@abinashpatri/orchestrator 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Abinash Patri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,301 @@
+# @abinashpatri/orchestrator
+
+Reusable TypeScript/JavaScript toolkit for service registration, service
+discovery, and API gateway routing.
+
+Works in both ESM and CommonJS projects with full TypeScript type support.
+
+Core APIs (`createConsulClient`, `registerService`, `deregisterService`, `getServiceUrl`) are framework-agnostic.
+Express gateway APIs are available from the subpath `@abinashpatri/orchestrator/express`.
+
+## Install
+
+```bash
+npm install @abinashpatri/orchestrator
+```
+
+For Express gateway adapter, install peer dependencies in your microservice:
+
+```bash
+npm install express http-proxy-middleware
+```
+
+## Prerequisites
+
+- Consul agent is running and reachable
+- your services expose a health endpoint (default: `/health`)
+- Node.js 18+ recommended
+
+---
+
+## Step-by-step usage (modern way)
+
+## 1) Create a Consul client
+
+```ts
+import { createConsulClient } from "@abinashpatri/orchestrator";
+
+const consul = createConsulClient({
+  host: process.env.CONSUL_HOST ?? "127.0.0.1",
+  port: Number(process.env.CONSUL_PORT ?? 8500),
+  token: process.env.CONSUL_HTTP_TOKEN, // optional
+  secure: process.env.CONSUL_SECURE === "true", // optional
+});
+```
+
+## 2) Register your service
+
+```ts
+import { registerService } from "@abinashpatri/orchestrator";
+
+const serviceId = await registerService(consul, {
+  serviceName: "user-service",
+  serviceId: `user-service-${process.pid}`, // optional (auto-generated if not provided)
+  address: "127.0.0.1",
+  port: 3001,
+  tags: ["v1", "public"], // optional
+  healthPath: "/health", // optional, default: /health
+  healthInterval: "10s", // optional, default: 10s
+  healthTimeout: "5s", // optional, default: 5s
+  deregisterCriticalServiceAfter: "30s", // optional, default: 30s
+});
+```
+
+## 3) Discover another service URL
+
+```ts
+import { getServiceUrl } from "@abinashpatri/orchestrator";
+
+const paymentServiceUrl = await getServiceUrl(consul, "payment-service");
+// Example output: http://127.0.0.1:4002
+```
+
+By default, discovery returns a random healthy instance (simple load balancing).
+
+## 4) Build an API gateway app
+
+```ts
+import { createGatewayApp } from "@abinashpatri/orchestrator/express";
+
+const app = createGatewayApp(consul, {
+  healthPath: "/health",
+  routes: [
+    { serviceName: "user-service", routePrefix: "/api/users" },
+    { serviceName: "payment-service", routePrefix: "/api/payments" },
+    { serviceName: "notification-service" }, // defaults to /api/notification-service
+  ],
+});
+
+const server = app.listen(4000, () => {
+  console.log("Gateway running on :4000");
+});
+```
+
+## 5) Graceful shutdown (important for production)
+
+```ts
+import { deregisterService } from "@abinashpatri/orchestrator";
+
+function shutdown(signal: string) {
+  return async () => {
+    console.log(`Received ${signal}, shutting down...`);
+
+    server.close(async () => {
+      try {
+        await deregisterService(consul, serviceId);
+      } finally {
+        process.exit(0);
+      }
+    });
+  };
+}
+
+process.on("SIGINT", shutdown("SIGINT"));
+process.on("SIGTERM", shutdown("SIGTERM"));
+```
+
+---
+
+## Full TypeScript example
+
+```ts
+import {
+  createConsulClient,
+  registerService,
+  deregisterService,
+  getServiceUrl,
+} from "@abinashpatri/orchestrator";
+import { createGatewayApp } from "@abinashpatri/orchestrator/express";
+
+const consul = createConsulClient({
+  host: process.env.CONSUL_HOST ?? "127.0.0.1",
+  port: Number(process.env.CONSUL_PORT ?? 8500),
+  token: process.env.CONSUL_HTTP_TOKEN,
+});
+
+const serviceId = await registerService(consul, {
+  serviceName: "api-gateway-service",
+  address: "127.0.0.1",
+  port: 4000,
+  healthPath: "/health",
+});
+
+const app = createGatewayApp(consul, {
+  routes: [
+    { serviceName: "user-service", routePrefix: "/api/users" },
+    { serviceName: "notification-service", routePrefix: "/api/notifications" },
+  ],
+});
+
+app.get("/where-is-user-service", async (_req, res) => {
+  try {
+    const url = await getServiceUrl(consul, "user-service");
+    res.json({ service: "user-service", url });
+  } catch (error) {
+    const message = error instanceof Error ? error.message : "Unknown error";
+    res.status(503).json({ error: message });
+  }
+});
+
+const server = app.listen(4000, () => {
+  console.log("API gateway listening on port 4000");
+});
+
+async function cleanup() {
+  await deregisterService(consul, serviceId);
+}
+
+process.on("SIGINT", async () => {
+  server.close(async () => {
+    await cleanup();
+    process.exit(0);
+  });
+});
+
+process.on("SIGTERM", async () => {
+  server.close(async () => {
+    await cleanup();
+    process.exit(0);
+  });
+});
+```
+
+---
+
+## JavaScript (CommonJS) usage
+
+```js
+const {
+  createConsulClient,
+  registerService,
+  getServiceUrl,
+  deregisterService,
+} = require("@abinashpatri/orchestrator");
+const { createGatewayApp } = require("@abinashpatri/orchestrator/express");
+
+async function main() {
+  const consul = createConsulClient({
+    host: "127.0.0.1",
+    port: 8500,
+    token: process.env.CONSUL_HTTP_TOKEN,
+  });
+
+  const serviceId = await registerService(consul, {
+    serviceName: "api-gateway-service",
+    address: "127.0.0.1",
+    port: 4000,
+  });
+
+  const app = createGatewayApp(consul, {
+    routes: [{ serviceName: "user-service", routePrefix: "/api/users" }],
+  });
+
+  app.get("/discover-user-service", async (_req, res) => {
+    const url = await getServiceUrl(consul, "user-service");
+    res.json({ url });
+  });
+
+  const server = app.listen(4000);
+
+  process.on("SIGINT", async () => {
+    server.close(async () => {
+      await deregisterService(consul, serviceId);
+      process.exit(0);
+    });
+  });
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+```
+
+---
+
+## API reference
+
+### `createConsulClient(options?)`
+
+Creates and returns a Consul client.
+
+`options`:
+
+- `host?: string` (default: `127.0.0.1`)
+- `port?: number` (default: `8500`)
+- `token?: string`
+- `secure?: boolean` (default: `false`)
+
+### `registerService(consulClient, options)`
+
+Registers a service and returns the final `serviceId`.
+
+`options`:
+
+- `serviceName: string` (required)
+- `serviceId?: string`
+- `address: string` (required)
+- `port: number` (required)
+- `tags?: string[]`
+- `healthPath?: string` (default: `/health`)
+- `healthInterval?: string` (default: `10s`)
+- `healthTimeout?: string` (default: `5s`)
+- `deregisterCriticalServiceAfter?: string` (default: `30s`)
+
+### `deregisterService(consulClient, serviceId)`
+
+Removes a registered service from Consul.
+
+### `getServiceUrl(consulClient, serviceName, options?)`
+
+Returns one discovered service URL, such as `http://127.0.0.1:3001`.
+
+`options`:
+
+- `passing?: boolean` (default: `true`)
+
+### `createServiceProxy(consulClient, options)` (from `@abinashpatri/orchestrator/express`)
+
+Creates an Express middleware that resolves service target dynamically via Consul.
+
+`options`:
+
+- `serviceName: string` (required)
+- `routePrefix?: string` (default: `/api/${serviceName}`)
+
+### `createGatewayApp(consulClient, options)` (from `@abinashpatri/orchestrator/express`)
+
+Creates an Express app and mounts service proxies for all routes.
+
+`options`:
+
+- `routes: Array<{ serviceName: string; routePrefix?: string }>` (required)
+- `healthPath?: string` (default: `/health`)
+
+---
+
+## Notes
+
+- If Consul returns `host.docker.internal`, the library auto-resolves it to `127.0.0.1` for host-local calls.
+- Keep service names consistent across registration and discovery.
+- For production, always use graceful shutdown to avoid stale Consul registrations.

