@daiso-tech/core 0.42.0 → 0.44.0

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

@@ -1,11 +1,11 @@
 /**
  * @module Cache
  */
-import type { Task } from "../../task/_module-exports.js";
-import type { AsyncLazyable, NoneFunc } from "../../utilities/_module-exports.js";
-import type { CacheEventMap } from "../../cache/contracts/cache.events.js";
-import type { IEventListenable } from "../../event-bus/contracts/_module-exports.js";
-import type { ITimeSpan } from "../../time-span/contracts/_module-exports.js";
+import { type CacheEventMap } from "../../cache/contracts/cache.events.js";
+import { type IEventListenable } from "../../event-bus/contracts/_module.js";
+import { type ITask } from "../../task/contracts/_module.js";
+import { type ITimeSpan } from "../../time-span/contracts/_module.js";
+import { type AsyncLazyable, type NoneFunc } from "../../utilities/_module.js";
 /**
  * The `ICacheListenable` contract defines a way for listening {@link ICache | `ICache`} operation events.
  *
@@ -13,6 +13,20 @@ import type { ITimeSpan } from "../../time-span/contracts/_module-exports.js";
  * @group Contracts
  */
 export type ICacheListenable<TType = unknown> = IEventListenable<CacheEventMap<TType>>;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
+ * @group Contracts
+ */
+export type CacheWriteSettings = {
+    ttl?: ITimeSpan | null;
+    jitter?: number;
+    /**
+     * Used internally for testin.
+     *
+     * @internal
+     */
+    _mathRandom?: () => number;
+};
 /**
  * The `ICacheBase` contract defines a way for as key-value pairs independent of data storage.
  *
@@ -22,109 +36,79 @@ export type ICacheListenable<TType = unknown> = IEventListenable<CacheEventMap<T
 export type ICacheBase<TType = unknown> = {
     /**
      * The `exists` method returns true when `key` is found otherwise false will be returned.
-     *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
      */
-    exists(key: string): Task<boolean>;
+    exists(key: string): ITask<boolean>;
     /**
      * The `missing` method returns true when `key` is not found otherwise false will be returned.
-     *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
      */
-    missing(key: string): Task<boolean>;
+    missing(key: string): ITask<boolean>;
     /**
      * The `get` method returns the value when `key` is found otherwise null will be returned.
-     *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
      */
-    get(key: string): Task<TType | null>;
+    get(key: string): ITask<TType | null>;
     /**
      * The `getOrFail` method returns the value when `key` is found otherwise an error will be thrown.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
-     *
      * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
      */
-    getOrFail(key: string): Task<TType>;
+    getOrFail(key: string): ITask<TType>;
     /**
      * The `getAndRemove` method returns the value when `key` is found otherwise null will be returned.
      * The key will be removed after it is returned.
-     *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
      */
-    getAndRemove(key: string): Task<TType | null>;
+    getAndRemove(key: string): ITask<TType | null>;
     /**
      * The `getOr` method will retrieve the given `key` if found otherwise `defaultValue` will be returned.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
-     *
-     * @param defaultValue - can be regular value, sync or async {@link Invokable | `Invokable`} value and {@link Task | `Task`} value.
+     * @param defaultValue - can be regular value, sync or async {@link Invokable | `Invokable`} value and {@link ITask | `ITask`} value.
      */
-    getOr(key: string, defaultValue: AsyncLazyable<NoneFunc<TType>>): Task<TType>;
+    getOr(key: string, defaultValue: AsyncLazyable<NoneFunc<TType>>): ITask<TType>;
     /**
      * The `getOrAdd` method will retrieve the given `key` if found otherwise `valueToAdd` will be added and returned.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
-     *
-     * @param valueToAdd - can be regular value, sync or async {@link Invokable | `Invokable`} value and {@link Task | `Task`} value.
+     * @param valueToAdd - can be regular value, sync or async {@link Invokable | `Invokable`} value and {@link ITask | `ITask`} value.
      */
