comes 0.0.1

package/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2023, Rafael Cheruti
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,3 @@
+# comes - Communication Event System
+
+

package/build/index.d.ts

@@ -0,0 +1,95 @@
+/**
+ * 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;
+/**
+ * Type that holds the value for an event address.
+ */
+export type ES_ValueType = {
+    /**
+     * The last value emitted.
+     */
+    last: any;
+    /**
+     * Listeners of this event.
+     */
+    listeners: ((event: any) => void)[];
+    /**
+     * Last time an event was emitted.
+     *
+     * If this value is "null" or "undefined" so no event/value was emitted yet.
+     * In this case, the "last" field will be "null" or "undefined" also.
+     */
+    date?: Date;
+    /**
+     * Loader to run when the first listeners is registered and no event was
+     * emitted yet.
+     *
+     * If some event/value was emitted before the first listener registered, so
+     * this function will not be called.
+     *
+     * @param id The address name
+     * @param args Extra parameters to the function
+     * @returns
+     */
+    loader?: (id: string, ...args: any[]) => void;
+    loaderProm?: Promise<any>;
+};
+/**
+ * Class that creates the field through which communication will occur.
+ */
+export declare class EventSystem {
+    /**
+     * Each key is an event address and the value is an {@link ES_ValueType} that
+     * holds the last value for the address.
+     */
+    data: {
+        [id: string]: ES_ValueType;
+    };
+    /**
+     * Gets a reference to {@link ES_ValueType} of the address informed.
+     * @param id The address name
+     */
+    get(id: string): ES_ValueType;
+    /**
+     * Sends the value to the listeners of the event address.
+     * @param id The address name
+     * @param event The value to send to listeners
+     * @returns The value informed
+     */
+    emit<T>(id: string, event: T): T;
+    /**
+     * Register a listener for the address.
+     * The listener will receive the last value emitted.
+     * The listener can call {@link get} to get the {@link ES_ValueType} of the type in the start of the function.
+     *
+     * The listener will be called with the last value available in the cache.
+     *
+     * @param id The address name
+     * @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;
+    unlisten(id: string, listener: (event: any) => void): void;
+    /**
+     * Configure a loader to execute when the first listener is registered and no value exists yet.
+     *
+     * @param id The address name
+     * @param loader The function to execute when the first liteners is registered
+     *               and no value exists yet.
+     */
+    setLoader(id: string, loader: ES_ValueType['loader']): void;
+    /**
+     * Executes the loader for an address.
+     * @param id The address name
+     * @param args Arguments to pass to the loader
+     * @returns Promise that will resolve when the loader resolves
+     */
+    load<T>(id: string, ...args: any[]): Promise<() => T>;
+}
+/**
+ * This "es" is the default EventSystem created.
+ */
+export declare const es: EventSystem;

package/build/index.js

@@ -0,0 +1,113 @@
+"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.
+ * @param item Item that will be removed
+ * @param list Array where to find the item
+ */
+function deleteFromArray(item, list) {
+    for (let i = list.length; i > -1; i--) {
+        let it = list[i];
+        if (it === item) {
+            list.splice(i, 1);
+            break;
+        }
+    }
+}
+/**
+ * Class that creates the field through which communication will occur.
+ */
+class EventSystem {
+    constructor() {
+        /**
+         * Each key is an event address and the value is an {@link ES_ValueType} that
+         * holds the last value for the address.
+         */
+        this.data = {};
+    }
+    /**
+     * Gets a reference to {@link ES_ValueType} of the address informed.
+     * @param id The address name
+     */
+    get(id) {
+        if (!this.data[id])
+            this.data[id] = { last: null, listeners: [] };
+        return this.data[id];
+    }
+    /**
+     * Sends the value to the listeners of the event address.
+     * @param id The address name
+     * @param event The value to send to listeners
+     * @returns The value informed
+     */
+    emit(id, event) {
+        let esData = this.get(id);
+        esData.last = event;
+        esData.date = new Date();
+        for (let func of esData.listeners)
+            func(event);
+        return event;
+    }
+    /**
+     * Register a listener for the address.
+     * The listener will receive the last value emitted.
+     * The listener can call {@link get} to get the {@link ES_ValueType} of the type in the start of the function.
+     *
+     * The listener will be called with the last value available in the cache.
+     *
+     * @param id The address name
+     * @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, listener) {
+        let esData = this.get(id);
+        esData.listeners.push(listener);
+        if (esData.date)
+            listener(esData.last);
+        else if (esData.loader)
+            exports.es.load(id);
+        return () => this.unlisten(id, listener);
+    }
+    unlisten(id, listener) {
+        let esData = this.get(id);
+        deleteFromArray(listener, esData.listeners);
+    }
+    /**
+     * Configure a loader to execute when the first listener is registered and no value exists yet.
+     *
+     * @param id The address name
+     * @param loader The function to execute when the first liteners is registered
+     *               and no value exists yet.
+     */
+    setLoader(id, loader) {
+        let esData = this.get(id);
+        esData.loader = loader;
+        if (!esData.date && esData.listeners.length)
+            this.load(id);
+    }
+    /**
+     * Executes the loader for an address.
+     * @param id The address name
+     * @param args Arguments to pass to the loader
+     * @returns Promise that will resolve when the loader resolves
+     */
+    async load(id, ...args) {
+        let esData = this.get(id);
+        if (!esData.loader)
+            return esData.last;
+        esData.loaderProm = new Promise(async (res) => {
+            await esData.loader(id, ...args);
+            esData.loaderProm = undefined;
+            res(esData.last);
+        });
+        return esData.loaderProm;
+    }
+}
+exports.EventSystem = EventSystem;
+/**
+ * This "es" is the default EventSystem created.
+ */
+exports.es = new EventSystem();

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "comes",
+  "version": "0.0.1",
+  "description": "Simple Event System Communication",
+  "keywords": [
+    "event",
+    "event-system",
+    "communication"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/rcheruti/comes.git"
+  },
+  "homepage": "https://github.com/rcheruti/comes#readme",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "dev": "ts-node src/index.ts",
+    "build": "rimraf build && tsc",
+    "test": "vitest"
+  },
+  "author": "RCC",
+  "license": "ISC",
+  "devDependencies": {
+    "@vitest/coverage-v8": "2.1.3",
+    "rimraf": "^6.0.1",
+    "typescript": "5.6.3",
+    "vitest": "2.1.3"
+  }
+}