@daiso-tech/core 0.26.0 → 0.27.0

package/dist/async/utilities/lazy-promise/lazy-promise.js

@@ -12,6 +12,7 @@ TimeoutAsyncError,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 RetryAsyncError, } from "../../../async/async.errors.js";
 import { resolveAsyncLazyable, } from "../../../utilities/_module-exports.js";
+import { delay } from "../../../async/utilities/_module.js";
 /**
  * The <i>LazyPromise</i> class is used for creating lazy <i>{@link PromiseLike}<i> object that will only execute when awaited or when then method is called.
  * The class includes helpful methods
@@ -38,20 +39,38 @@ export class LazyPromise {
      * The <i>wrapFn</i> is convience method used for wrapping a async method with a <i>LazyPromise</i>.
      * @example
      * ```ts
-     * import { LazyPromise, TimeSpan } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core/async";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
      * import { readFile as readFileNodeJs } from "node:fs/promises";
      *
-     * const readFile = LazyPromise.wrapFn(readFileNodeJs, {
-     *   retryAttempts: 3
-     * });
+     * const readFile = LazyPromise.wrapFn(readFileNodeJs);
      *
-     * (async () => {
-     *   await readFile("none_existing_file.txt").timeout(TimeSpan.fromMinutes(1));
-     * })();
+     * const file = await readFile("none_existing_file.txt")
+     *   .setRetryAttempts(4)
+     *   .timeout(TimeSpan.fromMinutes(1));
      * ```
      */
