@daiso-tech/core 0.22.2 → 0.24.0

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

@@ -1,125 +0,0 @@
-/**
- * @module Cache
- */
-import type { CacheEvents, WithTtlValue } from "../../../../cache/contracts/_module";
-import { type ICache, type ICacheAdapter } from "../../../../cache/contracts/_module";
-import { type IGroupableCache } from "../../../../cache/contracts/_module";
-import type { AsyncLazyable, GetOrAddValue, OneOrMore } from "../../../../utilities/_module";
-import type { TimeSpan } from "../../../../utilities/_module";
-import type { BackoffPolicy, RetryPolicy } from "../../../../async/_module";
-import { LazyPromise } from "../../../../async/_module";
-import type { IGroupableEventBus, Listener, Unsubscribe, EventClass, EventInstance } from "../../../../event-bus/contracts/_module";
-/**
- * @group Derivables
- */
-export type CacheSettings = {
-    adapter: ICacheAdapter<any>;
-    /**
-     * In order to listen to events of <i>{@link Cache}</i> class you must pass in <i>{@link IGroupableEventBus}</i>.
-     */
-    eventBus?: IGroupableEventBus<any>;
-    /**
-     * You can decide the default ttl value. If null is passed then no ttl will be used by default.
-     * @default {null}
-     */
-    defaultTtl?: TimeSpan | null;
-    /**
-     * The default retry attempt to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    retryAttempts?: number | null;
-    /**
-     * The default backof policy to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    backoffPolicy?: BackoffPolicy | null;
-    /**
-     * The default retry policy to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    retryPolicy?: RetryPolicy | null;
-    /**
-     * The default timeout to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    timeout?: TimeSpan | null;
-};
-/**
- * <i>Cache</i> class can be derived from any <i>{@link ICacheAdapter}</i>.
- * @group Derivables
- */
-export declare class Cache<TType = unknown> implements IGroupableCache<TType> {
-    private static defaultRetryPolicy;
-    private readonly groupdEventBus;
-    private readonly eventBus;
-    private readonly adapter;
-    private readonly defaultTtl;
-    private readonly retryAttempts;
-    private readonly backoffPolicy;
-    private readonly retryPolicy;
-    private readonly timeout;
-    /**
-     *@example
-     * ```ts
-     * import { Cache, MemoryCacheAdapter, EventBus, MemoryEventBusAdapter, registerCacheEvents, reigsterCacheErrors, SuperJsonSerde } from "@daiso-tech/core";
-     *
-     * const eventBus = new EventBus({
-     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
-     * });
-     * const cache = new Cache({
-     *   adapter: new MemoryCacheAdapter({
-     *     rootGroup: "@global"
-     *   }),
-     *   eventBus,
-     * });
-     * const serde = new SuperJsonSerde();
-     * registerCacheEvents(serde);
-     * reigsterCacheErrors(serde);
-     * ```
-     */
-    constructor(settings: CacheSettings);
-    private createLayPromise;
-    addListener<TEventClass extends EventClass<CacheEvents>>(eventName: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
-    addListenerMany<TEventClass extends EventClass<CacheEvents>>(eventNames: TEventClass[], listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
-    removeListener<TEventClass extends EventClass<CacheEvents>>(eventName: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
-    removeListenerMany<TEventClass extends EventClass<CacheEvents>>(eventNames: TEventClass[], listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
-    listenOnce<TEventClass extends EventClass<CacheEvents>>(eventName: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<void>;
-    subscribe<TEventClass extends EventClass<CacheEvents>>(eventName: TEventClass, listener: Listener<EventInstance<TEventClass>>): LazyPromise<Unsubscribe>;
-    subscribeMany<TEventClass extends EventClass<CacheEvents>>(eventNames: TEventClass[], listener: Listener<EventInstance<TEventClass>>): LazyPromise<Unsubscribe>;
-    withGroup(group: OneOrMore<string>): ICache<TType>;
-    getGroup(): string;
-    get(key: string): LazyPromise<TType | null>;
-    add(key: string, value: TType, 
-    /**
-     * @default null
-     */
-    ttl?: TimeSpan | null): LazyPromise<boolean>;
-    update(key: string, value: TType): LazyPromise<boolean>;
-    put(key: string, value: TType, 
-    /**
-     * @default null
-     */
-    ttl?: TimeSpan | null): LazyPromise<boolean>;
-    remove(key: string): LazyPromise<boolean>;
-    increment(key: string, value?: Extract<TType, number>): LazyPromise<boolean>;
-    clear(): LazyPromise<void>;
-    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>>;
-    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>;
-    addMany<TKeys extends string>(values: Record<TKeys, WithTtlValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
-    updateMany<TKeys extends string>(values: Record<TKeys, TType>): LazyPromise<Record<TKeys, boolean>>;
-    putMany<TKeys extends string>(values: Record<TKeys, WithTtlValue<TType>>): LazyPromise<Record<TKeys, boolean>>;
-    removeMany<TKeys extends string>(keys: TKeys[]): LazyPromise<Record<TKeys, boolean>>;
-    getAndRemove(key: string): LazyPromise<TType | null>;
-    getOrAdd(key: string, valueToAdd: AsyncLazyable<GetOrAddValue<TType>>, 
-    /**
-     * @default {null}
-     */
-    ttl?: TimeSpan): LazyPromise<TType>;
-    decrement(key: string, value?: Extract<TType, number>): LazyPromise<boolean>;
-}

package/dist/types/cache/implementations/derivables/cache-factory/_module.d.ts

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

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

@@ -1,111 +0,0 @@
-/**
- * @module Cache
- */
-import type { IGroupableEventBus } from "../../../../event-bus/contracts/_module";
-import type { ICacheAdapter } from "../../../../cache/contracts/_module";
-import { type ICacheFactory, type IGroupableCache } from "../../../../cache/contracts/_module";
-import type { OneOrMore, TimeSpan } from "../../../../utilities/_module";
-import type { BackoffPolicy, RetryPolicy } from "../../../../async/_module";
-import type { IFlexibleSerde } from "../../../../serde/contracts/_module";
-/**
- * @group Derivables
- */
-export type CacheAdapters<TAdapters extends string> = Partial<Record<TAdapters, ICacheAdapter<any>>>;
-/**
- * @group Derivables
- */
-export type CacheFactorySettings<TAdapters extends string = string> = {
-    /**
-     * You can pass one or more <i>{@link IFlexibleSerde}</i> that will be used to register all <i>{@link IGroupableCache}</i> related errors and events.
-     * @default {true}
-     */
-    serde: OneOrMore<IFlexibleSerde>;
-    /**
-     * If set to true, all <i>{@link IGroupableCache}</i> related errors will be registered with the specified <i>IFlexibleSerde</i> during constructor initialization.
-     * This ensures that all <i>{@link IGroupableCache}</i> related errors will be serialized correctly.
-     * @default {true}
-     */
-    shouldRegisterErrors?: boolean;
-    /**
-     * If set to true, all <i>{@link IGroupableCache}</i> related events will be registered with the specified <i>IFlexibleSerde</i> during constructor initialization.
-     * This ensures that all <i>{@link IGroupableCache}</i> related events will be serialized correctly.
-     * @default {true}
-     */
-    shouldRegisterEvents?: boolean;
-    adapters: CacheAdapters<TAdapters>;
-    defaultAdapter?: NoInfer<TAdapters>;
-    /**
-     * You can decide the default ttl value. If null is passed then no ttl will be used by default.
-     */
-    defaultTtl?: TimeSpan;
-    /**
-     * In order to listen to events of <i>{@link Cache}</i> class you must pass in <i>{@link IGroupableEventBus}</i>.
-     */
-    eventBus: IGroupableEventBus<any>;
-    /**
-     * The default retry attempt to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    retryAttempts?: number | null;
-    /**
-     * The default backof policy to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    backoffPolicy?: BackoffPolicy | null;
-    /**
-     * The default retry policy to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    retryPolicy?: RetryPolicy | null;
-    /**
-     * The default timeout to use in the returned <i>LazyPromise</i>.
-     * @default {null}
-     */
-    timeout?: TimeSpan | null;
-};
-/**
- * @group Derivables
- */
-export declare class CacheFactory<TAdapters extends string = string> implements ICacheFactory<TAdapters> {
-    private readonly cacheRecord;
-    private readonly defaultAdapter?;
-    private readonly eventBus;
-    private readonly defaultTtl;
-    private readonly retryAttempts?;
-    private readonly backoffPolicy?;
-    private readonly retryPolicy?;
-    private readonly timeout?;
-    private readonly serde;
-    private readonly shouldRegisterErrors?;
-    private readonly shouldRegisterEvents?;
-    /**
-     * @example
-     * ```ts
-     * import { CacheFactory, MemoryCacheAdapter, RedisCacheAdapter, EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
-     * import Redis from "ioredis"
-     *
-     * const eventBus = new EventBus({
-     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
-     * });
-     * const serde = new SuperJsonSerde();
-     * const cacheFactory = new CacheFactory({
-     *   serde,
-     *   adapters: {
-     *     memory: new MemoryCacheAdapter({
-     *       rootGroup: "@global"
-     *     }),
-     *     redis: new RedisCacheAdapter({
-     *       client: new Redis("YOUR_REDIS_CONNECTION"),
-     *       serde,
-     *       rootGroup: "@global"
-     *     }),
-     *   },
-     *   defaultAdapter: "memory",
-     *   eventBus,
-     * });
-     * ```
-     */
-    constructor(settings: CacheFactorySettings<TAdapters>);
-    private init;
-    use<TType = unknown>(adapterName?: TAdapters | undefined): IGroupableCache<TType>;
-}

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

@@ -1,4 +0,0 @@
-export * from "../../collection/contracts/_shared";
-export * from "../../collection/contracts/collection.contract";
-export * from "../../collection/contracts/collection.errors";
-export * from "../../collection/contracts/async-collection.contract";

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

@@ -1,33 +0,0 @@
-/**
- * @module Collection
- */
-export type Comparator<TItem> = (itemA: TItem, itemB: TItem) => number;
-export type Predicate_<TInput, TCollection> = (item: TInput, index: number, collection: TCollection) => boolean;
-export type PredicateGuard<TInput, TCollection, TOutput extends TInput = TInput> = (item: TInput, index: number, collection: TCollection) => item is TOutput;
-export type Predicate<TInput, TCollection, TOutput extends TInput = TInput> = Predicate_<TInput, TCollection> | PredicateGuard<TInput, TCollection, TOutput>;
-export type Reduce<TInput, TCollection, TOutput> = (output: TOutput, item: TInput, index: number, collection: TCollection) => TOutput;
-export type Map<TInput, TCollection, TOutput> = (item: TInput, index: number, collection: TCollection) => TOutput;
-export type ForEach<TInput, TCollection> = (item: TInput, index: number, collection: TCollection) => void;
-export type Modifier<TInput, TOutput> = (collection: TInput) => TOutput;
-export type Tap<TCollection> = (collection: TCollection) => void;
-export type Transform<TInput, TOutput> = (value: TInput) => TOutput;
-export type AsyncPredicate_<TInput, TCollection> = (item: TInput, index: number, collection: TCollection) => PromiseLike<boolean>;
-export type AsyncPredicate<TInput, TCollection, TOutput extends TInput = TInput> = AsyncPredicate_<TInput, TCollection> | Predicate<TInput, TCollection, TOutput>;
-export type AsyncReduce_<TInput, TCollection, TOutput> = (output: TOutput, item: TInput, index: number, collection: TCollection) => PromiseLike<TOutput>;
-export type AsyncReduce<TInput, TCollection, TOutput> = AsyncReduce_<TInput, TCollection, TOutput> | Reduce<TInput, TCollection, TOutput>;
-export type AsyncMap_<TInput, TCollection, TOutput> = (item: TInput, index: number, collection: TCollection) => PromiseLike<TOutput>;
-export type AsyncMap<TInput, TCollection, TOutput> = AsyncMap_<TInput, TCollection, TOutput> | Map<TInput, TCollection, TOutput>;
-export type AsyncForEach_<TInput, TCollection> = (item: TInput, index: number, collection: TCollection) => PromiseLike<void>;
-export type AsyncForEach<TInput, TCollection> = ForEach<TInput, TCollection> | AsyncForEach_<TInput, TCollection>;
-export type AsyncModifier_<TInput, TOutput> = (collection: TInput) => PromiseLike<TOutput>;
-export type AsyncModifier<TInput, TOutput> = Modifier<TInput, TOutput> | AsyncModifier_<TInput, TOutput>;
-export type AsyncTap_<TCollection> = (collection: TCollection) => PromiseLike<void>;
-export type AsyncTap<TCollection> = Tap<TCollection> | AsyncTap_<TCollection>;
-export type AsyncTransform_<TInput, TOutput> = (value: TInput) => PromiseLike<TOutput>;
-export type AsyncTransform<TInput, TOutput> = Transform<TInput, TOutput> | AsyncTransform_<TInput, TOutput>;
-export type CrossJoinResult<TInput, TExtended> = TInput extends [
-    infer R,
-    ...infer L
-] ? [R, ...L, TExtended] : [TInput, TExtended];
-export type EnsureRecord<TInput> = TInput extends [infer TKey, infer TValue] | readonly [infer TKey, infer TValue] ? TKey extends string | number | symbol ? Record<TKey, TValue> : never : never;
-export type EnsureMap<TInput> = TInput extends [infer TKey, infer TValue] | readonly [infer TKey, infer TValue] ? globalThis.Map<TKey, TValue> : never;