package/dist/chunk-24OKBTEJ.mjs

@@ -0,0 +1,2 @@
+function c(t){return t==="host.docker.internal"?"127.0.0.1":t}async function a(t,n,o={}){let r=await t.health.service({service:n,passing:o.passing??!0});if(!r.length)throw new Error(`No healthy instance found for "${n}"`);let e=r[Math.floor(Math.random()*r.length)],i=c(e.Service.Address),s=e.Service.Port;return`http://${i}:${String(s)}`}export{a};
+//# sourceMappingURL=chunk-24OKBTEJ.mjs.map

package/dist/chunk-24OKBTEJ.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/discover.ts"],"sourcesContent":["import type { ConsulClient } from \"./consul\";\nimport type { ServiceDiscoveryOptions } from \"./types\";\n\nfunction normalizeHost(address: string): string {\n  return address === \"host.docker.internal\" ? \"127.0.0.1\" : address;\n}\n\nexport async function getServiceUrl(\n  consulClient: ConsulClient,\n  serviceName: string,\n  options: ServiceDiscoveryOptions = {},\n): Promise<string> {\n  const services = await consulClient.health.service({\n    service: serviceName,\n    passing: options.passing ?? true,\n  });\n\n  if (!services.length) {\n    throw new Error(`No healthy instance found for \"${serviceName}\"`);\n  }\n\n  const randomInstance = services[Math.floor(Math.random() * services.length)];\n  const host = normalizeHost(randomInstance.Service.Address);\n  const port = randomInstance.Service.Port;\n\n  return `http://${host}:${String(port)}`;\n}\n"],"mappings":"AAGA,SAASA,EAAcC,EAAyB,CAC9C,OAAOA,IAAY,uBAAyB,YAAcA,CAC5D,CAEA,eAAsBC,EACpBC,EACAC,EACAC,EAAmC,CAAC,EACnB,CACjB,IAAMC,EAAW,MAAMH,EAAa,OAAO,QAAQ,CACjD,QAASC,EACT,QAASC,EAAQ,SAAW,EAC9B,CAAC,EAED,GAAI,CAACC,EAAS,OACZ,MAAM,IAAI,MAAM,kCAAkCF,CAAW,GAAG,EAGlE,IAAMG,EAAiBD,EAAS,KAAK,MAAM,KAAK,OAAO,EAAIA,EAAS,MAAM,CAAC,EACrEE,EAAOR,EAAcO,EAAe,QAAQ,OAAO,EACnDE,EAAOF,EAAe,QAAQ,KAEpC,MAAO,UAAUC,CAAI,IAAI,OAAOC,CAAI,CAAC,EACvC","names":["normalizeHost","address","getServiceUrl","consulClient","serviceName","options","services","randomInstance","host","port"]}

package/dist/consul-D2-fKyU6.d.mts

