@alwatr/signal 1.1.2 → 2.0.0

package/context-provider.d.ts

@@ -1,120 +0,0 @@
-import type { Stringifyable } from '@alwatr/type';
-/**
- * Context provider interface.
- */
-export declare const contextProvider: {
-    /**
-     * Get context value.
-     *
-     * Return undefined if context not set before or expired.
-     *
-     * Example:
-     *
-     * ```ts
-     * const currentProductList = contextProvider.getValue<ProductListType>('product-list');
-     * if (currentProductList === undefined) {
-     *   // productList not set before or expired.
-     * }
-     * ```
-     */
-    readonly getValue: <T extends Stringifyable>(signalId: string) => T | undefined;
-    /**
-     * Set context value and send signal to all consumers.
-     *
-     * Signal detail changed immediately without any debounce.
-     *
-     * Example:
-     *
-     * ```ts
-     * contextProvider.setValue<ProductListType>('product-list', newProductList);
-     * ```
-     */
-    readonly setValue: <T_1 extends Stringifyable>(signalId: string, detail: T_1, options?: Partial<import("./type.js").DispatchOptions>) => void;
-    /**
-     * Clear current context value without send signal to all consumers.
-     *
-     * new subscriber options.receivePrevious not work until new signal
-     *
-     * Example:
-     *
-     * ```ts
-     * contextProvider.expire('product-list');
-     * ```
-     */
-    readonly expire: (signalId: string) => void;
-    /**
-     * Waits until the context value changes.
-     *
-     * Example:
-     *
-     * ```ts
-     * const newProductList = await contextProvider.untilChange<ProductListType>('product-list');
-     * ```
-     */
-    readonly untilChange: <T_2 extends Stringifyable>(signalId: string) => Promise<T_2>;
-    /**
-     * Bind this interface to special context.
-     *
-     * Example:
-     *
-     * ```ts
-     * const productListProvider = contextProvider.bind<ProductListType>('product-list');
-     * ```
-     */
-    readonly bind: <T_3 extends Stringifyable>(contextId: string) => {
-        /**
-         * Context signal Id.
-         */
-        readonly id: string;
-        /**
-         * Get context value.
-         *
-         * Return undefined if context not set before or expired.
-         *
-         * Example:
-         *
-         * ```ts
-         * const currentProductList = productListProvider.getValue();
-         * if (currentProductList === undefined) {
-         *   // productList not set before or expired.
-         * }
-         * ```
-         */
-        readonly getValue: () => T_3 | undefined;
-        /**
-         * Set context value and send signal to all consumers.
-         *
-         * Signal detail changed immediately without any debounce.
-         *
-         * Example:
-         *
-         * ```ts
-         * productListProvider.setValue(newProductList);
-         * ```
-         */
-        readonly setValue: (detail: T_3, options?: Partial<import("./type.js").DispatchOptions> | undefined) => void;
-        /**
-         * Clear current context value without send signal to all consumers.
-         *
-         * new subscriber options.receivePrevious not work until new signal
-         *
-         * Example:
-         *
-         * ```ts
-         * productListProvider.expire();
-         * ```
-         */
-        readonly expire: () => void;
-        /**
-         * Waits until the context value changes.
-         *
-         * Example:
-         *
-         * ```ts
-         * const newProductList = await productListProvider.untilChange();
-         * ```
-         */
-        readonly untilChange: () => Promise<T_3>;
-    };
-};
-//# sourceMappingURL=context-provider.d.ts.map

package/context-provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context-provider.d.ts","sourceRoot":"","sources":["src/context-provider.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,aAAa,EAAiB,MAAM,cAAc,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;;OAQG;0DACwC,MAAM;QAC/C;;WAEG;;QAGH;;;;;;;;;;;;;WAaG;;QAGH;;;;;;;;;;WAUG;;QAGH;;;;;;;;;;WAUG;;QAGH;;;;;;;;WAQG;;;CAGG,CAAC"}

package/context-provider.js

