@daiso-tech/core 0.13.0 → 0.14.0

package/dist/types/event-bus/contracts/event-bus-factory.contract.d.ts

@@ -1,7 +1,6 @@
 /**
  * @module EventBus
  */
-import type { Validator } from "../../utilities/_module";
 import type { INamespacedEventBus } from "../../event-bus/contracts/event-bus.contract";
 import type { IBaseEvent } from "../../event-bus/contracts/_shared";
 /**
@@ -31,34 +30,11 @@ export type IEventBusFactory<TDrivers extends string = string, TEvents extends I
      * ```
      */
     use(driverName?: TDrivers): INamespacedEventBus<TEvents>;
-    /**
-     * The <i>withValidation</i> method is used to set a <i>validator</i>, which validates the event during runtime.
-     * The type is inferred from the provided <i>validator</i>.
-     * @example
-     * ```ts
-     * import { type IEventBusFactory, zodValidator } from "@daiso-tech/core";
-     * import { z } from "zod"
-     *
-     * async function main(eventBusFactory: IEventBusFactory): Promise<void> {
-     *   const addEventSchema = z.zod({
-     *     type: z.literal("add"),
-     *     a: z.number(),
-     *     b: z.number(),
-     *   });
-     *   await eventBusFactory
-     *     .withValidation(zodValidator(addEventSchema))
-     *     .use()
-     *     // You will se an typescript error and get runtime erorr
-     *     .dispatch({ type: "add" });
-     * }
-     * ```
-     */
-    withValidation<TOutput extends TEvents = TEvents>(validator: Validator<TOutput>): IEventBusFactory<TDrivers, TOutput>;
     /**
      * The <i>withTypes</i> method is used to set the event types of the <i>{@link IEventBus}</i>.
      * @example
      * ```ts
-     * import { type IEventBusFactory, zodValidator } from "@daiso-tech/core";
+     * import { type IEventBusFactory } from "@daiso-tech/core";
      *
      * async function main(eventBusFactory: IEventBusFactory): Promise<void> {
      *   type AddEvent = {

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

@@ -4,7 +4,23 @@
 import type { IBaseEvent, IEventBusAdapter, Listener } from "../../../../event-bus/contracts/_module";
 import { EventEmitter } from "node:events";
 /**
+ * To utilize the <i>MemoryEventBusAdapter</i>, you must create instance of it.
  * @group Adapters
+ * @example
+ * ```ts
+ * import { MemoryEventBusAdapter } from "@daiso-tech/core";
+ *
+ * const eventBusAdapter = new MemoryEventBusAdapter(client);
+ * ```
+ * You can also provide an <i>EVentEmitter</i>.
+ * @example
+ * ```ts
+ * import { MemoryCacheAdapter } from "@daiso-tech/core";
+ * import { EventEmitter } from "node:events";
+ *
+ * const eventEmitter = new EventEmitter();
+ * const eventBusAdapter = new MemoryCacheAdapter(eventEmitter);
+ * ```
  */
 export declare class MemoryEventBusAdapter implements IEventBusAdapter {
     private readonly eventEmiter;

package/dist/types/event-bus/implementations/adapters/redis-event-bus-adapter/redis-event-bus-adapter.d.ts

@@ -10,10 +10,25 @@ import type Redis from "ioredis";
 export type RedisEventBusAdapterSettings = {
     dispatcherClient: Redis;
     listenerClient: Redis;
-    serializer?: ISerializer<string>;
+    serializer: ISerializer<string>;
 };
 /**
+ * To utilize the <i>RedisEventBusAdapter</i>, you must install the <i>"ioredis"</i> package and supply a <i>{@link ISerializer | string serializer}</i>, such as <i>{@link SuperJsonSerializer}</i>.
  * @group Adapters
+ * @example
+ * ```ts
+ * import { RedisEventBusAdapter, SuperJsonSerializer } from "@daiso-tech/core";
+ * import Redis from "ioredis";
+ *
+ * const dispatcherClient = new Redis("YOUR_REDIS_CONNECTION_STRING");
+ * const listenerClient = new Redis("YOUR_REDIS_CONNECTION_STRING");
+ * const serializer = new SuperJsonSerializer();
+ * const eventBusAdapter = new RedisEventBusAdapter({
+ *   dispatcherClient,
+ *   listenerClient,
+ *   serializer,
+ * });
+ * ```
  */
 export declare class RedisEventBusAdapter implements IEventBusAdapter {
     private readonly serializer;

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

@@ -0,0 +1,23 @@
+/**
+ * @module EventBus
+ */
+import { LazyPromise } from "../../../utilities/_module";
+import type { SelectEvent, Unsubscribe } from "../../../event-bus/contracts/_module";
+import { type IEventBus, type INamespacedEventBus, type Listener, type IBaseEvent } from "../../../event-bus/contracts/_module";
+import type { OneOrMore } from "../../../_shared/types";
+/**
+ * The BaseEventBus class serves as an abstract base class that provides implementations for redundant methods.
+ * It simplifies implementing the {@link INamespacedEventBus} interface without using an {@link IEventBusAdapter}.
+ * @group Derivables
+ */
+export declare abstract class BaseEventBus<TEvents extends IBaseEvent> implements INamespacedEventBus<TEvents> {
+    abstract withNamespace(namespace: OneOrMore<string>): IEventBus<TEvents>;
+    abstract getNamespace(): string;
+    abstract addListener<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
+    addListenerMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
+    abstract removeListener<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
+    removeListenerMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
+    subscribe<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<Unsubscribe>;
+    subscribeMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<Unsubscribe>;
+    abstract dispatch(events: OneOrMore<TEvents>): LazyPromise<void>;
+}

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

@@ -1,7 +1,6 @@
 /**
  * @module EventBus
  */
-import type { Validator } from "../../../utilities/_module";
 import type { INamespacedEventBus, IEventBusAdapter, IBaseEvent, IEventBusFactory } from "../../../event-bus/contracts/_module";
 /**
  * @group Derivables
@@ -39,9 +38,7 @@ export declare class EventBusFactory<TAdapters extends string = string, TEvent e
     private readonly drivers;
     private readonly defaultDriver?;
     private readonly rootNamespace?;
-    private validator;
     constructor(settings: EventBusFactorySettings<TAdapters>);
     use(driverName?: TAdapters | undefined): INamespacedEventBus<TEvent>;
-    withValidation<TOutput extends IBaseEvent = IBaseEvent>(validator: Validator<TOutput>): IEventBusFactory<TAdapters, TOutput>;
     withType<TOutput extends IBaseEvent = IBaseEvent>(): IEventBusFactory<TAdapters, TOutput>;
 }

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

@@ -1,15 +1,15 @@
 /**
  * @module EventBus
  */
-import type { Validator } from "../../../utilities/_module";
 import { LazyPromise } from "../../../utilities/_module";
-import type { SelectEvent, Unsubscribe } from "../../../event-bus/contracts/_module";
+import type { SelectEvent } from "../../../event-bus/contracts/_module";
 import { type IEventBus, type INamespacedEventBus, type IEventBusAdapter, type Listener, type IBaseEvent } from "../../../event-bus/contracts/_module";
 import type { OneOrMore } from "../../../_shared/types";
+import { BaseEventBus } from "../../../event-bus/implementations/derivables/base-event-bus";
 /**
  * @group Derivables
  */
-export type EventBusSettings<TEvents extends IBaseEvent> = {
+export type EventBusSettings = {
     /**
      * You can prefix all keys with a given <i>namespace</i>.
      * This useful if you want to add multitenancy but still use the same database.
@@ -44,60 +44,18 @@ export type EventBusSettings<TEvents extends IBaseEvent> = {
      * ```
      */
     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 { EventBus, MemoryEventBusAdapter, zodValidator } from "@daiso-tech/core";
-     * import { z } from "zod";
-     *
-     * const addEventSchema = z.object({
-     *   type: z.literal("add"),
-     *   a: z.number(),
-     *   b: z.number(),
-     * });
-     *
-     * const subEventSchema = z.object({
-     *   type: z.literal("sub"),
-     *   c: z.number(),
-     *   d: z.number(),
-     * });
-     *
-     * const eventBus = new EventBus(new MemoryEventBusAdapter(), {
-     *   // Event type will be infered from validator
-     *   validator: zodValidator(addEventSchema.or(subEventSchema))
-     * });
-     *
-     * (async () => {
-     *   // An Typescript error will be seen and ValidationError will be thrown during runtime.
-     *   await eventBus.dispatch([
-     *     {
-     *       type: "none existing",
-     *       noneExistingField: 20
-     *     }
-     *   ]);
-     * })();
-     * ```
-     */
-    validator?: Validator<TEvents>;
 };
 /**
  * <i>EventBus</i> class can be derived from any <i>{@link IEventBusAdapter}</i>.
  * @group Derivables
  */
-export declare class EventBus<TEvents extends IBaseEvent = IBaseEvent> implements INamespacedEventBus<TEvents> {
+export declare class EventBus<TEvents extends IBaseEvent = IBaseEvent> extends BaseEventBus<TEvents> implements INamespacedEventBus<TEvents> {
     private readonly eventBusAdapter;
     private readonly namespace;
-    private readonly validator;
-    constructor(eventBusAdapter: IEventBusAdapter, settings?: EventBusSettings<TEvents>);
+    constructor(eventBusAdapter: IEventBusAdapter, settings?: EventBusSettings);
     withNamespace(namespace: OneOrMore<string>): IEventBus<TEvents>;
     getNamespace(): string;
     addListener<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
-    addListenerMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
     removeListener<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
-    removeListenerMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<void>;
-    subscribe<TEventType extends TEvents["type"]>(event: TEventType, listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<Unsubscribe>;
-    subscribeMany<TEventType extends TEvents["type"]>(events: TEventType[], listener: Listener<SelectEvent<TEvents, TEventType>>): LazyPromise<Unsubscribe>;
     dispatch(events: OneOrMore<TEvents>): LazyPromise<void>;
 }

package/package.json

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

package/dist/cjs/event-bus/implementations/derivables/with-validation-event-bus-adapter.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WithValidationEventBusAdapter = void 0;
-class WithValidationEventBusAdapter {
-    eventBusAdapter;
-    validator;
-    listenerMap = new Map();
-    constructor(eventBusAdapter, validator) {
-        this.eventBusAdapter = eventBusAdapter;
-        this.validator = validator;
-    }
-    async addListener(event, listener) {
-        let wrappedListener = this.listenerMap.get(listener);
-        if (wrappedListener === undefined) {
-            wrappedListener = async (event) => {
-                await listener(this.validator(event));
-            };
-            this.listenerMap.set(listener, wrappedListener);
-        }
-        await this.eventBusAdapter.addListener(event, wrappedListener);
-    }
-    async removeListener(event, listener) {
-        const wrappedListener = this.listenerMap.get(listener);
-        if (wrappedListener === undefined) {
-            return;
-        }
-        await this.eventBusAdapter.removeListener(event, wrappedListener);
-        this.listenerMap.delete(listener);
-    }
-    async dispatch(events) {
-        await this.eventBusAdapter.dispatch(events.map(this.validator));
-    }
-}
-exports.WithValidationEventBusAdapter = WithValidationEventBusAdapter;
-//# sourceMappingURL=with-validation-event-bus-adapter.js.map

package/dist/cjs/event-bus/implementations/derivables/with-validation-event-bus-adapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-validation-event-bus-adapter.js","sourceRoot":"","sources":["../../../../../src/event-bus/implementations/derivables/with-validation-event-bus-adapter.ts"],"names":[],"mappings":";;;AAcA,MAAa,6BAA6B;IAOjB;IACA;IAPJ,WAAW,GAAG,IAAI,GAAG,EAGnC,CAAC;IAEJ,YACqB,eAAiC,EACjC,SAAgC;QADhC,oBAAe,GAAf,eAAe,CAAkB;QACjC,cAAS,GAAT,SAAS,CAAuB;IAClD,CAAC;IAEJ,KAAK,CAAC,WAAW,CACb,KAAa,EACb,QAA8B;QAE9B,IAAI,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAChC,eAAe,GAAG,KAAK,EAAE,KAAiB,EAAE,EAAE;gBAC1C,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,cAAc,CAChB,KAAa,EACb,QAA8B;QAE9B,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QAClE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAoB;QAC/B,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE,CAAC;CACJ;AA1CD,sEA0CC"}

package/dist/esm/event-bus/implementations/derivables/with-validation-event-bus-adapter.js

@@ -1,31 +0,0 @@
-export class WithValidationEventBusAdapter {
-    eventBusAdapter;
-    validator;
-    listenerMap = new Map();
-    constructor(eventBusAdapter, validator) {
-        this.eventBusAdapter = eventBusAdapter;
-        this.validator = validator;
-    }
-    async addListener(event, listener) {
-        let wrappedListener = this.listenerMap.get(listener);
-        if (wrappedListener === undefined) {
-            wrappedListener = async (event) => {
-                await listener(this.validator(event));
-            };
-            this.listenerMap.set(listener, wrappedListener);
-        }
-        await this.eventBusAdapter.addListener(event, wrappedListener);
-    }
-    async removeListener(event, listener) {
-        const wrappedListener = this.listenerMap.get(listener);
-        if (wrappedListener === undefined) {
-            return;
-        }
-        await this.eventBusAdapter.removeListener(event, wrappedListener);
-        this.listenerMap.delete(listener);
-    }
-    async dispatch(events) {
-        await this.eventBusAdapter.dispatch(events.map(this.validator));
-    }
-}
-//# sourceMappingURL=with-validation-event-bus-adapter.js.map

package/dist/esm/event-bus/implementations/derivables/with-validation-event-bus-adapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-validation-event-bus-adapter.js","sourceRoot":"","sources":["../../../../../src/event-bus/implementations/derivables/with-validation-event-bus-adapter.ts"],"names":[],"mappings":"AAcA,MAAM,OAAO,6BAA6B;IAOjB;IACA;IAPJ,WAAW,GAAG,IAAI,GAAG,EAGnC,CAAC;IAEJ,YACqB,eAAiC,EACjC,SAAgC;QADhC,oBAAe,GAAf,eAAe,CAAkB;QACjC,cAAS,GAAT,SAAS,CAAuB;IAClD,CAAC;IAEJ,KAAK,CAAC,WAAW,CACb,KAAa,EACb,QAA8B;QAE9B,IAAI,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAChC,eAAe,GAAG,KAAK,EAAE,KAAiB,EAAE,EAAE;gBAC1C,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,cAAc,CAChB,KAAa,EACb,QAA8B;QAE9B,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QAClE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAoB;QAC/B,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE,CAAC;CACJ"}

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

@@ -1,17 +0,0 @@
-/**
- * @module EventBus
- */
-import type { Validator } from "../../../utilities/_module";
-import type { IBaseEvent, IEventBusAdapter, Listener } from "../../../event-bus/contracts/_module";
-/**
- * @internal
- */
-export declare class WithValidationEventBusAdapter implements IEventBusAdapter {
-    private readonly eventBusAdapter;
-    private readonly validator;
-    private readonly listenerMap;
-    constructor(eventBusAdapter: IEventBusAdapter, validator: Validator<IBaseEvent>);
-    addListener(event: string, listener: Listener<IBaseEvent>): Promise<void>;
-    removeListener(event: string, listener: Listener<IBaseEvent>): Promise<void>;
-    dispatch(events: IBaseEvent[]): Promise<void>;
-}