@daiso-tech/core 0.11.0 → 0.12.0

package/dist/types/storage/contracts/storage.events.d.ts

@@ -1,94 +0,0 @@
-/**
- * @module Storage
- */
-import type { IStorageAdapter } from "../../storage/contracts/storage-adapter.contract";
-/**
- * Name of all the events of <i>{@link IStorage}</i>.
- * @group Events
- */
-export declare const STORAGE_EVENTS: {
-    readonly KEY_FOUND: "key_found";
-    readonly KEY_NOT_FOUND: "key_not_found";
-    readonly KEY_ADDED: "key_added";
-    readonly KEY_UPDATED: "key_updated";
-    readonly KEY_REMOVED: "key_removed";
-    readonly KEYS_CLEARED: "keys_cleared";
-    readonly KEY_INCREMENTED: "key_incremented";
-    readonly KEY_DECREMENTED: "key_decremented";
-};
-/**
- * @group Events
- */
-export type StorageEventNames = (typeof STORAGE_EVENTS)[keyof typeof STORAGE_EVENTS];
-/**
- * @group Events
- */
-export type StorageEvent = {
-    namespace: string;
-    adapter: IStorageAdapter<any>;
-};
-/**
- * @group Events
- */
-export type KeyFoundStorageEvent<TType = unknown> = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_FOUND"];
-    key: string;
-    value: TType;
-};
-/**
- * @group Events
- */
-export type KeyNotFoundStorageEvent = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_NOT_FOUND"];
-    key: string;
-};
-/**
- * @group Events
- */
-export type KeyAddedStorageEvent<TType = unknown> = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_ADDED"];
-    key: string;
-    value: TType;
-};
-/**
- * @group Events
- */
-export type KeyUpdatedStorageEvent<TType = unknown> = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_UPDATED"];
-    key: string;
-    value: TType;
-};
-/**
- * @group Events
- */
-export type KeyIncrementedStorageEvent = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_INCREMENTED"];
-    key: string;
-    value: number;
-};
-/**
- * @group Events
- */
-export type KeyDecrementedStorageEvent = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_DECREMENTED"];
-    key: string;
-    value: number;
-};
-/**
- * @group Events
- */
-export type KeyRemovedStorageEvent = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEY_REMOVED"];
-    key: string;
-};
-/**
- * This event will be triggered when storage is cleared.
- * @group Events
- */
-export type KeysClearedStorageEvent = StorageEvent & {
-    type: (typeof STORAGE_EVENTS)["KEYS_CLEARED"];
-};
-/**
- * @group Events
- */
-export type AllStorageEvents<TType> = KeyFoundStorageEvent<TType> | KeyNotFoundStorageEvent | KeyAddedStorageEvent<TType> | KeyUpdatedStorageEvent<TType> | KeyRemovedStorageEvent | KeysClearedStorageEvent | KeyIncrementedStorageEvent | KeyDecrementedStorageEvent;

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

@@ -1,3 +0,0 @@
-export * from "../../storage/implementations/derivables/_module";
-export * from "../../storage/implementations/adapters/_module";
-export * from "../../storage/implementations/_shared/test-utilities/_module";

package/dist/types/storage/implementations/_shared/test-utilities/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../../storage/implementations/_shared/test-utilities/storage-adapter.test-suite";

package/dist/types/storage/implementations/_shared/test-utilities/storage-adapter.test-suite.d.ts

@@ -1,36 +0,0 @@
-/**
- * @module Storage
- */
-import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
-import { type IStorageAdapter } from "../../../../storage/contracts/_module";
-import { type Promisable } from "../../../../_shared/types";
-/**
- * @group Utilities
- */
-export type StorageAdapterTestSuiteSettings = {
-    expect: ExpectStatic;
-    test: TestAPI;
-    describe: SuiteAPI;
-    beforeEach: typeof beforeEach;
-    createAdapter: () => Promisable<IStorageAdapter>;
-};
-/**
- * The <i>storageAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link IStorageAdapter}</i>.
- * @example
- * ```ts
- * import { storageAdapterTestSuite, MemoryStorageAdapter } from "@daiso-tech/core";
- * import { expext, test, describe, beforeEach } from "vitest";
- *
- * describe("class: MemoryStorageAdapter", () => {
- *   storageAdapterTestSuite({
- *     createAdapter: () => new MemoryStorageAdapter(),
- *     test,
- *     beforeEach,
- *     expect,
- *     describe,
- *   });
- * });
- * ```
- * @group Utilities
- */
-export declare function storageAdapterTestSuite(settings: StorageAdapterTestSuiteSettings): void;

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

