@daiso-tech/core 0.42.0 → 0.43.2

package/dist/namespace/namespace.js

@@ -1,7 +1,7 @@
 /**
  * @module Namespace
  */
-import { resolveOneOrMoreStr, resolveOneOrMore, UnexpectedError, } from "../utilities/_module-exports.js";
+import { resolveOneOrMoreStr, resolveOneOrMore, UnexpectedError, } from "../utilities/_module.js";
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/namespace"`

package/dist/namespace/namespace.js.map

@@ -1 +1 @@
-{"version":3,"file":"namespace.js","sourceRoot":"","sources":["../../src/namespace/namespace.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,GAElB,MAAM,gCAAgC,CAAC;AAWxC;;;GAGG;AACH,MAAM,OAAO,GAAG;IACK,SAAS,CAAgB;IACzB,GAAG,CAAS;IACZ,SAAS,CAAS;IAEnC;;;OAGG;IACH,YAAY,QAAqB;QAC7B,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,GAAG;QACC,OAAO,IAAI,CAAC,GAAG,CAAC;IACpB,CAAC;IAED,QAAQ;QACJ,OAAO,mBAAmB,CACtB,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,EAC7B,IAAI,CAAC,SAAS,CACjB,CAAC;IACN,CAAC;CACJ;AAkBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,SAAS;IAKG;IAJJ,SAAS,CAAS;IAClB,cAAc,CAAS;IAExC,YACqB,IAAuB,EACxC,WAA8B,EAAE;QADf,SAAI,GAAJ,IAAI,CAAmB;QAGxC,MAAM,EAAE,SAAS,GAAG,GAAG,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,QAAQ,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAED,YAAY,CAAC,SAAiB;QAC1B,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE;YAC5B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,iBAAiB,CAAC,UAAkB;QAChC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE;YAC5B,cAAc,EAAE,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,GAAsB;QAC7B,OAAO,IAAI,SAAS,CAChB,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC1D;YACI,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CACJ,CAAC;IACN,CAAC;IAED,WAAW,CAAC,GAAsB;QAC9B,OAAO,IAAI,SAAS,CAChB,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAC1D;YACI,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CACJ,CAAC;IACN,CAAC;IAEO,QAAQ,CAAC,GAAW;QACxB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACrB,QAAQ,GAAG,yBAAyB,IAAI,CAAC,cAAc,GAAG,CAC7D,CAAC;QACN,CAAC;IACL,CAAC;IAEO,iBAAiB;QACrB,OAAO;YACH,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YAC9C,IAAI,CAAC,cAAc;SACtB,CAAC;IACN,CAAC;IAED,QAAQ;QACJ,OAAO,mBAAmB,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,GAAG,CAAC;YACX,GAAG;YACH,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,iBAAiB,EAAE;SACtC,CAAC,CAAC;IACP,CAAC;CACJ"}
+{"version":3,"file":"namespace.js","sourceRoot":"","sources":["../../src/namespace/namespace.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,GAElB,MAAM,wBAAwB,CAAC;AAWhC;;;GAGG;AACH,MAAM,OAAO,GAAG;IACK,SAAS,CAAgB;IACzB,GAAG,CAAS;IACZ,SAAS,CAAS;IAEnC;;;OAGG;IACH,YAAY,QAAqB;QAC7B,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,GAAG;QACC,OAAO,IAAI,CAAC,GAAG,CAAC;IACpB,CAAC;IAED,QAAQ;QACJ,OAAO,mBAAmB,CACtB,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,EAC7B,IAAI,CAAC,SAAS,CACjB,CAAC;IACN,CAAC;CACJ;AAkBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,SAAS;IAKG;IAJJ,SAAS,CAAS;IAClB,cAAc,CAAS;IAExC,YACqB,IAAuB,EACxC,WAA8B,EAAE;QADf,SAAI,GAAJ,IAAI,CAAmB;QAGxC,MAAM,EAAE,SAAS,GAAG,GAAG,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,QAAQ,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAED,YAAY,CAAC,SAAiB;QAC1B,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE;YAC5B,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,iBAAiB,CAAC,UAAkB;QAChC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE;YAC5B,cAAc,EAAE,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,GAAsB;QAC7B,OAAO,IAAI,SAAS,CAChB,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC1D;YACI,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CACJ,CAAC;IACN,CAAC;IAED,WAAW,CAAC,GAAsB;QAC9B,OAAO,IAAI,SAAS,CAChB,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAC1D;YACI,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CACJ,CAAC;IACN,CAAC;IAEO,QAAQ,CAAC,GAAW;QACxB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACrB,QAAQ,GAAG,yBAAyB,IAAI,CAAC,cAAc,GAAG,CAC7D,CAAC;QACN,CAAC;IACL,CAAC;IAEO,iBAAiB;QACrB,OAAO;YACH,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YAC9C,IAAI,CAAC,cAAc;SACtB,CAAC;IACN,CAAC;IAED,QAAQ;QACJ,OAAO,mBAAmB,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,IAAI,GAAG,CAAC;YACX,GAAG;YACH,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,iBAAiB,EAAE;SACtC,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/rate-limiter/contracts/_module-exports.d.ts

@@ -0,0 +1,9 @@
+export type * from "../../rate-limiter/contracts/rate-limiter-adapter.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-policy.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-provider-factory.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-provider.contract.js";
+export * from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-storage-adapter.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter.contract.js";
+export * from "../../rate-limiter/contracts/rate-limiter.errors.js";
+export * from "../../rate-limiter/contracts/rate-limiter.events.js";

package/dist/rate-limiter/contracts/_module-exports.js

@@ -0,0 +1,4 @@
+export * from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+export * from "../../rate-limiter/contracts/rate-limiter.errors.js";
+export * from "../../rate-limiter/contracts/rate-limiter.events.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/rate-limiter/contracts/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/_module-exports.ts"],"names":[],"mappings":"AAIA,cAAc,yDAAyD,CAAC;AAGxE,cAAc,iDAAiD,CAAC;AAChE,cAAc,iDAAiD,CAAC"}

package/dist/rate-limiter/contracts/_module.d.ts

@@ -0,0 +1,9 @@
+export type * from "../../rate-limiter/contracts/rate-limiter-adapter.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-policy.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-provider-factory.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-provider.contract.js";
+export * from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter-storage-adapter.contract.js";
+export type * from "../../rate-limiter/contracts/rate-limiter.contract.js";
+export * from "../../rate-limiter/contracts/rate-limiter.errors.js";
+export * from "../../rate-limiter/contracts/rate-limiter.events.js";

package/dist/rate-limiter/contracts/_module.js

@@ -0,0 +1,4 @@
+export * from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+export * from "../../rate-limiter/contracts/rate-limiter.errors.js";
+export * from "../../rate-limiter/contracts/rate-limiter.events.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/contracts/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/_module.ts"],"names":[],"mappings":"AAIA,cAAc,yDAAyD,CAAC;AAGxE,cAAc,iDAAiD,CAAC;AAChE,cAAc,iDAAiD,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter-adapter.contract.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @module RateLimiter
+ */
+import { type ITimeSpan } from "../../time-span/contracts/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export type IRateLimiterAdapterState = {
+    success: boolean;
+    attempt: number;
+    resetTime: ITimeSpan | null;
+};
+/**
+ * The `IRateLimiterAdapter` contract defines a way for managing rate limiters independent of the underlying technology and algorithm.
+ * This contract is not meant to be used directly, instead you should use {@link IRateLimiterProvider | `IRateLimiterProvider`} contract.
+ *
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export type IRateLimiterAdapter = {
+    /**
+     * The `getState` method returns the state of the rate limiter.
+     */
+    getState(key: string): Promise<IRateLimiterAdapterState | null>;
+    /**
+     * The `updateState` method updates the state of the rate limiter and returns the new state.
+     */
+    updateState(key: string, limit: number): Promise<IRateLimiterAdapterState>;
+    /**
+     * The `reset` method resets rate limiter to its initial state regardless of the current state.
+     */
+    reset(key: string): Promise<void>;
+};

