@daiso-tech/core 0.22.2 → 0.24.0

package/dist/types/async/backof-policies/constant-backoff-policy/constant-backoff-policy.d.ts

@@ -1,28 +0,0 @@
-/**
- * @module Async
- */
-import { TimeSpan } from "../../../utilities/_module";
-import { type BackoffPolicy } from "../../../async/backof-policies/_shared";
-/**
- * @group Backoff policies
- */
-export type ConstantBackoffPolicySettings = {
-    /**
-     * @default 1000 milliseconds
-     */
-    delay?: TimeSpan;
-    /**
-     * @default {0.5}
-     */
-    jitter?: number;
-    /**
-     * Used only for testing
-     * @internal
-     */
-    _mathRandom?: () => number;
-};
-/**
- * Constant backoff policy with jitter
- * @group Backoff policies
- */
-export declare function constantBackoffPolicy(settings?: ConstantBackoffPolicySettings | ((error: unknown) => ConstantBackoffPolicySettings)): BackoffPolicy;

package/dist/types/async/backof-policies/exponential-backoff-policy/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../async/backof-policies/exponential-backoff-policy/exponential-backoff-policy";

package/dist/types/async/backof-policies/exponential-backoff-policy/exponential-backoff-policy.d.ts

@@ -1,36 +0,0 @@
-/**
- * @module Async
- */
-import { TimeSpan } from "../../../utilities/_module";
-import type { BackoffPolicy } from "../../../async/backof-policies/_shared";
-/**
- * @group Backoff policies
- */
-export type ExponentialBackoffPolicySettings = {
-    /**
-     * @default 60_000 milliseconds
-     */
-    maxDelay?: TimeSpan;
-    /**
-     * @default 1_000 milliseconds
-     */
-    minDelay?: TimeSpan;
-    /**
-     * @default {2}
-     */
-    multiplier?: number;
-    /**
-     * @default {0.5}
-     */
-    jitter?: number;
-    /**
-     * Used only for testing
-     * @internal
-     */
-    _mathRandom?: () => number;
-};
-/**
- * Exponential backoff policy with jitter
- * @group Backoff policies
- */
-export declare function exponentialBackoffPolicy(settings?: ExponentialBackoffPolicySettings | ((error: unknown) => ExponentialBackoffPolicySettings)): BackoffPolicy;

package/dist/types/async/backof-policies/linear-backoff-policy/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../async/backof-policies/linear-backoff-policy/linear-backoff-policy";

package/dist/types/async/backof-policies/linear-backoff-policy/linear-backoff-policy.d.ts

@@ -1,32 +0,0 @@
-/**
- * @module Async
- */
-import { TimeSpan } from "../../../utilities/_module";
-import type { BackoffPolicy } from "../../../async/backof-policies/_shared";
-/**
- * @group Backoff policies
- */
-export type LinearBackoffPolicySettings = {
-    /**
-     * @default 6000 milliseconds
-     */
-    maxDelay?: TimeSpan;
-    /**
-     * @default 1_000 milliseconds
-     */
-    minDelay?: TimeSpan;
-    /**
-     * @default {0.5}
-     */
-    jitter?: number;
-    /**
-     * Used only for testing
-     * @internal
-     */
-    _mathRandom?: () => number;
-};
-/**
- * Linear backoff policy with jitter
- * @group Backoff policies
- */
-export declare function linearBackoffPolicy(settings?: LinearBackoffPolicySettings | ((error: unknown) => LinearBackoffPolicySettings)): BackoffPolicy;

package/dist/types/async/backof-policies/polynomial-backoff-policy/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../async/backof-policies/polynomial-backoff-policy/polynomial-backoff-policy";

package/dist/types/async/backof-policies/polynomial-backoff-policy/polynomial-backoff-policy.d.ts

@@ -1,36 +0,0 @@
-/**
- * @module Async
- */
-import { TimeSpan } from "../../../utilities/_module";
-import type { BackoffPolicy } from "../../../async/backof-policies/_shared";
-/**
- * @group Backoff policies
- */
-export type PolynomialBackoffPolicySettings = {
-    /**
-     * @default 60_000 milliseconds
-     */
-    maxDelay?: TimeSpan;
-    /**
-     * @default 1_000 milliseconds
-     */
-    minDelay?: TimeSpan;
-    /**
-     * @default {2}
-     */
-    degree?: number;
-    /**
-     * @default {0.5}
-     */
-    jitter?: number;
-    /**
-     * Used only for testing
-     * @internal
-     */
-    _mathRandom?: () => number;
-};
-/**
- * Polynomial backoff policy with jitter
- * @group Backoff policies
- */
-export declare function polynomialBackoffPolicy(settings?: PolynomialBackoffPolicySettings | ((error: unknown) => PolynomialBackoffPolicySettings)): BackoffPolicy;

