opticore-api-gateway 1.0.3 → 1.0.4

package/dist/index.cjs

@@ -40,7 +40,8 @@ __export(index_exports, {
   MiddlewareChain: () => MiddlewareChain,
   RateLimitMiddleware: () => RateLimitMiddleware,
   ServiceRegistry: () => ServiceRegistry,
-  ValidationMiddleware: () => ValidationMiddleware
+  ValidationMiddleware: () => ValidationMiddleware,
+  flattenServiceRoutes: () => flattenServiceRoutes
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1070,6 +1071,13 @@ var ValidationMiddleware = class extends BaseMiddleware {
     };
   }
 };
+
+// src/utils/flattenServiceRoutes.utils.ts
+function flattenServiceRoutes(...serviceRoutes) {
+  return serviceRoutes.flatMap(
+    (grouped) => Object.values(grouped).flat()
+  );
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   APIGateway,
@@ -1082,5 +1090,6 @@ var ValidationMiddleware = class extends BaseMiddleware {
   MiddlewareChain,
   RateLimitMiddleware,
   ServiceRegistry,
-  ValidationMiddleware
+  ValidationMiddleware,
+  flattenServiceRoutes
 });

package/dist/index.d.cts

@@ -326,4 +326,37 @@ declare class ValidationMiddleware extends BaseMiddleware {
     handle(): TMiddlewareFunction;
 }
 
-export { APIGateway, AuthMiddleware, BaseMiddleware, GatewayRoute, HttpClient, type ICircuitBreakerConfig, type IGatewayConfig, type IRouteConfig, type IServiceConfig, LoadBalancer, LoggingMiddleware, MiddlewareChain, RateLimitMiddleware, ServiceRegistry, type TLoadBalancingStrategy, type TMiddlewareFunction, ValidationMiddleware };
+/**
+ * Routes grouped by service name, e.g.:
+ *
+ * ```ts
+ * const userServiceRoutes: IServiceRoutes = {
+ *   "user-service": [
+ *     { path: "/api/v1/auth/login", method: "post", target: "http://localhost:4201", serviceName: "user-service" },
+ *   ],
+ * };
+ * ```
+ *
+ * Meant to live in its own file per service (see `flattenServiceRoutes`) so a
+ * gateway wiring many services doesn't collapse every route into one flat
+ * `routes: [...]` array in `apiGateway.ts`.
+ */
+type IServiceRoutes = Record<string, IRouteConfig[]>;
+
+/**
+ * Flattens one or more `IServiceRoutes` groupings (routes keyed by service
+ * name, typically one file per microservice) into the flat `IRouteConfig[]`
+ * that `new APIGateway({ routes: [...] })` expects.
+ *
+ * @example
+ * import { userServiceRoutes } from "./routes/user.routes";
+ * import { propertyServiceRoutes } from "./routes/property.routes";
+ *
+ * const gateway = new APIGateway({
+ *   services: [...],
+ *   routes: flattenServiceRoutes(userServiceRoutes, propertyServiceRoutes),
+ * });
+ */
+declare function flattenServiceRoutes(...serviceRoutes: IServiceRoutes[]): IRouteConfig[];
+
+export { APIGateway, AuthMiddleware, BaseMiddleware, GatewayRoute, HttpClient, type ICircuitBreakerConfig, type IGatewayConfig, type IRouteConfig, type IServiceConfig, type IServiceRoutes, LoadBalancer, LoggingMiddleware, MiddlewareChain, RateLimitMiddleware, ServiceRegistry, type TLoadBalancingStrategy, type TMiddlewareFunction, ValidationMiddleware, flattenServiceRoutes };

package/dist/index.d.ts

@@ -326,4 +326,37 @@ declare class ValidationMiddleware extends BaseMiddleware {
     handle(): TMiddlewareFunction;
 }
 
-export { APIGateway, AuthMiddleware, BaseMiddleware, GatewayRoute, HttpClient, type ICircuitBreakerConfig, type IGatewayConfig, type IRouteConfig, type IServiceConfig, LoadBalancer, LoggingMiddleware, MiddlewareChain, RateLimitMiddleware, ServiceRegistry, type TLoadBalancingStrategy, type TMiddlewareFunction, ValidationMiddleware };
+/**
+ * Routes grouped by service name, e.g.:
+ *
+ * ```ts
+ * const userServiceRoutes: IServiceRoutes = {
+ *   "user-service": [
+ *     { path: "/api/v1/auth/login", method: "post", target: "http://localhost:4201", serviceName: "user-service" },
+ *   ],
+ * };
+ * ```
+ *
+ * Meant to live in its own file per service (see `flattenServiceRoutes`) so a
+ * gateway wiring many services doesn't collapse every route into one flat
+ * `routes: [...]` array in `apiGateway.ts`.
+ */
+type IServiceRoutes = Record<string, IRouteConfig[]>;
+
+/**
+ * Flattens one or more `IServiceRoutes` groupings (routes keyed by service
+ * name, typically one file per microservice) into the flat `IRouteConfig[]`
+ * that `new APIGateway({ routes: [...] })` expects.
+ *
+ * @example
+ * import { userServiceRoutes } from "./routes/user.routes";
+ * import { propertyServiceRoutes } from "./routes/property.routes";
+ *
+ * const gateway = new APIGateway({
+ *   services: [...],
+ *   routes: flattenServiceRoutes(userServiceRoutes, propertyServiceRoutes),
+ * });
+ */
+declare function flattenServiceRoutes(...serviceRoutes: IServiceRoutes[]): IRouteConfig[];
+
+export { APIGateway, AuthMiddleware, BaseMiddleware, GatewayRoute, HttpClient, type ICircuitBreakerConfig, type IGatewayConfig, type IRouteConfig, type IServiceConfig, type IServiceRoutes, LoadBalancer, LoggingMiddleware, MiddlewareChain, RateLimitMiddleware, ServiceRegistry, type TLoadBalancingStrategy, type TMiddlewareFunction, ValidationMiddleware, flattenServiceRoutes };

