@daiso-tech/core 0.22.2 → 0.23.0

package/dist/types/lock/implementations/adapters/sqlite-lock-adapter/sqlite-lock-adapter.d.ts

@@ -2,7 +2,7 @@
  * @module Lock
  */
 import type { IDatabaseLockAdapter, ILockData } from "../../../../lock/contracts/_module";
-import { TimeSpan } from "../../../../utilities/_module";
+import { type IDeinitizable, type IInitizable, TimeSpan } from "../../../../utilities/_module";
 import type { SqliteDatabase } from "kysely";
 /**
  * @group Adapters
@@ -17,7 +17,7 @@ export type SqliteLockAdapterSettings = {
 /**
  * @group Adapters
  */
-export declare class SqliteLockAdapter implements IDatabaseLockAdapter {
+export declare class SqliteLockAdapter implements IDatabaseLockAdapter, IDeinitizable, IInitizable {
     private databaseLockAdapter;
     /**
      * @example

package/dist/types/lock/implementations/derivables/lock-provider/database-lock-adapter.d.ts

@@ -1,22 +1,17 @@
 /**
  * @module Lock
  */
-import type { IDeinitizable, IInitizable } from "../../../../_module";
-import { TimeSpan } from "../../../../_module";
+import type { TimeSpan } from "../../../../_module";
 import type { IDatabaseLockAdapter, ILockAdapter } from "../../../../lock/contracts/_module";
 /**
  * @internal
  */
-export declare class DatabaseLockAdapter implements ILockAdapter, IDeinitizable, IInitizable {
+export declare class DatabaseLockAdapter implements ILockAdapter {
     private readonly adapter;
     constructor(adapter: IDatabaseLockAdapter);
-    init(): Promise<void>;
-    deInit(): Promise<void>;
     acquire(key: string, owner: string, ttl: TimeSpan | null): Promise<boolean>;
     release(key: string, owner: string): Promise<boolean>;
     forceRelease(key: string): Promise<void>;
-    isLocked(key: string): Promise<boolean>;
-    getRemainingTime(key: string): Promise<TimeSpan | null>;
     refresh(key: string, owner: string, ttl: TimeSpan): Promise<boolean>;
     getGroup(): string;
     withGroup(group: string): ILockAdapter;

package/dist/types/lock/implementations/derivables/lock-provider/lock-provider.d.ts

@@ -1,7 +1,6 @@
 /**
  * @module Lock
  */
-import type { ISerdeRegistrable } from "../../../../utilities/_module";
 import { TimeSpan, type OneOrMore } from "../../../../utilities/_module";
 import type { IDatabaseLockAdapter, LockEvents } from "../../../../lock/contracts/_module";
 import { type ILock, type IGroupableLockProvider, type LockProviderCreateSettings, type ILockProvider, type ILockAdapter } from "../../../../lock/contracts/_module";
@@ -18,6 +17,7 @@ export type LockProviderSettings = {
      */
     createOwnerId?: () => string;
     adapter: ILockAdapter | IDatabaseLockAdapter;
+    serde: OneOrMore<IFlexibleSerde>;
     /**
      * In order to listen to events of <i>{@link LockProvider}</i> class you must pass in <i>{@link IGroupableEventBus}</i>.
      */
@@ -57,10 +57,11 @@ export type LockProviderSettings = {
  * <i>LockProvider</i> class can be derived from any <i>{@link ILockAdapter}</i> or <i>{@link IDatabaseLockAdapter}</i>.
  * @group Derivables
  */
-export declare class LockProvider implements IGroupableLockProvider, ISerdeRegistrable, ISerdeTransformer<Lock, ISerializedLock> {
+export declare class LockProvider implements IGroupableLockProvider, ISerdeTransformer<Lock, ISerializedLock> {
     private static DEFAULT_TTL;
     private static DEFAULT_REFRESH_TIME;
     private static isDatabaseAdapter;
+    private readonly serde;
     private readonly createOwnerId;
     private readonly adapter;
     private readonly defaultTtl;
@@ -71,7 +72,7 @@ export declare class LockProvider implements IGroupableLockProvider, ISerdeRegis
     private readonly timeout;
     private readonly eventBus;
     private readonly lockProviderEventBus;
-    get name(): string;
+    private stateRecord;
     /**
      *@example
      * ```ts
@@ -80,19 +81,20 @@ export declare class LockProvider implements IGroupableLockProvider, ISerdeRegis
      * const eventBus = new EventBus({
      *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
      * });
+     * const serde = new SuperJsonSerde();
      * const lockProvider = new LockProvider({
+     *   serde,
      *   adapter: new MemoryLockAdapter({
      *     rootGroup: "@global"
      *   }),
      *   eventBus,
      * });
-     * const serde = new SuperJsonSerde();
-     * lockProvider.registerToSerde(serde);
      * registerLockEvents(serde);
      * reigsterLockErrors(serde);
      * ```
      */
     constructor(settings: LockProviderSettings);
+    private registerToSerde;
     addListener<TEventClass extends EventClass<LockEvents>>(event: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
     addListenerMany<TEventClass extends EventClass<LockEvents>>(events: TEventClass[], listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
     removeListener<TEventClass extends EventClass<LockEvents>>(event: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
@@ -100,15 +102,11 @@ export declare class LockProvider implements IGroupableLockProvider, ISerdeRegis
     listenOnce<TEventClass extends EventClass<LockEvents>>(event: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
     subscribe<TEventClass extends EventClass<LockEvents>>(event: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<Unsubscribe>;
     subscribeMany<TEventClass extends EventClass<LockEvents>>(events: TEventClass[], listener: Listener<EventInstance<TEventClass>>): LazyPromise<Unsubscribe>;
+    get name(): string;
     isApplicable(value: unknown): value is Lock;
     serialize(deserializedValue: Lock): ISerializedLock;
     deserialize(serializedValue: ISerializedLock): Lock;
     create(key: OneOrMore<string>, settings?: LockProviderCreateSettings): ILock;
     getGroup(): string;
     withGroup(group: OneOrMore<string>): ILockProvider;
-    /**
-     * The <i>registerToSerde</i> method ensures that the <i>ILock</i> instance returned by the <i>create</i> method is serializable.
-     * This method must be called once before using the <i>LockProvider</i> class.
-     */
-    registerToSerde(serde: OneOrMore<IFlexibleSerde>): void;
 }

package/dist/types/lock/implementations/derivables/lock-provider/lock-state.d.ts

@@ -0,0 +1,40 @@
+import { TimeSpan } from "../../../../utilities/_module";
+/**
+ * @internal
+ */
+export type ILockStateData = {
+    expiration: Date | null;
+};
+/**
+ * @internal
+ */
+export type ILockStateRecord = Partial<Record<string, ILockStateData>>;
+/**
+ * @internal
+ */
+export declare class LockState {
+    private stateRecord;
+    private readonly key;
+    constructor(stateRecord: ILockStateRecord, key: string);
+    /**
+     * Return the expiration as a date.
+     */
+    get(): Date | null;
+    /**
+     * Sets the expiration time.
+     * If a number is provided, it must be in milliseconds.
+     */
+    set(ttl: TimeSpan | number | null): void;
+    /**
+     * Checks if the key is expired.
+     */
+    isExpired(): boolean;
+    /**
+     * Returns the remaining time.
+     */
+    getRemainingTime(): TimeSpan | null;
+    /**
+     * Removes the expiration from the record.
+     */
+    remove(): void;
+}

package/dist/types/lock/implementations/derivables/lock-provider/lock.d.ts

@@ -8,6 +8,7 @@ import { LazyPromise } from "../../../../async/_module";
 import type { ILockAdapter, LockEvents } from "../../../../lock/contracts/_module";
 import { KeyAlreadyAcquiredLockError, type ILock } from "../../../../lock/contracts/_module";
 import type { EventClass, Listener, EventInstance, Unsubscribe, IGroupableEventBus, IEventDispatcher } from "../../../../event-bus/contracts/_module";
+import { type ILockStateRecord } from "../../../../lock/implementations/derivables/lock-provider/lock-state";
 /**
  * @group Derivables
  */
@@ -16,6 +17,7 @@ export type ISerializedLock = {
     key: string;
     owner: string;
     ttlInMs: number | null;
+    expirationInMs: number | null;
 };
 /**
  * @internal
@@ -28,12 +30,14 @@ export type LockSettings = {
     owner: string;
     defaultRefreshTime: TimeSpan;
     ttl: TimeSpan | null;
+    expirationInMs: number | null;
     lazyPromiseSettings: {
         retryAttempts: number | null;
         backoffPolicy: BackoffPolicy | null;
         retryPolicy: RetryPolicy | null;
         timeout: TimeSpan | null;
     };
+    stateRecord: ILockStateRecord;
 };
 /**
  * @internal
@@ -48,10 +52,12 @@ export declare class Lock implements ILock {
     private readonly ttl;
     private readonly defaultRefreshTime;
     private readonly lazyPromiseSettings;
+    private readonly state;
+    private readonly expirationInMs;
     constructor(settings: LockSettings);
     private createLayPromise;
-    run<TValue = void>(asyncFn: LazyPromiseable<TValue>, shouldTimeout?: boolean): LazyPromise<Result<TValue, KeyAlreadyAcquiredLockError>>;
-    runOrFail<TValue = void>(asyncFn: LazyPromiseable<TValue>, shouldTimeout?: boolean): LazyPromise<TValue>;
+    run<TValue = void>(asyncFn: LazyPromiseable<TValue>): LazyPromise<Result<TValue, KeyAlreadyAcquiredLockError>>;
+    runOrFail<TValue = void>(asyncFn: LazyPromiseable<TValue>): LazyPromise<TValue>;
     acquire(): LazyPromise<boolean>;
     acquireOrFail(): LazyPromise<void>;
     release(): LazyPromise<boolean>;

package/dist/types/utilities/contracts/_module.d.ts

@@ -2,4 +2,3 @@ export * from "../../utilities/contracts/serialized-error.contract";
 export * from "../../utilities/contracts/buildable.contract";
 export * from "../../utilities/contracts/deinitizable.contract";
 export * from "../../utilities/contracts/initizable.contract";
-export * from "../../utilities/contracts/serde-registrable.contract";

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@daiso-tech/core",
     "private": false,
-    "version": "0.22.2",
+    "version": "0.23.0",
     "author": "Yousif Abdulkarim",
     "license": "Apache-2.0",
     "main": "./dist/cjs/_module.js",

package/dist/cjs/utilities/contracts/serde-registrable.contract.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=serde-registrable.contract.js.map

package/dist/cjs/utilities/contracts/serde-registrable.contract.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serde-registrable.contract.js","sourceRoot":"","sources":["../../../../src/utilities/contracts/serde-registrable.contract.ts"],"names":[],"mappings":""}

package/dist/esm/utilities/contracts/serde-registrable.contract.js

@@ -1 +0,0 @@
-//# sourceMappingURL=serde-registrable.contract.js.map

package/dist/esm/utilities/contracts/serde-registrable.contract.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serde-registrable.contract.js","sourceRoot":"","sources":["../../../../src/utilities/contracts/serde-registrable.contract.ts"],"names":[],"mappings":""}

package/dist/types/utilities/contracts/serde-registrable.contract.d.ts

@@ -1,11 +0,0 @@
-/**
- * @module Utilities
- */
-import type { IFlexibleSerde } from "../../serde/contracts/_module";
-import type { OneOrMore } from "../../utilities/types";
-/**
- * @group Contracts
- */
-export type ISerdeRegistrable = {
-    registerToSerde(serde: OneOrMore<IFlexibleSerde>): void;
-};