gingersnap 0.23.2 → 0.23.4

package/data-structures/object/Publisher.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+class Publisher {
+    constructor(queue, transformer) {
+        this.queue = queue;
+        this.transformer = transformer;
+    }
+    send(value) {
+        this.queue.enqueue(this.transformer(value));
+    }
+    publish(value) {
+        this.send(value);
+    }
+}
+
+exports.Publisher = Publisher;

package/data-structures/object/Publisher.d.ts

@@ -0,0 +1,8 @@
+import { Queue } from "./Queue";
+export declare class Publisher<T, K> {
+    private readonly queue;
+    private readonly transformer;
+    constructor(queue: Queue<T>, transformer: (v: K) => T);
+    send(value: K): void;
+    publish(value: K): void;
+}

package/data-structures/object/Publisher.mjs

@@ -0,0 +1,14 @@
+class Publisher {
+    constructor(queue, transformer) {
+        this.queue = queue;
+        this.transformer = transformer;
+    }
+    send(value) {
+        this.queue.enqueue(this.transformer(value));
+    }
+    publish(value) {
+        this.send(value);
+    }
+}
+
+export { Publisher };

package/data-structures/object/Queue.cjs

@@ -9,6 +9,7 @@ var synchronize = require('../../synchronize.cjs');
 var stream = require('../../stream.cjs');
 var QueueFullError = require('../../errors/QueueFullError.cjs');
 var ValueDestroyedError = require('../../errors/ValueDestroyedError.cjs');
+var Publisher = require('./Publisher.cjs');
 
 /**
  * Queue data structure for First In First Out operation (FIFO)
@@ -25,6 +26,9 @@ class Queue extends WatchableObject.WatchableObject {
     get streamEntries() {
         return stream.Stream.of(this.asyncIterator);
     }
+    createPublisher(transformer) {
+        return new Publisher.Publisher(this, transformer);
+    }
     close() {
         this.closed = true;
         this.closedSignal.dispatchEvent(new CustomEvent("abort"));
@@ -49,6 +53,9 @@ class Queue extends WatchableObject.WatchableObject {
         this.set(this.tail, value);
         this.tail++;
     }
+    add(value) {
+        this.enqueue(value);
+    }
     awaitEnqueue(value) {
         return future.Future.of((resolve, reject, signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
             while (this.objectMaxSize && this.size() >= this.objectMaxSize) {

package/data-structures/object/Queue.d.ts

@@ -1,6 +1,7 @@
 import { WatchableObject } from "./WatchableObject";
 import { Future, WaitPeriod } from "../../future";
 import { Stream } from "../../stream";
+import { Publisher } from "./Publisher";
 /**
  * Queue data structure for First In First Out operation (FIFO)
  */
@@ -12,10 +13,12 @@ export declare class Queue<T> extends WatchableObject<number, T> implements Iter
     private readonly dequeueEvt;
     constructor(objectMaxSize?: number, expiryPeriod?: WaitPeriod);
     get streamEntries(): Stream<T>;
+    createPublisher<K>(transformer: (v: K) => T): Publisher<T, K>;
     close(): void;
     clone(): Queue<T>;
     ingest(stream: Stream<T>): Future<void>;
     enqueue(value: T): void;
+    add(value: T): void;
     awaitEnqueue(value: T): Future<void>;
     dequeue(): T;
     awaitDequeue(abortSignal?: AbortSignal): Future<T>;

package/data-structures/object/Queue.mjs

@@ -7,6 +7,7 @@ import { FutureEvent } from '../../synchronize.mjs';
 import { Stream } from '../../stream.mjs';
 import { QueueFullError } from '../../errors/QueueFullError.mjs';
 import { ValueDestroyedError } from '../../errors/ValueDestroyedError.mjs';