@@ -1,4 +0,0 @@
-export * from "../../../storage/implementations/adapters/memory-storage-adapter/_module";
-export * from "../../../storage/implementations/adapters/mongodb-storage-adapter/_module";
-export * from "../../../storage/implementations/adapters/redis-storage-adapter/_module";
-export * from "../../../storage/implementations/adapters/sqlite/_module";

package/dist/types/storage/implementations/adapters/memory-storage-adapter/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../../storage/implementations/adapters/memory-storage-adapter/memory-storage-adapter";

package/dist/types/storage/implementations/adapters/memory-storage-adapter/memory-storage-adapter.d.ts

@@ -1,18 +0,0 @@
-/**
- * @module Storage
- */
-import { type IStorageAdapter } from "../../../../storage/contracts/storage-adapter.contract";
-/**
- * @group Adapters
- */
-export declare class MemoryStorageAdapter<TType> implements IStorageAdapter<TType> {
-    private readonly map;
-    constructor(map?: Map<string, TType>);
-    get(key: string): Promise<TType | null>;
-    add(key: string, value: TType): Promise<boolean>;
-    update(key: string, value: TType): Promise<boolean>;
-    put(key: string, value: TType): Promise<boolean>;
-    remove(key: string): Promise<boolean>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(prefix: string): Promise<void>;
-}

package/dist/types/storage/implementations/adapters/mongodb-storage-adapter/_module.d.ts

@@ -1 +0,0 @@
-export { MongodbStorageAdapter, type MongodbStorageAdapterSettings, } from "../../../../storage/implementations/adapters/mongodb-storage-adapter/mongodb-storage-adapter";

package/dist/types/storage/implementations/adapters/mongodb-storage-adapter/mongodb-storage-adapter.d.ts

@@ -1,40 +0,0 @@
-/**
- * @module Storage
- */
-import { type ISerializer } from "../../../../serializer/contracts/_module";
-import { type IInitizable } from "../../../../_shared/types";
-import { type IStorageAdapter } from "../../../../storage/contracts/_module";
-import { ObjectId } from "mongodb";
-import { type Collection } from "mongodb";
-/**
- * @group Adapters
- */
-export type MongodbStorageDocument = {
-    _id: ObjectId;
-    key: string;
-    value: number | string;
-};
-/**
- * @group Adapters
- */
-export type MongodbStorageAdapterSettings = {
-    serializer?: ISerializer<string>;
-};
-/**
- * @group Adapters
- */
-export declare class MongodbStorageAdapter<TType> implements IStorageAdapter<TType>, IInitizable {
-    private readonly collection;
-    private static isMongodbIncrementError;
-    private static isMongoDuplicateError;
-    private serializer;
-    constructor(collection: Collection<MongodbStorageDocument>, { serializer, }?: MongodbStorageAdapterSettings);
-    init(): Promise<void>;
-    get(key: string): Promise<TType | null>;
-    add(key: string, value: TType): Promise<boolean>;
-    update(key: string, value: unknown): Promise<boolean>;
-    put(key: string, value: unknown): Promise<boolean>;
-    remove(key: string): Promise<boolean>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(prefix: string): Promise<void>;
-}

package/dist/types/storage/implementations/adapters/redis-storage-adapter/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../../storage/implementations/adapters/redis-storage-adapter/redis-storage-adapter";

package/dist/types/storage/implementations/adapters/sqlite/_module.d.ts

@@ -1,2 +0,0 @@
-export * from "../../../../storage/implementations/adapters/sqlite/sqlite-storage-adapter/_module";
-export * from "../../../../storage/implementations/adapters/sqlite/libsql-storage-adapter/_module";

package/dist/types/storage/implementations/adapters/sqlite/_shared/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../../../storage/implementations/adapters/sqlite/_shared/base-sqlite-storage-adapter";

package/dist/types/storage/implementations/adapters/sqlite/_shared/base-sqlite-storage-adapter.d.ts

