@daiso-tech/core 0.42.0 → 0.44.0

package/dist/rate-limiter/implementations/adapters/redis-rate-limiter-adapter/lua/sliding-window-limiter-lua.js

@@ -0,0 +1,113 @@
+/**
+ * @module RateLimiter
+ */
+/**
+ * @internal
+ */
+export const slidingWindowLimiterLua = `
+-- @param settings Required<SerializedSlidingWindowLimiterSettings>
+-- @return IRateLimiterPolicy<SlidingWindowLimiterState>
+local function SlidingWindowLimiter(settings)
+    -- @param currentDate number
+    -- @return number
+    local function currentWindow(currentDate)
+        return math.floor(currentDate / settings.window) * settings.window
+    end
+
+    -- @param currentDate number
+    -- @return number
+    local function previousWindow(currentDate)
+        return currentWindow(currentDate) - settings.window
+    end
+
+    -- @param metrics SlidingWindowLimiterState
+    -- @param currentDate number
+    -- @return SlidingWindowLimiterState
+    local function cleanup(metrics, currentDate)
+        local previousWindow_ = previousWindow(currentDate)
+        local newMetrics = {}
+
+        for key, value in pairs(metrics) do
+            local timeStamp = tonumber(timeStampAsStr)
+            if timeStamp >= previousWindow_ then
+                newMetrics[key] = value
+            end
+        end
+
+        return newMetrics
+    end
+
+    -- @param currentMetrics SlidingWindowLimiterState
+    -- @param currentDate number
+    -- @return number
+    local function currentAttempt(currentMetrics, currentDate)
+        local currentAttempt = currentMetrics[currentWindow(currentDate)]
+        if currentAttempt == nil or currentAttempt == cjson.null then
+            currentAttempt = 0
+        end
+
+        return currentAttempt
+    end
+
+    -- @param currentMetrics SlidingWindowLimiterState
+    -- @param currentDate number
+    -- @return number
+    local function previousAttempt(currentMetrics, currentDate)
+        local previousAttempt = currentMetrics[previousWindow(currentDate)]
+        if previousAttempt == nil or previousAttempt == cjson.null then
+            previousAttempt = 0
+        end
+
+        local percentageInCurrentWindow = currentDate % settings.window / settings.window
+        return math.floor((1 - percentageInCurrentWindow) * previousAttempt)
+    end
+
+    return {
+        -- @param currentDate number
+        -- @return SlidingWindowLimiterState
+        initialMetrics = function(currentDate)
+            local metrics = {}
+            metrics[currentWindow(currentDate)] = 0
+            return metrics
+        end,
+
+        -- @param currentMetrics SlidingWindowLimiterState
+        -- @param limit number
+        -- @param currentDate number
+        -- @return boolean
+        shouldBlock = function(currentMetrics, limit, currentDate)
+            local currentAttempt_ = currentAttempt(currentMetrics, currentDate)
+            local previousAttempt_ = previousAttempt(currentMetrics, currentDate)
+            return currentAttempts + previousAttempts >= limit
+        end,
+
+        -- @param _currentMetrics SlidingWindowLimiterState
+        -- @param currentDate number
+        -- @return number
+        getExpiration = function(_currentMetrics, currentDate)
+            return settings.window * 2 + settings.margin + currentDate
+        end,
+
+        -- @param currentMetrics SlidingWindowLimiterState
+        -- @param currentDate number
+        -- @return number
+        getAttempts = function(currentMetrics, currentDate)
+            local currentAttempt_ = currentAttempt(currentMetrics, currentDate)
+            local previousAttempt_ = previousAttempt(currentMetrics, currentDate)
+            return currentAttempt_ + previousAttempt_
+        end,
+
+        -- @param currentMetrics SlidingWindowLimiterState
+        -- @param currentDate number
+        -- @return SlidingWindowLimiterState
+        updateMetrics = function(currentMetrics, currentDate)
+            local currentMetrics_ = cleanup(currentMetrics, currentDate)
+            local currentAttempt = currentAttempt(currentMetrics, currentDate)
+            local currentKey = currentWindow(currentDate)
+            currentMetrics_[currentKey] = currentAttempt + 1
+            return currentMetrics_
+        end
+    }
+end
+`;
+//# sourceMappingURL=sliding-window-limiter-lua.js.map

