@daiso-tech/core 0.22.2 → 0.24.0

package/dist/async/utilities/retry/retry-or-fail.js

@@ -0,0 +1,39 @@
+/**
+ * @module Async
+ */
+import { delay } from "../../../async/utilities/_module.js";
+import { AbortAsyncError, RetryAsyncError } from "../../../async/async.errors.js";
+import { exponentialBackoffPolicy } from "../../../async/backof-policies/_module.js";
+import { TimeSpan } from "../../../utilities/_module-exports.js";
+/**
+ * @internal
+ */
+export async function retryOrFail(asyncFn, settings = {}) {
+    const { maxAttempts = 4, backoffPolicy = exponentialBackoffPolicy(), retryPolicy = () => true, } = settings;
+    let error_;
+    for (let attempt = 1; attempt <= maxAttempts; attempt++) {
+        try {
+            return await asyncFn();
+        }
+        catch (error) {
+            error_ = error;
+            if (error instanceof AbortAsyncError) {
+                throw error;
+            }
+            if (!retryPolicy(error)) {
+                throw error;
+            }
+            const time = backoffPolicy(attempt, error);
+            await delay(TimeSpan.fromMilliseconds(time));
+        }
+    }
+    let errorMessage = `Promise was failed after retried ${String(maxAttempts)} times`;
+    if (error_) {
+        errorMessage = `${errorMessage} and last thrown error was "${String(error_)}"`;
+    }
+    throw new RetryAsyncError(errorMessage, {
+        cause: error_,
+        maxAttempts,
+    });
+}
+//# sourceMappingURL=retry-or-fail.js.map

package/dist/async/utilities/retry/retry-or-fail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-or-fail.js","sourceRoot":"","sources":["../../../../src/async/utilities/retry/retry-or-fail.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAwB1D;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC7B,OAAkC,EAClC,WAA0B,EAAE;IAE5B,MAAM,EACF,WAAW,GAAG,CAAC,EACf,aAAa,GAAG,wBAAwB,EAAE,EAC1C,WAAW,GAAG,GAAG,EAAE,CAAC,IAAI,GAC3B,GAAG,QAAQ,CAAC;IACb,IAAI,MAAe,CAAC;IACpB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACtD,IAAI,CAAC;YACD,OAAO,MAAM,OAAO,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM,GAAG,KAAK,CAAC;YACf,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;gBACnC,MAAM,KAAK,CAAC;YAChB,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,MAAM,KAAK,CAAC;YAChB,CAAC;YACD,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3C,MAAM,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;IAED,IAAI,YAAY,GAAG,oCAAoC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;IACnF,IAAI,MAAM,EAAE,CAAC;QACT,YAAY,GAAG,GAAG,YAAY,+BAA+B,MAAM,CAAC,MAAiB,CAAC,GAAG,CAAC;IAC9F,CAAC;IACD,MAAM,IAAI,eAAe,CAAC,YAAY,EAAE;QACpC,KAAK,EAAE,MAAM;QACb,WAAW;KACd,CAAC,CAAC;AACP,CAAC"}

package/dist/async/utilities/retry/retry.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @module Async
+ */
+import { RetryAsyncError } from "../../../async/async.errors.js";
+import type { Result } from "../../../utilities/types.js";
+import type { RetrySettings } from "../../../async/utilities/retry/retry-or-fail.js";
+/**
+ * @internal
+ */
+export declare function retry<TValue = void>(asyncFn: () => PromiseLike<TValue>, settings?: RetrySettings): Promise<Result<TValue, RetryAsyncError>>;

package/dist/async/utilities/retry/retry.js