package/dist/index.js

@@ -1027,6 +1027,13 @@ var ValidationMiddleware = class extends BaseMiddleware {
     };
   }
 };
+
+// src/utils/flattenServiceRoutes.utils.ts
+function flattenServiceRoutes(...serviceRoutes) {
+  return serviceRoutes.flatMap(
+    (grouped) => Object.values(grouped).flat()
+  );
+}
 export {
   APIGateway,
   AuthMiddleware,
@@ -1038,5 +1045,6 @@ export {
   MiddlewareChain,
   RateLimitMiddleware,
   ServiceRegistry,
-  ValidationMiddleware
+  ValidationMiddleware,
+  flattenServiceRoutes
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opticore-api-gateway",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "OptiCore API Gateway",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/scripts/postinstall.cjs

@@ -6,8 +6,9 @@
  * 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())
+ *   1. Creates src/bootstrap/gateway/routes/*.routes.ts  (one file per service, grouped route definitions)
+ *   2. Creates src/bootstrap/apiGateway.ts  (gateway configuration, routes built via flattenServiceRoutes())
+ *   3. Patches  src/bootstrap/server/webApp.server.ts  (replaces registerRouter() with gateway.getOpticoreRoutes())
  *
  * Safe to re-run: already-patched files are left untouched.
  */
@@ -31,12 +32,64 @@ if (path.resolve(projectRoot) === packageDir) {
 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');
+const routesDir         = path.join(bootstrapDir, 'gateway', 'routes');
+const userRoutesPath    = path.join(routesDir, 'user.routes.ts');
+const productRoutesPath = path.join(routesDir, 'product.routes.ts');
 
 // Only proceed if this looks like an opticore-webapp template project
 if (!fs.existsSync(webAppServerPath)) {
     process.exit(0);
 }
 
+// One file per service, grouped under { [serviceName]: IRouteConfig[] } —
+// keeps a gateway wiring several services from collapsing every route into
+// one flat array inside apiGateway.ts. flattenServiceRoutes() (below) merges
+// them back into the flat IRouteConfig[] APIGateway itself expects.
+if (fs.existsSync(userRoutesPath) || fs.existsSync(productRoutesPath)) {
+    console.log('[opticore-api-gateway] src/bootstrap/gateway/routes/ already exists — skipping.');
+} else {
+    fs.mkdirSync(routesDir, { recursive: true });
+
+    fs.writeFileSync(userRoutesPath, `import { IServiceRoutes } from "opticore-api-gateway";
+
+/**
+ * Routes proxied to "user-service". Add every route this service owns here
+ * — grouping by service keeps apiGateway.ts short no matter how many
+ * services the gateway ends up fronting.
+ */
+export const userServiceRoutes: IServiceRoutes = {
+    "user-service": [
+        {
+            path: "/api/users",
+            method: "get",
+            target: "http://user-service:4001",
+            serviceName: "user-service",
+        },
+    ],
+};
+`, 'utf8');
+
+    fs.writeFileSync(productRoutesPath, `import { IServiceRoutes } from "opticore-api-gateway";
+
+/**
+ * Routes proxied to "product-service".
+ */
+export const productServiceRoutes: IServiceRoutes = {
+    "product-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",
+        },
+    ],
+};
+`, 'utf8');
+
+    console.log('[opticore-api-gateway] Created src/bootstrap/gateway/routes/{user,product}.routes.ts');
+}
+
 if (fs.existsSync(apiGatewayPath)) {
     console.log('[opticore-api-gateway] src/bootstrap/apiGateway.ts already exists — skipping.');
 } else {
@@ -44,14 +97,20 @@ if (fs.existsSync(apiGatewayPath)) {
     APIGateway,
     AuthMiddleware,
     RateLimitMiddleware,
-    LoggingMiddleware
+    LoggingMiddleware,
+    flattenServiceRoutes
 } from "opticore-api-gateway";
+import { userServiceRoutes } from "./gateway/routes/user.routes";
+import { productServiceRoutes } from "./gateway/routes/product.routes";
 
 /**
  * API Gateway configuration.
  *
  * - Add your microservices to \`services\`.
- * - Define how incoming routes map to those services in \`routes\`.
+ * - Define each service's routes in its own file under \`gateway/routes/\`
+ *   (see user.routes.ts / product.routes.ts) and merge them here with
+ *   \`flattenServiceRoutes()\` — add a new file + import per service instead
+ *   of growing one flat \`routes: [...]\` array.
  * - \`globalMiddlewares\` are applied to every matched request before proxying.
  *
  * In standalone mode: call \`gateway.start()\` to spin up a dedicated HTTP server.
@@ -63,21 +122,7 @@ export const gateway = new APIGateway({
         { 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",
-        },
-    ],
+    routes: flattenServiceRoutes(userServiceRoutes, productServiceRoutes),
     globalMiddlewares: [
         new LoggingMiddleware("info"),
         new RateLimitMiddleware(100, 60000),