@alwatr/signal 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.6.0](https://github.com/AliMD/alwatr/compare/v0.5.0...v0.6.0) (2022-03-11)
+
+
+### Bug Fixes
+
+* alalwatr ([898aa6e](https://github.com/AliMD/alwatr/commit/898aa6ed0888eab9265c83b96a50f1b8c216d143))
+* **packages:** duplicate alwatr keyword ([77d4aa2](https://github.com/AliMD/alwatr/commit/77d4aa2105ad47515c3eee251fd6b8c281d0d1fc))
+
+
+
+
+
+# [0.5.0](https://github.com/AliMD/alwatr/compare/v0.4.0...v0.5.0) (2022-03-11)
+
+
+### Bug Fixes
+
+* **signal:** disabled getter and optional dispatch options ([28ced3d](https://github.com/AliMD/alwatr/commit/28ced3d0c4cdf44fc2aebfab98db0883fc5363fe))
+
+
+### Features
+
+* **signal:** new SignalInterface ([221701a](https://github.com/AliMD/alwatr/commit/221701a54ea9edda4a3a935a7b098e235ec52691))
+
+
+
+
+
+# [0.4.0](https://github.com/AliMD/alwatr/compare/v0.3.0...v0.4.0) (2022-03-11)
+
+**Note:** Version bump only for package @alwatr/signal
+
+
+
+
+
+# [0.3.0](https://github.com/AliMD/alwatr/compare/v0.2.1...v0.3.0) (2022-03-06)
+
+
+### Bug Fixes
+
+* **signal:** signal provider type ([0151c57](https://github.com/AliMD/alwatr/commit/0151c57d9b6d4f7e83bb9b1847ebe0ae53cd8f89))
+
+
+
+
+
+## [0.2.1](https://github.com/AliMD/alwatr/compare/v0.2.0...v0.2.1) (2022-03-05)
+
+
+### Bug Fixes
+
+* **signal:** signal value type issue ([292a4a7](https://github.com/AliMD/alwatr/commit/292a4a7d12a2fd143761e67cd1ecd2e5e40f2ee9))
+
+
+
+
+
+# [0.2.0](https://github.com/AliMD/alwatr/compare/v0.1.2...v0.2.0) (2022-03-05)
+
+
+### Bug Fixes
+
+* **router:** rename setSignalProvider callback detail to requestParam ([6e09f87](https://github.com/AliMD/alwatr/commit/6e09f8772d320625fb4c15ccaa0abcfa2932f992))
+* **signal:** fix dispatchSignal value parameters ([4d34cfb](https://github.com/AliMD/alwatr/commit/4d34cfbb5281d5ce4a4f06ddaaf72218dde80cdd))
+
+
+### Features
+
+* **signal:** add contributors ([64287cd](https://github.com/AliMD/alwatr/commit/64287cd8cea95665a6ed298177df60dadda7642b))
+* **signal:** improve signal provider by dispatch return content ([80c2b27](https://github.com/AliMD/alwatr/commit/80c2b275bcc0521327400c5902f512c778f5eb3f))
+
+
+
+
+
+## [0.1.2](https://github.com/AliMD/alwatr/compare/v0.1.1...v0.1.2) (2022-03-03)
+
+**Note:** Version bump only for package @alwatr/signal
+
+
+
+
+
+## [0.1.1](https://github.com/AliMD/alwatr/compare/v0.1.0...v0.1.1) (2022-03-03)
+
+### Bug Fixes
+
+* **packages:** add publish config to public ([9cb3710](https://github.com/AliMD/alwatr/commit/9cb37106b5a35d24d5195ff54232e5769ccc034e))
+
+# 0.1.0 (2022-03-02)
+
+### Bug Fixes
+
+* **signal:** AlwatrRequestSignals global type ([228e333](https://github.com/AliMD/alwatr/commit/228e3333326b23df51e7834872daf1349826bf09))
+
+### Features
+
+* **signal:** addSignalListener ([e7c5742](https://github.com/AliMD/alwatr/commit/e7c57427ef11e2624eb9a52a166720b1a3c5f66a))
+* **signal:** getSignalObject ([b38954c](https://github.com/AliMD/alwatr/commit/b38954cf4ae1c24eaaa79ecf513995a4678814ee))
+* **signal:** impeliment addSignalProvider, waitForSignal, hasSignalDispatchedBefore, expireSignal ([e0b4d78](https://github.com/AliMD/alwatr/commit/e0b4d7831764d4454591f5105c5512e1657a63e5))
+* **signal:** impeliment dispatchSignal ([cb2dfbe](https://github.com/AliMD/alwatr/commit/cb2dfbe23ea751cba93cb1f6516cd2bfa2ecb18e))
+* **signal:** ListenerObject, SignalObject types ([36d8a33](https://github.com/AliMD/alwatr/commit/36d8a336760bba3808cfd26a28e4d24a31c95f8f))
+* **signal:** make new package for manage signals ([5bf82b3](https://github.com/AliMD/alwatr/commit/5bf82b3f05abc89102634e9b864d81b5b5af527e))
+* **signal:** register to alwatr meta ([9c850e8](https://github.com/AliMD/alwatr/commit/9c850e8df787aa44d289929dc65439e921982dce))
+* **signal:** removeSignalListener ([0088a52](https://github.com/AliMD/alwatr/commit/0088a5269ccce8b50a50e444695c81654fda70ff))
+* **signal:** requestSignal ([111ab5a](https://github.com/AliMD/alwatr/commit/111ab5a1436bc380f5121ef8c130da7010258d90))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,213 @@
+# @alwatr/signal
+
+Elegant powerful event system for handle global signals and states written in tiny TypeScript module.
+
+Every signal has own value and can be used as a advance **state management** like redux and recoil without the complexities and unnecessary facilities of those libraries.
+
+## Example usage
+
+### Add your signal name to global `AlwatrSignals` type helper
+
+```ts
+declare global {
+  /**
+   * Global signals value type registry.
+   */
+  interface AlwatrSignals {
+    readonly 'content-change': Record<string, number>;
+  }
+
+  /**
+   * Global request signal parameters types.
+   */
+   interface AlwatrRequestSignals {
+    readonly 'content-change': number;
+  }
+}
+```
+
+### Dispatch signal with value
+
+```ts
+import {SignalInterface} from 'https://esm.run/@alwatr/signal';
+
+const contentChangeSignal1 = new SignalInterface('content-change');
+
+contentChangeSignal1.dispatch({a:1, b:2});
+
+contentChangeSignal1.dispatch({a:2, b:3});
+
+// Multiple dispatch debounced and last value dispatched after an animate frame.
+contentChangeSignal1.dispatch({a:3, b:4});
+```
+
+### Receive the signal value
+
+```ts
+import {SignalInterface} from 'https://esm.run/@alwatr/signal';
+
+const contentChangeSignal2 = new SignalInterface('content-change'); // Same share signal as contentChangeSignal1
+
+contentChangeSignal2.addListener((content) => {
+  console.log(content); // {a:3, b:4}
+});
+```
+
+## API
+
+### Prepare
+
+#### `new SignalInterface(signal-name)`
+
+```ts
+import {SignalInterface} from 'https://esm.run/@alwatr/signal';
+
+const contentChangeSignal = new SignalInterface('content-change');
+```
+
+### `name`
+
+Get signal name.
+
+Example:
+
+```ts
+console.log(contentChangeSignal.name); // 'content-change'
+```
+
+### `value`
+
+Get last dispatched signal value or undefined.
+
+Example:
+
+```ts
+if (contentChangeSignal.dispatched) {
+  const content = contentChangeSignal.value!;
+  ...
+}
+```
+
+### `dispatched`
+
+Check signal dispatched before or not!
+
+Example
+
+```ts
+if(contentChangeSignal.dispatched) {
+  // contentChangeSignal.value exist.
+}
+```
+
+### `disabled`
+
+Disable signal, all dispatch's ignored (just value updated) and no more listeners will be called.
+
+Example:
+
+```ts
+contentChangeSignal.disabled = true;
+```
+
+### `expire()`
+
+Expire the signal by clear last dispatched value.
+
+dispatched and receivePrevious etc not work until new signal.
+
+Example:
+
+```ts
+contentChangeSignal.dispatched; // true
+contentChangeSignal.expire();
+contentChangeSignal.value; // undefined
+contentChangeSignal.dispatched; // false
+```
+
+### `setProvider(provider)`
+
+Define signal provider, which will be called when signal requested (addRequestSignalListener).
+
+Example:
+
+```ts
+contentChangeSignal.setProvider(async (requestParam) => {
+  const content = await fetchNewContent(requestParam);
+  if (content != null) {
+    return content; // Dispatch signal 'content-change' with content.
+  }
+  else {
+    // dispatch new signal: 'content-not-found'
+  }
+});
+```
+
+### `request(requestParam)`
+
+Dispatch request signal and wait for answer (wait for new signal dispatched).
+
+Resolved with signal value when new signal received (getNextSignalValue).
+
+Example:
+
+```ts
+// dispatch request signal and wait for answer (wait for NEW signal).
+const newContent = await contentChangeSignal.request({foo: 'bar'});
+```
+
+### `getNextSignalValue()`
+
+Resolved with signal value when new signal received.
+
+Example:
+
+```ts
+// Wait for NEW signal received.
+const newContent = await contentChangeSignal.getNextSignalValue();
+```
+
+### `getSignalValue()`
+
+Resolved with signal value when signal is ready.
+
+Get signal value from last dispatched signal (if any) or wait for new signal received.
+
+Example:
+
+```ts
+// get signal value from last dispatched signal (if any) or wait new signal received.
+const content = await contentChangeSignal.getSignalValue();
+```
+
+### `dispatch(signalValue)`
+
+Dispatch signal to all listeners.
+
+Example:
+
+```ts
+contentChangeSignal.dispatch(content);
+```
+
+### `addListener(listener)`
+
+Add new listener to the signal.
+
+Example:
+
+```ts
+const listener = contentChangeSignal.addListener((content) => console.log(content));
+```
+
+### `removeListener(listener)`
+
+Remove listener from specific signal.
+
+Example:
+
+```ts
+const listenerId = contentChangeSignal.addListener((content) => console.log(content));
+...
+contentChangeSignal.removeListener(listenerId);
+```

package/core.d.ts

@@ -0,0 +1,53 @@
+import type { DispatchOptions, ListenerCallback, ListenerOptions, SignalObject, SignalProvider, SignalProviderOptions } from './type';
+export declare const logger: import("logger/type").Logger;
+/**
+ * Access to signal option, Make new signal with default options if not exist.
+ */
+export declare function __getSignalObject<SignalName extends keyof AlwatrSignals>(signalName: SignalName): SignalObject<SignalName>;
+/**
+ * Add new listener to specific signal.
+ *
+ * Example:
+ *
+ * ```ts
+ * const listener = addSignalListener('content-change', (content) => console.log(content));
+ * ```
+ */
+export declare function _addSignalListener<SignalName extends keyof AlwatrSignals>(signalName: SignalName, signalCallback: ListenerCallback<SignalName>, options?: ListenerOptions): symbol;
+/**
+ * Remove listener from specific signal.
+ *
+ * Example:
+ *
+ * ```ts
+ * const listener = addSignalListener('content-change', ...);
+ * removeSignalListener('content-change', listener);
+ * ```
+ */
+export declare function _removeSignalListener<SignalName extends keyof AlwatrSignals>(signalName: SignalName, listenerId: symbol): void;
+/**
+ * Dispatch signal to all listeners.
+ *
+ * @example
+ * dispatchSignal('content-change', content);
+ */
+export declare function _dispatchSignal<SignalName extends keyof AlwatrSignals>(signalName: SignalName, value: AlwatrSignals[SignalName], options?: DispatchOptions): void;
+/**
+ * Define signal provider, which will be called when signal requested (addRequestSignalListener).
+ *
+ * Example:
+ *
+ * ```ts
+ * setSignalProvider('content-change', async (requestParam) => {
+ *   const content = await fetchNewContent(requestParam);
+ *   if (content != null) {
+ *     return content; // dispatchSignal('content-change', content);
+ *   }
+ *   else {
+ *     dispatchSignal('content-not-found');
+ *   }
+ * }
+ * ```
+ */
+export declare function _setSignalProvider<SignalName extends keyof AlwatrRequestSignals>(signalName: SignalName, signalProvider: SignalProvider<SignalName>, options?: SignalProviderOptions): symbol;
+//# sourceMappingURL=core.d.ts.map

package/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAEhB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,qBAAqB,EAEtB,MAAM,QAAQ,CAAC;AAEhB,eAAO,MAAM,MAAM,8BAAgC,CAAC;AAYpD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,SAAS,MAAM,aAAa,EACpE,UAAU,EAAE,UAAU,GACvB,YAAY,CAAC,UAAU,CAAC,CAU1B;AA0BD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,SAAS,MAAM,aAAa,EACrE,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,gBAAgB,CAAC,UAAU,CAAC,EAC5C,OAAO,CAAC,EAAE,eAAe,GAC1B,MAAM,CA8CR;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,SAAS,MAAM,aAAa,EACxE,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,MAAM,GACnB,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,UAAU,SAAS,MAAM,aAAa,EAClE,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,EAChC,OAAO,CAAC,EAAE,eAAe,GAC1B,IAAI,CAqBN;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,SAAS,MAAM,oBAAoB,EAC5E,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,CAAC,UAAU,CAAC,EAC1C,OAAO,CAAC,EAAE,qBAAqB,GAChC,MAAM,CAuBR"}

package/core.js

@@ -0,0 +1,180 @@
+import { createLogger, alwatrRegisteredList } from '@alwatr/logger';
+export const logger = createLogger('alwatr/signal');
+alwatrRegisteredList.push({
+    name: '@alwatr/signal',
+    version: '{{ALWATR_VERSION}}',
+});
+/**
+ * Signal stack database.
+ */
+const _signalStack = {};
+/**
+ * Access to signal option, Make new signal with default options if not exist.
+ */
+export function __getSignalObject(signalName) {
+    if (!_signalStack[signalName]) {
+        _signalStack[signalName] = {
+            name: signalName,
+            disabled: false,
+            debounced: false,
+            listenerList: [],
+        };
+    }
+    return _signalStack[signalName];
+}
+function __callListeners(signal) {
+    logger.logMethodArgs('_callListeners', { signalName: signal.name, signalValue: signal.value });
+    if (signal.value === undefined) {
+        logger.accident('_callListeners', 'no_signal_value', 'signal must have a value', { signalName: signal.name });
+        return;
+    }
+    for (const listener of signal.listenerList) {
+        if (listener.disabled)
+            continue;
+        try {
+            const ret = listener.callback(signal.value);
+            if (ret instanceof Promise) {
+                ret.catch((err) => logger.error('_callListeners', 'call_listener_failed', err.stack || err, { signalName: signal.name }));
+            }
+        }
+        catch (err) {
+            logger.error('_callListeners', 'call_listener_failed', err.stack || err, { signalName: signal.name });
+        }
+        if (listener.once)
+            _removeSignalListener(signal.name, listener.id);
+    }
+}
+/**
+ * Add new listener to specific signal.
+ *
+ * Example:
+ *
+ * ```ts
+ * const listener = addSignalListener('content-change', (content) => console.log(content));
+ * ```
+ */
+export function _addSignalListener(signalName, signalCallback, options) {
+    var _a, _b;
+    logger.logMethodArgs('addSignalListener', { signalName, options });
+    const signal = __getSignalObject(signalName);
+    const listener = {
+        id: Symbol('Alwatr signal listener for ' + signalName),
+        once: (_a = options === null || options === void 0 ? void 0 : options.once) !== null && _a !== void 0 ? _a : false,
+        disabled: (_b = options === null || options === void 0 ? void 0 : options.disabled) !== null && _b !== void 0 ? _b : false,
+        callback: signalCallback,
+    };
+    let callbackCalled = false;
+    // Run callback for old dispatch signal
+    if (signal.value !== undefined) {
+        if ((options === null || options === void 0 ? void 0 : options.receivePrevious) === 'Immediate') {
+            logger.incident('addSignalListener', 'call_signal_callback', 'run callback with previous signal value!', { signalName, mode: 'Immediate' });
+            try {
+                signalCallback(signal.value);
+            }
+            catch (err) {
+                logger.error('addSignalListener', 'call_signal_callback_failed', err.stack || err, { signalName });
+            }
+            callbackCalled = true;
+        }
+        else if ((options === null || options === void 0 ? void 0 : options.receivePrevious) === true) {
+            requestAnimationFrame(() => {
+                if (signal.value !== undefined) {
+                    logger.incident('addSignalListener', 'call_signal_callback', 'run callback with previous signal value!', { signalName, mode: 'Delay' });
+                    signalCallback(signal.value);
+                }
+            });
+            callbackCalled = true; // must be outside of requestAnimationFrame.
+        }
+    }
+    // if once then must remove listener after fist callback called! then why push it to listenerList?!
+    if (!((options === null || options === void 0 ? void 0 : options.once) && callbackCalled)) {
+        if (options === null || options === void 0 ? void 0 : options.priority) {
+            signal.listenerList.unshift(listener);
+        }
+        else {
+            signal.listenerList.push(listener);
+        }
+    }
+    return listener.id;
+}
+/**
+ * Remove listener from specific signal.
+ *
+ * Example:
+ *
+ * ```ts
+ * const listener = addSignalListener('content-change', ...);
+ * removeSignalListener('content-change', listener);
+ * ```
+ */
+export function _removeSignalListener(signalName, listenerId) {
+    logger.logMethodArgs('_removeSignalListener', signalName);
+    const signal = __getSignalObject(signalName);
+    const listenerIndex = signal.listenerList.findIndex((_listener) => _listener.id === listenerId);
+    if (listenerIndex !== -1) {
+        signal.listenerList.splice(listenerIndex, 1);
+    }
+}
+/**
+ * Dispatch signal to all listeners.
+ *
+ * @example
+ * dispatchSignal('content-change', content);
+ */
+export function _dispatchSignal(signalName, value, options) {
+    logger.logMethodArgs('dispatchSignal', { signalName, value, options });
+    const signal = __getSignalObject(signalName);
+    // set value before check signal.debounced for act like throttle (call listeners with last dispatch value).
+    signal.value = value;
+    if (signal.disabled)
+        return; // signal is disabled.
+    if ((options === null || options === void 0 ? void 0 : options.debounce) && signal.debounced)
+        return; // last dispatch in progress.
+    if (!(options === null || options === void 0 ? void 0 : options.debounce)) {
+        // call listeners immediately.
+        __callListeners(signal);
+        return;
+    }
+    // else: call listeners in next frame.
+    signal.debounced = true;
+    requestAnimationFrame(() => {
+        __callListeners(signal);
+        signal.debounced = false;
+    });
+}
+/**
+ * Define signal provider, which will be called when signal requested (addRequestSignalListener).
+ *
+ * Example:
+ *
+ * ```ts
+ * setSignalProvider('content-change', async (requestParam) => {
+ *   const content = await fetchNewContent(requestParam);
+ *   if (content != null) {
+ *     return content; // dispatchSignal('content-change', content);
+ *   }
+ *   else {
+ *     dispatchSignal('content-not-found');
+ *   }
+ * }
+ * ```
+ */
+export function _setSignalProvider(signalName, signalProvider, options) {
+    var _a;
+    logger.logMethodArgs('setSignalProvider', { signalName, options });
+    // @TODO: refactor with removeSignalProvider
+    const signal = __getSignalObject(`request-${signalName}`);
+    if (signal.listenerList.length > 0) {
+        logger.accident('setSignalProvider', 'signal_provider_already_set', 'another provider defined and will removed', { signalName });
+        signal.listenerList = [];
+    }
+    const _callback = async (requestParam) => {
+        var _a;
+        const signalValue = await signalProvider(requestParam);
+        if (signalValue !== undefined) { // null can be a valid value.
+            _dispatchSignal(signalName, signalValue, { debounce: (_a = options === null || options === void 0 ? void 0 : options.debounce) !== null && _a !== void 0 ? _a : true });
+        }
+    };
+    return _addSignalListener(`request-${signalName}`, _callback, { receivePrevious: (_a = options === null || options === void 0 ? void 0 : options.receivePrevious) !== null && _a !== void 0 ? _a : true });
+}
+//# sourceMappingURL=core.js.map

package/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,oBAAoB,EAAC,MAAM,gBAAgB,CAAC;AAYlE,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;AAEpD,oBAAoB,CAAC,IAAI,CAAC;IACxB,IAAI,EAAE,gBAAgB;IACtB,OAAO,EAAE,oBAAoB;CAC9B,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,YAAY,GAAgB,EAAE,CAAC;AAErC;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC7B,UAAsB;IAExB,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;QAC7B,YAAY,CAAC,UAAU,CAAC,GAAG;YACzB,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,KAAK;YACf,SAAS,EAAE,KAAK;YAChB,YAAY,EAAE,EAAE;SACjB,CAAC;KACH;IACD,OAAO,YAAY,CAAC,UAAU,CAAwC,CAAC;AACzE,CAAC;AAED,SAAS,eAAe,CACpB,MAAgC;IAElC,MAAM,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAC,UAAU,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,KAAK,EAAC,CAAC,CAAC;IAC7F,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;QAC9B,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,EAAC,UAAU,EAAE,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC;QAC5G,OAAO;KACR;IACD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,YAAY,EAAE;QAC1C,IAAI,QAAQ,CAAC,QAAQ;YAAE,SAAS;QAChC,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5C,IAAI,GAAG,YAAY,OAAO,EAAE;gBAC1B,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAChB,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,sBAAsB,EAAG,GAAa,CAAC,KAAK,IAAI,GAAG,EAC9E,EAAC,UAAU,EAAE,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC;aACnC;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,sBAAsB,EAAG,GAAa,CAAC,KAAK,IAAI,GAAG,EAAE,EAAC,UAAU,EAAE,MAAM,CAAC,IAAI,EAAC,CAAC,CAAC;SAChH;QACD,IAAI,QAAQ,CAAC,IAAI;YAAE,qBAAqB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;KACpE;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAC9B,UAAsB,EACtB,cAA4C,EAC5C,OAAyB;;IAE3B,MAAM,CAAC,aAAa,CAAC,mBAAmB,EAAE,EAAC,UAAU,EAAE,OAAO,EAAC,CAAC,CAAC;IAEjE,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAA+B;QAC3C,EAAE,EAAE,MAAM,CAAC,6BAA6B,GAAG,UAAU,CAAC;QACtD,IAAI,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,KAAK;QAC5B,QAAQ,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,KAAK;QACpC,QAAQ,EAAE,cAAc;KACzB,CAAC;IAEF,IAAI,cAAc,GAAG,KAAK,CAAC;IAE3B,uCAAuC;IACvC,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;QAC9B,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,MAAK,WAAW,EAAE;YAC5C,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,sBAAsB,EAAE,0CAA0C,EACnG,EAAC,UAAU,EAAE,IAAI,EAAE,WAAW,EAAC,CAAC,CAAC;YACrC,IAAI;gBACF,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC9B;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,6BAA6B,EAAG,GAAa,CAAC,KAAK,IAAI,GAAG,EAAE,EAAC,UAAU,EAAC,CAAC,CAAC;aAC7G;YACD,cAAc,GAAG,IAAI,CAAC;SACvB;aAAM,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,MAAK,IAAI,EAAE;YAC5C,qBAAqB,CAAC,GAAG,EAAE;gBACzB,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;oBAC9B,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,sBAAsB,EAAE,0CAA0C,EACnG,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC,CAAC;oBACjC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;iBAC9B;YACH,CAAC,CAAC,CAAC;YACH,cAAc,GAAG,IAAI,CAAC,CAAC,4CAA4C;SACpE;KACF;IAED,mGAAmG;IACnG,IAAI,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,KAAI,cAAc,CAAC,EAAE;QACtC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE;YACrB,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SACvC;aAAM;YACL,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACpC;KACF;IAED,OAAO,QAAQ,CAAC,EAAE,CAAC;AACrB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CACjC,UAAsB,EACtB,UAAkB;IAEpB,MAAM,CAAC,aAAa,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;IAChG,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;QACxB,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;KAC9C;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC3B,UAAsB,EACtB,KAAgC,EAChC,OAAyB;IAE3B,MAAM,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAC,UAAU,EAAE,KAAK,EAAE,OAAO,EAAC,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC7C,2GAA2G;IAC3G,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;IAErB,IAAI,MAAM,CAAC,QAAQ;QAAE,OAAO,CAAC,sBAAsB;IACnD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,MAAM,CAAC,SAAS;QAAE,OAAO,CAAC,6BAA6B;IAEhF,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAA,EAAE;QACxB,8BAA8B;QAC5B,eAAe,CAAC,MAAM,CAAC,CAAC;QACxB,OAAO;KACR;IACD,sCAAsC;IACtC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,qBAAqB,CAAC,GAAG,EAAE;QACzB,eAAe,CAAC,MAAM,CAAC,CAAC;QACxB,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kBAAkB,CAC9B,UAAsB,EACtB,cAA0C,EAC1C,OAA+B;;IAEjC,MAAM,CAAC,aAAa,CAAC,mBAAmB,EAAE,EAAC,UAAU,EAAE,OAAO,EAAC,CAAC,CAAC;IAEjE,4CAA4C;IAC5C,MAAM,MAAM,GAAG,iBAAiB,CAAC,WAAW,UAAU,EAA2B,CAAC,CAAC;IACnF,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;QAClC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,6BAA6B,EAAE,2CAA2C,EACzG,EAAC,UAAU,EAAC,CAAC,CAAC;QACpB,MAAM,CAAC,YAAY,GAAG,EAAE,CAAC;KAC1B;IAED,MAAM,SAAS,GAAG,KAAK,EAAE,YAA8C,EAAiB,EAAE;;QACxF,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,CAAC;QACvD,IAAI,WAAW,KAAK,SAAS,EAAE,EAAE,6BAA6B;YAC5D,eAAe,CAAC,UAAU,EAAE,WAAW,EAAE,EAAC,QAAQ,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,IAAI,EAAC,CAAC,CAAC;SACjF;IACH,CAAC,CAAC;IAEF,OAAO,kBAAkB,CACvB,WAAW,UAAU,EAA2B,EAChD,SAAoD,EACpD,EAAC,eAAe,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,mCAAI,IAAI,EAAC,CACpD,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@alwatr/signal",
+  "version": "0.6.0",
+  "description": "Elegant powerful event system for handle global signals and states written in tiny TypeScript module.",
+  "keywords": [
+    "signal",
+    "typescript",
+    "esm",
+    "alwatr"
+  ],
+  "main": "signal.js",
+  "type": "module",
+  "types": "signal.d.ts",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com> (https://ali.mihandoost.com)",
+  "contributors": [
+    "MohammadMahdi Zamanian <mm25zamanian@gmail.com>"
+  ],
+  "license": "MIT",
+  "files": [
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.map",
+    "**/*.html",
+    "**/*.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AliMD/alwatr",
+    "directory": "package/signal"
+  },
+  "homepage": "https://github.com/AliMD/alwatr/tree/main/package/signal#readme",
+  "bugs": {
+    "url": "https://github.com/AliMD/alwatr/issues"
+  },
+  "dependencies": {
+    "@alwatr/logger": "^0.6.0",
+    "tslib": "^2.3.1"
+  },
+  "gitHead": "8ed13adce22d7bb0cc24eb17c9f8ecfb6bbe8553"
+}

package/signal.d.ts

@@ -0,0 +1,168 @@
+import type { ListenerOptions, DispatchOptions, ListenerCallback, SignalProvider, SignalProviderOptions } from './type';
+/**
+ * Signal API interface as a remote controller.
+ */
+export declare class SignalInterface<SignalName extends keyof AlwatrSignals> {
+    private _signal;
+    private _logger;
+    constructor(signalName: SignalName);
+    /**
+     * Get signal name.
+     *
+     * Example:
+     *
+     * ```ts
+     * console.log(contentChangeSignal.name);
+     * ```
+     */
+    get name(): SignalName;
+    /**
+     * Get last dispatched signal value or undefined.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * if (contentChangeSignal.dispatched) {
+     *   const content = contentChangeSignal.value!;
+     *   ...
+     * }
+     * ```
+     */
+    get value(): AlwatrSignals[SignalName] | undefined;
+    /**
+     * Check signal dispatched before or not!
+     *
+     * Example
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * if(contentChangeSignal.dispatched) {
+     *   // contentChangeSignal.value exist.
+     * }
+     * ```
+     */
+    get dispatched(): boolean;
+    /**
+     * Disable signal, all dispatch's ignored (just value updated) and no more listeners will be called.
+     *
+     * Example:
+     *
+     * ```ts
+     * contentChangeSignal.disabled = true;
+     * ```
+     */
+    get disabled(): boolean;
+    set disabled(disabled: boolean);
+    /**
+     * Expire the signal by clear last dispatched value.
+     *
+     * dispatched and receivePrevious etc not work until new signal.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * contentChangeSignal.dispatched; // true
+     * contentChangeSignal.expire();
+     * contentChangeSignal.value; // undefined
+     * contentChangeSignal.dispatched; // false
+     * ```
+     */
+    expire(): void;
+    /**
+     * Define signal provider, which will be called when signal requested (addRequestSignalListener).
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * contentChangeSignal.setProvider(async (requestParam) => {
+     *   const content = await fetchNewContent(requestParam);
+     *   if (content != null) {
+     *     return content; // Dispatch signal 'content-change' with content.
+     *   }
+     *   else {
+     *     // dispatch new signal: 'content-not-found'
+     *   }
+     * });
+     * ```
+     */
+    setProvider(signalProvider: SignalProvider<SignalName>, options?: SignalProviderOptions): symbol;
+    /**
+     * Dispatch request signal and wait for answer (wait for new signal dispatched).
+     *
+     * Resolved with signal value when new signal received (getNextSignalValue).
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * // dispatch request signal and wait for answer (wait for NEW signal).
+     * const newContent = await contentChangeSignal.request({foo: 'bar'});
+     * ```
+     */
+    request(requestParam: AlwatrRequestSignals[SignalName]): Promise<AlwatrSignals[SignalName]>;
+    /**
+     * Resolved with signal value when new signal received.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * // Wait for NEW signal received.
+     * const newContent = await contentChangeSignal.getNextSignalValue();
+     * ```
+     */
+    getNextSignalValue(): Promise<AlwatrSignals[SignalName]>;
+    /**
+     * Resolved with signal value when signal is ready.
+     *
+     * Get signal value from last dispatched signal (if any) or wait for new signal received.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * // get signal value from last dispatched signal (if any) or wait new signal received.
+     * const content = await contentChangeSignal.getSignalValue();
+     * ```
+     */
+    getSignalValue(): Promise<AlwatrSignals[SignalName]>;
+    /**
+     * Dispatch signal to all listeners.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * contentChangeSignal.dispatch(content);
+     * ```
+     */
+    dispatch(signalValue: AlwatrSignals[SignalName], options?: DispatchOptions): void;
+    /**
+     * Add new listener to the signal.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * const listener = contentChangeSignal.addListener((content) => console.log(content));
+     * ```
+     */
+    addListener(listener: ListenerCallback<SignalName>, options?: ListenerOptions): symbol;
+    /**
+     * Remove listener from specific signal.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * const listenerId = contentChangeSignal.addListener((content) => console.log(content));
+     * ...
+     * contentChangeSignal.removeListener(listenerId);
+     * ```
+     */
+    removeListener(listenerId: symbol): void;
+}
+//# sourceMappingURL=signal.d.ts.map

package/signal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signal.d.ts","sourceRoot":"","sources":["src/signal.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACtB,MAAM,QAAQ,CAAC;AAEhB;;GAEG;AACH,qBAAa,eAAe,CAAC,UAAU,SAAS,MAAM,aAAa;IACjE,OAAO,CAAC,OAAO,CAAC;IAChB,OAAO,CAAC,OAAO,CAAC;gBAEJ,UAAU,EAAE,UAAU;IAKlC;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,KAAK,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,SAAS,CAEjD;IAED;;;;;;;;;;;OAWG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;;;;OAQG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAE7B;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,IAAI,IAAI;IAKd;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,cAAc,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,MAAM;IAOhG;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,YAAY,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAS3F;;;;;;;;;;OAUG;IACH,kBAAkB,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAWxD;;;;;;;;;;;;OAYG;IACH,cAAc,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IASpD;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI;IAKjF;;;;;;;;;OASG;IACH,WAAW,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,MAAM;IAKtF;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;CAIzC"}

package/signal.js

@@ -0,0 +1,221 @@
+import { createLogger } from '@alwatr/logger';
+import { __getSignalObject, _removeSignalListener, _setSignalProvider, _dispatchSignal, _addSignalListener, } from './core';
+/**
+ * Signal API interface as a remote controller.
+ */
+export class SignalInterface {
+    constructor(signalName) {
+        this._logger = createLogger('Signal:' + signalName);
+        this._signal = __getSignalObject(signalName);
+    }
+    /**
+     * Get signal name.
+     *
+     * Example:
+     *
+     * ```ts
+     * console.log(contentChangeSignal.name);
+     * ```
+     */
+    get name() {
+        return this._signal.name;
+    }
+    /**
+     * Get last dispatched signal value or undefined.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * if (contentChangeSignal.dispatched) {
+     *   const content = contentChangeSignal.value!;
+     *   ...
+     * }
+     * ```
+     */
+    get value() {
+        return this._signal.value;
+    }
+    /**
+     * Check signal dispatched before or not!
+     *
+     * Example
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * if(contentChangeSignal.dispatched) {
+     *   // contentChangeSignal.value exist.
+     * }
+     * ```
+     */
+    get dispatched() {
+        return 'value' in this._signal;
+    }
+    /**
+     * Disable signal, all dispatch's ignored (just value updated) and no more listeners will be called.
+     *
+     * Example:
+     *
+     * ```ts
+     * contentChangeSignal.disabled = true;
+     * ```
+     */
+    get disabled() {
+        return this._signal.disabled;
+    }
+    set disabled(disabled) {
+        this._signal.disabled = disabled;
+    }
+    /**
+     * Expire the signal by clear last dispatched value.
+     *
+     * dispatched and receivePrevious etc not work until new signal.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * contentChangeSignal.dispatched; // true
+     * contentChangeSignal.expire();
+     * contentChangeSignal.value; // undefined
+     * contentChangeSignal.dispatched; // false
+     * ```
+     */
+    expire() {
+        this._logger.logMethod('expire');
+        delete this._signal.value;
+    }
+    /**
+     * Define signal provider, which will be called when signal requested (addRequestSignalListener).
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * contentChangeSignal.setProvider(async (requestParam) => {
+     *   const content = await fetchNewContent(requestParam);
+     *   if (content != null) {
+     *     return content; // Dispatch signal 'content-change' with content.
+     *   }
+     *   else {
+     *     // dispatch new signal: 'content-not-found'
+     *   }
+     * });
+     * ```
+     */
+    setProvider(signalProvider, options) {
+        this._logger.logMethodArgs('setProvider', { options });
+        return _setSignalProvider(this.name, signalProvider, options);
+    }
+    // @TODO: removeProvider(signalName): void
+    /**
+     * Dispatch request signal and wait for answer (wait for new signal dispatched).
+     *
+     * Resolved with signal value when new signal received (getNextSignalValue).
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * // dispatch request signal and wait for answer (wait for NEW signal).
+     * const newContent = await contentChangeSignal.request({foo: 'bar'});
+     * ```
+     */
+    request(requestParam) {
+        this._logger.logMethodArgs('request', { requestParam });
+        _dispatchSignal(`request-${this.name}`, requestParam);
+        return this.getNextSignalValue();
+    }
+    /**
+     * Resolved with signal value when new signal received.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * // Wait for NEW signal received.
+     * const newContent = await contentChangeSignal.getNextSignalValue();
+     * ```
+     */
+    getNextSignalValue() {
+        this._logger.logMethod('getNextSignalValue');
+        return new Promise((resolve) => {
+            this.addListener(resolve, {
+                once: true,
+                priority: true,
+                receivePrevious: false,
+            });
+        });
+    }
+    /**
+     * Resolved with signal value when signal is ready.
+     *
+     * Get signal value from last dispatched signal (if any) or wait for new signal received.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * // get signal value from last dispatched signal (if any) or wait new signal received.
+     * const content = await contentChangeSignal.getSignalValue();
+     * ```
+     */
+    getSignalValue() {
+        this._logger.logMethod('getSignalValue');
+        if (this._signal.value !== undefined) {
+            return Promise.resolve(this._signal.value);
+        }
+        else {
+            return this.getNextSignalValue();
+        }
+    }
+    /**
+     * Dispatch signal to all listeners.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * contentChangeSignal.dispatch(content);
+     * ```
+     */
+    dispatch(signalValue, options) {
+        this._logger.logMethodArgs('dispatch', { signalValue, options });
+        _dispatchSignal(this._signal.name, signalValue, options);
+    }
+    /**
+     * Add new listener to the signal.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * const listener = contentChangeSignal.addListener((content) => console.log(content));
+     * ```
+     */
+    addListener(listener, options) {
+        this._logger.logMethodArgs('addListener', { listener, options });
+        return _addSignalListener(this._signal.name, listener, options);
+    }
+    /**
+     * Remove listener from specific signal.
+     *
+     * Example:
+     *
+     * ```ts
+     * const contentChangeSignal = new SignalInterface('content-change');
+     * const listenerId = contentChangeSignal.addListener((content) => console.log(content));
+     * ...
+     * contentChangeSignal.removeListener(listenerId);
+     * ```
+     */
+    removeListener(listenerId) {
+        this._logger.logMethod('removeListener');
+        _removeSignalListener(this._signal.name, listenerId);
+    }
+}
+// @TODO: getSignalOptions(signalName);
+// @TODO: getListenerOptions(listenerId);
+// @TODO: setSignalOptions(signalName, {...});
+// @TODO: setListenerOptions(listenerId, {...});
+//# sourceMappingURL=signal.js.map

package/signal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signal.js","sourceRoot":"","sources":["src/signal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,kBAAkB,GACnB,MAAM,QAAQ,CAAC;AAUhB;;GAEG;AACH,MAAM,OAAO,eAAe;IAI1B,YAAY,UAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,SAAS,GAAG,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,UAAU;QACZ,OAAO,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;IACD,IAAI,QAAQ,CAAC,QAAiB;QAC5B,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM;QACJ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,cAA0C,EAAE,OAA+B;QACrF,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;QACrD,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED,0CAA0C;IAE1C;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,YAA8C;QACpD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,EAAC,YAAY,EAAC,CAAC,CAAC;QACtD,eAAe,CACb,WAAW,IAAI,CAAC,IAAI,EAA2B,EAC/C,YAAoD,CACrD,CAAC;QACF,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB;QAChB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,IAAI;gBACd,eAAe,EAAE,KAAK;aACvB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,cAAc;QACZ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;YACpC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC5C;aAAM;YACL,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAClC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAsC,EAAE,OAAyB;QACxE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,EAAC,WAAW,EAAE,OAAO,EAAC,CAAC,CAAC;QAC/D,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,QAAsC,EAAE,OAAyB;QAC3E,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;QAC/D,OAAO,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAkB;QAC/B,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACzC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACvD,CAAC;CACF;AAED,uCAAuC;AACvC,yCAAyC;AACzC,8CAA8C;AAC9C,gDAAgD"}

package/type.d.ts

@@ -0,0 +1,131 @@
+declare global {
+    /**
+     * Global signals value type registry.
+     */
+    interface AlwatrSignals {
+        readonly 'easter-egg': number;
+    }
+    /**
+     * Global request signal parameters types.
+     */
+    interface AlwatrRequestSignals {
+        readonly 'easter-egg': number;
+    }
+}
+/**
+ * addSignalListener options type
+ */
+export interface ListenerOptions {
+    /**
+     * If true, the listener will be called only once.
+     * @default false
+     */
+    once?: boolean;
+    /**
+     * If true, the listener will be called before other.
+     * @default false
+     */
+    priority?: boolean;
+    /**
+     * If true, the listener will be defined disabled by default.
+     *
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * Calling this listener (callback) with preview signal value (if dispatched before).
+     * If Immediate, the listener will be called immediately without any debounce for preview signal.
+     *
+     * @default true
+     */
+    receivePrevious?: boolean | 'Immediate';
+}
+/**
+ * dispatchSignal options type
+ */
+export interface DispatchOptions {
+    /**
+     * If true, the dispatch will be send after animation frame debounce.
+     * If false, every signal is matter and count.
+     * tips: debounce work like throttle this means listeners call with last dispatch value.
+     *
+     * @default true
+     */
+    debounce?: boolean;
+}
+export interface SignalProviderOptions {
+    /**
+     * Calling signal provider (request signal callback) with preview signal value (if dispatched before).
+     * If Immediate, the listener will be called immediately without any debounce for preview signal.
+     *
+     * @default true
+     */
+    receivePrevious?: boolean | 'Immediate';
+    /**
+     * If true, the dispatch will be send after animation frame debounce.
+     * If false, every signal is matter and count.
+     * tips: debounce work like throttle this means listeners call with last dispatch value.
+     *
+     * @default true
+     */
+    debounce?: boolean;
+}
+/**
+ * Signal listeners callback function type.
+ */
+export declare type ListenerCallback<SignalName extends keyof AlwatrSignals> = (signalValue: AlwatrSignals[SignalName]) => void | Promise<void>;
+/**
+ * Signal provider function type used to setSignalProvider.
+ */
+export declare type SignalProvider<SignalName extends keyof AlwatrRequestSignals> = (requestParam: AlwatrRequestSignals[SignalName]) => AlwatrSignals[SignalName] | void | Promise<AlwatrSignals[SignalName] | void>;
+/**
+ * Signal listeners object in database.
+ */
+export interface ListenerObject<SignalName extends keyof AlwatrSignals> {
+    /**
+     * Listener symbol id (unique).
+     */
+    id: symbol;
+    /**
+     * If true, the listener will be called only once and removed automatically after first call
+     */
+    once: boolean;
+    /**
+     * If true, the listener will be disabled.
+     */
+    disabled: boolean;
+    callback: ListenerCallback<SignalName>;
+}
+/**
+ * Signal object in database.
+ */
+export interface SignalObject<SignalName extends keyof AlwatrSignals> {
+    /**
+     * Signal name for direct access.
+     */
+    name: SignalName;
+    /**
+     * Last dispatched value.
+     */
+    value?: AlwatrSignals[SignalName];
+    /**
+     * If true, the signal is disabled.
+     */
+    disabled: boolean;
+    /**
+     * Dispatches debounced (delayed).
+     * Internal use case for debounce dispatch signal.
+     */
+    debounced: boolean;
+    /**
+     * Signal listeners list.
+     */
+    listenerList: Array<ListenerObject<SignalName>>;
+}
+/**
+ * Signal stack database.
+ */
+export declare type SignalStack = {
+    [SignalName in keyof AlwatrSignals]?: SignalObject<SignalName>;
+};
+//# sourceMappingURL=type.d.ts.map

package/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,aAAa;QACrB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;KAC/B;IAED;;OAEG;IACF,UAAU,oBAAoB;QAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;KAC/B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACF,eAAe,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;IAEzC;;;;;;OAMG;IACJ,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,oBAAY,gBAAgB,CAAC,UAAU,SAAS,MAAM,aAAa,IACjE,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnE;;GAEG;AACH,oBAAY,cAAc,CAAC,UAAU,SAAS,MAAM,oBAAoB,IACtE,CAAC,YAAY,EAAE,oBAAoB,CAAC,UAAU,CAAC,KAC7C,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,UAAU,SAAS,MAAM,aAAa;IAEpE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,UAAU,SAAS,MAAM,aAAa;IAElE;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,oBAAY,WAAW,GAAG;KACvB,UAAU,IAAI,MAAM,aAAa,CAAC,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;CAC/D,CAAA"}

package/type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type.js.map

package/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":""}