@darajs/core 0.4.8

package/dist/shared/interactivity/use-server-component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-server-component.d.ts","sourceRoot":"","sources":["../../../js/shared/interactivity/use-server-component.tsx"],"names":[],"mappings":"AAUA,OAAO,EACH,WAAW,EACX,iBAAiB,EAKpB,MAAM,SAAS,CAAC;AAoEjB;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,GAAG,CAa9D;AA4LD;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACtC,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,GAChD,iBAAiB,CA4BnB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,IAAI,CAajE"}

package/dist/shared/interactivity/use-server-component.js

@@ -0,0 +1,256 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+/* eslint-disable react-hooks/exhaustive-deps */
+import { useContext, useEffect } from 'react';
+import { atom, selectorFamily, useRecoilCallback, useRecoilValueLoadable } from 'recoil';
+import { HTTP_METHOD, validateResponse } from '@darajs/ui-utils';
+import { fetchTaskResult, handleAuthErrors, request } from '../../api';
+import { RequestExtrasSerializable } from '../../api/http';
+import { useDeferLoadable } from '../../shared/utils';
+import { denormalize, normalizeRequest } from '../../shared/utils/normalization';
+import { isResolvedDerivedDataVariable, isResolvedDerivedVariable, } from '../../types';
+import { VariableCtx, WebSocketCtx, useRequestExtras } from '../context';
+import { useTaskContext } from '../context/global-task-context';
+import { useEventBus } from '../event-bus/event-bus';
+import { resolveDerivedValue } from './derived-variable';
+import { resolveVariable } from './resolve-variable';
+import { atomRegistry, depsRegistry, selectorFamilyMembersRegistry, selectorFamilyRegistry, } from './store';
+function isTaskResponse(response) {
+    return response && typeof response === 'object' && 'task_id' in response;
+}
+/**
+ * Generate a registry key for a component instance
+ *
+ * @param uid component instance uid
+ * @param trigger whether it's a trigger key
+ */
+function getComponentRegistryKey(uid, trigger) {
+    let key = `_COMPONENT_${uid}`;
+    if (trigger) {
+        key += '_TRIGGER';
+    }
+    return key;
+}
+/**
+ * Fetch a component from the backend, expects a component instance to be returned.
+ *
+ * @param component the component to fetch
+ * @param values the values to pass into the component
+ * @param uid the component instance uid
+ * @param extras request extras to be merged into the options
+ * @param wsClient websocket client
+ */
+function fetchFunctionComponent(component, values, uid, extras, wsClient) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ws_channel = yield wsClient.getChannel();
+        const res = yield request(`/api/core/components/${component}`, {
+            body: JSON.stringify({ uid, values, ws_channel }),
+            method: HTTP_METHOD.POST,
+        }, extras);
+        yield handleAuthErrors(res, true);
+        yield validateResponse(res, `Failed to fetch the component: ${component}`);
+        const result = yield res.json();
+        return result;
+    });
+}
+/**
+ * Claan value to a format understood by the backend.
+ * Removes `deps`, appends `force` to resolved derived(data)variables.
+ *
+ * @param value a value to clean
+ * @param force whether to force a derived variable recalculation
+ */
+export function cleanValue(value, force) {
+    if (isResolvedDerivedVariable(value) || isResolvedDerivedDataVariable(value)) {
+        const { deps } = value, rest = __rest(value, ["deps"]);
+        const cleanedValues = value.values.map((v) => cleanValue(v, force));
+        return Object.assign(Object.assign({}, rest), { force, values: cleanedValues });
+    }
+    return value;
+}
+function cleanKwargs(kwargs, force) {
+    return Object.keys(kwargs).reduce((acc, k) => {
+        acc[k] = cleanValue(kwargs[k], force);
+        return acc;
+    }, {});
+}
+function getOrRegisterComponentTrigger(uid) {
+    const triggerKey = getComponentRegistryKey(uid, true);
+    if (!atomRegistry.has(triggerKey)) {
+        atomRegistry.set(triggerKey, atom({
+            default: {
+                force: false,
+                inc: 0,
+            },
+            key: triggerKey,
+        }));
+    }
+    return atomRegistry.get(triggerKey);
+}
+/**
+ * Get a server component from the selector registry, registering it if not already registered
+ *
+ * @param name component name
+ * @param uid  component uid
+ * @param dynamicKwargs kwargs
+ * @param wsClient websocket client
+ * @param taskContext task context
+ * @param search current search string
+ * @param currentExtras request extras to be merged into the options
+ */
+function getOrRegisterServerComponent(name, uid, dynamicKwargs, wsClient, taskContext, currentExtras) {
+    const key = getComponentRegistryKey(uid);
+    if (!selectorFamilyRegistry.has(key)) {
+        selectorFamilyRegistry.set(key, selectorFamily({
+            cachePolicy_UNSTABLE: {
+                eviction: 'most-recent',
+            },
+            get: (extrasSerializable) => (_a) => __awaiter(this, [_a], void 0, function* ({ get }) {
+                // Kwargs resolved to their simple values
+                const resolvedKwargs = Object.keys(dynamicKwargs).reduce((acc, k) => {
+                    const value = dynamicKwargs[k];
+                    acc[k] = resolveVariable(value, wsClient, taskContext, currentExtras);
+                    return acc;
+                }, {});
+                // Turn kwargs into lists so we can re-use the DerivedVariable logic
+                const resolvedKwargsList = Object.values(resolvedKwargs);
+                const kwargsList = Object.values(dynamicKwargs);
+                const triggerAtom = getOrRegisterComponentTrigger(uid);
+                const selfTrigger = get(triggerAtom);
+                const { extras } = extrasSerializable;
+                const derivedResult = yield resolveDerivedValue(key, kwargsList, kwargsList, // pass deps=kwargs
+                resolvedKwargsList, wsClient, get, selfTrigger);
+                // returning previous result as no change in dependant values
+                if (derivedResult.type === 'previous') {
+                    return derivedResult.entry.result;
+                }
+                // Otherwise fetch new component
+                // turn the resolved values back into an object and clean them up
+                const kwargValues = cleanKwargs(Object.keys(dynamicKwargs).reduce((acc, k, idx) => {
+                    acc[k] = derivedResult.values[idx];
+                    return acc;
+                }, {}), derivedResult.force);
+                let result = null;
+                try {
+                    result = yield fetchFunctionComponent(name, normalizeRequest(kwargValues, dynamicKwargs), uid, extras, wsClient);
+                }
+                catch (e) {
+                    e.selectorId = key;
+                    e.selectorExtras = extrasSerializable.toJSON();
+                    throw e;
+                }
+                taskContext.cleanupRunningTasks(key);
+                // Metatask returned
+                if (isTaskResponse(result)) {
+                    const taskId = result.task_id;
+                    // Register the task under the component's instance key
+                    taskContext.startTask(taskId, key, getComponentRegistryKey(uid, true));
+                    try {
+                        yield wsClient.waitForTask(taskId);
+                    }
+                    catch (_b) {
+                        return null;
+                    }
+                    finally {
+                        taskContext.endTask(taskId);
+                    }
+                    try {
+                        result = yield fetchTaskResult(taskId, extras);
+                    }
+                    catch (e) {
+                        e.selectorId = key;
+                        e.selectorExtras = extrasSerializable.toJSON();
+                        throw e;
+                    }
+                }
+                if (result !== null) {
+                    // Denormalize
+                    result = denormalize(result.data, result.lookup);
+                }
+                depsRegistry.set(key, {
+                    args: derivedResult.relevantValues,
+                    cacheKey: null,
+                    result,
+                });
+                return result;
+            }),
+            key,
+        }));
+    }
+    const family = selectorFamilyRegistry.get(key);
+    // Get a selector instance for this particular extras value
+    // This is required as otherwise the selector is not aware of different possible extras values
+    // at the call site of e.g. useVariable and would otherwise be a stale closure using the initial extras when
+    // first registered
+    const serializableExtras = new RequestExtrasSerializable(currentExtras);
+    const selectorInstance = family(serializableExtras);
+    // register selector instance in the selector family registry
+    if (!selectorFamilyMembersRegistry.has(family)) {
+        selectorFamilyMembersRegistry.set(family, new Map());
+    }
+    selectorFamilyMembersRegistry.get(family).set(serializableExtras.toJSON(), selectorInstance);
+    return selectorInstance;
+}
+/**
+ * A hook to fetch a server component
+ *
+ * @param name component name - specific to a given py_component
+ * @param uid component uid - specific to a given *instance* of a py_component
+ * @param dynamicKwargs kwargs passed into the component
+ */
+export default function useServerComponent(name, uid, dynamicKwargs) {
+    const extras = useRequestExtras();
+    const { client: wsClient } = useContext(WebSocketCtx);
+    const taskContext = useTaskContext();
+    const variablesContext = useContext(VariableCtx);
+    const bus = useEventBus();
+    // Synchronously register the py_component uid, and clean it up on unmount
+    variablesContext.variables.current.add(getComponentRegistryKey(uid));
+    useEffect(() => {
+        return () => {
+            variablesContext.variables.current.delete(getComponentRegistryKey(uid));
+        };
+    }, []);
+    const componentSelector = getOrRegisterServerComponent(name, uid, dynamicKwargs, wsClient, taskContext, extras);
+    const componentLoadable = useRecoilValueLoadable(componentSelector);
+    useEffect(() => {
+        if (componentLoadable.state === 'hasValue') {
+            bus.publish('SERVER_COMPONENT_LOADED', { name, uid, value: componentLoadable.contents });
+        }
+    }, [componentLoadable]);
+    const deferred = useDeferLoadable(componentLoadable);
+    return deferred;
+}
+/**
+ * A helper hook that returns a function to force a refresh of a server component
+ *
+ * @param name component uid
+ */
+export function useRefreshServerComponent(uid) {
+    return useRecoilCallback(({ set }) => () => {
+        const triggerAtom = getOrRegisterComponentTrigger(uid);
+        set(triggerAtom, (triggerIndexValue) => ({
+            force: false,
+            inc: triggerIndexValue.inc + 1,
+        }));
+    }, [uid]);
+}
+//# sourceMappingURL=use-server-component.js.map

