commit 3398982ca883f4215852134a80a9da9fbd260f81 Author: marvinpoo Date: Sun May 10 19:12:02 2026 +0200 init diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..f2dcb54 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,7 @@ +node_modules +npm-debug.log* +.env +.git +.idea +coverage +dist \ No newline at end of file diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..9f9b37f --- /dev/null +++ b/.env.example @@ -0,0 +1,5 @@ +PORT=3030 +API_HOST_PORT=8030 +MONGODB_URI=mongodb://root:change-me@37.60.245.70:27017 +MONGODB_DB=duneawa +MAX_PAGES= diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a97cdb1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +node_modules/ +npm-debug.log* +.env +.env.* +!.env.example +coverage/ +dist/ +.DS_Store +.idea \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..4eb22e9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +FROM cgr.dev/chainguard/node:latest-dev AS dependencies + +WORKDIR /app + +ENV NODE_ENV=production + +COPY package*.json ./ +RUN npm ci --omit=dev + +FROM cgr.dev/chainguard/node:latest AS runtime + +WORKDIR /app + +ENV NODE_ENV=production + +COPY --from=dependencies /app/node_modules ./node_modules +COPY src ./src +COPY scripts ./scripts + +EXPOSE 3030 + +CMD ["src/server.js"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..5ba7e7a --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Dune API + +Node.js API for Dune: Awakening Questlog data. It imports items, skills, recipes, placeables, and NPCs in English and German into MongoDB, then exposes them through REST endpoints and Swagger UI. + +## Quick Start + +```powershell +npm install +npm run import:smoke +npm start +``` + +Open Swagger UI at `http://localhost:3030/docs`. + +## Docker + +```powershell +docker compose up --build +``` + +The API listens on `http://localhost:8030` by default when run through Docker Compose. Set `API_HOST_PORT=3031` if your machine needs the alternate host port. + +## Import All Data + +```powershell +npm run import +``` + +You can also call the script directly with filters: + +```powershell +node scripts/import.js --datasets=items,skills --languages=en,de --max-pages=1 +``` + +or call `POST /api/import` from Swagger UI with an empty JSON body: + +```json +{} +``` + +The importer pulls every page for all configured datasets and both supported languages by default. + +## Endpoints + +- `GET /health` +- `GET /docs` +- `GET /openapi.json` +- `GET /api/{dataset}` +- `GET /api/{dataset}/{id}` +- `GET /api/search?q=...` +- `POST /api/import` +- `GET /api/import/status` + +Datasets: `items`, `skills`, `recipes`, `placeables`, `npcs`. diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..6e56de9 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,12 @@ +services: + api: + build: . + container_name: dune-api + restart: unless-stopped + ports: + - "${API_HOST_PORT:-8030}:${PORT:-3030}" + environment: + PORT: ${PORT:-3030} + MONGODB_URI: ${MONGODB_URI} + MONGODB_DB: ${MONGODB_DB:-duneawa} + MAX_PAGES: ${MAX_PAGES:-} diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..6517f74 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,1063 @@ +{ + "name": "dune-api", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "dune-api", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "cors": "^2.8.5", + "dotenv": "^16.4.7", + "express": "^4.21.2", + "mongodb": "^6.12.0", + "swagger-ui-express": "^5.0.1" + } + }, + "node_modules/@mongodb-js/saslprep": { + "version": "1.4.11", + "resolved": "https://registry.npmjs.org/@mongodb-js/saslprep/-/saslprep-1.4.11.tgz", + "integrity": "sha512-o9rAHc0IpIjuPSxRutWpE1F62x7n+4mVS4rCNHkzhIUMQcc18bb6xEq5wd2NdN0WjepIyXIppRshYI2kQDOZVA==", + "license": "MIT", + "dependencies": { + "sparse-bitfield": "^3.0.3" + } + }, + "node_modules/@scarf/scarf": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.4.0.tgz", + "integrity": "sha512-xxeapPiUXdZAE3che6f3xogoJPeZgig6omHEy1rIY5WVsB3H2BHNnZH+gHG6x91SCWyQCzWGsuL2Hh3ClO5/qQ==", + "hasInstallScript": true, + "license": "Apache-2.0" + }, + "node_modules/@types/webidl-conversions": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/@types/webidl-conversions/-/webidl-conversions-7.0.3.tgz", + "integrity": "sha512-CiJJvcRtIgzadHCYXw7dqEnMNRjhGZlYK05Mj9OyktqV8uVT8fD2BFOB7S1uwBE3Kj2Z+4UyPmFw/Ixgw/LAlA==", + "license": "MIT" + }, + "node_modules/@types/whatwg-url": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/@types/whatwg-url/-/whatwg-url-11.0.5.tgz", + "integrity": "sha512-coYR071JRaHa+xoEvvYqvnIHaVqaYrLPbsufM9BF63HkwI5Lgmy2QR8Q5K/lYDYo5AK82wOvSOS0UsLTpTG7uQ==", + "license": "MIT", + "dependencies": { + "@types/webidl-conversions": "*" + } + }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "license": "MIT", + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "license": "MIT" + }, + "node_modules/body-parser": { + "version": "1.20.5", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.5.tgz", + "integrity": "sha512-3grm+/2tUOvu2cjJkvsIxrv/wVpfXQW4PsQHYm7yk4vfpu7Ekl6nEsYBoJUL6qDwZUx8wUhQ8tR2qz+ad9c9OA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "~1.2.0", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "on-finished": "~2.4.1", + "qs": "~6.15.1", + "raw-body": "~2.5.3", + "type-is": "~1.6.18", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/qs": { + "version": "6.15.1", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.15.1.tgz", + "integrity": "sha512-6YHEFRL9mfgcAvql/XhwTvf5jKcOiiupt2FiJxHkiX1z4j7WL8J/jRHYLluORvc1XxB5rV20KoeK00gVJamspg==", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/bson": { + "version": "6.10.4", + "resolved": "https://registry.npmjs.org/bson/-/bson-6.10.4.tgz", + "integrity": "sha512-WIsKqkSC0ABoBJuT1LEX+2HEvNmNKKgnTAyd0fL8qzK4SH2i9NXg+t08YtdZp/V9IZ33cxe3iV4yM0qg8lMQng==", + "license": "Apache-2.0", + "engines": { + "node": ">=16.20.1" + } + }, + "node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie": { + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz", + "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==", + "license": "MIT" + }, + "node_modules/cors": { + "version": "2.8.6", + "resolved": "https://registry.npmjs.org/cors/-/cors-2.8.6.tgz", + "integrity": "sha512-tJtZBBHA6vjIAaF6EnIaq6laBBP9aq/Y3ouVJjEfoHbRBcHBAHYcMh/w8LDrk2PvIMMq8gmopa5D4V8RmbrxGw==", + "license": "MIT", + "dependencies": { + "object-assign": "^4", + "vary": "^1" + }, + "engines": { + "node": ">= 0.10" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "license": "MIT", + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/dotenv": { + "version": "16.6.1", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.6.1.tgz", + "integrity": "sha512-uBq4egWHTcTt33a72vpSG0z3HnPuIl6NqYcTrKEg2azoEyl2hpW0zqlxysq2pK9HlDIHyHyakeYaYnSAwd8bow==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" + } + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "license": "MIT" + }, + "node_modules/encodeurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", + "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "license": "MIT" + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express": { + "version": "4.22.1", + "resolved": "https://registry.npmjs.org/express/-/express-4.22.1.tgz", + "integrity": "sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "~1.20.3", + "content-disposition": "~0.5.4", + "content-type": "~1.0.4", + "cookie": "~0.7.1", + "cookie-signature": "~1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "~1.3.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.0", + "merge-descriptors": "1.0.3", + "methods": "~1.1.2", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "~0.1.12", + "proxy-addr": "~2.0.7", + "qs": "~6.14.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "~0.19.0", + "serve-static": "~1.16.2", + "setprototypeof": "1.2.0", + "statuses": "~2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/finalhandler": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.2.tgz", + "integrity": "sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "statuses": "~2.0.2", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.3.tgz", + "integrity": "sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg==", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/memory-pager": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/memory-pager/-/memory-pager-1.5.0.tgz", + "integrity": "sha512-ZS4Bp4r/Zoeq6+NLJpP+0Zzm0pR8whtGPf1XExKLJBAczGMnSi3It14OiNCStjQjM6NU1okjQGSxgEZN8eBYKg==", + "license": "MIT" + }, + "node_modules/merge-descriptors": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", + "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "license": "MIT", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mongodb": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/mongodb/-/mongodb-6.21.0.tgz", + "integrity": "sha512-URyb/VXMjJ4da46OeSXg+puO39XH9DeQpWCslifrRn9JWugy0D+DvvBvkm2WxmHe61O/H19JM66p1z7RHVkZ6A==", + "license": "Apache-2.0", + "dependencies": { + "@mongodb-js/saslprep": "^1.3.0", + "bson": "^6.10.4", + "mongodb-connection-string-url": "^3.0.2" + }, + "engines": { + "node": ">=16.20.1" + }, + "peerDependencies": { + "@aws-sdk/credential-providers": "^3.188.0", + "@mongodb-js/zstd": "^1.1.0 || ^2.0.0", + "gcp-metadata": "^5.2.0", + "kerberos": "^2.0.1", + "mongodb-client-encryption": ">=6.0.0 <7", + "snappy": "^7.3.2", + "socks": "^2.7.1" + }, + "peerDependenciesMeta": { + "@aws-sdk/credential-providers": { + "optional": true + }, + "@mongodb-js/zstd": { + "optional": true + }, + "gcp-metadata": { + "optional": true + }, + "kerberos": { + "optional": true + }, + "mongodb-client-encryption": { + "optional": true + }, + "snappy": { + "optional": true + }, + "socks": { + "optional": true + } + } + }, + "node_modules/mongodb-connection-string-url": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mongodb-connection-string-url/-/mongodb-connection-string-url-3.0.2.tgz", + "integrity": "sha512-rMO7CGo/9BFwyZABcKAWL8UJwH/Kc2x0g72uhDWzG48URRax5TCIcJ7Rc3RZqffZzO/Gwff/jyKwCU9TN8gehA==", + "license": "Apache-2.0", + "dependencies": { + "@types/whatwg-url": "^11.0.2", + "whatwg-url": "^14.1.0 || ^13.0.0" + } + }, + "node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "license": "MIT", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/path-to-regexp": { + "version": "0.1.13", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.13.tgz", + "integrity": "sha512-A/AGNMFN3c8bOlvV9RreMdrv7jsmF9XIfDeCd87+I8RNg6s78BhJxMu69NEMHBSJFxKidViTEdruRwEk/WIKqA==", + "license": "MIT" + }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", + "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", + "license": "MIT", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/qs": { + "version": "6.14.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.2.tgz", + "integrity": "sha512-V/yCWTTF7VJ9hIh18Ugr2zhJMP01MY7c5kh4J870L7imm6/DIzBsNLTXzMwUA3yZ5b/KBqLx8Kp3uRvd7xSe3Q==", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.3", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz", + "integrity": "sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" + }, + "node_modules/send": { + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/send/-/send-0.19.2.tgz", + "integrity": "sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.1", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "~2.4.1", + "range-parser": "~1.2.1", + "statuses": "~2.0.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/serve-static": { + "version": "1.16.3", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.3.tgz", + "integrity": "sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA==", + "license": "MIT", + "dependencies": { + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "~0.19.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "license": "ISC" + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.1.tgz", + "integrity": "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/sparse-bitfield": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/sparse-bitfield/-/sparse-bitfield-3.0.3.tgz", + "integrity": "sha512-kvzhi7vqKTfkh0PZU+2D2PIllw2ymqJKujUcyPMd9Y75Nv4nPbGJZXNhxsgdQab2BmlDct1YnfQCguEvHr7VsQ==", + "license": "MIT", + "dependencies": { + "memory-pager": "^1.0.2" + } + }, + "node_modules/statuses": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", + "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/swagger-ui-dist": { + "version": "5.32.5", + "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.32.5.tgz", + "integrity": "sha512-7/FQfWe9A4qoyYFdAwy0chD0uDYidDp/ZT9VQ9LZlgD4AnnHJk8/+ytAA1HkJYOPySmK6helPDdJQMlcumt7HA==", + "license": "Apache-2.0", + "dependencies": { + "@scarf/scarf": "=1.4.0" + } + }, + "node_modules/swagger-ui-express": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/swagger-ui-express/-/swagger-ui-express-5.0.1.tgz", + "integrity": "sha512-SrNU3RiBGTLLmFU8GIJdOdanJTl4TOmT27tt3bWWHppqYmAZ6IDuEuBvMU6nZq0zLEe6b/1rACXCgLZqO6ZfrA==", + "license": "MIT", + "dependencies": { + "swagger-ui-dist": ">=5.0.0" + }, + "engines": { + "node": ">= v0.10.32" + }, + "peerDependencies": { + "express": ">=4.0.0 || >=5.0.0-beta" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "license": "MIT", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/tr46": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-5.1.1.tgz", + "integrity": "sha512-hdF5ZgjTqgAntKkklYw0R03MG2x/bSzTtkxmIRw/sTNV8YXsCJ1tfLAX23lhxhHJlEf3CRCOCGGWw3vI3GaSPw==", + "license": "MIT", + "dependencies": { + "punycode": "^2.3.1" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "license": "MIT", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "license": "MIT", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/webidl-conversions": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-7.0.0.tgz", + "integrity": "sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=12" + } + }, + "node_modules/whatwg-url": { + "version": "14.2.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-14.2.0.tgz", + "integrity": "sha512-De72GdQZzNTUBBChsXueQUnPKDkg/5A5zp7pFDuQAj5UFoENpiACU0wlCvzpAGnTkj++ihpKwKyYewn/XNUbKw==", + "license": "MIT", + "dependencies": { + "tr46": "^5.1.0", + "webidl-conversions": "^7.0.0" + }, + "engines": { + "node": ">=18" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..b12cf7d --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "dune-api", + "version": "1.0.0", + "description": "Node.js API for Dune: Awakening Questlog data with MongoDB and Swagger UI.", + "main": "src/server.js", + "type": "commonjs", + "scripts": { + "start": "node src/server.js", + "dev": "node --watch src/server.js", + "import": "node scripts/import.js", + "import:smoke": "node scripts/import.js --max-pages=1", + "check": "node --check src/server.js && node --check src/app.js && node --check src/config.js && node --check src/db/client.js && node --check src/db/indexes.js && node --check src/datasets.js && node --check src/importer/importer.js && node --check src/importer/questlogClient.js && node --check src/routes/api.js && node --check src/swagger/openapi.js && node --check scripts/import.js" + }, + "keywords": [ + "dune-awakening", + "api", + "mongodb", + "swagger" + ], + "license": "UNLICENSED", + "dependencies": { + "cors": "^2.8.5", + "dotenv": "^16.4.7", + "express": "^4.21.2", + "mongodb": "^6.12.0", + "swagger-ui-express": "^5.0.1" + } +} diff --git a/scripts/import.js b/scripts/import.js new file mode 100644 index 0000000..56e8905 --- /dev/null +++ b/scripts/import.js @@ -0,0 +1,43 @@ +const { closeMongo } = require("../src/db/client"); +const { runImport } = require("../src/importer/importer"); + +function parseArgs(argv) { + const options = {}; + + for (const arg of argv) { + if (arg.startsWith("--datasets=")) { + options.datasets = arg + .slice("--datasets=".length) + .split(",") + .filter(Boolean); + } + + if (arg.startsWith("--languages=")) { + options.languages = arg + .slice("--languages=".length) + .split(",") + .filter(Boolean); + } + + if (arg.startsWith("--max-pages=")) { + options.maxPages = Number(arg.slice("--max-pages=".length)); + } + } + + return options; +} + +async function main() { + const options = parseArgs(process.argv.slice(2)); + const status = await runImport(options); + console.log(JSON.stringify(status, null, 2)); +} + +main() + .catch((error) => { + console.error(error); + process.exitCode = 1; + }) + .finally(async () => { + await closeMongo(); + }); diff --git a/src/app.js b/src/app.js new file mode 100644 index 0000000..3bf3762 --- /dev/null +++ b/src/app.js @@ -0,0 +1,50 @@ +const cors = require("cors"); +const express = require("express"); +const swaggerUi = require("swagger-ui-express"); +const { pingMongo } = require("./db/client"); +const { router: apiRouter } = require("./routes/api"); +const { openApiDocument } = require("./swagger/openapi"); + +function createApp() { + const app = express(); + + app.use(cors()); + app.use(express.json({ limit: "2mb" })); + + app.get("/", (request, response) => { + response.redirect("/docs"); + }); + + app.get("/health", async (request, response) => { + try { + await pingMongo(); + response.json({ ok: true, mongo: "connected" }); + } catch (error) { + response + .status(503) + .json({ ok: false, mongo: "unavailable", error: error.message }); + } + }); + + app.get("/openapi.json", (request, response) => { + response.json(openApiDocument); + }); + + app.use("/docs", swaggerUi.serve, swaggerUi.setup(openApiDocument)); + app.use("/api", apiRouter); + + app.use((request, response) => { + response.status(404).json({ error: "Not found" }); + }); + + app.use((error, request, response, next) => { + const status = error.status || 500; + response + .status(status) + .json({ error: error.message || "Internal server error" }); + }); + + return app; +} + +module.exports = { createApp }; diff --git a/src/config.js b/src/config.js new file mode 100644 index 0000000..8496ca6 --- /dev/null +++ b/src/config.js @@ -0,0 +1,35 @@ +const dotenv = require("dotenv"); + +dotenv.config(); + +function parseOptionalPositiveInteger(value, name) { + if (value === undefined || value === null || value === "") { + return undefined; + } + + const parsed = Number(value); + if (!Number.isInteger(parsed) || parsed <= 0) { + throw new Error(`${name} must be a positive integer when provided`); + } + + return parsed; +} + +const config = { + port: parseOptionalPositiveInteger(process.env.PORT, "PORT") || 3030, + mongodb: { + uri: + process.env.MONGODB_URI || "mongodb://root:63eba009@37.60.245.70:27017", + dbName: process.env.MONGODB_DB || "duneawa", + }, + importer: { + maxPages: parseOptionalPositiveInteger(process.env.MAX_PAGES, "MAX_PAGES"), + }, + questlog: { + baseUrl: + process.env.QUESTLOG_BASE_URL || + "https://questlog.gg/dune-awakening/api/trpc", + }, +}; + +module.exports = { config, parseOptionalPositiveInteger }; diff --git a/src/datasets.js b/src/datasets.js new file mode 100644 index 0000000..af2649e --- /dev/null +++ b/src/datasets.js @@ -0,0 +1,90 @@ +const DATASETS = { + items: { + key: "items", + collection: "items", + method: "database.getItems", + singular: "item", + }, + skills: { + key: "skills", + collection: "skills", + method: "database.getSkills", + singular: "skill", + }, + recipes: { + key: "recipes", + collection: "recipes", + method: "database.getRecipes", + singular: "recipe", + }, + placeables: { + key: "placeables", + collection: "placeables", + method: "database.getPlaceables", + singular: "placeable", + }, + npcs: { + key: "npcs", + collection: "npcs", + method: "database.getNpcs", + singular: "npc", + }, +}; + +const LANGUAGES = ["en", "de"]; + +function getDataset(key) { + return DATASETS[key]; +} + +function assertDataset(key) { + const dataset = getDataset(key); + if (!dataset) { + const allowed = Object.keys(DATASETS).join(", "); + const error = new Error( + `Unknown dataset "${key}". Allowed datasets: ${allowed}`, + ); + error.status = 400; + throw error; + } + return dataset; +} + +function normalizeDatasetList(values) { + if (!values || values.length === 0) { + return Object.keys(DATASETS); + } + + const list = Array.isArray(values) ? values : String(values).split(","); + return list.map((value) => assertDataset(String(value).trim()).key); +} + +function normalizeLanguageList(values) { + if (!values || values.length === 0) { + return LANGUAGES; + } + + const list = Array.isArray(values) ? values : String(values).split(","); + const normalized = list.map((value) => String(value).trim().toLowerCase()); + const invalid = normalized.filter( + (language) => !LANGUAGES.includes(language), + ); + + if (invalid.length > 0) { + const error = new Error( + `Unsupported language(s): ${invalid.join(", ")}. Allowed languages: ${LANGUAGES.join(", ")}`, + ); + error.status = 400; + throw error; + } + + return normalized; +} + +module.exports = { + DATASETS, + LANGUAGES, + assertDataset, + normalizeDatasetList, + normalizeLanguageList, +}; diff --git a/src/db/client.js b/src/db/client.js new file mode 100644 index 0000000..d18c316 --- /dev/null +++ b/src/db/client.js @@ -0,0 +1,52 @@ +const { MongoClient } = require("mongodb"); +const { config } = require("../config"); + +let client; +let db; + +async function connectToMongo() { + if (db) { + return db; + } + + client = new MongoClient(config.mongodb.uri, { + serverSelectionTimeoutMS: 5000, + connectTimeoutMS: 10000, + socketTimeoutMS: 30000, + maxIdleTimeMS: 300000, + }); + + await client.connect(); + db = client.db(config.mongodb.dbName); + return db; +} + +function getDb() { + if (!db) { + throw new Error("MongoDB is not connected yet"); + } + + return db; +} + +async function closeMongo() { + if (client) { + await client.close(); + } + + client = undefined; + db = undefined; +} + +async function pingMongo() { + const database = await connectToMongo(); + await database.command({ ping: 1 }); + return true; +} + +module.exports = { + closeMongo, + connectToMongo, + getDb, + pingMongo, +}; diff --git a/src/db/indexes.js b/src/db/indexes.js new file mode 100644 index 0000000..f6bdcb1 --- /dev/null +++ b/src/db/indexes.js @@ -0,0 +1,18 @@ +const { DATASETS } = require("../datasets"); + +async function ensureIndexes(db) { + await Promise.all( + Object.values(DATASETS).map(async (dataset) => { + const collection = db.collection(dataset.collection); + await collection.createIndex( + { language: 1, sourceId: 1 }, + { unique: true }, + ); + await collection.createIndex({ language: 1, name: 1 }); + await collection.createIndex({ dataset: 1, language: 1 }); + await collection.createIndex({ name: "text", searchText: "text" }); + }), + ); +} + +module.exports = { ensureIndexes }; diff --git a/src/importer/importer.js b/src/importer/importer.js new file mode 100644 index 0000000..5eca3e9 --- /dev/null +++ b/src/importer/importer.js @@ -0,0 +1,202 @@ +const crypto = require("crypto"); +const { config } = require("../config"); +const { + DATASETS, + normalizeDatasetList, + normalizeLanguageList, +} = require("../datasets"); +const { connectToMongo } = require("../db/client"); +const { ensureIndexes } = require("../db/indexes"); +const { fetchQuestlogPage } = require("./questlogClient"); + +const importStatus = { + running: false, + startedAt: null, + finishedAt: null, + error: null, + current: null, + totals: {}, +}; + +function stableJsonHash(value) { + return crypto.createHash("sha1").update(JSON.stringify(value)).digest("hex"); +} + +function extractSourceId(record) { + return String( + record?.compoundId || + record?.id || + record?._id || + record?.slug || + record?.name || + record?.title || + stableJsonHash(record), + ); +} + +function extractName(record) { + const value = + record?.name || + record?.title || + record?.displayName || + record?.id || + record?.compoundId || + ""; + return String(value).replace(/\s+/g, " ").trim(); +} + +function buildStoredDocument(dataset, language, record) { + const sourceId = extractSourceId(record); + const name = extractName(record); + const rawText = JSON.stringify(record); + + return { + dataset: dataset.key, + language, + source: "questlog.gg", + sourceMethod: dataset.method, + sourceId, + name, + searchText: `${name} ${rawText}`, + raw: record, + importedAt: new Date(), + }; +} + +async function upsertRecords(db, dataset, language, records) { + if (records.length === 0) { + return { matched: 0, modified: 0, upserted: 0 }; + } + + const collection = db.collection(dataset.collection); + const operations = records.map((record) => { + const document = buildStoredDocument(dataset, language, record); + return { + updateOne: { + filter: { language, sourceId: document.sourceId }, + update: { $set: document }, + upsert: true, + }, + }; + }); + + const result = await collection.bulkWrite(operations, { ordered: false }); + return { + matched: result.matchedCount || 0, + modified: result.modifiedCount || 0, + upserted: result.upsertedCount || 0, + }; +} + +function resetStatus() { + importStatus.running = true; + importStatus.startedAt = new Date().toISOString(); + importStatus.finishedAt = null; + importStatus.error = null; + importStatus.current = null; + importStatus.totals = {}; +} + +function recordTotals(datasetKey, language, pageResult, recordsCount) { + const key = `${datasetKey}:${language}`; + const existing = importStatus.totals[key] || { + pages: 0, + records: 0, + matched: 0, + modified: 0, + upserted: 0, + }; + existing.pages += 1; + existing.records += recordsCount; + existing.matched += pageResult.matched; + existing.modified += pageResult.modified; + existing.upserted += pageResult.upserted; + importStatus.totals[key] = existing; +} + +async function importDatasetLanguage(db, dataset, language, maxPages) { + let page = 1; + + while (true) { + importStatus.current = { dataset: dataset.key, language, page }; + const payload = await fetchQuestlogPage(dataset, language, page); + + if (payload.records.length === 0) { + break; + } + + const pageResult = await upsertRecords( + db, + dataset, + language, + payload.records, + ); + recordTotals(dataset.key, language, pageResult, payload.records.length); + + const reachedKnownEnd = payload.pageCount && page >= payload.pageCount; + const reachedConfiguredLimit = maxPages && page >= maxPages; + if (reachedKnownEnd || reachedConfiguredLimit) { + break; + } + + page += 1; + } +} + +async function runImport(options = {}) { + if (importStatus.running) { + const error = new Error("An import is already running"); + error.status = 409; + throw error; + } + + const datasetKeys = normalizeDatasetList(options.datasets); + const languages = normalizeLanguageList(options.languages); + const maxPages = options.maxPages || config.importer.maxPages; + + resetStatus(); + + try { + const db = await connectToMongo(); + await ensureIndexes(db); + + for (const datasetKey of datasetKeys) { + const dataset = DATASETS[datasetKey]; + for (const language of languages) { + await importDatasetLanguage(db, dataset, language, maxPages); + } + } + + importStatus.finishedAt = new Date().toISOString(); + importStatus.running = false; + importStatus.current = null; + return getImportStatus(); + } catch (error) { + importStatus.finishedAt = new Date().toISOString(); + importStatus.running = false; + importStatus.error = error.message; + throw error; + } +} + +function getImportStatus() { + return { + running: importStatus.running, + startedAt: importStatus.startedAt, + finishedAt: importStatus.finishedAt, + error: importStatus.error, + current: importStatus.current, + totals: importStatus.totals, + }; +} + +function startImport(options = {}) { + const promise = runImport(options).catch(() => undefined); + return promise; +} + +module.exports = { + getImportStatus, + runImport, + startImport, +}; diff --git a/src/importer/questlogClient.js b/src/importer/questlogClient.js new file mode 100644 index 0000000..951a28c --- /dev/null +++ b/src/importer/questlogClient.js @@ -0,0 +1,95 @@ +const { config } = require("../config"); + +function buildQuestlogUrl(method, language, page) { + const input = JSON.stringify({ + language, + page, + mainCategory: "", + subCategory: "", + }); + + return `${config.questlog.baseUrl}/${method}?input=${encodeURIComponent(input)}`; +} + +function findFirstArray(value) { + if (Array.isArray(value)) { + return value; + } + + if (!value || typeof value !== "object") { + return undefined; + } + + const preferredKeys = [ + "pageData", + "items", + "data", + "results", + "records", + "rows", + ]; + for (const key of preferredKeys) { + if (Array.isArray(value[key])) { + return value[key]; + } + } + + for (const key of Object.keys(value)) { + const nested = findFirstArray(value[key]); + if (nested) { + return nested; + } + } + + return undefined; +} + +function extractPagePayload(payload) { + const data = + payload?.result?.data || + payload?.result?.data?.json || + payload?.data || + payload; + const records = findFirstArray(data); + const pageCount = + Number(data?.pageCount || payload?.result?.data?.pageCount || 0) || + undefined; + const currentPage = + Number(data?.currentPage || payload?.result?.data?.currentPage || 0) || + undefined; + + if (!records) { + const topLevelKeys = + payload && typeof payload === "object" ? Object.keys(payload) : []; + throw new Error( + `Could not find records array in Questlog response. Top-level keys: ${topLevelKeys.join(", ")}`, + ); + } + + return { records, pageCount, currentPage }; +} + +async function fetchQuestlogPage(dataset, language, page) { + const url = buildQuestlogUrl(dataset.method, language, page); + const response = await fetch(url, { + headers: { + accept: "application/json", + "user-agent": "dune-api-importer/1.0", + }, + }); + + if (!response.ok) { + throw new Error( + `Questlog request failed for ${dataset.key}/${language}/page ${page}: ${response.status} ${response.statusText}`, + ); + } + + const payload = await response.json(); + return extractPagePayload(payload); +} + +module.exports = { + buildQuestlogUrl, + extractPagePayload, + fetchQuestlogPage, +}; diff --git a/src/routes/api.js b/src/routes/api.js new file mode 100644 index 0000000..fad7422 --- /dev/null +++ b/src/routes/api.js @@ -0,0 +1,170 @@ +const express = require("express"); +const { ObjectId } = require("mongodb"); +const { + assertDataset, + DATASETS, + normalizeDatasetList, + normalizeLanguageList, +} = require("../datasets"); +const { getDb } = require("../db/client"); +const { getImportStatus, startImport } = require("../importer/importer"); + +const router = express.Router(); + +function parsePage(value) { + const page = Number(value || 1); + return Number.isInteger(page) && page > 0 ? page : 1; +} + +function parseLimit(value, fallback, max) { + const limit = Number(value || fallback); + if (!Number.isInteger(limit) || limit <= 0) { + return fallback; + } + + return Math.min(limit, max); +} + +function parseMaxPages(value) { + if (value === undefined || value === null || value === "") { + return undefined; + } + + const maxPages = Number(value); + if (!Number.isInteger(maxPages) || maxPages <= 0) { + const error = new Error("maxPages must be a positive integer"); + error.status = 400; + throw error; + } + + return maxPages; +} + +function buildLanguageFilter(language) { + if (!language) { + return {}; + } + + const [normalized] = normalizeLanguageList([language]); + return { language: normalized }; +} + +function buildSearchFilter(query) { + if (!query) { + return {}; + } + + return { $text: { $search: String(query) } }; +} + +router.get("/datasets", (request, response) => { + response.json({ datasets: Object.values(DATASETS) }); +}); + +router.get("/import/status", (request, response) => { + response.json(getImportStatus()); +}); + +router.post("/import", (request, response, next) => { + try { + const body = request.body || {}; + const options = { + datasets: normalizeDatasetList(body.datasets), + languages: normalizeLanguageList(body.languages), + maxPages: parseMaxPages(body.maxPages), + }; + + startImport(options); + response + .status(202) + .json({ message: "Import started", status: getImportStatus() }); + } catch (error) { + next(error); + } +}); + +router.get("/search", async (request, response, next) => { + try { + const query = String(request.query.q || "").trim(); + if (!query) { + const error = new Error("q is required"); + error.status = 400; + throw error; + } + + const datasetKeys = normalizeDatasetList(request.query.datasets); + const languageFilter = buildLanguageFilter(request.query.language); + const limit = parseLimit(request.query.limit, 10, 50); + const db = getDb(); + + const results = {}; + for (const datasetKey of datasetKeys) { + const dataset = DATASETS[datasetKey]; + results[datasetKey] = await db + .collection(dataset.collection) + .find({ ...languageFilter, ...buildSearchFilter(query) }) + .project({ searchText: 0 }) + .limit(limit) + .toArray(); + } + + response.json({ query, results }); + } catch (error) { + next(error); + } +}); + +router.get("/:dataset", async (request, response, next) => { + try { + const dataset = assertDataset(request.params.dataset); + const page = parsePage(request.query.page); + const limit = parseLimit(request.query.limit, 25, 100); + const skip = (page - 1) * limit; + const languageFilter = buildLanguageFilter(request.query.language); + const searchFilter = buildSearchFilter(request.query.q); + const filter = { ...languageFilter, ...searchFilter }; + const collection = getDb().collection(dataset.collection); + + const [items, total] = await Promise.all([ + collection + .find(filter) + .project({ searchText: 0 }) + .skip(skip) + .limit(limit) + .toArray(), + collection.countDocuments(filter), + ]); + + response.json({ dataset: dataset.key, page, limit, total, items }); + } catch (error) { + next(error); + } +}); + +router.get("/:dataset/:id", async (request, response, next) => { + try { + const dataset = assertDataset(request.params.dataset); + const id = request.params.id; + const languageFilter = buildLanguageFilter(request.query.language); + const idFilter = ObjectId.isValid(id) + ? { $or: [{ _id: new ObjectId(id) }, { sourceId: id }] } + : { sourceId: id }; + const document = await getDb() + .collection(dataset.collection) + .findOne( + { ...languageFilter, ...idFilter }, + { projection: { searchText: 0 } }, + ); + + if (!document) { + response.status(404).json({ error: "Not found" }); + return; + } + + response.json(document); + } catch (error) { + next(error); + } +}); + +module.exports = { router }; diff --git a/src/server.js b/src/server.js new file mode 100644 index 0000000..2d851ec --- /dev/null +++ b/src/server.js @@ -0,0 +1,31 @@ +const { createApp } = require("./app"); +const { config } = require("./config"); +const { closeMongo, connectToMongo } = require("./db/client"); +const { ensureIndexes } = require("./db/indexes"); + +async function start() { + const db = await connectToMongo(); + await ensureIndexes(db); + + const app = createApp(); + const server = app.listen(config.port, () => { + console.log(`Dune API listening on http://localhost:${config.port}`); + console.log(`Swagger UI available at http://localhost:${config.port}/docs`); + }); + + async function shutdown(signal) { + console.log(`Received ${signal}, shutting down`); + server.close(async () => { + await closeMongo(); + process.exit(0); + }); + } + + process.on("SIGINT", shutdown); + process.on("SIGTERM", shutdown); +} + +start().catch((error) => { + console.error(error); + process.exit(1); +}); diff --git a/src/swagger/openapi.js b/src/swagger/openapi.js new file mode 100644 index 0000000..b1f8daf --- /dev/null +++ b/src/swagger/openapi.js @@ -0,0 +1,166 @@ +const { DATASETS, LANGUAGES } = require("../datasets"); + +const datasetKeys = Object.keys(DATASETS); + +const openApiDocument = { + openapi: "3.0.3", + info: { + title: "Dune Awakening API", + version: "1.0.0", + description: "API for Dune: Awakening Questlog data stored in MongoDB.", + }, + servers: [{ url: "/" }], + tags: [{ name: "Health" }, { name: "Data" }, { name: "Import" }], + paths: { + "/health": { + get: { + tags: ["Health"], + summary: "Check API and MongoDB status", + responses: { + 200: { description: "Service is healthy" }, + 503: { description: "MongoDB is unavailable" }, + }, + }, + }, + "/api/datasets": { + get: { + tags: ["Data"], + summary: "List supported datasets", + responses: { 200: { description: "Supported datasets" } }, + }, + }, + "/api/{dataset}": { + get: { + tags: ["Data"], + summary: "List records for a dataset", + parameters: [ + { + name: "dataset", + in: "path", + required: true, + schema: { type: "string", enum: datasetKeys }, + }, + { + name: "language", + in: "query", + schema: { type: "string", enum: LANGUAGES }, + }, + { name: "q", in: "query", schema: { type: "string" } }, + { + name: "page", + in: "query", + schema: { type: "integer", minimum: 1, default: 1 }, + }, + { + name: "limit", + in: "query", + schema: { type: "integer", minimum: 1, maximum: 100, default: 25 }, + }, + ], + responses: { 200: { description: "Paged dataset records" } }, + }, + }, + "/api/{dataset}/{id}": { + get: { + tags: ["Data"], + summary: "Get one record by MongoDB id or Questlog source id", + parameters: [ + { + name: "dataset", + in: "path", + required: true, + schema: { type: "string", enum: datasetKeys }, + }, + { + name: "id", + in: "path", + required: true, + schema: { type: "string" }, + }, + { + name: "language", + in: "query", + schema: { type: "string", enum: LANGUAGES }, + }, + ], + responses: { + 200: { description: "Record" }, + 404: { description: "Record was not found" }, + }, + }, + }, + "/api/search": { + get: { + tags: ["Data"], + summary: "Search across datasets", + parameters: [ + { + name: "q", + in: "query", + required: true, + schema: { type: "string" }, + }, + { + name: "language", + in: "query", + schema: { type: "string", enum: LANGUAGES }, + }, + { + name: "datasets", + in: "query", + schema: { type: "string", example: "items,skills" }, + }, + { + name: "limit", + in: "query", + schema: { type: "integer", minimum: 1, maximum: 50, default: 10 }, + }, + ], + responses: { + 200: { description: "Search results grouped by dataset" }, + }, + }, + }, + "/api/import": { + post: { + tags: ["Import"], + summary: "Start Questlog import", + requestBody: { + required: false, + content: { + "application/json": { + schema: { + type: "object", + properties: { + datasets: { + type: "array", + items: { type: "string", enum: datasetKeys }, + }, + languages: { + type: "array", + items: { type: "string", enum: LANGUAGES }, + }, + maxPages: { type: "integer", minimum: 1 }, + }, + }, + example: { datasets: ["items"], languages: ["en"], maxPages: 1 }, + }, + }, + }, + responses: { + 202: { description: "Import started" }, + 409: { description: "Import is already running" }, + }, + }, + }, + "/api/import/status": { + get: { + tags: ["Import"], + summary: "Get current or latest import status", + responses: { 200: { description: "Import status" } }, + }, + }, + }, +}; + +module.exports = { openApiDocument };