@daiso-tech/core 0.42.0 → 0.43.2

package/dist/rate-limiter/implementations/derivables/rate-limiter-provider-factory/rate-limiter-provider-factory.js

@@ -0,0 +1,132 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../event-bus/contracts/_module.js";
+import {} from "../../../../namespace/_module.js";
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { RateLimiterProvider, DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE, } from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider/_module.js";
+import { 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+UnregisteredAdapterError, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+DefaultAdapterNotDefinedError, } from "../../../../utilities/_module.js";
+/**
+ * The `RateLimiterProviderFactory` class is immutable.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export class RateLimiterProviderFactory {
+    settings;
+    /**
+     * @example
+     * ```ts
+     * import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
+     * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+     * import { RedisRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
+     * import Redis from "ioredis"
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const rateLimiterProviderFactory = new RateLimiterProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new DatabaseRateLimiterAdapter({
+     *       adapter: new MemoryRateLimiterStorageAdapter()
+     *     }),
+     *     redis: new RedisRateLimiterAdapter({
+     *       database: new Redis("YOUR_REDIS_CONNECTION")
+     *     }),
+     *   },
+     *   defaultAdapter: "memory",
+     * });
+     * ```
+     */
+    constructor(settings) {
+        this.settings = settings;
+    }
+    setNamespace(namespace) {
+        return new RateLimiterProviderFactory({
+            ...this.settings,
+            namespace,
+        });
+    }
+    setEventBus(eventBus) {
+        return new RateLimiterProviderFactory({
+            ...this.settings,
+            eventBus,
+        });
+    }
+    setOnlyError(onlyError) {
+        return new RateLimiterProviderFactory({
+            ...this.settings,
+            onlyError,
+        });
+    }
+    setErrorPolicy(errorPolicy) {
+        return new RateLimiterProviderFactory({
+            ...this.settings,
+            errorPolicy,
+        });
+    }
+    /**
+     * @example
+     * ```ts
+     * import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
+     * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+     * import { RedisRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
+     * import Redis from "ioredis"
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const rateLimiterProviderFactory = new RateLimiterProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new DatabaseRateLimiterAdapter({
+     *       adapter: new MemoryRateLimiterStorageAdapter()
+     *     }),
+     *     redis: new RedisRateLimiterAdapter({
+     *       database: new Redis("YOUR_REDIS_CONNECTION")
+     *     }),
+     *   },
+     *   defaultAdapter: "memory",
+     * });
+     *
+     * // Will apply rate limiter logic the default adapter which is MemoryRateLimiterStorageAdapter
+     * await rateLimiterProviderFactory
+     *   .use()
+     *   .create("a")
+     *   .runOrFail(async () => {
+     *     // ... code to apply rate limiter logic
+     *   });
+     *
+     * // Will apply rate limiter logic the default adapter which is RedisRateLimiterAdapter
+     * await rateLimiterProviderFactory
+     *   .use("redis")
+     *   .create("a")
+     *   .runOrFail(async () => {
+     *     // ... code to apply rate limiter logic
+     *   });
+     * ```
+     */
+    use(adapterName = this.settings.defaultAdapter) {
+        if (adapterName === undefined) {
+            throw new DefaultAdapterNotDefinedError(RateLimiterProviderFactory.name);
+        }
+        const adapter = this.settings.adapters[adapterName];
+        if (adapter === undefined) {
+            throw new UnregisteredAdapterError(adapterName);
+        }
+        const { namespace = DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE } = this.settings;
+        return new RateLimiterProvider({
+            ...this.settings,
+            adapter,
+            namespace: namespace.appendRoot(adapterName),
+        });
+    }
+}
+//# sourceMappingURL=rate-limiter-provider-factory.js.map