@@ -0,0 +1,39 @@
+import Consul from 'consul';
+
+interface ConsulClientOptions {
+    host?: string;
+    port?: number;
+    token?: string;
+    secure?: boolean;
+}
+interface ServiceDiscoveryOptions {
+    passing?: boolean;
+}
+interface ServiceRegistrationOptions {
+    serviceName: string;
+    serviceId?: string;
+    address: string;
+    port: number;
+    tags?: string[];
+    healthPath?: string;
+    healthInterval?: string;
+    healthTimeout?: string;
+    deregisterCriticalServiceAfter?: string;
+}
+interface GatewayRoute {
+    serviceName: string;
+    routePrefix?: string;
+}
+interface ServiceProxyOptions {
+    serviceName: string;
+    routePrefix?: string;
+}
+interface GatewayOptions {
+    routes: GatewayRoute[];
+    healthPath?: string;
+}
+
+type ConsulClient = InstanceType<typeof Consul>;
+declare function createConsulClient(options?: ConsulClientOptions): ConsulClient;
+
+export { type ConsulClient as C, type GatewayOptions as G, type ServiceProxyOptions as S, type GatewayRoute as a, type ServiceDiscoveryOptions as b, type ServiceRegistrationOptions as c, type ConsulClientOptions as d, createConsulClient as e };

package/dist/consul-D2-fKyU6.d.ts

@@ -0,0 +1,39 @@
+import Consul from 'consul';
+
+interface ConsulClientOptions {
+    host?: string;
+    port?: number;
+    token?: string;
+    secure?: boolean;
+}
+interface ServiceDiscoveryOptions {
+    passing?: boolean;
+}
+interface ServiceRegistrationOptions {
+    serviceName: string;
+    serviceId?: string;
+    address: string;
+    port: number;
+    tags?: string[];
+    healthPath?: string;
+    healthInterval?: string;
+    healthTimeout?: string;
+    deregisterCriticalServiceAfter?: string;
+}
+interface GatewayRoute {
+    serviceName: string;
+    routePrefix?: string;
+}
+interface ServiceProxyOptions {
+    serviceName: string;
+    routePrefix?: string;
+}
+interface GatewayOptions {
+    routes: GatewayRoute[];
+    healthPath?: string;
+}
+
+type ConsulClient = InstanceType<typeof Consul>;
+declare function createConsulClient(options?: ConsulClientOptions): ConsulClient;
+
+export { type ConsulClient as C, type GatewayOptions as G, type ServiceProxyOptions as S, type GatewayRoute as a, type ServiceDiscoveryOptions as b, type ServiceRegistrationOptions as c, type ConsulClientOptions as d, createConsulClient as e };

package/dist/express.d.mts

@@ -0,0 +1,9 @@
+import { Express, RequestHandler } from 'express';
+import { C as ConsulClient, G as GatewayOptions, S as ServiceProxyOptions } from './consul-D2-fKyU6.mjs';
+export { a as GatewayRoute } from './consul-D2-fKyU6.mjs';
+import 'consul';
+
+declare function createServiceProxy(consulClient: ConsulClient, options: ServiceProxyOptions): RequestHandler;
+declare function createGatewayApp(consulClient: ConsulClient, options: GatewayOptions): Express;
+
+export { GatewayOptions, ServiceProxyOptions, createGatewayApp, createServiceProxy };

package/dist/express.d.ts

@@ -0,0 +1,9 @@
+import { Express, RequestHandler } from 'express';
+import { C as ConsulClient, G as GatewayOptions, S as ServiceProxyOptions } from './consul-D2-fKyU6.js';
+export { a as GatewayRoute } from './consul-D2-fKyU6.js';
+import 'consul';
+
+declare function createServiceProxy(consulClient: ConsulClient, options: ServiceProxyOptions): RequestHandler;
+declare function createGatewayApp(consulClient: ConsulClient, options: GatewayOptions): Express;
+
+export { GatewayOptions, ServiceProxyOptions, createGatewayApp, createServiceProxy };

package/dist/express.js

@@ -0,0 +1,2 @@
+"use strict";var g=Object.create;var a=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var P=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,w=Object.prototype.hasOwnProperty;var d=(e,t)=>{for(var r in t)a(e,r,{get:t[r],enumerable:!0})},l=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of P(t))!w.call(e,o)&&o!==r&&a(e,o,{get:()=>t[o],enumerable:!(n=x(t,o))||n.enumerable});return e};var C=(e,t,r)=>(r=e!=null?g(S(e)):{},l(t||!e||!e.__esModule?a(r,"default",{value:e,enumerable:!0}):r,e)),O=e=>l(a({},"__esModule",{value:!0}),e);var G={};d(G,{createGatewayApp:()=>h,createServiceProxy:()=>u});module.exports=O(G);var f=C(require("express")),m=require("http-proxy-middleware");function $(e){return e==="host.docker.internal"?"127.0.0.1":e}async function y(e,t,r={}){let n=await e.health.service({service:t,passing:r.passing??!0});if(!n.length)throw new Error(`No healthy instance found for "${t}"`);let o=n[Math.floor(Math.random()*n.length)],s=$(o.Service.Address),c=o.Service.Port;return`http://${s}:${String(c)}`}function p(e){return e.startsWith("/")?e:`/${e}`}function u(e,t){let n=`^${p(t.routePrefix??`/api/${t.serviceName}`)}`;return async(o,s,c)=>{try{let i=await y(e,t.serviceName);return(0,m.createProxyMiddleware)({target:i,changeOrigin:!0,pathRewrite:{[n]:""}})(o,s,c)}catch(i){let v=i instanceof Error?i.message:"Service discovery failed";s.status(503).json({service:t.serviceName,error:v})}}}function h(e,t){let r=(0,f.default)(),n=p(t.healthPath??"/health");r.get(n,(o,s)=>{s.status(200).send("OK")});for(let o of t.routes){let s=p(o.routePrefix??`/api/${o.serviceName}`);r.use(s,u(e,{...o,routePrefix:s}))}return r}0&&(module.exports={createGatewayApp,createServiceProxy});
+//# sourceMappingURL=express.js.map