package/dist/shared/interactivity/use-server-component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-server-component.js","sourceRoot":"","sources":["../../../js/shared/interactivity/use-server-component.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,gDAAgD;AAChD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAA4B,IAAI,EAAE,cAAc,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAEnH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAA4B,eAAe,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC7F,OAAO,EAAiB,yBAAyB,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAKH,6BAA6B,EAC7B,yBAAyB,GAC5B,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,EAAqB,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAEH,YAAY,EACZ,YAAY,EACZ,6BAA6B,EAC7B,sBAAsB,GACzB,MAAM,SAAS,CAAC;AAEjB,SAAS,cAAc,CAAC,QAAa;IACjC,OAAO,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,SAAS,IAAI,QAAQ,CAAC;AAC7E,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,GAAW,EAAE,OAAiB;IAC3D,IAAI,GAAG,GAAG,cAAc,GAAG,EAAE,CAAC;IAE9B,IAAI,OAAO,EAAE,CAAC;QACV,GAAG,IAAI,UAAU,CAAC;IACtB,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAe,sBAAsB,CACjC,SAAiB,EACjB,MAEC,EACD,GAAW,EACX,MAAqB,EACrB,QAAkC;;QAElC,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,MAAM,OAAO,CACrB,wBAAwB,SAAS,EAAE,EACnC;YACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACjD,MAAM,EAAE,WAAW,CAAC,IAAI;SAC3B,EACD,MAAM,CACT,CAAC;QACF,MAAM,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAClC,MAAM,gBAAgB,CAAC,GAAG,EAAE,kCAAkC,SAAS,EAAE,CAAC,CAAC;QAC3E,MAAM,MAAM,GAA+D,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5F,OAAO,MAAM,CAAC;IAClB,CAAC;CAAA;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,KAAc;IACrD,IAAI,yBAAyB,CAAC,KAAK,CAAC,IAAI,6BAA6B,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3E,MAAM,EAAE,IAAI,KAAc,KAAK,EAAd,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAQ,CAAC;QAChC,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QAEpE,uCACO,IAAI,KACP,KAAK,EACL,MAAM,EAAE,aAAa,IACvB;IACN,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,MAA2B,EAAE,KAAc;IAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QACP,GAAG,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACtC,OAAO,GAAG,CAAC;IACf,CAAC,EACD,EAAyB,CAC5B,CAAC;AACN,CAAC;AAED,SAAS,6BAA6B,CAAC,GAAW;IAC9C,MAAM,UAAU,GAAG,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAEtD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,YAAY,CAAC,GAAG,CACZ,UAAU,EACV,IAAI,CAAC;YACD,OAAO,EAAE;gBACL,KAAK,EAAE,KAAK;gBACZ,GAAG,EAAE,CAAC;aACT;YACD,GAAG,EAAE,UAAU;SAClB,CAAC,CACL,CAAC;IACN,CAAC;IAED,OAAO,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,4BAA4B,CACjC,IAAY,EACZ,GAAW,EACX,aAA+C,EAC/C,QAAkC,EAClC,WAA8B,EAC9B,aAA4B;IAE5B,MAAM,GAAG,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;IAEzC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,sBAAsB,CAAC,GAAG,CACtB,GAAG,EACH,cAAc,CAAC;YACX,oBAAoB,EAAE;gBAClB,QAAQ,EAAE,aAAa;aAC1B;YACD,GAAG,EACC,CAAC,kBAA6C,EAAE,EAAE,CAClD,KAAgB,EAAE,0CAAX,EAAE,GAAG,EAAE;gBACV,yCAAyC;gBACzC,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CACpD,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;oBACP,MAAM,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;oBAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;oBACtE,OAAO,GAAG,CAAC;gBACf,CAAC,EACD,EAAyB,CAC5B,CAAC;gBAEF,oEAAoE;gBACpE,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBACzD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBAEhD,MAAM,WAAW,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC;gBACvD,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;gBAErC,MAAM,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC;gBAEtC,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAC3C,GAAG,EACH,UAAU,EACV,UAAU,EAAE,mBAAmB;gBAC/B,kBAAkB,EAClB,QAAQ,EACR,GAAG,EACH,WAAW,CACd,CAAC;gBAEF,6DAA6D;gBAC7D,IAAI,aAAa,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;oBACpC,OAAO,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;gBACtC,CAAC;gBAED,gCAAgC;gBAEhC,iEAAiE;gBACjE,MAAM,WAAW,GAAG,WAAW,CAC3B,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;oBACZ,GAAG,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACnC,OAAO,GAAG,CAAC;gBACf,CAAC,EACD,EAAyB,CAC5B,EACD,aAAa,CAAC,KAAK,CACtB,CAAC;gBAEF,IAAI,MAAM,GAAG,IAAI,CAAC;gBAElB,IAAI,CAAC;oBACD,MAAM,GAAG,MAAM,sBAAsB,CACjC,IAAI,EACJ,gBAAgB,CAAC,WAAW,EAAE,aAAa,CAAC,EAC5C,GAAG,EACH,MAAM,EACN,QAAQ,CACX,CAAC;gBACN,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACT,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC;oBACnB,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,MAAM,EAAE,CAAC;oBAC/C,MAAM,CAAC,CAAC;gBACZ,CAAC;gBAED,WAAW,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;gBAErC,oBAAoB;gBACpB,IAAI,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;oBACzB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC;oBAE9B,uDAAuD;oBACvD,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;oBAEvE,IAAI,CAAC;wBACD,MAAM,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;oBACvC,CAAC;oBAAC,WAAM,CAAC;wBACL,OAAO,IAAI,CAAC;oBAChB,CAAC;4BAAS,CAAC;wBACP,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;oBAChC,CAAC;oBAED,IAAI,CAAC;wBACD,MAAM,GAAG,MAAM,eAAe,CAAuC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACzF,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACT,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC;wBACnB,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,MAAM,EAAE,CAAC;wBAC/C,MAAM,CAAC,CAAC;oBACZ,CAAC;gBACL,CAAC;gBAED,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;oBAClB,cAAc;oBACd,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBACrD,CAAC;gBAED,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE;oBAClB,IAAI,EAAE,aAAa,CAAC,cAAc;oBAClC,QAAQ,EAAE,IAAI;oBACd,MAAM;iBACT,CAAC,CAAC;gBAEH,OAAO,MAAM,CAAC;YAClB,CAAC,CAAA;YACL,GAAG;SACN,CAAC,CACL,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE/C,2DAA2D;IAC3D,8FAA8F;IAC9F,4GAA4G;IAC5G,mBAAmB;IACnB,MAAM,kBAAkB,GAAG,IAAI,yBAAyB,CAAC,aAAa,CAAC,CAAC;IACxE,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEpD,6DAA6D;IAC7D,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,6BAA6B,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IACzD,CAAC;IACD,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC;IAE7F,OAAO,gBAAgB,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACtC,IAAY,EACZ,GAAW,EACX,aAA+C;IAE/C,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAClC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IAEjD,MAAM,GAAG,GAAG,WAAW,EAAE,CAAC;IAE1B,0EAA0E;IAC1E,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,SAAS,CAAC,GAAG,EAAE;QACX,OAAO,GAAG,EAAE;YACR,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC;IACN,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IAChH,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;IAEpE,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,iBAAiB,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YACzC,GAAG,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7F,CAAC;IACL,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAExB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IAErD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,GAAW;IACjD,OAAO,iBAAiB,CACpB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CACR,GAAG,EAAE;QACD,MAAM,WAAW,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC;QAEvD,GAAG,CAAC,WAAW,EAAE,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;YACrC,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,iBAAiB,CAAC,GAAG,GAAG,CAAC;SACjC,CAAC,CAAC,CAAC;IACR,CAAC,EACL,CAAC,GAAG,CAAC,CACR,CAAC;AACN,CAAC"}