-    static wrapFn(fn) {
-        return (...parameters) => new LazyPromise(() => fn(...parameters));
+    static wrapFn(fn, settings) {
+        return (...parameters) => new LazyPromise(() => fn(...parameters), settings);
+    }
+    /**
+     * The <i>delay</i> method creates a <i>{@link LazyPromise}</i> that will be fulfilled after given <i>time</i>.
+     *
+     * @throws {AsyncError} {@link AsyncError}
+     * @throws {AbortAsyncError} {@link AbortAsyncError}
+     * @example
+     * ```ts
+     * import { LazyPromise } from "@daiso-tech/core/async";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
+     *
+     * console.log("a");
+     * await LazyPromise.delay(TimeSpan.fromSeconds(2));
+     * console.log("b");
+     */
+    static delay(time) {
+        return new LazyPromise(async () => {
+            await delay(time);
+        });
     }
     /**
      * The <i>all<i> method works similarly to <i>{@link Promise.all}</i> with the key distinction that it operates lazily.
@@ -78,64 +97,70 @@ export class LazyPromise {
         return new LazyPromise(async () => Promise.any(promises));
     }
     promise = null;
-    attempts = null;
-    backoffPolicy_ = null;
-    retryPolicy_ = null;
-    abortSignal = null;
-    time = null;
     asyncFn;
+    settings;
     /**
      * @example
      * ```ts
-     * import { LazyPromise } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core/async";
      *
-     * (async () => {
-     *   const promise = new LazyPromise(async () => {
-     *     console.log("I am lazy");
-     *   });
-     *   // "I am lazy" will only logged when awaited or then method i called.
-     *   await promise;
-     * })();
+     * const promise = new LazyPromise(async () => {
+     *   console.log("I am lazy");
+     * });
+     *
+     * // "I am lazy" will only logged when awaited or then method i called.
+     * await promise;
      */
-    constructor(asyncFn) {
+    constructor(asyncFn, settings = {}) {
         this.asyncFn = () => resolveAsyncLazyable(asyncFn);
+        this.settings = {
+            retryAttempts: null,
+            backoffPolicy: null,
+            retryPolicy: null,
+            abortSignal: null,
+            timeout: null,
+            onFinally: () => { },
+            onSuccess: (_value) => { },
+            onError: () => { },
+            ...settings,
+        };
     }
     applyTimeout() {
-        if (this.time !== null) {
+        if (this.settings.timeout !== null) {
             const oldAsyncFn = this.asyncFn;
             const newAsyncFn = () => {
-                if (this.time === null) {
+                if (this.settings.timeout === null) {
                     throw new Error(`LazyPromise["time"] field is null`);
                 }
-                return timeoutAndFail(oldAsyncFn, this.time);
+                return timeoutAndFail(oldAsyncFn, this.settings.timeout);
             };
             this.asyncFn = newAsyncFn;
         }
     }
     applyRetry() {
-        if (this.attempts !== null) {
+        if (this.settings.retryAttempts !== null) {
             const oldAsyncFn = this.asyncFn;
             const newAsyncFn = () => {
-                if (this.attempts === null) {
+                if (this.settings.retryAttempts === null) {
                     throw new Error(`LazyPromise["attempts"] field is null`);
                 }
                 return retryOrFail(oldAsyncFn, {
-                    backoffPolicy: this.backoffPolicy_ ?? undefined,
-                    retryPolicy: this.retryPolicy_ ?? undefined,
-                    maxAttempts: this.attempts,
+                    backoffPolicy: this.settings.backoffPolicy ?? undefined,
+                    retryPolicy: this.settings.retryPolicy ?? undefined,
+                    maxAttempts: this.settings.retryAttempts,
                 });
             };
             this.asyncFn = newAsyncFn;
         }
     }
     applyAbort() {
-        if (this.abortSignal !== null) {
+        if (this.settings.abortSignal !== null) {
             const oldAsyncFn = this.asyncFn;
             const newAsyncFn = () => {
-                if (this.abortSignal === null) {
+                if (this.settings.abortSignal === null) {
                     throw new Error(`LazyPromise["abortSignal"] field is null`);
                 }
-                return abortAndFail(oldAsyncFn, this.abortSignal);
+                return abortAndFail(oldAsyncFn, this.settings.abortSignal);
             };
             this.asyncFn = newAsyncFn;
         }
@@ -164,7 +189,7 @@ export class LazyPromise {
      * The <i>setRetryAttempts</i> method is used for setting max retry attempts.
      * @example
      * ```ts
-     * import { LazyPromise } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core/async";
      *
      * const promise =
      *   new LazyPromise(async () => {
@@ -172,21 +197,22 @@ export class LazyPromise {
      *     throw new Error("Error occured!");
      *   })
      *   .setRetryAttempts(3)
-     * (async () => {
-     *   // Will log "A" 3 times and then retry error will be thrown.
-     *   await promise;
-     * })();
+     *
+     * // Will log "A" 3 times and then retry error will be thrown.
+     * await promise;
      * ```
      */
     setRetryAttempts(attempts) {
-        this.attempts = attempts;
-        return this;
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            retryAttempts: attempts,
+        });
     }
     /**
      * The <i>setBackoffPolicy</i> method is used for setting a custom <i>{@link BackoffPolicy}</i>.
-     * @example
      * ```ts
-     * import { LazyPromise, linearBackoffPolicy } from "@daiso-tech/core";
+     * import { LazyPromise, linearBackoffPolicy } from "@daiso-tech/core/async";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
      *
      * const promise =
      *   new LazyPromise(async () => {
@@ -195,21 +221,22 @@ export class LazyPromise {
      *   })
      *   .setRetryAttempts(3)
      *   .setBackoffPolicy(linearBackoffPolicy())
-     * (async () => {
-     *   // Will log "A" 3 times and then retry error will be thrown.
-     *   await promise;
-     * })();
+     *
+     * // Will log "A" 3 times and then retry error will be thrown.
+     * await promise;
      * ```
      */
     setBackoffPolicy(policy) {
-        this.backoffPolicy_ = policy;
-        return this;
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            backoffPolicy: policy,
+        });
     }
     /**
      * The <i>setRetryPolicy</i> method is used for setting a custom <i>{@link BackoffPolicy}</i>.
      * @example
      * ```ts
-     * import { LazyPromise } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core/async";
      *
      * class ErrorA extends Error {}
      *
@@ -221,113 +248,126 @@ export class LazyPromise {
      *   .setRetryAttempts(3)
      *   // Will only retry an error that is instance ErrorA
      *   .setRetryPolicy(error => error instanceof ErrorA)
-     * (async () => {
-     *   // Will log "A" 1 time and then error will be thrown.
-     *   await promise;
-     * })();
+     *
+     * // Will log "A" 1 time and then error will be thrown.
+     * await promise;
      * ```
      */
     setRetryPolicy(policy) {
-        this.retryPolicy_ = policy;
-        return this;
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            retryPolicy: policy,
+        });
     }
     /**
      * The <i>setTimeout</i> method aborts the <i>LazyPromise</i> if it exceeds the given <i>time</i> by throwning an error.
      * @example
      * ```ts
-     * import { LazyPromise, delay, TimeSpan } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core/async";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
      *
      * const promise =
      *   new LazyPromise(async () => {
-     *     await delay(TimeSpan.fromMinutes(1));
+     *     await LazyPromise.delay(TimeSpan.fromMinutes(1));
      *   })
      *   .setTimeout(TimeSpan.fromSeconds(1));
-     * (async () => {
-     *   // An timeout error will be thrown.
-     *   await promise;
-     * })();
+     *
+     * // An timeout error will be thrown.
+     * await promise;
      * ```
      */
     setTimeout(time) {
-        this.time = time;
-        return this;
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            timeout: time,
+        });
     }
     /**
      * The <i>setAbortSignal</i> method aborts the <i>LazyPromise</i> by the passed in <i>abortSignal</i>.
      * @example
      * ```ts
-     * import { LazyPromise, delay, TimeSpan } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
      *
      * const abortController = new AbortController();
      * const promise =
      *   new LazyPromise(async () => {
-     *     await delay(TimeSpan.fromMinutes(1));
+     *     await LazyPromise.delay(TimeSpan.fromMinutes(1));
      *   })
      *   .setAbortSignal(abortController.signal);
-     * (async () => {
-     *   setTimeout(() => {
-     *     abortController.abort();
-     *   }, 1000);
-     *   // An timeout error will be thrown.
-     *   await promise;
-     * })();
+     *
+     * setTimeout(() => {
+     *   abortController.abort();
+     * }, 1000);
+     *
+     * // An timeout error will be thrown.
+     * await promise;
      * ```
      */
     setAbortSignal(abortSignal) {
-        this.abortSignal = abortSignal;
-        return this;
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            abortSignal,
+        });
+    }
+    onFinally(cb) {
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            onFinally: cb,
+        });
+    }
+    onSuccess(cb) {
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            onSuccess: cb,
+        });
+    }
+    onError(cb) {
+        return new LazyPromise(this.asyncFn, {
+            ...this.settings,
+            onError: cb,
+        });
     }
     /**
      * The <i>defer</i> method executes the <i>LazyPromise</i> without awaiting it.
      * @example
      * ```ts
-     * import { LazyPromise, delay, TimeSpan } from "@daiso-tech/core";
+     * import { LazyPromise } from "@daiso-tech/core";
+     * import { TimeSpan } from "@daiso-tech/core/utilities";
      *
      * const promise =
      *   new LazyPromise(async () => {
-     *     await delay(TimeSpan.fromSeconds(1));
+     *     await LazyPromise.delay(TimeSpan.fromSeconds(1));
      *     // Will be loged after one second
      *     console.log("Done !");
      *   });
+     *
      * promise.defer();
+     *
      * // Will be logged immediately
      * console.log("Hello");
+     * await LazyPromise.delay(TimeSpan.fromSeconds(2));
      * ```
      */
