@hazeljs/gateway 0.2.0-beta.41

package/dist/types/index.d.ts

@@ -0,0 +1,217 @@
+/**
+ * @hazeljs/gateway - Type Definitions
+ */
+import { CircuitBreakerConfig, RetryConfig, RateLimiterConfig } from '@hazeljs/resilience';
+import { DiscoveryClientConfig, ServiceFilter } from '@hazeljs/discovery';
+export interface GatewayConfig {
+    /** Discovery client configuration */
+    discovery?: DiscoveryClientConfig;
+    /** Default resilience settings applied to all routes */
+    resilience?: GatewayResilienceDefaults;
+    /** Metrics collection configuration */
+    metrics?: GatewayMetricsConfig;
+    /** Global middleware */
+    middleware?: GatewayMiddlewareConfig;
+}
+export interface GatewayResilienceDefaults {
+    /** Default circuit breaker config for all routes */
+    defaultCircuitBreaker?: Partial<CircuitBreakerConfig>;
+    /** Default retry config for all routes */
+    defaultRetry?: Partial<RetryConfig>;
+    /** Default timeout in ms for all routes */
+    defaultTimeout?: number;
+}
+export interface GatewayMetricsConfig {
+    /** Whether to collect metrics */
+    enabled: boolean;
+    /** How often to aggregate metrics (ms or string like '10s') */
+    collectionInterval?: number | string;
+    /** Metrics window size in ms */
+    windowSize?: number;
+}
+export interface GatewayMiddlewareConfig {
+    /** Enable CORS */
+    cors?: boolean | CorsConfig;
+    /** Enable request logging */
+    logging?: boolean;
+    /** Enable request ID generation */
+    requestId?: boolean;
+}
+export interface CorsConfig {
+    origin?: string | string[];
+    methods?: string[];
+    headers?: string[];
+    credentials?: boolean;
+}
+export interface RouteConfig {
+    /** URL pattern to match (supports ** glob, :param, *) */
+    path: string;
+    /** HTTP methods to match (default: all) */
+    methods?: string[];
+}
+export interface ServiceRouteConfig {
+    /** Name of the service in the discovery registry */
+    serviceName: string;
+    /** Load balancing strategy override */
+    loadBalancingStrategy?: string;
+    /** Filter for service instances */
+    filter?: ServiceFilter;
+    /** Path prefix to strip before forwarding */
+    stripPrefix?: string;
+    /** Path prefix to add when forwarding */
+    addPrefix?: string;
+}
+export type VersionResolutionStrategy = 'header' | 'uri' | 'query';
+export interface VersionRouteConfig {
+    /** How to detect the requested version */
+    strategy?: VersionResolutionStrategy;
+    /** Header name for header-based routing (default: 'X-API-Version') */
+    header?: string;
+    /** Query parameter name for query-based routing */
+    queryParam?: string;
+    /** Route definitions per version */
+    routes: Record<string, VersionRouteEntry>;
+    /** Default version if none specified */
+    defaultVersion?: string;
+}
+export interface VersionRouteEntry {
+    /** Weight for weighted routing (0-100) */
+    weight: number;
+    /** Whether to route only when version is explicitly requested */
+    allowExplicit?: boolean;
+    /** Service filter override for this version */
+    filter?: ServiceFilter;
+}
+export interface CanaryConfig {
+    /** Stable version configuration */
+    stable: CanaryVersionConfig;
+    /** Canary version configuration */
+    canary: CanaryVersionConfig;
+    /** Promotion strategy configuration */
+    promotion: CanaryPromotionConfig;
+}
+export interface CanaryVersionConfig {
+    /** Version identifier (matches metadata.version on ServiceInstance) */
+    version: string;
+    /** Initial traffic weight (0-100, stable + canary should = 100) */
+    weight: number;
+    /** Optional service filter override */
+    filter?: ServiceFilter;
+}
+export interface CanaryPromotionConfig {
+    /** Strategy for evaluating promotion readiness */
+    strategy: 'error-rate' | 'latency' | 'custom';
+    /** Error rate threshold percentage (for 'error-rate' strategy) */
+    errorThreshold?: number;
+    /** Latency threshold in ms (for 'latency' strategy) */
+    latencyThreshold?: number;
+    /** Time window for evaluation (ms or string like '5m') */
+    evaluationWindow: number | string;
+    /** Whether to automatically promote through steps */
+    autoPromote: boolean;
+    /** Whether to automatically rollback on threshold breach */
+    autoRollback: boolean;
+    /** Weight progression steps (e.g. [10, 25, 50, 75, 100]) */
+    steps: number[];
+    /** Time between promotion steps (ms or string like '10m') */
+    stepInterval: number | string;
+    /** Custom evaluator function (for 'custom' strategy) */
+    customEvaluator?: (metrics: CanaryMetrics) => CanaryDecision;
+    /** Minimum number of requests before evaluation can happen */
+    minRequests?: number;
+}
+export interface CanaryMetrics {
+    stable: CanaryVersionMetrics;
+    canary: CanaryVersionMetrics;
+}
+export interface CanaryVersionMetrics {
+    totalRequests: number;
+    errorCount: number;
+    errorRate: number;
+    averageLatency: number;
+    p99Latency: number;
+}
+export type CanaryDecision = 'promote' | 'rollback' | 'hold';
+export declare enum CanaryState {
+    /** Canary is actively receiving traffic at current weight */
+    ACTIVE = "ACTIVE",
+    /** Canary was promoted to 100% */
+    PROMOTED = "PROMOTED",
+    /** Canary was rolled back, all traffic to stable */
+    ROLLED_BACK = "ROLLED_BACK",
+    /** Canary is paused (manual intervention) */
+    PAUSED = "PAUSED"
+}
+export interface TrafficPolicyConfig {
+    /** Mirror traffic to another service for shadow testing */
+    mirror?: TrafficMirrorConfig;
+    /** Request/response transformation */
+    transform?: TrafficTransformConfig;
+    /** Timeout override in ms */
+    timeout?: number;
+    /** Retry override */
+    retry?: Partial<RetryConfig>;
+    /** Circuit breaker override */
+    circuitBreaker?: Partial<CircuitBreakerConfig>;
+    /** Rate limit override */
+    rateLimit?: Partial<RateLimiterConfig>;
+}
+export interface TrafficMirrorConfig {
+    /** Target service name for mirrored traffic */
+    service: string;
+    /** Percentage of traffic to mirror (0-100) */
+    percentage: number;
+    /** Whether to wait for mirror response */
+    waitForResponse?: boolean;
+}
+export interface TrafficTransformConfig {
+    /** Transform the outgoing request before forwarding */
+    request?: (req: ProxyRequest) => ProxyRequest;
+    /** Transform the response before returning to client */
+    response?: (res: ProxyResponse) => ProxyResponse;
+}
+export interface ProxyRequest {
+    method: string;
+    path: string;
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    query?: Record<string, string>;
+}
+export interface ProxyResponse {
+    status: number;
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+}
+export interface GatewayRouteDefinition {
+    /** Route path pattern */
+    path: string;
+    /** Target service name */
+    serviceName: string;
+    /** Full service route configuration */
+    serviceConfig?: ServiceRouteConfig;
+    /** Version routing configuration */
+    versionRoute?: VersionRouteConfig;
+    /** Canary deployment configuration */
+    canary?: CanaryConfig;
+    /** Traffic policy */
+    trafficPolicy?: TrafficPolicyConfig;
+    /** Rate limiter config */
+    rateLimit?: Partial<RateLimiterConfig>;
+    /** Circuit breaker config */
+    circuitBreaker?: Partial<CircuitBreakerConfig>;
+    /** HTTP methods */
+    methods?: string[];
+}
+export interface GatewayFullConfig extends GatewayConfig {
+    /** Route definitions loaded from configuration */
+    routes: GatewayRouteDefinition[];
+}
+export interface GatewayEvent {
+    type: string;
+    timestamp: number;
+    route?: string;
+    service?: string;
+    data?: Record<string, unknown>;
+}
+export type GatewayEventType = 'canary:promote' | 'canary:rollback' | 'canary:complete' | 'canary:paused' | 'circuit:open' | 'circuit:close' | 'circuit:half-open' | 'rate-limit:exceeded' | 'route:error' | 'route:timeout';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAI1E,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,wDAAwD;IACxD,UAAU,CAAC,EAAE,yBAAyB,CAAC;IACvC,uCAAuC;IACvC,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,wBAAwB;IACxB,UAAU,CAAC,EAAE,uBAAuB,CAAC;CACtC;AAED,MAAM,WAAW,yBAAyB;IACxC,oDAAoD;IACpD,qBAAqB,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACtD,0CAA0C;IAC1C,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACpC,2CAA2C;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,+DAA+D;IAC/D,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrC,gCAAgC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,kBAAkB;IAClB,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IAC5B,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mCAAmC;IACnC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAID,MAAM,WAAW,WAAW;IAC1B,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,mCAAmC;IACnC,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC;AAEnE,MAAM,WAAW,kBAAkB;IACjC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IACrC,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC1C,wCAAwC;IACxC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAID,MAAM,WAAW,YAAY;IAC3B,mCAAmC;IACnC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,mCAAmC;IACnC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,uCAAuC;IACvC,SAAS,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,mBAAmB;IAClC,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,kDAAkD;IAClD,QAAQ,EAAE,YAAY,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC9C,kEAAkE;IAClE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,0DAA0D;IAC1D,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,qDAAqD;IACrD,WAAW,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,YAAY,EAAE,OAAO,CAAC;IACtB,4DAA4D;IAC5D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,wDAAwD;IACxD,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,cAAc,CAAC;IAC7D,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,oBAAoB,CAAC;IAC7B,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;AAE7D,oBAAY,WAAW;IACrB,6DAA6D;IAC7D,MAAM,WAAW;IACjB,kCAAkC;IAClC,QAAQ,aAAa;IACrB,oDAAoD;IACpD,WAAW,gBAAgB;IAC3B,6CAA6C;IAC7C,MAAM,WAAW;CAClB;AAID,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,sCAAsC;IACtC,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7B,+BAA+B;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC/C,0BAA0B;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,uDAAuD;IACvD,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,YAAY,CAAC;IAC9C,wDAAwD;IACxD,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,aAAa,CAAC;CAClD;AAID,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,oCAAoC;IACpC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,sCAAsC;IACtC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,qBAAqB;IACrB,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,0BAA0B;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACvC,6BAA6B;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC/C,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAID,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,kDAAkD;IAClD,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAID,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,MAAM,gBAAgB,GACxB,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,cAAc,GACd,eAAe,GACf,mBAAmB,GACnB,qBAAqB,GACrB,aAAa,GACb,eAAe,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * @hazeljs/gateway - Type Definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanaryState = void 0;
+var CanaryState;
+(function (CanaryState) {
+    /** Canary is actively receiving traffic at current weight */
+    CanaryState["ACTIVE"] = "ACTIVE";
+    /** Canary was promoted to 100% */
+    CanaryState["PROMOTED"] = "PROMOTED";
+    /** Canary was rolled back, all traffic to stable */
+    CanaryState["ROLLED_BACK"] = "ROLLED_BACK";
+    /** Canary is paused (manual intervention) */
+    CanaryState["PAUSED"] = "PAUSED";
+})(CanaryState || (exports.CanaryState = CanaryState = {}));

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@hazeljs/gateway",
+  "version": "0.2.0-beta.41",
+  "description": "Intelligent API Gateway for HazelJS - Version routing, canary deployments, circuit breaking, and traffic management",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest --coverage --passWithNoTests",
+    "test:ci": "jest --coverage --coverageReporters=text --coverageReporters=lcov --coverageReporters=clover --no-coverage-threshold",
+    "test:watch": "jest --watch",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@hazeljs/core": "^0.2.0-beta.41",
+    "@hazeljs/discovery": "^0.2.0-beta.41",
+    "@hazeljs/resilience": "^0.2.0-beta.41",
+    "axios": "^1.6.0",
+    "reflect-metadata": "^0.2.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.17.50",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "@hazeljs/config": "*"
+  },
+  "peerDependenciesMeta": {
+    "@hazeljs/config": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hazel-js/hazeljs.git",
+    "directory": "packages/gateway"
+  },
+  "keywords": [
+    "hazeljs",
+    "api-gateway",
+    "gateway",
+    "routing",
+    "canary",
+    "circuit-breaker",
+    "traffic-management",
+    "version-routing",
+    "microservices"
+  ],
+  "author": "Muhammad Arslan <marslan@hazeljs.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/hazeljs/hazel-js/issues"
+  },
+  "homepage": "https://hazeljs.com",
+  "gitHead": "b50699eaa4847a8cfe9c346d7e4464b4af7f3120"
+}