@daiso-tech/core 0.27.0 → 0.28.0

package/dist/event-bus/implementations/derivables/event-bus-factory/event-bus-factory.d.ts

@@ -2,15 +2,15 @@
  * @module EventBus
  */
 import type { BackoffPolicy, RetryPolicy } from "../../../../async/_module-exports.js";
-import { type IEventBusAdapter, type IGroupableEventBus, type IEventBusFactory, type BaseEvent } from "../../../../event-bus/contracts/_module-exports.js";
-import { type EventBusSettingsBase } from "../../../../event-bus/implementations/derivables/event-bus/event-bus.js";
+import { type IGroupableEventBus, type IEventBusFactory, type BaseEvent } from "../../../../event-bus/contracts/_module-exports.js";
+import { type EventBusAdapterFactoryable, type EventBusSettingsBase } from "../../../../event-bus/implementations/derivables/event-bus/_module.js";
 import type { KeyPrefixer, TimeSpan } from "../../../../utilities/_module-exports.js";
 /**
  *
  * IMPORT_PATH: ```"@daiso-tech/core/event-bus"```
  * @group Derivables
  */
-export type EventBusAdapters<TAdapters extends string = string> = Partial<Record<TAdapters, IEventBusAdapter>>;
+export type EventBusAdapters<TAdapters extends string = string> = Partial<Record<TAdapters, EventBusAdapterFactoryable>>;
 /**
  *
  * IMPORT_PATH: ```"@daiso-tech/core/event-bus"```
@@ -27,28 +27,70 @@ export type EventBusFactorySettings<TAdapters extends string = string> = EventBu
  */
 export declare class EventBusFactory<TAdapters extends string = string> implements IEventBusFactory<TAdapters> {
     private readonly settings;
+    /**
+     * @example
+     * ```ts
+     * import { type IEventBusAdapter, BaseEvent } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBusFactory } from "@daiso-tech/core/event-bus";
+     * import { MemoryEventBusAdapter, RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
+     * import { KeyPrefixer, type IFactoryObject, type Promiseable, type FactoryFn } from "@daiso-tech/utilities";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters"
+     * import Redis from "ioredis";
+     *
+     * type Store = Partial<Record<string, IEventBusAdapter>> = {};
+     *
+     * async function cahceAdapterFactory(store: Store): FactoryFn<string, IEventBusAdapter> {
+     *   return (prefix) => {
+     *     let adapter = store[prefix];
+     *     if (adapter === undefined) {
+     *       adapter = new MemoryEventBusAdapter();
+     *       store[prefix] = adapter;
+     *     }
+     *     return adapter;
+     *   }
+     * }
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const store: Store = {};
+     * const eventBusFactory = new EventBusFactory({
+     *   keyPrefixer: new KeyPrefixer("event-bus"),
+     *   adapters: {
+     *     memory: new MemoryEventBusAdapter(),
+     *     memoryFactory: cahceAdapterFactory(store),
+     *     redis: new RedisPubSubEventBusAdapter({
+     *       serde,
+     *       dispatcherClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
+     *       listenerClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
+     *     }),
+     *   },
+     *   defaultAdapter: "memory"
+     * });
+     * ```
+     */
     constructor(settings: EventBusFactorySettings<TAdapters>);
     setKeyPrefixer(keyPrefixer: KeyPrefixer): EventBusFactory<TAdapters>;
     setRetryAttempts(attempts: number): EventBusFactory<TAdapters>;
     setBackoffPolicy(policy: BackoffPolicy): EventBusFactory<TAdapters>;
     setRetryPolicy(policy: RetryPolicy): EventBusFactory<TAdapters>;
-    setTimeout(timeout: TimeSpan): EventBusFactory<TAdapters>;
+    setRetryTimeout(timeout: TimeSpan): EventBusFactory<TAdapters>;
+    setTotalTimeout(timeout: TimeSpan): EventBusFactory<TAdapters>;
     /**
      * @example
      * ```ts
      * import { type IEventBusAdapter, BaseEvent } from "@daiso-tech/core/event-bus/contracts";
      * import { EventBusFactory } from "@daiso-tech/core/event-bus";
      * import { MemoryEventBusAdapter, RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
-     * import { KeyPrefixer, type IFactoryObject, type Promiseable } from "@daiso-tech/utilities";
+     * import { KeyPrefixer, type IFactoryObject, type Promiseable, type FactoryFn } from "@daiso-tech/utilities";
      * import { Serde } from "@daiso-tech/core/serde";
      * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters"
      * import Redis from "ioredis";
      *
-     * class EventBusAdapterFactory implements IFactoryObject<string, IEventBusAdapter> {
-     *   private store: Partial<Record<string, IEventBusAdapter>> = {};
+     * type Store = Partial<Record<string, IEventBusAdapter>> = {};
      *
-     *   async use(prefix: string): Promiseable<IEventBusAdapter> {
-     *     let adapter = this.store[prefix];
+     * async function cahceAdapterFactory(store: Store): FactoryFn<string, IEventBusAdapter> {
+     *   return (prefix) => {
+     *     let adapter = store[prefix];
      *     if (adapter === undefined) {
      *       adapter = new MemoryEventBusAdapter();
      *       store[prefix] = adapter;
@@ -60,15 +102,16 @@ export declare class EventBusFactory<TAdapters extends string = string> implemen
      * const dispatcherClient = new Redis("YOUR_REDIS_CONNECTION_STRING");
      * const listenerClient = new Redis("YOUR_REDIS_CONNECTION_STRING");
      * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const store: Store = {};
      * const eventBusFactory = new EventBusFactory({
      *   keyPrefixer: new KeyPrefixer("event-bus"),
      *   adapters: {
      *     memory: new MemoryEventBusAdapter(),
-     *     memorFactory: new EventBusAdapterFactory(),
+     *     memoryFactory: cahceAdapterFactory(store),
      *     redis: new RedisPubSubEventBusAdapter({
      *       serde,
-     *       dispatcherClient,
-     *       listenerClient,
+     *       dispatcherClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
+     *       listenerClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
      *     }),
      *   },
      *   defaultAdapter: "memory"
@@ -89,7 +132,7 @@ export declare class EventBusFactory<TAdapters extends string = string> implemen
      * // You can change the default settings of the returned EventBus instance.
      * await eventBusFactory
      *   .setRetryAttempts(4)
-     *   .use("sqlite")
+     *   .use("memoryFactory")
      *   .dispatch(new AddEvent({ a: 1, b: 2 }));
      *
      * // You can reuse the settings
@@ -102,7 +145,7 @@ export declare class EventBusFactory<TAdapters extends string = string> implemen
      *
      * // You can extend the settings
      * const extendedEventBusFactory = retryableEventBusFactory
-     *   .setTimeout(TimeSpan.fromSeconds(1));
+     *   .setRetryTimeout(TimeSpan.fromSeconds(1));
      *
      * await extendedEventBusFactory
      *   .use()

package/dist/event-bus/implementations/derivables/event-bus-factory/event-bus-factory.js

@@ -2,7 +2,7 @@
  * @module EventBus
  */
 import {} from "../../../../event-bus/contracts/_module-exports.js";
-import { EventBus, } from "../../../../event-bus/implementations/derivables/event-bus/event-bus.js";
+import { EventBus, } from "../../../../event-bus/implementations/derivables/event-bus/_module.js";
 import { DefaultAdapterNotDefinedError, UnregisteredAdapterError, } from "../../../../utilities/_module-exports.js";
 /**
  *
@@ -11,6 +11,47 @@ import { DefaultAdapterNotDefinedError, UnregisteredAdapterError, } from "../../
  */
 export class EventBusFactory {
     settings;
+    /**
+     * @example
+     * ```ts
+     * import { type IEventBusAdapter, BaseEvent } from "@daiso-tech/core/event-bus/contracts";
+     * import { EventBusFactory } from "@daiso-tech/core/event-bus";
+     * import { MemoryEventBusAdapter, RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
+     * import { KeyPrefixer, type IFactoryObject, type Promiseable, type FactoryFn } from "@daiso-tech/utilities";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters"
+     * import Redis from "ioredis";
+     *
+     * type Store = Partial<Record<string, IEventBusAdapter>> = {};
+     *
+     * async function cahceAdapterFactory(store: Store): FactoryFn<string, IEventBusAdapter> {
+     *   return (prefix) => {
+     *     let adapter = store[prefix];
+     *     if (adapter === undefined) {
+     *       adapter = new MemoryEventBusAdapter();
+     *       store[prefix] = adapter;
+     *     }
+     *     return adapter;
+     *   }
+     * }
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const store: Store = {};
+     * const eventBusFactory = new EventBusFactory({
+     *   keyPrefixer: new KeyPrefixer("event-bus"),
+     *   adapters: {
+     *     memory: new MemoryEventBusAdapter(),
+     *     memoryFactory: cahceAdapterFactory(store),
+     *     redis: new RedisPubSubEventBusAdapter({
+     *       serde,
+     *       dispatcherClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
+     *       listenerClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
+     *     }),
+     *   },
+     *   defaultAdapter: "memory"
+     * });
+     * ```
+     */
     constructor(settings) {
         this.settings = settings;
     }
@@ -38,10 +79,16 @@ export class EventBusFactory {
             retryPolicy: policy,
         });
     }
