@daiso-tech/core 0.41.1 → 0.43.2

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

@@ -0,0 +1,8 @@
+export * from "../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module.js";
+export * from "../../../rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module.js";
+export * from "../../../rate-limiter/implementations/adapters/memory-rate-limiter-storage-adapter/_module.js";
+export * from "../../../rate-limiter/implementations/adapters/mongodb-rate-limiter-storage-adapter/_module.js";
+export * from "../../../rate-limiter/implementations/adapters/no-op-rate-limiter-storage-adapter/_module.js";
+export * from "../../../rate-limiter/implementations/adapters/no-op-rate-limiter-adapter/_module.js";
+export * from "../../../rate-limiter/implementations/adapters/redis-rate-limiter-adapter/_module.js";
+//# sourceMappingURL=_module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/adapters/_module.ts"],"names":[],"mappings":"AAAA,cAAc,kFAAkF,CAAC;AACjG,cAAc,wFAAwF,CAAC;AACvG,cAAc,wFAAwF,CAAC;AACvG,cAAc,yFAAyF,CAAC;AACxG,cAAc,uFAAuF,CAAC;AACtG,cAAc,+EAA+E,CAAC;AAC9F,cAAc,+EAA+E,CAAC"}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module-exports.d.ts

@@ -0,0 +1 @@
+export * from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.js";

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module-exports.js

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,wGAAwG,CAAC"}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.js";

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,wGAAwG,CAAC"}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @module RateLimiter
+ */
+import { type BackoffPolicy } from "../../../../backoff-policies/_module.js";
+import { type IRateLimiterAdapter, type IRateLimiterAdapterState, type IRateLimiterPolicy, type IRateLimiterStorageAdapter } from "../../../../rate-limiter/contracts/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/database-rate-limiter-adapter"`
+ * @group Adapters
+ */
+export type DatabaseRateLimiterAdapterSettings = {
+    adapter: IRateLimiterStorageAdapter;
+    /**
+     * You can define your own {@link BackoffPolicy | `BackoffPolicy`}.
+     * @default
+     * ```ts
+     * import { exponentialBackoff } from "@daiso-tech/core/backoff-policies";
+     *
+     * exponentialBackoff();
+     * ```
+     */
+    backoffPolicy?: BackoffPolicy;
+    /**
+     * You can define your own {@link IRateLimiterPolicy | `IRateLimiterPolicy`}.
+     * @default
+     * ```ts
+     * import { FixedWindowLimiter } from "@daiso-tech/core/rate-limiter/policies";
+     *
+     * new FixedWindowLimiter();
+     * ```
+     */
+    rateLimiterPolicy?: IRateLimiterPolicy;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/database-rate-limiter-adapter"`
+ * @group Adapters
+ */
+export declare class DatabaseRateLimiterAdapter<TMetrics = unknown> implements IRateLimiterAdapter {
+    private readonly rateLimiterStorage;
+    private readonly rateLimiterStateManager;
+    /**
+     * @example
+     * ```ts
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+     * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+     *
+     * const rateLimiterStorageAdapter = new MemoryRateLimiterStorageAdapter();
+     * const rateLimiterAdapter = new DatabaseRateLimiterAdapter({
+     *   adapter: rateLimiterStorageAdapter
+     * });
+     * ```
+     */
+    constructor(settings: DatabaseRateLimiterAdapterSettings);
+    getState(key: string): Promise<IRateLimiterAdapterState | null>;
+    updateState(key: string, limit: number): Promise<IRateLimiterAdapterState>;
+    reset(key: string): Promise<void>;
+}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.js

