@daiso-tech/core 0.2.0 → 0.3.0

package/dist/esm/storage/usable-storage-adapter.js

@@ -0,0 +1,98 @@
+import { simplifyAsyncLazyable } from "../_shared/utilities";
+import { TypeStorageError, UnexpectedStorageError, } from "../contracts/storage/_module";
+export class UsableStorageAdapter {
+    storageAdapter;
+    constructor(storageAdapter) {
+        this.storageAdapter = storageAdapter;
+    }
+    async existsMany(keys) {
+        if (this.storageAdapter.existsMany !== undefined) {
+            return await this.storageAdapter.existsMany(keys);
+        }
+        const getResult = await this.getMany(keys);
+        const results = {};
+        for (const key in getResult) {
+            results[key] = getResult[key] !== null;
+        }
+        return results;
+    }
+    async getMany(keys) {
+        return await this.storageAdapter.getMany(keys);
+    }
+    async addMany(values) {
+        return await this.storageAdapter.addMany(values);
+    }
+    async updateMany(values) {
+        return await this.storageAdapter.updateMany(values);
+    }
+    async putMany(values) {
+        if (this.storageAdapter.putMany !== undefined) {
+            return await this.storageAdapter.putMany(values);
+        }
+        const removeResults = await this.removeMany(Object.keys(values));
+        await this.addMany(values);
+        return removeResults;
+    }
+    async removeMany(keys) {
+        return await this.storageAdapter.removeMany(keys);
+    }
+    async increment(key, value) {
+        if (this.storageAdapter.increment !== undefined) {
+            return await this.storageAdapter.increment(key, value);
+        }
+        const { [key]: previousValue } = await this.getMany([key]);
+        if (previousValue === undefined) {
+            throw new UnexpectedStorageError(`Destructed field "key" is undefined`);
+        }
+        if (previousValue === null) {
+            return false;
+        }
+        if (typeof previousValue !== "number") {
+            throw new TypeStorageError(`Unable to increment or decrement none number type key "${key}"`);
+        }
+        const newValue = previousValue + value;
+        await this.updateMany({
+            [key]: newValue,
+        });
+        return true;
+    }
+    async getAndRemove(key) {
+        if (this.storageAdapter.getAndRemove !== undefined) {
+            return await this.storageAdapter.getAndRemove(key);
+        }
+        const { [key]: value } = await this.getMany([key]);
+        if (value === undefined) {
+            throw new UnexpectedStorageError(`Destructed field "key" is undefined`);
+        }
+        await this.removeMany([key]);
+        return value;
+    }
+    async getOrAdd(key, valueToAdd) {
+        if (typeof valueToAdd !== "function" &&
+            this.storageAdapter.getOrAdd !== undefined) {
+            return await this.storageAdapter.getOrAdd(key, valueToAdd);
+        }
+        const { [key]: value } = await this.getMany([key]);
+        if (value === undefined) {
+            throw new UnexpectedStorageError(`Destructed field "key" is undefined`);
+        }
+        if (value === null) {
+            const valueToAddSimplified = await simplifyAsyncLazyable(valueToAdd);
+            await this.addMany({
+                [key]: valueToAddSimplified,
+            });
+            return {
+                hasKey: false,
+                value: valueToAddSimplified,
+            };
+        }
+        return {
+            hasKey: true,
+            value,
+        };
+    }
+    async clear(prefix) {
+        await this.storageAdapter.clear(prefix);
+    }
+}
+//# sourceMappingURL=usable-storage-adapter.js.map