package/dist/rate-limiter/implementations/derivables/rate-limiter-provider-factory/rate-limiter-provider-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-provider-factory.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/derivables/rate-limiter-provider-factory/rate-limiter-provider-factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAkB,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAIN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACH,mBAAmB,EACnB,0CAA0C,GAE7C,MAAM,4EAA4E,CAAC;AACpF,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAEhC,MAAM,wBAAwB,CAAC;AAuBhC;;;;;GAKG;AACH,MAAM,OAAO,0BAA0B;IA8Bd;IA3BrB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,YACqB,QAAuD;QAAvD,aAAQ,GAAR,QAAQ,CAA+C;IACzE,CAAC;IAEJ,YAAY,CAAC,SAAoB;QAC7B,OAAO,IAAI,0BAA0B,CAAC;YAClC,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,QAAmB;QAC3B,OAAO,IAAI,0BAA0B,CAAC;YAClC,GAAG,IAAI,CAAC,QAAQ;YAChB,QAAQ;SACX,CAAC,CAAC;IACP,CAAC;IAED,YAAY,CAAC,SAAmB;QAC5B,OAAO,IAAI,0BAA0B,CAAC;YAClC,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CACV,WAAwB;QAExB,OAAO,IAAI,0BAA0B,CAAC;YAClC,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,QAAQ,CAAC,cAAc;QAEjE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CACnC,0BAA0B,CAAC,IAAI,CAClC,CAAC;QACN,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,EAAE,SAAS,GAAG,0CAA0C,EAAE,GAC5D,IAAI,CAAC,QAAQ,CAAC;QAClB,OAAO,IAAI,mBAAmB,CAAC;YAC3B,GAAG,IAAI,CAAC,QAAQ;YAChB,OAAO;YACP,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC;SAC/C,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/rate-limiter/implementations/policies/_module-exports.d.ts

@@ -0,0 +1,4 @@
+export * from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/_shared.js";
+export * from "../../../rate-limiter/implementations/policies/types.js";

package/dist/rate-limiter/implementations/policies/_module-exports.js

@@ -0,0 +1,5 @@
+export * from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/_shared.js";
+export * from "../../../rate-limiter/implementations/policies/types.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/rate-limiter/implementations/policies/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/policies/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,yEAAyE,CAAC;AACxF,cAAc,2EAA2E,CAAC;AAC1F,cAAc,oDAAoD,CAAC;AACnE,cAAc,kDAAkD,CAAC"}

package/dist/rate-limiter/implementations/policies/_module.d.ts

@@ -0,0 +1,4 @@
+export * from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/_shared.js";
+export * from "../../../rate-limiter/implementations/policies/types.js";

package/dist/rate-limiter/implementations/policies/_module.js

@@ -0,0 +1,5 @@
+export * from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+export * from "../../../rate-limiter/implementations/policies/_shared.js";
+export * from "../../../rate-limiter/implementations/policies/types.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/implementations/policies/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/policies/_module.ts"],"names":[],"mappings":"AAAA,cAAc,yEAAyE,CAAC;AACxF,cAAc,2EAA2E,CAAC;AAC1F,cAAc,oDAAoD,CAAC;AACnE,cAAc,kDAAkD,CAAC"}

package/dist/rate-limiter/implementations/policies/_shared.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @module RateLimiter
+ */
+import { type RateLimiterPolicySettingsEnum, type SerializedRateLimiterPolicySettingsEnum } from "../../../rate-limiter/implementations/policies/types.js";
+/**
+ * @internal
+ */
+export declare function resolveRateLimiterPolicySettings(settings: RateLimiterPolicySettingsEnum): Required<RateLimiterPolicySettingsEnum>;
+/**
+ * @internal
+ */
+export declare function serializeRateLimiterPolicySettingsEnum(settings: RateLimiterPolicySettingsEnum): Required<SerializedRateLimiterPolicySettingsEnum>;

package/dist/rate-limiter/implementations/policies/_shared.js

@@ -0,0 +1,37 @@
+/**
+ * @module RateLimiter
+ */
+import { resolveFixedWindowLimiterSettings, serializeFixedWindowLimiterSettings, } from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+import { resolveSlidingWindowLimiterSettings, serializeSlidingWindowLimiterSettings, } from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+import { LIMITER_POLICIES, } from "../../../rate-limiter/implementations/policies/types.js";
+/**
+ * @internal
+ */
+export function resolveRateLimiterPolicySettings(settings) {
+    if (settings.type === LIMITER_POLICIES.FIXED_WINDOW) {
+        return {
+            type: LIMITER_POLICIES.FIXED_WINDOW,
+            ...resolveFixedWindowLimiterSettings(settings),
+        };
+    }
+    return {
+        type: LIMITER_POLICIES.SLIDING_WINDOW,
+        ...resolveSlidingWindowLimiterSettings(settings),
+    };
+}
+/**
+ * @internal
+ */
+export function serializeRateLimiterPolicySettingsEnum(settings) {
+    if (settings.type === LIMITER_POLICIES.FIXED_WINDOW) {
+        return {
+            type: LIMITER_POLICIES.FIXED_WINDOW,
+            ...serializeFixedWindowLimiterSettings(settings),
+        };
+    }
+    return {
+        type: LIMITER_POLICIES.SLIDING_WINDOW,
+        ...serializeSlidingWindowLimiterSettings(settings),
+    };
+}
+//# sourceMappingURL=_shared.js.map

