@daiso-tech/core 0.39.0 → 0.41.0

package/dist/shared-lock/contracts/shared-lock.events.d.ts

@@ -0,0 +1,205 @@
+/**
+ * @module SharedLock
+ */
+import type { ISharedLockStateMethods } from "../../shared-lock/contracts/shared-lock.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type LockEventBase = {
+    sharedLock: ISharedLockStateMethods;
+};
+/**
+ * The event is dispatched when a lock is aquired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type AcquiredWriterLockEvent = LockEventBase;
+/**
+ * The event is dispatched when a lock is released.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type ReleasedWriterLockEvent = LockEventBase;
+/**
+ * The event is dispatched when a lock is forcefully released.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type ForceReleasedWriterLockEvent = LockEventBase & {
+    hasReleased: boolean;
+};
+/**
+ * The event is dispatched when trying to release a lock that is owned by a different owner.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type FailedReleaseWriterLockEvent = LockEventBase;
+/**
+ * The event is dispatched when trying to refefresh a lock that is owned by a different owner.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type FailedRefreshWriterLockEvent = LockEventBase;
+/**
+ * The event is dispatched when
+ * 1. Trying to acquire the shared lock as writer when in reader mode.
+ * 2. Trying to acquire the shared lock as reader when in writer mode.
+ * 3. trying to acquire a shared lock that is owned by a different owner.
+ * 4. Trying to acquire the shared lock as reader when limit is reached.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type UnavailableSharedLockEvent = LockEventBase;
+/**
+ * The event is dispatched when a lock is refreshed.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type RefreshedWriterLockEvent = LockEventBase;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export declare const WRITER_LOCK_EVENTS: {
+    readonly WRITER_ACQUIRED: "WRITER_ACQUIRED";
+    readonly WRITER_RELEASED: "WRITER_RELEASED";
+    readonly WRITER_FAILED_RELEASE: "WRITER_FAILED_RELEASE";
+    readonly WRITER_FAILED_REFRESH: "WRITER_FAILED_REFRESH";
+    readonly WRITER_FORCE_RELEASED: "WRITER_FORCE_RELEASED";
+    readonly WRITER_REFRESHED: "WRITER_REFRESHED";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type WriterLockEventMap = {
+    [WRITER_LOCK_EVENTS.WRITER_ACQUIRED]: AcquiredWriterLockEvent;
+    [WRITER_LOCK_EVENTS.WRITER_RELEASED]: ReleasedWriterLockEvent;
+    [WRITER_LOCK_EVENTS.WRITER_FAILED_RELEASE]: FailedReleaseWriterLockEvent;
+    [WRITER_LOCK_EVENTS.WRITER_FAILED_REFRESH]: FailedRefreshWriterLockEvent;
+    [WRITER_LOCK_EVENTS.WRITER_FORCE_RELEASED]: ForceReleasedWriterLockEvent;
+    [WRITER_LOCK_EVENTS.WRITER_REFRESHED]: RefreshedWriterLockEvent;
+};
+/**
+ * The event is dispatched when a lock slot is aquired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type AcquiredReaderSemaphoreEvent = LockEventBase;
+/**
+ * The event is dispatched when a lock slot is released.
+ * Note this event is only dispatched when the shared lock slot is released and not when the shared lock slot expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type ReleasedReaderSemaphoreEvent = LockEventBase;
+/**
+ * The event is dispatched when all slot of semapahore are released.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type AllForceReleasedReaderSemaphoreEvent = LockEventBase & {
+    hasReleased: boolean;
+};
+/**
+ * The error is dispatched when trying to referesh a lock slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type FailedRefreshReaderSemaphoreEvent = LockEventBase;
+/**
+ * The error is dispatched when trying to release a lock slot that is already expired.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type FailedReleaseReaderSemaphoreEvent = LockEventBase;
+/**
+ * The event is dispatched when a lock slot is refreshed.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type RefreshedReaderSemaphoreEvent = LockEventBase;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export declare const READER_SEMAPHORE_EVENTS: {
+    readonly READER_ACQUIRED: "READER_ACQUIRED";
+    readonly READER_RELEASED: "READER_RELEASED";
+    readonly READER_ALL_FORCE_RELEASED: "READER_ALL_FORCE_RELEASED";
+    readonly READER_FAILED_RELEASE: "READER_FAILED_RELEASE";
+    readonly READER_FAILED_REFRESH: "READER_FAILED_REFRESH";
+    readonly READER_LIMIT_REACHED: "READER_LIMIT_REACHED";
+    readonly READER_REFRESHED: "READER_REFRESHED";
+    readonly READER_UNEXPECTED_ERROR: "READER_UNEXPECTED_ERROR";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type ReaderSemaphoreEventMap = {
+    [READER_SEMAPHORE_EVENTS.READER_ACQUIRED]: AcquiredReaderSemaphoreEvent;
+    [READER_SEMAPHORE_EVENTS.READER_RELEASED]: ReleasedReaderSemaphoreEvent;
+    [READER_SEMAPHORE_EVENTS.READER_ALL_FORCE_RELEASED]: AllForceReleasedReaderSemaphoreEvent;
+    [READER_SEMAPHORE_EVENTS.READER_FAILED_RELEASE]: FailedReleaseReaderSemaphoreEvent;
+    [READER_SEMAPHORE_EVENTS.READER_FAILED_REFRESH]: FailedRefreshReaderSemaphoreEvent;
+    [READER_SEMAPHORE_EVENTS.READER_REFRESHED]: RefreshedReaderSemaphoreEvent;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type UnexpectedErrorSharedLockEvent = LockEventBase & {
+    error: unknown;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export declare const SHARED_LOCK_EVENTS: {
+    readonly UNEXPECTED_ERROR: "UNEXPECTED_ERROR";
+    readonly UNAVAILABLE: "UNAVAILABLE";
+    readonly WRITER_ACQUIRED: "WRITER_ACQUIRED";
+    readonly WRITER_RELEASED: "WRITER_RELEASED";
+    readonly WRITER_FAILED_RELEASE: "WRITER_FAILED_RELEASE";
+    readonly WRITER_FAILED_REFRESH: "WRITER_FAILED_REFRESH";
+    readonly WRITER_FORCE_RELEASED: "WRITER_FORCE_RELEASED";
+    readonly WRITER_REFRESHED: "WRITER_REFRESHED";
+    readonly READER_ACQUIRED: "READER_ACQUIRED";
+    readonly READER_RELEASED: "READER_RELEASED";
+    readonly READER_ALL_FORCE_RELEASED: "READER_ALL_FORCE_RELEASED";
+    readonly READER_FAILED_RELEASE: "READER_FAILED_RELEASE";
+    readonly READER_FAILED_REFRESH: "READER_FAILED_REFRESH";
+    readonly READER_LIMIT_REACHED: "READER_LIMIT_REACHED";
+    readonly READER_REFRESHED: "READER_REFRESHED";
+    readonly READER_UNEXPECTED_ERROR: "READER_UNEXPECTED_ERROR";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export type SharedLockEventMap = ReaderSemaphoreEventMap & WriterLockEventMap & {
+    [SHARED_LOCK_EVENTS.UNEXPECTED_ERROR]: UnexpectedErrorSharedLockEvent;
+    [SHARED_LOCK_EVENTS.UNAVAILABLE]: UnavailableSharedLockEvent;
+};

package/dist/shared-lock/contracts/shared-lock.events.js

@@ -0,0 +1,43 @@
+/**
+ * @module SharedLock
+ */
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export const WRITER_LOCK_EVENTS = {
+    WRITER_ACQUIRED: "WRITER_ACQUIRED",
+    WRITER_RELEASED: "WRITER_RELEASED",
+    WRITER_FAILED_RELEASE: "WRITER_FAILED_RELEASE",
+    WRITER_FAILED_REFRESH: "WRITER_FAILED_REFRESH",
+    WRITER_FORCE_RELEASED: "WRITER_FORCE_RELEASED",
+    WRITER_REFRESHED: "WRITER_REFRESHED",
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export const READER_SEMAPHORE_EVENTS = {
+    READER_ACQUIRED: "READER_ACQUIRED",
+    READER_RELEASED: "READER_RELEASED",
+    READER_ALL_FORCE_RELEASED: "READER_ALL_FORCE_RELEASED",
+    READER_FAILED_RELEASE: "READER_FAILED_RELEASE",
+    READER_FAILED_REFRESH: "READER_FAILED_REFRESH",
+    READER_LIMIT_REACHED: "READER_LIMIT_REACHED",
+    READER_REFRESHED: "READER_REFRESHED",
+    READER_UNEXPECTED_ERROR: "READER_UNEXPECTED_ERROR",
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Events
+ */
+export const SHARED_LOCK_EVENTS = {
+    ...READER_SEMAPHORE_EVENTS,
+    ...WRITER_LOCK_EVENTS,
+    UNEXPECTED_ERROR: "UNEXPECTED_ERROR",
+    UNAVAILABLE: "UNAVAILABLE",
+};
+//# sourceMappingURL=shared-lock.events.js.map

package/dist/shared-lock/contracts/shared-lock.events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-lock.events.js","sourceRoot":"","sources":["../../../src/shared-lock/contracts/shared-lock.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AA0EH;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B,eAAe,EAAE,iBAAiB;IAClC,eAAe,EAAE,iBAAiB;IAClC,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC;AAoEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACnC,eAAe,EAAE,iBAAiB;IAClC,eAAe,EAAE,iBAAiB;IAClC,yBAAyB,EAAE,2BAA2B;IACtD,qBAAqB,EAAE,uBAAuB;IAC9C,qBAAqB,EAAE,uBAAuB;IAC9C,oBAAoB,EAAE,sBAAsB;IAC5C,gBAAgB,EAAE,kBAAkB;IACpC,uBAAuB,EAAE,yBAAyB;CAC5C,CAAC;AAyBX;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B,GAAG,uBAAuB;IAC1B,GAAG,kBAAkB;IACrB,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;CACpB,CAAC"}

package/dist/shared-lock/contracts/types.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @module SharedLock
+ */
+import type { IDatabaseSharedLockAdapter } from "../../shared-lock/contracts/database-shared-lock-adapter.contract.js";
+import type { ISharedLockAdapter } from "../../shared-lock/contracts/shared-lock-adapter.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/contracts"`
+ * @group Contracts
+ */
+export type SharedLockAdapterVariants = ISharedLockAdapter | IDatabaseSharedLockAdapter;

package/dist/shared-lock/contracts/types.js

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

package/dist/shared-lock/contracts/types.js.map

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

package/dist/shared-lock/implementations/adapters/_module-exports.d.ts

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

package/dist/shared-lock/implementations/adapters/_module-exports.js

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

package/dist/shared-lock/implementations/adapters/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/shared-lock/implementations/adapters/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,8EAA8E,CAAC;AAC7F,cAAc,8EAA8E,CAAC;AAC7F,cAAc,+EAA+E,CAAC;AAC9F,cAAc,6EAA6E,CAAC;AAC5F,cAAc,6EAA6E,CAAC"}

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

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

package/dist/shared-lock/implementations/adapters/kysely-shared-lock-adapter/_module.js

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

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

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

package/dist/shared-lock/implementations/adapters/kysely-shared-lock-adapter/kysely-shared-lock-adapter.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @module SharedLock
+ */
+import type { IDatabaseSharedLockAdapter, IDatabaseSharedLockTransaction } from "../../../../shared-lock/contracts/_module-exports.js";
+import { type Kysely } from "kysely";
+import { type IDeinitizable, type IInitizable, type InvokableFn, type IPrunable } from "../../../../utilities/_module-exports.js";
+import { TimeSpan } from "../../../../time-span/implementations/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/adapters"`
+ * @group Adapters
+ */
+export type KyselyWriterLockTable = {
+    key: string;
+    owner: string;
+    expiration: number | bigint | string | null;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/adapters"`
+ * @group Adapters
+ */
+export type KyselyReaderSemaphoreTable = {
+    key: string;
+    limit: number;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/adapters"`
+ * @group Adapters
+ */
+export type KyselyReaderSemaphoreSlotTable = {
+    id: string;
+    key: string;
+    expiration: number | string | null;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/adapters"`
+ * @group Adapters
+ */
+export type KyselySharedLockTables = {
+    writerLock: KyselyWriterLockTable;
+    readerSemaphore: KyselyReaderSemaphoreTable;
+    readerSemaphoreSlot: KyselyReaderSemaphoreSlotTable;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/adapters"`
+ * @group Adapters
+ */
+export type KyselySharedLockAdapterSettings = {
+    kysely: Kysely<KyselySharedLockTables>;
+    /**
+     * @default
+     * ```ts
+     * TimeSpan.fromMinutes(1)
+     * ```
+     */
+    expiredKeysRemovalInterval?: TimeSpan;
+    /**
+     * @default true
+     */
+    shouldRemoveExpiredKeys?: boolean;
+    /**
+     *  @default
+     * ```ts
+     * () => new Date()
+     * ```
+     */
+    currentDate?: () => Date;
+};
+/**
+ * To utilize the `KyselySharedLockAdapter`, you must install the [`"kysely"`](https://www.npmjs.com/package/kysely) package and configure a `Kysely` class instance.
+ *
+ * Note in order to use `KyselySharedLockAdapter` 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/shared-lock/adapters"`
+ * @group Adapters
+ */
+export declare class KyselySharedLockAdapter implements IDatabaseSharedLockAdapter, IDeinitizable, IInitizable, IPrunable {
+    private readonly kysely;
+    private readonly expiredKeysRemovalInterval;
+    private readonly shouldRemoveExpiredKeys;
+    private intervalId;
+    private readonly currentDate;
+    /**
+     * @example
+     * ```ts
+     * import { KyselySharedLockAdapter } from "@daiso-tech/core/shared-lock/adapters";
+     * import Sqlite from "better-sqlite3";
+     *
+     * const lockAdapter = new KyselySharedLockAdapter({
+     *   kysely: new Kysely({
+     *     dialect: new SqliteDialect({
+     *       database: new Sqlite("local.db"),
+     *     }),
+     *   }),
+     * });
+     * // You need initialize the adapter once before using it.
+     * await lockAdapter.init();
+     * ```
+     */
+    constructor(settings: KyselySharedLockAdapterSettings);
+    init(): Promise<void>;
+    deInit(): Promise<void>;
+    private removeAllExpiredReaders;
+    private removeAllExpiredWriters;
+    removeAllExpired(): Promise<void>;
+    transaction<TReturn>(fn: InvokableFn<[
+        transaction: IDatabaseSharedLockTransaction
+    ], Promise<TReturn>>): Promise<TReturn>;
+}