comes 0.0.2 → 0.0.3

package/build/index.d.ts

@@ -1,9 +1,5 @@
-/**
- * Function to exclude an item from the array.
- * @param item Item that will be removed
- * @param list Array where to find the item
- */
-export declare function deleteFromArray(item: any, list: any[]): void;
+export type EventListenerType<T = any> = (event: T) => void;
+export type EventInterceptorType<T = any> = (id: string, event: T, es: EventSystem) => T;
 /**
  * Type that holds the value for an event address.
  */
@@ -15,7 +11,7 @@ export type ES_ValueType = {
     /**
      * Listeners of this event.
      */
-    listeners: ((event: any) => void)[];
+    listeners: EventListenerType[];
     /**
      * Last time an event was emitted.
      *
@@ -72,6 +68,19 @@ export declare class EventSystem {
     data: {
         [id: string]: ES_ValueType;
     };
+    /**
+     * Interceptors to transform data.
+     * Interceptors are called in the installation order.
+     * The special empty string event address will be called for all events sent.
+     *
+     * The interceptors exists to transform, monitor, prepare or validate (or many other uses)
+     * the event sent to an address. The sequence of interceptors will be called like a
+     * "chain of responsibility" pattern, if any exception is thrown the following interceptors
+     * will not be executed, and the listeners not called.
+     */
+    inters: {
+        [id: string]: EventInterceptorType[];
+    };
     /**
      * Gets a reference to {@link ES_ValueType} of the address informed.
      * @param id The address name of the event
@@ -81,9 +90,8 @@ export declare class EventSystem {
      * Sends the value to the listeners of the event address.
      * @param id The address name of the event
      * @param event The value to send to listeners
-     * @returns The value informed
      */
-    emit<T>(id: string, event: T): T;
+    send<T>(id: string, event: T): Promise<T>;
     /**
      * Register a listener for the address.
      * The listener will receive the last value emitted.
@@ -95,7 +103,7 @@ export declare class EventSystem {
      * @param listener The listener, will be called every time a new value is emitted to this address
      * @returns An unregister function. Use this function to remove the listener
      */
-    listen(id: string, listener: (event: any) => void): () => void;
+    listen(id: string, listener: EventListenerType): () => void;
     /**
      * Remove the listener from the list of this event address.
      *
@@ -115,7 +123,33 @@ export declare class EventSystem {
      * @param id The address name of the event
      * @param listener Listener to remove
      */
-    unlisten(id: string, listener: (event: any) => void): void;
+    unlisten(id: string, listener: EventListenerType): void;
+    /**
+     * Add an interceptor to transform data.
+     * Interceptors are called in the installation order.
+     * The special empty string event address will be called for all events sent.
+     *
+     * The interceptors exists to transform, monitor, prepare or validate (or many other uses)
+     * the event sent to an address. The sequence of interceptors will be called like a
+     * "chain of responsibility" pattern, if any exception is thrown the following interceptors
+     * will not be executed, and the listeners not called.
+     *
+     * Interceptors will be executed synchronous in the call of the {@link send} method.
+     * So any exception thrown will be thrown also in the {@link send} call.
+     *
+     * @param id The address name of the event
+     * @param listener Interceptor to add
+     * @returns An unregister function. Use this function to remove the interceptor
+     */
+    addInter(id: string, listener: EventInterceptorType): () => void;
+    /**
+     * Remove an interceptor.
+     *
+     * @param id The address name of the event
+     * @param listener Interceptor to add
+     * @returns An unregister function. Use this function to remove the interceptor
+     */
+    removeInter(id: string, listener: EventInterceptorType): void;
     /**
      * Configure a {@link ES_ValueType.loader loader} to execute when the first listener is registered and no value exists yet.
      *

package/build/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.es = exports.EventSystem = void 0;
-exports.deleteFromArray = deleteFromArray;
 // -------
 /**
  * Function to exclude an item from the array.
@@ -27,6 +26,17 @@ class EventSystem {
          * holds the last value for the address.
          */
         this.data = {};
+        /**
+         * Interceptors to transform data.
+         * Interceptors are called in the installation order.
+         * The special empty string event address will be called for all events sent.
+         *
+         * The interceptors exists to transform, monitor, prepare or validate (or many other uses)
+         * the event sent to an address. The sequence of interceptors will be called like a
+         * "chain of responsibility" pattern, if any exception is thrown the following interceptors
+         * will not be executed, and the listeners not called.
+         */
+        this.inters = {};
     }
     /**
      * Gets a reference to {@link ES_ValueType} of the address informed.
@@ -41,15 +51,32 @@ class EventSystem {
      * Sends the value to the listeners of the event address.
      * @param id The address name of the event
      * @param event The value to send to listeners
-     * @returns The value informed
      */
-    emit(id, event) {
+    async send(id, event) {
+        let inters = [...(this.inters[''] || []), ...(this.inters[id] || [])];
+        let newValue = event;
+        try {
+            for (let inte of inters) {
+                newValue = await inte(id, newValue, this);
+            }
+        }
+        catch (err) {
+            console.error(`error on interceptor of ${id}`, err);
+            throw err;
+        }
         let esData = this.get(id);
-        esData.last = event;
+        esData.last = newValue;
         esData.date = new Date();
-        for (let func of esData.listeners)
-            func(event);
-        return event;
+        for (let func of esData.listeners) {
+            try {
+                await func(newValue);
+            }
+            catch (err) {
+                console.error(`Error on listener of ${id}, ${func}`, err);
+                throw err;
+            }
+        }
+        return newValue;
     }
     /**
      * Register a listener for the address.
@@ -94,6 +121,39 @@ class EventSystem {
         let esData = this.get(id);
         deleteFromArray(listener, esData.listeners);
     }
+    /**
+     * Add an interceptor to transform data.
+     * Interceptors are called in the installation order.
+     * The special empty string event address will be called for all events sent.
+     *
+     * The interceptors exists to transform, monitor, prepare or validate (or many other uses)
+     * the event sent to an address. The sequence of interceptors will be called like a
+     * "chain of responsibility" pattern, if any exception is thrown the following interceptors
+     * will not be executed, and the listeners not called.
+     *
+     * Interceptors will be executed synchronous in the call of the {@link send} method.
+     * So any exception thrown will be thrown also in the {@link send} call.
+     *
+     * @param id The address name of the event
+     * @param listener Interceptor to add
+     * @returns An unregister function. Use this function to remove the interceptor
+     */
+    addInter(id, listener) {
+        if (!this.inters[id])
+            this.inters[id] = [];
+        this.inters[id].push(listener);
+        return () => this.removeInter(id, listener);
+    }
+    /**
+     * Remove an interceptor.
+     *
+     * @param id The address name of the event
+     * @param listener Interceptor to add
+     * @returns An unregister function. Use this function to remove the interceptor
+     */
+    removeInter(id, listener) {
+        deleteFromArray(listener, this.inters[id]);
+    }
     /**
      * Configure a {@link ES_ValueType.loader loader} to execute when the first listener is registered and no value exists yet.
      *
@@ -149,7 +209,7 @@ class EventSystem {
                     try {
                         const catchRes = await esData.loaderCatch(id, ex);
                         if (catchRes !== undefined) {
-                            this.emit(id, catchRes);
+                            this.send(id, catchRes);
                             res(catchRes);
                         }
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comes",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Simple Event System Communication",
   "keywords": [
     "event",