elbe-ui 1.0.3 → 1.0.5

package/dist/bit/_bit_provider.js

@@ -16,6 +16,7 @@ function _LoadView({}) {
 }
 export function _makeBitProvider(context, bitP) {
     function _BitProvider(p) {
+        const [streamCancel, setStreamCancel] = useState(null);
         const [state, setState] = useState({
             v: { type: "loading" },
             history: [],
@@ -74,7 +75,24 @@ export function _makeBitProvider(context, bitP) {
                     }
                 });
             }
-            const _reload = (silent) => _worker(() => bitP.worker(p), silent);
+            const _reload = (silent) => {
+                const _bit = bitP;
+                if (_bit.stream) {
+                    try {
+                        if (!silent)
+                            _partCtrl.setLoading();
+                        if (streamCancel)
+                            streamCancel();
+                        const cancel = _bit.stream(p, _partCtrl);
+                        setStreamCancel(() => cancel);
+                        return;
+                    }
+                    catch (e) {
+                        _partCtrl.setError(e);
+                    }
+                }
+                _worker(() => _bit.worker(p), silent);
+            };
             function act(fn, silent) {
                 return __awaiter(this, void 0, void 0, function* () {
                     const data = _partCtrl.data;
@@ -112,6 +130,20 @@ export function _makeBitProvider(context, bitP) {
         const ctrl = useMemo(() => _make(), [state]);
         useEffect(() => {
             ctrl.reload(true);
+            return () => {
+                if (streamCancel)
+                    streamCancel();
+                // call dispose if exists
+                const d = ctrl.dispose;
+                if (typeof d !== "function")
+                    return;
+                try {
+                    d();
+                }
+                catch (_a) {
+                    // ignore errors during dispose
+                }
+            };
         }, []);
         // ========== DEFINE THE JSX ELEMENT ==========
         return _jsx(context.Provider, { value: ctrl, children: p.children });

package/dist/bit/bit.d.ts

@@ -1,6 +1,6 @@
 import { Context } from "react";
 import { Maybe, PromiseOr } from "..";
-import { _BitCtrlMaker, _BitData, _BitGetInterface, _BitInterface } from "./_bit_utils";
+import { _BitCtrlInput, _BitCtrlMaker, _BitData, _BitGetInterface, _BitInterface } from "./_bit_utils";
 export type BitStates = "loading" | "error" | "data";
 export type BitContext<D> = Context<_BitData<D> | null>;
 export type BitTriMap<T, D> = {
@@ -14,7 +14,16 @@ export type BitUseInterface<D, P, I> = _BitGetInterface<D> & I & {
 export type BitParams<D, P, I> = {
     control?: _BitCtrlMaker<D, P, I>;
     debugLabel?: Maybe<string>;
-    worker: (params: P) => PromiseOr<D>;
+    /** the value will not be used allows Typescript to infer the data type.
+     *
+     * So, pass a value like this:
+     * `dataTypeHint: null as any as {[key: string]: number}`
+     */
+    dataTypeHint?: D;
     useHistory?: boolean;
-};
+} & ({
+    worker: (params: P) => PromiseOr<D>;
+} | {
+    stream: (params: P, ctrl: _BitCtrlInput<D, P>) => () => void;
+});
 export declare function createBit<D, P extends Object, I>({ control, ...p }: BitParams<D, P, I>): _BitInterface<D, P, I>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "elbe-ui",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "author": "Robin Naumann",
   "license": "MIT",
   "repository": {