package/dist/rate-limiter/implementations/adapters/redis-rate-limiter-adapter/lua/sliding-window-limiter-lua.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliding-window-limiter-lua.js","sourceRoot":"","sources":["../../../../../../src/rate-limiter/implementations/adapters/redis-rate-limiter-adapter/lua/sliding-window-limiter-lua.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyGtC,CAAC"}

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

@@ -0,0 +1,69 @@
+/**
+ * @module RateLimiter
+ */
+import { type Redis, type Result } from "ioredis";
+import { type BackoffSettingsEnum } from "../../../../backoff-policies/_module.js";
+import { type IRateLimiterAdapter, type IRateLimiterAdapterState } from "../../../../rate-limiter/contracts/_module.js";
+import { type RateLimiterPolicySettingsEnum } from "../../../../rate-limiter/implementations/policies/_module.js";
+declare module "ioredis" {
+    interface RedisCommander<Context> {
+        /**
+         * @returns {string} {@link IRedisJsonRateLimiterState | `IRedisJsonRateLimiterState`} as json string.
+         */
+        daiso_rate_limiter_update_state(key: string, limit: number, backoffSettings: string, policySettings: string, currentDate: number): Result<string, Context>;
+        /**
+         * @returns {string} {@link IRedisJsonRateLimiterState | `IRedisJsonRateLimiterState | null`} as json string.
+         */
+        daiso_rate_limiter_get_state(key: string, backoffSettings: string, policySettings: string, currentDate: number): Result<string, Context>;
+    }
+}
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter"`
+ * @group Adapters
+ */
+export type RedisRateLimiterAdapterSettings = {
+    database: Redis;
+    /**
+     * You can choose between different types of predefined backoff policies.
+     * @default
+     * ```ts
+     * { type: BACKOFFS.EXPONENTIAL }
+     * ```
+     */
+    backoffPolicy?: BackoffSettingsEnum;
+    /**
+     * You can choose between different types of predefined circuit breaker policies.
+     * @default
+     * ```ts
+     * { type: LIMITER.FIXED_WINDOW }
+     * ```
+     */
+    rateLimiterPolicy?: RateLimiterPolicySettingsEnum;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter"`
+ * @group Adapters
+ */
+export declare class RedisRateLimiterAdapter implements IRateLimiterAdapter {
+    private readonly backoff;
+    private readonly policy;
+    private readonly database;
+    /**
+     * @example
+     * ```ts
+     * import { RedisRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter";
+     * import Redis from "ioredis";
+     *
+     * const database = new Redis("YOUR_REDIS_CONNECTION_STRING");
+     * const rateLimiterAdapter = new RedisRateLimiterAdapter({
+     *   database
+     * });
+     * ```
+     */
+    constructor(settings: RedisRateLimiterAdapterSettings);
+    private initGetStateCommand;
+    private initUpdateStateCommmand;
+    getState(key: string): Promise<IRateLimiterAdapterState | null>;
+    updateState(key: string, limit: number): Promise<IRateLimiterAdapterState>;
+    reset(key: string): Promise<void>;
+}

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

@@ -0,0 +1,112 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "ioredis";
+import { BACKOFFS, resolveBackoffSettingsEnum, serializeBackoffSettingsEnum, } from "../../../../backoff-policies/_module.js";
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { rateLimiterFactoryLua } from "../../../../rate-limiter/implementations/adapters/redis-rate-limiter-adapter/lua/_module.js";
+import { LIMITER_POLICIES, resolveRateLimiterPolicySettings, serializeRateLimiterPolicySettingsEnum, } from "../../../../rate-limiter/implementations/policies/_module.js";
+import { TimeSpan } from "../../../../time-span/implementations/time-span.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter"`
+ * @group Adapters
+ */
+export class RedisRateLimiterAdapter {
+    backoff;
+    policy;
+    database;
+    /**
+     * @example
+     * ```ts
+     * import { RedisRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/redis-rate-limiter-adapter";
+     * import Redis from "ioredis";
+     *
+     * const database = new Redis("YOUR_REDIS_CONNECTION_STRING");
+     * const rateLimiterAdapter = new RedisRateLimiterAdapter({
+     *   database
+     * });
+     * ```
+     */
+    constructor(settings) {
+        const { database, backoffPolicy = {
+            type: BACKOFFS.EXPONENTIAL,
+        }, rateLimiterPolicy = {
+            type: LIMITER_POLICIES.FIXED_WINDOW,
+        }, } = settings;
+        this.database = database;
+        this.backoff = resolveBackoffSettingsEnum(backoffPolicy);
+        this.policy = resolveRateLimiterPolicySettings(rateLimiterPolicy);
+        this.initGetStateCommand();
+        this.initUpdateStateCommmand();
+    }
+    initGetStateCommand() {
+        if (typeof this.database.daiso_rate_limiter_get_state === "function") {
+            return;
+        }
+        this.database.defineCommand("daiso_rate_limiter_get_state", {
+            numberOfKeys: 1,
+            lua: `
+            ${rateLimiterFactoryLua}
+
+            local key = KEYS[1];
+            local backoffSettings = cjson.decode(ARGV[1]);
+            local policySettings = cjson.decode(ARGV[2]);
+            local currentDate = tonumber(ARGV[3]);
+
+            local rateLimiter = rateLimiterFactory(backoffSettings, policySettings, currentDate)
+            local state = rateLimiter.getState(key)
+            return cjson.encode(state)
+            `,
+        });
+    }
+    initUpdateStateCommmand() {
+        if (typeof this.database.daiso_rate_limiter_update_state === "function") {
+            return;
+        }
+        this.database.defineCommand("daiso_rate_limiter_update_state", {
+            numberOfKeys: 1,
+            lua: `
+            ${rateLimiterFactoryLua}
+
+            local key = KEYS[1];
+            local limit = tonumber(ARGV[1]);
+            local backoffSettings = cjson.decode(ARGV[2]);
+            local policySettings = cjson.decode(ARGV[3]);
+            local currentDate = tonumber(ARGV[4]);
+
+            local rateLimiter = rateLimiterFactory(backoffSettings, policySettings, currentDate)
+            local state = rateLimiter.updateState(key, limit)
+            return cjson.encode(state)
+            `,
+        });
+    }
+    async getState(key) {
+        const json = await this.database.daiso_rate_limiter_get_state(key, JSON.stringify(serializeBackoffSettingsEnum(this.backoff)), JSON.stringify(serializeRateLimiterPolicySettingsEnum(this.policy)), Date.now());
+        const state = JSON.parse(json);
+        if (state === null) {
+            return null;
+        }
+        return {
+            success: state.success,
+            attempt: state.attempt,
+            resetTime: TimeSpan.fromDateRange({
+                end: new Date(state.resetTime),
+            }),
+        };
+    }
+    async updateState(key, limit) {
+        const json = await this.database.daiso_rate_limiter_update_state(key, limit, JSON.stringify(serializeBackoffSettingsEnum(this.backoff)), JSON.stringify(serializeRateLimiterPolicySettingsEnum(this.policy)), Date.now());
+        const state = JSON.parse(json);
+        return {
+            success: state.success,
+            attempt: state.attempt,
+            resetTime: TimeSpan.fromDateRange({
+                end: new Date(state.resetTime),
+            }),
+        };
+    }
+    async reset(key) {
+        await this.database.del(key);
+    }
+}
+//# sourceMappingURL=redis-rate-limiter-adapter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redis-rate-limiter-adapter.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/adapters/redis-rate-limiter-adapter/redis-rate-limiter-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAA2B,MAAM,SAAS,CAAC;AAElD,OAAO,EACH,QAAQ,EACR,0BAA0B,EAC1B,4BAA4B,GAE/B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAGN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mFAAmF,CAAC;AAC1H,OAAO,EACH,gBAAgB,EAChB,gCAAgC,EAChC,sCAAsC,GAEzC,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AA8DpE;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IACf,OAAO,CAAgC;IAEvC,MAAM,CAA0C;IAEhD,QAAQ,CAAQ;IAEjC;;;;;;;;;;;OAWG;IACH,YAAY,QAAyC;QACjD,MAAM,EACF,QAAQ,EACR,aAAa,GAAG;YACZ,IAAI,EAAE,QAAQ,CAAC,WAAW;SAC7B,EACD,iBAAiB,GAAG;YAChB,IAAI,EAAE,gBAAgB,CAAC,YAAY;SACtC,GACJ,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,gCAAgC,CAAC,iBAAiB,CAAC,CAAC;QAClE,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IAEO,mBAAmB;QACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,4BAA4B,KAAK,UAAU,EAAE,CAAC;YACnE,OAAO;QACX,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,8BAA8B,EAAE;YACxD,YAAY,EAAE,CAAC;YACf,GAAG,EAAE;cACH,qBAAqB;;;;;;;;;;aAUtB;SACJ,CAAC,CAAC;IACP,CAAC;IAEO,uBAAuB;QAC3B,IACI,OAAO,IAAI,CAAC,QAAQ,CAAC,+BAA+B,KAAK,UAAU,EACrE,CAAC;YACC,OAAO;QACX,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,iCAAiC,EAAE;YAC3D,YAAY,EAAE,CAAC;YACf,GAAG,EAAE;cACH,qBAAqB;;;;;;;;;;;aAWtB;SACJ,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW;QACtB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CACzD,GAAG,EACH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAC1D,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EACnE,IAAI,CAAC,GAAG,EAAE,CACb,CAAC;QACF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAsC,CAAC;QACpE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO;YACH,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC;gBAC9B,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;aACjC,CAAC;SACL,CAAC;IACN,CAAC;IAED,KAAK,CAAC,WAAW,CACb,GAAW,EACX,KAAa;QAEb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAC5D,GAAG,EACH,KAAK,EACL,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAC1D,IAAI,CAAC,SAAS,CAAC,sCAAsC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EACnE,IAAI,CAAC,GAAG,EAAE,CACb,CAAC;QACF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAA+B,CAAC;QAC7D,OAAO;YACH,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC;gBAC9B,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;aACjC,CAAC;SACL,CAAC;IACN,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACnB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACJ"}

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/derivables/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,4EAA4E,CAAC;AAC3F,cAAc,oFAAoF,CAAC"}

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/derivables/_module.ts"],"names":[],"mappings":"AAAA,cAAc,4EAA4E,CAAC;AAC3F,cAAc,oFAAoF,CAAC"}

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

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

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

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

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

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

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

@@ -0,0 +1,123 @@
+/**
+ * @module RateLimiter
+ */
+import { type EventListener, type IEventBus, type Unsubscribe } from "../../../../event-bus/contracts/_module.js";
+import { Namespace } from "../../../../namespace/_module.js";
+import { type IRateLimiter, type IRateLimiterAdapter, type IRateLimiterProvider, type RateLimiterEventMap, type RateLimiterProviderCreateSettings } from "../../../../rate-limiter/contracts/_module.js";
+import { type ITask } from "../../../../task/contracts/_module.js";
+import { type ErrorPolicy } from "../../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export type RateLimiterProviderSettingsBase = {
+    /**
+     * @default
+     * ```ts
+     * import { Namespace } from "@daiso-tech/core/namespace";
+     *
+     * new Namespace("@rate-limiter")
+     * ```
+     */
+    namespace?: Namespace;
+    /**
+     * @default
+     * ```ts
+     * import { EventBus } from "@daiso-tech/core/event-bus";
+     * import { NoOpEventBusAdapter } from "@daiso-tech/core/event-bus/no-op-event-bus-adapter";
+     *
+     * new EventBus({
+     *   adapter: new NoOpEventBusAdapter()
+     * })
+     * ```
+     */
+    eventBus?: IEventBus;
+    /**
+     * You can set the default `ErrorPolicy`
+     *
+     * @default
+     * ```ts
+     * (_error: unknown) => true
+     * ```
+     */
+    defaultErrorPolicy?: ErrorPolicy;
+    /**
+     * If true will only apply rate limiting when function errors and not when function is called.
+     * @default false
+     */
+    onlyError?: boolean;
+    /**
+     * If true, metric tracking will run asynchronously in the background and won't block the function utilizing the circuit breaker logic.
+     * This will only have effect if `onlyError` settings is true.
+     * @default true
+     */
+    enableAsyncTracking?: boolean;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export type RateLimiterProviderSettings = RateLimiterProviderSettingsBase & {
+    adapter: IRateLimiterAdapter;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export declare const DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE: Namespace;
+/**
+ * The `RateLimiterProvider` class can be derived from any {@link IRateLimiterAdapter | `IRateLimiterAdapter`}.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export declare class RateLimiterProvider implements IRateLimiterProvider {
+    private readonly namespace;
+    private readonly eventBus;
+    private readonly adapter;
+    private readonly onlyError;
+    private readonly defaultErrorPolicy;
+    private readonly enableAsyncTracking;
+    /**
+     * @example
+     * ```ts
+     * import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-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 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();
+     *
+     * const rateLimiterAdapter = new DatabaseRateLimiterAdapter({
+     *   adapter: rateLimiterStorageAdapter
+     * });
+     *
+     * const rateLimiterProvider = new RateLimiterProvider({
+     *   adapter: rateLimiterAdapter
+     * })
+     * ```
+     */
+    constructor(settings: RateLimiterProviderSettings);
+    addListener<TEventName extends keyof RateLimiterEventMap>(eventName: TEventName, listener: EventListener<RateLimiterEventMap[TEventName]>): ITask<void>;
+    removeListener<TEventName extends keyof RateLimiterEventMap>(eventName: TEventName, listener: EventListener<RateLimiterEventMap[TEventName]>): ITask<void>;
+    listenOnce<TEventName extends keyof RateLimiterEventMap>(eventName: TEventName, listener: EventListener<RateLimiterEventMap[TEventName]>): ITask<void>;
+    asTask<TEventName extends keyof RateLimiterEventMap>(eventName: TEventName): ITask<RateLimiterEventMap[TEventName]>;
+    subscribeOnce<TEventName extends keyof RateLimiterEventMap>(eventName: TEventName, listener: EventListener<RateLimiterEventMap[TEventName]>): ITask<Unsubscribe>;
+    subscribe<TEventName extends keyof RateLimiterEventMap>(eventName: TEventName, listener: EventListener<RateLimiterEventMap[TEventName]>): ITask<Unsubscribe>;
+    create(key: string, settings: RateLimiterProviderCreateSettings): IRateLimiter;
+}

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

@@ -0,0 +1,104 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../../event-bus/contracts/_module.js";
+import { NoOpEventBusAdapter } from "../../../../event-bus/implementations/adapters/_module.js";
+import { EventBus } from "../../../../event-bus/implementations/derivables/_module.js";
+import { Namespace } from "../../../../namespace/_module.js";
+import {} from "../../../../rate-limiter/contracts/_module.js";
+import { RateLimiter } from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider/rate-limiter.js";
+import {} from "../../../../task/contracts/_module.js";
+import {} from "../../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export const DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE = new Namespace("@rate-limiter");
+/**
+ * The `RateLimiterProvider` class can be derived from any {@link IRateLimiterAdapter | `IRateLimiterAdapter`}.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
+ * @group Derivables
+ */
+export class RateLimiterProvider {
+    namespace;
+    eventBus;
+    adapter;
+    onlyError;
+    defaultErrorPolicy;
+    enableAsyncTracking;
+    /**
+     * @example
+     * ```ts
+     * import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-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 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();
+     *
+     * const rateLimiterAdapter = new DatabaseRateLimiterAdapter({
+     *   adapter: rateLimiterStorageAdapter
+     * });
+     *
+     * const rateLimiterProvider = new RateLimiterProvider({
+     *   adapter: rateLimiterAdapter
+     * })
+     * ```
+     */
+    constructor(settings) {
+        const { enableAsyncTracking = true, namespace = DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE, eventBus = new EventBus({
+            adapter: new NoOpEventBusAdapter(),
+        }), adapter, onlyError = false, defaultErrorPolicy = () => true, } = settings;
+        this.enableAsyncTracking = enableAsyncTracking;
+        this.namespace = namespace;
+        this.eventBus = eventBus;
+        this.adapter = adapter;
+        this.onlyError = onlyError;
+        this.defaultErrorPolicy = defaultErrorPolicy;
+    }
+    addListener(eventName, listener) {
+        return this.eventBus.addListener(eventName, listener);
+    }
+    removeListener(eventName, listener) {
+        return this.eventBus.removeListener(eventName, listener);
+    }
+    listenOnce(eventName, listener) {
+        return this.eventBus.listenOnce(eventName, listener);
+    }
+    asTask(eventName) {
+        return this.eventBus.asTask(eventName);
+    }
+    subscribeOnce(eventName, listener) {
+        return this.eventBus.subscribeOnce(eventName, listener);
+    }
+    subscribe(eventName, listener) {
+        return this.eventBus.subscribe(eventName, listener);
+    }
+    create(key, settings) {
+        const { errorPolicy = this.defaultErrorPolicy, onlyError = this.onlyError, limit, } = settings;
+        return new RateLimiter({
+            limit,
+            enableAsyncTracking: this.enableAsyncTracking,
+            eventDispatcher: this.eventBus,
+            adapter: this.adapter,
+            key: this.namespace.create(key),
+            errorPolicy,
+            onlyError,
+        });
+    }
+}
+//# sourceMappingURL=rate-limiter-provider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-provider.js","sourceRoot":"","sources":["../../../../../src/rate-limiter/implementations/derivables/rate-limiter-provider/rate-limiter-provider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAIN,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,EAAE,QAAQ,EAAE,MAAM,mDAAmD,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAMN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,iFAAiF,CAAC;AAC9G,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAoB,MAAM,wBAAwB,CAAC;AAgE1D;;;;GAIG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG,IAAI,SAAS,CACnE,eAAe,CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,OAAO,mBAAmB;IACX,SAAS,CAAY;IACrB,QAAQ,CAAiC;IACzC,OAAO,CAAsB;IAC7B,SAAS,CAAU;IACnB,kBAAkB,CAAc;IAChC,mBAAmB,CAAU;IAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,YAAY,QAAqC;QAC7C,MAAM,EACF,mBAAmB,GAAG,IAAI,EAC1B,SAAS,GAAG,0CAA0C,EACtD,QAAQ,GAAG,IAAI,QAAQ,CAAC;YACpB,OAAO,EAAE,IAAI,mBAAmB,EAAE;SACrC,CAAC,EACF,OAAO,EACP,SAAS,GAAG,KAAK,EACjB,kBAAkB,GAAG,GAAG,EAAE,CAAC,IAAI,GAClC,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IACjD,CAAC;IAED,WAAW,CACP,SAAqB,EACrB,QAAwD;QAExD,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,cAAc,CACV,SAAqB,EACrB,QAAwD;QAExD,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,UAAU,CACN,SAAqB,EACrB,QAAwD;QAExD,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,CACF,SAAqB;QAErB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,aAAa,CACT,SAAqB,EACrB,QAAwD;QAExD,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,SAAS,CACL,SAAqB,EACrB,QAAwD;QAExD,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CACF,GAAW,EACX,QAA2C;QAE3C,MAAM,EACF,WAAW,GAAG,IAAI,CAAC,kBAAkB,EACrC,SAAS,GAAG,IAAI,CAAC,SAAS,EAC1B,KAAK,GACR,GAAG,QAAQ,CAAC;QACb,OAAO,IAAI,WAAW,CAAC;YACnB,KAAK;YACL,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,eAAe,EAAE,IAAI,CAAC,QAAQ;YAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC;YAC/B,WAAW;YACX,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;CACJ"}

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

@@ -0,0 +1,41 @@
+/**
+ * @module RateLimiter
+ */
+import { type IEventDispatcher } from "../../../../event-bus/contracts/_module.js";
+import { type Key } from "../../../../namespace/_module.js";
+import { type IRateLimiter, type IRateLimiterAdapter, type RateLimiterEventMap, type RateLimiterState } from "../../../../rate-limiter/contracts/_module.js";
+import { type ITask } from "../../../../task/contracts/_module.js";
+import { type AsyncLazy, type ErrorPolicy } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export type RateLimiterSettings = {
+    limit: number;
+    enableAsyncTracking: boolean;
+    eventDispatcher: IEventDispatcher<RateLimiterEventMap>;
+    adapter: IRateLimiterAdapter;
+    key: Key;
+    errorPolicy: ErrorPolicy;
+    onlyError: boolean;
+};
+/**
+ * @internal
+ */
+export declare class RateLimiter implements IRateLimiter {
+    private readonly _key;
+    private readonly _limit;
+    private readonly errorPolicy;
+    private readonly onlyError;
+    private readonly adapter;
+    private readonly eventDispatcher;
+    private readonly enableAsyncTracking;
+    constructor(settings: RateLimiterSettings);
+    private toRateLimiterState;
+    getState(): ITask<RateLimiterState>;
+    get key(): string;
+    get limit(): number;
+    private trackErrorWrapper;
+    private trackWrapper;
+    runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): ITask<TValue>;
+    reset(): ITask<void>;
+}