package/dist/rate-limiter/implementations/policies/_shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_shared.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/policies/_shared.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,iCAAiC,EACjC,mCAAmC,GACtC,MAAM,yEAAyE,CAAC;AACjF,OAAO,EACH,mCAAmC,EACnC,qCAAqC,GACxC,MAAM,2EAA2E,CAAC;AACnF,OAAO,EACH,gBAAgB,GAGnB,MAAM,kDAAkD,CAAC;AAE1D;;GAEG;AACH,MAAM,UAAU,gCAAgC,CAC5C,QAAuC;IAEvC,IAAI,QAAQ,CAAC,IAAI,KAAK,gBAAgB,CAAC,YAAY,EAAE,CAAC;QAClD,OAAO;YACH,IAAI,EAAE,gBAAgB,CAAC,YAAY;YACnC,GAAG,iCAAiC,CAAC,QAAQ,CAAC;SACjD,CAAC;IACN,CAAC;IACD,OAAO;QACH,IAAI,EAAE,gBAAgB,CAAC,cAAc;QACrC,GAAG,mCAAmC,CAAC,QAAQ,CAAC;KACnD,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sCAAsC,CAClD,QAAuC;IAEvC,IAAI,QAAQ,CAAC,IAAI,KAAK,gBAAgB,CAAC,YAAY,EAAE,CAAC;QAClD,OAAO;YACH,IAAI,EAAE,gBAAgB,CAAC,YAAY;YACnC,GAAG,mCAAmC,CAAC,QAAQ,CAAC;SACnD,CAAC;IACN,CAAC;IACD,OAAO;QACH,IAAI,EAAE,gBAAgB,CAAC,cAAc;QACrC,GAAG,qCAAqC,CAAC,QAAQ,CAAC;KACrD,CAAC;AACN,CAAC"}

package/dist/rate-limiter/implementations/policies/fixed-window-limiter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../rate-limiter/implementations/policies/fixed-window-limiter/fixed-window-limiter.js";

package/dist/rate-limiter/implementations/policies/fixed-window-limiter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/policies/fixed-window-limiter/fixed-window-limiter.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/implementations/policies/fixed-window-limiter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/policies/fixed-window-limiter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,sFAAsF,CAAC"}