package/dist/express.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/express.ts","../src/gateway.ts","../src/discover.ts"],"sourcesContent":["export { createGatewayApp, createServiceProxy } from \"./gateway\";\n\nexport type { GatewayOptions, GatewayRoute, ServiceProxyOptions } from \"./types\";\n","import express, { type Express, type RequestHandler } from \"express\";\nimport { createProxyMiddleware } from \"http-proxy-middleware\";\nimport type { ConsulClient } from \"./consul\";\nimport { getServiceUrl } from \"./discover\";\nimport type { GatewayOptions, ServiceProxyOptions } from \"./types\";\n\nfunction normalizePrefix(prefix: string): string {\n  return prefix.startsWith(\"/\") ? prefix : `/${prefix}`;\n}\n\nexport function createServiceProxy(\n  consulClient: ConsulClient,\n  options: ServiceProxyOptions,\n): RequestHandler {\n  const routePrefix = normalizePrefix(options.routePrefix ?? `/api/${options.serviceName}`);\n  const pathPrefixPattern = `^${routePrefix}`;\n\n  return async (req, res, next) => {\n    try {\n      const target = await getServiceUrl(consulClient, options.serviceName);\n\n      return createProxyMiddleware({\n        target,\n        changeOrigin: true,\n        pathRewrite: {\n          [pathPrefixPattern]: \"\",\n        },\n      })(req, res, next);\n    } catch (error) {\n      const message = error instanceof Error ? error.message : \"Service discovery failed\";\n      res.status(503).json({\n        service: options.serviceName,\n        error: message,\n      });\n    }\n  };\n}\n\nexport function createGatewayApp(consulClient: ConsulClient, options: GatewayOptions): Express {\n  const app = express();\n  const healthPath = normalizePrefix(options.healthPath ?? \"/health\");\n\n  app.get(healthPath, (_req, res) => {\n    res.status(200).send(\"OK\");\n  });\n\n  for (const route of options.routes) {\n    const routePrefix = normalizePrefix(route.routePrefix ?? `/api/${route.serviceName}`);\n    app.use(routePrefix, createServiceProxy(consulClient, { ...route, routePrefix }));\n  }\n\n  return app;\n}\n","import type { ConsulClient } from \"./consul\";\nimport type { ServiceDiscoveryOptions } from \"./types\";\n\nfunction normalizeHost(address: string): string {\n  return address === \"host.docker.internal\" ? \"127.0.0.1\" : address;\n}\n\nexport async function getServiceUrl(\n  consulClient: ConsulClient,\n  serviceName: string,\n  options: ServiceDiscoveryOptions = {},\n): Promise<string> {\n  const services = await consulClient.health.service({\n    service: serviceName,\n    passing: options.passing ?? true,\n  });\n\n  if (!services.length) {\n    throw new Error(`No healthy instance found for \"${serviceName}\"`);\n  }\n\n  const randomInstance = services[Math.floor(Math.random() * services.length)];\n  const host = normalizeHost(randomInstance.Service.Address);\n  const port = randomInstance.Service.Port;\n\n  return `http://${host}:${String(port)}`;\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,sBAAAE,EAAA,uBAAAC,IAAA,eAAAC,EAAAJ,GCAA,IAAAK,EAA2D,sBAC3DC,EAAsC,iCCEtC,SAASC,EAAcC,EAAyB,CAC9C,OAAOA,IAAY,uBAAyB,YAAcA,CAC5D,CAEA,eAAsBC,EACpBC,EACAC,EACAC,EAAmC,CAAC,EACnB,CACjB,IAAMC,EAAW,MAAMH,EAAa,OAAO,QAAQ,CACjD,QAASC,EACT,QAASC,EAAQ,SAAW,EAC9B,CAAC,EAED,GAAI,CAACC,EAAS,OACZ,MAAM,IAAI,MAAM,kCAAkCF,CAAW,GAAG,EAGlE,IAAMG,EAAiBD,EAAS,KAAK,MAAM,KAAK,OAAO,EAAIA,EAAS,MAAM,CAAC,EACrEE,EAAOR,EAAcO,EAAe,QAAQ,OAAO,EACnDE,EAAOF,EAAe,QAAQ,KAEpC,MAAO,UAAUC,CAAI,IAAI,OAAOC,CAAI,CAAC,EACvC,CDpBA,SAASC,EAAgBC,EAAwB,CAC/C,OAAOA,EAAO,WAAW,GAAG,EAAIA,EAAS,IAAIA,CAAM,EACrD,CAEO,SAASC,EACdC,EACAC,EACgB,CAEhB,IAAMC,EAAoB,IADNL,EAAgBI,EAAQ,aAAe,QAAQA,EAAQ,WAAW,EAAE,CAC/C,GAEzC,MAAO,OAAOE,EAAKC,EAAKC,IAAS,CAC/B,GAAI,CACF,IAAMC,EAAS,MAAMC,EAAcP,EAAcC,EAAQ,WAAW,EAEpE,SAAO,yBAAsB,CAC3B,OAAAK,EACA,aAAc,GACd,YAAa,CACX,CAACJ,CAAiB,EAAG,EACvB,CACF,CAAC,EAAEC,EAAKC,EAAKC,CAAI,CACnB,OAASG,EAAO,CACd,IAAMC,EAAUD,aAAiB,MAAQA,EAAM,QAAU,2BACzDJ,EAAI,OAAO,GAAG,EAAE,KAAK,CACnB,QAASH,EAAQ,YACjB,MAAOQ,CACT,CAAC,CACH,CACF,CACF,CAEO,SAASC,EAAiBV,EAA4BC,EAAkC,CAC7F,IAAMU,KAAM,EAAAC,SAAQ,EACdC,EAAahB,EAAgBI,EAAQ,YAAc,SAAS,EAElEU,EAAI,IAAIE,EAAY,CAACC,EAAMV,IAAQ,CACjCA,EAAI,OAAO,GAAG,EAAE,KAAK,IAAI,CAC3B,CAAC,EAED,QAAWW,KAASd,EAAQ,OAAQ,CAClC,IAAMe,EAAcnB,EAAgBkB,EAAM,aAAe,QAAQA,EAAM,WAAW,EAAE,EACpFJ,EAAI,IAAIK,EAAajB,EAAmBC,EAAc,CAAE,GAAGe,EAAO,YAAAC,CAAY,CAAC,CAAC,CAClF,CAEA,OAAOL,CACT","names":["express_exports","__export","createGatewayApp","createServiceProxy","__toCommonJS","import_express","import_http_proxy_middleware","normalizeHost","address","getServiceUrl","consulClient","serviceName","options","services","randomInstance","host","port","normalizePrefix","prefix","createServiceProxy","consulClient","options","pathPrefixPattern","req","res","next","target","getServiceUrl","error","message","createGatewayApp","app","express","healthPath","_req","route","routePrefix"]}

