@daiso-tech/core 0.40.0 → 0.41.0

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

@@ -2,58 +2,51 @@
  * @module Lock
  */
 /**
+ * The error is thrown when trying to acquire a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export declare class LockError extends Error {
+export declare class FailedAcquireLockError extends Error {
     constructor(message: string, cause?: unknown);
 }
 /**
- * The error is thrown when trying to acquire a lock that is owned by a different owner.
+ * The error is thrown when trying to release a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export declare class KeyAlreadyAcquiredLockError extends LockError {
+export declare class FailedReleaseLockError extends Error {
     constructor(message: string, cause?: unknown);
 }
 /**
- * The error is thrown when trying to release a lock that is owned by a different owner.
+ * The error is thrown when trying to referesh a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export declare class UnownedReleaseLockError extends LockError {
+export declare class FailedRefreshLockError extends Error {
     constructor(message: string, cause?: unknown);
 }
 /**
- * The error is thrown when trying to referesh a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export declare class UnownedRefreshLockError extends LockError {
-    constructor(message: string, cause?: unknown);
-}
+export declare const LOCK_ERRORS: {
+    readonly FailedAcquire: typeof FailedAcquireLockError;
+    readonly FailedRelease: typeof FailedReleaseLockError;
+    readonly FailedRefresh: typeof FailedRefreshLockError;
+};
 /**
- * The error is thrown when trying to referesh a lock that is unexpireable.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export declare class UnrefreshableKeyLockError extends LockError {
-    constructor(message: string, cause?: unknown);
-}
+export type AllLockErrors = FailedAcquireLockError | FailedReleaseLockError | FailedRefreshLockError;
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export declare const LOCK_ERRORS: {
-    readonly Base: typeof LockError;
-    readonly UnrefreshableKey: typeof UnrefreshableKeyLockError;
-    readonly KeyAlreadyAcquired: typeof KeyAlreadyAcquiredLockError;
-    readonly UnownedRelease: typeof UnownedReleaseLockError;
-    readonly UnownedRefresh: typeof UnownedRefreshLockError;
-};
+export declare function isLockError(value: unknown): value is AllLockErrors;

package/dist/lock/contracts/lock.errors.js

@@ -1,25 +1,16 @@
 /**
  * @module Lock
  */
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
- * @group Errors
- */
-export class LockError extends Error {
-    constructor(message, cause) {
-        super(message, { cause });
-    }
-}
 /**
  * The error is thrown when trying to acquire a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export class KeyAlreadyAcquiredLockError extends LockError {
+export class FailedAcquireLockError extends Error {
     constructor(message, cause) {
         super(message, { cause });
+        this.name = FailedAcquireLockError.name;
     }
 }
 /**
@@ -28,9 +19,10 @@ export class KeyAlreadyAcquiredLockError extends LockError {
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export class UnownedReleaseLockError extends LockError {
+export class FailedReleaseLockError extends Error {
     constructor(message, cause) {
         super(message, { cause });
+        this.name = FailedReleaseLockError.name;
     }
 }
 /**
@@ -39,32 +31,33 @@ export class UnownedReleaseLockError extends LockError {
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export class UnownedRefreshLockError extends LockError {
+export class FailedRefreshLockError extends Error {
     constructor(message, cause) {
         super(message, { cause });
+        this.name = FailedRefreshLockError.name;
     }
 }
 /**
- * The error is thrown when trying to referesh a lock that is unexpireable.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export class UnrefreshableKeyLockError extends LockError {
-    constructor(message, cause) {
-        super(message, { cause });
-    }
-}
+export const LOCK_ERRORS = {
+    FailedAcquire: FailedAcquireLockError,
+    FailedRelease: FailedReleaseLockError,
+    FailedRefresh: FailedRefreshLockError,
+};
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Errors
  */