package/dist/shared/interactivity/use-variable-state.d.ts

@@ -0,0 +1,9 @@
+import { ResolvedDataVariable, ResolvedDerivedDataVariable, ResolvedDerivedVariable } from '../../types';
+type AnyResolvedVariable = ResolvedDataVariable | ResolvedDerivedDataVariable | ResolvedDerivedVariable;
+/**
+ * Helper hook to get the current state of the variable.
+ * For client-side variables, returns their value. For server-side variables, returns their resolved forms.
+ */
+export default function useVariableState(): any | AnyResolvedVariable;
+export {};
+//# sourceMappingURL=use-variable-state.d.ts.map

package/dist/shared/interactivity/use-variable-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-variable-state.d.ts","sourceRoot":"","sources":["../../../js/shared/interactivity/use-variable-state.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAe,oBAAoB,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAKlH,KAAK,mBAAmB,GAAG,oBAAoB,GAAG,2BAA2B,GAAG,uBAAuB,CAAC;AAExG;;;GAGG;AAEH,MAAM,CAAC,OAAO,UAAU,gBAAgB,IAAI,GAAG,GAAG,mBAAmB,CAmBpE"}

package/dist/shared/interactivity/use-variable-state.js

@@ -0,0 +1,26 @@
+import { useContext } from 'react';
+import { useRecoilCallback } from 'recoil';
+import { WebSocketCtx, useRequestExtras, useTaskContext } from '../../shared/context';
+import { resolveVariable } from './resolve-variable';
+import { isRegistered } from './store';
+/**
+ * Helper hook to get the current state of the variable.
+ * For client-side variables, returns their value. For server-side variables, returns their resolved forms.
+ */
+// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+export default function useVariableState() {
+    const extras = useRequestExtras();
+    const { client } = useContext(WebSocketCtx);
+    const taskCtx = useTaskContext();
+    return useRecoilCallback(({ snapshot }) => {
+        return (variable) => {
+            if (!isRegistered(variable)) {
+                return '__NOT_REGISTERED__';
+            }
+            // get the resolved form of the variable
+            const resolvedVariable = resolveVariable(variable, client, taskCtx, extras, (v) => snapshot.getLoadable(v).getValue());
+            return resolvedVariable;
+        };
+    }, []);
+}
+//# sourceMappingURL=use-variable-state.js.map