-    getOrAdd(key: string, valueToAdd: AsyncLazyable<NoneFunc<TType>>, ttl?: ITimeSpan | null): Task<TType>;
+    getOrAdd(key: string, valueToAdd: AsyncLazyable<NoneFunc<TType>>, settings?: CacheWriteSettings): ITask<TType>;
     /**
      * The `add` method adds a `key` with given `value` when key doesn't exists.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
-     *
      * @param ttl - If null is passed, the item will not expire.
      *
      * @returns Returns true when key doesn't exists otherwise false will be returned.
      */
-    add(key: string, value: TType, ttl?: ITimeSpan | null): Task<boolean>;
+    add(key: string, value: TType, settings?: CacheWriteSettings): ITask<boolean>;
+    /**
+     * The `addOrFail` method adds a `key` with given `value` when key doesn't exists.
+     * Throws an error if the `key` exists.
+     *
+     * @throws {KeyExistsCacheError} {@link KeyExistsCacheError}
+     */
+    addOrFail(key: string, value: TType, settings?: CacheWriteSettings): ITask<void>;
     /**
      * The `put` method replaces th given `key` with the given `value` and `ttl` if the `key` exists
      * othwerwise it will add the given `value` with the given `ttl`.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
-     *
      * @param ttl - If null is passed, the item will not expire.
      *
      * @returns Returns true if the `key` where replaced otherwise false is returned.
      */
-    put(key: string, value: TType, ttl?: ITimeSpan | null): Task<boolean>;
+    put(key: string, value: TType, settings?: CacheWriteSettings): ITask<boolean>;
     /**
      * The `update` method updates the given `key` with given `value`.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
-     *
      * @returns Returns true if the `key` where updated otherwise false will be returned.
      */
-    update(key: string, value: TType): Task<boolean>;
+    update(key: string, value: TType): ITask<boolean>;
     /**
-     * The `increment` method increments the given `key` with given `value`.
-     * An error will thrown if the key is not a number.
+     * The `updateOrFail` method updates the given `key` with given `value`.
+     * Thorws error if the `key` is not found.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
+     * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
+     */
+    updateOrFail(key: string, value: TType): ITask<void>;
+    /**
+     * The `increment` method increments the given `key` with given `value`.
+     * An error will thrown if the value is not a number.
      *
      * @param value - If not defined then it will be defaulted to 1.
      *
@@ -132,14 +116,20 @@ export type ICacheBase<TType = unknown> = {
      *
      * @throws {TypeError} {@link TypeError}
      */
-    increment(key: string, value?: Extract<TType, number>): Task<boolean>;
+    increment(key: string, value?: Extract<TType, number>): ITask<boolean>;
     /**
-     * The `decrement` method decrements the given `key` with given `value`.
-     * An error will thrown if the key is not a number.
+     * The `incrementOrFail` method increments the given `key` with given `value`.
+     * An error will thrown if the value is not a number or if the key is not found.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
+     * @param value - If not defined then it will be defaulted to 1.
+     *
+     * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
+     * @throws {TypeError} {@link TypeError}
+     */
+    incrementOrFail(key: string, value?: Extract<TType, number>): ITask<void>;
+    /**
+     * The `decrement` method decrements the given `key` with given `value`.
+     * An error will thrown if the value is not a number.
      *
      * @param value - If not defined then it will be defaulted to 1.
      *
@@ -147,17 +137,30 @@ export type ICacheBase<TType = unknown> = {
      *
      * @throws {TypeError} {@link TypeError}
      */
-    decrement(key: string, value?: Extract<TType, number>): Task<boolean>;
+    decrement(key: string, value?: Extract<TType, number>): ITask<boolean>;
     /**
-     * The `remove` method removes the given `key`.
+     * The `decrementOrFail` method decrements the given `key` with given `value`.
+     * An error will thrown if the value is not a number or if the key is not found.
      *
-     * @param key - can be a string or an `Iterable` of strings.
-     * If it's an `Iterable`, it will be joined into a single string.
-     * Think of an `Iterable` as representing a path.
+     * @param value - If not defined then it will be defaulted to 1.
+     *
+     * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
+     * @throws {TypeError} {@link TypeError}
+     */
+    decrementOrFail(key: string, value?: Extract<TType, number>): ITask<void>;
+    /**
+     * The `remove` method removes the given `key`.
      *
      * @returns Returns true if the key is found otherwise false is returned.
      */