package/dist/express.mjs

@@ -0,0 +1,2 @@
+import{a as c}from"./chunk-24OKBTEJ.mjs";import f from"express";import{createProxyMiddleware as m}from"http-proxy-middleware";function n(e){return e.startsWith("/")?e:`/${e}`}function p(e,r){let i=`^${n(r.routePrefix??`/api/${r.serviceName}`)}`;return async(o,t,u)=>{try{let s=await c(e,r.serviceName);return m({target:s,changeOrigin:!0,pathRewrite:{[i]:""}})(o,t,u)}catch(s){let y=s instanceof Error?s.message:"Service discovery failed";t.status(503).json({service:r.serviceName,error:y})}}}function x(e,r){let a=f(),i=n(r.healthPath??"/health");a.get(i,(o,t)=>{t.status(200).send("OK")});for(let o of r.routes){let t=n(o.routePrefix??`/api/${o.serviceName}`);a.use(t,p(e,{...o,routePrefix:t}))}return a}export{x as createGatewayApp,p as createServiceProxy};
+//# sourceMappingURL=express.mjs.map

package/dist/express.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/gateway.ts"],"sourcesContent":["import express, { type Express, type RequestHandler } from \"express\";\nimport { createProxyMiddleware } from \"http-proxy-middleware\";\nimport type { ConsulClient } from \"./consul\";\nimport { getServiceUrl } from \"./discover\";\nimport type { GatewayOptions, ServiceProxyOptions } from \"./types\";\n\nfunction normalizePrefix(prefix: string): string {\n  return prefix.startsWith(\"/\") ? prefix : `/${prefix}`;\n}\n\nexport function createServiceProxy(\n  consulClient: ConsulClient,\n  options: ServiceProxyOptions,\n): RequestHandler {\n  const routePrefix = normalizePrefix(options.routePrefix ?? `/api/${options.serviceName}`);\n  const pathPrefixPattern = `^${routePrefix}`;\n\n  return async (req, res, next) => {\n    try {\n      const target = await getServiceUrl(consulClient, options.serviceName);\n\n      return createProxyMiddleware({\n        target,\n        changeOrigin: true,\n        pathRewrite: {\n          [pathPrefixPattern]: \"\",\n        },\n      })(req, res, next);\n    } catch (error) {\n      const message = error instanceof Error ? error.message : \"Service discovery failed\";\n      res.status(503).json({\n        service: options.serviceName,\n        error: message,\n      });\n    }\n  };\n}\n\nexport function createGatewayApp(consulClient: ConsulClient, options: GatewayOptions): Express {\n  const app = express();\n  const healthPath = normalizePrefix(options.healthPath ?? \"/health\");\n\n  app.get(healthPath, (_req, res) => {\n    res.status(200).send(\"OK\");\n  });\n\n  for (const route of options.routes) {\n    const routePrefix = normalizePrefix(route.routePrefix ?? `/api/${route.serviceName}`);\n    app.use(routePrefix, createServiceProxy(consulClient, { ...route, routePrefix }));\n  }\n\n  return app;\n}\n"],"mappings":"yCAAA,OAAOA,MAAoD,UAC3D,OAAS,yBAAAC,MAA6B,wBAKtC,SAASC,EAAgBC,EAAwB,CAC/C,OAAOA,EAAO,WAAW,GAAG,EAAIA,EAAS,IAAIA,CAAM,EACrD,CAEO,SAASC,EACdC,EACAC,EACgB,CAEhB,IAAMC,EAAoB,IADNL,EAAgBI,EAAQ,aAAe,QAAQA,EAAQ,WAAW,EAAE,CAC/C,GAEzC,MAAO,OAAOE,EAAKC,EAAKC,IAAS,CAC/B,GAAI,CACF,IAAMC,EAAS,MAAMC,EAAcP,EAAcC,EAAQ,WAAW,EAEpE,OAAOO,EAAsB,CAC3B,OAAAF,EACA,aAAc,GACd,YAAa,CACX,CAACJ,CAAiB,EAAG,EACvB,CACF,CAAC,EAAEC,EAAKC,EAAKC,CAAI,CACnB,OAASI,EAAO,CACd,IAAMC,EAAUD,aAAiB,MAAQA,EAAM,QAAU,2BACzDL,EAAI,OAAO,GAAG,EAAE,KAAK,CACnB,QAASH,EAAQ,YACjB,MAAOS,CACT,CAAC,CACH,CACF,CACF,CAEO,SAASC,EAAiBX,EAA4BC,EAAkC,CAC7F,IAAMW,EAAMC,EAAQ,EACdC,EAAajB,EAAgBI,EAAQ,YAAc,SAAS,EAElEW,EAAI,IAAIE,EAAY,CAACC,EAAMX,IAAQ,CACjCA,EAAI,OAAO,GAAG,EAAE,KAAK,IAAI,CAC3B,CAAC,EAED,QAAWY,KAASf,EAAQ,OAAQ,CAClC,IAAMgB,EAAcpB,EAAgBmB,EAAM,aAAe,QAAQA,EAAM,WAAW,EAAE,EACpFJ,EAAI,IAAIK,EAAalB,EAAmBC,EAAc,CAAE,GAAGgB,EAAO,YAAAC,CAAY,CAAC,CAAC,CAClF,CAEA,OAAOL,CACT","names":["express","createProxyMiddleware","normalizePrefix","prefix","createServiceProxy","consulClient","options","pathPrefixPattern","req","res","next","target","getServiceUrl","createProxyMiddleware","error","message","createGatewayApp","app","express","healthPath","_req","route","routePrefix"]}