package/dist/shared/interactivity/use-variable-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-variable-state.js","sourceRoot":"","sources":["../../../js/shared/interactivity/use-variable-state.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlF,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAIvC;;;GAGG;AACH,6EAA6E;AAC7E,MAAM,CAAC,OAAO,UAAU,gBAAgB;IACpC,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAClC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IAEjC,OAAO,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QACtC,OAAO,CAAC,QAA0B,EAAE,EAAE;YAClC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1B,OAAO,oBAAoB,CAAC;YAChC,CAAC;YAED,wCAAwC;YACxC,MAAM,gBAAgB,GAAG,eAAe,CAAsB,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CACnG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CACrC,CAAC;YAEF,OAAO,gBAAgB,CAAC;QAC5B,CAAC,CAAC;IACN,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC"}

package/dist/shared/interactivity/use-variable-value.d.ts

@@ -0,0 +1,33 @@
+import { Snapshot } from 'recoil';
+import { WebSocketClientInterface } from '../../api';
+import { RequestExtras } from '../../api/http';
+import { AnyVariable, DataFrame, DataVariable, DerivedDataVariable, DerivedVariable, ResolvedDataVariable, ResolvedDerivedDataVariable, ResolvedDerivedVariable, Variable } from '../../types';
+import { GlobalTaskContext } from '../context/global-task-context';
+type GetVariableValueCtx = {
+    client: WebSocketClientInterface;
+    extras: RequestExtras;
+    search: string;
+    snapshot: Snapshot;
+    taskContext: GlobalTaskContext;
+};
+/**
+ * Helper function that returns the current value of a variable.
+ *
+ * Plain variables are always resolved to their value.
+ * Computed (server-side) variables are resolved to their uid and dependency values, unless shouldFetchVariable is true.
+ */
+export declare function getVariableValue<VV, B extends boolean = false>(variable: AnyVariable<VV>, shouldFetchVariable: B, ctx: GetVariableValueCtx): VV | DataFrame | ResolvedDataVariable | ResolvedDerivedVariable | ResolvedDerivedDataVariable | Promise<VV> | Promise<DataFrame>;
+/**
+ * A helper hook that turns a Variable class into the actual value.
+ * As opposed to the `useVariable` hook, this one returns a callback to retrieve the latest value
+ * without subscribing the component using it to updates.
+ * For derived (data) variables, instead of returning its value directly - its resolved to its
+ * uid and dependency values.
+ *
+ * @param variable the variable to use
+ * @param shouldFetchVariable if true, if the variable is a derived (data) variable, the request to fetch the variable value will be made
+ * @returns Returns the value if the Variable is not derived/data. A Resolved(Data/Derived/DerivedData)Variable if shouldFetchVariable = false, and a Promise for fetching the variable if true.
+ */
+export default function useVariableValue<VV, B extends boolean = false>(variable: VV | Variable<VV> | DataVariable | DerivedVariable | DerivedDataVariable, shouldFetchVariable?: B): () => ReturnType<typeof getVariableValue<VV, B>>;
+export {};
+//# sourceMappingURL=use-variable-value.d.ts.map