-export const LOCK_ERRORS = {
-    Base: LockError,
-    UnrefreshableKey: UnrefreshableKeyLockError,
-    KeyAlreadyAcquired: KeyAlreadyAcquiredLockError,
-    UnownedRelease: UnownedReleaseLockError,
-    UnownedRefresh: UnownedRefreshLockError,
-};
+export function isLockError(value) {
+    for (const ErrorClass of Object.values(LOCK_ERRORS)) {
+        if (!(value instanceof ErrorClass)) {
+            return false;
+        }
+    }
+    return true;
+}
 //# sourceMappingURL=lock.errors.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"lock.errors.js","sourceRoot":"","sources":["../../../src/lock/contracts/lock.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAChC,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,SAAS;IACtD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;IAClD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,SAAS;IAClD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IACpD,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,IAAI,EAAE,SAAS;IACf,gBAAgB,EAAE,yBAAyB;IAC3C,kBAAkB,EAAE,2BAA2B;IAC/C,cAAc,EAAE,uBAAuB;IACvC,cAAc,EAAE,uBAAuB;CACjC,CAAC"}
+{"version":3,"file":"lock.errors.js","sourceRoot":"","sources":["../../../src/lock/contracts/lock.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC;IAC5C,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC;IAC5C,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC;IAC5C,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,aAAa,EAAE,sBAAsB;IACrC,aAAa,EAAE,sBAAsB;IACrC,aAAa,EAAE,sBAAsB;CAC/B,CAAC;AAYX;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACtC,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QAClD,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/lock/contracts/lock.events.d.ts

@@ -1,97 +1,71 @@
 /**
  * @module Lock
  */
-import type { TimeSpan } from "../../utilities/_module-exports.js";
+import type { ILockStateMethods } from "../../lock/contracts/lock.contract.js";
 /**
- * The event is dispatched when a lock is aquired.
- *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type AcquiredLockEvent = {
-    key: string;
-    owner: string;
-    ttl: TimeSpan | null;
+export type LockEventBase = {
+    lock: ILockStateMethods;
 };
 /**
- * The event is dispatched when a lock is released.
+ * The event is dispatched when a lock is aquired.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type ReleasedLockEvent = {
-    key: string;
-    owner: string;
-};
+export type AcquiredLockEvent = LockEventBase;
 /**
- * The event is dispatched when a lock is forcefully released.
+ * The event is dispatched when a lock is released.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type ForceReleasedLockEvent = {
-    key: string;
-};
+export type ReleasedLockEvent = LockEventBase;
 /**
- * The event is dispatched when trying to release a lock that is owned by a different owner.
+ * The event is dispatched when a lock is forcefully released.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type UnownedReleaseTryLockEvent = {
-    key: string;
-    owner: string;
+export type ForceReleasedLockEvent = LockEventBase & {
+    hasReleased: boolean;
 };
 /**
- * The event is dispatched when trying to refefresh a lock that is owned by a different owner.
+ * The event is dispatched when trying to release a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type UnownedRefreshTryLockEvent = {
-    key: string;
-    owner: string;
-};
+export type FailedReleaseLockEvent = LockEventBase;
 /**
- * The event is dispatched when trying to refefresh a lock that is unexpireable.
+ * The event is dispatched when trying to refefresh a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type UnexpireableKeyRefreshTryLockEvent = {
-    key: string;
-    owner: string;
-};
+export type FailedRefreshLockEvent = LockEventBase;
 /**
  * The event is dispatched when trying to acquire a lock that is owned by a different owner.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type UnavailableLockEvent = {
-    key: string;
-    owner: string;
-};
+export type UnavailableLockEvent = LockEventBase;
 /**
  * The event is dispatched when a lock is refreshed.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type RefreshedLockEvent = {
-    key: string;
-    owner: string;
-    ttl: TimeSpan;
-};
+export type RefreshedLockEvent = LockEventBase;
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
  * @group Events
  */
-export type UnexpectedErrorLockEvent = {
-    key: string;
-    owner: string;
-    ttl: TimeSpan | null;
+export type UnexpectedErrorLockEvent = LockEventBase & {
     error: unknown;
 };
 /**
@@ -102,9 +76,8 @@ export type UnexpectedErrorLockEvent = {
 export declare const LOCK_EVENTS: {
     readonly ACQUIRED: "ACQUIRED";
     readonly RELEASED: "RELEASED";
-    readonly UNOWNED_RELEASE_TRY: "UNOWNED_RELEASE_TRY";
-    readonly UNOWNED_REFRESH_TRY: "UNOWNED_REFRESH_TRY";
-    readonly UNEXPIREABLE_KEY_REFRESH_TRY: "UNEXPIREABLE_KEY_REFRESH_TRY";
+    readonly FAILED_RELEASE: "FAILED_RELEASE";
+    readonly FAILED_REFRESH: "FAILED_REFRESH";
     readonly UNAVAILABLE: "UNAVAILABLE";
     readonly FORCE_RELEASED: "FORCE_RELEASED";
     readonly REFRESHED: "REFRESHED";
@@ -118,9 +91,8 @@ export declare const LOCK_EVENTS: {
 export type LockEventMap = {
     [LOCK_EVENTS.ACQUIRED]: AcquiredLockEvent;
     [LOCK_EVENTS.RELEASED]: ReleasedLockEvent;
-    [LOCK_EVENTS.UNOWNED_RELEASE_TRY]: UnownedReleaseTryLockEvent;
-    [LOCK_EVENTS.UNOWNED_REFRESH_TRY]: UnownedRefreshTryLockEvent;
-    [LOCK_EVENTS.UNEXPIREABLE_KEY_REFRESH_TRY]: UnexpireableKeyRefreshTryLockEvent;
+    [LOCK_EVENTS.FAILED_RELEASE]: FailedReleaseLockEvent;
+    [LOCK_EVENTS.FAILED_REFRESH]: FailedRefreshLockEvent;
     [LOCK_EVENTS.UNAVAILABLE]: UnavailableLockEvent;
     [LOCK_EVENTS.FORCE_RELEASED]: ForceReleasedLockEvent;
     [LOCK_EVENTS.REFRESHED]: RefreshedLockEvent;

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

@@ -9,9 +9,8 @@
 export const LOCK_EVENTS = {
     ACQUIRED: "ACQUIRED",
     RELEASED: "RELEASED",
-    UNOWNED_RELEASE_TRY: "UNOWNED_RELEASE_TRY",
-    UNOWNED_REFRESH_TRY: "UNOWNED_REFRESH_TRY",
-    UNEXPIREABLE_KEY_REFRESH_TRY: "UNEXPIREABLE_KEY_REFRESH_TRY",
+    FAILED_RELEASE: "FAILED_RELEASE",
+    FAILED_REFRESH: "FAILED_REFRESH",
     UNAVAILABLE: "UNAVAILABLE",
     FORCE_RELEASED: "FORCE_RELEASED",
     REFRESHED: "REFRESHED",

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

@@ -1 +1 @@
-{"version":3,"file":"lock.events.js","sourceRoot":"","sources":["../../../src/lock/contracts/lock.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AA2GH;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,mBAAmB,EAAE,qBAAqB;IAC1C,mBAAmB,EAAE,qBAAqB;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,gBAAgB;IAChC,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC"}
+{"version":3,"file":"lock.events.js","sourceRoot":"","sources":["../../../src/lock/contracts/lock.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAiFH;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,gBAAgB;IAChC,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC"}

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

@@ -0,0 +1,11 @@
+/**
+ * @module Lock
+ */
+import type { IDatabaseLockAdapter } from "../../lock/contracts/database-lock-adapter.contract.js";
+import type { ILockAdapter } from "../../lock/contracts/lock-adapter.contract.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/lock/contracts"`
+ * @group Contracts
+ */
+export type LockAdapterVariants = ILockAdapter | IDatabaseLockAdapter;

package/dist/lock/contracts/types.js

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

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

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

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

@@ -1,15 +1,16 @@
 /**
  * @module Lock
  */
-import type { IDatabaseLockAdapter, ILockData, ILockExpirationData } from "../../../../lock/contracts/_module-exports.js";
+import type { IDatabaseLockAdapter, IDatabaseLockTransaction, ILockData, ILockExpirationData } from "../../../../lock/contracts/_module-exports.js";
 import { type Kysely } from "kysely";
-import { type IDeinitizable, type IInitizable, type IPrunable, TimeSpan } from "../../../../utilities/_module-exports.js";
+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/lock/adapters"`
  * @group Adapters
  */
-export type KyselyLockAdapterTable = {
+export type KyselyLockTable = {
     key: string;
     owner: string;
     expiration: number | bigint | string | null;
@@ -19,8 +20,8 @@ export type KyselyLockAdapterTable = {
  * IMPORT_PATH: `"@daiso-tech/core/lock/adapters"`
  * @group Adapters
  */
-export type KyselyLockAdapterTables = {
-    lock: KyselyLockAdapterTable;
+export type KyselyLockTables = {
+    lock: KyselyLockTable;
 };
 /**
  *
@@ -28,7 +29,7 @@ export type KyselyLockAdapterTables = {
  * @group Adapters
  */
 export type KyselyLockAdapterSettings = {
-    kysely: Kysely<KyselyLockAdapterTables>;
+    kysely: Kysely<KyselyLockTables>;
     /**
      * @default
      * ```ts
@@ -47,13 +48,6 @@ export type KyselyLockAdapterSettings = {
      * ```
      */
     currentDate?: () => Date;
-    /**
-     * @default
-     * ```ts
-     * globalThis.setInterval
-     * ```
-     */
-    setInterval?: typeof setInterval;
 };
 /**
  * To utilize the `KyselyLockAdapter`, you must install the [`"kysely"`](https://www.npmjs.com/package/kysely) package and configure a `Kysely` class instance.
@@ -68,9 +62,8 @@ export declare class KyselyLockAdapter implements IDatabaseLockAdapter, IDeiniti
     private readonly kysely;
     private readonly expiredKeysRemovalInterval;
     private readonly shouldRemoveExpiredKeys;
-    private timeoutId;
+    private intervalId;
     private readonly currentDate;
-    private readonly setInterval;
     private readonly isMysql;
     /**
      * @example
@@ -90,13 +83,22 @@ export declare class KyselyLockAdapter implements IDatabaseLockAdapter, IDeiniti
      * ```
      */
     constructor(settings: KyselyLockAdapterSettings);
+    /**
+     * Removes all related lock tables and their rows.
+     * Note all lock data will be removed.
+     */
     deInit(): Promise<void>;
+    /**
+     * Creates all related tables and indexes.
+     * Note the `init` method needs to be called once before using the adapter.
+     */
     init(): Promise<void>;
     removeAllExpired(): Promise<void>;
-    insert(key: string, owner: string, expiration: Date | null): Promise<void>;
-    updateIfExpired(key: string, owner: string, expiration: Date | null): Promise<number>;
+    transaction<TReturn>(fn: InvokableFn<[
+        transaction: IDatabaseLockTransaction
+    ], Promise<TReturn>>): Promise<TReturn>;
     remove(key: string): Promise<ILockExpirationData | null>;
-    removeIfOwner(key: string, owner: string): Promise<ILockData | null>;
-    updateExpirationIfOwner(key: string, owner: string, expiration: Date): Promise<number>;
+    removeIfOwner(key: string, lockId: string): Promise<ILockData | null>;
+    updateExpiration(key: string, lockId: string, expiration: Date): Promise<number>;
     find(key: string): Promise<ILockData | null>;
 }