package/dist/esm/storage/usable-storage-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usable-storage-adapter.js","sourceRoot":"","sources":["../../../src/storage/usable-storage-adapter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAEH,gBAAgB,EAChB,sBAAsB,GACzB,MAAM,6BAA6B,CAAC;AAKrC,MAAM,OAAO,oBAAoB;IAGA;IAA7B,YAA6B,cAAsC;QAAtC,mBAAc,GAAd,cAAc,CAAwB;IAAG,CAAC;IAEvE,KAAK,CAAC,UAAU,CACZ,IAAa;QAEb,IAAI,IAAI,CAAC,cAAc,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAC/C,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,EAA4B,CAAC;QAC7C,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;QAC3C,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,OAAO,CACT,IAAa;QAEb,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,OAAO,CACT,MAA8B;QAE9B,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,UAAU,CACZ,MAA8B;QAE9B,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,OAAO,CACT,MAA8B;QAE9B,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC5C,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,UAAU,CACZ,IAAa;QAEb,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,KAAa;QACtC,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC9C,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,sBAAsB,CAC5B,qCAAqC,CACxC,CAAC;QACN,CAAC;QACD,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,IAAI,gBAAgB,CACtB,0DAA0D,GAAG,GAAG,CACnE,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAG,aAAa,GAAG,KAAK,CAAC;QACvC,MAAM,IAAI,CAAC,UAAU,CAAC;YAClB,CAAC,GAAG,CAAC,EAAE,QAAiB;SAC3B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,YAAY,CACd,GAAW;QAEX,IAAI,IAAI,CAAC,cAAc,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACjD,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QACnE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,sBAAsB,CAC5B,qCAAqC,CACxC,CAAC;QACN,CAAC;QACD,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,QAAQ,CACV,GAAW,EACX,UAAoC;QAEpC,IACI,OAAO,UAAU,KAAK,UAAU;YAChC,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,SAAS,EAC5C,CAAC;YACC,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CACrC,GAAG,EACH,UAAU,CACb,CAAC;QACN,CAAC;QACD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CACvC,CAAC,GAAG,CAAC,CACR,CAAC;QACF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,sBAAsB,CAC5B,qCAAqC,CACxC,CAAC;QACN,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,oBAAoB,GACtB,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,IAAI,CAAC,OAAO,CAAC;gBACf,CAAC,GAAG,CAAC,EAAE,oBAAoB;aAC9B,CAAC,CAAC;YACH,OAAO;gBACH,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,oBAAoB;aAC9B,CAAC;QACN,CAAC;QACD,OAAO;YACH,MAAM,EAAE,IAAI;YACZ,KAAK;SACR,CAAC;IACN,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAc;QACtB,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;CACJ"}

package/dist/types/_module.d.ts

@@ -1,2 +1,4 @@
-export * from "./collection/_module";
 export * from "./contracts/_module";
+export * from "./collection/_module";
+export * from "./serializer/_module";
+export * from "./storage/_module";

package/dist/types/_shared/kysely/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../_shared/kysely/kysely-table-name-transformer-plugin";

package/dist/types/_shared/kysely/kysely-table-name-transformer-plugin.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @module Shared
+ */
+import type { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs, QueryResult, RootOperationNode, UnknownRow } from "kysely";
+/**
+ * @internal
+ */
+export declare class KyselyTableNameTransformerPlugin implements KyselyPlugin {
+    private readonly transformer;
+    constructor(tableNameMap: Record<string, string>);
+    transformQuery(args: PluginTransformQueryArgs): RootOperationNode;
+    transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
+}

package/dist/types/_shared/redis/_module.d.ts

@@ -0,0 +1,3 @@
+export * from "../../_shared/redis/escape-redis-chars";
+export * from "../../_shared/redis/clear-iterable";
+export * from "../../_shared/redis/is-redis-type-error";

package/dist/types/_shared/redis/clear-iterable.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @module Shared
+ */
+import type Redis from "ioredis";
+/**
+ * @internal
+ */
+export declare class ClearIterable implements AsyncIterable<void> {
+    private readonly client;
+    private readonly pattern;
+    constructor(client: Redis, pattern: string);
+    [Symbol.asyncIterator](): AsyncIterator<void>;
+}

