@daiso-tech/core 0.10.0 → 0.12.0

package/dist/types/storage/implementations/storage/storage.d.ts

@@ -1,114 +0,0 @@
-/**
- * @module Storage
- */
-import { type IStorage, type IStorageAdapter } from "../../../storage/contracts/_module";
-import { type StorageValue, type INamespacedStorage, type AllStorageEvents } from "../../../storage/contracts/_module";
-import { type AsyncLazyable, type GetOrAddValue } from "../../../_shared/types";
-import type { Validator } from "../../../utilities/_module";
-import { LazyPromise } from "../../../utilities/_module";
-import type { INamespacedEventBus, Listener, SelectEvent, Unsubscribe } from "../../../event-bus/contracts/_module";
-/**
- * @group Derivables
- */
-export type StorageSettings<TType> = {
-    /**
-     * You can prefix all keys with a given <i>rootNamespace</i>.
-     * This useful if you want to add multitenancy but still use the same database.
-     * @default {""}
-     * @example
-     * ```ts
-     * import { Storage, MemoryStorageAdapter } from "@daiso-tech/core";
-     *
-     * const storageA = new Storage(new MemoryStorageAdapter(), {
-     *   rootNamespace: "@a/"
-     * });
-     * const storageB = new Storage(new MemoryStorageAdapter(), {
-     *   rootNamespace: "@b/"
-     * });
-     *
-     * (async () => {
-     *   await storageA.add("a", 1);
-     *
-     *   // Will be "a"
-     *   console.log(await storageA.get("a"));
-     *
-     *   // Will be "null"
-     *   console.log(await storageB.get("a"));
-     * })();
-     * ```
-     */
-    rootNamespace?: string;
-    /**
-     * You can pass a custom <i>{@link Validator}</i> to validate, transform and sanitize your data.
-     * You could also use <i>{@link zodValidator}</i> which enables you to use zod for validating, transforming, and sanitizing.
-     * @example
-     * ```ts
-     * import { Storage, MemoryStorageAdapter, zodValidator } from "@daiso-tech/core";
-     * import { z } from "zod";
-     *
-     * const storage = new Storage(new MemoryStorageAdapter(), {
-     *   // Type will be infered from validator
-     *   validator: zodValidator(z.string())
-     * });
-     *
-     * (async () => {
-     *   // An Typescript error will be seen and ValidationError will be thrown during runtime.
-     *   await storageA.add("a", 1);
-     * })();
-     * ```
-     */
-    validator?: Validator<TType>;
-    eventBus?: INamespacedEventBus<AllStorageEvents<TType>>;
-};
-/**
- * <i>Storage</i> class can be derived from any <i>{@link IStorageAdapter}</i>.
- * @group Derivables
- */
-export declare class Storage<TType = unknown> implements INamespacedStorage<TType> {
-    private readonly storageAdapter;
-    static EVENTS: {
-        readonly KEYS_FOUND: "keys_found";
-        readonly KEYS_NOT_FOUND: "keys_not_found";
-        readonly KEYS_ADDED: "keys_added";
-        readonly KEYS_UPDATED: "keys_updated";
-        readonly KEYS_REMOVED: "keys_removed";
-        readonly KEYS_CLEARED: "keys_cleared";
-        readonly KEY_INCREMENTED: "key_incremented";
-        readonly KEY_DECREMENTED: "key_decremented";
-    };
-    private readonly withEventStorageAdapter;
-    private readonly namespace_;
-    private readonly validator;
-    private readonly eventBus;
-    constructor(storageAdapter: IStorageAdapter<any>, settings?: StorageSettings<TType>);
-    addListener<TEventType extends AllStorageEvents<TType>["type"]>(event: TEventType, listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    addListenerMany<TEventType extends AllStorageEvents<TType>["type"]>(events: TEventType[], listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    removeListener<TEventType extends AllStorageEvents<TType>["type"]>(event: TEventType, listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    removeListenerMany<TEventType extends AllStorageEvents<TType>["type"]>(events: TEventType[], listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    subscribe<TEventType extends AllStorageEvents<TType>["type"]>(event: TEventType, listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<Unsubscribe>;
-    subscribeMany<TEventType extends AllStorageEvents<TType>["type"]>(events: TEventType[], listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<Unsubscribe>;
-    withNamespace(namespace: string): IStorage<TType>;
-    getNamespace(): string;
-    exists(key: string): LazyPromise<boolean>;
-    existsMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
-    missing(key: string): LazyPromise<boolean>;
-    missingMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
-    get(key: string): LazyPromise<TType | null>;
-    getMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, TType | null>>;
-    getOr(key: string, defaultValue: AsyncLazyable<TType>): LazyPromise<TType>;
-    getOrMany<TKeys extends string>(keysWithDefaults: Record<TKeys, AsyncLazyable<TType>>): LazyPromise<Record<TKeys, TType>>;
-    getOrFail(key: string): LazyPromise<TType>;
-    add(key: string, value: StorageValue<TType>): LazyPromise<boolean>;
-    addMany<TKeys extends string>(values: Record<TKeys, StorageValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
-    update(key: string, value: TType): LazyPromise<boolean>;
-    updateMany<TKeys extends string>(values: Record<TKeys, TType>): LazyPromise<Record<TKeys, boolean>>;
-    put(key: string, value: StorageValue<TType>): LazyPromise<boolean>;
-    putMany<TKeys extends string>(values: Record<TKeys, StorageValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
-    remove(key: string): LazyPromise<boolean>;
-    removeMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
-    getAndRemove(key: string): LazyPromise<TType | null>;
-    getOrAdd(key: string, valueToAdd: AsyncLazyable<StorageValue<GetOrAddValue<TType>>>): LazyPromise<TType>;
-    increment(key: string, value?: Extract<TType, number>): LazyPromise<boolean>;
-    decrement(key: string, value?: Extract<TType, number>): LazyPromise<boolean>;
-    clear(): LazyPromise<void>;
-}

package/dist/types/storage/implementations/storage/with-event-storage-adapter.d.ts

@@ -1,31 +0,0 @@
-/**
- * @module Storage
- */
-import type { StorageEvent } from "../../../storage/contracts/_module";
-import { type IStorageAdapter, type AllStorageEvents } from "../../../storage/contracts/_module";
-import { type IEventBus } from "../../../event-bus/contracts/_module";
-import type { WithNamespaceStorageAdapter } from "../../../storage/implementations/storage/with-namespace-storage-adapter";
-/**
- * @internal
- */
-export declare class WithEventStorageAdapter<TType> implements Required<Omit<IStorageAdapter<TType>, "clear">> {
-    private readonly withNamespaceStorageAdapter;
-    private readonly eventBus;
-    private readonly eventAttributes;
-    constructor(withNamespaceStorageAdapter: WithNamespaceStorageAdapter<TType>, eventBus: IEventBus<AllStorageEvents<TType>>, eventAttributes: StorageEvent);
-    private triggerGetManyEvents;
-    getMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, TType | null>>;
-    private triggerAddManyEvents;
-    addMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    private triggerUpdateManyEvents;
-    updateMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    private triggerPutManyEvents;
-    putMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    private triggerRemoveManyEvents;
-    removeMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
-    private triggerIncrementEvents;
-    private triggerDecrementEvents;
-    increment(key: string, value: number): Promise<boolean>;
-    private triggerClearEvents;
-    clear(): Promise<void>;
-}

package/dist/types/storage/implementations/storage/with-namespace-storage-adapter.d.ts

@@ -1,24 +0,0 @@
-/**
- * @module Storage
- */
-import { type IStorageAdapter } from "../../../storage/contracts/_module";
-/**
- * @internal
- */
-export declare class WithNamespaceStorageAdapter<TType> implements Required<Omit<IStorageAdapter<TType>, "clear">> {
-    private readonly storageAdapter;
-    private readonly namespace;
-    constructor(storageAdapter: IStorageAdapter<TType>, namespace: string);
-    private withNamespace;
-    private withNamespaceArray;
-    private withNamespaceObject;
-    private withoutNamespace;
-    private withoutNamespaceObject;
-    getMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, TType | null>>;
-    addMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    updateMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    putMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    removeMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(): Promise<void>;
-}

package/dist/types/storage/implementations/storage/with-validation-storage-adapter.d.ts

@@ -1,22 +0,0 @@
-/**
- * @module Storage
- */
-import type { Validator } from "../../../utilities/_module";
-import type { IStorageAdapter } from "../../../storage/contracts/_module";
-/**
- * @internal
- */
-export declare class WithValidationStorageAdapter<TType> implements IStorageAdapter<TType> {
-    private readonly storageAdapter;
-    private readonly validator;
-    constructor(storageAdapter: IStorageAdapter<TType>, validator: Validator<TType>);
-    private validateOutput;
-    private validateInput;
-    getMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, TType | null>>;
-    addMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    updateMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    putMany<TKeys extends string>(values: Record<TKeys, TType>): Promise<Record<TKeys, boolean>>;
-    removeMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(prefix: string): Promise<void>;
-}