package/dist/types/async/utilities/_module.d.ts

@@ -1,5 +0,0 @@
-export * from "../../async/utilities/abort/_module";
-export * from "../../async/utilities/delay/_module";
-export * from "../../async/utilities/lazy-promise/_module";
-export * from "../../async/utilities/retry/_module";
-export * from "../../async/utilities/timeout/_module";

package/dist/types/async/utilities/abort/_module.d.ts

@@ -1,2 +0,0 @@
-export * from "../../../async/utilities/abort/abort-and-fail";
-export * from "../../../async/utilities/abort/abort";

package/dist/types/async/utilities/abort/abort.d.ts

@@ -1,9 +0,0 @@
-/**
- * @module Async
- */
-import type { Result } from "../../../utilities/types";
-import { AbortAsyncError } from "../../../async/async.errors";
-/**
- * @internal
- */
-export declare function abort<TValue>(asyncFn: () => PromiseLike<TValue>, abortSignal: AbortSignal): Promise<Result<TValue, AbortAsyncError>>;

package/dist/types/async/utilities/delay/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../async/utilities/delay/delay";

package/dist/types/async/utilities/delay/delay.d.ts

@@ -1,19 +0,0 @@
-/**
- * @module Async
- */
-import { type TimeSpan } from "../../../utilities/_module";
-/**
- * The <i>delay</i> function creates a promise that will be fulfilled after given <i>time</i> and can be aborted by providing <i>abortSignal</i>.
- * @group Utilities
- * @throws {AsyncError} {@link AsyncError}
- * @throws {AbortAsyncError} {@link AbortAsyncError}
- * @example
- * ```ts
- * import { delay, TimeSpan } from "@daiso-tech/core";
- * (async () => {
- *   console.log("a");
- *   await delay(TimeSpan.fromSeconds(2));
- *   console.log("b");
- * })();
- */
-export declare function delay(time: TimeSpan, abortSignal?: AbortSignal): Promise<void>;

package/dist/types/async/utilities/lazy-promise/_module.d.ts

@@ -1 +0,0 @@
-export * from "../../../async/utilities/lazy-promise/lazy-promise";

package/dist/types/async/utilities/lazy-promise/lazy-promise.d.ts