package/dist/types/_shared/redis/escape-redis-chars.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @module Shared
+ */
+/**
+ * @internal
+ */
+export declare function escapeRedisChars(value: string): string;

package/dist/types/_shared/redis/is-redis-type-error.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @module Shared
+ */
+/**
+ * @internal
+ */
+export declare function isRedisTypeError(value: any): boolean;

package/dist/types/_shared/types.d.ts

@@ -1,6 +1,19 @@
+/**
+ * @module Shared
+ */
 export type EnsureType<TValue, TType> = Exclude<TValue, TType> extends never ? TValue : never;
 export type RecordItem<TKey, TValue> = [key: TKey, value: TValue];
 export type Lazyable<TValue> = TValue | (() => TValue);
-export type AsyncLazyable_<TValue> = TValue | (() => Promise<TValue>);
-export type AsyncLazyable<TValue> = AsyncLazyable_<TValue> | Lazyable<TValue>;
+export type Promisable<TValue> = TValue | Promise<TValue>;
+export type AsyncLazyable<TValue> = TValue | (() => Promisable<TValue>);
 export type AsyncIterableValue<TInput> = Iterable<TInput> | AsyncIterable<TInput>;
+export type AnyFunction = (...parameters: unknown[]) => unknown;
+export type IInitizable = {
+    init(): Promise<void>;
+};
+export type Func<TArgs extends unknown[], TReturn> = (...args_: TArgs) => TReturn;
+export type GetOrAddValue<TValue> = Awaited<TValue extends AnyFunction ? ReturnType<TValue> : TValue>;
+export type GetOrAddResult<TValue> = {
+    value: TValue;
+    hasKey: boolean;
+};

package/dist/types/_shared/utilities.d.ts

@@ -1,3 +1,13 @@
-import { AsyncLazyable, Lazyable } from "../_shared/types";
+/**
+ * @module Shared
+ */
+import type { Lazyable } from "../_shared/types";
+import { type AsyncLazyable } from "../_shared/types";
+/**
+ * @internal
+ */
 export declare function simplifyLazyable<TValue>(lazyable: Lazyable<TValue>): TValue;
+/**
+ * @internal
+ */
 export declare function simplifyAsyncLazyable<TValue>(lazyable: AsyncLazyable<TValue>): Promise<TValue>;

package/dist/types/collection/_shared.d.ts

@@ -1,5 +1,5 @@
 /**
- * @module Collections
+ * @module Collection
  */
 /**
  * The <i>range</i> function return a <i>{@link Iterable}</i> of numbers, starting from <i>from</i>,increments by 1 and stops at <i>to</i>.

package/dist/types/collection/async-iterable-collection/_shared/async-cross-join-iterable.d.ts

@@ -1,4 +1,5 @@
-import { CrossJoinResult, type IAsyncCollection } from "../../../contracts/collection/_module";
+import type { CrossJoinResult } from "../../../contracts/collection/_module";
+import { type IAsyncCollection } from "../../../contracts/collection/_module";
 import { type AsyncIterableValue } from "../../../_shared/types";
 /**
  * @internal

package/dist/types/collection/async-iterable-collection/_shared/async-group-by-iterable.d.ts

@@ -7,6 +7,6 @@ export declare class AsyncGroupByIterable<TInput, TOutput = TInput> implements A
     private collection;
     private selectFn;
     private makeCollection;
-    constructor(collection: IAsyncCollection<TInput>, selectFn: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput>, makeCollection: <TInput>(iterable: AsyncIterableValue<TInput>) => IAsyncCollection<TInput>);
+    constructor(collection: IAsyncCollection<TInput>, selectFn: AsyncMap<TInput, IAsyncCollection<TInput>, TOutput> | undefined, makeCollection: <TInput>(iterable: AsyncIterableValue<TInput>) => IAsyncCollection<TInput>);
     [Symbol.asyncIterator](): AsyncIterator<RecordItem<TOutput, IAsyncCollection<TInput>>>;
 }

package/dist/types/collection/async-iterable-collection/async-iterable-collection.d.ts

@@ -1,5 +1,5 @@
 /**
- * @module Collections
+ * @module Collection
  */
 import { type AsyncCollapse, type AsyncPredicate, type AsyncForEach, type AsyncMap, type AsyncModifier, type AsyncTap, type AsyncTransform, type Comparator, type IAsyncCollection, type ChangendItem, type AsyncReduce, type CrossJoinResult } from "../../contracts/collection/_module";
 import { type AsyncIterableValue, type AsyncLazyable, type EnsureType } from "../../_shared/types";