package/dist/rate-limiter/contracts/rate-limiter-adapter.contract.js

@@ -0,0 +1,7 @@
+/**
+ * @module RateLimiter
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import {} from "../../rate-limiter/contracts/rate-limiter-provider.contract.js";
+import {} from "../../time-span/contracts/_module.js";
+//# sourceMappingURL=rate-limiter-adapter.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter-adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-adapter.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,6DAA6D;AAC7D,OAAO,EAA6B,MAAM,4DAA4D,CAAC;AACvG,OAAO,EAAkB,MAAM,kCAAkC,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter-policy.contract.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @module RateLimiter
+ */
+/**
+ * The `IRateLimiterPolicy` contract defines the rate limiter algorithm.
+ * Note all the methods here are pure functions, meaning they should return copies and not mutate input data.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterPolicy<TMetrics = unknown> = {
+    initialMetrics(currentDate: Date): TMetrics;
+    shouldBlock(currentMetrics: TMetrics, limit: number, currentDate: Date): boolean;
+    /**
+     * The `getExpiration` method should return the expiration as `Date`.
+     * This method is optional, if defined rate limiter data will be cleaned up when expired.
+     * If not defined the rate limiter data will be stored forever.
+     */
+    getExpiration(currentMetrics: TMetrics, currentDate: Date): Date;
+    /**
+     * The `getAttempts` method returns amount of used attempts.
+     */
+    getAttempts(currentMetrics: TMetrics, currentDate: Date): number;
+    /**
+     * The `updateMetrics` method updates the metrics when an attempt occurs.
+     */
+    updateMetrics(currentMetrics: TMetrics, currentDate: Date): TMetrics;
+};