@@ -1,45 +0,0 @@
-/**
- * @module Storage
- */
-import { type IStorageAdapter } from "../../../../../storage/contracts/storage-adapter.contract";
-import { type Kysely } from "kysely";
-import { type ISerializer } from "../../../../../serializer/contracts/_module";
-import type { IDeinitizable } from "../../../../../_shared/types";
-import { type IInitizable } from "../../../../../_shared/types";
-/**
- * @internal
- */
-type BaseSqliteStorageTable = {
-    key: string;
-    value: string;
-};
-/**
- * @internal
- */
-type BaseSqliteTables = {
-    storage: BaseSqliteStorageTable;
-};
-/**
- * @internal
- */
-export declare class BaseSqliteStorageAdapter<TType> implements IStorageAdapter<TType>, IInitizable, IDeinitizable {
-    private readonly db;
-    private readonly serializer;
-    constructor(db: Kysely<BaseSqliteTables>, serializer: ISerializer<string>);
-    /**
-     * Creates the table
-     */
-    init(): Promise<void>;
-    /**
-     * Removes the table
-     */
-    deInit(): Promise<void>;
-    get(key: string): Promise<TType | null>;
-    add(key: string, value: TType): Promise<boolean>;
-    update(key: string, value: TType): Promise<boolean>;
-    put(key: string, value: TType): Promise<boolean>;
-    remove(key: string): Promise<boolean>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(prefix: string): Promise<void>;
-}
-export {};

package/dist/types/storage/implementations/adapters/sqlite/libsql-storage-adapter/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../../../storage/implementations/adapters/sqlite/libsql-storage-adapter/libsql-storage-adapter";

package/dist/types/storage/implementations/adapters/sqlite/libsql-storage-adapter/libsql-storage-adapter.d.ts

@@ -1,37 +0,0 @@
-/**
- * @module Storage
- */
-import type { ISerializer } from "../../../../../serializer/contracts/_module";
-import { type IStorageAdapter } from "../../../../../storage/contracts/_module";
-import type { IDeinitizable } from "../../../../../_shared/types";
-import { type IInitizable } from "../../../../../_shared/types";
-import type { Client } from "@libsql/client";
-/**
- * @group Adapters
- */
-export type LibsqlStorageAdapterSettings = {
-    tableName?: string;
-    serializer?: ISerializer<string>;
-};
-/**
- * @group Adapters
- */
-export declare class LibsqlStorageAdapter<TType> implements IStorageAdapter<TType>, IInitizable, IDeinitizable {
-    private readonly storageAdapter;
-    constructor(client: Client, { tableName, serializer, }?: LibsqlStorageAdapterSettings);
-    /**
-     * Creates the table
-     */
-    init(): Promise<void>;
-    /**
-     * Removes the table
-     */
-    deInit(): Promise<void>;
-    get(key: string): Promise<TType | null>;
-    add(key: string, value: TType): Promise<boolean>;
-    update(key: string, value: TType): Promise<boolean>;
-    put(key: string, value: TType): Promise<boolean>;
-    remove(key: string): Promise<boolean>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(prefix: string): Promise<void>;
-}

package/dist/types/storage/implementations/adapters/sqlite/sqlite-storage-adapter/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../../../storage/implementations/adapters/sqlite/sqlite-storage-adapter/sqlite-storage-adapter";

package/dist/types/storage/implementations/adapters/sqlite/sqlite-storage-adapter/sqlite-storage-adapter.d.ts

@@ -1,37 +0,0 @@
-/**
- * @module Storage
- */
-import type { ISerializer } from "../../../../../serializer/contracts/_module";
-import { type IStorageAdapter } from "../../../../../storage/contracts/_module";
-import { type Database } from "better-sqlite3";
-import type { IDeinitizable } from "../../../../../_shared/types";
-import { type IInitizable } from "../../../../../_shared/types";
-/**
- * @group Adapters
- */
-export type SqliteStorageAdapterSettings = {
-    tableName?: string;
-    serializer?: ISerializer<string>;
-};
-/**
- * @group Adapters
- */
-export declare class SqliteStorageAdapter<TType> implements IStorageAdapter<TType>, IInitizable, IDeinitizable {
-    private readonly storageAdapter;
-    constructor(database: Database, { tableName, serializer, }?: SqliteStorageAdapterSettings);
-    /**
-     * Creates the table
-     */
-    init(): Promise<void>;
-    /**
-     * Removes the table
-     */
-    deInit(): Promise<void>;
-    get(key: string): Promise<TType | null>;
-    add(key: string, value: TType): Promise<boolean>;
-    update(key: string, value: TType): Promise<boolean>;
-    put(key: string, value: TType): Promise<boolean>;
-    remove(key: string): Promise<boolean>;
-    increment(key: string, value: number): Promise<boolean>;
-    clear(prefix: string): Promise<void>;
-}

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

@@ -1,2 +0,0 @@
-export * from "../../../storage/implementations/derivables/storage";
-export * from "../../../storage/implementations/derivables/storage-factory";