@@ -72,7 +72,7 @@ export declare class AsyncIterableCollection<TInput> implements IAsyncCollection
     insertAfter<TExtended = TInput>(predicateFn: AsyncPredicate<TInput, IAsyncCollection<TInput>>, iterable: AsyncIterableValue<TInput | TExtended>): IAsyncCollection<TInput | TExtended>;
     crossJoin<TExtended>(iterable: AsyncIterableValue<TExtended>): IAsyncCollection<CrossJoinResult<TInput, TExtended>>;
     zip<TExtended>(iterable: AsyncIterableValue<TExtended>): IAsyncCollection<RecordItem<TInput, TExtended>>;
-    sort(comparator?: Comparator<TInput> | undefined): IAsyncCollection<TInput>;
+    sort(comparator?: Comparator<TInput>): IAsyncCollection<TInput>;
     reverse(chunkSize?: number): IAsyncCollection<TInput>;
     shuffle(mathRandom?: () => number): IAsyncCollection<TInput>;
     first<TOutput extends TInput>(predicateFn?: AsyncPredicate<TInput, IAsyncCollection<TInput>, TOutput>): Promise<TOutput | null>;

package/dist/types/collection/iterable-collection/_shared/cross-join-iterable.d.ts

@@ -1,4 +1,4 @@
-import { CrossJoinResult, ICollection } from "../../../contracts/collection/_module";
+import type { CrossJoinResult, ICollection } from "../../../contracts/collection/_module";
 export declare class CrossJoinIterable<TInput, TExtended = TInput> implements Iterable<CrossJoinResult<TInput, TExtended>> {
     private collection;
     private iterable;

package/dist/types/collection/iterable-collection/_shared/group-by-iterable.d.ts

@@ -7,6 +7,6 @@ export declare class GroupByIterable<TInput, TOutput = TInput> implements Iterab
     private collection;
     private selectFn;
     private makeCollection;
-    constructor(collection: ICollection<TInput>, selectFn: Map<TInput, ICollection<TInput>, TOutput>, makeCollection: <TInput>(iterable: Iterable<TInput>) => ICollection<TInput>);
+    constructor(collection: ICollection<TInput>, selectFn: Map<TInput, ICollection<TInput>, TOutput> | undefined, makeCollection: <TInput>(iterable: Iterable<TInput>) => ICollection<TInput>);
     [Symbol.iterator](): Iterator<RecordItem<TOutput, ICollection<TInput>>>;
 }

package/dist/types/collection/iterable-collection/iterable-collection.d.ts

@@ -1,5 +1,5 @@
 /**
- * @module Collections
+ * @module Collection
  */
 import { type Collapse, type Comparator, type Predicate, type ForEach, type ICollection, type Map, type Modifier, type Tap, type Transform, type ChangendItem, type Reduce, type CrossJoinResult } from "../../contracts/collection/_module";
 import { type Lazyable, type EnsureType } from "../../_shared/types";

package/dist/types/collection/list-collection/list-collection.d.ts

@@ -1,5 +1,5 @@
 /**
- * @module Collections
+ * @module Collection
  */
 import { type Collapse, type Comparator, type Predicate, type ICollection, type Map, type Modifier, type Tap, type Transform, type ChangendItem, type Reduce, type ForEach, type CrossJoinResult } from "../../contracts/collection/_module";
 import { type EnsureType, type Lazyable } from "../../_shared/types";

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