package/dist/shared/interactivity/use-variable-value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-variable-value.d.ts","sourceRoot":"","sources":["../../../js/shared/interactivity/use-variable-value.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAqB,MAAM,QAAQ,CAAC;AAKrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EACH,WAAW,EACX,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,2BAA2B,EAC3B,uBAAuB,EACvB,QAAQ,EAQX,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAUnE,KAAK,mBAAmB,GAAG;IACvB,MAAM,EAAE,wBAAwB,CAAC;IACjC,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,iBAAiB,CAAC;CAClC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,CAAC,SAAS,OAAO,GAAG,KAAK,EAC1D,QAAQ,EAAE,WAAW,CAAC,EAAE,CAAC,EACzB,mBAAmB,EAAE,CAAc,EACnC,GAAG,EAAE,mBAAmB,GAEtB,EAAE,GACF,SAAS,GACT,oBAAoB,GACpB,uBAAuB,GACvB,2BAA2B,GAC3B,OAAO,CAAC,EAAE,CAAC,GACX,OAAO,CAAC,SAAS,CAAC,CAgEvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,EAAE,EAAE,CAAC,SAAS,OAAO,GAAG,KAAK,EAClE,QAAQ,EAAE,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC,GAAG,YAAY,GAAG,eAAe,GAAG,mBAAmB,EAClF,mBAAmB,GAAE,CAAc,GACpC,MAAM,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAwBlD"}

package/dist/shared/interactivity/use-variable-value.js