@@ -0,0 +1,75 @@
+/**
+ * @module RateLimiter
+ */
+import { exponentialBackoff, } from "../../../../backoff-policies/_module.js";
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { RateLimiterPolicy, } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js";
+import { RateLimiterStateManager } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-state-manager.js";
+import { RateLimiterStorage } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-storage.js";
+import { FixedWindowLimiter } from "../../../../rate-limiter/implementations/policies/_module.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/database-rate-limiter-adapter"`
+ * @group Adapters
+ */
+export class DatabaseRateLimiterAdapter {
+    rateLimiterStorage;
+    rateLimiterStateManager;
+    /**
+     * @example
+     * ```ts
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+     * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+     *
+     * const rateLimiterStorageAdapter = new MemoryRateLimiterStorageAdapter();
+     * const rateLimiterAdapter = new DatabaseRateLimiterAdapter({
+     *   adapter: rateLimiterStorageAdapter
+     * });
+     * ```
+     */
+    constructor(settings) {
+        const { adapter, backoffPolicy = exponentialBackoff(), rateLimiterPolicy = new FixedWindowLimiter(), } = settings;
+        const internalRateLimiterPolicy = new RateLimiterPolicy(rateLimiterPolicy);
+        this.rateLimiterStorage = new RateLimiterStorage({
+            adapter: adapter,
+            rateLimiterPolicy: internalRateLimiterPolicy,
+            backoffPolicy,
+        });
+        this.rateLimiterStateManager = new RateLimiterStateManager(internalRateLimiterPolicy, backoffPolicy);
+    }
+    async getState(key) {
+        const state = await this.rateLimiterStorage.find(key);
+        if (state === null) {
+            return null;
+        }
+        return {
+            ...state,
+            resetTime: state.resetTime === null
+                ? null
+                : TimeSpan.fromDateRange({
+                    end: state.resetTime,
+                }),
+        };
+    }
+    async updateState(key, limit) {
+        const currentDate = new Date();
+        const state = await this.rateLimiterStorage.atomicUpdate({
+            key,
+            update: (state) => {
+                return this.rateLimiterStateManager.updateState(limit, currentDate)(this.rateLimiterStateManager.track(currentDate)(state));
+            },
+        });
+        return {
+            ...state,
+            resetTime: state.resetTime === null
+                ? null
+                : TimeSpan.fromDateRange({
+                    end: state.resetTime,
+                }),
+        };
+    }
+    async reset(key) {
+        await this.rateLimiterStorage.remove(key);
+    }
+}
+//# sourceMappingURL=database-rate-limiter-adapter.js.map

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database-rate-limiter-adapter.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/database-rate-limiter-adapter/database-rate-limiter-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,kBAAkB,GAErB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAKN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACH,iBAAiB,GAEpB,MAAM,8FAA8F,CAAC;AACtG,OAAO,EAAE,uBAAuB,EAAE,MAAM,qGAAqG,CAAC;AAC9I,OAAO,EAAE,kBAAkB,EAAE,MAAM,+FAA+F,CAAC;AACnI,OAAO,EAAE,kBAAkB,EAAE,MAAM,oDAAoD,CAAC;AACxF,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAgClE;;;GAGG;AACH,MAAM,OAAO,0BAA0B;IAGlB,kBAAkB,CAA+B;IACjD,uBAAuB,CAAoC;IAE5E;;;;;;;;;;;OAWG;IACH,YAAY,QAA4C;QACpD,MAAM,EACF,OAAO,EACP,aAAa,GAAG,kBAAkB,EAAE,EACpC,iBAAiB,GAAG,IAAI,kBAAkB,EAAE,GAC/C,GAAG,QAAQ,CAAC;QACb,MAAM,yBAAyB,GAAG,IAAI,iBAAiB,CACnD,iBAAiD,CACpD,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,CAAC;YAC7C,OAAO,EAAE,OAER;YACD,iBAAiB,EAAE,yBAAyB;YAC5C,aAAa;SAChB,CAAC,CAAC;QACH,IAAI,CAAC,uBAAuB,GAAG,IAAI,uBAAuB,CACtD,yBAAyB,EACzB,aAAa,CAChB,CAAC;IACN,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW;QACtB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO;YACH,GAAG,KAAK;YACR,SAAS,EACL,KAAK,CAAC,SAAS,KAAK,IAAI;gBACpB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;oBACnB,GAAG,EAAE,KAAK,CAAC,SAAS;iBACvB,CAAC;SACf,CAAC;IACN,CAAC;IAED,KAAK,CAAC,WAAW,CACb,GAAW,EACX,KAAa;QAEb,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC;YACrD,GAAG;YACH,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACd,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAC3C,KAAK,EACL,WAAW,CACd,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9D,CAAC;SACJ,CAAC,CAAC;QACH,OAAO;YACH,GAAG,KAAK;YACR,SAAS,EACL,KAAK,CAAC,SAAS,KAAK,IAAI;gBACpB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;oBACnB,GAAG,EAAE,KAAK,CAAC,SAAS;iBACvB,CAAC;SACf,CAAC;IACN,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACnB,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;CACJ"}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @module RateLimiter
+ */
+import { type BackoffPolicy } from "../../../../backoff-policies/_module.js";
+import { RATE_LIMITER_STATE, type IRateLimiterPolicy } from "../../../../rate-limiter/contracts/_module.js";
+/**
+ * @internal
+ */
+export type AllowedState<TMetrics = unknown> = {
+    type: (typeof RATE_LIMITER_STATE)["ALLOWED"];
+    metrics: TMetrics;
+    attempt: number;
+};
+/**
+ * @internal
+ */
+export type BlockedState = {
+    type: (typeof RATE_LIMITER_STATE)["BLOCKED"];
+    /**
+     * Unix timestamp in miliseconds
+     */
+    startedAt: number;
+    attempt: number;
+};
+/**
+ * @internal
+ */
+export type AllRateLimiterState<TMetrics = unknown> = AllowedState<TMetrics> | BlockedState;
+/**
+ * @internal
+ */
+export type BackoffPolicySettings = {
+    currentDate: Date;
+    backoffPolicy: BackoffPolicy;
+};
+/**
+ * @internal
+ */
+export declare class RateLimiterPolicy<TMetrics = unknown> {
+    private readonly rateLimiterPolicy;
+    constructor(rateLimiterPolicy: IRateLimiterPolicy<TMetrics>);
+    initialState(currentDate: Date): AllowedState<TMetrics>;
+    whenAllowed(currentState: AllowedState<TMetrics>, limit: number, currentDate: Date): AllRateLimiterState<TMetrics>;
+    whenBlocked(currentState: BlockedState, settings: BackoffPolicySettings): AllRateLimiterState<TMetrics>;
+    trackWhenAllowed(currentState: AllowedState<TMetrics>, currentDate: Date): AllRateLimiterState<TMetrics>;
+    trackWhenBlocked(currentState: BlockedState): BlockedState;
+    getExpiration(currentState: AllRateLimiterState<TMetrics>, settings: BackoffPolicySettings): Date;
+}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js

@@ -0,0 +1,69 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../backoff-policies/_module.js";
+import { RATE_LIMITER_STATE, } from "../../../../rate-limiter/contracts/_module.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module.js";
+import { callInvokable } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export class RateLimiterPolicy {
+    rateLimiterPolicy;
+    constructor(rateLimiterPolicy) {
+        this.rateLimiterPolicy = rateLimiterPolicy;
+    }
+    initialState(currentDate) {
+        const currentMetrics = this.rateLimiterPolicy.initialMetrics(currentDate);
+        return {
+            attempt: this.rateLimiterPolicy.getAttempts(currentMetrics, currentDate),
+            type: RATE_LIMITER_STATE.ALLOWED,
+            metrics: currentMetrics,
+        };
+    }
+    whenAllowed(currentState, limit, currentDate) {
+        if (this.rateLimiterPolicy.shouldBlock(currentState.metrics, limit, currentDate)) {
+            return {
+                type: RATE_LIMITER_STATE.BLOCKED,
+                attempt: 1,
+                startedAt: currentDate.getTime(),
+            };
+        }
+        return currentState;
+    }
+    whenBlocked(currentState, settings) {
+        const waitTime = TimeSpan.fromTimeSpan(callInvokable(settings.backoffPolicy, currentState.attempt, null));
+        const endDate = waitTime.toEndDate(new Date(currentState.startedAt));
+        const isWaitTimeOver = endDate.getTime() <= settings.currentDate.getTime();
+        if (isWaitTimeOver) {
+            const currentMetrics = this.rateLimiterPolicy.initialMetrics(settings.currentDate);
+            return {
+                attempt: this.rateLimiterPolicy.getAttempts(currentMetrics, settings.currentDate),
+                type: RATE_LIMITER_STATE.ALLOWED,
+                metrics: currentMetrics,
+            };
+        }
+        return currentState;
+    }
+    trackWhenAllowed(currentState, currentDate) {
+        return {
+            type: currentState.type,
+            attempt: currentState.attempt,
+            metrics: this.rateLimiterPolicy.updateMetrics(currentState.metrics, currentDate),
+        };
+    }
+    trackWhenBlocked(currentState) {
+        return {
+            type: currentState.type,
+            startedAt: currentState.startedAt,
+            attempt: currentState.attempt + 1,
+        };
+    }
+    getExpiration(currentState, settings) {
+        if (currentState.type === RATE_LIMITER_STATE.ALLOWED) {
+            return this.rateLimiterPolicy.getExpiration(currentState.metrics, settings.currentDate);
+        }
+        return TimeSpan.fromTimeSpan(callInvokable(settings.backoffPolicy, currentState.attempt, null)).toEndDate(settings.currentDate);
+    }
+}
+//# sourceMappingURL=rate-limiter-policy.js.map

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-policy.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,EACH,kBAAkB,GAErB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAsCvD;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAEL;IADrB,YACqB,iBAA+C;QAA/C,sBAAiB,GAAjB,iBAAiB,CAA8B;IACjE,CAAC;IAEJ,YAAY,CAAC,WAAiB;QAC1B,MAAM,cAAc,GAChB,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACvD,OAAO;YACH,OAAO,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CACvC,cAAc,EACd,WAAW,CACd;YACD,IAAI,EAAE,kBAAkB,CAAC,OAAO;YAChC,OAAO,EAAE,cAAc;SAC1B,CAAC;IACN,CAAC;IAED,WAAW,CACP,YAAoC,EACpC,KAAa,EACb,WAAiB;QAEjB,IACI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAC9B,YAAY,CAAC,OAAO,EACpB,KAAK,EACL,WAAW,CACd,EACH,CAAC;YACC,OAAO;gBACH,IAAI,EAAE,kBAAkB,CAAC,OAAO;gBAChC,OAAO,EAAE,CAAC;gBACV,SAAS,EAAE,WAAW,CAAC,OAAO,EAAE;aACnC,CAAC;QACN,CAAC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,WAAW,CACP,YAA0B,EAC1B,QAA+B;QAE/B,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAClC,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CACpE,CAAC;QACF,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,MAAM,cAAc,GAChB,OAAO,CAAC,OAAO,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAExD,IAAI,cAAc,EAAE,CAAC;YACjB,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CACxD,QAAQ,CAAC,WAAW,CACvB,CAAC;YACF,OAAO;gBACH,OAAO,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CACvC,cAAc,EACd,QAAQ,CAAC,WAAW,CACvB;gBACD,IAAI,EAAE,kBAAkB,CAAC,OAAO;gBAChC,OAAO,EAAE,cAAc;aAC1B,CAAC;QACN,CAAC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,gBAAgB,CACZ,YAAoC,EACpC,WAAiB;QAEjB,OAAO;YACH,IAAI,EAAE,YAAY,CAAC,IAAI;YACvB,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,OAAO,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,CACzC,YAAY,CAAC,OAAO,EACpB,WAAW,CACd;SACJ,CAAC;IACN,CAAC;IAED,gBAAgB,CAAC,YAA0B;QACvC,OAAO;YACH,IAAI,EAAE,YAAY,CAAC,IAAI;YACvB,SAAS,EAAE,YAAY,CAAC,SAAS;YACjC,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,CAAC;SACpC,CAAC;IACN,CAAC;IAED,aAAa,CACT,YAA2C,EAC3C,QAA+B;QAE/B,IAAI,YAAY,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,iBAAiB,CAAC,aAAa,CACvC,YAAY,CAAC,OAAO,EACpB,QAAQ,CAAC,WAAW,CACvB,CAAC;QACN,CAAC;QAED,OAAO,QAAQ,CAAC,YAAY,CACxB,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CACpE,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;CACJ"}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-state-manager.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @module RateLimiter
+ */
+import { type BackoffPolicy } from "../../../../backoff-policies/_module.js";
+import { type AllRateLimiterState, type RateLimiterPolicy } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js";
+/**
+ * @internal
+ */
+export declare class RateLimiterStateManager<TMetrics = unknown> {
+    private readonly rateLimiterPolicy;
+    private readonly backoffPolicy;
+    constructor(rateLimiterPolicy: RateLimiterPolicy<TMetrics>, backoffPolicy: BackoffPolicy);
+    updateState: (limit: number, currentDate: Date) => (currentState: AllRateLimiterState<TMetrics>) => AllRateLimiterState<TMetrics>;
+    track: (currentDate: Date) => (currentState: AllRateLimiterState<TMetrics>) => AllRateLimiterState<TMetrics>;
+}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-state-manager.js

@@ -0,0 +1,33 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../backoff-policies/_module.js";
+import { RATE_LIMITER_STATE } from "../../../../rate-limiter/contracts/_module.js";
+import {} from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js";
+/**
+ * @internal
+ */
+export class RateLimiterStateManager {
+    rateLimiterPolicy;
+    backoffPolicy;
+    constructor(rateLimiterPolicy, backoffPolicy) {
+        this.rateLimiterPolicy = rateLimiterPolicy;
+        this.backoffPolicy = backoffPolicy;
+    }
+    updateState = (limit, currentDate) => (currentState) => {
+        if (currentState.type === RATE_LIMITER_STATE.ALLOWED) {
+            return this.rateLimiterPolicy.whenAllowed(currentState, limit, currentDate);
+        }
+        return this.rateLimiterPolicy.whenBlocked(currentState, {
+            currentDate,
+            backoffPolicy: this.backoffPolicy,
+        });
+    };
+    track = (currentDate) => (currentState) => {
+        if (currentState.type === RATE_LIMITER_STATE.ALLOWED) {
+            return this.rateLimiterPolicy.trackWhenAllowed(currentState, currentDate);
+        }
+        return this.rateLimiterPolicy.trackWhenBlocked(currentState);
+    };
+}
+//# sourceMappingURL=rate-limiter-state-manager.js.map

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-state-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-state-manager.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-state-manager.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAGN,MAAM,8FAA8F,CAAC;AAEtG;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAEX;IACA;IAFrB,YACqB,iBAA8C,EAC9C,aAA4B;QAD5B,sBAAiB,GAAjB,iBAAiB,CAA6B;QAC9C,kBAAa,GAAb,aAAa,CAAe;IAC9C,CAAC;IAEJ,WAAW,GACP,CAAC,KAAa,EAAE,WAAiB,EAAE,EAAE,CACrC,CACI,YAA2C,EACd,EAAE;QAC/B,IAAI,YAAY,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CACrC,YAAY,EACZ,KAAK,EACL,WAAW,CACd,CAAC;QACN,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,YAAY,EAAE;YACpD,WAAW;YACX,aAAa,EAAE,IAAI,CAAC,aAAa;SACpC,CAAC,CAAC;IACP,CAAC,CAAC;IAEN,KAAK,GACD,CAAC,WAAiB,EAAE,EAAE,CACtB,CACI,YAA2C,EACd,EAAE;QAC/B,IAAI,YAAY,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAC1C,YAAY,EACZ,WAAW,CACd,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACjE,CAAC,CAAC;CACT"}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-storage.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @module RateLimiter
+ */
+import { type BackoffPolicy } from "../../../../backoff-policies/_module.js";
+import { type IRateLimiterStorageAdapter } from "../../../../rate-limiter/contracts/_module.js";
+import { type AllRateLimiterState, type RateLimiterPolicy } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js";
+import { type InvokableFn } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export type RateLimiterStorageSettings<TMetrics> = {
+    adapter: IRateLimiterStorageAdapter<AllRateLimiterState<TMetrics>>;
+    rateLimiterPolicy: RateLimiterPolicy<TMetrics>;
+    backoffPolicy: BackoffPolicy;
+};
+/**
+ * @internal
+ */
+export type IRateLimiterStorageState = {
+    success: boolean;
+    attempt: number;
+    resetTime: Date | null;
+};
+/**
+ * @internal
+ */
+export type AtomicUpdateArgs<TMetrics> = {
+    key: string;
+    update: InvokableFn<[
+        currentState: AllRateLimiterState<TMetrics>
+    ], AllRateLimiterState<TMetrics>>;
+};
+/**
+ * @internal
+ */
+export declare class RateLimiterStorage<TMetrics = unknown> {
+    private readonly adapter;
+    private readonly rateLimiterPolicy;
+    private readonly backoffPolicy;
+    constructor(settings: RateLimiterStorageSettings<TMetrics>);
+    atomicUpdate(args: AtomicUpdateArgs<TMetrics>): Promise<IRateLimiterStorageState>;
+    private toAdapterState;
+    find(key: string): Promise<IRateLimiterStorageState | null>;
+    remove(key: string): Promise<void>;
+}

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-storage.js

@@ -0,0 +1,59 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../backoff-policies/_module.js";
+import { RATE_LIMITER_STATE, } from "../../../../rate-limiter/contracts/_module.js";
+import {} from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-policy.js";
+import { TimeSpan } from "../../../../time-span/implementations/time-span.js";
+import { callInvokable } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export class RateLimiterStorage {
+    adapter;
+    rateLimiterPolicy;
+    backoffPolicy;
+    constructor(settings) {
+        const { adapter, rateLimiterPolicy, backoffPolicy } = settings;
+        this.adapter = adapter;
+        this.rateLimiterPolicy = rateLimiterPolicy;
+        this.backoffPolicy = backoffPolicy;
+    }
+    async atomicUpdate(args) {
+        const currentDate = new Date();
+        const state = await this.adapter.transaction(async (trx) => {
+            const data = await this.adapter.find(args.key);
+            let currentState = data?.state;
+            if (currentState === undefined) {
+                currentState = this.rateLimiterPolicy.initialState(currentDate);
+            }
+            const newState = args.update(currentState);
+            await trx.upsert(args.key, newState, this.rateLimiterPolicy.getExpiration(newState, {
+                backoffPolicy: this.backoffPolicy,
+                currentDate,
+            }));
+            return newState;
+        });
+        return this.toAdapterState(state);
+    }
+    toAdapterState(state) {
+        return {
+            success: state.type === RATE_LIMITER_STATE.ALLOWED,
+            attempt: state.attempt,
+            resetTime: state.type === RATE_LIMITER_STATE.ALLOWED
+                ? null
+                : TimeSpan.fromTimeSpan(callInvokable(this.backoffPolicy, state.attempt, null)).toEndDate(new Date(state.startedAt)),
+        };
+    }
+    async find(key) {
+        const data = await this.adapter.find(key);
+        if (data === null) {
+            return null;
+        }
+        return this.toAdapterState(data.state);
+    }
+    async remove(key) {
+        await this.adapter.remove(key);
+    }
+}
+//# sourceMappingURL=rate-limiter-storage.js.map

package/dist/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-storage.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/database-rate-limiter-adapter/rate-limiter-storage.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,EACH,kBAAkB,GAErB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAGN,MAAM,8FAA8F,CAAC;AACtG,OAAO,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AACpE,OAAO,EAAE,aAAa,EAAoB,MAAM,wBAAwB,CAAC;AA+BzE;;GAEG;AACH,MAAM,OAAO,kBAAkB;IACV,OAAO,CAEtB;IACe,iBAAiB,CAA8B;IAC/C,aAAa,CAAgB;IAE9C,YAAY,QAA8C;QACtD,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,GAAG,QAAQ,CAAC;QAE/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,YAAY,CACd,IAAgC;QAEhC,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACvD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/C,IAAI,YAAY,GAAG,IAAI,EAAE,KAAK,CAAC;YAC/B,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC7B,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACpE,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAE3C,MAAM,GAAG,CAAC,MAAM,CACZ,IAAI,CAAC,GAAG,EACR,QAAQ,EACR,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,QAAQ,EAAE;gBAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,WAAW;aACd,CAAC,CACL,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAEO,cAAc,CAClB,KAAoC;QAEpC,OAAO;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO;YAClD,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,SAAS,EACL,KAAK,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO;gBACrC,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,QAAQ,CAAC,YAAY,CACjB,aAAa,CACT,IAAI,CAAC,aAAa,EAClB,KAAK,CAAC,OAAO,EACb,IAAI,CACP,CACJ,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;SACnD,CAAC;IACN,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAW;QAClB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACpB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;CACJ"}

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module-exports.d.ts

@@ -0,0 +1 @@
+export * from "../../../../rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/kysely-rate-limiter-storage-adapter.js";

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module-exports.js

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/kysely-rate-limiter-storage-adapter.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,oHAAoH,CAAC"}

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/kysely-rate-limiter-storage-adapter.js";

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/kysely-rate-limiter-storage-adapter.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,oHAAoH,CAAC"}

package/dist/rate-limiter/implementations/adapters/kysely-rate-limiter-storage-adapter/kysely-rate-limiter-storage-adapter.d.ts

@@ -0,0 +1,95 @@
+/**
+ * @module RateLimiter
+ */
+import { type Kysely } from "kysely";
+import { type IRateLimiterData, type IRateLimiterStorageAdapter, type IRateLimiterStorageAdapterTransaction } from "../../../../rate-limiter/contracts/_module.js";
+import { type ISerde } from "../../../../serde/contracts/_module.js";
+import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
+import { type IDeinitizable, type IInitizable, type InvokableFn, type IPrunable } from "../../../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
+ * @group Adapters
+ */
+export type KyselyRateLimiterTable = {
+    key: string;
+    state: string;
+    expiration: number | bigint | string;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
+ * @group Adapters
+ */
+export type KyselyRateLimiterStorageTables = {
+    rateLimiter: KyselyRateLimiterTable;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
+ * @group Adapters
+ */
+export type KyselyRateLimiterStorageAdapterSettings = {
+    kysely: Kysely<KyselyRateLimiterStorageTables>;
+    serde: ISerde<string>;
+    /**
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
+     * TimeSpan.fromMinutes(1)
+     * ```
+     */
+    expiredKeysRemovalInterval?: ITimeSpan;
+    /**
+     * @default true
+     */
+    shouldRemoveExpiredKeys?: boolean;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
+ * @group Adapters
+ */
+export declare class KyselyRateLimiterStorageAdapter<TType> implements IRateLimiterStorageAdapter<TType>, IInitizable, IDeinitizable, IPrunable {
+    private readonly kysely;
+    private readonly serde;
+    private readonly expiredKeysRemovalInterval;
+    private readonly shouldRemoveExpiredKeys;
+    private intervalId;
+    /**
+     * @example
+     * ```ts
+     * import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
+     * import Sqlite from "better-sqlite3";
+     * import { Kysely, SqliteDialect } from "kysely";
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const rateLimiterStorageAdapter = new KyselyRateLimiterStorageAdapter({
+     *   kysely: new Kysely({
+     *     dialect: new SqliteDialect({
+     *       database: new Sqlite("local.db"),
+     *     }),
+     *   }),
+     *   serde
+     * });
+     * // You need initialize the adapter once before using it.
+     * await rateLimiterStorageAdapter.init();
+     * ```
+     */
+    constructor(settings: KyselyRateLimiterStorageAdapterSettings);
+    /**
+     * Removes all related rate limiter tables and their rows.
+     * Note all rate limiter data will be removed.
+     */
+    deInit(): Promise<void>;
+    /**
+     * Creates all related tables and indexes.
+     * Note the `init` method needs to be called once before using the adapter.
+     */
+    init(): Promise<void>;
+    removeAllExpired(): Promise<void>;
+    transaction<TValue>(fn: InvokableFn<[
+        transaction: IRateLimiterStorageAdapterTransaction<TType>
+    ], Promise<TValue>>): Promise<TValue>;
+    find(key: string): Promise<IRateLimiterData<TType> | null>;
+    remove(key: string): Promise<void>;
+}