@stack-spot/portal-network 0.39.2 → 0.40.0

package/dist/utils/StreamedJson.js

@@ -0,0 +1,162 @@
+import { CompletablePromise } from '@stack-spot/opa';
+import { StreamCanceledError } from '../error/StreamCanceledError.js';
+import { StreamError } from '../error/StreamError.js';
+import { StreamJsonError } from '../error/StreamJsonError.js';
+/**
+ * An object represented by a JSON stream. This can be watched as the stream runs.
+ */
+export class StreamedJson {
+    /**
+     * @param response the fetch response.
+     * @param minChangeIntervalMS a stream can be too fast. This sets a minimum interval between running the listeners. The default is 50ms.
+     */
+    constructor(eventsPromise, abortController, minChangeIntervalMS = 50) {
+        Object.defineProperty(this, "onChangeListeners", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "error", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        Object.defineProperty(this, "fullPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new CompletablePromise()
+        });
+        Object.defineProperty(this, "abortController", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.abortController = abortController;
+        this.run(eventsPromise, minChangeIntervalMS);
+    }
+    async run(eventsPromise, minChangeIntervalMS) {
+        let lastChangeCall = 0;
+        try {
+            const events = await eventsPromise;
+            let flushed = true;
+            for await (const event of events) {
+                if (this.error)
+                    return;
+                if (event.data) {
+                    const json = JSON.parse(event.data);
+                    StreamedJson.merge(json, this.data);
+                    if (new Date().getTime() - lastChangeCall >= minChangeIntervalMS) {
+                        this.onChangeListeners.forEach(l => l(this.data));
+                        lastChangeCall = new Date().getTime();
+                        flushed = true;
+                    }
+                    else {
+                        flushed = false;
+                    }
+                }
+            }
+            if (!flushed)
+                this.onChangeListeners.forEach(l => l(this.data));
+        }
+        catch (error) {
+            if (error instanceof DOMException && error.name === 'AbortError')
+                this.fail(new StreamCanceledError());
+            if (error instanceof SyntaxError)
+                this.fail(new StreamJsonError());
+            else if (error instanceof StreamError)
+                this.fail(error);
+            else
+                this.fail(new StreamError(error?.message || `${error}`));
+        }
+        if (!this.error)
+            this.complete();
+    }
+    static merge(source, target) {
+        Object.keys(source).forEach((k) => {
+            if (typeof source[k] !== typeof target[k])
+                target[k] = source[k];
+            else if (typeof source[k] === 'string')
+                target[k] += source[k];
+            else if (Array.isArray(source[k]))
+                target[k].push(...source[k]);
+            else if (typeof source[k] === 'number')
+                parseFloat(target[k] + source[k]);
+            else if (typeof source[k] === 'object')
+                this.merge(source[k], target[k]);
+            else
+                target[k] = source[k];
+        });
+    }
+    clear() {
+        this.onChangeListeners = [];
+        this.abortController = undefined;
+    }
+    fail(error) {
+        this.error = error;
+        this.fullPromise.reject(this.error);
+        this.clear();
+    }
+    complete() {
+        this.fullPromise.resolve(this.data);
+        this.clear();
+    }
+    /**
+     * Returns the full value of the object once the stream finishes.
+     */
+    getValue() {
+        return this.fullPromise.promise;
+    }
+    /**
+     * Returns the streamed object with everything already streamed. This will be the complete object if the stream has finished.
+     */
+    getPartialValue() {
+        return this.data;
+    }
+    /**
+     * Watches the object as it's streamed. This doesn't wait for the value to be complete.
+     *
+     * The listener is called whenever the value changes.
+     *
+     * @param listener the function to call with the new value.
+     * @returns a function that, when called, removes the listener.
+     */
+    onChange(listener) {
+        if (this.fullPromise.resolved) {
+            listener(this.data);
+            return () => { };
+        }
+        this.onChangeListeners.push(listener);
+        return () => {
+            const index = this.onChangeListeners?.findIndex(l => l === listener);
+            if (index !== undefined && index >= 0)
+                this.onChangeListeners?.splice(index, 1);
+        };
+    }
+    getStatus() {
+        if (this.error)
+            return 'error';
+        if (this.fullPromise.resolved)
+            return 'success';
+        return 'pending';
+    }
+    getError() {
+        return this.error;
+    }
+    /**
+     * If this is a stream and it's not yet finished, calling this function cancels the stream.
+     */
+    cancel() {
+        this.abortController?.abort(new StreamCanceledError());
+    }
+}
+//# sourceMappingURL=StreamedJson.js.map

package/dist/utils/StreamedJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamedJson.js","sourceRoot":"","sources":["../../src/utils/StreamedJson.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAM1D;;GAEG;AACH,MAAM,OAAO,YAAY;IAOvB;;;OAGG;IACH,YAAY,aAAwC,EAAE,eAAgC,EAAE,mBAAmB,GAAG,EAAE;QAVxG;;;;mBAA2C,EAAE;WAAA;QAC7C;;;;;WAA8B;QAC9B;;;;mBAAmB,EAAE;WAAA;QACrB;;;;mBAAc,IAAI,kBAAkB,EAAK;WAAA;QACzC;;;;;WAA4C;QAOlD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAA;IAC9C,CAAC;IAEO,KAAK,CAAC,GAAG,CAAC,aAAwC,EAAE,mBAA2B;QACrF,IAAI,cAAc,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,aAAa,CAAA;YAClC,IAAI,OAAO,GAAG,IAAI,CAAA;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBACjC,IAAI,IAAI,CAAC,KAAK;oBAAE,OAAM;gBACtB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;oBACf,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;oBACnC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;oBACnC,IAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,cAAc,IAAI,mBAAmB,EAAE,CAAC;wBACjE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;wBACjD,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;wBACrC,OAAO,GAAG,IAAI,CAAA;oBAChB,CAAC;yBAAM,CAAC;wBACN,OAAO,GAAG,KAAK,CAAA;oBACjB,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACjE,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;gBAAE,IAAI,CAAC,IAAI,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAA;YACtG,IAAI,KAAK,YAAY,WAAW;gBAAE,IAAI,CAAC,IAAI,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;iBAC7D,IAAI,KAAK,YAAY,WAAW;gBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;;gBAClD,IAAI,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,QAAQ,EAAE,CAAA;IAClC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,MAA2B,EAAE,MAA2B;QAC3E,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAChC,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;gBAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;iBAC3D,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ;gBAAE,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAA;iBACzD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;iBAC1D,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ;gBAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;iBACpE,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ;gBAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;;gBACnE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAA;QAC3B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAA;IAClC,CAAC;IAEO,IAAI,CAAC,KAAU;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnC,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAEO,QAAQ;QACd,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,IAAS,CAAC,CAAA;QACxC,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAA;IACjC,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAqC;QAC5C,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACnB,OAAO,GAAG,EAAE,GAAE,CAAC,CAAA;QACjB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACrC,OAAO,GAAG,EAAE;YACV,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;YACpE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,IAAI,CAAC;gBAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACjF,CAAC,CAAA;IACH,CAAC;IAED,SAAS;QACP,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,OAAO,CAAA;QAC9B,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAA;QAC/C,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAA;IACxD,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stack-spot/portal-network",
-  "version": "0.39.2",
+  "version": "0.40.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -53,6 +53,7 @@
   },
   "dependencies": {
     "@oazapfts/runtime": "^1.0.3",
+    "fetch-event-stream": "^0.1.5",
     "lodash": "^4.17.21"
   }
 }