@@ -0,0 +1,94 @@
+/* eslint-disable react-hooks/rules-of-hooks */
+import { useContext } from 'react';
+import { useLocation } from 'react-router-dom';
+import { useRecoilCallback } from 'recoil';
+import { useDeepCompare } from '@darajs/ui-utils';
+import { WebSocketCtx, useRequestExtras, useTaskContext } from '../../shared/context';
+import { normalizeRequest } from '../../shared/utils/normalization';
+import { isDataVariable, isDerivedDataVariable, isDerivedVariable, isResolvedDataVariable, isResolvedDerivedDataVariable, isResolvedDerivedVariable, isVariable, } from '../../types';
+import { fetchDataVariable, fetchDerivedDataVariable, fetchDerivedVariable, formatDerivedVariableRequest, isTaskResponse, resolveVariable, } from './internal';
+/**
+ * Helper function that returns the current value of a variable.
+ *
+ * Plain variables are always resolved to their value.
+ * Computed (server-side) variables are resolved to their uid and dependency values, unless shouldFetchVariable is true.
+ */
+export function getVariableValue(variable, shouldFetchVariable = false, ctx) {
+    // Using loadable since the resolver is only used for simple atoms and shouldn't cause problems
+    const resolved = resolveVariable(variable, ctx.client, ctx.taskContext, ctx.extras, (v) => ctx.snapshot.getLoadable(v).getValue());
+    // if we're NOT forced to fetch, or if it's not a DV/DDV/data variable, return the resolved value
+    // variable is plain/url
+    if (!shouldFetchVariable ||
+        (!isDerivedVariable(variable) && !isDataVariable(variable) && !isDerivedDataVariable(variable))) {
+        return resolved;
+    }
+    // we're forced to fetch but the resolved variable is not a resolved DV/data var, return the resolved value
+    // variable is plain/url
+    if (!isResolvedDerivedVariable(resolved) &&
+        !isResolvedDataVariable(resolved) &&
+        !isResolvedDerivedDataVariable(resolved)) {
+        return resolved;
+    }
+    // data variable
+    if (isResolvedDataVariable(resolved)) {
+        return fetchDataVariable(resolved.uid, ctx.extras, resolved.filters);
+    }
+    // derived variable
+    return fetchDerivedVariable({
+        cache: variable.cache,
+        extras: ctx.extras,
+        force: false,
+        /**
+         * In this case we're not concerned about different selectors fetching the value so just use the uid
+         */
+        selectorKey: resolved.uid,
+        values: normalizeRequest(formatDerivedVariableRequest(resolved.values), variable.variables),
+        variableUid: resolved.uid,
+        wsClient: ctx.client,
+    }).then((resp) => {
+        // This is really only used in DownloadVariable currently; we can add support for tasks
+        // if it is requested in the future
+        if (isTaskResponse(resp)) {
+            throw new Error('Task DerivedVariables are not supported in this context');
+        }
+        // for derived data variables we need to make another request to retrieve the filtered value
+        if (isDerivedDataVariable(variable)) {
+            return ctx.client
+                .getChannel()
+                .then((chan) => fetchDerivedDataVariable(variable.uid, ctx.extras, resp.cache_key, chan, variable.filters));
+        }
+        return resp.value;
+    });
+}
+/**
+ * A helper hook that turns a Variable class into the actual value.
+ * As opposed to the `useVariable` hook, this one returns a callback to retrieve the latest value
+ * without subscribing the component using it to updates.
+ * For derived (data) variables, instead of returning its value directly - its resolved to its
+ * uid and dependency values.
+ *
+ * @param variable the variable to use
+ * @param shouldFetchVariable if true, if the variable is a derived (data) variable, the request to fetch the variable value will be made
+ * @returns Returns the value if the Variable is not derived/data. A Resolved(Data/Derived/DerivedData)Variable if shouldFetchVariable = false, and a Promise for fetching the variable if true.
+ */
+export default function useVariableValue(variable, shouldFetchVariable = false) {
+    const taskContext = useTaskContext();
+    const { client } = useContext(WebSocketCtx);
+    const { search } = useLocation();
+    const extras = useRequestExtras();
+    if (!isVariable(variable)) {
+        return () => variable;
+    }
+    return useRecoilCallback(({ snapshot }) => {
+        return () => {
+            return getVariableValue(variable, shouldFetchVariable, {
+                client,
+                extras,
+                search,
+                snapshot,
+                taskContext,
+            });
+        };
+    }, [variable.uid, useDeepCompare(taskContext), client, search, extras]);
+}
+//# sourceMappingURL=use-variable-value.js.map

package/dist/shared/interactivity/use-variable-value.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-variable-value.js","sourceRoot":"","sources":["../../../js/shared/interactivity/use-variable-value.tsx"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAY,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAUH,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,6BAA6B,EAC7B,yBAAyB,EACzB,UAAU,GACb,MAAM,SAAS,CAAC;AAGjB,OAAO,EACH,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EACpB,4BAA4B,EAC5B,cAAc,EACd,eAAe,GAClB,MAAM,YAAY,CAAC;AAUpB;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC5B,QAAyB,EACzB,sBAAyB,KAAU,EACnC,GAAwB;IASxB,+FAA+F;IAC/F,MAAM,QAAQ,GAAG,eAAe,CAAM,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAC3F,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CACzC,CAAC;IAEF,iGAAiG;IACjG,wBAAwB;IACxB,IACI,CAAC,mBAAmB;QACpB,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,EACjG,CAAC;QACC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,2GAA2G;IAC3G,wBAAwB;IACxB,IACI,CAAC,yBAAyB,CAAC,QAAQ,CAAC;QACpC,CAAC,sBAAsB,CAAC,QAAQ,CAAC;QACjC,CAAC,6BAA6B,CAAC,QAAQ,CAAC,EAC1C,CAAC;QACC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,gBAAgB;IAChB,IAAI,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,iBAAiB,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzE,CAAC;IAED,mBAAmB;IACnB,OAAO,oBAAoB,CAAC;QACxB,KAAK,EAAG,QAAkD,CAAC,KAAK;QAChE,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,KAAK,EAAE,KAAK;QACZ;;WAEG;QACH,WAAW,EAAE,QAAQ,CAAC,GAAG;QAEzB,MAAM,EAAE,gBAAgB,CACpB,4BAA4B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC5C,QAAkD,CAAC,SAAS,CAChE;QACD,WAAW,EAAE,QAAQ,CAAC,GAAG;QACzB,QAAQ,EAAE,GAAG,CAAC,MAAM;KACvB,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,uFAAuF;QACvF,mCAAmC;QACnC,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC/E,CAAC;QAED,4FAA4F;QAC5F,IAAI,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClC,OAAO,GAAG,CAAC,MAAM;iBACZ,UAAU,EAAE;iBACZ,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACX,wBAAwB,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAC7F,CAAC;QACV,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC,CAAgB,CAAC;AACtB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACpC,QAAkF,EAClF,sBAAyB,KAAU;IAEnC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IAC5C,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAElC,IAAI,CAAC,UAAU,CAAK,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAED,OAAO,iBAAiB,CACpB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QACb,OAAO,GAAG,EAAE;YACR,OAAO,gBAAgB,CAAQ,QAAQ,EAAE,mBAAmB,EAAE;gBAC1D,MAAM;gBACN,MAAM;gBACN,MAAM;gBACN,QAAQ;gBACR,WAAW;aACd,CAAC,CAAC;QACP,CAAC,CAAC;IACN,CAAC,EACD,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CACtE,CAAC;AACN,CAAC"}

package/dist/shared/interactivity/use-variable.d.ts