package/dist/rate-limiter/contracts/rate-limiter-policy.contract.js

@@ -0,0 +1,5 @@
+/**
+ * @module RateLimiter
+ */
+export {};
+//# sourceMappingURL=rate-limiter-policy.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter-policy.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-policy.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter-policy.contract.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/rate-limiter/contracts/rate-limiter-provider-factory.contract.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @module RateLimiter
+ */
+import { type IRateLimiterProvider } from "../../rate-limiter/contracts/rate-limiter-provider.contract.js";
+/**
+ * The `IRateLimiterProviderFactory` contract makes it easy to configure and switch between different {@link IRateLimiterProvider | `IRateLimiterProvider`} dynamically.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterProviderFactory<TAdapters extends string = string> = {
+    /**
+     * The `use` method will throw an error if you provide it unregisted adapter.
+     * If no default adapter is defined an error will be thrown by `use` method.
+     * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
+     * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
+     */
+    use(adapterName?: TAdapters): IRateLimiterProvider;
+};

package/dist/rate-limiter/contracts/rate-limiter-provider-factory.contract.js

@@ -0,0 +1,10 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../rate-limiter/contracts/rate-limiter-provider.contract.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";
+//# sourceMappingURL=rate-limiter-provider-factory.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter-provider-factory.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-provider-factory.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter-provider-factory.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAA6B,MAAM,4DAA4D,CAAC;AACvG,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAChC,MAAM,wBAAwB,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter-provider.contract.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @module RateLimiter
+ */
+import { type IEventListenable } from "../../event-bus/contracts/_module.js";
+import { type IRateLimiter } from "../../rate-limiter/contracts/rate-limiter.contract.js";
+import { type RateLimiterEventMap } from "../../rate-limiter/contracts/rate-limiter.events.js";
+import { type ErrorPolicySettings } from "../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type RateLimiterProviderCreateSettings = ErrorPolicySettings & {
+    /**
+     * If true will only apply rate limiting when function errors and not when function is called.
+     * @default false
+     */
+    onlyError?: boolean;
+    limit: number;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterProviderBase = {
+    create(key: string, settings: RateLimiterProviderCreateSettings): IRateLimiter;
+};
+/**
+ * The `IRateLimiterListenable` contract defines a way for listening {@link IRateLimiter | `IRateLimiter`} operations and state transitions.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterListenable = IEventListenable<RateLimiterEventMap>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterProvider = IRateLimiterListenable & IRateLimiterProviderBase;

package/dist/rate-limiter/contracts/rate-limiter-provider.contract.js

@@ -0,0 +1,8 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../event-bus/contracts/_module.js";
+import {} from "../../rate-limiter/contracts/rate-limiter.contract.js";
+import {} from "../../rate-limiter/contracts/rate-limiter.events.js";
+import {} from "../../utilities/_module.js";
+//# sourceMappingURL=rate-limiter-provider.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter-provider.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-provider.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter-provider.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAyB,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAqB,MAAM,mDAAmD,CAAC;AACtF,OAAO,EAA4B,MAAM,iDAAiD,CAAC;AAC3F,OAAO,EAA4B,MAAM,wBAAwB,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter-state.contract.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @module RateLimiter
+ */
+import { type ITimeSpan } from "../../time-span/contracts/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export declare const RATE_LIMITER_STATE: {
+    readonly BLOCKED: "BLOCKED";
+    readonly ALLOWED: "ALLOWED";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type RateLimiterStateLiterals = (typeof RATE_LIMITER_STATE)[keyof typeof RATE_LIMITER_STATE];
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type RateLimiterAllowedState = {
+    type: (typeof RATE_LIMITER_STATE)["ALLOWED"];
+    usedAttempts: number;
+    reaminingAttemps: number;
+    limit: number;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type RateLimiterBlockedState = {
+    type: (typeof RATE_LIMITER_STATE)["BLOCKED"];
+    limit: number;
+    totalAttempts: number;
+    exceedAttempts: number;
+    resetTime: ITimeSpan;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type RateLimiterState = RateLimiterBlockedState | RateLimiterAllowedState;

package/dist/rate-limiter/contracts/rate-limiter-state.contract.js

@@ -0,0 +1,14 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../time-span/contracts/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export const RATE_LIMITER_STATE = {
+    BLOCKED: "BLOCKED",
+    ALLOWED: "ALLOWED",
+};
+//# sourceMappingURL=rate-limiter-state.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter-state.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-state.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter-state.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAElE;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACZ,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter-storage-adapter.contract.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @module RateLimiter
+ */
+import { type InvokableFn } from "../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterData<TType = unknown> = {
+    state: TType;
+    /**
+     * The expiration date and time of the lock.
+     * `null` indicates the lock does not expire.
+     */
+    expiration: Date;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterStorageAdapterTransaction<TType = unknown> = {
+    /**
+     * The `upsert` inserts a rate limiter if it doesnt exist otherwise it will be updated.
+     *
+     * @param key The unique identifier for the rate limiter.
+     */
+    upsert(key: string, state: TType, expiration: Date): Promise<void>;
+    /**
+     * Retrieves the current rate limiter state for a given key.
+     *
+     * @param key The unique identifier for the rate limiter.
+     * @returns Returns the rate limiter state if found, otherwise `null`.
+     */
+    find(key: string): Promise<IRateLimiterData<TType> | null>;
+};
+/**
+ * The `IRateLimiterStorageAdapter` contract defines a way for storing rate limiter state independent of the underlying technology.
+ * This contract simplifies the implementation of rate limiter adapters with CRUD-based databases, such as SQL databases and ORMs like TypeOrm and MikroOrm.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterStorageAdapter<TType = unknown> = {
+    /**
+     * The `transaction` method runs the `fn` function inside a transaction.
+     * The `fn` function is given a {@link IRateLimiterStorageAdapterTransaction | `IRateLimiterStorageAdapterTransaction`} object.
+     */
+    transaction<TValue>(fn: InvokableFn<[
+        transaction: IRateLimiterStorageAdapterTransaction<TType>
+    ], Promise<TValue>>): Promise<TValue>;
+    /**
+     * Retrieves the current rate limiter state for a given key.
+     *
+     * @param key The unique identifier for the rate limiter.
+     * @returns Returns the rate limiter state if found, otherwise `null`.
+     */
+    find(key: string): Promise<IRateLimiterData<TType> | null>;
+    /**
+     * Removes a rate limiter from the database.
+     *
+     * @param key The unique identifier for the rate limiter to remove.
+     */
+    remove(key: string): Promise<void>;
+};

package/dist/rate-limiter/contracts/rate-limiter-storage-adapter.contract.js

@@ -0,0 +1,5 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../utilities/_module.js";
+//# sourceMappingURL=rate-limiter-storage-adapter.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter-storage-adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-storage-adapter.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter-storage-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAoB,MAAM,wBAAwB,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter.contract.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @module RateLimiter
+ */
+import { type RateLimiterState } from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+import { type ITask } from "../../task/contracts/_module.js";
+import { type ITimeSpan } from "../../time-span/contracts/_module.js";
+import { type AsyncLazy } from "../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiterStateMethods = {
+    getState(): ITask<RateLimiterState>;
+    /**
+     * The `key` of the `IRateLimiter` instance.
+     */
+    readonly key: string;
+    /**
+     * The `limit` of the `IRateLimiter` instance.
+     */
+    readonly limit: number;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type RateLimiterRunBlockingSettings = {
+    time?: ITimeSpan;
+    interval?: ITimeSpan;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Contracts
+ */
+export type IRateLimiter = IRateLimiterStateMethods & {
+    /**
+     * @throws {BlockedRateLimiterError} {@link BlockedRateLimiterError}
+     */
+    runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): ITask<TValue>;
+    /**
+     * The `reset` method resets rate limiter to its initial state regardless of the current state.
+     */
+    reset(): ITask<void>;
+};

package/dist/rate-limiter/contracts/rate-limiter.contract.js

@@ -0,0 +1,10 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { BlockedRateLimiterError } from "../../rate-limiter/contracts/rate-limiter.errors.js";
+import {} from "../../task/contracts/_module.js";
+import {} from "../../time-span/contracts/_module.js";
+import {} from "../../utilities/_module.js";
+//# sourceMappingURL=rate-limiter.contract.js.map

package/dist/rate-limiter/contracts/rate-limiter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.contract.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAyB,MAAM,yDAAyD,CAAC;AAChG,6DAA6D;AAC7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAkB,MAAM,wBAAwB,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter.errors.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @module RateLimiter
+ */
+import { type RateLimiterBlockedState } from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+/**
+ * The error is throw when rate limiter blocks the attempts.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export declare class BlockedRateLimiterError extends Error {
+    readonly state: Omit<RateLimiterBlockedState, "type">;
+    constructor(state: Omit<RateLimiterBlockedState, "type">, message?: string, cause?: unknown);
+}
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export declare const CIRCUIT_BREAKER_ERRORS: {
+    readonly Blocked: typeof BlockedRateLimiterError;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export type AllRateLimiterErrors = BlockedRateLimiterError;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export declare function isRateLimiterError(value: unknown): value is AllRateLimiterErrors;

package/dist/rate-limiter/contracts/rate-limiter.errors.js

@@ -0,0 +1,40 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../rate-limiter/contracts/rate-limiter-state.contract.js";
+/**
+ * The error is throw when rate limiter blocks the attempts.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export class BlockedRateLimiterError extends Error {
+    state;
+    constructor(state, message, cause) {
+        super(message, { cause });
+        this.state = state;
+        this.name = BlockedRateLimiterError.name;
+    }
+}
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export const CIRCUIT_BREAKER_ERRORS = {
+    Blocked: BlockedRateLimiterError,
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Errors
+ */
+export function isRateLimiterError(value) {
+    for (const ErrorClass of Object.values(CIRCUIT_BREAKER_ERRORS)) {
+        if (!(value instanceof ErrorClass)) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=rate-limiter.errors.js.map

package/dist/rate-limiter/contracts/rate-limiter.errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.errors.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAgC,MAAM,yDAAyD,CAAC;AAEvG;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAE1B;IADpB,YACoB,KAA4C,EAC5D,OAAgB,EAChB,KAAe;QAEf,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAJV,UAAK,GAAL,KAAK,CAAuC;QAK5D,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC7C,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IAClC,OAAO,EAAE,uBAAuB;CAC1B,CAAC;AASX;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAC9B,KAAc;IAEd,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC7D,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/rate-limiter/contracts/rate-limiter.events.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @module RateLimiter
+ */
+import { type IRateLimiterStateMethods } from "../../rate-limiter/contracts/rate-limiter.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type RateLimiterEventBase = {
+    rateLimiter: IRateLimiterStateMethods;
+};
+/**
+ * The event is dispatched when the attempt is blocked.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type BlockedRateLimiterEvent = RateLimiterEventBase;
+/**
+ * The event is dispatched when the attempt is allowed to proceed.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type AllowedRateLimiterEvent = RateLimiterEventBase;
+/**
+ * The event is dispatched when rate limiter has been reseted.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type ResetedRateLimiterEvent = RateLimiterEventBase;
+/**
+ * The event is dispatched when a rate limiter has tracked failure.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type TrackedFailureRateLimiterEvent = RateLimiterEventBase & {
+    error: unknown;
+};
+/**
+ * The event is dispatched when a rate limiter has untracked failure.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type UntrackedFailureRateLimiterEvent = RateLimiterEventBase & {
+    error: unknown;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export declare const RATE_LIMITER_EVENTS: {
+    readonly TRACKED_FAILURE: "TRACKED_FAILURE";
+    readonly UNTRACKED_FAILURE: "UNTRACKED_FAILURE";
+    readonly BLOCKED: "BLOCKED";
+    readonly ALLOWED: "ALLOWED";
+    readonly RESETED: "RESETED";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export type RateLimiterEventMap = {
+    [RATE_LIMITER_EVENTS.TRACKED_FAILURE]: TrackedFailureRateLimiterEvent;
+    [RATE_LIMITER_EVENTS.UNTRACKED_FAILURE]: UntrackedFailureRateLimiterEvent;
+    [RATE_LIMITER_EVENTS.BLOCKED]: BlockedRateLimiterEvent;
+    [RATE_LIMITER_EVENTS.ALLOWED]: AllowedRateLimiterEvent;
+    [RATE_LIMITER_EVENTS.RESETED]: ResetedRateLimiterEvent;
+};

package/dist/rate-limiter/contracts/rate-limiter.events.js

@@ -0,0 +1,17 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../rate-limiter/contracts/rate-limiter.contract.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/contracts"`
+ * @group Events
+ */
+export const RATE_LIMITER_EVENTS = {
+    TRACKED_FAILURE: "TRACKED_FAILURE",
+    UNTRACKED_FAILURE: "UNTRACKED_FAILURE",
+    BLOCKED: "BLOCKED",
+    ALLOWED: "ALLOWED",
+    RESETED: "RESETED",
+};
+//# sourceMappingURL=rate-limiter.events.js.map

package/dist/rate-limiter/contracts/rate-limiter.events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.events.js","sourceRoot":"","sources":["../../../src/rate-limiter/contracts/rate-limiter.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAiC,MAAM,mDAAmD,CAAC;AAsDlG;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAC/B,eAAe,EAAE,iBAAiB;IAClC,iBAAiB,EAAE,mBAAmB;IACtC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACZ,CAAC"}

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

@@ -0,0 +1,7 @@
+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";