@@ -1,120 +0,0 @@
-import { clearDetail, dispatch, getDetail, untilNext } from './core.js';
-/**
- * Context provider interface.
- */
-export const contextProvider = {
-    /**
-     * Get context value.
-     *
-     * Return undefined if context not set before or expired.
-     *
-     * Example:
-     *
-     * ```ts
-     * const currentProductList = contextProvider.getValue<ProductListType>('product-list');
-     * if (currentProductList === undefined) {
-     *   // productList not set before or expired.
-     * }
-     * ```
-     */
-    getValue: getDetail,
-    /**
-     * Set context value and send signal to all consumers.
-     *
-     * Signal detail changed immediately without any debounce.
-     *
-     * Example:
-     *
-     * ```ts
-     * contextProvider.setValue<ProductListType>('product-list', newProductList);
-     * ```
-     */
-    setValue: dispatch,
-    /**
-     * Clear current context value without send signal to all consumers.
-     *
-     * new subscriber options.receivePrevious not work until new signal
-     *
-     * Example:
-     *
-     * ```ts
-     * contextProvider.expire('product-list');
-     * ```
-     */
-    expire: clearDetail,
-    /**
-     * Waits until the context value changes.
-     *
-     * Example:
-     *
-     * ```ts
-     * const newProductList = await contextProvider.untilChange<ProductListType>('product-list');
-     * ```
-     */
-    untilChange: untilNext,
-    /**
-     * Bind this interface to special context.
-     *
-     * Example:
-     *
-     * ```ts
-     * const productListProvider = contextProvider.bind<ProductListType>('product-list');
-     * ```
-     */
-    bind: (contextId) => ({
-        /**
-         * Context signal Id.
-         */
-        id: contextId,
-        /**
-         * Get context value.
-         *
-         * Return undefined if context not set before or expired.
-         *
-         * Example:
-         *
-         * ```ts
-         * const currentProductList = productListProvider.getValue();
-         * if (currentProductList === undefined) {
-         *   // productList not set before or expired.
-         * }
-         * ```
-         */
-        getValue: getDetail.bind(null, contextId),
-        /**
-         * Set context value and send signal to all consumers.
-         *
-         * Signal detail changed immediately without any debounce.
-         *
-         * Example:
-         *
-         * ```ts
-         * productListProvider.setValue(newProductList);
-         * ```
-         */
-        setValue: dispatch.bind(null, contextId),
-        /**
-         * Clear current context value without send signal to all consumers.
-         *
-         * new subscriber options.receivePrevious not work until new signal
-         *
-         * Example:
-         *
-         * ```ts
-         * productListProvider.expire();
-         * ```
-         */
-        expire: clearDetail.bind(null, contextId),
-        /**
-         * Waits until the context value changes.
-         *
-         * Example:
-         *
-         * ```ts
-         * const newProductList = await productListProvider.untilChange();
-         * ```
-         */
-        untilChange: untilNext.bind(null, contextId),
-    }),
-};
-//# sourceMappingURL=context-provider.js.map

package/context-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context-provider.js","sourceRoot":"","sources":["src/context-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAC,MAAM,WAAW,CAAC;AAItE;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;;;;;;;;;;;;;OAaG;IACH,QAAQ,EAAE,SAAS;IAEnB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,QAAQ;IAElB;;;;;;;;;;OAUG;IACH,MAAM,EAAE,WAAW;IAEnB;;;;;;;;OAQG;IACH,WAAW,EAAE,SAAS;IAEtB;;;;;;;;OAQG;IACH,IAAI,EAAE,CAA0B,SAAiB,EAAE,EAAE,CAAA,CAAC;QACpD;;WAEG;QACH,EAAE,EAAE,SAAS;QAEb;;;;;;;;;;;;;WAaG;QACH,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAwC;QAEhF;;;;;;;;;;WAUG;QACH,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAuC;QAE9E;;;;;;;;;;WAUG;QACH,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC;QAEzC;;;;;;;;WAQG;QACH,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAwC;KAC1E,CAAA;CACH,CAAC","sourcesContent":["import {clearDetail, dispatch, getDetail, untilNext} from './core.js';\n\nimport type {Stringifyable, OmitFirstParam} from '@alwatr/type';\n\n/**\n * Context provider interface.\n */\nexport const contextProvider = {\n  /**\n   * Get context value.\n   *\n   * Return undefined if context not set before or expired.\n   *\n   * Example:\n   *\n   * ```ts\n   * const currentProductList = contextProvider.getValue<ProductListType>('product-list');\n   * if (currentProductList === undefined) {\n   *   // productList not set before or expired.\n   * }\n   * ```\n   */\n  getValue: getDetail,\n\n  /**\n   * Set context value and send signal to all consumers.\n   *\n   * Signal detail changed immediately without any debounce.\n   *\n   * Example:\n   *\n   * ```ts\n   * contextProvider.setValue<ProductListType>('product-list', newProductList);\n   * ```\n   */\n  setValue: dispatch,\n\n  /**\n   * Clear current context value without send signal to all consumers.\n   *\n   * new subscriber options.receivePrevious not work until new signal\n   *\n   * Example:\n   *\n   * ```ts\n   * contextProvider.expire('product-list');\n   * ```\n   */\n  expire: clearDetail,\n\n  /**\n   * Waits until the context value changes.\n   *\n   * Example:\n   *\n   * ```ts\n   * const newProductList = await contextProvider.untilChange<ProductListType>('product-list');\n   * ```\n   */\n  untilChange: untilNext,\n\n  /**\n   * Bind this interface to special context.\n   *\n   * Example:\n   *\n   * ```ts\n   * const productListProvider = contextProvider.bind<ProductListType>('product-list');\n   * ```\n   */\n  bind: <T extends Stringifyable>(contextId: string) =>({\n    /**\n     * Context signal Id.\n     */\n    id: contextId,\n\n    /**\n     * Get context value.\n     *\n     * Return undefined if context not set before or expired.\n     *\n     * Example:\n     *\n     * ```ts\n     * const currentProductList = productListProvider.getValue();\n     * if (currentProductList === undefined) {\n     *   // productList not set before or expired.\n     * }\n     * ```\n     */\n    getValue: getDetail.bind(null, contextId) as OmitFirstParam<typeof getDetail<T>>,\n\n    /**\n     * Set context value and send signal to all consumers.\n     *\n     * Signal detail changed immediately without any debounce.\n     *\n     * Example:\n     *\n     * ```ts\n     * productListProvider.setValue(newProductList);\n     * ```\n     */\n    setValue: dispatch.bind(null, contextId) as OmitFirstParam<typeof dispatch<T>>,\n\n    /**\n     * Clear current context value without send signal to all consumers.\n     *\n     * new subscriber options.receivePrevious not work until new signal\n     *\n     * Example:\n     *\n     * ```ts\n     * productListProvider.expire();\n     * ```\n     */\n    expire: clearDetail.bind(null, contextId),\n\n    /**\n     * Waits until the context value changes.\n     *\n     * Example:\n     *\n     * ```ts\n     * const newProductList = await productListProvider.untilChange();\n     * ```\n     */\n    untilChange: untilNext.bind(null, contextId) as OmitFirstParam<typeof untilNext<T>>,\n  } as const),\n} as const;\n"]}