@@ -0,0 +1,12 @@
+import { Dispatch, SetStateAction } from 'react';
+import { Variable } from '../../types';
+/**
+ * A helper hook that turns a Variable class into the actual value by accessing the appropriate recoil state from the
+ * atomRegistry defined above. For convenience, it will also handle a non variable being passed and will return it
+ * directly and a noop function for setting it. In most cases components accept a variable or something else, so this
+ * helps to clean up all those areas in a consistent manner.
+ *
+ * @param variable the possible variable to use
+ */
+export declare function useVariable<T>(variable: Variable<T> | T): [value: T, update: Dispatch<SetStateAction<T>>];
+//# sourceMappingURL=use-variable.d.ts.map

package/dist/shared/interactivity/use-variable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-variable.d.ts","sourceRoot":"","sources":["../../../js/shared/interactivity/use-variable.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAmC,MAAM,OAAO,CAAC;AAKlF,OAAO,EAAE,QAAQ,EAAuF,MAAM,SAAS,CAAC;AAmBxH;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAqEzG"}

package/dist/shared/interactivity/use-variable.js

@@ -0,0 +1,84 @@
+import { useContext, useEffect, useState } from 'react';
+import { useRecoilState, useRecoilStateLoadable, useRecoilValueLoadable_TRANSITION_SUPPORT_UNSTABLE } from 'recoil';
+import { VariableCtx, WebSocketCtx, useRequestExtras, useTaskContext } from '../../shared/context';
+import { useDeferLoadable } from '../../shared/utils';
+import { isDataVariable, isDerivedDataVariable, isDerivedVariable, isUrlVariable, isVariable } from '../../types';
+import { useEventBus } from '../event-bus/event-bus';
+import { getOrRegisterPlainVariable, useDerivedVariable, useUrlVariable } from './internal';
+/** Disabling rules of hook because of assumptions that variables never change their types which makes the hook order consistent */
+/* eslint-disable react-hooks/rules-of-hooks */
+/** Disabling no-use-before-define because of functions depending on each other */
+/* eslint-disable @typescript-eslint/no-use-before-define */
+/* eslint-disable react-hooks/exhaustive-deps */
+/**
+ * Helper function to warn when trying to update DerivedVariable directly
+ */
+function warnUpdateOnDerivedState() {
+    // eslint-disable-next-line no-console
+    console.warn('You tried to call update on variable with derived state, this is a noop and will be ignored.');
+}
+/**
+ * A helper hook that turns a Variable class into the actual value by accessing the appropriate recoil state from the
+ * atomRegistry defined above. For convenience, it will also handle a non variable being passed and will return it
+ * directly and a noop function for setting it. In most cases components accept a variable or something else, so this
+ * helps to clean up all those areas in a consistent manner.
+ *
+ * @param variable the possible variable to use
+ */
+export function useVariable(variable) {
+    const extras = useRequestExtras();
+    const { client: WsClient } = useContext(WebSocketCtx);
+    const taskContext = useTaskContext();
+    const variablesContext = useContext(VariableCtx);
+    const bus = useEventBus();
+    if (!isVariable(variable)) {
+        return useState(variable);
+    }
+    // Synchronously register variable subscription, and clean it up on unmount
+    variablesContext.variables.current.add(variable.uid);
+    useEffect(() => {
+        return () => {
+            variablesContext.variables.current.delete(variable.uid);
+        };
+    }, []);
+    // This hook should only be used for components not expecting DataFrames
+    if (isDataVariable(variable) || isDerivedDataVariable(variable)) {
+        throw new Error(`Non-data variable expected, got ${variable.__typename}`);
+    }
+    if (isDerivedVariable(variable)) {
+        const selector = useDerivedVariable(variable, WsClient, taskContext, extras);
+        const selectorLoadable = useRecoilValueLoadable_TRANSITION_SUPPORT_UNSTABLE(selector);
+        useEffect(() => {
+            if (selectorLoadable.state !== 'loading') {
+                bus.publish('DERIVED_VARIABLE_LOADED', { variable, value: selectorLoadable.contents });
+            }
+        }, [selectorLoadable]);
+        const deferred = useDeferLoadable(selectorLoadable);
+        return [deferred.value, warnUpdateOnDerivedState];
+    }
+    if (isUrlVariable(variable)) {
+        const [urlValue, setUrlValue] = useUrlVariable(variable);
+        useEffect(() => {
+            bus.publish('URL_VARIABLE_LOADED', { variable, value: urlValue });
+        }, [urlValue]);
+        return [urlValue, setUrlValue];
+    }
+    const recoilState = getOrRegisterPlainVariable(variable, WsClient, taskContext, extras);
+    if (!isDerivedVariable(variable.default)) {
+        const [value, setValue] = useRecoilState(recoilState);
+        useEffect(() => {
+            bus.publish('PLAIN_VARIABLE_LOADED', { variable, value });
+        }, [value]);
+        return [value, setValue];
+    }
+    const [loadable, setLoadable] = useRecoilStateLoadable(recoilState);
+    useEffect(() => {
+        // when loadable resolves to a value/error
+        if (loadable.state !== 'loading') {
+            bus.publish('PLAIN_VARIABLE_LOADED', { variable, value: loadable.contents });
+        }
+    }, [loadable]);
+    const deferred = useDeferLoadable(loadable);
+    return [deferred, setLoadable];
+}
+//# sourceMappingURL=use-variable.js.map

