@futdevpro/nts-dynamo 1.15.145 → 1.15.151

package/build/_modules/rate-limit/rate-limit.middleware.d.ts

@@ -1,69 +1,28 @@
 import { Request, Response } from 'express';
 import { DyNTS_SingletonServiceBase } from '../../_services/base/singleton.service-base';
+import { DyNTS_RateLimitStoreKind_Type } from './_enums/rate-limit-store-kind.type-enum';
 import { DyNTS_RateLimit_Config } from './_models/rate-limit-config.interface';
 import { DyNTS_RateLimit_Policy } from './_models/rate-limit-policy.interface';
-/**
- * Sliding-window HTTP rate-limit middleware — opt-in service-szel, a meglevo
- * `DyNTS_Endpoint_Params.preProcesses` mechanizmus mellol mukodik.
- *
- * **Hasznalat (host app):**
- * ```ts
- * const rateLimit = DyNTS_RateLimit_Middleware.getInstance();
- * rateLimit.configure({
- *   defaultLimit: 100,            // 100 req/perc default
- *   defaultWindowMs: 60_000,
- *   keyExtractor: (req) => req.headers['x-api-key'] as string || req.ip,
- * });
- *
- * new DyNTS_Endpoint_Params({
- *   ...,
- *   preProcesses: [rateLimit.check, ...other],
- * });
- *
- * // subscription-tier-up: per-kulcs egyedi limit
- * rateLimit.setPolicyForKey('subscriber-tier-key-123', {
- *   limit: 1000,
- *   windowMs: 60_000,
- * });
- * ```
- *
- * **Viselkedes:**
- * - Sliding-window algoritmus: minden request egy timestamp; a window-on
- *   kivuli timestamp-ek nem szamolnak. Tobb pontos mint a fix-bucket
- *   (boundary-burst nincs).
- * - In-memory storage — single-instance MVP-nek megfelelo. Multi-instance
- *   prod-hoz Redis-backed extension kell (lasd a kozelebb dokumentumaltot).
- * - Limit lepes: 429 DyFM_Error + `X-RateLimit-*` + `Retry-After` header-ek.
- *
- * **Storage:** `Map<storageKey, timestamps[]>` ahol storageKey = `${subject}|${endpoint}`.
- * Periodikus GC takaritja a inaktiv kulcsokat.
- *
- * **Singleton:** `getInstance()`-szel hivd. A `.check` mezo binding-elve van
- * `this`-re, igy direkt atadhato `preProcesses`-be ujracsomagolas nelkul.
- */
+/** Atomic HTTP rate-limit boundary with an explicit shared-store production gate. */
 export declare class DyNTS_RateLimit_Middleware extends DyNTS_SingletonServiceBase {
-    static getInstance(): DyNTS_RateLimit_Middleware;
     private defaultLimit;
     private defaultWindowMs;
-    private responseHeaders;
+    private isResponseHeadersEnabled;
+    private isSharedStoreRequired;
+    private isKeyExtractorExplicit;
+    private isEndpointGrouperExplicit;
     private keyExtractor;
     private endpointGrouper;
-    /** request-log: storageKey → timestamp-tomb (Date.now() ms). */
-    private requestLog;
-    /** Per-kulcs egyedi policy-k. */
+    private costExtractor;
+    private clock;
+    private store;
     private keyPolicies;
-    /** Per-endpoint(-csoport) egyedi policy-k (a `endpointGrouper` outputjara kulcsolva). */
     private endpointPolicies;
-    /** GC timer handle. */
-    private gcTimer;
-    /**
-     * Konfig override. Hianyzo mezok a default-okat orzik. Hivhato barmikor —
-     * a `check()` a friss config-ot olvassa.
-     */
+    /** Returns the process-wide rate-limit middleware. */
+    static getInstance(): DyNTS_RateLimit_Middleware;
+    /** Applies a validated configuration atomically; invalid settings do not partially mutate the service. */
     configure(config: DyNTS_RateLimit_Config): void;
-    /**
-     * Aktualis konfig olvasasa (diagnosztika celokra).
-     */
+    /** Returns content-free configuration diagnostics. */
     getConfig(): {
         defaultLimit: number;
         defaultWindowMs: number;
@@ -71,63 +30,40 @@ export declare class DyNTS_RateLimit_Middleware extends DyNTS_SingletonServiceBa
         activeKeyPolicies: number;
         activeEndpointPolicies: number;
         trackedStorageKeys: number;
+        storeKind: DyNTS_RateLimitStoreKind_Type;
+        requireSharedStore: boolean;
     };
-    /**
-     * Per-kulcs egyedi policy beallitas (pl. subscription-tier alapjan).
-     * A `key`-nek pontosan azzal a stringgel kell egyeznie, amit a `keyExtractor`
-     * visszaad.
-     */
+    /** Sets one validated subject policy. */
     setPolicyForKey(key: string, policy: DyNTS_RateLimit_Policy): void;
-    /**
-     * Per-kulcs policy torlese (visszaall a default-ra).
-     */
+    /** Removes one subject policy. */
     clearPolicyForKey(key: string): void;
-    /**
-     * Per-endpoint(-csoport) egyedi policy beallitas. Az `endpoint`-nek pontosan
-     * azzal a stringgel kell egyeznie, amit az `endpointGrouper` visszaad (default: `req.path`).
-     * Akkor hasznos, ha egy endpointnak a globalis default-tol eltero limit kell — pl. egy
-     * webhook nagy burst-toleranciat igenyel (a legit, distributed forgalom ne bukjon), mig
-     * egy admin-endpoint szuk limitet. Precedencia: per-kulcs policy > per-endpoint policy > default.
-     */
+    /** Sets one validated endpoint-group policy. */
     setPolicyForEndpoint(endpoint: string, policy: DyNTS_RateLimit_Policy): void;
-    /**
-     * Per-endpoint policy torlese (visszaall a default-ra).
-     */
+    /** Removes one endpoint-group policy. */
     clearPolicyForEndpoint(endpoint: string): void;
-    /**
-     * Pre-process function — atadhato `DyNTS_Endpoint_Params.preProcesses`-be.
-     *
-     * Throws:
-     *   - 429 ha az aktualis request meghaladna a limit-et a sliding window-on
-     *
-     * Side-effect: ha `responseHeaders === true`, beallitja az `X-RateLimit-Limit`,
-     * `X-RateLimit-Remaining`, `X-RateLimit-Reset` header-eket; 429 eseten
-     * a `Retry-After` header-t is.
-     */
+    /** Atomically consumes one request permit or raises a stable content-free error. */
     readonly check: (req: Request, res: Response) => Promise<void>;
-    /**
-     * Default key-extractor: x-forwarded-for vagy req.ip vagy 'unknown'.
-     * Csak akkor hasznalt, ha a host nem allit be sajat extractort a configure-ben.
-     */
-    private defaultKeyExtractor;
-    /**
-     * GC timer inditasa (idempotent). Periodikusan eltavolitja az inaktiv
-     * storage-key-eket a request-log-bol — memory-leak prevention.
-     */
-    private startGcTimer;
-    /**
-     * GC sweep — minden storage-key-rol levagja a regi timestamp-eket, es
-     * eltavolitja az ureseket. Hivhato kulonosen test-bol.
-     */
+    /** Performs explicit opportunistic cleanup only for the local test/development store. */
     runGc(): void;
-    /**
-     * GC timer leallitasa (graceful shutdown vagy test-cleanup).
-     */
+    /** Backward-compatible no-op: this implementation never starts a timer. */
     stopGcTimer(): void;
-    /**
-     * Test-only: visszaallitja a default config-ot + uriti a state-et, hogy a
-     * specfajlok ne szivarogjak at egymas state-jet. Production code NE hivja.
-     */
+    /** Resets all state to deterministic local defaults for tests. */
     _resetForTesting(): void;
+    private buildConfigSnapshot;
+    private addInitialPolicies;
+    private assertPolicy;
+    private assertCost;
+    private assertConfigurationFunctions;
+    private assertStore;
+    private extractBucketPart;
+    private extractCost;
+    private buildBucketKey;
+    private getNow;
+    private assertBucketPart;
+    private throwBucketKeyInvalid;
+    private assertStoreResult;
+    private setResponseHeaders;
+    private getRetryAfterSeconds;
+    private throwRateLimitError;
 }
 //# sourceMappingURL=rate-limit.middleware.d.ts.map

