@daiso-tech/core 0.22.2 → 0.24.0

package/dist/lock/implementations/derivables/lock-provider/lock-provider.js

@@ -0,0 +1,516 @@
+/**
+ * @module Lock
+ */
+import { CORE, simplifyOneOrMoreStr, TimeSpan, } from "../../../../utilities/_module-exports.js";
+import {} from "../../../../lock/contracts/_module-exports.js";
+import { Lock } from "../../../../lock/implementations/derivables/lock-provider/lock.js";
+import { EventBus } from "../../../../event-bus/implementations/derivables/_module-exports.js";
+import { NoOpEventBusAdapter } from "../../../../event-bus/implementations/adapters/_module-exports.js";
+import { v4 } from "uuid";
+import { DatabaseLockAdapter } from "../../../../lock/implementations/derivables/lock-provider/database-lock-adapter.js";
+import { LockSerdeTransformer } from "../../../../lock/implementations/derivables/lock-provider/lock-serde-transformer.js";
+/**
+ * <i>LockProvider</i> class can be derived from any <i>{@link ILockAdapter}</i> or <i>{@link IDatabaseLockAdapter}</i>.
+ *
+ * Note the <i>{@link ILock}</i> instances created by the <i>LockProvider</i> class are serializable and deserializable,
+ * allowing them to be seamlessly transferred across different servers, processes, and databases.
+ * This can be done directly using <i>{@link IFlexibleSerde}</i> or indirectly through components that rely on <i>{@link IFlexibleSerde}</i> internally.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/derivables"```
+ * @group Derivables
+ */
+export class LockProvider {
+    static DEFAULT_TTL = TimeSpan.fromMinutes(5);
+    static DEFAULT_REFRESH_TIME = TimeSpan.fromMinutes(5);
+    static isDatabaseAdapter(adapter) {
+        const adapter_ = adapter;
+        return (typeof adapter_["init"] === "function" &&
+            adapter_["init"].length === 0 &&
+            typeof adapter_["deInit"] === "function" &&
+            adapter_["deInit"].length === 0 &&
+            typeof adapter_["insert"] === "function" &&
+            adapter_["insert"].length === 3 &&
+            typeof adapter_["update"] === "function" &&
+            adapter_["update"].length === 3 &&
+            typeof adapter_["remove"] === "function" &&
+            adapter_["remove"].length === 2 &&
+            typeof adapter_["refresh"] === "function" &&
+            adapter_["refresh"].length === 3 &&
+            typeof adapter_["find"] === "function" &&
+            adapter_["find"].length === 1 &&
+            typeof adapter_["getGroup"] === "function" &&
+            adapter_["getGroup"].length === 0 &&
+            typeof adapter_["withGroup"] === "function" &&
+            adapter_["withGroup"].length === 1);
+    }
+    serde;
+    createOwnerId;
+    adapter;
+    defaultTtl;
+    defaultRefreshTime;
+    retryAttempts;
+    backoffPolicy;
+    retryPolicy;
+    timeout;
+    eventBus;
+    lockProviderEventBus;
+    stateRecord = {};
+    /**
+     * @example
+     * ```ts
+     * import type { IGroupableLockProvider } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     * ```
+     */
+    constructor(settings) {
+        const { createOwnerId = () => v4(), adapter, defaultTtl = LockProvider.DEFAULT_TTL, defaultRefreshTime = LockProvider.DEFAULT_REFRESH_TIME, retryAttempts = null, backoffPolicy = null, retryPolicy = null, timeout = null, eventBus = new EventBus({
+            adapter: new NoOpEventBusAdapter(),
+        }), serde, } = settings;
+        this.createOwnerId = createOwnerId;
+        if (LockProvider.isDatabaseAdapter(adapter)) {
+            this.adapter = new DatabaseLockAdapter(adapter);
+        }
+        else {
+            this.adapter = adapter;
+        }
+        this.serde = serde;
+        this.defaultTtl = defaultTtl ?? LockProvider.DEFAULT_TTL;
+        this.defaultRefreshTime = defaultRefreshTime;
+        this.retryAttempts = retryAttempts;
+        this.backoffPolicy = backoffPolicy;
+        this.retryPolicy = retryPolicy;
+        this.timeout = timeout;
+        this.eventBus = eventBus;
+        this.lockProviderEventBus = eventBus.withGroup(adapter.getGroup());
+        this.registerToSerde();
+    }
+    registerToSerde() {
+        const transformer = new LockSerdeTransformer({
+            adapter: this.adapter,
+            backoffPolicy: this.backoffPolicy,
+            defaultRefreshTime: this.defaultRefreshTime,
+            eventBus: this.eventBus,
+            retryAttempts: this.retryAttempts,
+            retryPolicy: this.retryPolicy,
+            timeout: this.timeout,
+        });
+        let serde = this.serde;
+        if (!Array.isArray(serde)) {
+            serde = [serde];
+        }
+        for (const serde_ of serde) {
+            serde_.registerCustom(transformer, CORE);
+        }
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * await lockProvider.addListener(KeyAcquiredLockEvent, listener);
+     * ```
+     */
+    addListener(event, listener) {
+        return this.lockProviderEventBus.addListener(event, listener);
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * await lockProvider.addListenerMany([KeyAcquiredLockEvent], listener);
+     * ```
+     */
+    addListenerMany(events, listener) {
+        return this.lockProviderEventBus.addListenerMany(events, listener);
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * await lockProvider.removeListener(KeyAcquiredLockEvent, listener);
+     * ```
+     */
+    removeListener(event, listener) {
+        return this.lockProviderEventBus.removeListener(event, listener);
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * await lockProvider.removeListenerMany([KeyAcquiredLockEvent], listener);
+     * ```
+     */
+    removeListenerMany(events, listener) {
+        return this.lockProviderEventBus.removeListenerMany(events, listener);
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * await lockProvider.listenOnce(KeyAcquiredLockEvent, listener);
+     * ```
+     */
+    listenOnce(event, listener) {
+        return this.lockProviderEventBus.listenOnce(event, listener);
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * const unsubscribe = await lockProvider.subscribe(KeyAcquiredLockEvent, listener);
+     * await unsubscribe();
+     * ```
+     */
+    subscribe(event, listener) {
+        return this.lockProviderEventBus.subscribe(event, listener);
+    }
+    /**
+     * You listen to different events of all locks created by <i>LockProvider</i> class.
+     *
+     * Refer to <i>{@link LockEvents}</i>, to se all events dispatched by <i>Cache</i> class.
+     * Refer to <i>{@link IEventListener}</i> ford details on how the method works.
+     * @example
+     * ```ts
+     * import { type IGroupableLockProvider, type LockEvents, KeyAcquiredLockEvent } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import type { Listener } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * const listener: Listener<LockEvents> = event => {
+     *   console.log(event);
+     * }
+     * const unsubscribe = await lockProvider.subscribeMany([KeyAcquiredLockEvent], listener);
+     * await unsubscribe();
+     * ```
+     */
+    subscribeMany(events, listener) {
+        return this.lockProviderEventBus.subscribeMany(events, listener);
+    }
+    /**
+     * ```ts
+     * import type { IGroupableLockProvider } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * // You can use the lock
+     * const lockA = lockProvider.create("a");
+     *
+     * // You can provide ttl
+     * const lockB = lockProvider.create("b", {
+     *   ttl: TimeSpan.fromMinutes(2),
+     * });
+     *
+     * // You can provide a custom owner. By default the owner will be unique random value.
+     * const lockB = lockProvider.create("b", {
+     *   owner: "user-1"
+     * });
+     * ```
+     */
+    create(key, settings = {}) {
+        const { ttl = this.defaultTtl, owner = this.createOwnerId() } = settings;
+        return new Lock({
+            lockProviderEventDispatcher: this.lockProviderEventBus,
+            lockEventBus: this.eventBus,
+            adapter: this.adapter,
+            defaultRefreshTime: this.defaultRefreshTime,
+            key: simplifyOneOrMoreStr(key),
+            owner: simplifyOneOrMoreStr(owner),
+            ttl,
+            lazyPromiseSettings: {
+                backoffPolicy: this.backoffPolicy,
+                retryAttempts: this.retryAttempts,
+                retryPolicy: this.retryPolicy,
+                timeout: this.timeout,
+            },
+            stateRecord: this.stateRecord,
+            expirationInMs: null,
+        });
+    }
+    /**
+     * @example
+     * ```ts
+     * import type { IGroupableLockProvider } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * // Will print "@global"
+     * console.log(lockProvider.getGroup());
+     * ```
+     */
+    getGroup() {
+        return this.adapter.getGroup();
+    }
+    /**
+     * @example
+     * ```ts
+     * import type { IGroupableLockProvider, ILockProvider } from "@daiso-tech/core/lock/contracts";
+     * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+     * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+     * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+     * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new Serde(SuperJsonSerdeAdapter);
+     * const lockProvider: IGroupableLockProvider = new LockProvider({
+     *   serde,
+     *   adapter: new MemoryLockAdapter({
+     *     rootGroup: "@global"
+     *   }),
+     *   eventBus,
+     * });
+     *
+     * // Will print "@global"
+     * console.log(lockProvider.getGroup());
+     *
+     * const groupedLockProvider: ILockProvider = lockProvider.withGroup("company-1");
+     *
+     * // Will print "@global/company-1"
+     * console.log(groupedLockProvider.getGroup());
+     * ```
+     */
+    withGroup(group) {
+        return new LockProvider({
+            adapter: this.adapter.withGroup(simplifyOneOrMoreStr(group)),
+            eventBus: this.eventBus,
+            defaultTtl: this.defaultTtl,
+            defaultRefreshTime: this.defaultRefreshTime,
+            retryAttempts: this.retryAttempts,
+            backoffPolicy: this.backoffPolicy,
+            retryPolicy: this.retryPolicy,
+            timeout: this.timeout,
+            serde: this.serde,
+        });
+    }
+}
+//# sourceMappingURL=lock-provider.js.map

package/dist/lock/implementations/derivables/lock-provider/lock-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-provider.js","sourceRoot":"","sources":["../../../../../src/lock/implementations/derivables/lock-provider/lock-provider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,IAAI,EACJ,oBAAoB,EACpB,QAAQ,GAEX,MAAM,gCAAgC,CAAC;AAKxC,OAAO,EAMN,MAAM,qCAAqC,CAAC;AAM7C,OAAO,EAAE,IAAI,EAAE,MAAM,yDAAyD,CAAC;AAW/E,OAAO,EAAE,QAAQ,EAAE,MAAM,2DAA2D,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,yDAAyD,CAAC;AAC9F,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAE1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,0EAA0E,CAAC;AAE/G,OAAO,EAAE,oBAAoB,EAAE,MAAM,2EAA2E,CAAC;AA2DjH;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAY;IACb,MAAM,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,CAAC,oBAAoB,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAEtD,MAAM,CAAC,iBAAiB,CAC5B,OAA4C;QAE5C,MAAM,QAAQ,GAAG,OAEhB,CAAC;QACF,OAAO,CACH,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,UAAU;YACtC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,UAAU;YACxC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC;YAC/B,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,UAAU;YACxC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC;YAC/B,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,UAAU;YACxC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC;YAC/B,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,UAAU;YACxC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC;YAC/B,OAAO,QAAQ,CAAC,SAAS,CAAC,KAAK,UAAU;YACzC,QAAQ,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC;YAChC,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,UAAU;YACtC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,UAAU;YAC1C,QAAQ,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC;YACjC,OAAO,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU;YAC3C,QAAQ,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,CACrC,CAAC;IACN,CAAC;IAEgB,KAAK,CAA4B;IACjC,aAAa,CAAe;IAC5B,OAAO,CAAe;IACtB,UAAU,CAAW;IACrB,kBAAkB,CAAW;IAC7B,aAAa,CAAgB;IAC7B,aAAa,CAAuB;IACpC,WAAW,CAAqB;IAChC,OAAO,CAAkB;IACzB,QAAQ,CAAiC;IACzC,oBAAoB,CAAwB;IACrD,WAAW,GAAqB,EAAE,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,YAAY,QAA8B;QACtC,MAAM,EACF,aAAa,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,EAC1B,OAAO,EACP,UAAU,GAAG,YAAY,CAAC,WAAW,EACrC,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,EACtD,aAAa,GAAG,IAAI,EACpB,aAAa,GAAG,IAAI,EACpB,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,IAAI,EACd,QAAQ,GAAG,IAAI,QAAQ,CAAC;YACpB,OAAO,EAAE,IAAI,mBAAmB,EAAE;SACrC,CAAC,EACF,KAAK,GACR,GAAG,QAAQ,CAAC;QACb,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,YAAY,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,YAAY,CAAC,WAAW,CAAC;QACzD,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,oBAAoB,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAEO,eAAe;QACnB,MAAM,WAAW,GAAG,IAAI,oBAAoB,CAAC;YACzC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC,CAAC;QAEH,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,WAAW,CACP,KAAkB,EAClB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,eAAe,CACX,MAAqB,EACrB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,cAAc,CACV,KAAkB,EAClB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,kBAAkB,CACd,MAAqB,EACrB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,UAAU,CACN,KAAkB,EAClB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,SAAS,CACL,KAAkB,EAClB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,aAAa,CACT,MAAqB,EACrB,QAA8C;QAE9C,OAAO,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CACF,GAAsB,EACtB,WAAuC,EAAE;QAEzC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,GACzD,QAAQ,CAAC;QACb,OAAO,IAAI,IAAI,CAAC;YACZ,2BAA2B,EAAE,IAAI,CAAC,oBAAoB;YACtD,YAAY,EAAE,IAAI,CAAC,QAAQ;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,GAAG,EAAE,oBAAoB,CAAC,GAAG,CAAC;YAC9B,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC;YAClC,GAAG;YACH,mBAAmB,EAAE;gBACjB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;aACxB;YACD,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI;SACvB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,SAAS,CAAC,KAAwB;QAC9B,OAAO,IAAI,YAAY,CAAC;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAC5D,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC,CAAC;IACP,CAAC"}

package/dist/lock/implementations/derivables/lock-provider/lock-serde-transformer.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @module Lock
+ */
+import { TimeSpan, type OneOrMore } from "../../../../utilities/_module-exports.js";
+import type { ILockAdapter } from "../../../../lock/contracts/_module-exports.js";
+import type { BackoffPolicy, RetryPolicy } from "../../../../async/_module-exports.js";
+import { Lock, type ISerializedLock } from "../../../../lock/implementations/derivables/lock-provider/lock.js";
+import type { IGroupableEventBus } from "../../../../event-bus/contracts/_module-exports.js";
+import type { ISerdeTransformer } from "../../../../serde/contracts/_module-exports.js";
+/**
+ * @internal
+ */
+export type LockSerdeTransformerSettings = {
+    adapter: ILockAdapter;
+    /**
+     * In order to listen to events of <i>{@link LockProvider}</i> class you must pass in <i>{@link IGroupableEventBus}</i>.
+     */
+    eventBus: IGroupableEventBus<any>;
+    /**
+     * The default refresh time used in the <i>{@link ILock}</i> <i>extend</i> method.
+     * @default TimeSpan.fromMinutes(5);
+     */
+    defaultRefreshTime: TimeSpan;
+    /**
+     * The default retry attempt to use in the returned <i>LazyPromise</i>.
+     * @default {null}
+     */
+    retryAttempts?: number | null;
+    /**
+     * The default backof policy to use in the returned <i>LazyPromise</i>.
+     * @default {null}
+     */
+    backoffPolicy?: BackoffPolicy | null;
+    /**
+     * The default retry policy to use in the returned <i>LazyPromise</i>.
+     * @default {null}
+     */
+    retryPolicy?: RetryPolicy | null;
+    /**
+     * The default timeout to use in the returned <i>LazyPromise</i>.
+     * @default {null}
+     */
+    timeout?: TimeSpan | null;
+};
+/**
+ * @internal
+ */
+export declare class LockSerdeTransformer implements ISerdeTransformer<Lock, ISerializedLock> {
+    private readonly adapter;
+    private readonly defaultRefreshTime;
+    private readonly retryAttempts;
+    private readonly backoffPolicy;
+    private readonly retryPolicy;
+    private readonly timeout;
+    private readonly eventBus;
+    private readonly lockProviderEventBus;
+    private stateRecord;
+    constructor(settings: LockSerdeTransformerSettings);
+    get name(): OneOrMore<string>;
+    isApplicable(value: unknown): value is Lock;
+    deserialize(serializedValue: ISerializedLock): Lock;
+    serialize(deserializedValue: Lock): ISerializedLock;
+}

package/dist/lock/implementations/derivables/lock-provider/lock-serde-transformer.js

@@ -0,0 +1,72 @@
+/**
+ * @module Lock
+ */
+import { getConstructorName, TimeSpan, } from "../../../../utilities/_module-exports.js";
+import { Lock, } from "../../../../lock/implementations/derivables/lock-provider/lock.js";
+import { NoOpEventBusAdapter } from "../../../../event-bus/implementations/adapters/_module-exports.js";
+import { EventBus } from "../../../../event-bus/implementations/derivables/_module-exports.js";
+/**
+ * @internal
+ */
+export class LockSerdeTransformer {
+    adapter;
+    defaultRefreshTime;
+    retryAttempts;
+    backoffPolicy;
+    retryPolicy;
+    timeout;
+    eventBus;
+    lockProviderEventBus;
+    stateRecord = {};
+    constructor(settings) {
+        const { adapter, defaultRefreshTime, retryAttempts = null, backoffPolicy = null, retryPolicy = null, timeout = null, eventBus = new EventBus({
+            adapter: new NoOpEventBusAdapter(),
+        }), } = settings;
+        this.adapter = adapter;
+        this.defaultRefreshTime = defaultRefreshTime;
+        this.retryAttempts = retryAttempts;
+        this.backoffPolicy = backoffPolicy;
+        this.retryPolicy = retryPolicy;
+        this.timeout = timeout;
+        this.eventBus = eventBus;
+        this.lockProviderEventBus = eventBus.withGroup(adapter.getGroup());
+    }
+    get name() {
+        return ["lock", getConstructorName(this.adapter)];
+    }
+    isApplicable(value) {
+        return value instanceof Lock && getConstructorName(value) === Lock.name;
+    }
+    deserialize(serializedValue) {
+        const { group, key, owner, ttlInMs } = serializedValue;
+        let adapter = this.adapter;
+        const rootGroup = adapter.getGroup();
+        const isRoot = group === rootGroup;
+        if (!isRoot) {
+            const groupWithouRoot = group.slice(this.adapter.getGroup().length + 1);
+            adapter = adapter.withGroup(groupWithouRoot);
+        }
+        const ttl = ttlInMs ? TimeSpan.fromMilliseconds(ttlInMs) : null;
+        return new Lock({
+            lockProviderEventDispatcher: this.lockProviderEventBus,
+            lockEventBus: this.eventBus,
+            adapter,
+            defaultRefreshTime: this.defaultRefreshTime,
+            key,
+            owner,
+            ttl,
+            lazyPromiseSettings: {
+                backoffPolicy: this.backoffPolicy,
+                retryAttempts: this.retryAttempts,
+                retryPolicy: this.retryPolicy,
+                timeout: this.timeout,
+            },
+            stateRecord: this.stateRecord,
+            expirationInMs: serializedValue.expirationInMs,
+        });
+    }
+    serialize(deserializedValue) {
+        return Lock.serialize(deserializedValue);
+    }
+}
+//# sourceMappingURL=lock-serde-transformer.js.map

package/dist/lock/implementations/derivables/lock-provider/lock-serde-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-serde-transformer.js","sourceRoot":"","sources":["../../../../../src/lock/implementations/derivables/lock-provider/lock-serde-transformer.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,kBAAkB,EAClB,QAAQ,GAEX,MAAM,gCAAgC,CAAC;AAIxC,OAAO,EACH,IAAI,GAEP,MAAM,yDAAyD,CAAC;AAKjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,yDAAyD,CAAC;AAC9F,OAAO,EAAE,QAAQ,EAAE,MAAM,2DAA2D,CAAC;AA8CrF;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAGZ,OAAO,CAAe;IACtB,kBAAkB,CAAW;IAC7B,aAAa,CAAgB;IAC7B,aAAa,CAAuB;IACpC,WAAW,CAAqB;IAChC,OAAO,CAAkB;IACzB,QAAQ,CAAiC;IACzC,oBAAoB,CAAwB;IACrD,WAAW,GAAqB,EAAE,CAAC;IAE3C,YAAY,QAAsC;QAC9C,MAAM,EACF,OAAO,EACP,kBAAkB,EAClB,aAAa,GAAG,IAAI,EACpB,aAAa,GAAG,IAAI,EACpB,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,IAAI,EACd,QAAQ,GAAG,IAAI,QAAQ,CAAC;YACpB,OAAO,EAAE,IAAI,mBAAmB,EAAE;SACrC,CAAC,GACL,GAAG,QAAQ,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,oBAAoB,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,YAAY,CAAC,KAAc;QACvB,OAAO,KAAK,YAAY,IAAI,IAAI,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC;IAC5E,CAAC;IAED,WAAW,CAAC,eAAgC;QACxC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QACvD,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,KAAK,KAAK,SAAS,CAAC;QACnC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,CAC/B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,GAAG,CAAC,CACrC,CAAC;YACF,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,OAAO,IAAI,IAAI,CAAC;YACZ,2BAA2B,EAAE,IAAI,CAAC,oBAAoB;YACtD,YAAY,EAAE,IAAI,CAAC,QAAQ;YAC3B,OAAO;YACP,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,GAAG;YACH,KAAK;YACL,GAAG;YACH,mBAAmB,EAAE;gBACjB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;aACxB;YACD,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,eAAe,CAAC,cAAc;SACjD,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,iBAAuB;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC7C,CAAC;CACJ"}