package/dist/types/storage/implementations/derivables/storage-factory.d.ts

@@ -1,47 +0,0 @@
-/**
- * @module Storage
- */
-import type { INamespacedEventBus } from "../../../event-bus/contracts/_module";
-import type { IStorageFactory, INamespacedStorage, IStorageAdapter } from "../../../storage/contracts/_module";
-import type { Validator } from "../../../utilities/_module";
-/**
- * @group Derivables
- */
-export type StorageDrivers<TDrivers extends string> = Partial<Record<TDrivers, IStorageAdapter<any>>>;
-/**
- * @group Derivables
- */
-export type StorageFactorySettings<TDrivers extends string = string> = {
-    drivers: StorageDrivers<TDrivers>;
-    defaultDriver?: NoInfer<TDrivers>;
-    eventBus?: INamespacedEventBus<any>;
-    rootNamespace?: string;
-};
-/**
- * @group Derivables
- * @example
- * ```ts
- * import { StorageFactory } from "@daiso-tech/core";
- * import Redis from "ioredis"
- *
- * const storageFactory = new StorageFactory({
- *   drivers: {
- *     memory: new MemoryStorageAdapter(),
- *     redis: new RedisStorageAdapter(new Redis()),
- *   },
- *   defaultDriver: "memory",
- *   rootNamespace: "@events"
- * });
- * ```
- */
-export declare class StorageFactory<TDrivers extends string = string, TType = unknown> implements IStorageFactory<TDrivers, TType> {
-    private readonly rootNamespace?;
-    private readonly drivers;
-    private readonly defaultDriver?;
-    private readonly eventBus?;
-    private validator;
-    constructor(settings: StorageFactorySettings<TDrivers>);
-    use(driverName?: TDrivers | undefined): INamespacedStorage<TType>;
-    withValidation<TOutput extends TType = TType>(validator: Validator<TOutput>): IStorageFactory<TDrivers, TOutput>;
-    withType<TOutput extends TType = TType>(): IStorageFactory<TDrivers, TOutput>;
-}

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

@@ -1,119 +0,0 @@
-/**
- * @module Storage
- */
-import type { StorageEventNames } from "../../../storage/contracts/_module";
-import { type IStorage, type IStorageAdapter } from "../../../storage/contracts/_module";
-import { type INamespacedStorage, type AllStorageEvents } from "../../../storage/contracts/_module";
-import type { OneOrMore } from "../../../_shared/types";
-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 memoryStorageAdapter = new MemoryStorageAdapter();
-     * const storageA = new Storage(memoryStorageAdapter, {
-     *   rootNamespace: "@a"
-     * });
-     * const storageB = new Storage(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?: OneOrMore<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>;
-    /**
-     * In order to listen to events of <i>{@link Storage}</i> class you must pass in <i>{@link INamespacedEventBus}</i>.
-     */
-    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 namespace;
-    private readonly validator;
-    private readonly eventBus;
-    private readonly storageAdapter;
-    private readonly eventAttributes;
-    constructor(storageAdapter: IStorageAdapter<any>, settings?: StorageSettings<TType>);
-    addListener<TEventType extends StorageEventNames>(event: TEventType, listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    addListenerMany<TEventType extends StorageEventNames>(events: TEventType[], listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    removeListener<TEventType extends StorageEventNames>(event: TEventType, listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    removeListenerMany<TEventType extends StorageEventNames>(events: TEventType[], listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<void>;
-    subscribe<TEventType extends StorageEventNames>(event: TEventType, listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<Unsubscribe>;
-    subscribeMany<TEventType extends StorageEventNames>(events: TEventType[], listener: Listener<SelectEvent<AllStorageEvents<TType>, TEventType>>): LazyPromise<Unsubscribe>;
-    withNamespace(namespace: OneOrMore<string>): IStorage<TType>;
-    getNamespace(): string;
-    private createKeyFoundEvent;
-    private createKeyNotFoundEvent;
-    private createKeyAddedEvent;
-    private createKeyUpdatedEvent;
-    private createKeyRemovedEvent;
-    private createKeysClearedEvent;
-    private createKeyIncrementedEvent;
-    private createKeyDecrementedEvent;
-    private keyWithNamespace;
-    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: TType): LazyPromise<boolean>;
-    addMany<TKeys extends string>(values: Record<TKeys, 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: TType): LazyPromise<boolean>;
-    putMany<TKeys extends string>(values: Record<TKeys, 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<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>;
-}