@daiso-tech/core 0.42.0 → 0.43.2

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

@@ -0,0 +1,160 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../event-bus/contracts/_module.js";
+import {} from "../../../../namespace/_module.js";
+import { BlockedRateLimiterError, RATE_LIMITER_EVENTS, RATE_LIMITER_STATE, } from "../../../../rate-limiter/contracts/_module.js";
+import {} from "../../../../task/contracts/_module.js";
+import { Task } from "../../../../task/implementations/_module.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module.js";
+import { callErrorPolicyOnThrow, resolveAsyncLazyable, UnexpectedError, } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export class RateLimiter {
+    _key;
+    _limit;
+    errorPolicy;
+    onlyError;
+    adapter;
+    eventDispatcher;
+    enableAsyncTracking;
+    constructor(settings) {
+        const { limit, enableAsyncTracking, eventDispatcher, key, errorPolicy, onlyError, adapter, } = settings;
+        this._limit = limit;
+        this.enableAsyncTracking = enableAsyncTracking;
+        this.eventDispatcher = eventDispatcher;
+        this._key = key;
+        this.errorPolicy = errorPolicy;
+        this.onlyError = onlyError;
+        this.adapter = adapter;
+    }
+    toRateLimiterState(state) {
+        if (state === null) {
+            return {
+                type: RATE_LIMITER_STATE.ALLOWED,
+                usedAttempts: 0,
+                reaminingAttemps: this.limit,
+                limit: this.limit,
+            };
+        }
+        if (state.success) {
+            return {
+                type: RATE_LIMITER_STATE.ALLOWED,
+                usedAttempts: state.attempt,
+                reaminingAttemps: this.limit - state.attempt,
+                limit: this.limit,
+            };
+        }
+        if (state.resetTime !== null) {
+            return {
+                type: RATE_LIMITER_STATE.BLOCKED,
+                limit: this.limit,
+                totalAttempts: state.attempt,
+                exceedAttempts: state.attempt - this.limit,
+                resetTime: TimeSpan.fromTimeSpan(state.resetTime),
+            };
+        }
+        throw new UnexpectedError("1_!!__MESSAGE__!!");
+    }
+    getState() {
+        return new Task(async () => {
+            const state = await this.adapter.getState(this._key.toString());
+            return this.toRateLimiterState(state);
+        });
+    }
+    get key() {
+        return this._key.get();
+    }
+    get limit() {
+        return this._limit;
+    }
+    async trackErrorWrapper(asyncFn) {
+        const state = this.toRateLimiterState(await this.adapter.getState(this.key.toString()));
+        if (state.type === RATE_LIMITER_STATE.BLOCKED) {
+            this.eventDispatcher
+                .dispatch(RATE_LIMITER_EVENTS.BLOCKED, {
+                rateLimiter: this,
+            })
+                .detach();
+            const { type: _type, ...rest } = state;
+            throw new BlockedRateLimiterError(rest, "2_!!__MESSAGE__!!");
+        }
+        try {
+            this.eventDispatcher
+                .dispatch(RATE_LIMITER_EVENTS.ALLOWED, {
+                rateLimiter: this,
+            })
+                .detach();
+            return await resolveAsyncLazyable(asyncFn);
+        }
+        catch (error) {
+            const isErrorMatching = await callErrorPolicyOnThrow(this.errorPolicy, error);
+            if (isErrorMatching) {
+                this.eventDispatcher
+                    .dispatch(RATE_LIMITER_EVENTS.TRACKED_FAILURE, {
+                    rateLimiter: this,
+                    error,
+                })
+                    .detach();
+            }
+            else {
+                this.eventDispatcher
+                    .dispatch(RATE_LIMITER_EVENTS.UNTRACKED_FAILURE, {
+                    rateLimiter: this,
+                    error,
+                })
+                    .detach();
+            }
+            if (isErrorMatching) {
+                const task = new Task(async () => {
+                    await this.adapter.updateState(this.key.toString(), this.limit);
+                });
+                if (this.enableAsyncTracking) {
+                    task.detach();
+                }
+                else {
+                    await task;
+                }
+            }
+            throw error;
+        }
+    }
+    async trackWrapper(asyncFn) {
+        const state = this.toRateLimiterState(await this.adapter.updateState(this.key.toString(), this.limit));
+        if (state.type === RATE_LIMITER_STATE.BLOCKED) {
+            this.eventDispatcher
+                .dispatch(RATE_LIMITER_EVENTS.BLOCKED, {
+                rateLimiter: this,
+            })
+                .detach();
+            const { type: _type, ...rest } = state;
+            throw new BlockedRateLimiterError(rest, "3_!!__MESSAGE__!!");
+        }
+        this.eventDispatcher
+            .dispatch(RATE_LIMITER_EVENTS.ALLOWED, {
+            rateLimiter: this,
+        })
+            .detach();
+        return await resolveAsyncLazyable(asyncFn);
+    }
+    runOrFail(asyncFn) {
+        return new Task(async () => {
+            if (this.onlyError) {
+                return await this.trackErrorWrapper(asyncFn);
+            }
+            return await this.trackWrapper(asyncFn);
+        });
+    }
+    reset() {
+        return new Task(async () => {
+            this.eventDispatcher
+                .dispatch(RATE_LIMITER_EVENTS.RESETED, {
+                rateLimiter: this,
+            })
+                .detach();
+            await this.adapter.reset(this._key.toString());
+        });
+    }
+}
+//# sourceMappingURL=rate-limiter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/derivables/rate-limiter-provider/rate-limiter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAyB,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,EACH,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,GAQrB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EACH,sBAAsB,EACtB,oBAAoB,EACpB,eAAe,GAGlB,MAAM,wBAAwB,CAAC;AAehC;;GAEG;AACH,MAAM,OAAO,WAAW;IACH,IAAI,CAAM;IACV,MAAM,CAAS;IACf,WAAW,CAAc;IACzB,SAAS,CAAU;IACnB,OAAO,CAAsB;IAC7B,eAAe,CAAwC;IACvD,mBAAmB,CAAU;IAE9C,YAAY,QAA6B;QACrC,MAAM,EACF,KAAK,EACL,mBAAmB,EACnB,eAAe,EACf,GAAG,EACH,WAAW,EACX,SAAS,EACT,OAAO,GACV,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAEO,kBAAkB,CACtB,KAAsC;QAEtC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO;gBACH,IAAI,EAAE,kBAAkB,CAAC,OAAO;gBAChC,YAAY,EAAE,CAAC;gBACf,gBAAgB,EAAE,IAAI,CAAC,KAAK;gBAC5B,KAAK,EAAE,IAAI,CAAC,KAAK;aACpB,CAAC;QACN,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,OAAO;gBACH,IAAI,EAAE,kBAAkB,CAAC,OAAO;gBAChC,YAAY,EAAE,KAAK,CAAC,OAAO;gBAC3B,gBAAgB,EAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO;gBAC5C,KAAK,EAAE,IAAI,CAAC,KAAK;aACc,CAAC;QACxC,CAAC;QAED,IAAI,KAAK,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAC3B,OAAO;gBACH,IAAI,EAAE,kBAAkB,CAAC,OAAO;gBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,aAAa,EAAE,KAAK,CAAC,OAAO;gBAC5B,cAAc,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK;gBAC1C,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC;aAClB,CAAC;QACxC,CAAC;QAED,MAAM,IAAI,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,IAAI,CAAmB,KAAK,IAAI,EAAE;YACzC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEhE,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC3B,OAA0B;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CACjC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CACnD,CAAC;QAEF,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO,EAAE,CAAC;YAC5C,IAAI,CAAC,eAAe;iBACf,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE;gBACnC,WAAW,EAAE,IAAI;aACpB,CAAC;iBACD,MAAM,EAAE,CAAC;YAEd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YACvC,MAAM,IAAI,uBAAuB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACjE,CAAC;QAED,IAAI,CAAC;YACD,IAAI,CAAC,eAAe;iBACf,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE;gBACnC,WAAW,EAAE,IAAI;aACpB,CAAC;iBACD,MAAM,EAAE,CAAC;YAEd,OAAO,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAChD,IAAI,CAAC,WAAW,EAChB,KAAK,CACR,CAAC;YAEF,IAAI,eAAe,EAAE,CAAC;gBAClB,IAAI,CAAC,eAAe;qBACf,QAAQ,CAAC,mBAAmB,CAAC,eAAe,EAAE;oBAC3C,WAAW,EAAE,IAAI;oBACjB,KAAK;iBACR,CAAC;qBACD,MAAM,EAAE,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,eAAe;qBACf,QAAQ,CAAC,mBAAmB,CAAC,iBAAiB,EAAE;oBAC7C,WAAW,EAAE,IAAI;oBACjB,KAAK;iBACR,CAAC;qBACD,MAAM,EAAE,CAAC;YAClB,CAAC;YAED,IAAI,eAAe,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE;oBAC7B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC1B,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EACnB,IAAI,CAAC,KAAK,CACb,CAAC;gBACN,CAAC,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;gBAClB,CAAC;qBAAM,CAAC;oBACJ,MAAM,IAAI,CAAC;gBACf,CAAC;YACL,CAAC;YAED,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,YAAY,CACtB,OAA0B;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CACjC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAClE,CAAC;QAEF,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO,EAAE,CAAC;YAC5C,IAAI,CAAC,eAAe;iBACf,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE;gBACnC,WAAW,EAAE,IAAI;aACpB,CAAC;iBACD,MAAM,EAAE,CAAC;YAEd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YACvC,MAAM,IAAI,uBAAuB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACjE,CAAC;QAED,IAAI,CAAC,eAAe;aACf,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE;YACnC,WAAW,EAAE,IAAI;SACpB,CAAC;aACD,MAAM,EAAE,CAAC;QAEd,OAAO,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,SAAS,CAAgB,OAA0B;QAC/C,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK;QACD,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,IAAI,CAAC,eAAe;iBACf,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE;gBACnC,WAAW,EAAE,IAAI;aACpB,CAAC;iBACD,MAAM,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/rate-limiter/implementations/derivables/rate-limiter-provider-factory/_module.d.ts

