@daiso-tech/core 0.39.0 → 0.41.0

package/dist/cache/implementations/derivables/cache/cache.d.ts

@@ -3,12 +3,13 @@
  */
 import type { CacheEventMap, IDatabaseCacheAdapter } from "../../../../cache/contracts/_module-exports.js";
 import { type ICache, type ICacheAdapter } from "../../../../cache/contracts/_module-exports.js";
-import { type AsyncLazyable, type OneOrMore } from "../../../../utilities/_module-exports.js";
-import { type NoneFunc, type TimeSpan, Namespace } from "../../../../utilities/_module-exports.js";
-import { LazyPromise } from "../../../../async/_module-exports.js";
+import type { AsyncLazyable } from "../../../../utilities/_module-exports.js";
+import { type NoneFunc } from "../../../../utilities/_module-exports.js";
+import { Task } from "../../../../task/_module-exports.js";
 import type { IEventBus, Unsubscribe, EventListener } from "../../../../event-bus/contracts/_module-exports.js";
-import type { AsyncLazy, Factory } from "../../../../utilities/_module-exports.js";
 import type { StandardSchemaV1 } from "@standard-schema/spec";
+import type { ITimeSpan } from "../../../../time-span/contracts/_module-exports.js";
+import { Namespace } from "../../../../namespace/_module-exports.js";
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache"`
@@ -27,22 +28,12 @@ export type CacheSettingsBase<TType = unknown> = {
     /**
      * @default
      * ```ts
-     * import { Namespace } from "@daiso-tech/core/utilities";
+     * import { Namespace } from "@daiso-tech/core/namespace";
      *
-     * new Namespace(["@", "cache"])
+     * new Namespace("@cache")
      * ```
      */
     namespace?: Namespace;
-    /**
-     * You can pass a {@link Factory | `Factory`} of {@link LazyPromise| `LazyPromise`} to configure default settings for all {@link LazyPromise| `LazyPromise`} instances used in the `Cache` class.
-     * @default
-     * ```ts
-     * import { LazyPromise } from "@daiso-tech/core/async";
-     *
-     * (invokable) => new LazyPromise(invokable)
-     * ```
-     */
-    lazyPromiseFactory?: Factory<AsyncLazy<any>, LazyPromise<any>>;
     /**
      * @default
      * ```ts
@@ -59,22 +50,28 @@ export type CacheSettingsBase<TType = unknown> = {
      * You can decide the default ttl value. If null is passed then no ttl will be used by default.
      * @default null
      */
-    defaultTtl?: TimeSpan | null;
+    defaultTtl?: ITimeSpan | null;
 };
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache"`
  * @group Derivables
  */
-export type CacheAdapter<TType> = ICacheAdapter<TType> | IDatabaseCacheAdapter<TType>;
+export type CacheAdapterVariants<TType> = ICacheAdapter<TType> | IDatabaseCacheAdapter<TType>;
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache"`
  * @group Derivables
  */
 export type CacheSettings<TType = unknown> = CacheSettingsBase<TType> & {
-    adapter: CacheAdapter<any>;
+    adapter: CacheAdapterVariants<any>;
 };
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/cache"`
+ * @group Derivables
+ */
+export declare const DEFAULT_CACHE_NAMESPACE: Namespace;
 /**
  *
  * IMPORT_PATH: `"@daiso-tech/core/cache"`
@@ -85,7 +82,6 @@ export declare class Cache<TType = unknown> implements ICache<TType> {
     private readonly adapter;
     private readonly defaultTtl;
     private readonly namespace;
-    private readonly lazyPromiseFactory;
     private readonly schema;
     private readonly shouldValidateOutput;
     /**
@@ -97,7 +93,7 @@ export declare class Cache<TType = unknown> implements ICache<TType> {
      * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters"
      * import Sqlite from "better-sqlite3";
      * import { Cache } from "@daiso-tech/core/cache";
-     * import { Namespace } from "@daiso-tech/core/utilities";
+     * import { Namespace } from "@daiso-tech/core/namespace";
      *
      * const database = new Sqlite("local.db");
      * const serde = new Serde(new SuperJsonSerdeAdapter());
@@ -118,46 +114,45 @@ export declare class Cache<TType = unknown> implements ICache<TType> {
      * You can listen to the following {@link CacheEventMap | `CacheEventMap`} of the {@link ICache | `ICache`} instance.
      * To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
      */