@@ -0,0 +1,21 @@
+/**
+ * @module Async
+ */
+import { RetryAsyncError } from "../../../async/async.errors.js";
+import { retryOrFail } from "../../../async/utilities/retry/retry-or-fail.js";
+/**
+ * @internal
+ */
+export async function retry(asyncFn, settings = {}) {
+    try {
+        const value = await retryOrFail(asyncFn, settings);
+        return [value, null];
+    }
+    catch (error) {
+        if (error instanceof RetryAsyncError) {
+            return [null, error];
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=retry.js.map

package/dist/async/utilities/retry/retry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.js","sourceRoot":"","sources":["../../../../src/async/utilities/retry/retry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG1D,OAAO,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACvB,OAAkC,EAClC,WAA0B,EAAE;IAE5B,IAAI,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACnD,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACtB,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;AACL,CAAC"}

package/dist/async/utilities/timeout/_module.d.ts

@@ -0,0 +1,2 @@
+export * from "../../../async/utilities/timeout/timeout-and-fail.js";
+export * from "../../../async/utilities/timeout/timeout.js";

package/dist/async/utilities/timeout/_module.js

@@ -0,0 +1,3 @@
+export * from "../../../async/utilities/timeout/timeout-and-fail.js";
+export * from "../../../async/utilities/timeout/timeout.js";
+//# sourceMappingURL=_module.js.map

package/dist/async/utilities/timeout/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/async/utilities/timeout/_module.ts"],"names":[],"mappings":"AAAA,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sCAAsC,CAAC"}

package/dist/async/utilities/timeout/timeout-and-fail.d.ts

@@ -0,0 +1,5 @@
+import type { TimeSpan } from "../../../utilities/_module-exports.js";
+/**
+ * @internal
+ */
+export declare function timeoutAndFail<TValue>(asyncFn: () => PromiseLike<TValue>, time: TimeSpan): Promise<TValue>;

package/dist/async/utilities/timeout/timeout-and-fail.js

@@ -0,0 +1,28 @@
+/**
+ * @module Async
+ */
+import { AbortAsyncError, TimeoutAsyncError } from "../../../async/async.errors.js";
+import { abortAndFail } from "../../../async/utilities/abort/_module.js";
+/**
+ * @internal
+ */
+export async function timeoutAndFail(asyncFn, time) {
+    const timeoutController = new AbortController();
+    const timeoutId = setTimeout(() => {
+        timeoutController.abort(new TimeoutAsyncError("The promise exceded time"));
+    }, time.toMilliseconds());
+    try {
+        return await abortAndFail(asyncFn, timeoutController.signal);
+    }
+    catch (error) {
+        if (error instanceof AbortAsyncError &&
+            error.cause instanceof TimeoutAsyncError) {
+            throw error.cause;
+        }
+        throw error;
+    }
+    finally {
+        clearTimeout(timeoutId);
+    }
+}
+//# sourceMappingURL=timeout-and-fail.js.map

package/dist/async/utilities/timeout/timeout-and-fail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout-and-fail.js","sourceRoot":"","sources":["../../../../src/async/utilities/timeout/timeout-and-fail.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE7E,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAChC,OAAkC,EAClC,IAAc;IAEd,MAAM,iBAAiB,GAAG,IAAI,eAAe,EAAE,CAAC;IAChD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;QAC9B,iBAAiB,CAAC,KAAK,CACnB,IAAI,iBAAiB,CAAC,0BAA0B,CAAC,CACpD,CAAC;IACN,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;IAC1B,IAAI,CAAC;QACD,OAAO,MAAM,YAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACtB,IACI,KAAK,YAAY,eAAe;YAChC,KAAK,CAAC,KAAK,YAAY,iBAAiB,EAC1C,CAAC;YACC,MAAM,KAAK,CAAC,KAAK,CAAC;QACtB,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;YAAS,CAAC;QACP,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;AACL,CAAC"}

package/dist/async/utilities/timeout/timeout.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @module Async
+ */
+import { TimeoutAsyncError } from "../../../async/async.errors.js";
+import type { TimeSpan } from "../../../utilities/_module-exports.js";
+import type { Result } from "../../../utilities/types.js";
+/**
+ * @internal
+ */
+export declare function timeout<TValue>(asyncFn: () => PromiseLike<TValue>, time: TimeSpan): Promise<Result<TValue, TimeoutAsyncError>>;

package/dist/async/utilities/timeout/timeout.js

@@ -0,0 +1,21 @@
+/**
+ * @module Async
+ */
+import { TimeoutAsyncError } from "../../../async/async.errors.js";
+import { timeoutAndFail } from "../../../async/utilities/timeout/timeout-and-fail.js";
+/**
+ * @internal
+ */
+export async function timeout(asyncFn, time) {
+    try {
+        const value = await timeoutAndFail(asyncFn, time);
+        return [value, null];
+    }
+    catch (error) {
+        if (error instanceof TimeoutAsyncError) {
+            return [null, error];
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=timeout.js.map

package/dist/async/utilities/timeout/timeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout.js","sourceRoot":"","sources":["../../../../src/async/utilities/timeout/timeout.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAG5D,OAAO,EAAE,cAAc,EAAE,MAAM,+CAA+C,CAAC;AAE/E;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CACzB,OAAkC,EAClC,IAAc;IAEd,IAAI,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACtB,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACzB,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,5 @@
+export * from "../../cache/contracts/cache-adapter.contract.js";
+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";

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

@@ -0,0 +1,6 @@
+export * from "../../cache/contracts/cache-adapter.contract.js";
+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";
+//# sourceMappingURL=_module-exports.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,56 @@
+/**
+ * @module Cache
+ */
+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.
+ *
+ * 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.
+     */
+    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.
+     */
+    add(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
+    /**
+     * The <i>update</i> method updates a <i>key</i>. Returns true if the <i>key</i> where updated otherwise false will be returned.
+     */
+    update(key: string, value: TType): 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>.
+     * 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.
+     */
+    remove(key: string): 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.
+     * 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>.
+     */
+    clear(): PromiseLike<void>;
+    /**
+     * The <i>getGroup</i> method returns the group name.
+     */
+    getGroup(): string;
+    /**
+     * 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.
+     */
+    withGroup(group: string): ICacheAdapter<TType>;
+};

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

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

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

@@ -0,0 +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"}

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

@@ -0,0 +1,19 @@
+/**
+ * @module Cache
+ */
+import type { IGroupableCache } from "../../cache/contracts/cache.contract.js";
+/**
+ * The <i>ICacheFactory</i> contract makes it easy to configure and switch between different <i>{@link IGroupableCache}</i> dynamically.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Contracts
+ */
+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.
+     * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
+     * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
+     */
+    use<TType = unknown>(adapterName?: TAdapters): IGroupableCache<TType>;
+};

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

@@ -0,0 +1,9 @@
+/**
+ * @module Cache
+ */
+import { 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+UnregisteredAdapterError, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+DefaultAdapterNotDefinedError, } from "../../utilities/errors.js";
+//# sourceMappingURL=cache-factory.contract.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache-factory.contract.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache-factory.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAChC,MAAM,uBAAuB,CAAC"}

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

@@ -0,0 +1,156 @@
+/**
+ * @module Cache
+ */
+import type { IEventListener } from "../../event-bus/contracts/_module-exports.js";
+import type { OneOrMore } from "../../utilities/_module-exports.js";
+import { type AsyncLazyable, type GetOrAddValue } from "../../utilities/_module-exports.js";
+import type { CacheEvents } from "../../cache/contracts/_module-exports.js";
+import type { TimeSpan } from "../../utilities/_module-exports.js";
+import type { LazyPromise } from "../../async/_module-exports.js";
+/**
+ * The <i>ICacheListener</i> contract defines a way for listening <i>{@link ICache}</i> operations.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Contracts
+ */
+export type ICacheListener<TType = unknown> = IEventListener<CacheEvents<TType>>;
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Contracts
+ */
+export type WithTtlValue<TType> = {
+    value: TType;
+    /**
+     * You can provide a <i>ttl</i> value. If null is passed, the item will not expire.
+     */
+    ttl?: TimeSpan | null;
+};
+/**
+ * The <i>ICache</i> contract defines a way for storing data as key-value pairs independent of data storage.
+ * It commes with more convient methods compared to <i>ICacheAdapter</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Contracts
+ */
+export type ICache<TType = unknown> = ICacheListener & {
+    /**
+     * The <i>exists</i> method returns true when <i>key</i> is found otherwise false will be returned.
+     */
+    exists(key: string): LazyPromise<boolean>;
+    /**
+     * The <i>existsMany</i> method returns true for the <i>keys</i> that are found otherwise false will be returned.
+     */
+    existsMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
+    /**
+     * The <i>missing</i> method returns true when <i>key</i> is not found otherwise false will be returned.
+     */
+    missing(key: string): LazyPromise<boolean>;
+    /**
+     * The <i>missingMany</i> method returns true for the <i>keys</i> that are not found otherwise false will be returned.
+     */
+    missingMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
+    /**
+     * The <i>get</i> method returns the value when <i>key</i> is found otherwise null will be returned.
+     */
+    get(key: string): LazyPromise<TType | null>;
+    /**
+     * The <i>getMany</i> returns the value for the <i>keys</i> that are found otherwise null will be returned.
+     */
+    getMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, TType | null>>;
+    /**
+     * The <i>getOr</i> method returns the value when <i>key</i> is found otherwise <i>defaultValue</i> will be returned.
+     */
+    getOr(key: string, defaultValue: AsyncLazyable<TType>): LazyPromise<TType>;
+    /**
+     * The <i>getOrMany</i> method returns the value for the keys that are found otherwise defaultValue will be returned.
+     */
+    getOrMany<TKeys extends string>(keysWithDefaults: Record<TKeys, AsyncLazyable<TType>>): LazyPromise<Record<TKeys, TType>>;
+    /**
+     * The <i>getOrFail</i> method returns the value when <i>key</i> is found otherwise an error will be thrown.
+     * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
+     */
+    getOrFail(key: string): LazyPromise<TType>;
+    /**
+     * 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.
+     */
+    add(key: string, value: TType, ttl?: TimeSpan | null): LazyPromise<boolean>;
+    /**
+     * The <i>addMany</i> method adds new keys. Returns true for the keys that where added otherwise false will be returned.
+     */
+    addMany<TKeys extends string>(values: Record<TKeys, WithTtlValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
+    /**
+     * The <i>update</i> method updates the given <i>key</i> with given <i>value</i>. Returns true when key otherwise false will be returned.
+     */
+    update(key: string, value: TType): LazyPromise<boolean>;
+    /**
+     * The <i>updateMany</i> method updates the given keys. Returns true for the keys that where updated otherwise false will be returned.
+     */
+    updateMany<TKeys extends string>(values: Record<TKeys, TType>): LazyPromise<Record<TKeys, 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>.
+     * Returns true if the <i>key</i> where replaced otherwise false is returned.
+     * You can provide a <i>ttl</i> value for the replaced key. If <i>null</i> is passed, the item will not expires and <i>null</i> is the default value.
+     */
+    put(key: string, value: TType, ttl?: TimeSpan | null): LazyPromise<boolean>;
+    /**
+     * The <i>putMany</i> method replaces the keys that exists including their ttl values or adds keys that do not exists.
+     * Returns true for all the keys that where replaced otherwise false is returned.
+     */
+    putMany<TKeys extends string>(values: Record<TKeys, WithTtlValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
+    /**
+     * The <i>remove</i> method removes the given <i>key</i> when found. Returns true if the key is found otherwise false is returned.
+     */
+    remove(key: string): LazyPromise<boolean>;
+    /**
+     * The <i>removeMany</i> method removes keys. Returns true for the keys that are removed otherwise false is returned.
+     */
+    removeMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
+    /**
+     * The <i>getAndRemove</i> method removes the given <i>key</i> and returns it when found otherwise null will be returned.
+     */
+    getAndRemove(key: string): LazyPromise<TType | null>;
+    /**
+     * The <i>getOrAdd</i> method will retrieve the given <i>key</i> if found otherwise <i>valueToAdd</i> will be added and returned.
+     * The <i>valueToAdd<i> can be async or sync function.
+     */
+    getOrAdd(key: string, valueToAdd: AsyncLazyable<GetOrAddValue<TType>>, ttl?: TimeSpan | null): LazyPromise<TType>;
+    /**
+     * 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.
+     * An error will thrown if the key is not a number.
+     * @throws {TypeCacheError} {@link TypeCacheError}
+     */
+    increment(key: string, value?: Extract<TType, number>): LazyPromise<boolean>;
+    /**
+     * The <i>decrement</i> method will decrement the given <i>key</i> if found otherwise nonthing will occur.
+     * Returns true if key exists otherwise false will be returned.
+     * An error will thrown if the key is not a number.
+     * @throws {TypeCacheError} {@link TypeCacheError}
+     */
+    decrement(key: string, value?: Extract<TType, number>): LazyPromise<boolean>;
+    /**
+     * The <i>clear</i> method removes all the keys in the cache.
+     */
+    clear(): LazyPromise<void>;
+    /**
+     * The <i>getGroup</i> method returns the group name.
+     */
+    getGroup(): string;
+};
+/**
+ * The <i>IGroupableCache</i> contract defines a way for storing data as key-value pairs independent of data storage.
+ * It commes with one extra method which is useful for multitennat applications compared to <i>{@link ICache}</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Contracts
+ */
+export type IGroupableCache<TType = unknown> = ICache<TType> & {
+    /**
+     * The <i>withGroup</i> method returns a new <i>{@link ICache}</i> instance that groups keys together.
+     * Only keys in the same group will be updated, removed, or retrieved, leaving keys outside the group unaffected.
+     * This useful for multitennat applications.
+     */
+    withGroup(group: OneOrMore<string>): ICache<TType>;
+};

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

@@ -0,0 +1,6 @@
+/**
+ * @module Cache
+ */
+import {} from "../../utilities/_module-exports.js";
+import {} from "../../cache/contracts/_module-exports.js";
+//# sourceMappingURL=cache.contract.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache.contract.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAGN,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAON,MAAM,sCAAsC,CAAC"}

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

@@ -0,0 +1,49 @@
+/**
+ * @module Cache
+ */
+import type { IFlexibleSerde, ISerializable } from "../../serde/contracts/_module-exports.js";
+import { type ISerializedError, type OneOrMore } from "../../utilities/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export declare class CacheError extends Error implements ISerializable<ISerializedError> {
+    static deserialize(deserializedValue: ISerializedError): CacheError;
+    constructor(message: string, cause?: unknown);
+    serialize(): ISerializedError;
+}
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export declare class UnexpectedCacheError extends CacheError implements ISerializable<ISerializedError> {
+    static deserialize(deserializedValue: ISerializedError): CacheError;
+    constructor(message: string, cause?: unknown);
+}
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export declare class TypeCacheError extends CacheError implements ISerializable<ISerializedError> {
+    static deserialize(deserializedValue: ISerializedError): CacheError;
+    constructor(message: string, cause?: unknown);
+}
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export declare class KeyNotFoundCacheError extends CacheError implements ISerializable<ISerializedError> {
+    static deserialize(deserializedValue: ISerializedError): CacheError;
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The <i>registerCacheErrorsToSerde</i> function registers all <i>{@link IGroupableCache}</i> related errors with <i>IFlexibleSerde</i>, ensuring they will properly be serialized and deserialized.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export declare function registerCacheErrorsToSerde(serde: OneOrMore<IFlexibleSerde>): void;

package/dist/cache/contracts/cache.errors.js

@@ -0,0 +1,86 @@
+/**
+ * @module Cache
+ */
+import { CORE, } from "../../utilities/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export class CacheError extends Error {
+    static deserialize(deserializedValue) {
+        return new CacheError(deserializedValue.message, deserializedValue.cause);
+    }
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = CacheError.name;
+    }
+    serialize() {
+        return {
+            name: this.name,
+            message: this.message,
+            cause: this.cause,
+        };
+    }
+}
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export class UnexpectedCacheError extends CacheError {
+    static deserialize(deserializedValue) {
+        return new UnexpectedCacheError(deserializedValue.message, deserializedValue.cause);
+    }
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = UnexpectedCacheError.name;
+    }
+}
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export class TypeCacheError extends CacheError {
+    static deserialize(deserializedValue) {
+        return new TypeCacheError(deserializedValue.message, deserializedValue.cause);
+    }
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = TypeCacheError.name;
+    }
+}
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export class KeyNotFoundCacheError extends CacheError {
+    static deserialize(deserializedValue) {
+        return new KeyNotFoundCacheError(deserializedValue.message, deserializedValue.cause);
+    }
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = KeyNotFoundCacheError.name;
+    }
+}
+/**
+ * The <i>registerCacheErrorsToSerde</i> function registers all <i>{@link IGroupableCache}</i> related errors with <i>IFlexibleSerde</i>, ensuring they will properly be serialized and deserialized.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * @group Errors
+ */
+export function registerCacheErrorsToSerde(serde) {
+    if (!Array.isArray(serde)) {
+        serde = [serde];
+    }
+    for (const serde_ of serde) {
+        serde_
+            .registerClass(CacheError, CORE)
+            .registerClass(UnexpectedCacheError, CORE)
+            .registerClass(TypeCacheError, CORE)
+            .registerClass(KeyNotFoundCacheError, CORE);
+    }
+}
+//# sourceMappingURL=cache.errors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache.errors.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAQH,OAAO,EACH,IAAI,GAGP,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,MAAM,OAAO,UACT,SAAQ,KAAK;IAGb,MAAM,CAAC,WAAW,CAAC,iBAAmC;QAClD,OAAO,IAAI,UAAU,CACjB,iBAAiB,CAAC,OAAO,EACzB,iBAAiB,CAAC,KAAK,CAC1B,CAAC;IACN,CAAC;IAED,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,SAAS;QACL,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;IACN,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,oBACT,SAAQ,UAAU;IAGlB,MAAM,CAAU,WAAW,CACvB,iBAAmC;QAEnC,OAAO,IAAI,oBAAoB,CAC3B,iBAAiB,CAAC,OAAO,EACzB,iBAAiB,CAAC,KAAK,CAC1B,CAAC;IACN,CAAC;IAED,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAC1C,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,cACT,SAAQ,UAAU;IAGlB,MAAM,CAAU,WAAW,CACvB,iBAAmC;QAEnC,OAAO,IAAI,cAAc,CACrB,iBAAiB,CAAC,OAAO,EACzB,iBAAiB,CAAC,KAAK,CAC1B,CAAC;IACN,CAAC;IAED,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;IACpC,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,qBACT,SAAQ,UAAU;IAGlB,MAAM,CAAU,WAAW,CACvB,iBAAmC;QAEnC,OAAO,IAAI,qBAAqB,CAC5B,iBAAiB,CAAC,OAAO,EACzB,iBAAiB,CAAC,KAAK,CAC1B,CAAC;IACN,CAAC;IAED,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;IAC3C,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACtC,KAAgC;IAEhC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM;aACD,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC;aAC/B,aAAa,CAAC,oBAAoB,EAAE,IAAI,CAAC;aACzC,aAAa,CAAC,cAAc,EAAE,IAAI,CAAC;aACnC,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;AACL,CAAC"}