-    defer(callbacks = {}) {
-        const { onSucces, onError, onFinally } = callbacks;
-        let onSuccesHandler;
-        if (onSucces || onFinally) {
-            onSuccesHandler = async (value) => {
-                try {
-                    if (onSucces !== undefined) {
-                        await onSucces(value);
-                    }
-                    return value;
-                }
-                finally {
-                    if (onFinally !== undefined) {
-                        await onFinally();
-                    }
-                }
-            };
-        }
-        let onErrorHandler;
-        if (onError || onFinally) {
-            onErrorHandler = async (error) => {
-                try {
-                    if (onError !== undefined) {
-                        await onError(error);
-                    }
-                    return error;
-                }
-                finally {
-                    if (onFinally !== undefined) {
-                        await onFinally();
-                    }
-                }
-            };
-        }
+    defer() {
+        const onSuccesHandler = async (value) => {
+            try {
+                await this.settings.onSuccess(value);
+                return value;
+            }
+            finally {
+                await this.settings.onFinally();
+            }
+        };
+        const onErrorHandler = async (error) => {
+            try {
+                await this.settings.onError(error);
+                return error;
+            }
+            finally {
+                await this.settings.onFinally();
+            }
+        };
         this.then(onSuccesHandler, onErrorHandler);
     }
 }

package/dist/async/utilities/lazy-promise/lazy-promise.js.map

