opticore-api-gateway 1.0.0

package/dist/utils/translations/message.translation.en.json

@@ -0,0 +1,5 @@
+{
+  "ROUTER_COLLECTION_NOT_FOUND": "Collection router not initialized. Call createCollectionRouter first.",
+  "MISSING_ROUTES": "MISSING ROUTES",
+  "ROUTER_COLLECTION": "ROUTER COLLECTION"
+}

package/dist/utils/translations/message.translation.fr.json

@@ -0,0 +1,5 @@
+{
+  "ROUTER_COLLECTION_NOT_FOUND": "Le routeur de collection n'est pas initialisé. Veuillez d'abord appeler createCollectionRouter",
+  "MISSING_ROUTES": "ROUTES MANQUANTES",
+  "ROUTER_COLLECTION": "COLLECTION ROUTER"
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "opticore-api-gateway",
+  "version": "1.0.0",
+  "description": "OptiCore API Gateway",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsup",
+    "postinstall": "node scripts/postinstall.cjs"
+  },
+  "files": [
+    "dist",
+    "scripts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guyzoum77/opticore-api-gateway.git"
+  },
+  "keywords": [
+    "opticore",
+    "opticore-api-gateway"
+  ],
+  "author": "Guy-serge Kouacou",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/guyzoum77/opticore-api-gateway/issues"
+  },
+  "homepage": "https://github.com/guyzoum77/opticore-api-gateway#readme",
+  "dependencies": {
+    "ansi-colors": "^4.1.3",
+    "chalk": "^5.6.2",
+    "gradient-string": "^3.0.0",
+    "opticore-http-response": "^1.0.9",
+    "opticore-logger": "^1.0.29",
+    "opticore-router": "^1.0.20",
+    "opticore-translator": "^1.0.13",
+    "opticore-validator": "^1.0.3"
+  },
+  "devDependencies": {
+    "@types/gradient-string": "^1.1.6",
+    "@types/node": "^22.19.7",
+    "reflect-metadata": "^0.2.2",
+    "tslib": "^2.8.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.4.5"
+  }
+}

package/scripts/postinstall.cjs

@@ -0,0 +1,127 @@
+#!/usr/bin/env node
+
+/**
+ * postinstall.js
+ *
+ * Runs automatically after `npm install opticore-api-gateway` inside a project.
+ * If the project looks like an opticore-webapp template (has src/bootstrap/server/webApp.server.ts),
+ * this script:
+ *   1. Creates src/bootstrap/apiGateway.ts  (gateway configuration)
+ *   2. Patches  src/bootstrap/server/webApp.server.ts  (replaces registerRouter() with gateway.getOpticoreRoutes())
+ *
+ * Safe to re-run: already-patched files are left untouched.
+ */
+
+const fs   = require('fs');
+const path = require('path');
+
+// When installed as a dependency, process.cwd() is the consumer project root.
+// When running in the package's own dev install, skip everything.
+const projectRoot = process.cwd();
+const packageDir  = path.resolve(__dirname, '..');
+
+if (projectRoot === packageDir) {
+    // Running inside the gateway package itself — nothing to do
+    process.exit(0);
+}
+
+const webAppServerPath  = path.join(projectRoot, 'src', 'bootstrap', 'server', 'webApp.server.ts');
+const apiGatewayPath    = path.join(projectRoot, 'src', 'bootstrap', 'apiGateway.ts');
+const bootstrapDir      = path.join(projectRoot, 'src', 'bootstrap');
+
+// Only proceed if this looks like an opticore-webapp template project
+if (!fs.existsSync(webAppServerPath)) {
+    process.exit(0);
+}
+
+if (fs.existsSync(apiGatewayPath)) {
+    console.log('[opticore-api-gateway] src/bootstrap/apiGateway.ts already exists — skipping.');
+} else {
+    const apiGatewayContent = `import {
+    APIGateway,
+    AuthMiddleware,
+    RateLimitMiddleware,
+    LoggingMiddleware
+} from "opticore-api-gateway";
+
+/**
+ * API Gateway configuration.
+ *
+ * - Add your microservices to \`services\`.
+ * - Define how incoming routes map to those services in \`routes\`.
+ * - \`globalMiddlewares\` are applied to every matched request before proxying.
+ *
+ * In standalone mode: call \`gateway.start()\` to spin up a dedicated HTTP server.
+ * In opticore-webapp mode: pass \`gateway.getOpticoreRoutes()\` to \`onStartServer()\`.
+ */
+export const gateway = new APIGateway({
+    port: 4200,   // used only by gateway.start() — WebServerCore controls the Express port
+    services: [
+        { name: "user-service",    url: "http://user-service:4001" },
+        { name: "product-service", url: "http://product-service:4002" },
+    ],
+    routes: [
+        {
+            path: "/api/users",
+            method: "get",
+            target: "http://user-service:4001",
+            serviceName: "user-service",
+        },
+        {
+            path: "/api/products",
+            method: "get",
+            // Multiple targets activate load balancing
+            target: ["http://product-service-1:4002", "http://product-service-2:4002"],
+            serviceName: "product-service",
+        },
+    ],
+    globalMiddlewares: [
+        new LoggingMiddleware("info"),
+        new RateLimitMiddleware(100, 60000),
+        new AuthMiddleware(["my-api-key"]),
+    ],
+    loadBalancer: "round-robin",
+    enableLogging: true,
+});
+`;
+
+    fs.mkdirSync(bootstrapDir, { recursive: true });
+    fs.writeFileSync(apiGatewayPath, apiGatewayContent, 'utf8');
+    console.log('[opticore-api-gateway] Created src/bootstrap/apiGateway.ts');
+}
+
+let serverContent = fs.readFileSync(webAppServerPath, 'utf8');
+
+if (serverContent.includes('opticore-api-gateway') || serverContent.includes('apiGateway')) {
+    console.log('[opticore-api-gateway] src/bootstrap/server/webApp.server.ts already patched — skipping.');
+    process.exit(0);
+}
+
+// Add the gateway import after the last existing import line
+const gatewayImport = `import { gateway } from "../apiGateway";`;
+
+// Insert import after the last import block
+const lastImportIndex = serverContent.lastIndexOf('\nimport ');
+if (lastImportIndex !== -1) {
+    const insertAfter = serverContent.indexOf('\n', lastImportIndex + 1);
+    serverContent =
+        serverContent.slice(0, insertAfter) +
+        '\n' + gatewayImport +
+        serverContent.slice(insertAfter);
+}
+
+// Replace registerRouter() with gateway.getOpticoreRoutes()
+serverContent = serverContent.replace(
+    /registerRouter\(\)/g,
+    'gateway.getOpticoreRoutes()'
+);
+
+// Remove the registerRouter import if present
+serverContent = serverContent.replace(
+    /^import\s*\{[^}]*registerRouter[^}]*\}\s*from\s*["'][^"']+["'];\s*\n?/m,
+    ''
+);
+
+fs.writeFileSync(webAppServerPath, serverContent, 'utf8');
+console.log('[opticore-api-gateway] Patched  src/bootstrap/server/webApp.server.ts');
+console.log('[opticore-api-gateway] Setup complete. Edit src/bootstrap/apiGateway.ts to configure your services and routes.');