package/build/_modules/rate-limit/rate-limit.middleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rate-limit.middleware.d.ts","sourceRoot":"","sources":["../../../src/_modules/rate-limit/rate-limit.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAI5C,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AAGzF,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AA2B/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,0BAA2B,SAAQ,0BAA0B;IAExE,MAAM,CAAC,WAAW,IAAI,0BAA0B;IAIhD,OAAO,CAAC,YAAY,CAAyB;IAC7C,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,eAAe,CAAqC;IAE5D,OAAO,CAAC,YAAY,CACsC;IAC1D,OAAO,CAAC,eAAe,CACc;IAErC,gEAAgE;IAChE,OAAO,CAAC,UAAU,CAAoC;IAEtD,iCAAiC;IACjC,OAAO,CAAC,WAAW,CAAkD;IAErE,yFAAyF;IACzF,OAAO,CAAC,gBAAgB,CAAkD;IAE1E,uBAAuB;IACvB,OAAO,CAAC,OAAO,CAA+B;IAG9C;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IA6B/C;;OAEG;IACH,SAAS,IAAI;QACX,YAAY,EAAE,MAAM,CAAC;QACrB,eAAe,EAAE,MAAM,CAAC;QACxB,eAAe,EAAE,OAAO,CAAC;QACzB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,sBAAsB,EAAE,MAAM,CAAC;QAC/B,kBAAkB,EAAE,MAAM,CAAC;KAC5B;IAWD;;;;OAIG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIlE;;OAEG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;;OAMG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAI5E;;OAEG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK9C;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,QAAe,OAAO,OAAO,QAAQ,KAAG,OAAO,CAAC,IAAI,CAAC,CAuDjE;IAGF;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAapB;;;OAGG;IACH,KAAK,IAAI,IAAI;IAcb;;OAEG;IACH,WAAW,IAAI,IAAI;IAQnB;;;OAGG;IACH,gBAAgB,IAAI,IAAI;CAWzB"}
+{"version":3,"file":"rate-limit.middleware.d.ts","sourceRoot":"","sources":["../../../src/_modules/rate-limit/rate-limit.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAK5C,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,EAAE,6BAA6B,EAAE,MAAM,0CAA0C,CAAC;AACzF,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAE/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAyC/E,qFAAqF;AACrF,qBAAa,0BAA2B,SAAQ,0BAA0B;IACxE,OAAO,CAAC,YAAY,CAAyB;IAC7C,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,wBAAwB,CAAqC;IACrE,OAAO,CAAC,qBAAqB,CAAkB;IAC/C,OAAO,CAAC,sBAAsB,CAAkB;IAChD,OAAO,CAAC,yBAAyB,CAAkB;IACnD,OAAO,CAAC,YAAY,CAA2E;IAC/F,OAAO,CAAC,eAAe,CAAgE;IACvF,OAAO,CAAC,aAAa,CAInB;IACF,OAAO,CAAC,KAAK,CAA0C;IACvD,OAAO,CAAC,KAAK,CAAwE;IACrF,OAAO,CAAC,WAAW,CAAkD;IACrE,OAAO,CAAC,gBAAgB,CAAkD;IAE1E,sDAAsD;WACxC,WAAW,IAAI,0BAA0B;IAIvD,0GAA0G;IACnG,SAAS,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAkBtD,sDAAsD;IAC/C,SAAS,IAAI;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,eAAe,EAAE,MAAM,CAAC;QACxB,eAAe,EAAE,OAAO,CAAC;QACzB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,sBAAsB,EAAE,MAAM,CAAC;QAC/B,kBAAkB,EAAE,MAAM,CAAC;QAC3B,SAAS,EAAE,6BAA6B,CAAC;QACzC,kBAAkB,EAAE,OAAO,CAAC;KAC3B;IAeH,yCAAyC;IAClC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAMzE,kCAAkC;IAC3B,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI3C,gDAAgD;IACzC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAMnF,yCAAyC;IAClC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIrD,oFAAoF;IACpF,SAAgB,KAAK,QAAe,OAAO,OAAO,QAAQ,KAAG,OAAO,CAAC,IAAI,CAAC,CAgDxE;IAEF,yFAAyF;IAClF,KAAK,IAAI,IAAI;IAMpB,2EAA2E;IACpE,WAAW,IAAI,IAAI;IAE1B,kEAAkE;IAC3D,gBAAgB,IAAI,IAAI;IAoB/B,OAAO,CAAC,mBAAmB;IAkD3B,OAAO,CAAC,kBAAkB;IAkB1B,OAAO,CAAC,YAAY;IAkBpB,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,4BAA4B;IAqBpC,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,iBAAiB;IAoBzB,OAAO,CAAC,WAAW;IAanB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,MAAM;IAqBd,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,iBAAiB;IA6BzB,OAAO,CAAC,kBAAkB;IA4B1B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,mBAAmB;CAY5B"}