@@ -0,0 +1,2 @@
+export * from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider-factory/database-rate-limiter-provider-factory.js";
+export * from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider-factory/rate-limiter-provider-factory.js";

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

@@ -0,0 +1,3 @@
+export * from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider-factory/database-rate-limiter-provider-factory.js";
+export * from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider-factory/rate-limiter-provider-factory.js";
+//# sourceMappingURL=_module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/derivables/rate-limiter-provider-factory/_module.ts"],"names":[],"mappings":"AAAA,cAAc,mHAAmH,CAAC;AAClI,cAAc,0GAA0G,CAAC"}

package/dist/rate-limiter/implementations/derivables/rate-limiter-provider-factory/database-rate-limiter-provider-factory.d.ts

@@ -0,0 +1,135 @@
+/**
+ * @module RateLimiter
+ */
+import { type BackoffPolicy } from "../../../../backoff-policies/_module.js";
+import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
+import { type Namespace } from "../../../../namespace/_module.js";
+import { type IRateLimiterProviderFactory, type IRateLimiterProvider, type IRateLimiterStorageAdapter, type IRateLimiterPolicy } from "../../../../rate-limiter/contracts/_module.js";
+import { type RateLimiterProviderSettingsBase } from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider/_module.js";
+import { type ErrorPolicy } from "../../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export type DatabaseRateLimiterAdapters<TAdapters extends string> = Partial<Record<TAdapters, IRateLimiterStorageAdapter>>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export type DatabaseRateLimiterProviderFactorySettings<TAdapters extends string> = RateLimiterProviderSettingsBase & {
+    adapters: DatabaseRateLimiterAdapters<TAdapters>;
+    defaultAdapter?: NoInfer<TAdapters>;
+    /**
+     * @default
+     * ```ts
+     * import { exponentialBackoff } from "@daiso-tech/core/backoff-policies";
+     *
+     * exponentialBackoff();
+     * ```
+     */
+    backoffPolicy?: BackoffPolicy;
+    /**
+     * @default
+     * ```ts
+     * import { ConsecutiveBreaker } from "@daiso-tech/core/rate-limiter/policies";
+     *
+     * new ConsecutiveBreaker({ failureThreshold: 5 });
+     * ```
+     */
+    rateLimiterPolicy?: IRateLimiterPolicy;
+};
+/**
+ * The `DatabaseRateLimiterProviderFactory` class is immutable.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export declare class DatabaseRateLimiterProviderFactory<TAdapters extends string> implements IRateLimiterProviderFactory<TAdapters> {
+    private readonly 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 { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-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 rateLimiterProviderFactory = new RateLimiterProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new MemoryRateLimiterStorageAdapter(),
+     *     sqlite: new KyselyRateLimiterStorageAdapter({
+     *       kysely: new Kysely({
+     *         dialect: new SqliteDialect({
+     *           database: new Sqlite("local.db"),
+     *         }),
+     *       }),
+     *       serde,
+     *     }),
+     *   },
+     *   defaultAdapter: "memory",
+     * });
+     * ```
+     */
+    constructor(settings: DatabaseRateLimiterProviderFactorySettings<TAdapters>);
+    setNamespace(namespace: Namespace): DatabaseRateLimiterProviderFactory<TAdapters>;
+    setEventBus(eventBus: IEventBus): DatabaseRateLimiterProviderFactory<TAdapters>;
+    setOnlyError(onlyError?: boolean): DatabaseRateLimiterProviderFactory<TAdapters>;
+    setErrorPolicy(errorPolicy: ErrorPolicy): DatabaseRateLimiterProviderFactory<TAdapters>;
+    setBackoffPolicy(backoffPolicy?: BackoffPolicy): DatabaseRateLimiterProviderFactory<TAdapters>;
+    setRateLimiterPolicy(rateLimiterPolicy?: IRateLimiterPolicy): DatabaseRateLimiterProviderFactory<TAdapters>;
+    /**
+     * @example
+     * ```ts
+     * import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
+     * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
+     * import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-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 rateLimiterProviderFactory = new RateLimiterProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new MemoryRateLimiterStorageAdapter(),
+     *     sqlite: new KyselyRateLimiterStorageAdapter({
+     *       kysely: new Kysely({
+     *         dialect: new SqliteDialect({
+     *           database: new Sqlite("local.db"),
+     *         }),
+     *       }),
+     *       serde,
+     *     }),
+     *   },
+     *   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 KyselyRateLimiterStorageAdapter
+     * await rateLimiterProviderFactory
+     *   .use("sqlite")
+     *   .create("a")
+     *   .runOrFail(async () => {
+     *     // ... code to apply rate limiter logic
+     *   });
+     * ```
+     */
+    use(adapterName?: TAdapters | undefined): IRateLimiterProvider;
+}

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

