diff --git a/src/problem4/solution.ts b/src/problem4/solution.ts new file mode 100644 index 000000000..2ba3d9ace --- /dev/null +++ b/src/problem4/solution.ts @@ -0,0 +1,67 @@ +// Problem 4: Three ways to sum to n (TypeScript) +// ================================================ + +/** + * Method 1: Iterative approach using a for loop + * + * Time Complexity: O(n) - loops n times + * Space Complexity: O(1) - only uses a single variable for sum + * + * Efficiency: Simple and straightforward, but slower for large n + * Use case: Good for small to medium values of n, easy to understand + */ +function sum_to_n_a(n: number): number { + let sum = 0; + for (let i = 1; i <= n; i++) { + sum += i; + } + return sum; +} + +/** + * Method 2: Mathematical formula (Gauss formula) + * Formula: n * (n + 1) / 2 + * + * Time Complexity: O(1) - constant time, single calculation + * Space Complexity: O(1) - no additional space needed + * + * Efficiency: Most efficient approach, instant calculation regardless of n + * Use case: Best for any size of n, especially large values + * Note: This is the optimal solution + */ +function sum_to_n_b(n: number): number { + return (n * (n + 1)) / 2; +} + +/** + * Method 3: Recursive approach + * + * Time Complexity: O(n) - makes n recursive calls + * Space Complexity: O(n) - call stack grows to n depth + * + * Efficiency: Least efficient due to function call overhead and stack usage + * Use case: Demonstrates recursion concept but not recommended for large n + * Warning: May cause stack overflow for very large values of n + */ +function sum_to_n_c(n: number): number { + if (n <= 1) { + return n; + } + return n + sum_to_n_c(n - 1); +} + +// Test cases +console.log('Testing sum_to_n_a:'); +console.log(`sum_to_n_a(5) = ${sum_to_n_a(5)}`); // Expected: 15 +console.log(`sum_to_n_a(10) = ${sum_to_n_a(10)}`); // Expected: 55 +console.log(`sum_to_n_a(100) = ${sum_to_n_a(100)}`); // Expected: 5050 + +console.log('\nTesting sum_to_n_b:'); +console.log(`sum_to_n_b(5) = ${sum_to_n_b(5)}`); // Expected: 15 +console.log(`sum_to_n_b(10) = ${sum_to_n_b(10)}`); // Expected: 55 +console.log(`sum_to_n_b(100) = ${sum_to_n_b(100)}`); // Expected: 5050 + +console.log('\nTesting sum_to_n_c:'); +console.log(`sum_to_n_c(5) = ${sum_to_n_c(5)}`); // Expected: 15 +console.log(`sum_to_n_c(10) = ${sum_to_n_c(10)}`); // Expected: 55 +console.log(`sum_to_n_c(100) = ${sum_to_n_c(100)}`); // Expected: 5050 diff --git a/src/problem4/tsconfig.json b/src/problem4/tsconfig.json new file mode 100644 index 000000000..c8c45f91f --- /dev/null +++ b/src/problem4/tsconfig.json @@ -0,0 +1,17 @@ +{ + "compilerOptions": { + "target": "ES2020", + "module": "commonjs", + "lib": ["ES2020"], + "moduleResolution": "node", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "resolveJsonModule": true, + "outDir": "./dist", + "types": ["node"] + }, + "include": ["*.ts"], + "exclude": ["node_modules", "dist"] +} diff --git a/src/problem5/.env.example b/src/problem5/.env.example new file mode 100644 index 000000000..766252b48 --- /dev/null +++ b/src/problem5/.env.example @@ -0,0 +1,2 @@ +PORT=3000 +NODE_ENV=development diff --git a/src/problem5/.gitignore b/src/problem5/.gitignore new file mode 100644 index 000000000..8ca37287e --- /dev/null +++ b/src/problem5/.gitignore @@ -0,0 +1,7 @@ +node_modules +dist +.env +*.log +.DS_Store +data/*.json +!data/.gitkeep diff --git a/src/problem5/README.md b/src/problem5/README.md new file mode 100644 index 000000000..8ac7c13be --- /dev/null +++ b/src/problem5/README.md @@ -0,0 +1,373 @@ +# Problem 5: A Crude Server + +A RESTful CRUD API server built with Express.js and TypeScript, featuring a simple file-based database for data persistence. + +## Features + +- βœ… **CRUD Operations**: Create, Read, Update, Delete resources +- πŸ” **Filtering**: List resources with type, status, and search filters +- πŸ’Ύ **Data Persistence**: JSON file-based database +- πŸ”’ **TypeScript**: Fully typed for better development experience +- πŸš€ **Express.js**: Fast and minimal web framework +- πŸ”„ **Hot Reload**: Development mode with automatic restart +- πŸ“š **Swagger Documentation**: Interactive API documentation with Swagger UI + +## Tech Stack + +- **Runtime**: Node.js +- **Framework**: Express.js +- **Language**: TypeScript +- **Database**: JSON file-based storage +- **Documentation**: Swagger/OpenAPI 3.0 with Swagger UI + +## Installation + +1. Install dependencies: +```bash +npm install +``` + +2. Create environment file: +```bash +cp .env.example .env +``` + +3. (Optional) Modify `.env` to change port: +```env +PORT=3000 +NODE_ENV=development +``` + +## Running the Application + +### Development Mode (with hot reload) +```bash +npm run dev +``` + +### Production Mode +```bash +# Build TypeScript to JavaScript +npm run build + +# Start the server +npm start +``` + +The server will start at `http://localhost:3000` + +## API Documentation + +### Swagger UI +Once the server is running, access the interactive API documentation at: + +**Swagger UI**: [http://localhost:3000/api-docs](http://localhost:3000/api-docs) + +The Swagger documentation provides: +- πŸ“– Complete API reference with all endpoints +- πŸ§ͺ Interactive testing interface - try API calls directly from the browser +- πŸ“‹ Request/response schemas with example values +- βœ… Validation rules and required fields +- 🎯 Query parameters and filters documentation + +## API Endpoints + +### Base URL +``` +http://localhost:3000 +``` + +### 1. List All Resources +```http +GET /api/resources +``` + +**Query Parameters** (optional): +- `type` - Filter by resource type +- `status` - Filter by status (active/inactive) +- `search` - Search in name and description + +**Example:** +```bash +curl http://localhost:3000/api/resources +curl http://localhost:3000/api/resources?type=server&status=active +curl http://localhost:3000/api/resources?search=test +``` + +**Response:** +```json +{ + "success": true, + "count": 2, + "data": [ + { + "id": "resource_1234567890_abc123", + "name": "Test Resource", + "description": "A test resource", + "type": "server", + "status": "active", + "createdAt": "2026-01-25T10:00:00.000Z", + "updatedAt": "2026-01-25T10:00:00.000Z", + "metadata": {} + } + ] +} +``` + +### 2. Get Resource by ID +```http +GET /api/resources/:id +``` + +**Example:** +```bash +curl http://localhost:3000/api/resources/resource_1234567890_abc123 +``` + +**Response:** +```json +{ + "success": true, + "data": { + "id": "resource_1234567890_abc123", + "name": "Test Resource", + "description": "A test resource", + "type": "server", + "status": "active", + "createdAt": "2026-01-25T10:00:00.000Z", + "updatedAt": "2026-01-25T10:00:00.000Z", + "metadata": {} + } +} +``` + +### 3. Create a Resource +```http +POST /api/resources +Content-Type: application/json +``` + +**Required Fields:** +- `name` (string) +- `description` (string) +- `type` (string) + +**Optional Fields:** +- `status` ("active" | "inactive") - defaults to "active" +- `metadata` (object) + +**Example:** +```bash +curl -X POST http://localhost:3000/api/resources \ + -H "Content-Type: application/json" \ + -d '{ + "name": "New Server", + "description": "Production server instance", + "type": "server", + "status": "active", + "metadata": { + "cpu": "4 cores", + "ram": "16GB" + } + }' +``` + +**Response:** +```json +{ + "success": true, + "message": "Resource created successfully", + "data": { + "id": "resource_1234567890_abc123", + "name": "New Server", + "description": "Production server instance", + "type": "server", + "status": "active", + "createdAt": "2026-01-25T10:00:00.000Z", + "updatedAt": "2026-01-25T10:00:00.000Z", + "metadata": { + "cpu": "4 cores", + "ram": "16GB" + } + } +} +``` + +### 4. Update a Resource +```http +PUT /api/resources/:id +Content-Type: application/json +``` + +**All fields are optional:** +- `name` (string) +- `description` (string) +- `type` (string) +- `status` ("active" | "inactive") +- `metadata` (object) + +**Example:** +```bash +curl -X PUT http://localhost:3000/api/resources/resource_1234567890_abc123 \ + -H "Content-Type: application/json" \ + -d '{ + "status": "inactive", + "metadata": { + "cpu": "8 cores", + "ram": "32GB" + } + }' +``` + +**Response:** +```json +{ + "success": true, + "message": "Resource updated successfully", + "data": { + "id": "resource_1234567890_abc123", + "name": "New Server", + "description": "Production server instance", + "type": "server", + "status": "inactive", + "createdAt": "2026-01-25T10:00:00.000Z", + "updatedAt": "2026-01-25T10:30:00.000Z", + "metadata": { + "cpu": "8 cores", + "ram": "32GB" + } + } +} +``` + +### 5. Delete a Resource +```http +DELETE /api/resources/:id +``` + +**Example:** +```bash +curl -X DELETE http://localhost:3000/api/resources/resource_1234567890_abc123 +``` + +**Response:** +```json +{ + "success": true, + "message": "Resource deleted successfully" +} +``` + +## Error Responses + +### 400 Bad Request +```json +{ + "success": false, + "message": "Missing required fields: name, description, type" +} +``` + +### 404 Not Found +```json +{ + "success": false, + "message": "Resource with ID 'xyz' not found" +} +``` + +### 500 Internal Server Error +```json +{ + "success": false, + "message": "Internal server error", + "error": "Error details (development mode only)" +} +``` + +## Project Structure + +``` +src/problem5/ +β”œβ”€β”€ src/ +β”‚ β”œβ”€β”€ config/ +β”‚ β”‚ └── swagger.ts # Swagger/OpenAPI configuration +β”‚ β”œβ”€β”€ types/ +β”‚ β”‚ └── resource.ts # TypeScript interfaces +β”‚ β”œβ”€β”€ database/ +β”‚ β”‚ └── db.ts # File-based database operations +β”‚ β”œβ”€β”€ routes/ +β”‚ β”‚ └── resources.ts # CRUD route handlers with Swagger annotation +β”‚ β”‚ └── resources.ts # CRUD route handlers +β”‚ └── middleware/ +β”‚ └── errorHandler.ts # Error handling middleware +β”œβ”€β”€ data/ +β”‚ └── resources.json # JSON database file (auto-created) +β”œβ”€β”€ dist/ # Compiled JavaScript (after build) +β”œβ”€β”€ package.json +β”œβ”€β”€ tsconfig.json +β”œβ”€β”€ .env.example +└── README.md +``` + +## Database + +The application uses a simple JSON file-based database stored in `data/resources.json`. The file is automatically created on first run. + +**Data Structure:** +```json +[ + { + "id": "resource_1234567890_abc123", + "name": "Resource Name", + "description": "Resource Description", + "type": "resource-type", + "status": "active", + "createdAt": "2026-01-25T10:00:00.000Z", + "updatedAt": "2026-01-25T10:00:00.000Z", + "metadata": {} + } +] +``` + +## Testing with cURL + +### Create a few test resources: +```bash +# Create resource 1 +curl -X POST http://localhost:3000/api/resources \ + -H "Content-Type: application/json" \ + -d '{"name":"Web Server","description":"Main production server","type":"server","status":"active"}' + +# Create resource 2 +curl -X POST http://localhost:3000/api/resources \ + -H "Content-Type: application/json" \ + -d '{"name":"Database","description":"PostgreSQL instance","type":"database","status":"active"}' + +# List all resources +curl http://localhost:3000/api/resources + +# Filter by type +curl http://localhost:3000/api/resources?type=server + +# Search +curl http://localhost:3000/api/resources?search=database +``` + +## Development + +The server uses `ts-node-dev` for development, which provides: +- Automatic TypeScript compilation +- Hot reload on file changes +- Fast restart times + +## Notes + +- The database is stored in a JSON file for simplicity +- For production use, consider using a proper database (PostgreSQL, MongoDB, etc.) +- The server includes basic error handling and validation +- CORS is enabled for cross-origin requests + +## License + +ISC diff --git a/src/problem5/package-lock.json b/src/problem5/package-lock.json new file mode 100644 index 000000000..4f2f6363a --- /dev/null +++ b/src/problem5/package-lock.json @@ -0,0 +1,2035 @@ +{ + "name": "crude-server", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "crude-server", + "version": "1.0.0", + "license": "ISC", + "dependencies": { + "cors": "^2.8.5", + "dotenv": "^16.3.1", + "express": "^4.18.2", + "swagger-jsdoc": "^6.2.8", + "swagger-ui-express": "^5.0.0" + }, + "devDependencies": { + "@types/cors": "^2.8.17", + "@types/express": "^4.17.21", + "@types/node": "^20.10.5", + "@types/swagger-jsdoc": "^6.0.4", + "@types/swagger-ui-express": "^4.1.6", + "ts-node": "^10.9.2", + "ts-node-dev": "^2.0.0", + "typescript": "^5.3.3" + } + }, + "node_modules/@apidevtools/json-schema-ref-parser": { + "version": "9.1.2", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz", + "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==", + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.6", + "call-me-maybe": "^1.0.1", + "js-yaml": "^4.1.0" + } + }, + "node_modules/@apidevtools/openapi-schemas": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", + "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/@apidevtools/swagger-methods": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz", + "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==", + "license": "MIT" + }, + "node_modules/@apidevtools/swagger-parser": { + "version": "10.0.3", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz", + "integrity": "sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==", + "license": "MIT", + "dependencies": { + "@apidevtools/json-schema-ref-parser": "^9.0.6", + "@apidevtools/openapi-schemas": "^2.0.4", + "@apidevtools/swagger-methods": "^3.0.2", + "@jsdevtools/ono": "^7.1.3", + "call-me-maybe": "^1.0.1", + "z-schema": "^5.0.1" + }, + "peerDependencies": { + "openapi-types": ">=7" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==", + "license": "MIT" + }, + "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/@tsconfig/node10": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.12.tgz", + "integrity": "sha512-UCYBaeFvM11aU2y3YPZ//O5Rhj+xKyzy7mvcIoAjASbigy8mHMryP5cK7dgjlz2hWxh1g5pLw084E0a/wlUSFQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", + "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/body-parser": { + "version": "1.19.6", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.6.tgz", + "integrity": "sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.38", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", + "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/cors": { + "version": "2.8.19", + "resolved": "https://registry.npmjs.org/@types/cors/-/cors-2.8.19.tgz", + "integrity": "sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/express": { + "version": "4.17.25", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.25.tgz", + "integrity": "sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.33", + "@types/qs": "*", + "@types/serve-static": "^1" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.19.8", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.8.tgz", + "integrity": "sha512-02S5fmqeoKzVZCHPZid4b8JH2eM5HzQLZWN2FohQEy/0eXTq8VXZfSN6Pcr3F6N9R/vNrj7cpgbhjie6m/1tCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*", + "@types/send": "*" + } + }, + "node_modules/@types/http-errors": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.5.tgz", + "integrity": "sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "license": "MIT" + }, + "node_modules/@types/mime": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", + "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "20.19.30", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.30.tgz", + "integrity": "sha512-WJtwWJu7UdlvzEAUm484QNg5eAoq5QR08KDNx7g45Usrs2NtOPiX8ugDqmKdXkyL03rBqU5dYNYVQetEpBHq2g==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.21.0" + } + }, + "node_modules/@types/qs": { + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.14.0.tgz", + "integrity": "sha512-eOunJqu0K1923aExK6y8p6fsihYEn/BYuQ4g0CxAAgFc4b/ZLN4CrsRZ55srTdqoiLzU2B2evC+apEIxprEzkQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/range-parser": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", + "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/send": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@types/send/-/send-1.2.1.tgz", + "integrity": "sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/serve-static": { + "version": "1.15.10", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.10.tgz", + "integrity": "sha512-tRs1dB+g8Itk72rlSI2ZrW6vZg0YrLI81iQSTkMmOqnqCaNr/8Ek4VwWcN5vZgCYWbg/JJSGBlUaYGAOP73qBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/http-errors": "*", + "@types/node": "*", + "@types/send": "<1" + } + }, + "node_modules/@types/serve-static/node_modules/@types/send": { + "version": "0.17.6", + "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.6.tgz", + "integrity": "sha512-Uqt8rPBE8SY0RK8JB1EzVOIZ32uqy8HwdxCnoCOsYrvnswqmFZ/k+9Ikidlk/ImhsdvBsloHbAlewb2IEBV/Og==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@types/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@types/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha512-xevGOReSYGM7g/kUBZzPqCrR/KYAo+F0yiPc85WFTJa0MSLtyFTVTU6cJu/aV4mid7IffDIWqo69THF2o4JiEQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/strip-json-comments": { + "version": "0.0.30", + "resolved": "https://registry.npmjs.org/@types/strip-json-comments/-/strip-json-comments-0.0.30.tgz", + "integrity": "sha512-7NQmHra/JILCd1QqpSzl8+mJRc8ZHz3uDm8YV1Ks9IhK0epEiTw8aIErbvH9PI+6XbqhyIQy3462nEsn7UVzjQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/swagger-jsdoc": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/@types/swagger-jsdoc/-/swagger-jsdoc-6.0.4.tgz", + "integrity": "sha512-W+Xw5epcOZrF/AooUM/PccNMSAFOKWZA5dasNyMujTwsBkU74njSJBpvCCJhHAJ95XRMzQrrW844Btu0uoetwQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/swagger-ui-express": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/@types/swagger-ui-express/-/swagger-ui-express-4.1.8.tgz", + "integrity": "sha512-AhZV8/EIreHFmBV5wAs0gzJUNq9JbbSXgJLQubCC0jtIo6prnI9MIRRxnU4MZX9RB9yXxF1V4R7jtLl/Wcj31g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/express": "*", + "@types/serve-static": "*" + } + }, + "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/acorn": { + "version": "8.15.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", + "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.3.4", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz", + "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "dev": true, + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true, + "license": "MIT" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "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/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/binary-extensions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/body-parser": { + "version": "1.20.4", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.4.tgz", + "integrity": "sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==", + "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.14.0", + "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/brace-expansion": { + "version": "1.1.12", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", + "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true, + "license": "MIT" + }, + "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/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "license": "MIT" + }, + "node_modules/chokidar": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/commander": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-6.2.0.tgz", + "integrity": "sha512-zP4jEKbe8SHzKJYQmq8Y9gYjtO/POJLgIdKgV7B9qNmABVFVc+ctqSX6iXh4mCpJfRBOabiZ2YKPg8ciDw6C+Q==", + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "license": "MIT" + }, + "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/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true, + "license": "MIT" + }, + "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/diff": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.4.tgz", + "integrity": "sha512-X07nttJQkwkfKfvTPG/KSnE2OMdcUCao6+eXF3wmnIQRn2aPAHH3VxDbDOdegkd6JbPsXqShpvEOHfAT+nCNwQ==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "license": "Apache-2.0", + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "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/dynamic-dedupe": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/dynamic-dedupe/-/dynamic-dedupe-0.3.0.tgz", + "integrity": "sha512-ssuANeD+z97meYOqd50e04Ze5qp4bPqo8cCkI4TRjZkzAUgIDTrXV1R8QCdINpiI+hw14+rYazvTRdQrz0/rFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "xtend": "^4.0.0" + } + }, + "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/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "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/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "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/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "license": "ISC" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "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/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "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.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "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/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "license": "ISC", + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "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/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-core-module": { + "version": "2.16.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", + "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/js-yaml": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", + "deprecated": "This package is deprecated. Use the optional chaining (?.) operator instead.", + "license": "MIT" + }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", + "deprecated": "This package is deprecated. Use require('node:util').isDeepStrictEqual instead.", + "license": "MIT" + }, + "node_modules/lodash.mergewith": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.mergewith/-/lodash.mergewith-4.6.2.tgz", + "integrity": "sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ==", + "license": "MIT" + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true, + "license": "ISC" + }, + "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/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/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "license": "MIT", + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, + "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/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "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/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/openapi-types": { + "version": "12.1.3", + "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", + "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", + "license": "MIT", + "peer": true + }, + "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-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true, + "license": "MIT" + }, + "node_modules/path-to-regexp": { + "version": "0.1.12", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.12.tgz", + "integrity": "sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ==", + "license": "MIT" + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "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/qs": { + "version": "6.14.1", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.1.tgz", + "integrity": "sha512-4EK3+xJl8Ts67nLYNwqw/dsFVnCf+qR7RgXSK9jEEm9unao3njwMDdmsdvoKBKHzxd7tCYz5e5M+SnMjdtXGQQ==", + "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/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/resolve": { + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.16.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/rimraf": { + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz", + "integrity": "sha512-uWjbaKIK3T1OSVptzX7Nl6PvQ3qAGtKEtVRjRuazjfL3Bx5eI409VZSqgND+4UNnmzLVdPj9FqFJNPqBZFve4w==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + } + }, + "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.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "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/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "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/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/swagger-jsdoc": { + "version": "6.2.8", + "resolved": "https://registry.npmjs.org/swagger-jsdoc/-/swagger-jsdoc-6.2.8.tgz", + "integrity": "sha512-VPvil1+JRpmJ55CgAtn8DIcpBs0bL5L3q5bVQvF4tAW/k/9JYSj7dCpaYCAv5rufe0vcCbBRQXGvzpkWjvLklQ==", + "license": "MIT", + "dependencies": { + "commander": "6.2.0", + "doctrine": "3.0.0", + "glob": "7.1.6", + "lodash.mergewith": "^4.6.2", + "swagger-parser": "^10.0.3", + "yaml": "2.0.0-1" + }, + "bin": { + "swagger-jsdoc": "bin/swagger-jsdoc.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/swagger-jsdoc/node_modules/glob": { + "version": "7.1.6", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", + "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/swagger-parser": { + "version": "10.0.3", + "resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-10.0.3.tgz", + "integrity": "sha512-nF7oMeL4KypldrQhac8RyHerJeGPD1p2xDh900GPvc+Nk7nWP6jX2FcC7WmkinMoAmoO774+AFXcWsW8gMWEIg==", + "license": "MIT", + "dependencies": { + "@apidevtools/swagger-parser": "10.0.3" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/swagger-ui-dist": { + "version": "5.31.0", + "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.31.0.tgz", + "integrity": "sha512-zSUTIck02fSga6rc0RZP3b7J7wgHXwLea8ZjgLA3Vgnb8QeOl3Wou2/j5QkzSGeoz6HusP/coYuJl33aQxQZpg==", + "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/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "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/tree-kill": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz", + "integrity": "sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==", + "dev": true, + "license": "MIT", + "bin": { + "tree-kill": "cli.js" + } + }, + "node_modules/ts-node": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/ts-node-dev": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ts-node-dev/-/ts-node-dev-2.0.0.tgz", + "integrity": "sha512-ywMrhCfH6M75yftYvrvNarLEY+SUXtUvU8/0Z6llrHQVBx12GiFk5sStF8UdfE/yfzk9IAq7O5EEbTQsxlBI8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "chokidar": "^3.5.1", + "dynamic-dedupe": "^0.3.0", + "minimist": "^1.2.6", + "mkdirp": "^1.0.4", + "resolve": "^1.0.0", + "rimraf": "^2.6.1", + "source-map-support": "^0.5.12", + "tree-kill": "^1.2.2", + "ts-node": "^10.4.0", + "tsconfig": "^7.0.0" + }, + "bin": { + "ts-node-dev": "lib/bin.js", + "tsnd": "lib/bin.js" + }, + "engines": { + "node": ">=0.8.0" + }, + "peerDependencies": { + "node-notifier": "*", + "typescript": "*" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/tsconfig": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/tsconfig/-/tsconfig-7.0.0.tgz", + "integrity": "sha512-vZXmzPrL+EmC4T/4rVlT2jNVMWCi/O4DIiSj3UHg1OE5kCKbk4mfrXc6dZksLgRM/TZlKnousKH9bbTazUWRRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/strip-bom": "^3.0.0", + "@types/strip-json-comments": "0.0.30", + "strip-bom": "^3.0.0", + "strip-json-comments": "^2.0.0" + } + }, + "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/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "6.21.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", + "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", + "dev": true, + "license": "MIT" + }, + "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/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true, + "license": "MIT" + }, + "node_modules/validator": { + "version": "13.15.26", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.15.26.tgz", + "integrity": "sha512-spH26xU080ydGggxRyR1Yhcbgx+j3y5jbNXk/8L+iRvdIEQ4uTRH2Sgf2dokud6Q4oAtsbNvJ1Ft+9xmm6IZcA==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "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/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "license": "ISC" + }, + "node_modules/xtend": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", + "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4" + } + }, + "node_modules/yaml": { + "version": "2.0.0-1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.0-1.tgz", + "integrity": "sha512-W7h5dEhywMKenDJh2iX/LABkbFnBxasD27oyXWDS/feDsxiw0dD5ncXdYXgkvAsXIY2MpW/ZKkr9IU30DBdMNQ==", + "license": "ISC", + "engines": { + "node": ">= 6" + } + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/z-schema": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", + "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", + "license": "MIT", + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^9.4.1" + } + }, + "node_modules/z-schema/node_modules/commander": { + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", + "license": "MIT", + "optional": true, + "engines": { + "node": "^12.20.0 || >=14" + } + } + } +} diff --git a/src/problem5/package.json b/src/problem5/package.json new file mode 100644 index 000000000..12eb1eb5c --- /dev/null +++ b/src/problem5/package.json @@ -0,0 +1,32 @@ +{ + "name": "crude-server", + "version": "1.0.0", + "description": "A CRUD backend server with ExpressJS and TypeScript", + "main": "dist/server.js", + "scripts": { + "dev": "ts-node-dev --respawn --transpile-only src/server.ts", + "build": "tsc", + "start": "node dist/server.js", + "test": "echo \"No tests specified\"" + }, + "keywords": ["express", "typescript", "crud", "api"], + "author": "", + "license": "ISC", + "dependencies": { + "express": "^4.18.2", + "cors": "^2.8.5", + "dotenv": "^16.3.1", + "swagger-ui-express": "^5.0.0", + "swagger-jsdoc": "^6.2.8" + }, + "devDependencies": { + "@types/express": "^4.17.21", + "@types/cors": "^2.8.17", + "@types/node": "^20.10.5", + "@types/swagger-ui-express": "^4.1.6", + "@types/swagger-jsdoc": "^6.0.4", + "typescript": "^5.3.3", + "ts-node": "^10.9.2", + "ts-node-dev": "^2.0.0" + } +} diff --git a/src/problem5/src/config/swagger.ts b/src/problem5/src/config/swagger.ts new file mode 100644 index 000000000..28a614f59 --- /dev/null +++ b/src/problem5/src/config/swagger.ts @@ -0,0 +1,188 @@ +import swaggerJsdoc from 'swagger-jsdoc'; + +const options: swaggerJsdoc.Options = { + definition: { + openapi: '3.0.0', + info: { + title: 'CRUD API Server', + version: '1.0.0', + description: 'A RESTful CRUD API server built with Express.js and TypeScript', + contact: { + name: 'API Support', + }, + }, + servers: [ + { + url: 'http://localhost:3000', + description: 'Development server', + }, + ], + tags: [ + { + name: 'Resources', + description: 'Resource management endpoints', + }, + ], + components: { + schemas: { + Resource: { + type: 'object', + required: ['id', 'name', 'description', 'type', 'status', 'createdAt', 'updatedAt'], + properties: { + id: { + type: 'string', + description: 'Unique resource identifier', + example: 'resource_1234567890_abc123', + }, + name: { + type: 'string', + description: 'Resource name', + example: 'Web Server', + }, + description: { + type: 'string', + description: 'Resource description', + example: 'Main production web server', + }, + type: { + type: 'string', + description: 'Resource type', + example: 'server', + }, + status: { + type: 'string', + enum: ['active', 'inactive'], + description: 'Resource status', + example: 'active', + }, + createdAt: { + type: 'string', + format: 'date-time', + description: 'Creation timestamp', + }, + updatedAt: { + type: 'string', + format: 'date-time', + description: 'Last update timestamp', + }, + metadata: { + type: 'object', + description: 'Additional resource metadata', + additionalProperties: true, + }, + }, + }, + CreateResourceDTO: { + type: 'object', + required: ['name', 'description', 'type'], + properties: { + name: { + type: 'string', + description: 'Resource name', + example: 'New Server', + }, + description: { + type: 'string', + description: 'Resource description', + example: 'Production server instance', + }, + type: { + type: 'string', + description: 'Resource type', + example: 'server', + }, + status: { + type: 'string', + enum: ['active', 'inactive'], + description: 'Resource status (optional, defaults to active)', + example: 'active', + }, + metadata: { + type: 'object', + description: 'Additional metadata (optional)', + additionalProperties: true, + }, + }, + }, + UpdateResourceDTO: { + type: 'object', + properties: { + name: { + type: 'string', + description: 'Resource name', + }, + description: { + type: 'string', + description: 'Resource description', + }, + type: { + type: 'string', + description: 'Resource type', + }, + status: { + type: 'string', + enum: ['active', 'inactive'], + description: 'Resource status', + }, + metadata: { + type: 'object', + description: 'Additional metadata', + additionalProperties: true, + }, + }, + }, + SuccessResponse: { + type: 'object', + properties: { + success: { + type: 'boolean', + example: true, + }, + data: { + $ref: '#/components/schemas/Resource', + }, + }, + }, + ListResponse: { + type: 'object', + properties: { + success: { + type: 'boolean', + example: true, + }, + count: { + type: 'number', + example: 10, + }, + data: { + type: 'array', + items: { + $ref: '#/components/schemas/Resource', + }, + }, + }, + }, + ErrorResponse: { + type: 'object', + properties: { + success: { + type: 'boolean', + example: false, + }, + message: { + type: 'string', + example: 'Error message', + }, + error: { + type: 'string', + example: 'Detailed error information', + }, + }, + }, + }, + }, + }, + apis: ['./src/routes/*.ts'], +}; + +export const swaggerSpec = swaggerJsdoc(options); diff --git a/src/problem5/src/database/db.ts b/src/problem5/src/database/db.ts new file mode 100644 index 000000000..aa59f0d09 --- /dev/null +++ b/src/problem5/src/database/db.ts @@ -0,0 +1,127 @@ +import fs from 'fs'; +import path from 'path'; +import { Resource, CreateResourceDTO, UpdateResourceDTO, ResourceFilter } from '../types/resource'; + +const DATA_FILE = path.join(__dirname, '../../data/resources.json'); + +// Ensure data directory and file exist +const ensureDataFile = () => { + const dataDir = path.dirname(DATA_FILE); + if (!fs.existsSync(dataDir)) { + fs.mkdirSync(dataDir, { recursive: true }); + } + if (!fs.existsSync(DATA_FILE)) { + fs.writeFileSync(DATA_FILE, JSON.stringify([], null, 2)); + } +}; + +// Read resources from file +const readResources = (): Resource[] => { + ensureDataFile(); + const data = fs.readFileSync(DATA_FILE, 'utf-8'); + return JSON.parse(data); +}; + +// Write resources to file +const writeResources = (resources: Resource[]): void => { + ensureDataFile(); + fs.writeFileSync(DATA_FILE, JSON.stringify(resources, null, 2)); +}; + +// Generate unique ID +const generateId = (): string => { + return `resource_${Date.now()}_${Math.random().toString(36).substr(2, 9)}`; +}; + +class Database { + // Get all resources with optional filters + getAllResources(filters?: ResourceFilter): Resource[] { + let resources = readResources(); + + if (filters) { + if (filters.type) { + resources = resources.filter(r => r.type === filters.type); + } + if (filters.status) { + resources = resources.filter(r => r.status === filters.status); + } + if (filters.search) { + const searchLower = filters.search.toLowerCase(); + resources = resources.filter(r => + r.name.toLowerCase().includes(searchLower) || + r.description.toLowerCase().includes(searchLower) + ); + } + } + + return resources; + } + + // Get resource by ID + getResourceById(id: string): Resource | null { + const resources = readResources(); + return resources.find(r => r.id === id) || null; + } + + // Create new resource + createResource(data: CreateResourceDTO): Resource { + const resources = readResources(); + + const newResource: Resource = { + id: generateId(), + name: data.name, + description: data.description, + type: data.type, + status: data.status || 'active', + createdAt: new Date().toISOString(), + updatedAt: new Date().toISOString(), + metadata: data.metadata || {} + }; + + resources.push(newResource); + writeResources(resources); + + return newResource; + } + + // Update resource + updateResource(id: string, data: UpdateResourceDTO): Resource | null { + const resources = readResources(); + const index = resources.findIndex(r => r.id === id); + + if (index === -1) { + return null; + } + + const updatedResource: Resource = { + ...resources[index], + ...data, + updatedAt: new Date().toISOString() + }; + + resources[index] = updatedResource; + writeResources(resources); + + return updatedResource; + } + + // Delete resource + deleteResource(id: string): boolean { + const resources = readResources(); + const filteredResources = resources.filter(r => r.id !== id); + + if (filteredResources.length === resources.length) { + return false; // Resource not found + } + + writeResources(filteredResources); + return true; + } + + // Check if resource exists + resourceExists(id: string): boolean { + return this.getResourceById(id) !== null; + } +} + +export default new Database(); diff --git a/src/problem5/src/middleware/errorHandler.ts b/src/problem5/src/middleware/errorHandler.ts new file mode 100644 index 000000000..bc0f0d609 --- /dev/null +++ b/src/problem5/src/middleware/errorHandler.ts @@ -0,0 +1,16 @@ +import { Request, Response, NextFunction } from 'express'; + +export const errorHandler = ( + err: Error, + req: Request, + res: Response, + next: NextFunction +) => { + console.error('Error:', err); + + res.status(500).json({ + success: false, + message: 'Internal server error', + error: process.env.NODE_ENV === 'development' ? err.message : undefined + }); +}; diff --git a/src/problem5/src/routes/resources.ts b/src/problem5/src/routes/resources.ts new file mode 100644 index 000000000..87a263127 --- /dev/null +++ b/src/problem5/src/routes/resources.ts @@ -0,0 +1,347 @@ +import { Router, Request, Response } from 'express'; +import db from '../database/db'; +import { CreateResourceDTO, UpdateResourceDTO, ResourceFilter } from '../types/resource'; + +const router = Router(); + +/** + * @swagger + * /api/resources: + * get: + * summary: List all resources + * description: Retrieve a list of all resources with optional filtering + * tags: [Resources] + * parameters: + * - in: query + * name: type + * schema: + * type: string + * description: Filter by resource type + * - in: query + * name: status + * schema: + * type: string + * enum: [active, inactive] + * description: Filter by status + * - in: query + * name: search + * schema: + * type: string + * description: Search in name and description + * responses: + * 200: + * description: List of resources + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ListResponse' + * 500: + * description: Server error + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + */ +router.get('/', (req: Request, res: Response) => { + try { + const filters: ResourceFilter = { + type: req.query.type as string, + status: req.query.status as 'active' | 'inactive', + search: req.query.search as string + }; + + const resources = db.getAllResources(filters); + + res.json({ + success: true, + count: resources.length, + data: resources + }); + } catch (error) { + res.status(500).json({ + success: false, + message: 'Failed to retrieve resources', + error: error instanceof Error ? error.message : 'Unknown error' + }); + } +}); + +/** + * @swagger + * /api/resources/{id}: + * get: + * summary: Get a resource by ID + * description: Retrieve details of a specific resource + * tags: [Resources] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: string + * description: Resource ID + * responses: + * 200: + * description: Resource details + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/SuccessResponse' + * 404: + * description: Resource not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + * 500: + * description: Server error + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + */ +router.get('/:id', (req: Request, res: Response) => { + try { + const { id } = req.params; + const resource = db.getResourceById(id); + + if (!resource) { + return res.status(404).json({ + success: false, + message: `Resource with ID '${id}' not found` + }); + } + + res.json({ + success: true, + data: resource + }); + } catch (error) { + res.status(500).json({ + success: false, + message: 'Failed to retrieve resource', + error: error instanceof Error ? error.message : 'Unknown error' + }); + } +}); + +/** + * @swagger + * /api/resources: + * post: + * summary: Create a new resource + * description: Add a new resource to the database + * tags: [Resources] + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/CreateResourceDTO' + * responses: + * 201: + * description: Resource created successfully + * content: + * application/json: + * schema: + * type: object + * properties: + * success: + * type: boolean + * example: true + * message: + * type: string + * example: Resource created successfully + * data: + * $ref: '#/components/schemas/Resource' + * 400: + * description: Bad request - missing required fields + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + * 500: + * description: Server error + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + */ +router.post('/', (req: Request, res: Response) => { + try { + const { name, description, type, status, metadata }: CreateResourceDTO = req.body; + + // Validation + if (!name || !description || !type) { + return res.status(400).json({ + success: false, + message: 'Missing required fields: name, description, and type are required' + }); + } + + const newResource = db.createResource({ + name, + description, + type, + status, + metadata + }); + + res.status(201).json({ + success: true, + message: 'Resource created successfully', + data: newResource + }); + } catch (error) { + res.status(500).json({ + success: false, + message: 'Failed to create resource', + error: error instanceof Error ? error.message : 'Unknown error' + }); + } +}); + +/** + * @swagger + * /api/resources/{id}: + * put: + * summary: Update a resource + * description: Update an existing resource by ID + * tags: [Resources] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: string + * description: Resource ID + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/UpdateResourceDTO' + * responses: + * 200: + * description: Resource updated successfully + * content: + * application/json: + * schema: + * type: object + * properties: + * success: + * type: boolean + * example: true + * message: + * type: string + * example: Resource updated successfully + * data: + * $ref: '#/components/schemas/Resource' + * 404: + * description: Resource not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + * 500: + * description: Server error + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + */ +router.put('/:id', (req: Request, res: Response) => { + try { + const { id } = req.params; + const updates: UpdateResourceDTO = req.body; + + const updatedResource = db.updateResource(id, updates); + + if (!updatedResource) { + return res.status(404).json({ + success: false, + message: `Resource with ID '${id}' not found` + }); + } + + res.json({ + success: true, + message: 'Resource updated successfully', + data: updatedResource + }); + } catch (error) { + res.status(500).json({ + success: false, + message: 'Failed to update resource', + error: error instanceof Error ? error.message : 'Unknown error' + }); + } +}); + +/** + * @swagger + * /api/resources/{id}: + * delete: + * summary: Delete a resource + * description: Remove a resource from the database + * tags: [Resources] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: string + * description: Resource ID + * responses: + * 200: + * description: Resource deleted successfully + * content: + * application/json: + * schema: + * type: object + * properties: + * success: + * type: boolean + * example: true + * message: + * type: string + * example: Resource deleted successfully + * 404: + * description: Resource not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + * 500: + * description: Server error + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/ErrorResponse' + */ +router.delete('/:id', (req: Request, res: Response) => { + try { + const { id } = req.params; + const success = db.deleteResource(id); + + if (!success) { + return res.status(404).json({ + success: false, + message: `Resource with ID '${id}' not found` + }); + } + + res.json({ + success: true, + message: 'Resource deleted successfully' + }); + } catch (error) { + res.status(500).json({ + success: false, + message: 'Failed to delete resource', + error: error instanceof Error ? error.message : 'Unknown error' + }); + } +}); + +export default router; diff --git a/src/problem5/src/server.ts b/src/problem5/src/server.ts new file mode 100644 index 000000000..01f60fb42 --- /dev/null +++ b/src/problem5/src/server.ts @@ -0,0 +1,52 @@ +import express, { Application } from 'express'; +import cors from 'cors'; +import dotenv from 'dotenv'; +import swaggerUi from 'swagger-ui-express'; +import { swaggerSpec } from './config/swagger'; +import resourceRoutes from './routes/resources'; +import { errorHandler } from './middleware/errorHandler'; + +dotenv.config(); + +const app: Application = express(); +const PORT = process.env.PORT || 3000; + +// Middleware +app.use(cors()); +app.use(express.json()); +app.use(express.urlencoded({ extended: true })); + +// Swagger Documentation +app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec, { + customCss: '.swagger-ui .topbar { display: none }', + customSiteTitle: 'CRUD API Documentation', +})); + +// Routes +app.get('/', (req, res) => { + res.json({ + message: 'Welcome to CRUD API Server', + version: '1.0.0', + documentation: `http://localhost:${PORT}/api-docs`, + endpoints: { + 'GET /api/resources': 'List all resources (with optional filters)', + 'GET /api/resources/:id': 'Get resource by ID', + 'POST /api/resources': 'Create a new resource', + 'PUT /api/resources/:id': 'Update a resource', + 'DELETE /api/resources/:id': 'Delete a resource' + } + }); +}); + +app.use('/api/resources', resourceRoutes); + +// Error handling middleware +app.use(errorHandler); + +// Start server +app.listen(PORT, () => { + console.log(`πŸš€ Server is running on http://localhost:${PORT}`); + console.log(`πŸ“ API documentation available at http://localhost:${PORT}/api-docs`); +}); + +export default app; diff --git a/src/problem5/src/types/resource.ts b/src/problem5/src/types/resource.ts new file mode 100644 index 000000000..72f8fc50d --- /dev/null +++ b/src/problem5/src/types/resource.ts @@ -0,0 +1,32 @@ +export interface Resource { + id: string; + name: string; + description: string; + type: string; + status: 'active' | 'inactive'; + createdAt: string; + updatedAt: string; + metadata?: Record; +} + +export interface CreateResourceDTO { + name: string; + description: string; + type: string; + status?: 'active' | 'inactive'; + metadata?: Record; +} + +export interface UpdateResourceDTO { + name?: string; + description?: string; + type?: string; + status?: 'active' | 'inactive'; + metadata?: Record; +} + +export interface ResourceFilter { + type?: string; + status?: 'active' | 'inactive'; + search?: string; +} diff --git a/src/problem5/tsconfig.json b/src/problem5/tsconfig.json new file mode 100644 index 000000000..8aa0a6f66 --- /dev/null +++ b/src/problem5/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "target": "ES2020", + "module": "commonjs", + "lib": ["ES2020"], + "outDir": "./dist", + "rootDir": "./src", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "moduleResolution": "node", + "resolveJsonModule": true, + "types": ["node"] + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "dist"] +} diff --git a/src/problem6/README.md b/src/problem6/README.md new file mode 100644 index 000000000..c1d856d48 --- /dev/null +++ b/src/problem6/README.md @@ -0,0 +1,1344 @@ +# Problem 6: Real-Time Score Board API Service - Architecture Specification + +## πŸ“‹ Table of Contents + +- [Overview](#overview) +- [System Architecture](#system-architecture) +- [Component Design](#component-design) +- [API Specifications](#api-specifications) +- [Data Models](#data-models) +- [Execution Flow Diagrams](#execution-flow-diagrams) +- [Security & Authorization](#security--authorization) +- [Real-Time Updates](#real-time-updates) +- [Performance Considerations](#performance-considerations) +- [Deployment Architecture](#deployment-architecture) +- [Improvements & Recommendations](#improvements--recommendations) + +--- + +## Overview + +This document specifies the architecture for a **Real-Time Score Board API Service** that enables: +- Live score updates for users performing actions +- Top 10 leaderboard display +- Secure, authorized score increments +- Real-time updates to all connected clients +- Protection against malicious score manipulation + +### Key Requirements + +1. βœ… Display top 10 users on a live score board +2. βœ… Real-time score board updates across all clients +3. βœ… User actions trigger score increments +4. βœ… API calls to backend server for score updates +5. βœ… Prevention of unauthorized score manipulation + +--- + +## System Architecture + +### High-Level Architecture + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Client Layer β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Web App β”‚ β”‚ Web App β”‚ β”‚ Web App β”‚ β”‚ +β”‚ β”‚ (Browser) β”‚ β”‚ (Browser) β”‚ β”‚ (Browser) β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ WebSocket β”‚ WebSocket β”‚ WebSocket β”‚ +β”‚ β”‚ REST API β”‚ REST API β”‚ REST API β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ β”‚ β”‚ + β–Ό β–Ό β–Ό +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Load Balancer (Optional) β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Application Server β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ API Gateway / Express Server β”‚ β”‚ +β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ +β”‚ β”‚ β”‚ REST API β”‚ β”‚ WebSocket β”‚ β”‚ Auth Middleware β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ Endpoints β”‚ β”‚ Server β”‚ β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Business Logic Layer β”‚ β”‚ +β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ +β”‚ β”‚ β”‚Score Service β”‚ β”‚Auth Service β”‚ β”‚ Leaderboard β”‚ β”‚ β”‚ +β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ Service β”‚ β”‚ β”‚ +β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Cache Layer (Redis) β”‚ β”‚ +β”‚ β”‚ - Top 10 Leaderboard Cache β”‚ β”‚ +β”‚ β”‚ - User Session Data β”‚ β”‚ +β”‚ β”‚ - Rate Limiting Counters β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Database Layer β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Primary DB │◄───────►│ Read Replicas β”‚ β”‚ +β”‚ β”‚ (PostgreSQL/ β”‚ β”‚ (Optional for scale) β”‚ β”‚ +β”‚ β”‚ MySQL) β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ - Users β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ - Scores β”‚ β”‚ β”‚ β”‚ +β”‚ β”‚ - Actions Log β”‚ β”‚ β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## Component Design + +### 1. **API Gateway / Express Server** + +**Responsibilities:** +- Handle incoming HTTP/HTTPS requests +- Route requests to appropriate services +- Manage WebSocket connections for real-time updates +- Apply authentication and authorization middleware +- Rate limiting and request validation + +**Tech Stack:** +- **Framework**: Express.js or Fastify +- **WebSocket**: Socket.io or ws +- **Language**: Node.js (TypeScript) + +### 2. **Authentication & Authorization Service** + +**Responsibilities:** +- Verify user identity (JWT tokens, session tokens) +- Validate action authorization (ensure user can perform the action) +- Generate and verify cryptographic signatures for action completion +- Maintain session state + +**Security Mechanisms:** +- JWT (JSON Web Tokens) with short expiration +- Action tokens with HMAC signatures +- CSRF protection +- Rate limiting per user + +### 3. **Score Service** + +**Responsibilities:** +- Process score increment requests +- Validate action completion proofs +- Update user scores in database +- Emit events for leaderboard updates +- Maintain audit log of score changes + +**Key Features:** +- Idempotency keys to prevent duplicate submissions +- Atomic database transactions +- Action validation against server-side rules + +### 4. **Leaderboard Service** + +**Responsibilities:** +- Fetch and cache top 10 users +- Broadcast updates to connected clients via WebSocket +- Handle leaderboard queries efficiently +- Maintain real-time ranking calculations + +### 5. **Cache Layer (Redis)** + +**Purpose:** +- Store top 10 leaderboard (Sorted Set) +- Cache user session data +- Rate limiting counters +- Action completion tokens (with TTL) + +### 6. **Database Layer** + +**Primary Database Schema:** + +```sql +-- Users table +CREATE TABLE users ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + username VARCHAR(50) UNIQUE NOT NULL, + email VARCHAR(255) UNIQUE NOT NULL, + total_score BIGINT DEFAULT 0, + created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, + updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP +); + +-- Scores/Actions table +CREATE TABLE score_events ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + user_id UUID REFERENCES users(id), + action_type VARCHAR(50) NOT NULL, + points_earned INT NOT NULL, + action_token VARCHAR(255) UNIQUE NOT NULL, + metadata JSONB, + created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, + INDEX idx_user_id (user_id), + INDEX idx_created_at (created_at), + INDEX idx_action_token (action_token) +); + +-- Leaderboard materialized view (for performance) +CREATE MATERIALIZED VIEW leaderboard_top_100 AS +SELECT + u.id, + u.username, + u.total_score, + RANK() OVER (ORDER BY u.total_score DESC) as rank +FROM users u +ORDER BY u.total_score DESC +LIMIT 100; + +-- Index for fast leaderboard queries +CREATE INDEX idx_users_score ON users(total_score DESC); +``` + +--- + +## API Specifications + +### Base URL +``` +https://api.example.com/v1 +``` + +### Authentication +All API requests require authentication via JWT token in the `Authorization` header: +``` +Authorization: Bearer +``` + +--- + +### 1. **Get Top 10 Leaderboard** + +```http +GET /leaderboard/top10 +``` + +**Response:** +```json +{ + "success": true, + "data": { + "leaderboard": [ + { + "rank": 1, + "userId": "uuid-123", + "username": "player1", + "score": 15000 + }, + { + "rank": 2, + "userId": "uuid-456", + "username": "player2", + "score": 12500 + } + // ... up to 10 users + ], + "lastUpdated": "2026-01-25T10:30:00Z" + } +} +``` + +--- + +### 2. **Request Action Token (Pre-authorization)** + +Before a user performs an action, they request a cryptographically signed token: + +```http +POST /actions/request-token +``` + +**Request Body:** +```json +{ + "actionType": "complete_task" +} +``` + +**Response:** +```json +{ + "success": true, + "data": { + "actionToken": "eyJhbGc...", // HMAC-signed token + "expiresAt": "2026-01-25T10:35:00Z", // 5 minutes TTL + "expectedPoints": 100 + } +} +``` + +**Purpose:** +- Server pre-authorizes the action +- Token contains: userId, actionType, timestamp, nonce +- Token is stored in Redis with TTL +- Prevents replay attacks + +--- + +### 3. **Submit Action Completion (Update Score)** + +After completing the action, client submits the token: + +```http +POST /scores/submit-action +``` + +**Request Body:** +```json +{ + "actionToken": "eyJhbGc...", // Token from step 2 + "actionProof": { + "completedAt": "2026-01-25T10:33:00Z", + "metadata": { + // Optional action-specific data + } + } +} +``` + +**Response:** +```json +{ + "success": true, + "data": { + "pointsEarned": 100, + "newTotalScore": 5600, + "newRank": 15, + "wasInTop10": false + } +} +``` + +**Server-side Processing:** +1. Verify JWT authentication +2. Validate `actionToken` signature +3. Check token hasn't been used (idempotency) +4. Verify token hasn't expired +5. Mark token as consumed in Redis +6. Update user score in database (atomic transaction) +7. Update leaderboard cache +8. Broadcast WebSocket event if top 10 changed +9. Return result + +--- + +### 4. **Get User Profile & Score** + +```http +GET /users/me +``` + +**Response:** +```json +{ + "success": true, + "data": { + "userId": "uuid-123", + "username": "player1", + "totalScore": 5600, + "rank": 15, + "recentActions": [ + { + "actionType": "complete_task", + "points": 100, + "timestamp": "2026-01-25T10:33:00Z" + } + ] + } +} +``` + +--- + +### 5. **WebSocket Events** + +**Connection:** +```javascript +const socket = io('wss://api.example.com', { + auth: { + token: 'jwt_token_here' + } +}); +``` + +**Server β†’ Client Events:** + +```javascript +// Leaderboard update +socket.on('leaderboard:update', (data) => { + // { + // leaderboard: [...top 10 users], + // updatedAt: "2026-01-25T10:33:00Z" + // } +}); + +// User's score updated +socket.on('score:updated', (data) => { + // { + // userId: "uuid-123", + // newScore: 5700, + // pointsEarned: 100, + // newRank: 14 + // } +}); + +// User entered top 10 +socket.on('leaderboard:entry', (data) => { + // { + // userId: "uuid-123", + // username: "player1", + // rank: 10, + // score: 10000 + // } +}); +``` + +--- + +## Data Models + +### TypeScript Interfaces + +```typescript +// User Model +interface User { + id: string; + username: string; + email: string; + totalScore: number; + createdAt: Date; + updatedAt: Date; +} + +// Score Event Model +interface ScoreEvent { + id: string; + userId: string; + actionType: string; + pointsEarned: number; + actionToken: string; + metadata?: Record; + createdAt: Date; +} + +// Leaderboard Entry +interface LeaderboardEntry { + rank: number; + userId: string; + username: string; + score: number; +} + +// Action Token Payload +interface ActionTokenPayload { + userId: string; + actionType: string; + expectedPoints: number; + nonce: string; + issuedAt: number; + expiresAt: number; +} + +// Action Submission +interface ActionSubmission { + actionToken: string; + actionProof: { + completedAt: Date; + metadata?: Record; + }; +} +``` + +--- + +## Execution Flow Diagrams + +### Flow 1: User Action Completion & Score Update + +```mermaid +sequenceDiagram + participant Client as Web Client + participant API as API Server + participant Auth as Auth Service + participant Score as Score Service + participant DB as Database + participant Cache as Redis Cache + participant WS as WebSocket Server + + Note over Client,WS: Phase 1: Request Action Token + Client->>API: POST /actions/request-token + API->>Auth: Verify JWT & User + Auth-->>API: User Authenticated + API->>Score: Generate Action Token + Score->>Cache: Store Token (TTL: 5min) + Score-->>API: Return Signed Token + API-->>Client: { actionToken, expiresAt } + + Note over Client,WS: Phase 2: User Completes Action (Client-side) + Client->>Client: User performs action + Client->>Client: Action completed successfully + + Note over Client,WS: Phase 3: Submit Action & Update Score + Client->>API: POST /scores/submit-action + API->>Auth: Verify JWT + Auth-->>API: Authenticated + API->>Score: Validate Action Token + Score->>Cache: Check Token Exists & Not Used + Cache-->>Score: Token Valid + Score->>Cache: Mark Token as Consumed + Score->>DB: BEGIN TRANSACTION + Score->>DB: INSERT INTO score_events + Score->>DB: UPDATE users SET total_score = total_score + points + Score->>DB: COMMIT TRANSACTION + DB-->>Score: Success + Score->>Cache: Update Leaderboard Cache + Cache-->>Score: Leaderboard Updated + Score->>WS: Emit leaderboard:update event + WS->>Client: Broadcast to all connected clients + Score-->>API: { newScore, newRank, pointsEarned } + API-->>Client: Success Response + + Note over Client,WS: Phase 4: Real-time Update + WS->>Client: leaderboard:update event + Client->>Client: Update UI with new leaderboard +``` + +### Flow 2: Real-Time Leaderboard Updates + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ User A β”‚ +β”‚ (Client) β”‚ +β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”‚ 1. Complete Action + β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β–Ό + β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ API Server β”‚ + β”‚ β”‚ Score Service β”‚ + β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ β”‚ + β”‚ 2. Update Database + β”‚ β”‚ + β”‚ β–Ό + β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ PostgreSQL β”‚ + β”‚ β”‚ total_score++ β”‚ + β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ β”‚ + β”‚ 3. Update Cache + β”‚ β”‚ + β”‚ β–Ό + β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ Redis (ZADD) β”‚ + β”‚ β”‚ Leaderboard β”‚ + β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ β”‚ + β”‚ 4. Broadcast Event + β”‚ β”‚ + β”‚ β–Ό + β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”Œβ”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” β”‚ WebSocket Hub β”‚ +β”‚ User A │◄────────────────── β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ (Updated) β”‚ 5. WS Event β”‚ Socket.io β”‚ 5. WS Eventβ”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ + β”‚ +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” +β”‚ User B │◄───────────────────────────────────────│ User C β”‚ +β”‚ (Spectator) β”‚ 5. WS Event β”‚ (Spectator) β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + +All users see updated leaderboard in real-time! +``` + +### Flow 3: Security Token Validation + +``` +Client Request + β”‚ + β–Ό +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 1. Extract JWT from Header β”‚ +β”‚ Authorization: Bearer β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 2. Verify JWT Signature β”‚ +β”‚ - Check expiration β”‚ +β”‚ - Validate issuer β”‚ +β”‚ - Extract userId β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”œβ”€β”€ Invalid ──► 401 Unauthorized + β”‚ + β–Ό Valid +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 3. Verify Action Token (HMAC) β”‚ +β”‚ - Signature validation β”‚ +β”‚ - Check expiration (5 min) β”‚ +β”‚ - Extract payload β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”œβ”€β”€ Invalid ──► 400 Bad Request + β”‚ + β–Ό Valid +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 4. Check Token Usage (Redis) β”‚ +β”‚ GET action_token: β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”œβ”€β”€ Already Used ──► 409 Conflict + β”‚ + β–Ό Not Used +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 5. Mark Token as Consumed β”‚ +β”‚ SET action_token: 1 β”‚ +β”‚ EXPIRE 3600 (1 hour TTL) β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β–Ό +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ 6. Process Score Update β”‚ +β”‚ (Atomic Transaction) β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## Security & Authorization + +### 1. **Action Token System (Preventing Unauthorized Score Increases)** + +**Problem:** Prevent users from directly calling the score update API without actually completing actions. + +**Solution: Two-Phase Token System** + +**Phase 1: Token Request** +```typescript +// Server generates a cryptographically signed token +const actionToken = { + userId: user.id, + actionType: 'complete_task', + expectedPoints: 100, + nonce: crypto.randomBytes(16).toString('hex'), + issuedAt: Date.now(), + expiresAt: Date.now() + 5 * 60 * 1000 // 5 minutes +}; + +// Sign with HMAC +const signature = crypto + .createHmac('sha256', process.env.ACTION_SECRET) + .update(JSON.stringify(actionToken)) + .digest('hex'); + +const signedToken = `${Buffer.from(JSON.stringify(actionToken)).toString('base64')}.${signature}`; + +// Store in Redis with TTL +await redis.setex(`action_token:${signature}`, 300, JSON.stringify(actionToken)); +``` + +**Phase 2: Token Submission** +```typescript +// Client submits the token after completing action +// Server verifies: +1. Token signature is valid +2. Token hasn't expired +3. Token hasn't been used before (check Redis) +4. User ID in token matches authenticated user +5. Action type is allowed +``` + +**Benefits:** +- Server controls when actions can be performed +- Tokens expire quickly (5 minutes) +- One-time use only (idempotency) +- Cryptographic signature prevents tampering +- No client-side score calculation + +### 2. **Rate Limiting** + +**Per-User Rate Limiting:** +```typescript +// Using Redis +const rateLimitKey = `rate_limit:${userId}:${actionType}`; +const requestCount = await redis.incr(rateLimitKey); + +if (requestCount === 1) { + await redis.expire(rateLimitKey, 60); // 1 minute window +} + +if (requestCount > 10) { // Max 10 actions per minute + throw new TooManyRequestsError(); +} +``` + +**Global Rate Limiting:** +```typescript +// Using middleware like express-rate-limit +import rateLimit from 'express-rate-limit'; + +const apiLimiter = rateLimit({ + windowMs: 15 * 60 * 1000, // 15 minutes + max: 100, // Limit each IP to 100 requests per windowMs + standardHeaders: true, + legacyHeaders: false, +}); + +app.use('/api/', apiLimiter); +``` + +### 3. **Input Validation** + +```typescript +import { z } from 'zod'; + +const ActionSubmissionSchema = z.object({ + actionToken: z.string().min(1), + actionProof: z.object({ + completedAt: z.string().datetime(), + metadata: z.record(z.any()).optional() + }) +}); + +// Validate request body +const validatedData = ActionSubmissionSchema.parse(req.body); +``` + +### 4. **SQL Injection Prevention** + +Use parameterized queries or ORM: +```typescript +// βœ… Good: Parameterized query +const result = await db.query( + 'UPDATE users SET total_score = total_score + $1 WHERE id = $2', + [points, userId] +); + +// ❌ Bad: String concatenation +// const result = await db.query(`UPDATE users SET total_score = total_score + ${points} WHERE id = '${userId}'`); +``` + +### 5. **Audit Logging** + +```typescript +// Log all score changes +await db.query(` + INSERT INTO score_events (user_id, action_type, points_earned, action_token, metadata) + VALUES ($1, $2, $3, $4, $5) +`, [userId, actionType, points, actionToken, metadata]); + +// Benefits: +// - Detect suspicious patterns +// - Forensic analysis +// - Fraud detection +// - Compliance +``` + +--- + +## Real-Time Updates + +### WebSocket Implementation (Socket.io) + +**Server Setup:** +```typescript +import { Server } from 'socket.io'; +import { verify } from 'jsonwebtoken'; + +const io = new Server(httpServer, { + cors: { + origin: process.env.CLIENT_URL, + credentials: true + } +}); + +// Authentication middleware +io.use(async (socket, next) => { + try { + const token = socket.handshake.auth.token; + const decoded = verify(token, process.env.JWT_SECRET); + socket.data.userId = decoded.userId; + next(); + } catch (err) { + next(new Error('Authentication failed')); + } +}); + +// Connection handler +io.on('connection', (socket) => { + console.log(`User ${socket.data.userId} connected`); + + // Join user's personal room + socket.join(`user:${socket.data.userId}`); + + // Join global leaderboard room + socket.join('leaderboard'); + + socket.on('disconnect', () => { + console.log(`User ${socket.data.userId} disconnected`); + }); +}); + +// Broadcast leaderboard updates +export function broadcastLeaderboardUpdate(leaderboard: LeaderboardEntry[]) { + io.to('leaderboard').emit('leaderboard:update', { + leaderboard, + updatedAt: new Date().toISOString() + }); +} + +// Notify specific user +export function notifyUserScoreUpdate(userId: string, data: any) { + io.to(`user:${userId}`).emit('score:updated', data); +} +``` + +**Client Implementation:** +```typescript +import io from 'socket.io-client'; + +const socket = io('wss://api.example.com', { + auth: { + token: localStorage.getItem('jwt_token') + } +}); + +socket.on('connect', () => { + console.log('Connected to WebSocket'); +}); + +socket.on('leaderboard:update', (data) => { + // Update UI with new leaderboard + updateLeaderboardUI(data.leaderboard); +}); + +socket.on('score:updated', (data) => { + // Update user's score display + updateUserScore(data.newScore, data.pointsEarned); +}); + +socket.on('disconnect', () => { + console.log('Disconnected from WebSocket'); + // Implement reconnection logic +}); +``` + +--- + +## Performance Considerations + +### 1. **Leaderboard Caching Strategy** + +**Redis Sorted Set:** +```typescript +// Update leaderboard in Redis when score changes +async function updateLeaderboardCache(userId: string, username: string, newScore: number) { + await redis.zadd('leaderboard:global', newScore, `${userId}:${username}`); + + // Keep only top 100 for efficiency + await redis.zremrangebyrank('leaderboard:global', 0, -101); +} + +// Fetch top 10 +async function getTop10() { + const top10 = await redis.zrevrange('leaderboard:global', 0, 9, 'WITHSCORES'); + + return top10.map((entry, index) => { + const [userId, username] = entry.split(':'); + const score = top10[index + 1]; + return { rank: Math.floor(index / 2) + 1, userId, username, score }; + }); +} +``` + +**Cache Invalidation:** +- Update cache on every score change +- Set TTL of 5 minutes as fallback +- Rebuild from database if cache miss + +### 2. **Database Optimization** + +**Indexes:** +```sql +-- Fast leaderboard queries +CREATE INDEX idx_users_score ON users(total_score DESC); + +-- Fast user lookups +CREATE INDEX idx_users_id ON users(id); + +-- Fast score event queries +CREATE INDEX idx_score_events_user_id ON score_events(user_id); +CREATE INDEX idx_score_events_token ON score_events(action_token); +``` + +**Materialized Views:** +```sql +-- Pre-computed leaderboard +CREATE MATERIALIZED VIEW leaderboard_top_100 AS +SELECT + u.id, + u.username, + u.total_score, + RANK() OVER (ORDER BY u.total_score DESC) as rank +FROM users u +ORDER BY u.total_score DESC +LIMIT 100; + +-- Refresh every minute +REFRESH MATERIALIZED VIEW CONCURRENTLY leaderboard_top_100; +``` + +### 3. **Horizontal Scaling** + +**Stateless API Servers:** +- Store sessions in Redis, not in-memory +- Use load balancer for distributing requests +- Enable WebSocket sticky sessions + +**Redis Cluster:** +- Shard data across multiple Redis nodes +- Use Redis Sentinel for high availability + +**Database Read Replicas:** +- Direct read queries to replicas +- Write operations to primary +- Eventual consistency acceptable for leaderboard + +### 4. **Connection Pooling** + +```typescript +// PostgreSQL connection pool +import { Pool } from 'pg'; + +const pool = new Pool({ + host: process.env.DB_HOST, + port: 5432, + database: process.env.DB_NAME, + user: process.env.DB_USER, + password: process.env.DB_PASSWORD, + max: 20, // Maximum pool size + idleTimeoutMillis: 30000, + connectionTimeoutMillis: 2000, +}); +``` + +--- + +## Deployment Architecture + +### Production Environment + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Cloud Provider (AWS/GCP/Azure) β”‚ +β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ CDN (CloudFront / CloudFlare) β”‚ β”‚ +β”‚ β”‚ - Cache static assets β”‚ β”‚ +β”‚ β”‚ - DDoS protection β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Load Balancer (ALB / NLB) β”‚ β”‚ +β”‚ β”‚ - SSL/TLS termination β”‚ β”‚ +β”‚ β”‚ - Health checks β”‚ β”‚ +β”‚ β”‚ - Sticky sessions for WebSocket β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ API Server 1 β”‚ β”‚ API Server 2 β”‚ β”‚ +β”‚ β”‚ (Container) β”‚ β”‚ (Container) β”‚ β”‚ +β”‚ β”‚ - Express.js β”‚ β”‚ - Express.js β”‚ β”‚ +β”‚ β”‚ - Socket.io β”‚ β”‚ - Socket.io β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ Redis Cluster (ElastiCache / Memorystore) β”‚ β”‚ +β”‚ β”‚ - Primary + Replicas β”‚ β”‚ +β”‚ β”‚ - Automatic failover β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β”‚ β”‚ β”‚ +β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ +β”‚ β”‚ PostgreSQL (RDS / Cloud SQL) β”‚ β”‚ +β”‚ β”‚ - Primary + Read Replicas β”‚ β”‚ +β”‚ β”‚ - Automated backups β”‚ β”‚ +β”‚ β”‚ - Multi-AZ deployment β”‚ β”‚ +β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +### Container Orchestration (Kubernetes) + +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: scoreboard-api +spec: + replicas: 3 + selector: + matchLabels: + app: scoreboard-api + template: + metadata: + labels: + app: scoreboard-api + spec: + containers: + - name: api + image: scoreboard-api:latest + ports: + - containerPort: 3000 + env: + - name: DATABASE_URL + valueFrom: + secretKeyRef: + name: db-credentials + key: url + - name: REDIS_URL + valueFrom: + secretKeyRef: + name: redis-credentials + key: url + resources: + requests: + memory: "256Mi" + cpu: "250m" + limits: + memory: "512Mi" + cpu: "500m" + livenessProbe: + httpGet: + path: /health + port: 3000 + initialDelaySeconds: 30 + periodSeconds: 10 +``` + +--- + +## Improvements & Recommendations + +### 1. **Enhanced Security** + +#### Implement Device Fingerprinting +```typescript +// Track devices to detect suspicious activity +const deviceFingerprint = crypto + .createHash('sha256') + .update(userAgent + ipAddress + acceptLanguage) + .digest('hex'); + +await redis.setex(`device:${userId}:${deviceFingerprint}`, 86400, '1'); +``` + +#### Add Anomaly Detection +```typescript +// Detect unusual score patterns +async function detectAnomalies(userId: string, points: number) { + const recentScores = await db.query(` + SELECT points_earned, created_at + FROM score_events + WHERE user_id = $1 + AND created_at > NOW() - INTERVAL '1 hour' + ORDER BY created_at DESC + LIMIT 20 + `, [userId]); + + // Check for: + // - Too many actions in short time + // - Unusually high point values + // - Perfect timing patterns (bot-like behavior) + + if (isAnomaly(recentScores, points)) { + await flagForReview(userId); + await notifyAdmin(userId, 'Suspicious activity detected'); + } +} +``` + +#### Implement CAPTCHA for Suspicious Users +```typescript +// Require CAPTCHA verification if flagged +if (user.isFlagged) { + const captchaValid = await verifyCaptcha(req.body.captchaToken); + if (!captchaValid) { + throw new Error('CAPTCHA verification failed'); + } +} +``` + +### 2. **Performance Enhancements** + +#### Implement Pagination for History +```typescript +// GET /users/me/history?page=1&limit=20 +app.get('/users/me/history', async (req, res) => { + const page = parseInt(req.query.page) || 1; + const limit = parseInt(req.query.limit) || 20; + const offset = (page - 1) * limit; + + const history = await db.query(` + SELECT * FROM score_events + WHERE user_id = $1 + ORDER BY created_at DESC + LIMIT $2 OFFSET $3 + `, [req.user.id, limit, offset]); + + res.json({ data: history, page, limit }); +}); +``` + +#### Add GraphQL for Flexible Queries +```typescript +// Allow clients to request exactly what they need +type Query { + leaderboard(top: Int = 10): [LeaderboardEntry!]! + user(id: ID!): User + me: User +} + +type User { + id: ID! + username: String! + score: Int! + rank: Int! + recentActions(limit: Int = 10): [ScoreEvent!]! +} +``` + +#### Implement CDN for Static Leaderboard +```typescript +// Cache leaderboard HTML/JSON at edge locations +// Update cache every 5 seconds via webhook +app.get('/leaderboard/static', async (req, res) => { + res.set('Cache-Control', 'public, max-age=5'); + const leaderboard = await getTop10FromCache(); + res.json(leaderboard); +}); +``` + +### 3. **Monitoring & Observability** + +#### Add Comprehensive Logging +```typescript +import winston from 'winston'; + +const logger = winston.createLogger({ + level: 'info', + format: winston.format.json(), + transports: [ + new winston.transports.File({ filename: 'error.log', level: 'error' }), + new winston.transports.File({ filename: 'combined.log' }) + ] +}); + +// Log all score updates +logger.info('Score updated', { + userId, + actionType, + pointsEarned, + newScore, + timestamp: new Date() +}); +``` + +#### Implement Metrics Collection +```typescript +import prometheus from 'prom-client'; + +const scoreUpdatesCounter = new prometheus.Counter({ + name: 'score_updates_total', + help: 'Total number of score updates', + labelNames: ['action_type', 'status'] +}); + +const leaderboardCacheHitRatio = new prometheus.Gauge({ + name: 'leaderboard_cache_hit_ratio', + help: 'Cache hit ratio for leaderboard queries' +}); + +// Expose metrics endpoint +app.get('/metrics', async (req, res) => { + res.set('Content-Type', prometheus.register.contentType); + res.end(await prometheus.register.metrics()); +}); +``` + +#### Set Up Alerts +```yaml +# Prometheus alert rules +groups: + - name: scoreboard_alerts + rules: + - alert: HighErrorRate + expr: rate(http_requests_total{status=~"5.."}[5m]) > 0.05 + annotations: + summary: "High error rate detected" + + - alert: SlowDatabaseQueries + expr: histogram_quantile(0.95, rate(db_query_duration_seconds_bucket[5m])) > 1 + annotations: + summary: "Database queries are slow" +``` + +### 4. **Feature Additions** + +#### Add Achievements System +```typescript +// Award badges for milestones +const achievements = [ + { id: 'first_100', name: 'Century', requirement: 100 }, + { id: 'top_10', name: 'Elite Player', requirement: 'rank <= 10' }, + { id: 'streak_7', name: 'Weekly Warrior', requirement: '7 day streak' } +]; + +async function checkAchievements(userId: string, newScore: number) { + // Check and award achievements + // Emit WebSocket event for achievement unlocked +} +``` + +#### Implement Leaderboard Periods +```typescript +// Multiple leaderboards: daily, weekly, monthly, all-time +app.get('/leaderboard/:period/top10', async (req, res) => { + const { period } = req.params; // 'daily', 'weekly', 'monthly', 'all-time' + + const startDate = getStartDateForPeriod(period); + + const leaderboard = await db.query(` + SELECT + u.id, + u.username, + SUM(se.points_earned) as period_score, + RANK() OVER (ORDER BY SUM(se.points_earned) DESC) as rank + FROM users u + JOIN score_events se ON u.id = se.user_id + WHERE se.created_at >= $1 + GROUP BY u.id, u.username + ORDER BY period_score DESC + LIMIT 10 + `, [startDate]); + + res.json({ data: leaderboard }); +}); +``` + +#### Add Social Features +```typescript +// Friend system +// Compare scores with friends +// Challenge friends +// Share achievements +``` + +### 5. **Scalability Improvements** + +#### Implement Event-Driven Architecture +```typescript +// Use message queue (RabbitMQ, Kafka) for async processing +import { EventEmitter } from 'events'; + +const eventBus = new EventEmitter(); + +// Producer +eventBus.emit('score.updated', { + userId, + newScore, + pointsEarned, + timestamp: Date.now() +}); + +// Consumer +eventBus.on('score.updated', async (data) => { + await updateLeaderboardCache(data); + await checkAchievements(data.userId, data.newScore); + await notifyFollowers(data.userId, data); +}); +``` + +#### Database Sharding Strategy +```typescript +// Shard users by ID range +function getShardForUser(userId: string): string { + const hash = crypto.createHash('md5').update(userId).digest('hex'); + const shardNumber = parseInt(hash.substring(0, 8), 16) % NUM_SHARDS; + return `shard_${shardNumber}`; +} +``` + +### 6. **Testing Recommendations** + +```typescript +// Unit tests +describe('ScoreService', () => { + it('should update user score atomically', async () => { + const result = await scoreService.updateScore(userId, 100); + expect(result.newScore).toBe(previousScore + 100); + }); + + it('should prevent duplicate token usage', async () => { + await scoreService.submitAction(token); + await expect(scoreService.submitAction(token)).rejects.toThrow('Token already used'); + }); +}); + +// Integration tests +describe('API Endpoints', () => { + it('should return top 10 leaderboard', async () => { + const response = await request(app).get('/leaderboard/top10'); + expect(response.status).toBe(200); + expect(response.body.data.leaderboard).toHaveLength(10); + }); +}); + +// Load tests (using k6 or Artillery) +// Performance benchmarks +// Security penetration testing +``` + +--- + +## Conclusion + +This architecture provides: + +βœ… **Secure** score update mechanism with cryptographic tokens +βœ… **Real-time** leaderboard updates via WebSocket +βœ… **Scalable** design with caching and horizontal scaling +βœ… **Performant** with Redis caching and database optimization +βœ… **Auditable** with comprehensive logging +βœ… **Extensible** for future features + +The two-phase token system ensures that only authorized actions result in score updates, preventing malicious users from artificially inflating their scores. The combination of WebSocket for real-time updates and Redis caching ensures the leaderboard stays responsive even under high load. + +### Next Steps for Implementation Team + +1. Set up development environment with PostgreSQL + Redis +2. Implement authentication service with JWT +3. Build score service with token generation and validation +4. Develop WebSocket server for real-time updates +5. Create leaderboard cache layer with Redis +6. Implement rate limiting and security measures +7. Add comprehensive testing suite +8. Deploy to staging environment +9. Perform load testing and security audit +10. Deploy to production with monitoring + +**Estimated Implementation Time**: 4-6 weeks for MVP with a team of 3-4 backend engineers.