package/core.d.ts

@@ -1,181 +0,0 @@
-import type { DispatchOptions, ListenerFunction, SubscribeOptions, SignalObject, ProviderFunction, ProviderOptions, ListenerSpec } from './type.js';
-import type { Stringifyable, StringifyableRecord } from '@alwatr/type';
-export declare const logger: import("@alwatr/logger").AlwatrLogger;
-/**
- * Get signal object by id, If not available, it will create a new signal with default options.
- *
- * Don't use it directly.
- *
- * Example:
- *
- * ```ts
- * const signal = getSignalObject<ContentType>('content-change');
- * signal.disabled = true;
- * ```
- */
-export declare const getSignalObject: <T extends Stringifyable>(id: string) => SignalObject<T>;
-/**
- * Call all listeners callback of special signal.
- *
- * Used inside dispatch, Don't use it directly.
- */
-export declare const _callListeners: <T extends Stringifyable>(signal: SignalObject<T>, detail: T) => void;
-/**
- * Subscribe new signal listener to a signal, work like addEventListener.
- *
- * Example:
- *
- * ```ts
- * const listener = subscribe<ContentType>('content-change', (content) => console.log(content));
- * // ...
- * unsubscribe(listener);
- * ```
- */
-export declare const subscribe: <T extends Stringifyable>(signalId: string, listenerCallback: ListenerFunction<T>, options?: Partial<SubscribeOptions>) => ListenerSpec;
-/**
- * Unsubscribe listener from signal, work like removeEventListener.
- *
- * Example:
- *
- * ```ts
- * const listener = subscribe<ContentType>('content-change', (content) => console.log(content));
- * // ...
- * unsubscribe(listener);
- * ```
- */
-export declare const unsubscribe: (listener: ListenerSpec) => void;
-/**
- * Unsubscribe all listener from a signal, clear all listeners.
- *
- * Example:
- *
- * ```ts
- * removeAllListeners('content-change');
- * ```
- */
-export declare const removeAllListeners: (signalId: string) => void;
-/**
- * Dispatch (send) signal to all listeners.
- *
- * Signal detail changed immediately without any debounce.
- *
- * Example:
- *
- * ```ts
- * dispatch<ContentType>('content-change', newContent);
- * ```
- */
-export declare const dispatch: <T extends Stringifyable>(signalId: string, detail: T, options?: Partial<DispatchOptions>) => void;
-/**
- * Get current signal detail/value.
- *
- * Return undefined if signal not dispatched before or expired.
- *
- * Example:
- *
- * ```ts
- * const currentContent = getDetail<ContentType>('content-change');
- * if (currentContent === undefined) {
- *   // signal not dispatched yet
- * }
- * ```
- */
-export declare const getDetail: <T extends Stringifyable>(signalId: string) => T | undefined;
-/**
- * Get the detail/value of the next received signal.
- *
- * Example:
- *
- * ```ts
- * const newContent = await untilNext<ContentType>('content-change');
- * ```
- */
-export declare const untilNext: <T extends Stringifyable>(signalId: string) => Promise<T>;
-/**
- * Defines the provider of the context signal that will be called when the context requested.
- * Subscribe to `request-signalId`.
- *
- * Example:
- *
- * ```ts
- * setContextProvider('content-change', async (requestParam) => await fetchNewContent(requestParam));
- * ```
- */
-export declare const setContextProvider: <TContext extends Stringifyable, TRquest extends Stringifyable = null>(signalId: string, signalProvider: ProviderFunction<TRquest, void | TContext>, options?: Partial<ProviderOptions>) => void;
-/**
- * Defines the command and dispatch returned value.
- *
- * Subscribe commandFunction to request-command-signal and dispatch callback-signal with commandFunction return value.
- *
- * Example:
- *
- * ```ts
- * defineCommand<TArgument, TReturn>(
- *   'show-prompt',
- *   async (argumentObject) => {
- *      return await showPrompt(argumentObject);
- *   },
- * );
- * ```
- */
-export declare const defineCommand: <TArgument extends StringifyableRecord, TReturn extends Stringifyable>(signalId: string, signalProvider: ProviderFunction<TArgument & {
-    _callbackSignalId?: string | undefined;
-}, TReturn>, options?: Partial<Pick<ProviderOptions, 'debounce'>>) => ListenerSpec;
-/**
- * Dispatch request context signal with requestParam as detail.
- *
- * Example:
- *
- * ```ts
- * requestContext<RequestParamType>('content-change', {foo: 'bar'});
- * const newContent = await untilNext<ContentType>('content-change');
- * ```
- */
-export declare const requestContext: <TRequest extends Stringifyable>(contextId: string, requestParam: TRequest, options?: Partial<DispatchOptions>) => void;
-/**
- * Dispatch request command signal with commandArgument as detail.
- *
- * Example:
- *
- * ```ts
- * requestCommand<ArgumentType>('show-dialog', {foo: 'bar'});
- * ```
- */
-export declare const requestCommand: <TArgument extends StringifyableRecord>(commandId: string, commandArgument: TArgument) => void;
-/**
- * Dispatch request command signal with commandArgument as detail and return untilNext of callback signal.
- *
- * Request command and wait for answer.
- *
- * Example:
- *
- * ```ts
- * const response = await requestCommandWithResponse<ArgumentType, ReturnType>('show-dialog', {foo: 'bar'});
- * ```
- */
-export declare const requestCommandWithResponse: <TArgument extends StringifyableRecord, TReturn extends Stringifyable>(commandId: string, commandArgument: TArgument) => Promise<TReturn>;
-/**
- * Clear current signal detail without dispatch new signal.
- *
- * new subscriber options.receivePrevious not work until new signal
- *
- * Example:
- *
- * ```ts
- * clearDetail('product-list');
- * ```
- */
-export declare const clearDetail: (signalId: string) => void;
-/**
- * Delete signal object with detail and listeners and options.
- *
- * new subscriber options.receivePrevious not work until new signal
- *
- * Example:
- *
- * ```ts
- * destroySignal('product-list');
- * ```
- */
-export declare const destroySignal: (signalId: string) => void;
-//# sourceMappingURL=core.d.ts.map

