@daiso-tech/core 0.40.0 → 0.41.0

package/dist/semaphore/contracts/semaphore.errors.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @module Semaphore
+ */
+/**
+ * The error is thrown when trying to acquire a semaphore slot, but all slots are already taken.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export declare class LimitReachedSemaphoreError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The error is thrown when trying to referesh a semaphore slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export declare class FailedRefreshSemaphoreError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The error is thrown when trying to release a semaphore slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export declare class FailedReleaseSemaphoreError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export declare const SEMAPHORE_ERRORS: {
+    readonly ReachedLimit: typeof LimitReachedSemaphoreError;
+    readonly FailedRefresh: typeof FailedRefreshSemaphoreError;
+    readonly FailedRelease: typeof FailedReleaseSemaphoreError;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export type AllSemaphoreErrors = LimitReachedSemaphoreError | FailedRefreshSemaphoreError | FailedReleaseSemaphoreError;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export declare function isSemaphoreError(value: unknown): value is AllSemaphoreErrors;

package/dist/semaphore/contracts/semaphore.errors.js

@@ -0,0 +1,63 @@
+/**
+ * @module Semaphore
+ */
+/**
+ * The error is thrown when trying to acquire a semaphore slot, but all slots are already taken.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export class LimitReachedSemaphoreError extends Error {
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = LimitReachedSemaphoreError.name;
+    }
+}
+/**
+ * The error is thrown when trying to referesh a semaphore slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export class FailedRefreshSemaphoreError extends Error {
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = FailedRefreshSemaphoreError.name;
+    }
+}
+/**
+ * The error is thrown when trying to release a semaphore slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export class FailedReleaseSemaphoreError extends Error {
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = FailedReleaseSemaphoreError.name;
+    }
+}
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export const SEMAPHORE_ERRORS = {
+    ReachedLimit: LimitReachedSemaphoreError,
+    FailedRefresh: FailedRefreshSemaphoreError,
+    FailedRelease: FailedReleaseSemaphoreError,
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Errors
+ */
+export function isSemaphoreError(value) {
+    for (const ErrorClass of Object.values(SEMAPHORE_ERRORS)) {
+        if (!(value instanceof ErrorClass)) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=semaphore.errors.js.map

package/dist/semaphore/contracts/semaphore.errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semaphore.errors.js","sourceRoot":"","sources":["../../../src/semaphore/contracts/semaphore.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IACjD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC,IAAI,CAAC;IAChD,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IAClD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC;IACjD,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IAClD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC;IACjD,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,YAAY,EAAE,0BAA0B;IACxC,aAAa,EAAE,2BAA2B;IAC1C,aAAa,EAAE,2BAA2B;CACpC,CAAC;AAYX;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC3C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACvD,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/semaphore/contracts/semaphore.events.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @module Semaphore
+ */
+import type { ISemaphoreStateMethods } from "../../semaphore/contracts/semaphore.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type SemaphoreEventBase = {
+    semaphore: ISemaphoreStateMethods;
+};
+/**
+ * The event is dispatched when a semaphore slot is aquired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type AcquiredSemaphoreEvent = SemaphoreEventBase;
+/**
+ * The event is dispatched when a semaphore slot is released.
+ * Note this event is only dispatched when the semaphore slot is released and not when the semaphore slot expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type ReleasedSemaphoreEvent = SemaphoreEventBase;
+/**
+ * The event is dispatched when all slot of semapahore are released.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type AllForceReleasedSemaphoreEvent = SemaphoreEventBase & {
+    hasReleased: boolean;
+};
+/**
+ * The error is dispatched when trying to referesh a semaphore slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type FailedRefreshSemaphoreEvent = SemaphoreEventBase;
+/**
+ * The error is dispatched when trying to release a semaphore slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type FailedReleaseSemaphoreEvent = SemaphoreEventBase;
+/**
+ * The event is dispatched when trying to acquire a semaphore slot when all slots are unavailable.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type LimitReachedSemaphoreEvent = SemaphoreEventBase;
+/**
+ * The event is dispatched when a semaphore slot is refreshed.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type RefreshedSemaphoreEvent = SemaphoreEventBase;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type UnexpectedErrorSemaphoreEvent = SemaphoreEventBase & {
+    error: unknown;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export declare const SEMAPHORE_EVENTS: {
+    readonly ACQUIRED: "ACQUIRED";
+    readonly RELEASED: "RELEASED";
+    readonly ALL_FORCE_RELEASED: "ALL_FORCE_RELEASED";
+    readonly FAILED_RELEASE: "FAILED_RELEASE";
+    readonly FAILED_REFRESH: "FAILED_REFRESH";
+    readonly LIMIT_REACHED: "LIMIT_REACHED";
+    readonly REFRESHED: "REFRESHED";
+    readonly UNEXPECTED_ERROR: "UNEXPECTED_ERROR";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export type SemaphoreEventMap = {
+    [SEMAPHORE_EVENTS.ACQUIRED]: AcquiredSemaphoreEvent;
+    [SEMAPHORE_EVENTS.RELEASED]: ReleasedSemaphoreEvent;
+    [SEMAPHORE_EVENTS.ALL_FORCE_RELEASED]: AllForceReleasedSemaphoreEvent;
+    [SEMAPHORE_EVENTS.FAILED_RELEASE]: FailedReleaseSemaphoreEvent;
+    [SEMAPHORE_EVENTS.FAILED_REFRESH]: FailedRefreshSemaphoreEvent;
+    [SEMAPHORE_EVENTS.LIMIT_REACHED]: LimitReachedSemaphoreEvent;
+    [SEMAPHORE_EVENTS.REFRESHED]: RefreshedSemaphoreEvent;
+    [SEMAPHORE_EVENTS.UNEXPECTED_ERROR]: UnexpectedErrorSemaphoreEvent;
+};

package/dist/semaphore/contracts/semaphore.events.js

@@ -0,0 +1,19 @@
+/**
+ * @module Semaphore
+ */
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Events
+ */
+export const SEMAPHORE_EVENTS = {
+    ACQUIRED: "ACQUIRED",
+    RELEASED: "RELEASED",
+    ALL_FORCE_RELEASED: "ALL_FORCE_RELEASED",
+    FAILED_RELEASE: "FAILED_RELEASE",
+    FAILED_REFRESH: "FAILED_REFRESH",
+    LIMIT_REACHED: "LIMIT_REACHED",
+    REFRESHED: "REFRESHED",
+    UNEXPECTED_ERROR: "UNEXPECTED_ERROR",
+};
+//# sourceMappingURL=semaphore.events.js.map

package/dist/semaphore/contracts/semaphore.events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semaphore.events.js","sourceRoot":"","sources":["../../../src/semaphore/contracts/semaphore.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAgFH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,kBAAkB,EAAE,oBAAoB;IACxC,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC"}

package/dist/semaphore/contracts/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module Semaphore
+ */
+import type { IDatabaseSemaphoreAdapter } from "../../semaphore/contracts/database-semaphore-adapter.contract.js";
+import type { ISemaphoreAdapter } from "../../semaphore/contracts/semaphore-adapter.contract.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/contracts"`
+ * @group Contracts
+ */
+export type SemaphoreAdapterVariants = ISemaphoreAdapter | IDatabaseSemaphoreAdapter;

package/dist/semaphore/contracts/types.js

@@ -0,0 +1,5 @@
+/**
+ * @module Semaphore
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/semaphore/contracts/types.js.map

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

package/dist/semaphore/implementations/adapters/_module-exports.d.ts

@@ -0,0 +1,5 @@
+export * from "../../../semaphore/implementations/adapters/kysely-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/memory-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/mongodb-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/no-op-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/redis-semaphore-adapter/_module.js";

package/dist/semaphore/implementations/adapters/_module-exports.js

@@ -0,0 +1,6 @@
+export * from "../../../semaphore/implementations/adapters/kysely-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/memory-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/mongodb-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/no-op-semaphore-adapter/_module.js";
+export * from "../../../semaphore/implementations/adapters/redis-semaphore-adapter/_module.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/semaphore/implementations/adapters/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/semaphore/implementations/adapters/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,0EAA0E,CAAC;AACzF,cAAc,0EAA0E,CAAC;AACzF,cAAc,2EAA2E,CAAC;AAC1F,cAAc,yEAAyE,CAAC;AACxF,cAAc,yEAAyE,CAAC"}

package/dist/semaphore/implementations/adapters/kysely-semaphore-adapter/_module.d.ts

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

package/dist/semaphore/implementations/adapters/kysely-semaphore-adapter/_module.js

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

package/dist/semaphore/implementations/adapters/kysely-semaphore-adapter/_module.js.map

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

package/dist/semaphore/implementations/adapters/kysely-semaphore-adapter/kysely-semaphore-adapter.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @module Semaphore
+ */
+import type { IDatabaseSemaphoreTransaction, IDatabaseSemaphoreAdapter, ISemaphoreSlotExpirationData } from "../../../../semaphore/contracts/_module-exports.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module-exports.js";
+import { type IDeinitizable, type IInitizable, type InvokableFn, type IPrunable } from "../../../../utilities/_module-exports.js";
+import { type Kysely } from "kysely";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/adapters"`
+ * @group Adapters
+ */
+export type KyselySemaphoreTable = {
+    key: string;
+    limit: number;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/adapters"`
+ * @group Adapters
+ */
+export type KyselySemaphoreSlotTable = {
+    id: string;
+    key: string;
+    expiration: number | string | null;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/adapters"`
+ * @group Adapters
+ */
+export type KyselySemaphoreTables = {
+    semaphore: KyselySemaphoreTable;
+    semaphoreSlot: KyselySemaphoreSlotTable;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/adapters"`
+ * @group Adapters
+ */
+export type KyselySemaphoreAdapterSettings = {
+    kysely: Kysely<KyselySemaphoreTables>;
+    /**
+     * @default
+     * ```ts
+     * TimeSpan.fromMinutes(1)
+     * ```
+     */
+    expiredKeysRemovalInterval?: TimeSpan;
+    /**
+     * @default true
+     */
+    shouldRemoveExpiredKeys?: boolean;
+};
+/**
+ * To utilize the `KyselySemaphoreAdapter`, you must install the [`"kysely"`](https://www.npmjs.com/package/kysely) package and configure a `Kysely` class instance.
+ *
+ * Note in order to use `KyselySemaphoreAdapter` correctly, ensure you use a single, consistent database across all server instances.
+ * The adapter have been tested with `sqlite`, `postgres` and `mysql` databases.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/semaphore/adapters"`
+ * @group Adapters
+ */
+export declare class KyselySemaphoreAdapter implements IDatabaseSemaphoreAdapter, IDeinitizable, IInitizable, IPrunable {
+    private readonly kysely;
+    private readonly expiredKeysRemovalInterval;
+    private readonly shouldRemoveExpiredKeys;
+    private intervalId;
+    private readonly isMysql;
+    /**
+     * @example
+     * ```ts
+     * import { KyselySemaphoreAdapter } from "@daiso-tech/core/semaphore/adapters";
+     * import Sqlite from "better-sqlite3";
+     *
+     * const semaphoreAdapter = new KyselySemaphoreAdapter({
+     *   kysely: new Kysely({
+     *     dialect: new SqliteDialect({
+     *       database: new Sqlite("local.db"),
+     *     }),
+     *   }),
+     * });
+     * // You need initialize the adapter once before using it.
+     * await semaphoreAdapter.init();
+     * ```
+     */
+    constructor(settings: KyselySemaphoreAdapterSettings);
+    init(): Promise<void>;
+    deInit(): Promise<void>;
+    removeAllExpired(): Promise<void>;
+    transaction<TValue>(fn: InvokableFn<[
+        methods: IDatabaseSemaphoreTransaction
+    ], Promise<TValue>>): Promise<TValue>;
+    removeSlot(key: string, slotId: string): Promise<ISemaphoreSlotExpirationData | null>;
+    removeAllSlots(key: string): Promise<ISemaphoreSlotExpirationData[]>;
+    updateExpiration(key: string, slotId: string, expiration: Date): Promise<number>;
+}