@@ -1 +1 @@
-{"version":3,"file":"lazy-promise.js","sourceRoot":"","sources":["../../../../src/async/utilities/lazy-promise/lazy-promise.ts"],"names":[],"mappings":"AAAA;;GAEG;AASH,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO;AACH,6DAA6D;AAC7D,eAAe;AACf,6DAA6D;AAC7D,iBAAiB;AACjB,6DAA6D;AAC7D,eAAe,GAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,oBAAoB,GAEvB,MAAM,gCAAgC,CAAC;AAYxC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,WAAW;IACpB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CACT,EAA2C;QAE3C,OAAO,CAAC,GAAG,UAAU,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,CAAS,QAA+B;QAC9C,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAU,CACb,QAA+B;QAE/B,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAS,QAA+B;QAC/C,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,CAAS,QAA+B;QAC9C,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9D,CAAC;IAEO,OAAO,GAA+B,IAAI,CAAC;IAC3C,QAAQ,GAAkB,IAAI,CAAC;IAC/B,cAAc,GAAyB,IAAI,CAAC;IAC5C,YAAY,GAAuB,IAAI,CAAC;IACxC,WAAW,GAAuB,IAAI,CAAC;IACvC,IAAI,GAAoB,IAAI,CAAC;IAC7B,OAAO,CAA4B;IAE3C;;;;;;;;;;;;OAYG;IACH,YAAY,OAAgC;QACxC,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAEO,YAAY;QAChB,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACrB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;gBACzD,CAAC;gBACD,OAAO,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,UAAU;QACd,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;oBACzB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC7D,CAAC;gBACD,OAAO,WAAW,CAAC,UAAU,EAAE;oBAC3B,aAAa,EAAE,IAAI,CAAC,cAAc,IAAI,SAAS;oBAC/C,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,SAAS;oBAC3C,WAAW,EAAE,IAAI,CAAC,QAAQ;iBAC7B,CAAC,CAAC;YACP,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,UAAU;QACd,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAChE,CAAC;gBACD,OAAO,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACtD,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,aAAa;QACjB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,CACA,WAEU;IACV,8DAA8D;IAC9D,UAAuE;QAEvE,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,CAAC;QACD,qFAAqF;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,QAAuB;QACpC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,CAAC,MAA4B;QACzC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,MAA0B;QACrC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAAqB;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CAAC,WAA+B;QAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,YAAmC,EAAE;QACvC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;QAEnD,IAAI,eAAiE,CAAC;QACtE,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;YACxB,eAAe,GAAG,KAAK,EAAE,KAAa,EAAmB,EAAE;gBACvD,IAAI,CAAC;oBACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBACzB,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC1B,CAAC;oBACD,OAAO,KAAK,CAAC;gBACjB,CAAC;wBAAS,CAAC;oBACP,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;wBAC1B,MAAM,SAAS,EAAE,CAAC;oBACtB,CAAC;gBACL,CAAC;YACL,CAAC,CAAC;QACN,CAAC;QAED,IAAI,cAAkE,CAAC;QACvE,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACvB,cAAc,GAAG,KAAK,EAAE,KAAc,EAAoB,EAAE;gBACxD,IAAI,CAAC;oBACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;wBACxB,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;oBACzB,CAAC;oBACD,OAAO,KAAK,CAAC;gBACjB,CAAC;wBAAS,CAAC;oBACP,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;wBAC1B,MAAM,SAAS,EAAE,CAAC;oBACtB,CAAC;gBACL,CAAC;YACL,CAAC,CAAC;QACN,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IAC/C,CAAC;CACJ"}
+{"version":3,"file":"lazy-promise.js","sourceRoot":"","sources":["../../../../src/async/utilities/lazy-promise/lazy-promise.ts"],"names":[],"mappings":"AAAA;;GAEG;AASH,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO;AACH,6DAA6D;AAC7D,eAAe;AACf,6DAA6D;AAC7D,iBAAiB;AACjB,6DAA6D;AAC7D,eAAe,GAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,oBAAoB,GAEvB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAmCrD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,WAAW;IACpB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,MAAM,CACT,EAA2C,EAC3C,QAAuC;QAEvC,OAAO,CAAC,GAAG,UAAU,EAAE,EAAE,CACrB,IAAI,WAAW,CAAU,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAC,IAAc;QACvB,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE;YAC9B,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,CAAS,QAA+B;QAC9C,OAAO,IAAI,WAAW,CAAW,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAU,CACb,QAA+B;QAE/B,OAAO,IAAI,WAAW,CAAiC,KAAK,IAAI,EAAE,CAC9D,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAC/B,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAS,QAA+B;QAC/C,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,CAAS,QAA+B;QAC9C,OAAO,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9D,CAAC;IAEO,OAAO,GAA+B,IAAI,CAAC;IAC3C,OAAO,CAA4B;IAC1B,QAAQ,CAAwC;IAEjE;;;;;;;;;;;OAWG;IACH,YACI,OAAgC,EAChC,WAAwC,EAAE;QAE1C,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG;YACZ,aAAa,EAAE,IAAI;YACnB,aAAa,EAAE,IAAI;YACnB,WAAW,EAAE,IAAI;YACjB,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC;YACnB,SAAS,EAAE,CAAC,MAAc,EAAE,EAAE,GAAE,CAAC;YACjC,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC;YACjB,GAAG,QAAQ;SACd,CAAC;IACN,CAAC;IAEO,YAAY;QAChB,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YACjC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;oBACjC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;gBACzD,CAAC;gBACD,OAAO,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC7D,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,UAAU;QACd,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,IAAI,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,IAAI,EAAE,CAAC;oBACvC,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC7D,CAAC;gBACD,OAAO,WAAW,CAAC,UAAU,EAAE;oBAC3B,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,SAAS;oBACvD,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,SAAS;oBACnD,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa;iBAC3C,CAAC,CAAC;YACP,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,UAAU;QACd,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YACrC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAChE,CAAC;gBACD,OAAO,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC/D,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,aAAa;QACjB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,CACA,WAEU;IACV,8DAA8D;IAC9D,UAAuE;QAEvE,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,CAAC;QACD,qFAAqF;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,QAAuB;QACpC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,QAAQ;SAC1B,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,MAA4B;QACzC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,MAAM;SACxB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CAAC,MAA0B;QACrC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW,EAAE,MAAM;SACtB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,IAAqB;QAC5B,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,OAAO,EAAE,IAAI;SAChB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,WAA+B;QAC1C,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,EAAwB;QAC9B,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS,EAAE,EAAE;SAChB,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,EAAgC;QACtC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS,EAAE,EAAE;SAChB,CAAC,CAAC;IACP,CAAC;IAED,OAAO,CAAC,EAAsB;QAC1B,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,OAAO,EAAE,EAAE;SACd,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK;QACD,MAAM,eAAe,GAAG,KAAK,EAAE,KAAa,EAAmB,EAAE;YAC7D,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACrC,OAAO,KAAK,CAAC;YACjB,CAAC;oBAAS,CAAC;gBACP,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;YACpC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,cAAc,GAAG,KAAK,EAAE,KAAc,EAAoB,EAAE;YAC9D,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACnC,OAAO,KAAK,CAAC;YACjB,CAAC;oBAAS,CAAC;gBACP,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;YACpC,CAAC;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IAC/C,CAAC;CACJ"}