-    remove(key: string): Task<boolean>;
+    remove(key: string): ITask<boolean>;
+    /**
+     * The `removeOrFail` method removes the given `key`.
+     * Throws an error if the key is not found.
+     *
+     * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
+     */
+    removeOrFail(key: string): ITask<void>;
     /**
      * The `removeMany` method removes many keys.
      *
@@ -167,11 +170,11 @@ export type ICacheBase<TType = unknown> = {
      *
      * @returns Returns true if one of the keys where deleted otherwise false is returned.
      */
-    removeMany(keys: Iterable<string>): Task<boolean>;
+    removeMany(keys: Iterable<string>): ITask<boolean>;
     /**
      * The `clear` method removes all the keys in the cache. If a cache is in a group then only the keys part of the group will be removed.
      */
-    clear(): Task<void>;
+    clear(): ITask<void>;
 };
 /**
  * The `ICache` contract defines a way for as key-value pairs independent of data storage and listening to operation events.

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

@@ -1,5 +1,14 @@
 /**
  * @module Cache
  */
-export {};
+import { 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+KeyExistsCacheError, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+KeyNotFoundCacheError, } from "../../cache/contracts/cache.errors.js";
+import {} from "../../cache/contracts/cache.events.js";
+import {} from "../../event-bus/contracts/_module.js";
+import {} from "../../task/contracts/_module.js";
+import {} from "../../time-span/contracts/_module.js";
+import {} from "../../utilities/_module.js";
 //# sourceMappingURL=cache.contract.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"cache.contract.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.contract.ts"],"names":[],"mappings":"AAAA;;GAEG"}
+{"version":3,"file":"cache.contract.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO;AACH,6DAA6D;AAC7D,mBAAmB;AACnB,6DAA6D;AAC7D,qBAAqB,GACxB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAsB,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAyB,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAKN,MAAM,wBAAwB,CAAC"}

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

@@ -1,6 +1,7 @@
 /**
  * @module Cache
  */