package/dist/shared/interactivity/use-variable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-variable.js","sourceRoot":"","sources":["../../../js/shared/interactivity/use-variable.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA4B,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,kDAAkD,EAAE,MAAM,QAAQ,CAAC;AAEpH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAY,cAAc,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAExH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5F,mIAAmI;AACnI,+CAA+C;AAC/C,kFAAkF;AAClF,4DAA4D;AAC5D,gDAAgD;AAEhD;;GAEG;AACH,SAAS,wBAAwB;IAC7B,sCAAsC;IACtC,OAAO,CAAC,IAAI,CAAC,8FAA8F,CAAC,CAAC;AACjH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAI,QAAyB;IACpD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAElC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG,WAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,2EAA2E;IAC3E,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACrD,SAAS,CAAC,GAAG,EAAE;QACX,OAAO,GAAG,EAAE;YACR,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5D,CAAC,CAAC;IACN,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,wEAAwE;IACxE,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,mCAAoC,QAAgB,CAAC,UAAoB,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAC7E,MAAM,gBAAgB,GAAG,kDAAkD,CAAC,QAAQ,CAAC,CAAC;QAEtF,SAAS,CAAC,GAAG,EAAE;YACX,IAAI,gBAAgB,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACvC,GAAG,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC3F,CAAC;QACL,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAEvB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAEpD,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEzD,SAAS,CAAC,GAAG,EAAE;YACX,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtE,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEf,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,WAAW,GAAG,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IACxF,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;QACtD,SAAS,CAAC,GAAG,EAAE;YACX,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9D,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QACZ,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC7B,CAAC;IACD,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,sBAAsB,CAAC,WAAW,CAAC,CAAC;IACpE,SAAS,CAAC,GAAG,EAAE;QACX,0CAA0C;QAC1C,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjF,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE5C,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AACnC,CAAC"}

package/dist/shared/private-route/private-route.d.ts

@@ -0,0 +1,19 @@
+import { ReactNode } from 'react';
+import { Action } from '../../types';
+interface PrivateRouteProps {
+    /** The children to wrap */
+    children: ReactNode;
+    /** Name of the page this route links to */
+    name?: string;
+    /** Variables which should be reset upon visiting the page */
+    on_load?: Action;
+}
+/**
+ * The PrivateRoute component takes a private route object and checks for authentication.
+ * It redirects to the login page if the user is not authenticated.
+ *
+ * @param props - the component props
+ */
+declare function PrivateRoute({ children, on_load, name }: PrivateRouteProps): ReactNode;
+export default PrivateRoute;
+//# sourceMappingURL=private-route.d.ts.map

package/dist/shared/private-route/private-route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-route.d.ts","sourceRoot":"","sources":["../../../js/shared/private-route/private-route.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAa,MAAM,OAAO,CAAC;AAO7C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,UAAU,iBAAiB;IACvB,2BAA2B;IAC3B,QAAQ,EAAE,SAAS,CAAC;IACpB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,iBAAS,YAAY,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,iBAAiB,GAAG,SAAS,CA0B/E;AAED,eAAe,YAAY,CAAC"}

package/dist/shared/private-route/private-route.js

@@ -0,0 +1,35 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/* eslint-disable react-hooks/exhaustive-deps */
+import { useEffect } from 'react';
+import { Redirect } from 'react-router-dom';
+import { useSessionToken } from '../../auth/use-session-token';
+import DefaultFallback from '../../components/fallback/default';
+import useAction, { useActionIsLoading } from '../../shared/utils/use-action';
+import useWindowTitle from '../../shared/utils/use-window-title';
+/**
+ * The PrivateRoute component takes a private route object and checks for authentication.
+ * It redirects to the login page if the user is not authenticated.
+ *
+ * @param props - the component props
+ */
+function PrivateRoute({ children, on_load, name }) {
+    const token = useSessionToken();
+    const onLoad = useAction(on_load);
+    const isLoading = useActionIsLoading(on_load);
+    useWindowTitle(name);
+    useEffect(() => {
+        // On mount, call the on_load action
+        onLoad();
+    }, []);
+    if (!token) {
+        const referrer = encodeURIComponent(window.location.pathname + window.location.search);
+        return (_jsx(Redirect, { to: {
+                pathname: '/login',
+                search: `?referrer=${referrer}`,
+            } }));
+    }
+    // Show fallback while the onLoad action is in progress
+    return isLoading ? _jsx(DefaultFallback, {}) : children;
+}
+export default PrivateRoute;
+//# sourceMappingURL=private-route.js.map

package/dist/shared/private-route/private-route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-route.js","sourceRoot":"","sources":["../../../js/shared/private-route/private-route.tsx"],"names":[],"mappings":";AAAA,gDAAgD;AAChD,OAAO,EAAa,SAAS,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,eAAe,MAAM,+BAA+B,CAAC;AAC5D,OAAO,SAAS,EAAE,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,cAAc,MAAM,iCAAiC,CAAC;AAY7D;;;;;GAKG;AACH,SAAS,YAAY,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAqB;IAChE,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE9C,cAAc,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,CAAC,GAAG,EAAE;QACX,oCAAoC;QACpC,MAAM,EAAE,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvF,OAAO,CACH,KAAC,QAAQ,IACL,EAAE,EAAE;gBACA,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,aAAa,QAAQ,EAAE;aAClC,GACH,CACL,CAAC;IACN,CAAC;IAED,uDAAuD;IACvD,OAAO,SAAS,CAAC,CAAC,CAAC,KAAC,eAAe,KAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;AACtD,CAAC;AAED,eAAe,YAAY,CAAC"}