-    setTimeout(timeout) {
+    setRetryTimeout(timeout) {
+        return new EventBusFactory({
+            ...this.settings,
+            retryTimeout: timeout,
+        });
+    }
+    setTotalTimeout(timeout) {
         return new EventBusFactory({
             ...this.settings,
-            timeout,
+            totalTimeout: timeout,
         });
     }
     /**
@@ -50,16 +97,16 @@ export class EventBusFactory {
      * import { type IEventBusAdapter, BaseEvent } from "@daiso-tech/core/event-bus/contracts";
      * import { EventBusFactory } from "@daiso-tech/core/event-bus";
      * import { MemoryEventBusAdapter, RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
-     * import { KeyPrefixer, type IFactoryObject, type Promiseable } from "@daiso-tech/utilities";
+     * import { KeyPrefixer, type IFactoryObject, type Promiseable, type FactoryFn } from "@daiso-tech/utilities";
      * import { Serde } from "@daiso-tech/core/serde";
      * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters"
      * import Redis from "ioredis";
      *
-     * class EventBusAdapterFactory implements IFactoryObject<string, IEventBusAdapter> {
-     *   private store: Partial<Record<string, IEventBusAdapter>> = {};
+     * type Store = Partial<Record<string, IEventBusAdapter>> = {};
      *
-     *   async use(prefix: string): Promiseable<IEventBusAdapter> {
-     *     let adapter = this.store[prefix];
+     * async function cahceAdapterFactory(store: Store): FactoryFn<string, IEventBusAdapter> {
+     *   return (prefix) => {
+     *     let adapter = store[prefix];
      *     if (adapter === undefined) {
      *       adapter = new MemoryEventBusAdapter();
      *       store[prefix] = adapter;
@@ -71,15 +118,16 @@ export class EventBusFactory {
      * const dispatcherClient = new Redis("YOUR_REDIS_CONNECTION_STRING");
      * const listenerClient = new Redis("YOUR_REDIS_CONNECTION_STRING");
      * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const store: Store = {};
      * const eventBusFactory = new EventBusFactory({
      *   keyPrefixer: new KeyPrefixer("event-bus"),
      *   adapters: {
      *     memory: new MemoryEventBusAdapter(),
-     *     memorFactory: new EventBusAdapterFactory(),
+     *     memoryFactory: cahceAdapterFactory(store),
      *     redis: new RedisPubSubEventBusAdapter({
      *       serde,
-     *       dispatcherClient,
-     *       listenerClient,
+     *       dispatcherClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
+     *       listenerClient: new Redis("YOUR_REDIS_CONNECTION_STRING"),
      *     }),
      *   },
      *   defaultAdapter: "memory"
@@ -100,7 +148,7 @@ export class EventBusFactory {
      * // You can change the default settings of the returned EventBus instance.
      * await eventBusFactory
      *   .setRetryAttempts(4)
-     *   .use("sqlite")
+     *   .use("memoryFactory")
      *   .dispatch(new AddEvent({ a: 1, b: 2 }));
      *
      * // You can reuse the settings
@@ -113,7 +161,7 @@ export class EventBusFactory {
      *
      * // You can extend the settings
      * const extendedEventBusFactory = retryableEventBusFactory
-     *   .setTimeout(TimeSpan.fromSeconds(1));
+     *   .setRetryTimeout(TimeSpan.fromSeconds(1));
      *
      * await extendedEventBusFactory
      *   .use()

package/dist/event-bus/implementations/derivables/event-bus-factory/event-bus-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"event-bus-factory.js","sourceRoot":"","sources":["../../../../../src/event-bus/implementations/derivables/event-bus-factory/event-bus-factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAKN,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,QAAQ,GAEX,MAAM,+DAA+D,CAAC;AAEvE,OAAO,EACH,6BAA6B,EAC7B,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AAuBxC;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAIH;IADrB,YACqB,QAA4C;QAA5C,aAAQ,GAAR,QAAQ,CAAoC;IAC9D,CAAC;IAEJ,cAAc,CAAC,WAAwB;QACnC,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,QAAgB;QAC7B,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,QAAQ;SAC1B,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,MAAqB;QAClC,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,MAAM;SACxB,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,MAAmB;QAC9B,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW,EAAE,MAAM;SACtB,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,OAAiB;QACxB,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,OAAO;SACV,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2EG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,QAAQ,CAAC,cAAc;QAEjE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,QAAQ,CAAC;YAChB,OAAO;YACP,GAAG,IAAI,CAAC,QAAQ;SACnB,CAAC,CAAC;IACP,CAAC;CACJ"}
+{"version":3,"file":"event-bus-factory.js","sourceRoot":"","sources":["../../../../../src/event-bus/implementations/derivables/event-bus-factory/event-bus-factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAIN,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACH,QAAQ,GAGX,MAAM,6DAA6D,CAAC;AAErE,OAAO,EACH,6BAA6B,EAC7B,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AAuBxC;;;;GAIG;AACH,MAAM,OAAO,eAAe;IA6CH;IA1CrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,YACqB,QAA4C;QAA5C,aAAQ,GAAR,QAAQ,CAAoC;IAC9D,CAAC;IAEJ,cAAc,CAAC,WAAwB;QACnC,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,QAAgB;QAC7B,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,QAAQ;SAC1B,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,MAAqB;QAClC,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,MAAM;SACxB,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,MAAmB;QAC9B,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW,EAAE,MAAM;SACtB,CAAC,CAAC;IACP,CAAC;IAED,eAAe,CAAC,OAAiB;QAC7B,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,YAAY,EAAE,OAAO;SACxB,CAAC,CAAC;IACP,CAAC;IAED,eAAe,CAAC,OAAiB;QAC7B,OAAO,IAAI,eAAe,CAAC;YACvB,GAAG,IAAI,CAAC,QAAQ;YAChB,YAAY,EAAE,OAAO;SACxB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4EG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,QAAQ,CAAC,cAAc;QAEjE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,QAAQ,CAAC;YAChB,OAAO;YACP,GAAG,IAAI,CAAC,QAAQ;SACnB,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/lock/contracts/lock-provider.contract.d.ts

@@ -9,21 +9,27 @@ import type { ILock, ILockListenable } from "../../lock/contracts/lock.contract.
  * @group Contracts
  */
 export type LockProviderCreateSettings = {
+    /**
+     * You can also provide a <i>settings.ttl</i> value using. If not specified it defaults to null, meaning no TTL is applied.
+     */
     ttl?: TimeSpan | null;
+    /**
+     * You can provide a custom owner. If not specified a unique owner will be generated by default.
+     */
     owner?: OneOrMore<string>;
 };
 /**
- * The <i>ILockProvider</i> contract defines a way for managing locks independent of the underlying technology.
- * It commes with more convient methods compared to <i>ILockAdapter</i>.
  *
  * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
  * @group Contracts
  */
-export type ILockProvider = ILockListenable & {
+export type ILockProviderBase = {
     /**
      * The <i>create</i> method is used to create an instance of <i>{@link ILock}</i>.
-     * You can provide a custom owner using the <i>settings.owner</i> field. If not specified a unique owner will be generated by default.
-     * You can also provide a TTL value using the <i>settings.ttl</i> field. If not specified it defaults to null, meaning no TTL is applied.
+     *
+     * @param key - can be a string or an <i>Iterable</i> of strings.
+     * If it's an <i>Iterable</i>, it will be joined into a single string.
+     * Think of an <i>Iterable</i> as representing a path.
      */
     create(key: OneOrMore<string>, settings?: LockProviderCreateSettings): ILock;
     /**
@@ -31,6 +37,14 @@ export type ILockProvider = ILockListenable & {
      */
     getGroup(): string | null;
 };
+/**
+ * The <i>ILockProvider</i> contract defines a way for managing locks independent of the underlying technology.
+ * It commes with more convient methods compared to <i>ILockAdapter</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type ILockProvider = ILockListenable & ILockProviderBase;
 /**
  * The <i>IGroupableLockProvider</i> contract defines a way for managing locks independent of the underlying technology.
  * It commes with one extra method which is useful for multitennat applications compared to <i>{@link ILockProvider}</i>.

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

@@ -13,6 +13,11 @@ import type { LockEvents } from "../../lock/contracts/lock.events.js";
  * @group Contracts
  */
 export type ILockListenable = IEventListenable<LockEvents>;
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
 export type AquireBlockingSettings = {
     time?: TimeSpan;
     interval?: TimeSpan;
@@ -24,37 +29,57 @@ export type AquireBlockingSettings = {
  */
 export type ILock = ILockListenable & {
     /**
-     * The <i>run</i> method wraps an async function or <i>{@link LazyPromise}</i> with the <i>acquire</i> and <i>release</i> method.
+     * The <i>run</i> method wraps an function, async function or <i>{@link LazyPromise}</i> with the <i>acquire</i> and <i>release</i> method.
      * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
      * @throws {UnableToReleaseLockError} {@link UnableToReleaseLockError}
      */
     run<TValue = void>(asyncFn: LazyPromiseable<TValue>): LazyPromise<Result<TValue, KeyAlreadyAcquiredLockError>>;
     /**
-     * The <i>runOrFail</i> method wraps an async function or <i>{@link LazyPromise}</i> with the <i>acquireOrFail</i> and <i>release</i> method.
+     * The <i>runOrFail</i> method wraps an function, async function or <i>{@link LazyPromise}</i> with the <i>acquireOrFail</i> and <i>release</i> method.
      * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
      * @throws {UnableToReleaseLockError} {@link UnableToReleaseLockError}
      * @throws {KeyAlreadyAcquiredLockError} {@link KeyAlreadyAcquiredLockError}
      */
     runOrFail<TValue = void>(asyncFn: LazyPromiseable<TValue>): LazyPromise<TValue>;
     /**
-     * The <i>runBlocking</i> method wraps an async function or <i>{@link LazyPromise}</i> with the <i>acquireBlocking</i> and <i>release</i> method.
+     * The <i>runBlocking</i> method wraps an function, async function or <i>{@link LazyPromise}</i> with the <i>acquireBlocking</i> and <i>release</i> method.
      * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
      * @throws {UnableToReleaseLockError} {@link UnableToReleaseLockError}
      */
     runBlocking<TValue = void>(asyncFn: LazyPromiseable<TValue>, settings?: AquireBlockingSettings): LazyPromise<Result<TValue, KeyAlreadyAcquiredLockError>>;
+    /**
+     * The <i>runBlockingOrFail</i> method wraps an function, async function or <i>{@link LazyPromise}</i> with the <i>acquireBlockingOrFail</i> and <i>release</i> method.
+     * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
+     * @throws {UnableToReleaseLockError} {@link UnableToReleaseLockError}
+     * @throws {KeyAlreadyAcquiredLockError} {@link KeyAlreadyAcquiredLockError}
+     */
+    runBlockingOrFail<TValue = void>(asyncFn: LazyPromiseable<TValue>, settings?: AquireBlockingSettings): LazyPromise<TValue>;
     /**
      * The <i>acquire</i> method acquires a lock only if the lock is not already acquired.
-     * Returns true if the lock is acquired otherwise false is returned.
+     *
+     * @returns true if the lock is already acquired otherwise false is returned.
+     *
      * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
      */
     acquire(): LazyPromise<boolean>;
     /**
      * The <i>acquireBlocking</i> method acquires a lock only if the lock is not already acquired.
      * If the lock is acquired, it retries every <i>settings.interval</i> until <i>settings.time</i> is reached.
-     * Returns true if the lock is acquired otherwise false is returned.
+     *
+     * @returns true if the lock is already acquired otherwise false is returned.
+     *
      * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
      */
     acquireBlocking(settings?: AquireBlockingSettings): LazyPromise<boolean>;
+    /**
+     * The <i>acquireBlockingOrFail</i> method acquires a lock only if the lock is not already acquired.
+     * If the lock is acquired, it retries every <i>settings.interval</i> until <i>settings.time</i> is reached.
+     * Throws an error if not lock cannot be acquired after the given <i>settings.time</i>.
+     *
+     * @throws {UnableToAquireLockError} {@link UnableToAquireLockError}
+     * @throws {KeyAlreadyAcquiredLockError} {@link KeyAlreadyAcquiredLockError}
+     */
+    acquireBlockingOrFail(settings?: AquireBlockingSettings): LazyPromise<void>;
     /**
      * The <i>acquireOrFail</i> method acquires a lock only if the lock is not already acquired.
      * Throws an error if already acquired.
@@ -64,7 +89,9 @@ export type ILock = ILockListenable & {
     acquireOrFail(): LazyPromise<void>;
     /**
      * The <i>release</i> method releases a lock if owned by the same owner.
-     * Returns true if the lock is released otherwise false is returned.
+     *
+     * @returns true if the lock is released otherwise false is returned.
+     *
      * @throws {UnableToReleaseLockError} {@link UnableToReleaseLockError}
      */
     release(): LazyPromise<boolean>;
@@ -90,7 +117,8 @@ export type ILock = ILockListenable & {
     isLocked(): LazyPromise<boolean>;
     /**
      * The <i>refresh</i> method updates the TTL of the lock if owned by the same owner.
-     * Returns true if the lock is refreshed occurs otherwise false is returned.
+     *
+     * @returns true if the lock is refreshed occurs otherwise false is returned.
      */
     refresh(ttl?: TimeSpan): LazyPromise<boolean>;
     /**
@@ -101,7 +129,8 @@ export type ILock = ILockListenable & {
     refreshOrFail(ttl?: TimeSpan): LazyPromise<void>;
     /**
      * The <i>getRemainingTime</i> return the reaming time as <i>{@link TimeSpan}</i>.
-     * Returns null if the key doesnt exist, key has no expiration and key has expired.
+     *
+     * @returns null if the key doesnt exist, key has no expiration and key has expired.
      */
     getRemainingTime(): LazyPromise<TimeSpan | null>;
     /**

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

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

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/lock/implementations/adapters/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,gEAAgE,CAAC;AAC/E,cAAc,gEAAgE,CAAC;AAC/E,cAAc,iEAAiE,CAAC;AAChF,cAAc,+DAA+D,CAAC;AAC9E,cAAc,gEAAgE,CAAC"}
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/lock/implementations/adapters/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,gEAAgE,CAAC;AAC/E,cAAc,gEAAgE,CAAC;AAC/E,cAAc,iEAAiE,CAAC;AAChF,cAAc,+DAA+D,CAAC;AAC9E,cAAc,+DAA+D,CAAC;AAC9E,cAAc,gEAAgE,CAAC"}

package/dist/lock/implementations/adapters/no-op-lock-adapter/_module.d.ts

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

package/dist/lock/implementations/adapters/no-op-lock-adapter/_module.js

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

package/dist/lock/implementations/adapters/no-op-lock-adapter/_module.js.map

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

package/dist/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @module Lock
+ */
+import type { TimeSpan } from "../../../../utilities/_module-exports.js";
+import type { ILockAdapter } from "../../../../lock/contracts/_module-exports.js";
+/**
+ * This <i>NoOpLockAdapter</i> will do nothing and is used for easily mocking <i>{@link ILockProvider}</i> for testing.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/adapters"```
+ * @group Adapters
+ */
+export declare class NoOpLockAdapter implements ILockAdapter {
+    acquire(_key: string, _owner: string, _ttl: TimeSpan | null): PromiseLike<boolean>;
+    release(_key: string, _owner: string): PromiseLike<boolean>;
+    forceRelease(_key: string): PromiseLike<void>;
+    refresh(_key: string, _owner: string, _ttl: TimeSpan): PromiseLike<boolean>;
+}

package/dist/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.js

@@ -0,0 +1,24 @@
+/**
+ * @module Lock
+ */
+/**
+ * This <i>NoOpLockAdapter</i> will do nothing and is used for easily mocking <i>{@link ILockProvider}</i> for testing.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/adapters"```
+ * @group Adapters
+ */
+export class NoOpLockAdapter {
+    acquire(_key, _owner, _ttl) {
+        return Promise.resolve(true);
+    }
+    release(_key, _owner) {
+        return Promise.resolve(true);
+    }
+    forceRelease(_key) {
+        return Promise.resolve();
+    }
+    refresh(_key, _owner, _ttl) {
+        return Promise.resolve(true);
+    }
+}
+//# sourceMappingURL=no-op-lock-adapter.js.map

package/dist/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-op-lock-adapter.js","sourceRoot":"","sources":["../../../../../src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IACxB,OAAO,CACH,IAAY,EACZ,MAAc,EACd,IAAqB;QAErB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,MAAc;QAChC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,YAAY,CAAC,IAAY;QACrB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,OAAO,CACH,IAAY,EACZ,MAAc,EACd,IAAc;QAEd,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;CACJ"}

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

@@ -2,15 +2,14 @@
  * @module Lock
  */
 import type { IDatabaseLockAdapter, ILockData } from "../../../../lock/contracts/_module-exports.js";
-import { type IDeinitizable, type IInitizable, TimeSpan } from "../../../../utilities/_module-exports.js";
-import type { SqliteDatabase } from "kysely";
+import { type IDeinitizable, type IInitizable, type ISqliteDatabase, TimeSpan } from "../../../../utilities/_module-exports.js";
 /**
  *
  * IMPORT_PATH: ```"@daiso-tech/core/lock/adapters"```
  * @group Adapters
  */
 export type SqliteLockAdapterSettings = {
-    database: SqliteDatabase;
+    database: ISqliteDatabase;
     tableName?: string;
     expiredKeysRemovalInterval?: TimeSpan;
     shouldRemoveExpiredKeys?: boolean;

package/dist/lock/implementations/adapters/sqlite-lock-adapter/sqlite-lock-adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"sqlite-lock-adapter.js","sourceRoot":"","sources":["../../../../../src/lock/implementations/adapters/sqlite-lock-adapter/sqlite-lock-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAGH,QAAQ,GACX,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gEAAgE,CAAC;AAEnG,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAclF;;;;;;;;GAQG;AACH,MAAM,OAAO,iBAAiB;IAGlB,mBAAmB,CAAoB;IAE/C;;;;;;;;;;;;;OAaG;IACH,YAAY,QAAmC;QAC3C,MAAM,EACF,QAAQ,EACR,SAAS,GAAG,MAAM,EAClB,uBAAuB,GAAG,IAAI,EAC9B,0BAA0B,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,GACvD,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,mBAAmB,GAAG,IAAI,iBAAiB,CAAC;YAC7C,QAAQ,EAAE,IAAI,MAAM,CAAC;gBACjB,OAAO,EAAE,IAAI,aAAa,CAAC;oBACvB,QAAQ,EAAE,QAAQ;iBACrB,CAAC;gBACF,OAAO,EAAE;oBACL,IAAI,gCAAgC,CAAC;wBACjC,IAAI,EAAE,SAAS;qBAClB,CAAC;iBACL;aACJ,CAAC;YACF,0BAA0B;YAC1B,uBAAuB;SAC1B,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,MAAM,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACR,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACN,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACR,GAAW,EACX,KAAa,EACb,UAAuB;QAEvB,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,MAAM,CACR,GAAW,EACX,KAAa,EACb,UAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,KAAoB;QAC1C,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,OAAO,CACT,GAAW,EACX,KAAa,EACb,UAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAW;QAClB,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;CACJ"}
+{"version":3,"file":"sqlite-lock-adapter.js","sourceRoot":"","sources":["../../../../../src/lock/implementations/adapters/sqlite-lock-adapter/sqlite-lock-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAIH,QAAQ,GACX,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gEAAgE,CAAC;AACnG,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAclF;;;;;;;;GAQG;AACH,MAAM,OAAO,iBAAiB;IAGlB,mBAAmB,CAAoB;IAE/C;;;;;;;;;;;;;OAaG;IACH,YAAY,QAAmC;QAC3C,MAAM,EACF,QAAQ,EACR,SAAS,GAAG,MAAM,EAClB,uBAAuB,GAAG,IAAI,EAC9B,0BAA0B,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,GACvD,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,mBAAmB,GAAG,IAAI,iBAAiB,CAAC;YAC7C,QAAQ,EAAE,IAAI,MAAM,CAAC;gBACjB,OAAO,EAAE,IAAI,aAAa,CAAC;oBACvB,QAAQ,EAAE,QAAQ;iBACrB,CAAC;gBACF,OAAO,EAAE;oBACL,IAAI,gCAAgC,CAAC;wBACjC,IAAI,EAAE,SAAS;qBAClB,CAAC;iBACL;aACJ,CAAC;YACF,0BAA0B;YAC1B,uBAAuB;SAC1B,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,MAAM,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACR,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACN,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACR,GAAW,EACX,KAAa,EACb,UAAuB;QAEvB,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,MAAM,CACR,GAAW,EACX,KAAa,EACb,UAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,KAAoB;QAC1C,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,OAAO,CACT,GAAW,EACX,KAAa,EACb,UAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAW;QAClB,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;CACJ"}