+import { type Key } from "../../namespace/_module.js";
 /**
  * The error is thrown when a key is not found
  *
@@ -8,6 +9,27 @@
  * @group Errors
  */
 export declare class KeyNotFoundCacheError extends Error {
+    static create(key: Key, cause?: unknown): KeyNotFoundCacheError;
+    /**
+     * Note: Do not instantiate `KeyNotFoundCacheError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The error is thrown when a key is not found
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
+ * @group Errors
+ */
+export declare class KeyExistsCacheError extends Error {
+    static create(key: Key, cause?: unknown): KeyExistsCacheError;
+    /**
+     * Note: Do not instantiate `KeyExistsCacheError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
     constructor(message: string, cause?: unknown);
 }
 /**

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

@@ -1,6 +1,7 @@
 /**
  * @module Cache
  */
+import {} from "../../namespace/_module.js";
 /**
  * The error is thrown when a key is not found
  *
@@ -8,11 +9,39 @@
  * @group Errors
  */
 export class KeyNotFoundCacheError extends Error {
+    static create(key, cause) {
+        return new KeyNotFoundCacheError(`Key "${key.get()}" is not found`, cause);
+    }
+    /**
+     * Note: Do not instantiate `KeyNotFoundCacheError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
     constructor(message, cause) {
         super(message, { cause });
         this.name = KeyNotFoundCacheError.name;
     }
 }
+/**
+ * The error is thrown when a key is not found
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
+ * @group Errors
+ */
+export class KeyExistsCacheError extends Error {
+    static create(key, cause) {
+        return new KeyExistsCacheError(`Key "${key.get()}" already exists`, cause);
+    }
+    /**
+     * Note: Do not instantiate `KeyExistsCacheError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = KeyExistsCacheError.name;
+    }
+}
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`

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

@@ -1 +1 @@
-{"version":3,"file":"cache.errors.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC5C,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;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB,WAAW,EAAE,qBAAqB;CAC5B,CAAC;AASX;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACvC,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}
+{"version":3,"file":"cache.errors.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAY,MAAM,wBAAwB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC5C,MAAM,CAAC,MAAM,CAAC,GAAQ,EAAE,KAAe;QACnC,OAAO,IAAI,qBAAqB,CAC5B,QAAQ,GAAG,CAAC,GAAG,EAAE,gBAAgB,EACjC,KAAK,CACR,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,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,OAAO,mBAAoB,SAAQ,KAAK;IAC1C,MAAM,CAAC,MAAM,CAAC,GAAQ,EAAE,KAAe;QACnC,OAAO,IAAI,mBAAmB,CAC1B,QAAQ,GAAG,CAAC,GAAG,EAAE,kBAAkB,EACnC,KAAK,CACR,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;IACzC,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB,WAAW,EAAE,qBAAqB;CAC5B,CAAC;AASX;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACvC,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}

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

@@ -1,7 +1,8 @@
 /**
  * @module Cache
  */
-import type { TimeSpan } from "../../time-span/implementations/_module-exports.js";
+import { type Key } from "../../namespace/_module.js";
+import { type TimeSpan } from "../../time-span/implementations/_module.js";
 /**
  * The event is dispatched when key is found.
  *
@@ -9,7 +10,7 @@ import type { TimeSpan } from "../../time-span/implementations/_module-exports.j
  * @group Events
  */
 export type FoundCacheEvent<TType = unknown> = {
-    key: string;
+    key: Key;
     value: TType;
 };
 /**
@@ -19,7 +20,7 @@ export type FoundCacheEvent<TType = unknown> = {
  * @group Events
  */
 export type NotFoundCacheEvent = {
-    key: string;
+    key: Key;
 };
 /**
  * The event is dispatched when key is added.
@@ -28,8 +29,7 @@ export type NotFoundCacheEvent = {
  * @group Events
  */
 export type AddedCacheEvent<TType = unknown> = {
-    type: "added";
-    key: string;
+    key: Key;
     value: TType;
     ttl: TimeSpan | null;
 };
@@ -40,8 +40,7 @@ export type AddedCacheEvent<TType = unknown> = {
  * @group Events
  */
 export type UpdatedCacheEvent<TType = unknown> = {
-    type: "updated";
-    key: string;
+    key: Key;
     value: TType;
 };
 /**
@@ -51,8 +50,7 @@ export type UpdatedCacheEvent<TType = unknown> = {
  * @group Events
  */
 export type RemovedCacheEvent = {
-    type: "removed";
-    key: string;
+    key: Key;
 };
 /**
  * The event is dispatched when key is incremented.
@@ -61,8 +59,7 @@ export type RemovedCacheEvent = {
  * @group Events
  */
 export type IncrementedCacheEvent = {
-    type: "incremented";
-    key: string;
+    key: Key;
     value: number;
 };
 /**
@@ -72,17 +69,9 @@ export type IncrementedCacheEvent = {
  * @group Events
  */
 export type DecrementedCacheEvent = {
-    type: "decremented";
-    key: string;
+    key: Key;
     value: number;
 };
-/**
- * The event is dispatched when key is updated or added.
- *
- * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
- * @group Events
- */
-export type WrittenCacheEvent<TType = unknown> = AddedCacheEvent<TType> | UpdatedCacheEvent<TType> | RemovedCacheEvent | IncrementedCacheEvent | DecrementedCacheEvent;
 /**
  * The event is dispatched when all keys all cleared of the cache.
  *
@@ -109,7 +98,11 @@ export type UnexpectedErrorCacheEvent = {
 export declare const CACHE_EVENTS: {
     readonly FOUND: "FOUND";
     readonly NOT_FOUND: "NOT_FOUND";
-    readonly WRITTEN: "WRITTEN";
+    readonly ADDED: "ADDED";
+    readonly UPDATED: "UPDATED";
+    readonly REMOVED: "REMOVED";
+    readonly INCREMENTED: "INCREMENTED";
+    readonly DECREMENTED: "DECREMENTED";
     readonly CLEARED: "CLEARED";
     readonly UNEXPECTED_ERROR: "UNEXPECTED_ERROR";
 };
@@ -121,7 +114,11 @@ export declare const CACHE_EVENTS: {
 export type CacheEventMap<TType = unknown> = {
     [CACHE_EVENTS.FOUND]: FoundCacheEvent<TType>;
     [CACHE_EVENTS.NOT_FOUND]: NotFoundCacheEvent;
-    [CACHE_EVENTS.WRITTEN]: WrittenCacheEvent<TType>;
+    [CACHE_EVENTS.ADDED]: AddedCacheEvent<TType>;
+    [CACHE_EVENTS.UPDATED]: UpdatedCacheEvent<TType>;
+    [CACHE_EVENTS.REMOVED]: RemovedCacheEvent;
+    [CACHE_EVENTS.INCREMENTED]: IncrementedCacheEvent;
+    [CACHE_EVENTS.DECREMENTED]: DecrementedCacheEvent;
     [CACHE_EVENTS.CLEARED]: ClearedCacheEvent;
     [CACHE_EVENTS.UNEXPECTED_ERROR]: UnexpectedErrorCacheEvent;
 };

package/dist/cache/contracts/cache.events.js

@@ -1,6 +1,9 @@
 /**
  * @module Cache
  */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import {} from "../../namespace/_module.js";
+import {} from "../../time-span/implementations/_module.js";
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
@@ -9,7 +12,11 @@
 export const CACHE_EVENTS = {
     FOUND: "FOUND",
     NOT_FOUND: "NOT_FOUND",
-    WRITTEN: "WRITTEN",
+    ADDED: "ADDED",
+    UPDATED: "UPDATED",
+    REMOVED: "REMOVED",
+    INCREMENTED: "INCREMENTED",
+    DECREMENTED: "DECREMENTED",
     CLEARED: "CLEARED",
     UNEXPECTED_ERROR: "UNEXPECTED_ERROR",
 };

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

@@ -1 +1 @@
-{"version":3,"file":"cache.events.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAwHH;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC"}
+{"version":3,"file":"cache.events.js","sourceRoot":"","sources":["../../../src/cache/contracts/cache.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,6DAA6D;AAC7D,OAAO,EAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAiB,MAAM,wCAAwC,CAAC;AAmGvE;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC"}

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

@@ -0,0 +1,18 @@
+/**
+ * @module Cache
+ */
+import { type ICacheAdapter } from "../../cache/contracts/cache-adapter.contract.js";
+import { type ICacheBase } from "../../cache/contracts/cache.contract.js";
+import { type IDatabaseCacheAdapter } from "../../cache/contracts/database-cache-adapter.contract.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
+ * @group Contracts
+ */
+export type CacheAdapterVariants<TType = unknown> = ICacheAdapter<TType> | IDatabaseCacheAdapter<TType>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
+ * @group Contracts
+ */
+export type CacheVariants<TType = unknown> = ICacheBase<TType> | CacheAdapterVariants<TType>;

package/dist/cache/contracts/types.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/cache/contracts/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAsB,MAAM,6CAA6C,CAAC;AACjF,OAAO,EAAmB,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAA8B,MAAM,sDAAsD,CAAC"}

package/dist/cache/implementations/adapters/_module.d.ts

@@ -1,5 +1,5 @@
-export * from "../../../cache/implementations/adapters/kysely-cache-adapter/_module-exports.js";
-export * from "../../../cache/implementations/adapters/memory-cache-adapter/_module-exports.js";
-export * from "../../../cache/implementations/adapters/mongodb-cache-adapter/_module-exports.js";
-export * from "../../../cache/implementations/adapters/no-op-cache-adapter/_module-exports.js";
-export * from "../../../cache/implementations/adapters/redis-cache-adapter/_module-exports.js";
+export * from "../../../cache/implementations/adapters/kysely-cache-adapter/_module.js";
+export * from "../../../cache/implementations/adapters/memory-cache-adapter/_module.js";
+export * from "../../../cache/implementations/adapters/mongodb-cache-adapter/_module.js";
+export * from "../../../cache/implementations/adapters/no-op-cache-adapter/_module.js";
+export * from "../../../cache/implementations/adapters/redis-cache-adapter/_module.js";

package/dist/cache/implementations/adapters/_module.js

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

package/dist/cache/implementations/adapters/_module.js.map

@@ -1 +1 @@
-{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/cache/implementations/adapters/_module.ts"],"names":[],"mappings":"AAAA,cAAc,0EAA0E,CAAC;AACzF,cAAc,0EAA0E,CAAC;AACzF,cAAc,2EAA2E,CAAC;AAC1F,cAAc,yEAAyE,CAAC;AACxF,cAAc,yEAAyE,CAAC"}
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/cache/implementations/adapters/_module.ts"],"names":[],"mappings":"AAAA,cAAc,kEAAkE,CAAC;AACjF,cAAc,kEAAkE,CAAC;AACjF,cAAc,mEAAmE,CAAC;AAClF,cAAc,iEAAiE,CAAC;AAChF,cAAc,iEAAiE,CAAC"}

package/dist/cache/implementations/adapters/kysely-cache-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../cache/implementations/adapters/kysely-cache-adapter/kysely-cache-adapter.js";

package/dist/cache/implementations/adapters/kysely-cache-adapter/_module.js

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

package/dist/cache/implementations/adapters/kysely-cache-adapter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/cache/implementations/adapters/kysely-cache-adapter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,+EAA+E,CAAC"}

package/dist/cache/implementations/adapters/kysely-cache-adapter/kysely-cache-adapter.d.ts

@@ -1,11 +1,11 @@
 /**
  * @module Cache
  */
-import { type ICacheData, type ICacheInsert, type ICacheUpdate, type IDatabaseCacheAdapter } from "../../../../cache/contracts/_module-exports.js";
-import type { ISerde } from "../../../../serde/contracts/_module-exports.js";
-import type { IDeinitizable, IInitizable, IPrunable } from "../../../../utilities/_module-exports.js";
-import type { Kysely } from "kysely";
-import { TimeSpan } from "../../../../time-span/implementations/_module-exports.js";
+import { type Kysely } from "kysely";
+import { type ICacheData, type ICacheInsert, type ICacheUpdate, type IDatabaseCacheAdapter } from "../../../../cache/contracts/_module.js";
+import { type ISerde } from "../../../../serde/contracts/_module.js";
+import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
+import { type IDeinitizable, type IInitizable, type IPrunable } from "../../../../utilities/_module.js";
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache/kysely-cache-adapter"`
@@ -35,10 +35,12 @@ export type KyselyCacheAdapterSettings = {
     /**
      * @default
      * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
      * TimeSpan.fromMinutes(1)
      * ```
      */
-    expiredKeysRemovalInterval?: TimeSpan;
+    expiredKeysRemovalInterval?: ITimeSpan;
     /**
      * @default true
      */
@@ -66,7 +68,8 @@ export declare class KyselyCacheAdapter<TType = unknown> implements IDatabaseCac
      * import { KyselyCacheAdapter } from "@daiso-tech/core/cache/kysely-cache-adapter";
      * import { Serde } from "@daiso-tech/core/serde";
      * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
-     * import Sqlite from "better-sqlite3";
+     * import SQLite from 'better-sqlite3'
+     * import { Kysely, SqliteDialect } from 'kysely'
      *
      * const serde = new Serde(new SuperJsonSerdeAdapter());
      * const cacheAdapter = new KyselyCacheAdapter({
@@ -84,6 +87,10 @@ export declare class KyselyCacheAdapter<TType = unknown> implements IDatabaseCac
     constructor(settings: KyselyCacheAdapterSettings);
     removeAllExpired(): Promise<void>;
     init(): Promise<void>;
+    /**
+     * Removes all related cache tables and their rows.
+     * Note all cache data will be removed.
+     */
     deInit(): Promise<void>;
     find(key: string): Promise<ICacheData<TType> | null>;
     insert(data: ICacheInsert<TType>): Promise<void>;