+import { Publisher } from './Publisher.mjs';
 
 /**
  * Queue data structure for First In First Out operation (FIFO)
@@ -23,6 +24,9 @@ class Queue extends WatchableObject {
     get streamEntries() {
         return Stream.of(this.asyncIterator);
     }
+    createPublisher(transformer) {
+        return new Publisher(this, transformer);
+    }
     close() {
         this.closed = true;
         this.closedSignal.dispatchEvent(new CustomEvent("abort"));
@@ -47,6 +51,9 @@ class Queue extends WatchableObject {
         this.set(this.tail, value);
         this.tail++;
     }
+    add(value) {
+        this.enqueue(value);
+    }
     awaitEnqueue(value) {
         return Future.of((resolve, reject, signal) => __awaiter(this, void 0, void 0, function* () {
             while (this.objectMaxSize && this.size() >= this.objectMaxSize) {

package/package.json

@@ -1 +1 @@
-{"name":"gingersnap","version":"0.23.2","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/value":{"import":{"types":"./data/value.d.ts","default":"./data/value.mjs"},"require":{"types":"./data/value.d.ts","default":"./data/value.cjs"}},"./store":{"import":{"types":"./store/index.d.ts","default":"./store.mjs"},"require":{"types":"./store/index.d.ts","default":"./store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}
+{"name":"gingersnap","version":"0.23.4","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/value":{"import":{"types":"./data/value.d.ts","default":"./data/value.mjs"},"require":{"types":"./data/value.d.ts","default":"./data/value.cjs"}},"./store":{"import":{"types":"./store/index.d.ts","default":"./store.mjs"},"require":{"types":"./store/index.d.ts","default":"./store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}

package/stream/index.d.ts

@@ -33,6 +33,8 @@ export declare class Stream<T> implements AsyncGenerator<T> {
     protected cancelHooks: Set<() => any>;
     protected completionHooks: Set<() => any>;
     protected completionHookInvoked: boolean;
+    protected monitorHooks: Set<(v: T) => void>;
+    private frozen;
     protected done: boolean;
     protected backlog: Array<{
         records: T[] | Stream<T>;
@@ -92,6 +94,29 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      */
     get future(): Future<T>;
     get readableStream(): ReadableStream<T>;
+    /**
+     * Breaks up a stream into 2 other streams based on the callback result. If callback result is true, data will go to
+     * the first stream, otherwise it will go to the second stream. Note that splitting the stream will immediately invoke
+     * the parent stream if it's not already running
+     *
+     * Important Note! This will freeze the parent stream (this means you cannot add additional transformers to the parent
+     * stream)
+     * @param callback
+     */
+    split(callback: (v: T) => boolean | Promise<boolean> | Future<boolean>): [Stream<T>, Stream<T>];
+    /**
+     * Creates a new branch from the main stream, that monitors and collects values that matches the filter specified.
+     * Note, this does not trigger the main stream to run nor does it alter the main stream. It only collects matched
+     * records from main stream once main stream is running.
+     *
+     * Important Note! This will freeze the parent stream (this means you cannot add additional transformers to the parent
+     * stream)
+     * @param filter
+     * @param objectMaxSize max records to keep in queue, provided you start reading from this stream slower than data is
+     * being collected from main stream
+     * @param expiryPeriod
+     */
+    subStream(filter: (v: T) => boolean | Promise<boolean> | Future<boolean>, objectMaxSize?: number, expiryPeriod?: WaitPeriod): Stream<T>;
     /**
      * Cancel the stream on the given signal
      * @param signal
@@ -263,5 +288,6 @@ export declare class Stream<T> implements AsyncGenerator<T> {
     private yieldTrueResult;
     private forwardExecute;
     private collectResult;
+    private get canAlterStream();
 }
 export {};

package/stream.cjs

@@ -68,6 +68,8 @@ class Stream {
         this.completionHookInvoked = false;
         this.runLock = new synchronize.Lock();
         this.concurrencyLimit = 0;
+        this.monitorHooks = new Set();
+        this.frozen = false;
     }
     /**
      * Used to provide setup logic that should only be invoked once, when stream
@@ -245,6 +247,66 @@ class Stream {
             },
         });
     }
+    /**
+     * Breaks up a stream into 2 other streams based on the callback result. If callback result is true, data will go to
+     * the first stream, otherwise it will go to the second stream. Note that splitting the stream will immediately invoke
+     * the parent stream if it's not already running
+     *
+     * Important Note! This will freeze the parent stream (this means you cannot add additional transformers to the parent
+     * stream)
+     * @param callback
+     */
+    split(callback) {
+        this.frozen = true;
+        const queue1 = new Queue.Queue();
+        const queue2 = new Queue.Queue();
+        let canWrite1 = true;
+        let canWrite2 = true;
+        const future = this.forEach((v) => {
+            if (callback(v)) {
+                if (canWrite1) {
+                    queue1.enqueue(v);
+                }
+            }
+            else {
+                if (canWrite2) {
+                    queue2.enqueue(v);
+                }
+            }
+            if (!canWrite1 && !canWrite2) {
+                future.cancel();
+            }
+        });
+        return [
+            queue1.streamEntries.onCancellation(() => {
+                canWrite1 = false;
+            }),
+            queue2.streamEntries.onCancellation(() => {
+                canWrite2 = false;
+            }),
+        ];
+    }
+    /**
+     * Creates a new branch from the main stream, that monitors and collects values that matches the filter specified.
+     * Note, this does not trigger the main stream to run nor does it alter the main stream. It only collects matched
+     * records from main stream once main stream is running.
+     *
+     * Important Note! This will freeze the parent stream (this means you cannot add additional transformers to the parent
+     * stream)
+     * @param filter
+     * @param objectMaxSize max records to keep in queue, provided you start reading from this stream slower than data is
+     * being collected from main stream
+     * @param expiryPeriod
+     */
+    subStream(filter, objectMaxSize, expiryPeriod) {
+        this.frozen = true;
+        const queue = new Queue.Queue(objectMaxSize, expiryPeriod);
+        this.monitorHooks.add((v) => {
+            if (filter(v))
+                queue.enqueue(v);
+        });
+        return queue.streamEntries;
+    }
     /**
      * Cancel the stream on the given signal
      * @param signal
@@ -304,6 +366,8 @@ class Stream {
      * @param callback
      */
     map(callback) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({ type: ActionType.TRANSFORM, functor: callback });
         return this;
     }