package/core.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAEhB,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EAEf,YAAY,EACb,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAC,aAAa,EAAE,mBAAmB,EAAC,MAAM,cAAc,CAAC;AAmBrE,eAAO,MAAM,MAAM,uCAAgC,CAAC;AAEpD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,gCAAiC,MAAM,oBAWlE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,mEAAkE,IA0B5F,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,sCACV,MAAM,mDAEP,QAAQ,gBAAgB,CAAC,KACjC,YAuDF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,aAAc,YAAY,KAAG,IAOpD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,aAAc,MAAM,KAAG,IAMrD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ,sCACT,MAAM,uBAEP,QAAQ,eAAe,CAAC,KAChC,IAoCF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,sCAAuC,MAAM,kBAElE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,sCAAuC,MAAM,eASlE,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,mFACnB,MAAM,wEAGP,QAAQ,eAAe,CAAC,KAChC,IAkBF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,mFACd,MAAM;;uBAEP,QAAQ,KAAK,eAAe,EAAE,UAAU,CAAC,CAAC,KAClD,YAuBF,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,8CACd,MAAM,oCAER,QAAQ,eAAe,CAAC,KAChC,IAGF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,qDACd,MAAM,iCAEhB,IAGF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B,oFAI1B,MAAM,iDAqBlB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,aAAc,MAAM,KAAG,IAI9C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,KAAG,IAMhD,CAAC"}