@@ -1 +1,3 @@
 export * from "../contracts/collection/_module";
+export * from "../contracts/serializer/_module";
+export * from "../contracts/storage/_module";

package/dist/types/contracts/collection/_module.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module Collections
- */
 export * from "../../contracts/collection/_shared";
 export * from "../../contracts/collection/collection.contract";
 export * from "../../contracts/collection/async-collection.contract";

package/dist/types/contracts/collection/_shared.d.ts

@@ -1,5 +1,5 @@
 /**
- * @module Collections
+ * @module Collection
  */
 /**
  * @group Errors

package/dist/types/contracts/collection/async-collection.contract.d.ts

@@ -1,8 +1,8 @@
 /**
- * @module Collections
+ * @module Collection
  */
-import { type AsyncPredicate, type AsyncForEach, type AsyncMap, type AsyncModifier, type AsyncTap, type AsyncTransform, type Comparator, type ChangendItem, AsyncReduce, CrossJoinResult } from "../../contracts/collection/_shared";
-import { type RecordItem, type AsyncLazyable, type EnsureType, type AsyncIterableValue } from "../../_shared/types";
+import type { AsyncReduce, CrossJoinResult, AsyncPredicate, AsyncForEach, AsyncMap, AsyncModifier, AsyncTap, AsyncTransform, Comparator, ChangendItem } from "../../contracts/collection/_shared";
+import type { RecordItem, AsyncLazyable, EnsureType, AsyncIterableValue } from "../../_shared/types";
 export type AsyncCollapse<TValue> = TValue extends Array<infer TItem> | Iterable<infer TItem> | IAsyncCollection<infer TItem> ? TItem : TValue;
 /**
  * <i>IAsyncCollection</i> is immutable. The <i>throwOnIndexOverflow</i> parameter in the <i>IAsyncCollection</i> methods is used for preventing the index to overflow by throwing an error.

package/dist/types/contracts/collection/collection.contract.d.ts

@@ -1,8 +1,8 @@
 /**
- * @module Collections
+ * @module Collection
  */
