Merge pull request #1 from MapColonies/skeleton

refactor:  initializing overseer (MAPCO-4436)

.github/workflows/pull_request.yaml

@@ -6,3 +6,5 @@ jobs:
   pull_request:
     uses: MapColonies/shared-workflows/.github/workflows/pull_request.yaml@v1
     secrets: inherit
+    with:
+      enableOpenApiCheck: false

.gitignore

@@ -8,6 +8,7 @@ lerna-debug.log*
 
 # Development tools
 .idea
+local.json
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

.versionrc.json

@@ -1,9 +1,5 @@
 {
   "bumpFiles": [
-    {
-      "filename": "openapi3.yaml",
-      "updater": "node_modules/@map-colonies/standard-version-update-openapi3-version/src/index.js"
-    },
     {
       "filename": "package.json",
       "type": "json"

.vscode/launch.json

@@ -27,7 +27,6 @@
         "TELEMETRY_METRICS_ENABLED": "false",
         "TELEMETRY_TRACING_URL": "http://localhost:55681/v1/trace",
         "TELEMETRY_METRICS_URL": "http://localhost:55681/v1/metrics"
-        // "OPENAPI_FILE_PATH": "./openapi3.yaml"
       }
     }
   ]

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
   "files.eol": "\n"
-}
+}

README.md

@@ -1,8 +1,8 @@
-# Map Colonies typescript service template
+# Map Colonies Overseer Worker Service
 
 ----------------------------------
 
-This is a basic repo template for building new MapColonies web services in Typescript.
+A worker service designed for geospatial data management. Overseer handles a series of complex workflows including initialization, merge, and finalization tasks for geospatial layers. Features include polling for initialization and finalization tasks, processing merge tasks (new, update, swap), and resilient error handling with capabilities to resume tasks post-failure. It integrates with various APIs like mapproxy-API and GeoServer-API to insert and update layers, and enhances WFS links. The service listens to an ingestion queue, intelligently decides task creation, and commits updates upon successful task completions, ensuring data integrity and seamless workflow execution.
 
 ### Template Features:
 
@@ -22,8 +22,6 @@ This is a basic repo template for building new MapColonies web services in Types
 
 - logging by [@map-colonies/js-logger](https://github.com/MapColonies/js-logger)
 
-- OpenAPI request validation
-
 - config load with [node-config](https://www.npmjs.com/package/node-config)
 
 - Tracing and metrics by [@map-colonies/telemetry](https://github.com/MapColonies/telemetry)
@@ -48,9 +46,6 @@ This is a basic repo template for building new MapColonies web services in Types
 
 - snyk
 
-## API
-Checkout the OpenAPI spec [here](/openapi3.yaml)
-
 ## Installation
 
 Install deps with npm

config/custom-environment-variables.json

@@ -1,7 +1,4 @@
 {
-  "openapiConfig": {
-    "filePath": "OPENAPI_FILE_PATH"
-  },
   "telemetry": {
     "serviceName": "TELEMETRY_SERVICE_NAME",
     "hostname": "TELEMETRY_HOST_NAME",

config/default.json

@@ -1,10 +1,4 @@
 {
-  "openapiConfig": {
-    "filePath": "./openapi3.yaml",
-    "basePath": "/docs",
-    "rawPath": "/api",
-    "uiPath": "/api"
-  },
   "telemetry": {
     "logger": {
       "level": "info",