@@ -0,0 +1,156 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../backoff-policies/_module.js";
+import {} from "../../../../event-bus/contracts/_module.js";
+import {} from "../../../../namespace/_module.js";
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { DatabaseRateLimiterAdapter } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/_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 `DatabaseRateLimiterProviderFactory` class is immutable.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export class DatabaseRateLimiterProviderFactory {
+    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 { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-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 rateLimiterProviderFactory = new RateLimiterProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new MemoryRateLimiterStorageAdapter(),
+     *     sqlite: new KyselyRateLimiterStorageAdapter({
+     *       kysely: new Kysely({
+     *         dialect: new SqliteDialect({
+     *           database: new Sqlite("local.db"),
+     *         }),
+     *       }),
+     *       serde,
+     *     }),
+     *   },
+     *   defaultAdapter: "memory",
+     * });
+     * ```
+     */
+    constructor(settings) {
+        this.settings = settings;
+    }
+    setNamespace(namespace) {
+        return new DatabaseRateLimiterProviderFactory({
+            ...this.settings,
+            namespace,
+        });
+    }
+    setEventBus(eventBus) {
+        return new DatabaseRateLimiterProviderFactory({
+            ...this.settings,
+            eventBus,
+        });
+    }
+    setOnlyError(onlyError) {
+        return new DatabaseRateLimiterProviderFactory({
+            ...this.settings,
+            onlyError,
+        });
+    }
+    setErrorPolicy(errorPolicy) {
+        return new DatabaseRateLimiterProviderFactory({
+            ...this.settings,
+            errorPolicy,
+        });
+    }
+    setBackoffPolicy(backoffPolicy) {
+        return new DatabaseRateLimiterProviderFactory({
+            ...this.settings,
+            backoffPolicy,
+        });
+    }
+    setRateLimiterPolicy(rateLimiterPolicy) {
+        return new DatabaseRateLimiterProviderFactory({
+            ...this.settings,
+            rateLimiterPolicy,
+        });
+    }
+    /**
+     * @example
+     * ```ts
+     * import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
+     * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
+     * import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
+     * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-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 rateLimiterProviderFactory = new RateLimiterProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new MemoryRateLimiterStorageAdapter(),
+     *     sqlite: new KyselyRateLimiterStorageAdapter({
+     *       kysely: new Kysely({
+     *         dialect: new SqliteDialect({
+     *           database: new Sqlite("local.db"),
+     *         }),
+     *       }),
+     *       serde,
+     *     }),
+     *   },
+     *   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 KyselyRateLimiterStorageAdapter
+     * await rateLimiterProviderFactory
+     *   .use("sqlite")
+     *   .create("a")
+     *   .runOrFail(async () => {
+     *     // ... code to apply rate limiter logic
+     *   });
+     * ```
+     */
+    use(adapterName = this.settings.defaultAdapter) {
+        if (adapterName === undefined) {
+            throw new DefaultAdapterNotDefinedError(DatabaseRateLimiterProviderFactory.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: new DatabaseRateLimiterAdapter({
+                adapter,
+            }),
+            namespace: namespace.appendRoot(adapterName),
+        });
+    }
+}
+//# sourceMappingURL=database-rate-limiter-provider-factory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"database-rate-limiter-provider-factory.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/derivables/rate-limiter-provider-factory/database-rate-limiter-provider-factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAkB,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAKN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAAE,MAAM,kFAAkF,CAAC;AAC9H,OAAO,EACH,mBAAmB,EACnB,0CAA0C,GAE7C,MAAM,4EAA4E,CAAC;AACpF,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAEhC,MAAM,wBAAwB,CAAC;AA4ChC;;;;;GAKG;AACH,MAAM,OAAO,kCAAkC;IAkCtB;IA/BrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,YACqB,QAA+D;QAA/D,aAAQ,GAAR,QAAQ,CAAuD;IACjF,CAAC;IAEJ,YAAY,CACR,SAAoB;QAEpB,OAAO,IAAI,kCAAkC,CAAC;YAC1C,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CACP,QAAmB;QAEnB,OAAO,IAAI,kCAAkC,CAAC;YAC1C,GAAG,IAAI,CAAC,QAAQ;YAChB,QAAQ;SACX,CAAC,CAAC;IACP,CAAC;IAED,YAAY,CACR,SAAmB;QAEnB,OAAO,IAAI,kCAAkC,CAAC;YAC1C,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CACV,WAAwB;QAExB,OAAO,IAAI,kCAAkC,CAAC;YAC1C,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CACZ,aAA6B;QAE7B,OAAO,IAAI,kCAAkC,CAAC;YAC1C,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa;SAChB,CAAC,CAAC;IACP,CAAC;IAED,oBAAoB,CAChB,iBAAsC;QAEtC,OAAO,IAAI,kCAAkC,CAAC;YAC1C,GAAG,IAAI,CAAC,QAAQ;YAChB,iBAAiB;SACpB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,QAAQ,CAAC,cAAc;QAEjE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CACnC,kCAAkC,CAAC,IAAI,CAC1C,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,EAAE,IAAI,0BAA0B,CAAC;gBACpC,OAAO;aACV,CAAC;YACF,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC;SAC/C,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/rate-limiter/implementations/derivables/rate-limiter-provider-factory/rate-limiter-provider-factory.d.ts

@@ -0,0 +1,106 @@
+/**
+ * @module RateLimiter
+ */
+import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
+import { type Namespace } from "../../../../namespace/_module.js";
+import { type IRateLimiterProviderFactory, type IRateLimiterProvider, type IRateLimiterAdapter } from "../../../../rate-limiter/contracts/_module.js";
+import { type RateLimiterProviderSettingsBase } from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider/_module.js";
+import { type ErrorPolicy } from "../../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export type RateLimiterAdapters<TAdapters extends string> = Partial<Record<TAdapters, IRateLimiterAdapter>>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export type RateLimiterProviderFactorySettings<TAdapters extends string> = RateLimiterProviderSettingsBase & {
+    adapters: RateLimiterAdapters<TAdapters>;
+    defaultAdapter?: NoInfer<TAdapters>;
+};
+/**
+ * The `RateLimiterProviderFactory` class is immutable.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export declare class RateLimiterProviderFactory<TAdapters extends string> implements IRateLimiterProviderFactory<TAdapters> {
+    private readonly 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: RateLimiterProviderFactorySettings<TAdapters>);
+    setNamespace(namespace: Namespace): RateLimiterProviderFactory<TAdapters>;
+    setEventBus(eventBus: IEventBus): RateLimiterProviderFactory<TAdapters>;
+    setOnlyError(onlyError?: boolean): RateLimiterProviderFactory<TAdapters>;
+    setErrorPolicy(errorPolicy: ErrorPolicy): RateLimiterProviderFactory<TAdapters>;
+    /**
+     * @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?: TAdapters | undefined): IRateLimiterProvider;
+}