-import { type Comparator, type Predicate, type ForEach, type Map, type Modifier, type Tap, type Transform, type ChangendItem, type Reduce, type CrossJoinResult } from "../../contracts/collection/_shared";
-import { type Lazyable, type RecordItem, type EnsureType } from "../../_shared/types";
+import type { Comparator, Predicate, ForEach, Map, Modifier, Tap, Transform, ChangendItem, Reduce, CrossJoinResult } from "../../contracts/collection/_shared";
+import type { Lazyable, RecordItem, EnsureType } from "../../_shared/types";
 export type Collapse<TValue> = TValue extends Array<infer TItem> | Iterable<infer TItem> | ICollection<infer TItem> ? TItem : TValue;
 /**
  * <i>ICollection</i> is immutable.

package/dist/types/contracts/serializer/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../contracts/serializer/serializer.contract";

package/dist/types/contracts/serializer/serializer.contract.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @module Serializer
+ */
+/**
+ * @group Errors
+ */
+export declare class SerializerError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class SerializationError extends SerializerError {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class DeserializationError extends SerializerError {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Contracts
+ * @throws {SerializerError} {@link SerializerError}
+ * @throws {SerializationError} {@link SerializationError}
+ * @throws {DeserializationError} {@link DeserializationError}
+ */
+export type ISerializer<TSerialized = unknown> = {
+    /**
+     * @throws {SerializationError} {@link SerializationError}
+     */
+    serialize<TValue>(value: TValue): Promise<TSerialized>;
+    /**
+     * @throws {DeserializationError} {@link DeserializationError}
+     */
+    deserialize<TValue>(value: TSerialized): Promise<TValue>;
+};

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

@@ -0,0 +1,3 @@
+export * from "../../contracts/storage/_shared";
+export * from "../../contracts/storage/storage.contract";
+export * from "../../contracts/storage/storage-adapter.contract";

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

@@ -0,0 +1,27 @@
+/**
+ * @module Storage
+ */
+/**
+ * @group Errors
+ */
+export declare class StorageError extends Error {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class UnexpectedStorageError extends StorageError {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class TypeStorageError extends StorageError {
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * @group Errors
+ */
+export declare class KeyNotFoundStorageError extends StorageError {
+    constructor(message: string, cause?: unknown);
+}

package/dist/types/contracts/storage/storage-adapter.contract.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @module Storage
+ */
+import type { GetOrAddResult } from "../../_shared/types";
+/**
+ * @throws {StorageError} {@link StorageError}
+ * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+ * @throws {TypeStorageError} {@link TypeStorageError}
+ * @group Contracts
+ */
+export type IStorageAdapter<TType> = {
+    /**
+     * Returns true for the keys that are found otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    existsMany?<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
+    /**
+     * Returns the value for the keys that are found otherwise null will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getMany<TValues extends TType, TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, TValues | null>>;
+    /**
+     * Adds the keys that doesn't exists. Returns true for the keys that doesn't exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    addMany<TValues extends TType, TKeys extends string>(values: Record<TKeys, TValues>): Promise<Record<TKeys, boolean>>;
+    /**
+     * Updates the keys that exists. Returns true for the keys that exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    updateMany<TValues extends TType, TKeys extends string>(values: Record<TKeys, TValues>): Promise<Record<TKeys, boolean>>;
+    /**
+     * Replaces the keys that are found. Adds keys that are not found. Returns true for all the keys that are found otherwise false is returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    putMany?<TValues extends TType, TKeys extends string>(values: Record<TKeys, TValues>): Promise<Record<TKeys, boolean>>;
+    /**
+     * Removes the keys that are found. Returns true for the keys that are found otherwise false is returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    removeMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
+    /**
+     * If the key is found the value be returned and key will be removed otherwise null will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getAndRemove?<TValue extends TType>(key: string): Promise<TValue | null>;
+    /**
+     * If the key is found the value be returned otherwise valueToAdd will be added and returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getOrAdd?<TValue extends TType, TExtended extends TType>(key: string, valueToAdd: TExtended): Promise<GetOrAddResult<TValue | TExtended>>;
+    /**
+     * Will increment the existing key with value if found otherwise nonthing occurs. Returns true if key exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     * @throws {TypeStorageError} {@link TypeStorageError}
+     */
+    increment?(key: string, value: number): Promise<boolean>;
+    /**
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    clear(prefix: string): Promise<void>;
+};

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

@@ -0,0 +1,147 @@
+/**
+ * @module Storage
+ */
+import { type AnyFunction, type AsyncLazyable, type GetOrAddValue } from "../../_shared/types";
+export type StorageValue<T> = Exclude<T, AnyFunction | undefined | null>;
+/**
+ * @throws {StorageError} {@link StorageError}
+ * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+ * @throws {TypeStorageError} {@link TypeStorageError}
+ * @group Contracts
+ */
+export type IStorage<TType = unknown> = AsyncDisposable & {
+    /**
+     * Returns true when key is found otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    exists(key: string): Promise<boolean>;
+    /**
+     * Returns true for the keys that are found otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    existsMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
+    /**
+     * Returns true when key is not found otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    missing(key: string): Promise<boolean>;
+    /**
+     * Returns true for the keys that are not found otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    missingMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
+    /**
+     * Returns the value when key is found otherwise null will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    get<TValue extends TType>(key: string): Promise<TValue | null>;
+    /**
+     * Returns the value for the keys that are found otherwise null will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getMany<TValues extends TType, TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, TValues | null>>;
+    /**
+     * Returns the value when key is found otherwise defaultValue will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getOr<TValue extends TType, TExtended extends TType>(key: string, defaultValue: AsyncLazyable<TExtended>): Promise<TValue | TExtended>;
+    /**
+     * Returns the value for the keys that are found otherwise defaultValue will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getOrMany<TValues extends TType, TExtended extends TType, TKeys extends string>(keysWithDefaults: Record<TKeys, AsyncLazyable<TExtended>>): Promise<Record<TKeys, TValues | TExtended>>;
+    /**
+     * Returns the value when key is found otherwise an error will be thrown.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     * @throws {KeyNotFoundStorageError} {@link KeyNotFoundStorageError}
+     */
+    getOrFail<TValue extends TType>(key: string): Promise<TValue>;
+    /**
+     * Adds a key when key doesn't exists. Returns true when key doesn't exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    add<TValue extends TType>(key: string, value: StorageValue<TValue>): Promise<boolean>;
+    /**
+     * Adds the keys that doesn't exists. Returns true for the keys that doesn't exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    addMany<TValues extends TType, TKeys extends string>(values: Record<TKeys, StorageValue<TValues>>): Promise<Record<TKeys, boolean>>;
+    /**
+     * Updates a keys that exists. Returns true when key otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    update<TValue extends TType>(key: string, value: TValue): Promise<boolean>;
+    /**
+     * Updates the keys that exists. Returns true for the keys that exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    updateMany<TValues extends TType, TKeys extends string>(values: Record<TKeys, TValues>): Promise<Record<TKeys, boolean>>;
+    /**
+     * If the key is found it will replaced. If the key is not found it will just be added. True is returned if the key is found otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    put<TValue extends TType>(key: string, value: StorageValue<TValue>): Promise<boolean>;
+    /**
+     * Replaces the keys that are found. Adds keys that are not found. Returns true for all the keys that are found otherwise false is returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    putMany<TValues extends TType, TKeys extends string>(values: Record<TKeys, StorageValue<TValues>>): Promise<Record<TKeys, boolean>>;
+    /**
+     * Removes the key when found. Returns true if the key is found otherwise false is returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    remove(key: string): Promise<boolean>;
+    /**
+     * Removes the keys that are found. Returns true for the keys that are found otherwise false is returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    removeMany<TKeys extends string>(keys: TKeys[]): Promise<Record<TKeys, boolean>>;
+    /**
+     * If the key is found the value be returned and key will be removed otherwise null will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getAndRemove<TValue extends TType>(key: string): Promise<TValue | null>;
+    /**
+     * If the key is found the value be returned otherwise valueToAdd will be added and returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    getOrAdd<TValue extends TType, TExtended extends TType>(key: string, valueToAdd: AsyncLazyable<StorageValue<GetOrAddValue<TExtended>>>): Promise<TValue | TExtended>;
+    /**
+     * Will increment the existing key with value if found otherwise nonthing will occur. Returns true if key exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     * @throws {TypeStorageError} {@link TypeStorageError}
+     */
+    increment(key: string, value?: number): Promise<boolean>;
+    /**
+     * Will decrement the existing key with value if found otherwise nonthing will occur. Returns true if key exists otherwise false will be returned.
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     * @throws {TypeStorageError} {@link TypeStorageError}
+     */
+    decrement(key: string, value?: number): Promise<boolean>;
+    /**
+     * @throws {StorageError} {@link StorageError}
+     * @throws {UnexpectedStorageError} {@link UnexpectedStorageError}
+     */
+    clear(): Promise<void>;
+};

package/dist/types/serializer/_module.d.ts

@@ -0,0 +1,5 @@
+export * from "../serializer/_shared/test-utilities/_module";
+export * from "../serializer/mongodb-serializer/_module";
+export * from "../serializer/redis-serializer/_module";
+export * from "../serializer/sql-serializer/_module";
+export * from "../serializer/super-json-serializer/_module";

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

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