@axiom-lattice/gateway 8.2.0 → 8.4.0

package/dist/index.d.mts

@@ -1469,6 +1469,33 @@ declare const defaultSwaggerUiConfig: {
     transformStaticCSP: (header: string) => string;
 };
 
+/** Dimensions a rate-limit policy can key on. */
+type RateLimitDimension = "ip" | "token" | "user" | "tenant" | "credential" | "key" | "session";
+/** One named rate-limit policy. */
+interface RateLimitPolicy {
+    /** Maximum requests in one fixed window. */
+    limit: number;
+    /** Fixed window length in milliseconds. */
+    windowMs: number;
+    /** Dimensions that must all stay under the limit. */
+    dimensions: readonly RateLimitDimension[];
+    /** Optional per-dimension override of {@link limit}. */
+    dimensionLimits?: Partial<Record<RateLimitDimension, number>>;
+    /** Set false to disable only this policy. */
+    enabled?: boolean;
+}
+/** Gateway-level rate-limit configuration. */
+interface RateLimitConfig {
+    /** Default true; `AXIOM_RATE_LIMIT_DISABLED=true` forces false. */
+    enabled?: boolean;
+    /** Defaults to `REDIS_URL`; omitted leaves per-process counters. */
+    redisUrl?: string;
+    /** Partial overrides merged over {@link DEFAULT_RATE_LIMIT_POLICIES}. */
+    policies?: Record<string, Partial<RateLimitPolicy>>;
+    /** Cap the process-local fallback map (default 10_000). */
+    maxInMemoryEntries?: number;
+}
+
 /** Optional startup/shutdown hooks for host-provided Gateway resources. */
 interface GatewayLifespan {
     /** Optional name used in shutdown error logs. */
@@ -2992,6 +3019,8 @@ interface LatticeGatewayConfig {
     gracefulShutdownTimeoutMs?: number;
     /** Optional host startup/shutdown hooks. */
     lifespans?: GatewayLifespan | GatewayLifespan[];
+    /** Gateway-level rate-limit defaults and overrides. */
+    rateLimits?: RateLimitConfig;
 }
 declare const LatticeGateway: {
     startAsHttpEndpoint: (config?: LatticeGatewayConfig) => Promise<void>;

package/dist/index.d.ts

@@ -1469,6 +1469,33 @@ declare const defaultSwaggerUiConfig: {
     transformStaticCSP: (header: string) => string;
 };
 
+/** Dimensions a rate-limit policy can key on. */
+type RateLimitDimension = "ip" | "token" | "user" | "tenant" | "credential" | "key" | "session";
+/** One named rate-limit policy. */
+interface RateLimitPolicy {
+    /** Maximum requests in one fixed window. */
+    limit: number;
+    /** Fixed window length in milliseconds. */
+    windowMs: number;
+    /** Dimensions that must all stay under the limit. */
+    dimensions: readonly RateLimitDimension[];
+    /** Optional per-dimension override of {@link limit}. */
+    dimensionLimits?: Partial<Record<RateLimitDimension, number>>;
+    /** Set false to disable only this policy. */
+    enabled?: boolean;
+}
+/** Gateway-level rate-limit configuration. */
+interface RateLimitConfig {
+    /** Default true; `AXIOM_RATE_LIMIT_DISABLED=true` forces false. */
+    enabled?: boolean;
+    /** Defaults to `REDIS_URL`; omitted leaves per-process counters. */
+    redisUrl?: string;
+    /** Partial overrides merged over {@link DEFAULT_RATE_LIMIT_POLICIES}. */
+    policies?: Record<string, Partial<RateLimitPolicy>>;
+    /** Cap the process-local fallback map (default 10_000). */
+    maxInMemoryEntries?: number;
+}
+
 /** Optional startup/shutdown hooks for host-provided Gateway resources. */
 interface GatewayLifespan {
     /** Optional name used in shutdown error logs. */
@@ -2992,6 +3019,8 @@ interface LatticeGatewayConfig {
     gracefulShutdownTimeoutMs?: number;
     /** Optional host startup/shutdown hooks. */
     lifespans?: GatewayLifespan | GatewayLifespan[];
+    /** Gateway-level rate-limit defaults and overrides. */
+    rateLimits?: RateLimitConfig;
 }
 declare const LatticeGateway: {
     startAsHttpEndpoint: (config?: LatticeGatewayConfig) => Promise<void>;