@@ -1,212 +0,0 @@
-/**
- * @module Async
- */
-import type { BackoffPolicy } from "../../../async/backof-policies/_module";
-import type { TimeSpan } from "../../../utilities/time-span/_module";
-import type { RetryPolicy } from "../../../async/utilities/retry/_module";
-import { type Func } from "../../../utilities/_module";
-/**
- * The <i>LazyPromise</i> class is used for creating lazy <i>{@link PromiseLike}<i> object that will only execute when awaited or when then method is called.
- * The class includes helpful methods
- * - <i>defer</i>
- * - <i>retryAttempts</i>
- * - <i>retryPolicy</i>
- * - <i>backoffPolicy</i>
- * - <i>abort</i>
- * - <i>timeout</i>
- *
- * The order in which these methods are called does not affect their methodality. Internally, the following execution order is applied:
- * 1. <i>timeout</i>
- * 2. <i>retryAttempts</i>
- * 3. <i>abort</i>
- *
- * This means that combining all methods ensures the <i>retryAttempts</i> method will continue retrying even if the timeout is triggered,
- * while the <i>abort</i> method takes priority to cancel all operations if activated.
- * @group Utilities
- */
-export declare class LazyPromise<TValue> implements PromiseLike<TValue> {
-    /**
-     * The <i>wrapFn</i> is convience method used for wrapping a async method with a <i>LazyPromise</i>.
-     * @example
-     * ```ts
-     * import { LazyPromise, TimeSpan } from "@daiso-tech/core";
-     * import { readFile as readFileNodeJs } from "node:fs/promises";
-     *
-     * const readFile = LazyPromise.wrapFn(readFileNodeJs, {
-     *   retryAttempts: 3
-     * });
-     *
-     * (async () => {
-     *   await readFile("none_existing_file.txt").timeout(TimeSpan.fromMinutes(1));
-     * })();
-     * ```
-     */
-    static wrapFn<TParameters extends unknown[], TReturn>(fn: Func<TParameters, PromiseLike<TReturn>>): Func<TParameters, LazyPromise<TReturn>>;
-    /**
-     * The <i>all<i> method works similarly to <i>{@link Promise.all}</i> with the key distinction that it operates lazily.
-     */
-    static all<TValue>(promises: LazyPromise<TValue>[]): LazyPromise<TValue[]>;
-    /**
-     * The <i>allSettled<i> method works similarly to <i>{@link Promise.allSettled}</i> with the key distinction that it operates lazily.
-     */
-    static allSettled<TValue>(promises: LazyPromise<TValue>[]): LazyPromise<PromiseSettledResult<TValue>[]>;
-    /**
-     * The <i>race<i> method works similarly to <i>{@link Promise.race}</i> with the key distinction that it operates lazily.
-     */
-    static race<TValue>(promises: LazyPromise<TValue>[]): LazyPromise<TValue>;
-    /**
-     * The <i>any<i> method works similarly to <i>{@link Promise.any}</i> with the key distinction that it operates lazily.
-     */
-    static any<TValue>(promises: LazyPromise<TValue>[]): LazyPromise<TValue>;
-    private promise;
-    private attempts;
-    private backoffPolicy_;
-    private retryPolicy_;
-    private abortSignal;
-    private time;
-    private asyncFn;
-    /**
-     * @example
-     * ```ts
-     * import { LazyPromise } from "@daiso-tech/core";
-     *
-     * (async () => {
-     *   const promise = new LazyPromise(async () => {
-     *     console.log("I am lazy");
-     *   });
-     *   // "I am lazy" will only logged when awaited or then method i called.
-     *   await promise;
-     * })();
-     */
-    constructor(asyncFn: () => PromiseLike<TValue>);
-    private applyTimeout;
-    private applyRetry;
-    private applyAbort;
-    private applySettings;
-    /**
-     * @throws {AbortAsyncError} {@link AbortAsyncError}
-     * @throws {TimeoutAsyncError} {@link TimeoutAsyncError}
-     * @throws {RetryAsyncError} {@link RetryAsyncError}
-     */
-    then<TResult1 = TValue, TResult2 = never>(onfulfilled?: ((value: TValue) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
-    /**
-     * The <i>setRetryAttempts</i> method is used for setting max retry attempts.
-     * @example
-     * ```ts
-     * import { LazyPromise } from "@daiso-tech/core";
-     *
-     * const promise =
-     *   new LazyPromise(async () => {
-     *     console.log("A");
-     *     throw new Error("Error occured!");
-     *   })
-     *   .setRetryAttempts(3)
-     * (async () => {
-     *   // Will log "A" 3 times and then retry error will be thrown.
-     *   await promise;
-     * })();
-     * ```
-     */
-    setRetryAttempts(attempts: number | null): this;
-    /**
-     * The <i>setBackoffPolicy</i> method is used for setting a custom <i>{@link BackoffPolicy}</i>.
-     * @example
-     * ```ts
-     * import { LazyPromise, linearBackoffPolicy } from "@daiso-tech/core";
-     *
-     * const promise =
-     *   new LazyPromise(async () => {
-     *     console.log("A");
-     *     throw new Error("Error occured!");
-     *   })
-     *   .setRetryAttempts(3)
-     *   .setBackoffPolicy(linearBackoffPolicy())
-     * (async () => {
-     *   // Will log "A" 3 times and then retry error will be thrown.
-     *   await promise;
-     * })();
-     * ```
-     */
-    setBackoffPolicy(policy: BackoffPolicy | null): this;
-    /**
-     * The <i>setRetryPolicy</i> method is used for setting a custom <i>{@link BackoffPolicy}</i>.
-     * @example
-     * ```ts
-     * import { LazyPromise } from "@daiso-tech/core";
-     *
-     * class ErrorA extends Error {}
-     *
-     * const promise =
-     *   new LazyPromise(async () => {
-     *     console.log("A");
-     *     throw new Error("Error occured!");
-     *   })
-     *   .setRetryAttempts(3)
-     *   // Will only retry an error that is instance ErrorA
-     *   .setRetryPolicy(error => error instanceof ErrorA)
-     * (async () => {
-     *   // Will log "A" 1 time and then error will be thrown.
-     *   await promise;
-     * })();
-     * ```
-     */
-    setRetryPolicy(policy: RetryPolicy | null): this;
-    /**
-     * The <i>setTimeout</i> method aborts the <i>LazyPromise</i> if it exceeds the given <i>time</i> by throwning an error.
-     * @example
-     * ```ts
-     * import { LazyPromise, delay, TimeSpan } from "@daiso-tech/core";
-     *
-     * const promise =
-     *   new LazyPromise(async () => {
-     *     await delay(TimeSpan.fromMinutes(1));
-     *   })
-     *   .setTimeout(TimeSpan.fromSeconds(1));
-     * (async () => {
-     *   // An timeout error will be thrown.
-     *   await promise;
-     * })();
-     * ```
-     */
-    setTimeout(time: TimeSpan | null): this;
-    /**
-     * The <i>setAbortSignal</i> method aborts the <i>LazyPromise</i> by the passed in <i>abortSignal</i>.
-     * @example
-     * ```ts
-     * import { LazyPromise, delay, TimeSpan } from "@daiso-tech/core";
-     *
-     * const abortController = new AbortController();
-     * const promise =
-     *   new LazyPromise(async () => {
-     *     await delay(TimeSpan.fromMinutes(1));
-     *   })
-     *   .setAbortSignal(abortController.signal);
-     * (async () => {
-     *   setTimeout(() => {
-     *     abortController.abort();
-     *   }, 1000);
-     *   // An timeout error will be thrown.
-     *   await promise;
-     * })();
-     * ```
-     */
-    setAbortSignal(abortSignal: AbortSignal | null): this;
-    /**
-     * The <i>defer</i> method executes the <i>LazyPromise</i> without awaiting it.
-     * @example
-     * ```ts
-     * import { LazyPromise, delay, TimeSpan } from "@daiso-tech/core";
-     *
-     * const promise =
-     *   new LazyPromise(async () => {
-     *     await delay(TimeSpan.fromSeconds(1));
-     *     // Will be loged after one second
-     *     console.log("Done !");
-     *   });
-     * promise.defer();
-     * // Will be logged immediately
-     * console.log("Hello");
-     * ```
-     */
-    defer(): void;
-}

package/dist/types/async/utilities/retry/_module.d.ts

@@ -1,2 +0,0 @@
-export * from "../../../async/utilities/retry/retry-or-fail";
-export * from "../../../async/utilities/retry/retry";

package/dist/types/async/utilities/retry/retry-or-fail.d.ts

@@ -1,23 +0,0 @@
-/**
- * @module Async
- */
-import type { BackoffPolicy } from "../../../async/backof-policies/_module";
-/**
- * @group Utilities
- */
-export type RetryPolicy = (error: unknown) => boolean;
-/**
- * @group Utilities
- */
-export type RetrySettings = {
-    /**
-     * @default {4}
-     */
-    maxAttempts?: number;
-    backoffPolicy?: BackoffPolicy;
-    retryPolicy?: RetryPolicy;
-};
-/**
- * @internal
- */
-export declare function retryOrFail<TValue = void>(asyncFn: () => PromiseLike<TValue>, settings?: RetrySettings): Promise<TValue>;

package/dist/types/async/utilities/retry/retry.d.ts

@@ -1,10 +0,0 @@
-/**
- * @module Async
- */
-import { RetryAsyncError } from "../../../async/async.errors";
-import type { Result } from "../../../utilities/types";
-import type { RetrySettings } from "../../../async/utilities/retry/retry-or-fail";
-/**
- * @internal
- */
-export declare function retry<TValue = void>(asyncFn: () => PromiseLike<TValue>, settings?: RetrySettings): Promise<Result<TValue, RetryAsyncError>>;

package/dist/types/async/utilities/timeout/_module.d.ts

@@ -1,2 +0,0 @@
-export * from "../../../async/utilities/timeout/timeout-and-fail";
-export * from "../../../async/utilities/timeout/timeout";

package/dist/types/async/utilities/timeout/timeout-and-fail.d.ts

@@ -1,5 +0,0 @@
-import type { TimeSpan } from "../../../utilities/_module";
-/**
- * @internal
- */
-export declare function timeoutAndFail<TValue>(asyncFn: () => PromiseLike<TValue>, time: TimeSpan): Promise<TValue>;

package/dist/types/async/utilities/timeout/timeout.d.ts

@@ -1,10 +0,0 @@
-/**
- * @module Async
- */
-import { TimeoutAsyncError } from "../../../async/async.errors";
-import type { TimeSpan } from "../../../utilities/_module";
-import type { Result } from "../../../utilities/types";
-/**
- * @internal
- */
-export declare function timeout<TValue>(asyncFn: () => PromiseLike<TValue>, time: TimeSpan): Promise<Result<TValue, TimeoutAsyncError>>;

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

@@ -1,5 +0,0 @@
-export * from "../../cache/contracts/cache-adapter.contract";
-export * from "../../cache/contracts/cache-factory.contract";
-export * from "../../cache/contracts/cache.contract";
-export * from "../../cache/contracts/cache.errors";
-export * from "../../cache/contracts/cache.events";

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

@@ -1,54 +0,0 @@
-/**
- * @module Cache
- */
-import type { TimeSpan } from "../../utilities/_module";
-/**
- * The <i>ICacheAdapter</i> contract defines a way for storing data as key-value pairs independent of data storage.
- * This contract is not meant to be used directly, instead you should use <i>{@link ICache}</i> contract.
- * @group Contracts
- */
-export type ICacheAdapter<TType = unknown> = {
-    /**
-     * The <i>get</i> returns the <i>key</i> value if found otherwise null will be returned.
-     */
-    get(key: string): PromiseLike<TType | null>;
-    /**
-     * The <i>add</i> method add a new <i>key</i>. Returns true if the <i>key</i> where added otherwise false will be returned.
-     * You must provide a <i>ttl</i> value. If null is passed, the item will not expire.
-     */
-    add(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
-    /**
-     * The <i>update</i> method updates a <i>key</i>. Returns true if the <i>key</i> where updated otherwise false will be returned.
-     */
-    update(key: string, value: TType): PromiseLike<boolean>;
-    /**
-     * The <i>put</i> method replaces a <i>key</i> if the <i>key</i> exists including the ttl value or adds <i>key</i> that do not exists with a given <i>ttl</i>.
-     * Returns true if the <i>key</i> where replaced otherwise false is returned.
-     * You must provide a <i>ttl</i> value. If null is passed, the item will not expire.
-     */
-    put(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
-    /**
-     * The <i>remove</i> method removes a <i>key</i>. Returns true if the <i>key</i> is removed otherwise false is returned.
-     */
-    remove(key: string): PromiseLike<boolean>;
-    /**
-     * The <i>increment</i> method will increment the given <i>key</i> if found otherwise nonthing will occur.
-     * Returns true if key is incremented otherwise false will be returned.
-     * An error will thrown if the key is not a number.
-     * @throws {TypeCacheError} {@link TypeCacheError}
-     */
-    increment(key: string, value: number): PromiseLike<boolean>;
-    /**
-     * The <i>clear</i> method removes all keys that starts <i>prefix</i>.
-     */
-    clear(): PromiseLike<void>;
-    /**
-     * The <i>getGroup</i> method returns the group name.
-     */
-    getGroup(): string;
-    /**
-     * The <i>withGroup</i> method returns a new <i>{@link ICacheAdapter}</i> instance that groups keys together.
-     * Only keys in the same group will be updated, removed, or retrieved, leaving keys outside the group unaffected.
-     */
-    withGroup(group: string): ICacheAdapter<TType>;
-};

package/dist/types/cache/contracts/cache-factory.contract.d.ts

@@ -1,34 +0,0 @@
-/**
- * @module Cache
- */
-import type { IGroupableCache } from "../../cache/contracts/cache.contract";
-/**
- * The <i>ICacheFactory</i> contract makes it easy to configure and switch between different <i>{@link IGroupableCache}</i> dynamically.
- * @group Contracts
- */
-export type ICacheFactory<TAdapters extends string = string> = {
-    /**
-     * The <i>use</i> method will throw an error if you provide it unregisted adapter.
-     * If no default adapter is defined an error will be thrown by <i>use</i> method.
-     * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
-     * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
-     * @example
-     * ```ts
-     * import type { ICacheFactory } from "@daiso-tech/core";
-     *
-     * // Asume the inputed cacheFactory has registered both a memory and Redis ICacheAdapter.
-     * // The memory ICacheAdapter adapter is the default.
-     * async function main(cacheFactory: ICacheFactory): Promise<void> {
-     *   // Will add key using the default adapter
-     *   await cacheFactory
-     *     .use()
-     *     .add("a", 1);
-     *   // Will add key using the redis addapter
-     *   await cacheFactory
-     *     .use("redis")
-     *     .add("a", 1);
-     * }
-     * ```
-     */
-    use<TType = unknown>(adapterName?: TAdapters): IGroupableCache<TType>;
-};