package/dist/index.d.mts

@@ -0,0 +1,10 @@
+import { C as ConsulClient, b as ServiceDiscoveryOptions, c as ServiceRegistrationOptions } from './consul-D2-fKyU6.mjs';
+export { d as ConsulClientOptions, e as createConsulClient } from './consul-D2-fKyU6.mjs';
+import 'consul';
+
+declare function getServiceUrl(consulClient: ConsulClient, serviceName: string, options?: ServiceDiscoveryOptions): Promise<string>;
+
+declare function registerService(consulClient: ConsulClient, options: ServiceRegistrationOptions): Promise<string>;
+declare function deregisterService(consulClient: ConsulClient, serviceId: string): Promise<void>;
+
+export { ConsulClient, ServiceDiscoveryOptions, ServiceRegistrationOptions, deregisterService, getServiceUrl, registerService };

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { C as ConsulClient, b as ServiceDiscoveryOptions, c as ServiceRegistrationOptions } from './consul-D2-fKyU6.js';
+export { d as ConsulClientOptions, e as createConsulClient } from './consul-D2-fKyU6.js';
+import 'consul';
+
+declare function getServiceUrl(consulClient: ConsulClient, serviceName: string, options?: ServiceDiscoveryOptions): Promise<string>;
+
+declare function registerService(consulClient: ConsulClient, options: ServiceRegistrationOptions): Promise<string>;
+declare function deregisterService(consulClient: ConsulClient, serviceId: string): Promise<void>;
+
+export { ConsulClient, ServiceDiscoveryOptions, ServiceRegistrationOptions, deregisterService, getServiceUrl, registerService };

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";var g=Object.create;var s=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var f=Object.getPrototypeOf,d=Object.prototype.hasOwnProperty;var y=(t,e)=>{for(var r in e)s(t,r,{get:e[r],enumerable:!0})},a=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of C(e))!d.call(t,i)&&i!==r&&s(t,i,{get:()=>e[i],enumerable:!(n=m(e,i))||n.enumerable});return t};var S=(t,e,r)=>(r=t!=null?g(f(t)):{},a(e||!t||!t.__esModule?s(r,"default",{value:t,enumerable:!0}):r,t)),x=t=>a(s({},"__esModule",{value:!0}),t);var $={};y($,{createConsulClient:()=>p,deregisterService:()=>v,getServiceUrl:()=>u,registerService:()=>h});module.exports=x($);var l=S(require("consul"));function p(t={}){let{host:e="127.0.0.1",port:r=8500,token:n,secure:i=!1}=t;return new l.default({host:e,port:r,secure:i,defaults:n?{token:n}:void 0})}function O(t){return t==="host.docker.internal"?"127.0.0.1":t}async function u(t,e,r={}){let n=await t.health.service({service:e,passing:r.passing??!0});if(!n.length)throw new Error(`No healthy instance found for "${e}"`);let i=n[Math.floor(Math.random()*n.length)],o=O(i.Service.Address),c=i.Service.Port;return`http://${o}:${String(c)}`}async function h(t,e){let r=e.serviceId??`${e.serviceName}-${process.pid}`,n=e.healthPath??"/health",i=e.healthInterval??"10s",o=e.healthTimeout??"5s",c=e.deregisterCriticalServiceAfter??"30s";return await t.agent.service.register({id:r,name:e.serviceName,address:e.address,port:e.port,tags:e.tags,check:{name:`${e.serviceName}-health`,http:`http://${e.address}:${String(e.port)}${n}`,interval:i,timeout:o,deregistercriticalserviceafter:c}}),r}async function v(t,e){await t.agent.service.deregister(e)}0&&(module.exports={createConsulClient,deregisterService,getServiceUrl,registerService});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/consul.ts","../src/discover.ts","../src/register.ts"],"sourcesContent":["export { createConsulClient } from \"./consul\";\nexport type { ConsulClient } from \"./consul\";\n\nexport { getServiceUrl } from \"./discover\";\nexport { registerService, deregisterService } from \"./register\";\n\nexport type {\n  ConsulClientOptions,\n  ServiceDiscoveryOptions,\n  ServiceRegistrationOptions,\n} from \"./types\";\n","import Consul from \"consul\";\nimport type { ConsulClientOptions } from \"./types\";\n\nexport type ConsulClient = InstanceType<typeof Consul>;\n\nexport function createConsulClient(options: ConsulClientOptions = {}): ConsulClient {\n  const { host = \"127.0.0.1\", port = 8500, token, secure = false } = options;\n\n  return new Consul({\n    host,\n    port,\n    secure,\n    defaults: token ? { token } : undefined,\n  });\n}\n","import type { ConsulClient } from \"./consul\";\nimport type { ServiceDiscoveryOptions } from \"./types\";\n\nfunction normalizeHost(address: string): string {\n  return address === \"host.docker.internal\" ? \"127.0.0.1\" : address;\n}\n\nexport async function getServiceUrl(\n  consulClient: ConsulClient,\n  serviceName: string,\n  options: ServiceDiscoveryOptions = {},\n): Promise<string> {\n  const services = await consulClient.health.service({\n    service: serviceName,\n    passing: options.passing ?? true,\n  });\n\n  if (!services.length) {\n    throw new Error(`No healthy instance found for \"${serviceName}\"`);\n  }\n\n  const randomInstance = services[Math.floor(Math.random() * services.length)];\n  const host = normalizeHost(randomInstance.Service.Address);\n  const port = randomInstance.Service.Port;\n\n  return `http://${host}:${String(port)}`;\n}\n","import type { ConsulClient } from \"./consul\";\nimport type { ServiceRegistrationOptions } from \"./types\";\n\nexport async function registerService(\n  consulClient: ConsulClient,\n  options: ServiceRegistrationOptions,\n): Promise<string> {\n  const serviceId = options.serviceId ?? `${options.serviceName}-${process.pid}`;\n  const healthPath = options.healthPath ?? \"/health\";\n  const healthInterval = options.healthInterval ?? \"10s\";\n  const healthTimeout = options.healthTimeout ?? \"5s\";\n  const deregisterAfter = options.deregisterCriticalServiceAfter ?? \"30s\";\n\n  await consulClient.agent.service.register({\n    id: serviceId,\n    name: options.serviceName,\n    address: options.address,\n    port: options.port,\n    tags: options.tags,\n    check: {\n      name: `${options.serviceName}-health`,\n      http: `http://${options.address}:${String(options.port)}${healthPath}`,\n      interval: healthInterval,\n      timeout: healthTimeout,\n      deregistercriticalserviceafter: deregisterAfter,\n    },\n  });\n\n  return serviceId;\n}\n\nexport async function deregisterService(\n  consulClient: ConsulClient,\n  serviceId: string,\n): Promise<void> {\n  await consulClient.agent.service.deregister(serviceId);\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,wBAAAE,EAAA,sBAAAC,EAAA,kBAAAC,EAAA,oBAAAC,IAAA,eAAAC,EAAAN,GCAA,IAAAO,EAAmB,qBAKZ,SAASC,EAAmBC,EAA+B,CAAC,EAAiB,CAClF,GAAM,CAAE,KAAAC,EAAO,YAAa,KAAAC,EAAO,KAAM,MAAAC,EAAO,OAAAC,EAAS,EAAM,EAAIJ,EAEnE,OAAO,IAAI,EAAAK,QAAO,CAChB,KAAAJ,EACA,KAAAC,EACA,OAAAE,EACA,SAAUD,EAAQ,CAAE,MAAAA,CAAM,EAAI,MAChC,CAAC,CACH,CCXA,SAASG,EAAcC,EAAyB,CAC9C,OAAOA,IAAY,uBAAyB,YAAcA,CAC5D,CAEA,eAAsBC,EACpBC,EACAC,EACAC,EAAmC,CAAC,EACnB,CACjB,IAAMC,EAAW,MAAMH,EAAa,OAAO,QAAQ,CACjD,QAASC,EACT,QAASC,EAAQ,SAAW,EAC9B,CAAC,EAED,GAAI,CAACC,EAAS,OACZ,MAAM,IAAI,MAAM,kCAAkCF,CAAW,GAAG,EAGlE,IAAMG,EAAiBD,EAAS,KAAK,MAAM,KAAK,OAAO,EAAIA,EAAS,MAAM,CAAC,EACrEE,EAAOR,EAAcO,EAAe,QAAQ,OAAO,EACnDE,EAAOF,EAAe,QAAQ,KAEpC,MAAO,UAAUC,CAAI,IAAI,OAAOC,CAAI,CAAC,EACvC,CCvBA,eAAsBC,EACpBC,EACAC,EACiB,CACjB,IAAMC,EAAYD,EAAQ,WAAa,GAAGA,EAAQ,WAAW,IAAI,QAAQ,GAAG,GACtEE,EAAaF,EAAQ,YAAc,UACnCG,EAAiBH,EAAQ,gBAAkB,MAC3CI,EAAgBJ,EAAQ,eAAiB,KACzCK,EAAkBL,EAAQ,gCAAkC,MAElE,aAAMD,EAAa,MAAM,QAAQ,SAAS,CACxC,GAAIE,EACJ,KAAMD,EAAQ,YACd,QAASA,EAAQ,QACjB,KAAMA,EAAQ,KACd,KAAMA,EAAQ,KACd,MAAO,CACL,KAAM,GAAGA,EAAQ,WAAW,UAC5B,KAAM,UAAUA,EAAQ,OAAO,IAAI,OAAOA,EAAQ,IAAI,CAAC,GAAGE,CAAU,GACpE,SAAUC,EACV,QAASC,EACT,+BAAgCC,CAClC,CACF,CAAC,EAEMJ,CACT,CAEA,eAAsBK,EACpBP,EACAE,EACe,CACf,MAAMF,EAAa,MAAM,QAAQ,WAAWE,CAAS,CACvD","names":["index_exports","__export","createConsulClient","deregisterService","getServiceUrl","registerService","__toCommonJS","import_consul","createConsulClient","options","host","port","token","secure","Consul","normalizeHost","address","getServiceUrl","consulClient","serviceName","options","services","randomInstance","host","port","registerService","consulClient","options","serviceId","healthPath","healthInterval","healthTimeout","deregisterAfter","deregisterService"]}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import{a}from"./chunk-24OKBTEJ.mjs";import c from"consul";function l(t={}){let{host:e="127.0.0.1",port:r=8500,token:i,secure:s=!1}=t;return new c({host:e,port:r,secure:s,defaults:i?{token:i}:void 0})}async function p(t,e){let r=e.serviceId??`${e.serviceName}-${process.pid}`,i=e.healthPath??"/health",s=e.healthInterval??"10s",n=e.healthTimeout??"5s",o=e.deregisterCriticalServiceAfter??"30s";return await t.agent.service.register({id:r,name:e.serviceName,address:e.address,port:e.port,tags:e.tags,check:{name:`${e.serviceName}-health`,http:`http://${e.address}:${String(e.port)}${i}`,interval:s,timeout:n,deregistercriticalserviceafter:o}}),r}async function u(t,e){await t.agent.service.deregister(e)}export{l as createConsulClient,u as deregisterService,a as getServiceUrl,p as registerService};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/consul.ts","../src/register.ts"],"sourcesContent":["import Consul from \"consul\";\nimport type { ConsulClientOptions } from \"./types\";\n\nexport type ConsulClient = InstanceType<typeof Consul>;\n\nexport function createConsulClient(options: ConsulClientOptions = {}): ConsulClient {\n  const { host = \"127.0.0.1\", port = 8500, token, secure = false } = options;\n\n  return new Consul({\n    host,\n    port,\n    secure,\n    defaults: token ? { token } : undefined,\n  });\n}\n","import type { ConsulClient } from \"./consul\";\nimport type { ServiceRegistrationOptions } from \"./types\";\n\nexport async function registerService(\n  consulClient: ConsulClient,\n  options: ServiceRegistrationOptions,\n): Promise<string> {\n  const serviceId = options.serviceId ?? `${options.serviceName}-${process.pid}`;\n  const healthPath = options.healthPath ?? \"/health\";\n  const healthInterval = options.healthInterval ?? \"10s\";\n  const healthTimeout = options.healthTimeout ?? \"5s\";\n  const deregisterAfter = options.deregisterCriticalServiceAfter ?? \"30s\";\n\n  await consulClient.agent.service.register({\n    id: serviceId,\n    name: options.serviceName,\n    address: options.address,\n    port: options.port,\n    tags: options.tags,\n    check: {\n      name: `${options.serviceName}-health`,\n      http: `http://${options.address}:${String(options.port)}${healthPath}`,\n      interval: healthInterval,\n      timeout: healthTimeout,\n      deregistercriticalserviceafter: deregisterAfter,\n    },\n  });\n\n  return serviceId;\n}\n\nexport async function deregisterService(\n  consulClient: ConsulClient,\n  serviceId: string,\n): Promise<void> {\n  await consulClient.agent.service.deregister(serviceId);\n}\n"],"mappings":"oCAAA,OAAOA,MAAY,SAKZ,SAASC,EAAmBC,EAA+B,CAAC,EAAiB,CAClF,GAAM,CAAE,KAAAC,EAAO,YAAa,KAAAC,EAAO,KAAM,MAAAC,EAAO,OAAAC,EAAS,EAAM,EAAIJ,EAEnE,OAAO,IAAIF,EAAO,CAChB,KAAAG,EACA,KAAAC,EACA,OAAAE,EACA,SAAUD,EAAQ,CAAE,MAAAA,CAAM,EAAI,MAChC,CAAC,CACH,CCXA,eAAsBE,EACpBC,EACAC,EACiB,CACjB,IAAMC,EAAYD,EAAQ,WAAa,GAAGA,EAAQ,WAAW,IAAI,QAAQ,GAAG,GACtEE,EAAaF,EAAQ,YAAc,UACnCG,EAAiBH,EAAQ,gBAAkB,MAC3CI,EAAgBJ,EAAQ,eAAiB,KACzCK,EAAkBL,EAAQ,gCAAkC,MAElE,aAAMD,EAAa,MAAM,QAAQ,SAAS,CACxC,GAAIE,EACJ,KAAMD,EAAQ,YACd,QAASA,EAAQ,QACjB,KAAMA,EAAQ,KACd,KAAMA,EAAQ,KACd,MAAO,CACL,KAAM,GAAGA,EAAQ,WAAW,UAC5B,KAAM,UAAUA,EAAQ,OAAO,IAAI,OAAOA,EAAQ,IAAI,CAAC,GAAGE,CAAU,GACpE,SAAUC,EACV,QAASC,EACT,+BAAgCC,CAClC,CACF,CAAC,EAEMJ,CACT,CAEA,eAAsBK,EACpBP,EACAE,EACe,CACf,MAAMF,EAAa,MAAM,QAAQ,WAAWE,CAAS,CACvD","names":["Consul","createConsulClient","options","host","port","token","secure","registerService","consulClient","options","serviceId","healthPath","healthInterval","healthTimeout","deregisterAfter","deregisterService"]}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@abinashpatri/orchestrator",
+  "version": "1.0.0",
+  "description": "Reusable TypeScript/JavaScript service discovery and API gateway toolkit",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./express": {
+      "types": "./dist/express.d.ts",
+      "require": "./dist/express.js",
+      "import": "./dist/express.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run typecheck && npm run build"
+  },
+  "keywords": [
+    "consul",
+    "service-discovery",
+    "api-gateway",
+    "orchestrator",
+    "typescript"
+  ],
+  "author": "Abinash Patri",
+  "license": "MIT",
+  "type": "commonjs",
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "@types/node": "^25.5.0",
+    "eslint": "^10.1.0",
+    "express": "^5.1.0",
+    "http-proxy-middleware": "^3.0.5",
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "express": ">=4.18.0",
+    "http-proxy-middleware": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    },
+    "http-proxy-middleware": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "consul": "^2.0.1"
+  }
+}