-    addListener<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): LazyPromise<void>;
+    addListener<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): Task<void>;
     /**
      * You can listen to the following {@link CacheEventMap | `CacheEventMap`} of the {@link ICache | `ICache`} instance.
      * To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
      */
-    removeListener<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): LazyPromise<void>;
+    removeListener<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): Task<void>;
     /**
      * You can listen to the following {@link CacheEventMap | `CacheEventMap`} of the {@link ICache | `ICache`} instance.
      * To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
      */
-    listenOnce<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): LazyPromise<void>;
+    listenOnce<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): Task<void>;
     /**
      * You can listen to the following {@link CacheEventMap | `CacheEventMap`} of the {@link ICache | `ICache`} instance.
      * To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
      */
-    asPromise<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName): LazyPromise<CacheEventMap<TType>[TEventName]>;
+    asPromise<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName): Task<CacheEventMap<TType>[TEventName]>;
     /**
      * You can listen to the following {@link CacheEventMap | `CacheEventMap`} of the {@link ICache | `ICache`} instance.
      * To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
      */
-    subscribeOnce<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): LazyPromise<Unsubscribe>;
+    subscribeOnce<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): Task<Unsubscribe>;
     /**
      * You can listen to the following {@link CacheEventMap | `CacheEventMap`} of the {@link ICache | `ICache`} instance.
      * To understand how this method works, refer to {@link IEventListenable | `IEventListenable `}.
      */
-    subscribe<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): LazyPromise<Unsubscribe>;
-    private createLazyPromise;
-    exists(key: OneOrMore<string>): LazyPromise<boolean>;
-    missing(key: OneOrMore<string>): LazyPromise<boolean>;
-    get(key: OneOrMore<string>): LazyPromise<TType | null>;
-    getOrFail(key: OneOrMore<string>): LazyPromise<TType>;
-    getAndRemove(key: OneOrMore<string>): LazyPromise<TType | null>;
-    getOr(key: OneOrMore<string>, defaultValue: AsyncLazyable<NoneFunc<TType>>): LazyPromise<TType>;
-    getOrAdd(key: OneOrMore<string>, valueToAdd: AsyncLazyable<NoneFunc<TType>>, ttl?: TimeSpan | null): LazyPromise<TType>;
-    add(key: OneOrMore<string>, value: TType, ttl?: TimeSpan | null): LazyPromise<boolean>;
-    put(key: OneOrMore<string>, value: TType, ttl?: TimeSpan | null): LazyPromise<boolean>;
-    update(key: OneOrMore<string>, value: TType): LazyPromise<boolean>;
-    increment(key: OneOrMore<string>, value?: Extract<TType, number>): LazyPromise<boolean>;
-    decrement(key: OneOrMore<string>, value?: Extract<TType, number>): LazyPromise<boolean>;
-    remove(key: OneOrMore<string>): LazyPromise<boolean>;
-    removeMany(keys: Iterable<OneOrMore<string>>): LazyPromise<boolean>;
-    clear(): LazyPromise<void>;
+    subscribe<TEventName extends keyof CacheEventMap<TType>>(eventName: TEventName, listener: EventListener<CacheEventMap<TType>[TEventName]>): Task<Unsubscribe>;
+    exists(key: string): Task<boolean>;
+    missing(key: string): Task<boolean>;
+    get(key: string): Task<TType | null>;
+    getOrFail(key: string): Task<TType>;
+    getAndRemove(key: string): Task<TType | null>;
+    getOr(key: string, defaultValue: AsyncLazyable<NoneFunc<TType>>): Task<TType>;
+    getOrAdd(key: string, valueToAdd: AsyncLazyable<NoneFunc<TType>>, ttl?: ITimeSpan | null): Task<TType>;
+    add(key: string, value: TType, ttl?: ITimeSpan | null): Task<boolean>;
+    put(key: string, value: TType, ttl?: ITimeSpan | null): Task<boolean>;
+    update(key: string, value: TType): Task<boolean>;
+    increment(key: string, value?: Extract<TType, number>): Task<boolean>;
+    decrement(key: string, value?: Extract<TType, number>): Task<boolean>;
+    remove(key: string): Task<boolean>;
+    removeMany(keys: Iterable<string>): Task<boolean>;
+    clear(): Task<void>;
 }