gingersnap 0.23.0 → 0.23.2

package/README.md

@@ -0,0 +1,25 @@
+## 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

package/errors/TimeoutError.cjs

@@ -1,11 +1,9 @@
 'use strict';
 
-var FutureCancelled = require('./FutureCancelled.cjs');
-
 /**
  * Thrown to indicate that some timed operation has exceeded the maximum duration
  */
-class TimeoutError extends FutureCancelled.FutureCancelled {
+class TimeoutError extends Error {
 }
 
 exports.TimeoutError = TimeoutError;

package/errors/TimeoutError.d.ts

@@ -1,6 +1,5 @@
-import { FutureCancelled } from "./FutureCancelled";
 /**
  * Thrown to indicate that some timed operation has exceeded the maximum duration
  */
-export declare class TimeoutError extends FutureCancelled {
+export declare class TimeoutError extends Error {
 }

package/errors/TimeoutError.mjs

@@ -1,9 +1,7 @@
-import { FutureCancelled } from './FutureCancelled.mjs';
-
 /**
  * Thrown to indicate that some timed operation has exceeded the maximum duration
  */
-class TimeoutError extends FutureCancelled {
+class TimeoutError extends Error {
 }
 
 export { TimeoutError };

package/future/future.cjs

@@ -91,7 +91,7 @@ class Future {
         const timeableFuture = Future.sleep(timeout)
             .registerSignal(value.defaultSignal)
             .catch(() => { });
-        return Future.of((resolve, reject) => Promise.race([timeableFuture, value.run()])
+        return Future.of((resolve, reject) => Promise.race([timeableFuture, value])
             .then((v) => {
             if (value.done) {
                 timeableFuture.cancel();
@@ -130,19 +130,28 @@ class Future {
      * @param value
      */
     static completed(value) {
-        return new Future((resolve) => resolve(value));
+        const future = new Future(() => { });
+        future.underLyingPromise = Promise.resolve(value);
+        future.completedResult = value;
+        future.fulfilled = true;
+        future.isRunning = false;
+        return future;
     }
     /**
      * Returns a future that fails with the given value
      * @param value
      */
     static exceptionally(value) {
-        return new Future((_, reject) => reject(value));
+        const future = new Future(() => { });
+        future.isRunning = false;
+        future.failureResult = value;
+        future.underLyingPromise = Promise.reject(value);
+        return future;
     }
     /**
      * Returns the first completed or failed. If this is cancelled, then all futures provided will also be cancelled
      * @param futures list of futures
-     * @param signal optinal abort signal
+     * @param signal optional abort signal
      */
     static firstCompleted(futures, signal) {
         return Future.of((resolve, reject, signal) => {
@@ -243,7 +252,7 @@ class Future {
      * Checks if the future failed
      */
     get failed() {
-        return this.error instanceof Error;
+        return this.error !== undefined && this.error instanceof Error;
     }
     /**
      * Retrieves the result of the future, if there is any
@@ -327,7 +336,7 @@ class Future {
             this.signals.forEach((signal) => newFuture.registerSignal(signal));
             return newFuture;
         }
-        else if (this.done) {
+        else if (this.done || this.failed) {
             const newFuture = Future.wrap(this.underLyingPromise).thenApply(callback);
             return newFuture;
         }
@@ -438,24 +447,20 @@ class Future {
             const resolver = (v) => {
                 if (v instanceof Promise) {
                     v.then((v) => {
-                        this.fulfilled = true;
                         resolve(v);
                     }).catch(reject);
                 }
                 else if (v instanceof Future) {
                     v.run()
                         .then((v) => {
-                        this.fulfilled = true;
                         resolve(v);
                     })
                         .catch(reject);
                 }
                 else if (v instanceof result.FutureResult) {
-                    this.fulfilled = true;
                     resolve(v.value);
                 }
                 else {
-                    this.fulfilled = true;
                     resolve(v);
                 }
             };
@@ -482,7 +487,6 @@ class Future {
                 result$1
                     .then(() => {
                     if (!this.fulfilled) {
-                        this.fulfilled = true;
                         resolve(null);
                     }
                 })
@@ -492,10 +496,13 @@ class Future {
             .then((v) => {
             this.completedResult = v;
             onFulfilled === null || onFulfilled === void 0 ? void 0 : onFulfilled(v);
+            this.isRunning = false;
+            this.fulfilled = true;
             return v;
         })
             .catch((e) => {
             this.failureResult = e instanceof Error ? e : new Error(String(e));
+            this.isRunning = false;
             throw this.failureResult;
         })
             .finally(() => {
@@ -508,7 +515,6 @@ class Future {
         })
             .finally(() => {
             this.signals = new Set();
-            this.isRunning = false;
         });
         return this.underLyingPromise;
     }

package/future/future.d.ts

@@ -72,11 +72,11 @@ export declare class Future<T> {
      * Returns a future that fails with the given value
      * @param value
      */
-    static exceptionally(value: Error): Future<unknown>;
+    static exceptionally<K>(value: Error): Future<K>;
     /**
      * Returns the first completed or failed. If this is cancelled, then all futures provided will also be cancelled
      * @param futures list of futures
-     * @param signal optinal abort signal
+     * @param signal optional abort signal
      */
     static firstCompleted<T extends Array<Future<any>>>(futures: T, signal?: AbortSignal): Future<FutureReturnType<T[number]>>;
     /**

package/future/future.mjs

@@ -70,7 +70,7 @@ class Future {
         const timeableFuture = Future.sleep(timeout)
             .registerSignal(value.defaultSignal)
             .catch(() => { });
-        return Future.of((resolve, reject) => Promise.race([timeableFuture, value.run()])
+        return Future.of((resolve, reject) => Promise.race([timeableFuture, value])
             .then((v) => {
             if (value.done) {
                 timeableFuture.cancel();
@@ -109,19 +109,28 @@ class Future {
      * @param value
      */
     static completed(value) {
-        return new Future((resolve) => resolve(value));
+        const future = new Future(() => { });
+        future.underLyingPromise = Promise.resolve(value);
+        future.completedResult = value;
+        future.fulfilled = true;
+        future.isRunning = false;
+        return future;
     }
     /**
      * Returns a future that fails with the given value
      * @param value
      */
     static exceptionally(value) {
-        return new Future((_, reject) => reject(value));
+        const future = new Future(() => { });
+        future.isRunning = false;
+        future.failureResult = value;
+        future.underLyingPromise = Promise.reject(value);
+        return future;
     }
     /**
      * Returns the first completed or failed. If this is cancelled, then all futures provided will also be cancelled
      * @param futures list of futures
-     * @param signal optinal abort signal
+     * @param signal optional abort signal
      */
     static firstCompleted(futures, signal) {
         return Future.of((resolve, reject, signal) => {
@@ -222,7 +231,7 @@ class Future {
      * Checks if the future failed
      */
     get failed() {
-        return this.error instanceof Error;
+        return this.error !== undefined && this.error instanceof Error;
     }
     /**
      * Retrieves the result of the future, if there is any
@@ -306,7 +315,7 @@ class Future {
             this.signals.forEach((signal) => newFuture.registerSignal(signal));
             return newFuture;
         }
-        else if (this.done) {
+        else if (this.done || this.failed) {
             const newFuture = Future.wrap(this.underLyingPromise).thenApply(callback);
             return newFuture;
         }
@@ -417,24 +426,20 @@ class Future {
             const resolver = (v) => {
                 if (v instanceof Promise) {
                     v.then((v) => {
-                        this.fulfilled = true;
                         resolve(v);
                     }).catch(reject);
                 }
                 else if (v instanceof Future) {
                     v.run()
                         .then((v) => {
-                        this.fulfilled = true;
                         resolve(v);
                     })
                         .catch(reject);
                 }
                 else if (v instanceof FutureResult) {
-                    this.fulfilled = true;
                     resolve(v.value);
                 }
                 else {
-                    this.fulfilled = true;
                     resolve(v);
                 }
             };
@@ -461,7 +466,6 @@ class Future {
                 result
                     .then(() => {
                     if (!this.fulfilled) {
-                        this.fulfilled = true;
                         resolve(null);
                     }
                 })
@@ -471,10 +475,13 @@ class Future {
             .then((v) => {
             this.completedResult = v;
             onFulfilled === null || onFulfilled === void 0 ? void 0 : onFulfilled(v);
+            this.isRunning = false;
+            this.fulfilled = true;
             return v;
         })
             .catch((e) => {
             this.failureResult = e instanceof Error ? e : new Error(String(e));
+            this.isRunning = false;
             throw this.failureResult;
         })
             .finally(() => {
@@ -487,7 +494,6 @@ class Future {
         })
             .finally(() => {
             this.signals = new Set();
-            this.isRunning = false;
         });
         return this.underLyingPromise;
     }

package/networking/SocketService.cjs

@@ -131,7 +131,7 @@ class WebSocketService extends NetworkService.NetworkService {
                             data = body.object();
                         }
                         data = R__namespace.set(lens, guid, data);
-                        yield this.socket.send(JSON.stringify(data));
+                        yield this.socket.sendNow(JSON.stringify(data));
                         return 1;
                     })))
                         .map(() => this.socket.streamView(R__namespace.compose(R__namespace.equals(guid), R__namespace.view(lens)), config.socketRequestReply.objectMaxSize, config.socketRequestReply.expiryPeriod))
@@ -162,13 +162,13 @@ class WebSocketService extends NetworkService.NetworkService {
                             yield this.socket.open();
                         }
                         if (body instanceof model.Model) {
-                            yield this.socket.send(body.blob());
+                            yield this.socket.sendNow(body.blob());
                         }
                         else if (body instanceof ArrayBuffer || body instanceof Blob) {
-                            yield this.socket.send(body);
+                            yield this.socket.sendNow(body);
                         }
                         else {
-                            yield this.socket.send(JSON.stringify(body));
+                            yield this.socket.sendNow(JSON.stringify(body));
                         }
                         const result = oldMethod();
                         if (result instanceof Promise) {

package/networking/SocketService.mjs

@@ -110,7 +110,7 @@ class WebSocketService extends NetworkService {
                             data = body.object();
                         }
                         data = R.set(lens, guid, data);
-                        yield this.socket.send(JSON.stringify(data));
+                        yield this.socket.sendNow(JSON.stringify(data));
                         return 1;
                     })))
                         .map(() => this.socket.streamView(R.compose(R.equals(guid), R.view(lens)), config.socketRequestReply.objectMaxSize, config.socketRequestReply.expiryPeriod))
@@ -141,13 +141,13 @@ class WebSocketService extends NetworkService {
                             yield this.socket.open();
                         }
                         if (body instanceof Model) {
-                            yield this.socket.send(body.blob());
+                            yield this.socket.sendNow(body.blob());
                         }
                         else if (body instanceof ArrayBuffer || body instanceof Blob) {
-                            yield this.socket.send(body);
+                            yield this.socket.sendNow(body);
                         }
                         else {
-                            yield this.socket.send(JSON.stringify(body));
+                            yield this.socket.sendNow(JSON.stringify(body));
                         }
                         const result = oldMethod();
                         if (result instanceof Promise) {

package/package.json

@@ -1 +1 @@
-{"name":"gingersnap","version":"0.23.0","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.d.ts","default":"./stream.mjs"},"require":{"types":"./stream.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.d.ts","default":"./networking.mjs"},"require":{"types":"./networking.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers.d.ts","default":"./managers.mjs"},"require":{"types":"./managers.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future.d.ts","default":"./future.mjs"},"require":{"types":"./future.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors.d.ts","default":"./errors.mjs"},"require":{"types":"./errors.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model.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.d.ts","default":"./store.mjs"},"require":{"types":"./store.d.ts","default":"./store.cjs"}},"./functools":{"import":{"types":"./functools.d.ts","default":"./functools.mjs"},"require":{"types":"./functools.d.ts","default":"./functools.cjs"}}}}
+{"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"}}}}

package/socket.cjs

@@ -11,6 +11,7 @@ require('ramda');
 require('uuid');
 var stream = require('./stream.cjs');
 var future = require('./future/future.cjs');
+var result = require('./future/result.cjs');
 var synchronize = require('./synchronize.cjs');
 var stream_state = require('./stream/state.cjs');
 var WebSocket = require('modern-isomorphic-ws');
@@ -155,15 +156,28 @@ class StreamableWebSocket {
         this.signal.dispatchEvent(new CustomEvent("abort"));
     }
     /**
-     * Sends data via socket
+     * Sends data via socket as soon as possible
      * @param data
      */
-    send(data) {
+    sendNow(data) {
         var _a;
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             (_a = this.getSocket()) === null || _a === void 0 ? void 0 : _a.send(data instanceof Blob ? yield data.arrayBuffer() : data);
         });
     }
+    /**
+     * Sends data via socket, awaiting socket connection if currently disconnected
+     * @param data
+     */
+    send(data) {
+        return this.open().thenApply(() => _tslib.__awaiter(this, void 0, void 0, function* () { var _a; return (_a = this.getSocket()) === null || _a === void 0 ? void 0 : _a.send(data instanceof Blob ? yield data.arrayBuffer() : data); }));
+    }
+    /**
+     * Gets a stream of messages that match the given filter provided
+     * @param lens filter function to select specific messages
+     * @param objectMaxSize max messages to buffer if reading from this stream is slower than messages coming in
+     * @param expiryPeriod how long to store buffered messages if not read
+     */
     streamView(lens, objectMaxSize, expiryPeriod) {
         const queue = new Queue.Queue(objectMaxSize, expiryPeriod);
         const tuple = Pair.pair(queue, lens);
@@ -200,6 +214,21 @@ class StreamableWebSocket {
             this.messageQueues = this.messageQueues.filter((v) => v !== queue);
         });
     }
+    with(functor) {
+        return future.Future.of((_, __, signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            const stream = this.stream().buffer(this.cacheSize);
+            yield this.open().registerSignal(signal);
+            try {
+                functor(new result.FutureResult(stream, signal));
+            }
+            finally {
+                if (!this.closed) {
+                    this.close();
+                }
+                stream.cancel();
+            }
+        })).schedule();
+    }
     addEventListener(type, functor) {
         this.socketListeners.push([type, functor]);
         if (this.socket) {

package/socket.d.ts

@@ -1,6 +1,7 @@
 import { Stream } from "./stream";
-import { Future, WaitPeriod } from "./future";
+import { Future, FutureResult, WaitPeriod } from "./future";
 import { Decoder } from "./data/decoders";
+import { ContextManager } from "./managers";
 interface WebSocketConfiguration {
     retryOnDisconnect?: boolean;
     cacheSize?: number;
@@ -11,7 +12,7 @@ interface WebSocketConfiguration {
 /**
  * Future-based web sockets
  */
-export declare class StreamableWebSocket<T> {
+export declare class StreamableWebSocket<T> implements ContextManager<Stream<T>> {
     private readonly maxReconnectAttempt;
     private readonly retryOnDisconnect;
     private openFuture?;
@@ -49,15 +50,27 @@ export declare class StreamableWebSocket<T> {
      */
     close(): void;
     /**
-     * Sends data via socket
+     * Sends data via socket as soon as possible
      * @param data
      */
-    send(data: string | ArrayBufferView | Blob | ArrayBufferLike): Promise<void>;
+    sendNow(data: string | ArrayBufferView | Blob | ArrayBufferLike): Promise<void>;
+    /**
+     * Sends data via socket, awaiting socket connection if currently disconnected
+     * @param data
+     */
+    send(data: string | ArrayBufferView | Blob | ArrayBufferLike): Future<void>;
+    /**
+     * Gets a stream of messages that match the given filter provided
+     * @param lens filter function to select specific messages
+     * @param objectMaxSize max messages to buffer if reading from this stream is slower than messages coming in
+     * @param expiryPeriod how long to store buffered messages if not read
+     */
     streamView(lens: (v: T) => boolean, objectMaxSize?: number, expiryPeriod?: WaitPeriod): Stream<T>;
     /**
      * Gets the stream for messages received via this socket
      */
     stream(): Stream<T>;
+    with(functor: (value: FutureResult<Stream<T>>) => any): Future<void>;
     private addEventListener;
     private createSocket;
     private getSocket;

package/socket.mjs

@@ -9,6 +9,7 @@ import 'ramda';
 import 'uuid';
 import { Stream } from './stream.mjs';
 import { Future } from './future/future.mjs';
+import { FutureResult } from './future/result.mjs';
 import { FutureEvent, Lock } from './synchronize.mjs';
 import { ExecutorState } from './stream/state.mjs';
 import WebSocket from 'modern-isomorphic-ws';
@@ -153,15 +154,28 @@ class StreamableWebSocket {
         this.signal.dispatchEvent(new CustomEvent("abort"));
     }
     /**
-     * Sends data via socket
+     * Sends data via socket as soon as possible
      * @param data
      */
-    send(data) {
+    sendNow(data) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             (_a = this.getSocket()) === null || _a === void 0 ? void 0 : _a.send(data instanceof Blob ? yield data.arrayBuffer() : data);
         });
     }
+    /**
+     * Sends data via socket, awaiting socket connection if currently disconnected
+     * @param data
+     */
+    send(data) {
+        return this.open().thenApply(() => __awaiter(this, void 0, void 0, function* () { var _a; return (_a = this.getSocket()) === null || _a === void 0 ? void 0 : _a.send(data instanceof Blob ? yield data.arrayBuffer() : data); }));
+    }
+    /**
+     * Gets a stream of messages that match the given filter provided
+     * @param lens filter function to select specific messages
+     * @param objectMaxSize max messages to buffer if reading from this stream is slower than messages coming in
+     * @param expiryPeriod how long to store buffered messages if not read
+     */
     streamView(lens, objectMaxSize, expiryPeriod) {
         const queue = new Queue(objectMaxSize, expiryPeriod);
         const tuple = pair(queue, lens);
@@ -198,6 +212,21 @@ class StreamableWebSocket {
             this.messageQueues = this.messageQueues.filter((v) => v !== queue);
         });
     }
+    with(functor) {
+        return Future.of((_, __, signal) => __awaiter(this, void 0, void 0, function* () {
+            const stream = this.stream().buffer(this.cacheSize);
+            yield this.open().registerSignal(signal);
+            try {
+                functor(new FutureResult(stream, signal));
+            }
+            finally {
+                if (!this.closed) {
+                    this.close();
+                }
+                stream.cancel();
+            }
+        })).schedule();
+    }
     addEventListener(type, functor) {
         this.socketListeners.push([type, functor]);
         if (this.socket) {

package/stream/index.d.ts

@@ -97,6 +97,16 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      * @param signal
      */
     cancelOnSignal(signal: AbortSignal): this;
+    /**
+     * Waits at most 'period' time for the data upstream to be received, otherwise will cancel the stream
+     * @param period
+     */
+    waitFor(period: WaitPeriod): Stream<T>;
+    /**
+     * Waits at most 'period' time for the first data upstream to be received, otherwise will cancel the stream
+     * @param period
+     */
+    waitFirstFor(period: WaitPeriod): Stream<T>;
     parallel(concurrentlyLimit?: number): Stream<T>;
     /**
      * Transforms each data on the stream using the callback provided

package/stream/observable.cjs

@@ -39,6 +39,30 @@ class Observable {
         this.publish(reqTopic, data);
         return future.Future.waitFor(this.subscribe(replyTopic, 2).future, timeout).thenApply(({ value }) => value.data);
     }
+    /**
+     * Provides a Request-Multiple-Reply model by sending data over the given topic, and
+     * stream responses from the second topic provided. If you cancel the reply stream, a cancellation message
+     * can be sent via the cancellationTopic
+     * @param reqTopic request topic
+     * @param replyTopic reply topic which will be used to form the reply stream
+     * @param data request data
+     * @param cancellationTopic topic used to send a message if the stream is cancelled
+     * @param cancellationData cancellation message
+     * @param bufferSize max reply stream message buffer size
+     * @param timeout
+     */
+    requestStream(reqTopic, replyTopic, data, cancellationTopic, cancellationData, bufferSize = 100, timeout = { seconds: 15 }) {
+        this.publish(reqTopic, data);
+        const stream = this.subscribe(replyTopic, bufferSize);
+        return stream
+            .waitFirstFor(timeout)
+            .map(({ data }) => data)
+            .onCancellation(() => {
+            if (cancellationTopic) {
+                this.publish(cancellationTopic, cancellationData);
+            }
+        });
+    }
 }
 /**
  * Provides Publisher-Subscriber service around an EventTarget

package/stream/observable.d.ts

@@ -38,6 +38,19 @@ export declare abstract class Observable<T> {
      * @param timeout how long to wait for a response, defaults to 15 seconds
      */
     request(reqTopic: string, replyTopic: string, data: T, timeout?: WaitPeriod): Future<T>;
+    /**
+     * Provides a Request-Multiple-Reply model by sending data over the given topic, and
+     * stream responses from the second topic provided. If you cancel the reply stream, a cancellation message
+     * can be sent via the cancellationTopic
+     * @param reqTopic request topic
+     * @param replyTopic reply topic which will be used to form the reply stream
+     * @param data request data
+     * @param cancellationTopic topic used to send a message if the stream is cancelled
+     * @param cancellationData cancellation message
+     * @param bufferSize max reply stream message buffer size
+     * @param timeout
+     */
+    requestStream(reqTopic: string, replyTopic: string, data: T, cancellationTopic?: string, cancellationData?: T, bufferSize?: number, timeout?: WaitPeriod): Stream<T>;
 }
 /**
  * Provides Publisher-Subscriber service around an EventTarget

package/stream/observable.mjs

@@ -37,6 +37,30 @@ class Observable {
         this.publish(reqTopic, data);
         return Future.waitFor(this.subscribe(replyTopic, 2).future, timeout).thenApply(({ value }) => value.data);
     }
+    /**
+     * Provides a Request-Multiple-Reply model by sending data over the given topic, and
+     * stream responses from the second topic provided. If you cancel the reply stream, a cancellation message
+     * can be sent via the cancellationTopic
+     * @param reqTopic request topic
+     * @param replyTopic reply topic which will be used to form the reply stream
+     * @param data request data
+     * @param cancellationTopic topic used to send a message if the stream is cancelled
+     * @param cancellationData cancellation message
+     * @param bufferSize max reply stream message buffer size
+     * @param timeout
+     */
+    requestStream(reqTopic, replyTopic, data, cancellationTopic, cancellationData, bufferSize = 100, timeout = { seconds: 15 }) {
+        this.publish(reqTopic, data);
+        const stream = this.subscribe(replyTopic, bufferSize);
+        return stream
+            .waitFirstFor(timeout)
+            .map(({ data }) => data)
+            .onCancellation(() => {
+            if (cancellationTopic) {
+                this.publish(cancellationTopic, cancellationData);
+            }
+        });
+    }
 }
 /**
  * Provides Publisher-Subscriber service around an EventTarget

package/stream.cjs

@@ -253,6 +253,38 @@ class Stream {
         signal.addEventListener("abort", () => this.cancel());
         return this;
     }
+    /**
+     * Waits at most 'period' time for the data upstream to be received, otherwise will cancel the stream
+     * @param period
+     */
+    waitFor(period) {
+        const action = () => future.Future.waitFor(this.internalNext(), period);
+        return new Stream((signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            return action()
+                .registerSignal(signal)
+                .thenApply(({ value }) => new stream_state.ExecutorState(value.done, value.value));
+        }));
+    }
+    /**
+     * Waits at most 'period' time for the first data upstream to be received, otherwise will cancel the stream
+     * @param period
+     */
+    waitFirstFor(period) {
+        let i = 0;
+        const actions = [
+            () => future.Future.waitFor(this.internalNext(), period).thenApply(({ value }) => {
+                i = 1;
+                return value;
+            }),
+            () => this.internalNext(),
+        ];
+        return new Stream((signal) => _tslib.__awaiter(this, void 0, void 0, function* () {
+            const action = actions[i];
+            return action()
+                .registerSignal(signal)
+                .thenApply(({ value }) => new stream_state.ExecutorState(value.done, value.value));
+        }));
+    }
     parallel(concurrentlyLimit = 3) {
         if (concurrentlyLimit < 1) {
             throw new IllegalOperationError.IllegalOperationError("Cannot start parallel stream less than 2");

package/stream.mjs

@@ -232,6 +232,38 @@ class Stream {
         signal.addEventListener("abort", () => this.cancel());
         return this;
     }
+    /**
+     * Waits at most 'period' time for the data upstream to be received, otherwise will cancel the stream
+     * @param period
+     */
+    waitFor(period) {
+        const action = () => Future.waitFor(this.internalNext(), period);
+        return new Stream((signal) => __awaiter(this, void 0, void 0, function* () {
+            return action()
+                .registerSignal(signal)
+                .thenApply(({ value }) => new ExecutorState(value.done, value.value));
+        }));
+    }
+    /**
+     * Waits at most 'period' time for the first data upstream to be received, otherwise will cancel the stream
+     * @param period
+     */
+    waitFirstFor(period) {
+        let i = 0;
+        const actions = [
+            () => Future.waitFor(this.internalNext(), period).thenApply(({ value }) => {
+                i = 1;
+                return value;
+            }),
+            () => this.internalNext(),
+        ];
+        return new Stream((signal) => __awaiter(this, void 0, void 0, function* () {
+            const action = actions[i];
+            return action()
+                .registerSignal(signal)
+                .thenApply(({ value }) => new ExecutorState(value.done, value.value));
+        }));
+    }
     parallel(concurrentlyLimit = 3) {
         if (concurrentlyLimit < 1) {
             throw new IllegalOperationError("Cannot start parallel stream less than 2");