@@ -312,6 +376,8 @@ class Stream {
      * @param callback
      */
     filter(callback) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({
             type: ActionType.FILTER,
             functor: (v) => _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -328,6 +394,8 @@ class Stream {
         return this;
     }
     reduce(initialData, functor, exhaustive = true) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         let previousData = initialData;
         if (exhaustive) {
             this.actions.push({
@@ -353,6 +421,8 @@ class Stream {
         return this;
     }
     reduceWhile(predicate, initialData, functor, exhaustive = true) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         let previousData = initialData;
         if (exhaustive) {
             this.actions.push({
@@ -429,6 +499,8 @@ class Stream {
      * for the split criteria should be added to the chunk, if false then the data will be added to the next chunk
      */
     chunk(value, keepSplitCriteria = false) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         if (typeof value === "number" && value < 1)
             throw new Error("Invalid chunk size");
         let chunkedResults = [];
@@ -535,6 +607,8 @@ class Stream {
      * @param count
      */
     take(count) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         let index = 0;
         this.actions.push({
             type: ActionType.LIMIT,
@@ -552,6 +626,8 @@ class Stream {
      * @param predicate
      */
     takeWhile(predicate) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({
             type: ActionType.LIMIT,
             functor: (value) => {
@@ -568,6 +644,8 @@ class Stream {
      * @param predicate
      */
     skipWhile(predicate) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         let startFound = false;
         this.actions.push({
             type: ActionType.FILTER,
@@ -587,6 +665,8 @@ class Stream {
      * @param expiryPeriod
      */
     dropRepeats(uniqKeyExtractor, expiryPeriod = undefined) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         const cache = new TimeableObject.TimeableObject(undefined, expiryPeriod);
         this.actions.push({
             type: ActionType.FILTER,
@@ -612,6 +692,8 @@ class Stream {
      * @param count
      */
     skip(count) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         let index = 1;
         this.actions.push({
             type: ActionType.FILTER,
@@ -629,6 +711,8 @@ class Stream {
      * @param period
      */
     throttleBy(period) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         let future$1;
         this.actions.push({
             type: ActionType.TRANSFORM,
@@ -648,6 +732,8 @@ class Stream {
      * Flattens any nested structure from the data arriving on the stream
      */
     flatten() {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({
             type: ActionType.UNPACK,
             functor: (value) => {
@@ -804,6 +890,9 @@ class Stream {
                 const { state, value } = yield (this.sourceStream && this.concurrencyLimit
                     ? this.forwardExecute().registerSignal(signal)
                     : this.__execute__().registerSignal(signal));
+                if (value !== null && value !== undefined) {
+                    this.monitorHooks.forEach((hook) => hook(value));
+                }
                 if (state !== exports.State.CONTINUE) {
                     this.done = true;
                     this.invokeCompletionHooks();
@@ -1023,6 +1112,9 @@ class Stream {
                     const { state, value } = yield (this.sourceStream && this.concurrencyLimit
                         ? this.forwardExecute()
                         : this.__execute__());
+                    if (value !== null && value !== undefined) {
+                        this.monitorHooks.forEach((hook) => hook(value));
+                    }
                     if (state === exports.State.MATCHED && value !== undefined)
                         return { done: false, value };
                     if (state === exports.State.DONE) {
@@ -1180,6 +1272,9 @@ class Stream {
             return resolve({ state: exports.State.CONTINUE });
         }), signal);
     }
+    get canAlterStream() {
+        return !this.frozen;
+    }
 }
 
 exports.Stream = Stream;

package/stream.mjs

@@ -47,6 +47,8 @@ class Stream {
         this.completionHookInvoked = false;
         this.runLock = new Lock();
         this.concurrencyLimit = 0;
+        this.monitorHooks = new Set();
+        this.frozen = false;
     }
     /**
      * Used to provide setup logic that should only be invoked once, when stream
@@ -224,6 +226,66 @@ class Stream {
             },
         });
     }
+    /**
+     * Breaks up a stream into 2 other streams based on the callback result. If callback result is true, data will go to
+     * the first stream, otherwise it will go to the second stream. Note that splitting the stream will immediately invoke
+     * the parent stream if it's not already running
+     *
+     * Important Note! This will freeze the parent stream (this means you cannot add additional transformers to the parent
+     * stream)
+     * @param callback
+     */
+    split(callback) {
+        this.frozen = true;
+        const queue1 = new Queue();
+        const queue2 = new Queue();
+        let canWrite1 = true;
+        let canWrite2 = true;
+        const future = this.forEach((v) => {
+            if (callback(v)) {
+                if (canWrite1) {
+                    queue1.enqueue(v);
+                }
+            }
+            else {
+                if (canWrite2) {
+                    queue2.enqueue(v);
+                }
+            }
+            if (!canWrite1 && !canWrite2) {
+                future.cancel();
+            }
+        });
+        return [
+            queue1.streamEntries.onCancellation(() => {
+                canWrite1 = false;
+            }),
+            queue2.streamEntries.onCancellation(() => {
+                canWrite2 = false;
+            }),
+        ];
+    }
+    /**
+     * Creates a new branch from the main stream, that monitors and collects values that matches the filter specified.
+     * Note, this does not trigger the main stream to run nor does it alter the main stream. It only collects matched
+     * records from main stream once main stream is running.
+     *
+     * Important Note! This will freeze the parent stream (this means you cannot add additional transformers to the parent
+     * stream)
+     * @param filter
+     * @param objectMaxSize max records to keep in queue, provided you start reading from this stream slower than data is
+     * being collected from main stream
+     * @param expiryPeriod
+     */
+    subStream(filter, objectMaxSize, expiryPeriod) {
+        this.frozen = true;
+        const queue = new Queue(objectMaxSize, expiryPeriod);
+        this.monitorHooks.add((v) => {
+            if (filter(v))
+                queue.enqueue(v);
+        });
+        return queue.streamEntries;
+    }
     /**
      * Cancel the stream on the given signal
      * @param signal
@@ -283,6 +345,8 @@ class Stream {
      * @param callback
      */
     map(callback) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({ type: ActionType.TRANSFORM, functor: callback });
         return this;
     }
@@ -291,6 +355,8 @@ class Stream {
      * @param callback
      */
     filter(callback) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({
             type: ActionType.FILTER,
             functor: (v) => __awaiter(this, void 0, void 0, function* () {
@@ -307,6 +373,8 @@ class Stream {
         return this;
     }
     reduce(initialData, functor, exhaustive = true) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         let previousData = initialData;
         if (exhaustive) {
             this.actions.push({
@@ -332,6 +400,8 @@ class Stream {
         return this;
     }
     reduceWhile(predicate, initialData, functor, exhaustive = true) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         let previousData = initialData;
         if (exhaustive) {
             this.actions.push({
@@ -408,6 +478,8 @@ class Stream {
      * for the split criteria should be added to the chunk, if false then the data will be added to the next chunk
      */
     chunk(value, keepSplitCriteria = false) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         if (typeof value === "number" && value < 1)
             throw new Error("Invalid chunk size");
         let chunkedResults = [];
@@ -514,6 +586,8 @@ class Stream {
      * @param count
      */
     take(count) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         let index = 0;
         this.actions.push({
             type: ActionType.LIMIT,
@@ -531,6 +605,8 @@ class Stream {
      * @param predicate
      */
     takeWhile(predicate) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({
             type: ActionType.LIMIT,
             functor: (value) => {
@@ -547,6 +623,8 @@ class Stream {
      * @param predicate
      */
     skipWhile(predicate) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         let startFound = false;
         this.actions.push({
             type: ActionType.FILTER,
@@ -566,6 +644,8 @@ class Stream {
      * @param expiryPeriod
      */
     dropRepeats(uniqKeyExtractor, expiryPeriod = undefined) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         const cache = new TimeableObject(undefined, expiryPeriod);
         this.actions.push({
             type: ActionType.FILTER,
@@ -591,6 +671,8 @@ class Stream {
      * @param count
      */
     skip(count) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         let index = 1;
         this.actions.push({
             type: ActionType.FILTER,
@@ -608,6 +690,8 @@ class Stream {
      * @param period
      */
     throttleBy(period) {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         let future;
         this.actions.push({
             type: ActionType.TRANSFORM,
@@ -627,6 +711,8 @@ class Stream {
      * Flattens any nested structure from the data arriving on the stream
      */
     flatten() {
+        if (!this.canAlterStream)
+            throw new IllegalOperationError("Cannot alter the stream as it is frozen");
         this.actions.push({
             type: ActionType.UNPACK,
             functor: (value) => {
@@ -783,6 +869,9 @@ class Stream {
                 const { state, value } = yield (this.sourceStream && this.concurrencyLimit
                     ? this.forwardExecute().registerSignal(signal)
                     : this.__execute__().registerSignal(signal));
+                if (value !== null && value !== undefined) {
+                    this.monitorHooks.forEach((hook) => hook(value));
+                }
                 if (state !== State.CONTINUE) {
                     this.done = true;
                     this.invokeCompletionHooks();
@@ -1002,6 +1091,9 @@ class Stream {
                     const { state, value } = yield (this.sourceStream && this.concurrencyLimit
                         ? this.forwardExecute()
                         : this.__execute__());
+                    if (value !== null && value !== undefined) {
+                        this.monitorHooks.forEach((hook) => hook(value));
+                    }
                     if (state === State.MATCHED && value !== undefined)
                         return { done: false, value };
                     if (state === State.DONE) {
@@ -1159,6 +1251,9 @@ class Stream {
             return resolve({ state: State.CONTINUE });
         }), signal);
     }
+    get canAlterStream() {
+        return !this.frozen;
+    }
 }
 
 export { State, Stream };

package/README.md

@@ -1,25 +0,0 @@
-## GingerSnap
-
-
-## Description
-Gingersnap is a general purpose library built with the aim of filling the gaps of javascript shortcomings. First-Class support for networking, IO operations and data validation is at the core of this library.
-
-## Installation
-To install the package, run `npm install gingersnap`
-
-## Roadmap
-- Support request timeout
-- Opt out of using an authenticator for a method's request
-- Support multiple authenticators, and setting Primary authenticator
-- Allow methods to choose authenticator
-- Support endpoint polling with subscription methods
-- Support offline mode with resume feature once net is back
-- Support default response when offline
-- Support grouping requests, if one fail cancel all
-- Support race requests, the first one that finishes/fails cancel all others and return the response
-- Plugin support for services
-- Support for NodeJs
-- Push message support via subscribers
-- Websocket support via subscribers, and methods for sending messages
-- Websocket auth support
-- Improved documentation