package/dist/rate-limiter/implementations/policies/fixed-window-limiter/fixed-window-limiter.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @module RateLimiter
+ */
+import { type IRateLimiterPolicy } from "../../../../rate-limiter/contracts/_module.js";
+import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export type FixedWindowLimiterSettings = {
+    /**
+     * The time span in which attempts are active before reseting.
+     *
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
+     * TimeSpan.fromSeconds(1)
+     * ```
+     */
+    window?: ITimeSpan;
+};
+/**
+ * @internal
+ */
+export declare function resolveFixedWindowLimiterSettings(settings: FixedWindowLimiterSettings): Required<FixedWindowLimiterSettings>;
+/**
+ * @internal
+ */
+export type SerializedFixedWindowLimiterSettings = {
+    window?: number;
+};
+/**
+ * @internal
+ */
+export declare function serializeFixedWindowLimiterSettings(settings: FixedWindowLimiterSettings): Required<SerializedFixedWindowLimiterSettings>;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export type FixedWindowLimiterState = {
+    attempt: number;
+    /**
+     * Unix timestamp in ms
+     */
+    lastAttemptAt: number;
+};
+/**
+ * Each request inside a fixed time increases a counter.
+ * Once the counter reaches the maximum allowed number, all further attempts are
+ * rejected.
+ *
+ * **Pro:**
+ *
+ * - Newer attempts are not starved by old ones.
+ * - Low storage cost.
+ *
+ * **Con:**
+ *
+ * A burst of attempts near the boundary of a window can result in a very
+ * high request rate because two windows will be filled with attempts quickly.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export declare class FixedWindowLimiter implements IRateLimiterPolicy<FixedWindowLimiterState> {
+    private readonly window;
+    constructor(settings?: FixedWindowLimiterSettings);
+    initialMetrics(currentDate: Date): FixedWindowLimiterState;
+    shouldBlock(currentMetrics: FixedWindowLimiterState, limit: number, currentDate: Date): boolean;
+    getExpiration(currentMetrics: FixedWindowLimiterState, _currentDate: Date): Date;
+    getAttempts(currentMetrics: FixedWindowLimiterState, _currentDate: Date): number;
+    updateMetrics(currentMetrics: FixedWindowLimiterState, currentDate: Date): FixedWindowLimiterState;
+}

package/dist/rate-limiter/implementations/policies/fixed-window-limiter/fixed-window-limiter.js

@@ -0,0 +1,73 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { TO_MILLISECONDS, } from "../../../../time-span/contracts/_module.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module.js";
+/**
+ * @internal
+ */
+export function resolveFixedWindowLimiterSettings(settings) {
+    const { window = TimeSpan.fromSeconds(1) } = settings;
+    return {
+        window,
+    };
+}
+/**
+ * @internal
+ */
+export function serializeFixedWindowLimiterSettings(settings) {
+    const { window } = resolveFixedWindowLimiterSettings(settings);
+    return {
+        window: window[TO_MILLISECONDS](),
+    };
+}
+/**
+ * Each request inside a fixed time increases a counter.
+ * Once the counter reaches the maximum allowed number, all further attempts are
+ * rejected.
+ *
+ * **Pro:**
+ *
+ * - Newer attempts are not starved by old ones.
+ * - Low storage cost.
+ *
+ * **Con:**
+ *
+ * A burst of attempts near the boundary of a window can result in a very
+ * high request rate because two windows will be filled with attempts quickly.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export class FixedWindowLimiter {
+    window;
+    constructor(settings = {}) {
+        const { window } = resolveFixedWindowLimiterSettings(settings);
+        this.window = TimeSpan.fromTimeSpan(window);
+    }
+    initialMetrics(currentDate) {
+        return {
+            attempt: 0,
+            lastAttemptAt: currentDate.getTime(),
+        };
+    }
+    shouldBlock(currentMetrics, limit, currentDate) {
+        const timeSinceLastAttempt = currentDate.getTime() - currentMetrics.lastAttemptAt;
+        return (timeSinceLastAttempt < this.window.toMilliseconds() &&
+            currentMetrics.attempt >= limit);
+    }
+    getExpiration(currentMetrics, _currentDate) {
+        return this.window.toEndDate(new Date(currentMetrics.lastAttemptAt));
+    }
+    getAttempts(currentMetrics, _currentDate) {
+        return currentMetrics.attempt;
+    }
+    updateMetrics(currentMetrics, currentDate) {
+        return {
+            attempt: currentMetrics.attempt + 1,
+            lastAttemptAt: currentDate.getTime(),
+        };
+    }
+}
+//# sourceMappingURL=fixed-window-limiter.js.map

package/dist/rate-limiter/implementations/policies/fixed-window-limiter/fixed-window-limiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixed-window-limiter.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/policies/fixed-window-limiter/fixed-window-limiter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAA2B,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EACH,eAAe,GAElB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAoBlE;;GAEG;AACH,MAAM,UAAU,iCAAiC,CAC7C,QAAoC;IAEpC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC;IAEtD,OAAO;QACH,MAAM;KACT,CAAC;AACN,CAAC;AASD;;GAEG;AACH,MAAM,UAAU,mCAAmC,CAC/C,QAAoC;IAEpC,MAAM,EAAE,MAAM,EAAE,GAAG,iCAAiC,CAAC,QAAQ,CAAC,CAAC;IAC/D,OAAO;QACH,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE;KACpC,CAAC;AACN,CAAC;AAeD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,kBAAkB;IAGV,MAAM,CAAW;IAElC,YAAY,WAAuC,EAAE;QACjD,MAAM,EAAE,MAAM,EAAE,GAAG,iCAAiC,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,cAAc,CAAC,WAAiB;QAC5B,OAAO;YACH,OAAO,EAAE,CAAC;YACV,aAAa,EAAE,WAAW,CAAC,OAAO,EAAE;SACvC,CAAC;IACN,CAAC;IAED,WAAW,CACP,cAAuC,EACvC,KAAa,EACb,WAAiB;QAEjB,MAAM,oBAAoB,GACtB,WAAW,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,aAAa,CAAC;QACzD,OAAO,CACH,oBAAoB,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YACnD,cAAc,CAAC,OAAO,IAAI,KAAK,CAClC,CAAC;IACN,CAAC;IAED,aAAa,CACT,cAAuC,EACvC,YAAkB;QAElB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,WAAW,CACP,cAAuC,EACvC,YAAkB;QAElB,OAAO,cAAc,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,aAAa,CACT,cAAuC,EACvC,WAAiB;QAEjB,OAAO;YACH,OAAO,EAAE,cAAc,CAAC,OAAO,GAAG,CAAC;YACnC,aAAa,EAAE,WAAW,CAAC,OAAO,EAAE;SACvC,CAAC;IACN,CAAC;CACJ"}

package/dist/rate-limiter/implementations/policies/sliding-window-limiter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../rate-limiter/implementations/policies/sliding-window-limiter/sliding-window-limiter.js";

package/dist/rate-limiter/implementations/policies/sliding-window-limiter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/policies/sliding-window-limiter/sliding-window-limiter.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/implementations/policies/sliding-window-limiter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/policies/sliding-window-limiter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,0FAA0F,CAAC"}

package/dist/rate-limiter/implementations/policies/sliding-window-limiter/sliding-window-limiter.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @module RateLimiter
+ */
+import { type IRateLimiterPolicy } from "../../../../rate-limiter/contracts/_module.js";
+import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export type SlidingWindowLimiterSettings = {
+    /**
+     * The time span in which attempts are active before reseting.
+     *
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
+     * TimeSpan.fromSeconds(1)
+     * ```
+     */
+    window?: ITimeSpan;
+    /**
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
+     * TimeSpan.fromTimeSpan(window).divide(4)
+     * ```
+     */
+    margin?: ITimeSpan;
+};
+/**
+ * @internal
+ */
+export declare function resolveSlidingWindowLimiterSettings(settings: SlidingWindowLimiterSettings): Required<SlidingWindowLimiterSettings>;
+/**
+ * @internal
+ */
+export type SerializedSlidingWindowLimiterSettings = {
+    window?: number;
+    margin?: number;
+};
+/**
+ * @internal
+ */
+export declare function serializeSlidingWindowLimiterSettings(settings: SlidingWindowLimiterSettings): Required<SerializedSlidingWindowLimiterSettings>;
+/**
+ * Defines the structure for tracking attempts in the rate limiter.
+ * The key is the timestamp of the window's start (e.g., 1700000000000).
+ * The value is the attempts for that window.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export type SlidingWindowLimiterState = Partial<Record<number, number>>;
+/**
+ * Combined approach of `slidingLogs` and `fixedWindow` with lower storage
+ * costs than `slidingLogs` and improved boundary behavior by calculating a
+ * weighted score between two windows.
+ *
+ * **Pro:**
+ *
+ * Good performance allows this to scale to very high loads.
+ *
+ * **Con:**
+ *
+ * Nothing major.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export declare class SlidingWindowLimiter implements IRateLimiterPolicy<SlidingWindowLimiterState> {
+    private readonly window;
+    private readonly margin;
+    constructor(settings?: SlidingWindowLimiterSettings);
+    private currentWindow;
+    private previousWindow;
+    private cleanup;
+    private currentAttempt;
+    private previousAttempt;
+    initialMetrics(currentDate: Date): SlidingWindowLimiterState;
+    shouldBlock(currentMetrics: SlidingWindowLimiterState, limit: number, currentDate: Date): boolean;
+    getExpiration(_currentMetrics: SlidingWindowLimiterState, currentDate: Date): Date;
+    getAttempts(currentMetrics: SlidingWindowLimiterState, currentDate: Date): number;
+    updateMetrics(currentMetrics: SlidingWindowLimiterState, currentDate: Date): SlidingWindowLimiterState;
+}

package/dist/rate-limiter/implementations/policies/sliding-window-limiter/sliding-window-limiter.js

@@ -0,0 +1,106 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { TO_MILLISECONDS, } from "../../../../time-span/contracts/_module.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module.js";
+/**
+ * @internal
+ */
+export function resolveSlidingWindowLimiterSettings(settings) {
+    const { window = TimeSpan.fromSeconds(1), margin = TimeSpan.fromTimeSpan(window).divide(4), } = settings;
+    return {
+        window,
+        margin,
+    };
+}
+/**
+ * @internal
+ */
+export function serializeSlidingWindowLimiterSettings(settings) {
+    const { window, margin } = resolveSlidingWindowLimiterSettings(settings);
+    return {
+        window: window[TO_MILLISECONDS](),
+        margin: margin[TO_MILLISECONDS](),
+    };
+}
+/**
+ * Combined approach of `slidingLogs` and `fixedWindow` with lower storage
+ * costs than `slidingLogs` and improved boundary behavior by calculating a
+ * weighted score between two windows.
+ *
+ * **Pro:**
+ *
+ * Good performance allows this to scale to very high loads.
+ *
+ * **Con:**
+ *
+ * Nothing major.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export class SlidingWindowLimiter {
+    window;
+    margin;
+    constructor(settings = {}) {
+        const { window, margin } = resolveSlidingWindowLimiterSettings(settings);
+        this.window = TimeSpan.fromTimeSpan(window);
+        this.margin = TimeSpan.fromTimeSpan(margin);
+    }
+    currentWindow(currentDate) {
+        return (Math.floor(currentDate.getTime() / this.window.toMilliseconds()) *
+            this.window.toMilliseconds());
+    }
+    previousWindow(currentDate) {
+        return this.currentWindow(currentDate) - this.window.toMilliseconds();
+    }
+    cleanup(metrics, currentDate) {
+        const previousWindow = this.previousWindow(currentDate);
+        return Object.fromEntries(Object.entries(metrics).filter(([timeStampAsStr]) => {
+            const timeStamp = Number(timeStampAsStr);
+            return timeStamp >= previousWindow;
+        }));
+    }
+    currentAttempt(currentMetrics, currentDate) {
+        return currentMetrics[this.currentWindow(currentDate)] ?? 0;
+    }
+    previousAttempt(currentMetrics, currentDate) {
+        let previousAttempt = currentMetrics[this.previousWindow(currentDate)] ?? 0;
+        const percentageInCurrentWindow = (currentDate.getTime() % this.window.toMilliseconds()) /
+            this.window.toMilliseconds();
+        previousAttempt = Math.floor((1 - percentageInCurrentWindow) * previousAttempt);
+        return previousAttempt;
+    }
+    initialMetrics(currentDate) {
+        return {
+            [this.currentWindow(currentDate)]: 0,
+        };
+    }
+    shouldBlock(currentMetrics, limit, currentDate) {
+        const currentAttempts = this.currentAttempt(currentMetrics, currentDate);
+        const previousAttempts = this.previousAttempt(currentMetrics, currentDate);
+        return currentAttempts + previousAttempts >= limit;
+    }
+    getExpiration(_currentMetrics, currentDate) {
+        return this.window
+            .multiply(2)
+            .addTimeSpan(this.margin)
+            .toEndDate(new Date(this.currentWindow(currentDate)));
+    }
+    getAttempts(currentMetrics, currentDate) {
+        const currentAttempt = this.currentAttempt(currentMetrics, currentDate);
+        const previousAttempt = this.previousAttempt(currentMetrics, currentDate);
+        return currentAttempt + previousAttempt;
+    }
+    updateMetrics(currentMetrics, currentDate) {
+        currentMetrics = this.cleanup(currentMetrics, currentDate);
+        const currentAttempt = this.currentAttempt(currentMetrics, currentDate);
+        const currentKey = this.currentWindow(currentDate);
+        return {
+            ...currentMetrics,
+            [currentKey]: currentAttempt + 1,
+        };
+    }
+}
+//# sourceMappingURL=sliding-window-limiter.js.map

package/dist/rate-limiter/implementations/policies/sliding-window-limiter/sliding-window-limiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliding-window-limiter.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/policies/sliding-window-limiter/sliding-window-limiter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAA2B,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EACH,eAAe,GAElB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AA8BlE;;GAEG;AACH,MAAM,UAAU,mCAAmC,CAC/C,QAAsC;IAEtC,MAAM,EACF,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAChC,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GACnD,GAAG,QAAQ,CAAC;IAEb,OAAO;QACH,MAAM;QACN,MAAM;KACT,CAAC;AACN,CAAC;AAUD;;GAEG;AACH,MAAM,UAAU,qCAAqC,CACjD,QAAsC;IAEtC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,mCAAmC,CAAC,QAAQ,CAAC,CAAC;IACzE,OAAO;QACH,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE;QACjC,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE;KACpC,CAAC;AACN,CAAC;AAYD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,oBAAoB;IAGZ,MAAM,CAAW;IACjB,MAAM,CAAW;IAElC,YAAY,WAAyC,EAAE;QACnD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GACpB,mCAAmC,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAEO,aAAa,CAAC,WAAiB;QACnC,OAAO,CACH,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;YAChE,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAC/B,CAAC;IACN,CAAC;IAEO,cAAc,CAAC,WAAiB;QACpC,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IAC1E,CAAC;IAEO,OAAO,CACX,OAAkC,EAClC,WAAiB;QAEjB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,WAAW,CACrB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE;YAChD,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;YAEzC,OAAO,SAAS,IAAI,cAAc,CAAC;QACvC,CAAC,CAAC,CACL,CAAC;IACN,CAAC;IAEO,cAAc,CAClB,cAAyC,EACzC,WAAiB;QAEjB,OAAO,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC;IAEO,eAAe,CACnB,cAAyC,EACzC,WAAiB;QAEjB,IAAI,eAAe,GACf,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;QAE1D,MAAM,yBAAyB,GAC3B,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QACjC,eAAe,GAAG,IAAI,CAAC,KAAK,CACxB,CAAC,CAAC,GAAG,yBAAyB,CAAC,GAAG,eAAe,CACpD,CAAC;QAEF,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED,cAAc,CAAC,WAAiB;QAC5B,OAAO;YACH,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;SACvC,CAAC;IACN,CAAC;IAED,WAAW,CACP,cAAyC,EACzC,KAAa,EACb,WAAiB;QAEjB,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,CACvC,cAAc,EACd,WAAW,CACd,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CACzC,cAAc,EACd,WAAW,CACd,CAAC;QACF,OAAO,eAAe,GAAG,gBAAgB,IAAI,KAAK,CAAC;IACvD,CAAC;IAED,aAAa,CACT,eAA0C,EAC1C,WAAiB;QAEjB,OAAO,IAAI,CAAC,MAAM;aACb,QAAQ,CAAC,CAAC,CAAC;aACX,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;aACxB,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,WAAW,CACP,cAAyC,EACzC,WAAiB;QAEjB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACxE,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CACxC,cAAc,EACd,WAAW,CACd,CAAC;QACF,OAAO,cAAc,GAAG,eAAe,CAAC;IAC5C,CAAC;IAED,aAAa,CACT,cAAyC,EACzC,WAAiB;QAEjB,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO;YACH,GAAG,cAAc;YACjB,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,CAAC;SACnC,CAAC;IACN,CAAC;CACJ"}

package/dist/rate-limiter/implementations/policies/types.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @module RateLimiter
+ */
+import { type FixedWindowLimiterSettings, type SerializedFixedWindowLimiterSettings } from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+import { type SlidingWindowLimiterSettings, type SerializedSlidingWindowLimiterSettings } from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export declare const LIMITER_POLICIES: {
+    readonly FIXED_WINDOW: "FIXED_WINDOW";
+    readonly SLIDING_WINDOW: "SLIDING_WINDOW";
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export type FixedWindowLimiterSettingsEnum = FixedWindowLimiterSettings & {
+    type: (typeof LIMITER_POLICIES)["FIXED_WINDOW"];
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export type SlidingWindowLimiterSettingsEnum = SlidingWindowLimiterSettings & {
+    type: (typeof LIMITER_POLICIES)["SLIDING_WINDOW"];
+};
+/**
+ * @internal
+ */
+export type RateLimiterPolicySettingsEnum = FixedWindowLimiterSettingsEnum | SlidingWindowLimiterSettingsEnum;
+/**
+ * @internal
+ */
+export type SerializedFixedWindowLimiterSettingsEnum = SerializedFixedWindowLimiterSettings & {
+    type: (typeof LIMITER_POLICIES)["FIXED_WINDOW"];
+};
+/**
+ * @internal
+ */
+export type SerializedSlidingWindowLimiterSettingsEnum = SerializedSlidingWindowLimiterSettings & {
+    type: (typeof LIMITER_POLICIES)["SLIDING_WINDOW"];
+};
+/**
+ * @internal
+ */
+export type SerializedRateLimiterPolicySettingsEnum = SerializedFixedWindowLimiterSettingsEnum | SerializedSlidingWindowLimiterSettingsEnum;