@daiso-tech/core 0.20.0 → 0.21.0

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

@@ -2,8 +2,7 @@
  * @module Cache
  */
 import type { CacheEvents, WithTtlValue } from "../../../../cache/contracts/_module";
-import { KeyFoundCacheEvent, KeyNotFoundCacheEvent, KeyAddedCacheEvent, KeyUpdatedCacheEvent, KeyRemovedCacheEvent, KeyIncrementedCacheEvent, KeyDecrementedCacheEvent, KeysClearedCacheEvent, type ICache } from "../../../../cache/contracts/_module";
-import { CacheError, KeyNotFoundCacheError, TypeCacheError, UnexpectedCacheError } from "../../../../cache/contracts/_module";
+import { type ICache } 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";
@@ -16,22 +15,6 @@ import { CacheSettingsBuilder } from "../../../../cache/implementations/derivabl
  * @group Derivables
  */
 export declare class Cache<TType = unknown> implements IGroupableCache<TType> {
-    static readonly errors: {
-        readonly Error: typeof CacheError;
-        readonly Unexpected: typeof UnexpectedCacheError;
-        readonly Type: typeof TypeCacheError;
-        readonly KeyNotFound: typeof KeyNotFoundCacheError;
-    };
-    static readonly events: {
-        readonly KeyFound: typeof KeyFoundCacheEvent;
-        readonly KeyNotFound: typeof KeyNotFoundCacheEvent;
-        readonly KeyAdded: typeof KeyAddedCacheEvent;
-        readonly KeyUpdated: typeof KeyUpdatedCacheEvent;
-        readonly KeyRemoved: typeof KeyRemovedCacheEvent;
-        readonly KeyIncremented: typeof KeyIncrementedCacheEvent;
-        readonly KeyDecremented: typeof KeyDecrementedCacheEvent;
-        readonly KeysCleared: typeof KeysClearedCacheEvent;
-    };
     /**
      * @example
      * ```ts
@@ -40,10 +23,8 @@ export declare class Cache<TType = unknown> implements IGroupableCache<TType> {
      * const cache = new Cache(
      *   Cache
      *     .settings()
-     *     .setSerde(new SuperJsonSerde())
      *     .setAdapter(new MemoryCacheAdapter({ rootGroup: "@global" }))
      *     .setEventBus(new EventBus(new MemoryEventBusAdapter({ rootGroup: "@global" })))
-     *     .setDefaultTtl(TimeSpan.fromMinutes(2))
      *     .build()
      * );
      * ```
@@ -58,35 +39,26 @@ export declare class Cache<TType = unknown> implements IGroupableCache<TType> {
     private readonly backoffPolicy;
     private readonly retryPolicy;
     private readonly timeout;
-    private readonly serde;
-    private readonly shouldRegisterErrors;
-    private readonly shouldRegisterEvents;
     /**
      *@example
      * ```ts
-     * import { Cache, MemoryCacheAdapter, EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
+     * 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({
-     *   serde: new SuperJsonSerde();
      *   adapter: new MemoryCacheAdapter({
      *     rootGroup: "@global"
      *   }),
      *   eventBus,
      * });
+     * const serde = new SuperJsonSerde();
+     * registerCacheEvents(serde);
+     * reigsterCacheErrors(serde);
      * ```
      */
     constructor(settings: CacheSettings);
-    /**
-     * Registers all cache-related events within the given <i>IFlexibleSerde</i> contract.
-     */
-    private registerEvents;
-    /**
-     * Registers all cache-related error within the given <i>IFlexibleSerde</i> contract.
-     */
-    private registerErrors;
     private createLayPromise;
     private createKeyFoundEvent;
     private createKeyNotFoundEvent;

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

@@ -40,7 +40,7 @@ export type CacheFactorySettings<TAdapters extends string = string> = {
     /**
      * In order to listen to events of <i>{@link Cache}</i> class you must pass in <i>{@link IGroupableEventBus}</i>.
      */
-    eventBus?: IGroupableEventBus<any>;
+    eventBus: IGroupableEventBus<any>;
     /**
      * The default retry attempt to use in the returned <i>LazyPromise</i>.
      * @default {null}

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

@@ -1,7 +1,7 @@
 /**
  * @module Cache
  */
-import type { ICacheFactory, IGroupableCache } from "../../../../cache/contracts/_module";
+import { type ICacheFactory, type IGroupableCache } from "../../../../cache/contracts/_module";
 import type { CacheFactorySettings } from "../../../../cache/implementations/derivables/cache-factory/cache-factory-settings";
 import { CacheFactorySettingsBuilder } from "../../../../cache/implementations/derivables/cache-factory/cache-factory-settings";
 /**
@@ -33,10 +33,9 @@ export declare class CacheFactory<TAdapters extends string = string> implements
      * ```
      */
     static settings<TAdapters extends string, TSettings extends CacheFactorySettings<TAdapters>>(): CacheFactorySettingsBuilder<TSettings>;
-    private readonly caches;
-    private readonly adapters;
+    private readonly cacheRecord;
     private readonly defaultAdapter?;
-    private readonly eventBus?;
+    private readonly eventBus;
     private readonly defaultTtl;
     private readonly retryAttempts?;
     private readonly backoffPolicy?;
@@ -73,6 +72,6 @@ export declare class CacheFactory<TAdapters extends string = string> implements
      * ```
      */
     constructor(settings: CacheFactorySettings<TAdapters>);
-    private initCaches;
+    private init;
     use<TType = unknown>(adapterName?: TAdapters | undefined): IGroupableCache<TType>;
 }

package/dist/types/event-bus/contracts/event-bus.errors.d.ts

@@ -1,8 +1,8 @@
 /**
  * @module EventBus
  */
-import type { ISerializable } from "../../serde/contracts/_module";
-import type { ISerializedError } from "../../utilities/_module";
+import type { IFlexibleSerde, ISerializable } from "../../serde/contracts/_module";
+import type { ISerializedError, OneOrMore } from "../../utilities/_module";
 /**
  * @group Errors
  */
@@ -38,3 +38,8 @@ export declare class UnableToAddListenerEventBusError extends UnexpectedEventBus
 export declare class UnableToDispatchEventBusError extends UnexpectedEventBusError {
     constructor(message: string, cause?: unknown);
 }
+/**
+ * The <i>registerEventBusErrors</i> function registers all <i>{@link IGroupableEventBus}</i> related errors with <i>IFlexibleSerde</i>, ensuring they will properly be serialized and deserialized.
+ * @group Errors
+ */
+export declare function registerEventBusErrors(serde: OneOrMore<IFlexibleSerde>): void;

package/dist/types/event-bus/implementations/derivables/event-bus/event-bus-settings.d.ts

@@ -3,23 +3,11 @@
  */
 import type { BackoffPolicy, RetryPolicy } from "../../../../async/_module";
 import { type IGroupableEventBus, type IEventBusAdapter } from "../../../../event-bus/contracts/_module";
-import type { IFlexibleSerde } from "../../../../serde/contracts/_module";
-import type { IBuildable, OneOrMore, TimeSpan } from "../../../../utilities/_module";
+import type { IBuildable, TimeSpan } from "../../../../utilities/_module";
 /**
  * @group Derivables
  */
 export type EventBusSettings = {
-    /**
-     * You can pass one or more <i>{@link IFlexibleSerde}</i> that will be used to register all <i>{@link IGroupableEventBus}</i> related errors.
-     * @default {true}
-     */
-    serde: OneOrMore<IFlexibleSerde>;
-    /**
-     * If set to true, all <i>{@link IGroupableEventBus}</i> related errors will be registered with the specified <i>IFlexibleSerde</i> during constructor initialization.
-     * This ensures that all <i>{@link IGroupableEventBus}</i> related errors will be serialized correctly.
-     * @default {true}
-     */
-    shouldRegisterErrors?: boolean;
     adapter: IEventBusAdapter;
     /**
      * The default retry attempt to use in the returned <i>LazyPromise</i>.
@@ -49,12 +37,6 @@ export type EventBusSettings = {
 export declare class EventBusSettingsBuilder<TSettings extends Partial<EventBusSettings>> implements IBuildable<EventBusSettings> {
     private readonly settings;
     constructor(settings?: TSettings);
-    setShouldRegisterErrors(shouldRegisterErrors: boolean): EventBusSettingsBuilder<TSettings & {
-        shouldRegisterErrors: boolean;
-    }>;
-    setSerde(serde: OneOrMore<IFlexibleSerde>): EventBusSettingsBuilder<TSettings & {
-        serde: OneOrMore<IFlexibleSerde>;
-    }>;
     setAdapter(adapter: IEventBusAdapter): EventBusSettingsBuilder<TSettings & {
         adapter: IEventBusAdapter;
     }>;

package/dist/types/event-bus/implementations/derivables/event-bus/event-bus.d.ts

@@ -3,7 +3,7 @@
  */
 import { LazyPromise } from "../../../../async/_module";
 import type { EventClass, EventInstance, Unsubscribe } from "../../../../event-bus/contracts/_module";
-import { type IEventBus, type IGroupableEventBus, type Listener, type BaseEvent, UnableToRemoveListenerEventBusError, UnableToAddListenerEventBusError, UnexpectedEventBusError, EventBusError } from "../../../../event-bus/contracts/_module";
+import { type IEventBus, type IGroupableEventBus, type Listener, type BaseEvent } from "../../../../event-bus/contracts/_module";
 import type { OneOrMore } from "../../../../utilities/_module";
 import type { EventBusSettings } from "../../../../event-bus/implementations/derivables/event-bus/event-bus-settings";
 import { EventBusSettingsBuilder } from "../../../../event-bus/implementations/derivables/event-bus/event-bus-settings";
@@ -12,38 +12,40 @@ import { EventBusSettingsBuilder } from "../../../../event-bus/implementations/d
  * @group Derivables
  */
 export declare class EventBus<TEvents extends BaseEvent = BaseEvent> implements IGroupableEventBus<TEvents> {
-    static readonly errors: {
-        readonly Error: typeof EventBusError;
-        readonly Unexpected: typeof UnexpectedEventBusError;
-        readonly RemoveListener: typeof UnableToRemoveListenerEventBusError;
-        readonly AddListener: typeof UnableToAddListenerEventBusError;
-    };
     /**
      * @example
      * ```ts
-     * import { EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
+     * import { EventBus, MemoryEventBusAdapter, registerEventErrors, SuperJsonSerde } from "@daiso-tech/core";
      *
-     * const cache = new EventBus(
+     * const eventBus = new EventBus(
      *   EventBus
      *     .settings()
      *     .setAdapter(new MemoryEventBusAdapter({ rootGroup: "@global" }))
      *     .build()
      * );
+     * const serde = new SuperJsonSerde();
+     * registerEventErrors(serde)
      * ```
      */
     static settings<TSettings extends Partial<EventBusSettings>>(): EventBusSettingsBuilder<TSettings>;
-    private readonly serde;
     private readonly adapter;
     private readonly retryAttempts;
     private readonly backoffPolicy;
     private readonly retryPolicy;
     private readonly timeout;
-    private readonly shouldRegisterErrors;
-    constructor(settings: EventBusSettings);
     /**
-     * Registers all event bus related error within the given <i>IFlexibleSerde</i> contract.
+     * @example
+     * ```ts
+     * import { EventBus, MemoryEventBusAdapter, registerEventErrors, SuperJsonSerde } from "@daiso-tech/core";
+     *
+     * const eventBus = new EventBus({
+     *   adapter: new MemoryEventBusAdapter({ rootGroup: "@global" })
+     * });
+     * const serde = new SuperJsonSerde();
+     * registerEventErrors(serde)
+     * ```
      */
-    private registerErrors;
+    constructor(settings: EventBusSettings);
     private createLayPromise;
     withGroup(group: OneOrMore<string>): IEventBus<TEvents>;
     getGroup(): string;

package/dist/types/event-bus/implementations/derivables/event-bus-factory/event-bus-factory.d.ts

@@ -1,7 +1,7 @@
 /**
  * @module EventBus
  */
-import type { IGroupableEventBus, IEventBusFactory, BaseEvent } from "../../../../event-bus/contracts/_module";
+import { type IGroupableEventBus, type IEventBusFactory, type BaseEvent } from "../../../../event-bus/contracts/_module";
 import { type EventBusFactorySettings, EventBusFactorySettingsBuilder } from "../../../../event-bus/implementations/derivables/event-bus-factory/event-bus-factory-settings";
 /**
  * @group Derivables
@@ -21,6 +21,7 @@ import { type EventBusFactorySettings, EventBusFactorySettingsBuilder } from "..
  *     }),
  *   },
  *   defaultAdapter: "memory",
+ *   serde: new SuperJsonSerde()
  * });
  * ```
  */
@@ -31,16 +32,18 @@ export declare class EventBusFactory<TAdapters extends string = string> implemen
      * import { EventBusFactory, SuperJsonSerde. MemoryEventBusAdapter, RedisPubSubEventBusAdapter, EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
      * import Redis from "ioredis";
      *
+     * const serde = new SuperJsonSerde();
      * const cacheFactory = new EventBusFactory(
      *   EventBusFactory
      *     .settings()
+     *     .setSerde(serde)
      *     .setAdapter("memory", new MemoryEventBusAdapter({
      *       rootGroup: "@global"
      *     }))
      *     .setAdapter("redis", new RedisPubSubEventBusAdapter({
      *       dispatcherClient: new Redis("YOUR_REDIS_CONNECTION"),
      *       listenerClient: new Redis("YOUR_REDIS_CONNECTION")
-     *       serde: new SuperJsonSerde(),
+     *       serde,
      *       rootGroup: "@global"
      *     }))
      *     .setDefaultAdapter("memory")
@@ -49,16 +52,38 @@ export declare class EventBusFactory<TAdapters extends string = string> implemen
      * ```
      */
     static settings<TAdapters extends string, TSettings extends EventBusFactorySettings<TAdapters>>(): EventBusFactorySettingsBuilder<TSettings>;
-    private readonly eventBuses;
+    private readonly eventBusRecord;
     private readonly serde;
-    private readonly adapters;
     private readonly defaultAdapter?;
     private readonly retryAttempts?;
     private readonly backoffPolicy?;
     private readonly retryPolicy?;
     private readonly timeout?;
     private readonly shouldRegisterErrors?;
+    /**
+     * @example
+     * ```ts
+     * import { EventBusFactory, SuperJsonSerde. MemoryEventBusAdapter, RedisPubSubEventBusAdapter, EventBus, MemoryEventBusAdapter } from "@daiso-tech/core";
+     * import Redis from "ioredis";
+     * const serde = new SuperJsonSerde();
+     * const cacheFactory = new EventBusFactory({
+     *   serde,
+     *   adapters: {
+     *     memory:new MemoryEventBusAdapter({
+     *       rootGroup: "@global"
+     *     }),
+     *     redis: new RedisPubSubEventBusAdapter({
+     *       dispatcherClient: new Redis("YOUR_REDIS_CONNECTION"),
+     *       listenerClient: new Redis("YOUR_REDIS_CONNECTION")
+     *       serde,
+     *       rootGroup: "@global"
+     *     }),
+     *     defaultAdapter: "memory"
+     *   }
+     * })
+     * ```
+     */
     constructor(settings: EventBusFactorySettings<TAdapters>);
-    private initCaches;
+    private init;
     use<TEvents extends BaseEvent = BaseEvent>(adapterName?: TAdapters | undefined): IGroupableEventBus<TEvents>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@daiso-tech/core",
     "private": false,
-    "version": "0.20.0",
+    "version": "0.21.0",
     "author": "Yousif Abdulkarim",
     "license": "Apache-2.0",
     "main": "./dist/cjs/_module.js",