@fbltd/async 1.0.9 → 1.0.11

package/README.md

@@ -1,6 +1,8 @@
 # Async tools
 
-## delay
+## Overview
+
+### delay
 delay is a function that can be executed synchronous or asynchronous.
 The behaviour depends on passed arguments:
 ```typescript
@@ -8,10 +10,10 @@ The behaviour depends on passed arguments:
 await delay(number);
 
 // Returns nothing - synchrounous running in a blocking manner;
-delay(number, true);
+delay(number, 'sync');
 ```
 
-## getPromise
+### getPromise
 getPromise is a function that creates and returns promise, its fulfillment functions
 and status flags.
 Returned type is:
@@ -27,8 +29,8 @@ type IPromiseConfiguration<T> = {
 There is no any management of passed data for resolving.
 Returned promise is usual ES promise so it is impossible to fulfill promise twice.
 
-## DependencyStream
-### core
+### DependencyStream
+#### core
 Implementation of reactive model leveraging native JavaScript async features like
 Promises, (async) iterators and generators.
 The version is 0.0.x so keep it in mind
@@ -37,7 +39,7 @@ The version is 0.0.x so keep it in mind
 const counter = new DependencyStream<number>(0);
 
 async function onCounterChange() {
-    for await (let value of counter.stream()) {
+    for await (let value of counter) {
         // do whatever you want
     }
 
@@ -54,13 +56,13 @@ setInterval(() => {
         // differs from the previous one. 
         // Subsequent value updates are collected and processed together
         // during the next microtask execution phase of the event loop.
-        counter.set(i++);
+        counter.value = i++;
     }
 }, 1000)
 ```
 
-### Framework integrations
-#### React
+#### Framework integrations
+##### React
 Of course, there is a React integration via useStream hook:
 
 ```typescript jsx
@@ -99,5 +101,8 @@ export const Counter: React.FC<ITest> = React.memo(({
 })
 ```
 
-## Disclaimer
-Now this package is CommonJS module but should be an ESM.
+### Disclaimer
+Now this package is CommonJS module but should be an ESM.
+
+## Installation
+Just type ```npm i @fbltd/async``` 

package/dist/bin/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.symAI = void 0;
+exports.symAI = Symbol.asyncIterator;

package/dist/bin/{utils/delay.js → delay.js}

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.delay = delay;
 const get_promise_1 = require("./get-promise");
-function delay(ms = 0, sync) {
+function delay(ms = 0, syncKey) {
     ms = Math.max(ms, 0);
-    return delay.methods[typeof sync](ms);
+    return delay.methods[typeof syncKey](ms);
 }
 Object.defineProperty(delay, 'methods', {
     value: {
-        boolean: (ms) => {
+        string: (ms) => {
             const start = performance.now();
             while (true) {
                 if (performance.now() - start >= ms) {

package/dist/bin/dependency-stream/contracts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/bin/{core → dependency-stream}/dependency-stream.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DependencyStream = void 0;
-const utils_1 = require("../utils");
+const get_promise_1 = require("../get-promise");
 function baseComparer(prev, cur) {
     return prev === cur;
 }
 class DependencyStream {
     _value;
     reactionPromise;
-    abortPromise = (0, utils_1.getPromise)();
+    abortPromise = (0, get_promise_1.getPromise)();
     config;
     constructor(_value, config = {}) {
         this._value = _value;
@@ -34,30 +34,38 @@ class DependencyStream {
     get value() {
         return this._value;
     }
-    [Symbol.asyncIterator]() {
+    [Symbol.asyncIterator](thisStreamConfig = {}) {
         const totalDispose = this.abortPromise;
-        const selfDispose = (0, utils_1.getPromise)();
-        const externalPromises = [totalDispose.promise, selfDispose.promise];
+        const externalPromises = [totalDispose.promise];
         let firstPromise;
-        if (this.config.withReactionOnSubscribe) {
-            firstPromise = (0, utils_1.getPromise)();
+        const withReactionOnSubscribe = this.config.withReactionOnSubscribe || thisStreamConfig.withReactionOnSubscribe;
+        if (withReactionOnSubscribe) {
+            firstPromise = (0, get_promise_1.getPromise)();
             firstPromise.resolve(this.value);
             externalPromises.push(firstPromise.promise);
         }
+        if (thisStreamConfig.externalDispose) {
+            externalPromises.push(thisStreamConfig.externalDispose.promise);
+        }
+        let isDisposed = false;
         const owner = this;
         return {
             owner,
-            dispose: () => selfDispose.resolve(),
+            dispose: owner.dispose.bind(owner),
+            get isDisposed() {
+                return isDisposed;
+            },
             next: async () => {
                 if (!this.reactionPromise) {
-                    this.reactionPromise = (0, utils_1.getPromise)();
+                    this.reactionPromise = (0, get_promise_1.getPromise)();
                     this._set(this._value);
                 }
                 await Promise.race([
                     ...externalPromises,
                     this.reactionPromise.promise,
                 ]);
-                if (totalDispose.isFulfilled || selfDispose.isFulfilled) {
+                if (totalDispose.isFulfilled || thisStreamConfig.externalDispose?.isFulfilled) {
+                    isDisposed = true;
                     return { done: true };
                 }
                 if (firstPromise) {
@@ -75,7 +83,7 @@ class DependencyStream {
     }
     dispose() {
         this.abortPromise.resolve();
-        this.abortPromise = (0, utils_1.getPromise)();
+        this.abortPromise = (0, get_promise_1.getPromise)();
         this.reactionPromise = undefined;
     }
 }

package/dist/bin/{core → dependency-stream}/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./dependency-stream"), exports);
 __exportStar(require("./utils"), exports);
+__exportStar(require("./integrations"), exports);
+__exportStar(require("./contracts"), exports);

package/dist/bin/{utils → dependency-stream/integrations}/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./get-promise"), exports);
+__exportStar(require("./react"), exports);

package/dist/bin/{react → dependency-stream/integrations/react}/src/use-stream.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useStream = useStream;
-const core_1 = require("../../core");
+const index_1 = require("../../../index");
 const react_1 = require("react");
 class StreamController {
     setValue;
@@ -12,7 +12,7 @@ class StreamController {
         this.init();
     }
     async init() {
-        this.iterator = (0, core_1.anyStream)(...this.streams);
+        this.iterator = (0, index_1.raceStream)(...this.streams);
         for await (let chunk of this.iterator) {
             console.log(chunk);
             this.setValue?.(chunk);

package/dist/bin/dependency-stream/utils/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.raceStream = exports.once = void 0;
+var once_1 = require("./once");
+Object.defineProperty(exports, "once", { enumerable: true, get: function () { return once_1.once; } });
+var race_stream_1 = require("./race.stream");
+Object.defineProperty(exports, "raceStream", { enumerable: true, get: function () { return race_stream_1.raceStream; } });

package/dist/bin/dependency-stream/utils/once.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.once = once;
+function once(dep) {
+    let isIterationWas = false;
+    const iterator = dep[Symbol.asyncIterator]();
+    return {
+        [Symbol.asyncIterator]() {
+            return {
+                next: async () => {
+                    if (isIterationWas)
+                        return { done: true };
+                    return iterator.next();
+                }
+            };
+        },
+        dispose: iterator.dispose,
+    };
+}

package/dist/bin/dependency-stream/utils/race.stream.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.raceStream = raceStream;
+const constants_1 = require("../../constants");
+const get_promise_1 = require("../../get-promise");
+function raceStream(...deps) {
+    let selfDisposePromise = (0, get_promise_1.getPromise)();
+    let isDisposed = false;
+    const streams = deps.map((dep) => dep[constants_1.symAI]({
+        externalDispose: selfDisposePromise
+    }));
+    return {
+        dispose: () => selfDisposePromise.resolve({ done: true, value: void 0 }),
+        get isDisposed() {
+            return isDisposed;
+        },
+        [constants_1.symAI]() {
+            return {
+                next: async () => {
+                    const res = await Promise.race([selfDisposePromise.promise, ...streams.map(s => s.next())]);
+                    if (res.done)
+                        return res;
+                    return { done: false, value: streams.map(s => s.owner.value) };
+                }
+            };
+        }
+    };
+}

package/dist/bin/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./core"), exports);
-__exportStar(require("./react"), exports);
-__exportStar(require("./utils"), exports);
+__exportStar(require("./dependency-stream"), exports);
+__exportStar(require("./dependency-stream/integrations/react"), exports);
+__exportStar(require("./delay"), exports);
+__exportStar(require("./get-promise"), exports);

package/dist/types/constants.d.ts

@@ -0,0 +1 @@
+export declare const symAI: typeof Symbol.asyncIterator;

package/dist/types/delay.d.ts

@@ -0,0 +1,2 @@
+export declare function delay(ms: number, syncKey: 'sync'): void;
+export declare function delay(ms?: number): Promise<void>;

package/dist/types/dependency-stream/contracts.d.ts

@@ -0,0 +1,10 @@
+export interface IIteratorOwner<TValue = any> {
+    value: TValue;
+    dispose(): void;
+}
+export interface IStreamIterator<TValue = any> {
+    owner: IIteratorOwner<TValue>;
+    dispose(): void;
+    readonly isDisposed: boolean;
+    next(): Promise<IteratorResult<TValue, void>>;
+}

package/dist/types/dependency-stream/dependency-stream.d.ts

@@ -0,0 +1,26 @@
+import { IPromiseConfiguration } from "../get-promise";
+import { IIteratorOwner, IStreamIterator } from "./contracts";
+interface IIsEquals<T> {
+    (prev: T, cur: T): boolean;
+}
+type IAllStreamConfig<T> = {
+    withCustomEquality: IIsEquals<T>;
+    withReactionOnSubscribe: boolean;
+};
+type IThisStreamConfig = Partial<{
+    withReactionOnSubscribe: boolean;
+    externalDispose: IPromiseConfiguration<any>;
+}>;
+export declare class DependencyStream<T = any> implements IIteratorOwner<T> {
+    private _value;
+    private reactionPromise;
+    private abortPromise;
+    private config;
+    constructor(_value: T, config?: Partial<IAllStreamConfig<T>>);
+    private _set;
+    set value(v: T);
+    get value(): T;
+    [Symbol.asyncIterator](this: DependencyStream<T>, thisStreamConfig?: IThisStreamConfig): IStreamIterator<T>;
+    dispose(this: DependencyStream<T>): void;
+}
+export {};

package/dist/types/{core → dependency-stream}/index.d.ts

@@ -1,2 +1,4 @@
 export * from './dependency-stream';
 export * from './utils';
+export * from './integrations';
+export * from './contracts';

package/dist/types/dependency-stream/integrations/index.d.ts

@@ -0,0 +1 @@
+export * from './react';

package/dist/types/{react → dependency-stream/integrations/react}/src/use-stream.d.ts

@@ -1,4 +1,4 @@
-import { DependencyStream } from "../../core";
+import { DependencyStream } from "../../../index";
 export declare function useStream(...streams: DependencyStream[]): {
     value: Array<any> | undefined;
     dispose: () => void;

package/dist/types/dependency-stream/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { once } from "./once";
+export { raceStream } from "./race.stream";

package/dist/types/dependency-stream/utils/once.d.ts

@@ -0,0 +1,9 @@
+import { DependencyStream } from "../dependency-stream";
+export declare function once(dep: DependencyStream): {
+    [Symbol.asyncIterator](): {
+        next: () => Promise<IteratorYieldResult<any> | IteratorReturnResult<void> | {
+            done: boolean;
+        }>;
+    };
+    dispose: () => void;
+};

package/dist/types/dependency-stream/utils/race.stream.d.ts

@@ -0,0 +1,12 @@
+import { DependencyStream } from "../dependency-stream";
+import { symAI } from "../../constants";
+export declare function raceStream<TArray extends DependencyStream[]>(...deps: NoInfer<TArray>): {
+    dispose: () => void;
+    readonly isDisposed: boolean;
+    [Symbol.asyncIterator](): {
+        next: () => Promise<IteratorReturnResult<void> | {
+            done: boolean;
+            value: any[];
+        }>;
+    };
+};

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
-export * from './core';
-export * from './react';
-export * from './utils';
+export * from './dependency-stream';
+export * from './dependency-stream/integrations/react';
+export * from './delay';
+export * from './get-promise';

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@fbltd/async",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Miscellaneous async utils",
+  "homepage": "https://github.com/GlennMiller1991/async",
   "keywords": [
     "Reactivity",
     "State Management",
@@ -22,7 +23,7 @@
     "clearDist": "rm dist -rf || true",
     "clearModules": "rm node_modules -rf || true",
     "clearAll": "npm run clearDist && npm run clearModules",
-    "build": "cd src/react && npm run build && cd ../../ && npm run clearAll && npm i && mkdir dist && tsc",
+    "build": "cd src/dependency-stream/integrations/react && npm run build && cd ../../../../ && npm run clearAll && npm i && mkdir dist && tsc",
     "test": "jest --config=./__tests__/jest.config.js",
     "postVersionCommit": "git commit -m='post version commit' || true",
     "postVersionPush": "git push || true",

package/dist/bin/core/utils.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stream = stream;
-exports.once = once;
-exports.anyStream = anyStream;
-function stream(dep) {
-    return dep[Symbol.asyncIterator]();
-}
-function once(dep) {
-    let isIterationWas = false;
-    const iterator = dep[Symbol.asyncIterator]();
-    return {
-        [Symbol.asyncIterator]() {
-            return {
-                next: async () => {
-                    if (isIterationWas)
-                        return { done: true };
-                    return iterator.next();
-                }
-            };
-        },
-        dispose: iterator.dispose,
-    };
-}
-function anyStream(...deps) {
-    const streams = deps.map((dep) => stream(dep));
-    let disposed = false;
-    return {
-        dispose: () => {
-            streams.map(s => s.dispose());
-            disposed = true;
-        },
-        [Symbol.asyncIterator]() {
-            return {
-                next: async () => {
-                    await Promise.race(streams.map(s => s.next()));
-                    if (disposed) {
-                        return { done: true };
-                    }
-                    return { done: false, value: streams.map(s => s.owner.value) };
-                }
-            };
-        }
-    };
-}

package/dist/types/core/dependency-stream.d.ts

@@ -1,30 +0,0 @@
-interface IIsEquals<T> {
-    (prev: T, cur: T): boolean;
-}
-type IDependencyStreamConfig<T> = {
-    withCustomEquality: IIsEquals<T>;
-    withReactionOnSubscribe: boolean;
-};
-export declare class DependencyStream<T = any> {
-    private _value;
-    private reactionPromise;
-    private abortPromise;
-    private config;
-    constructor(_value: T, config?: Partial<IDependencyStreamConfig<T>>);
-    private _set;
-    set value(v: T);
-    get value(): T;
-    [Symbol.asyncIterator](this: DependencyStream<T>): {
-        owner: DependencyStream<T>;
-        dispose: () => void;
-        next: () => Promise<{
-            done: boolean;
-            readonly value?: undefined;
-        } | {
-            done: boolean;
-            readonly value: T;
-        }>;
-    };
-    dispose(this: DependencyStream<T>): void;
-}
-export {};

package/dist/types/core/utils.d.ts

@@ -1,35 +0,0 @@
-import { DependencyStream } from "./dependency-stream";
-export declare function stream(dep: DependencyStream): {
-    owner: DependencyStream<any>;
-    dispose: () => void;
-    next: () => Promise<{
-        done: boolean;
-        readonly value?: undefined;
-    } | {
-        done: boolean;
-        readonly value: any;
-    }>;
-};
-export declare function once(dep: DependencyStream): {
-    [Symbol.asyncIterator](): {
-        next: () => Promise<{
-            done: boolean;
-            readonly value: any;
-        } | {
-            done: boolean;
-        }>;
-    };
-    dispose: () => void;
-};
-export declare function anyStream(...deps: DependencyStream[]): {
-    dispose: () => void;
-    [Symbol.asyncIterator](): {
-        next: () => Promise<{
-            done: boolean;
-            readonly value?: undefined;
-        } | {
-            done: boolean;
-            value: any[];
-        }>;
-    };
-};

package/dist/types/utils/delay.d.ts

@@ -1,2 +0,0 @@
-export declare function delay(ms: number, sync: true): void;
-export declare function delay(ms?: number): Promise<void>;

package/dist/types/utils/index.d.ts

@@ -1 +0,0 @@
-export * from './get-promise';