package/dist/cache/contracts/_module-exports.d.ts

@@ -3,3 +3,4 @@ export * from "../../cache/contracts/cache-factory.contract.js";
 export * from "../../cache/contracts/cache.contract.js";
 export * from "../../cache/contracts/cache.errors.js";
 export * from "../../cache/contracts/cache.events.js";
+export * from "../../cache/contracts/database-cache-adapter.contract.js";

package/dist/cache/contracts/_module-exports.js

@@ -3,4 +3,5 @@ export * from "../../cache/contracts/cache-factory.contract.js";
 export * from "../../cache/contracts/cache.contract.js";
 export * from "../../cache/contracts/cache.errors.js";
 export * from "../../cache/contracts/cache.events.js";
+export * from "../../cache/contracts/database-cache-adapter.contract.js";
 //# sourceMappingURL=_module-exports.js.map

package/dist/cache/contracts/_module-exports.js.map

@@ -1 +1 @@
-{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../src/cache/contracts/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../src/cache/contracts/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC;AAClD,cAAc,sDAAsD,CAAC"}

package/dist/cache/contracts/cache-adapter.contract.d.ts

@@ -3,54 +3,52 @@
  */
 import type { TimeSpan } from "../../utilities/_module-exports.js";
 /**
- * The <i>ICacheAdapter</i> contract defines a way for storing data as key-value pairs independent of data storage.
- * This contract is not meant to be used directly, instead you should use <i>{@link ICache}</i> contract.
+ * The <i>ICacheAdapter</i> contract defines a way for key-value pairs independent of data storage.
  *
  * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
  * @group Contracts
  */
 export type ICacheAdapter<TType = unknown> = {
     /**
-     * The <i>get</i> returns the <i>key</i> value if found otherwise null will be returned.
+     * The <i>get</i> method returns the value when <i>key</i> is found otherwise null will be returned.
      */
     get(key: string): PromiseLike<TType | null>;
     /**
-     * The <i>add</i> method add a new <i>key</i>. Returns true if the <i>key</i> where added otherwise false will be returned.
-     * You must provide a <i>ttl</i> value. If null is passed, the item will not expire.
+     * The <i>getAndRemove</i> method returns the value when <i>key</i> is found otherwise null will be returned.
+     * The key will be removed after it is returned.
      */
-    add(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
+    getAndRemove(key: string): PromiseLike<TType | null>;
     /**
-     * The <i>update</i> method updates a <i>key</i>. Returns true if the <i>key</i> where updated otherwise false will be returned.
+     * The <i>add</i> method adds a <i>key</i> with given <i>value</i> when key doesn't exists. Returns true when key doesn't exists otherwise false will be returned.
+     * You can provide a <i>ttl</i> value. If null is passed, the item will not expire.
      */
-    update(key: string, value: TType): PromiseLike<boolean>;
+    add(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
     /**
-     * The <i>put</i> method replaces a <i>key</i> if the <i>key</i> exists including the ttl value or adds <i>key</i> that do not exists with a given <i>ttl</i>.
+     * The <i>put</i> method replaces th given <i>key</i> with the given <i>value</i> and <i>ttl</i> if the <i>key</i> exists othwerwise it will add the given <i>value</i> and <i>ttl</i>.
      * Returns true if the <i>key</i> where replaced otherwise false is returned.
-     * You must provide a <i>ttl</i> value. If null is passed, the item will not expire.
      */
     put(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
     /**
-     * The <i>remove</i> method removes a <i>key</i>. Returns true if the <i>key</i> is removed otherwise false is returned.
+     * The <i>update</i> method updates the given <i>key</i> with given <i>value</i>. Returns true if the <i>key</i> where updated otherwise false will be returned.
      */
-    remove(key: string): PromiseLike<boolean>;
+    update(key: string, value: TType): PromiseLike<boolean>;
     /**
-     * The <i>increment</i> method will increment the given <i>key</i> if found otherwise nonthing will occur.
-     * Returns true if key is incremented otherwise false will be returned.
+     * The <i>increment</i> method increments the given <i>key</i> with given <i>value</i>. Returns true if the <i>key</i> where incremented otherwise false will be returned.
+     * If <i>values</i> is not defined then it will increment the key with 1.
      * An error will thrown if the key is not a number.
      * @throws {TypeCacheError} {@link TypeCacheError}
      */
     increment(key: string, value: number): PromiseLike<boolean>;
     /**
-     * The <i>clear</i> method removes all keys that starts <i>prefix</i>.
+     * The <i>removeMany</i> method removes many keys. Returns true if one of the keys where deleted otherwise false is returned.
      */
-    clear(): PromiseLike<void>;
+    removeMany(keys: string[]): PromiseLike<boolean>;
     /**
-     * The <i>getGroup</i> method returns the group name.
+     * The <i>removeAll</i> method removes all keys from the cache.
      */
-    getGroup(): string;
+    removeAll(): PromiseLike<void>;
     /**
-     * The <i>withGroup</i> method returns a new <i>{@link ICacheAdapter}</i> instance that groups keys together.
-     * Only keys in the same group will be updated, removed, or retrieved, leaving keys outside the group unaffected.
+     * The <i>removeByKeyPrefix</i> method removes all the keys in the cache that starts with the given <i>prefix</i>.
      */
-    withGroup(group: string): ICacheAdapter<TType>;
+    removeByKeyPrefix(prefix: string): PromiseLike<void>;
 };

package/dist/cache/contracts/cache-adapter.contract.js

@@ -1,5 +1,2 @@
-/**
- * @module Cache
- */
-import {} from "../../cache/contracts/cache.errors.js";
+export {};
 //# sourceMappingURL=cache-adapter.contract.js.map

package/dist/cache/contracts/cache-adapter.contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache-adapter.contract.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAGN,MAAM,mCAAmC,CAAC"}
+{"version":3,"file":"cache-adapter.contract.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache-adapter.contract.ts"],"names":[],"mappings":""}

package/dist/cache/contracts/cache-factory.contract.d.ts

@@ -11,7 +11,7 @@ import type { IGroupableCache } from "../../cache/contracts/cache.contract.js";
 export type ICacheFactory<TAdapters extends string = string> = {
     /**
      * The <i>use</i> method will throw an error if you provide it unregisted adapter.
-     * If no default adapter is defined an error will be thrown by <i>use</i> method.
+     * If no default adapter is defined an error will be thrown.
      * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
      * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
      */