@darajs/core 0.4.8

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

@@ -0,0 +1,218 @@
+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());
+    });
+};
+/* eslint-disable react-hooks/exhaustive-deps */
+import { useCallback, useRef } from 'react';
+import { atom } from 'recoil';
+import { HTTP_METHOD, validateResponse } from '@darajs/ui-utils';
+import { fetchTaskResult, handleAuthErrors } from '../../api';
+import { request } from '../../api/http';
+import { useRequestExtras } from '../context';
+import { useEventBus } from '../event-bus/event-bus';
+import { combineFilters } from './filtering';
+import { atomRegistry } from './store';
+/**
+ * Format a DataVariable into a ResolvedDataVariable structure for the backend
+ *
+ * @param variable the variable to resolve for the backend
+ */
+export function resolveDataVariable(variable) {
+    return {
+        filters: variable.filters,
+        type: 'data',
+        uid: variable.uid,
+    };
+}
+/**
+ * Create necessary query parameters on a URL based on pagination settings
+ *
+ * @param path url path
+ * @param pagination pagination object
+ */
+function createDataUrl(path, pagination) {
+    const url = new URL(path, window.location.origin);
+    if (pagination === null || pagination === void 0 ? void 0 : pagination.limit) {
+        url.searchParams.set('limit', String(pagination.limit));
+    }
+    if (pagination === null || pagination === void 0 ? void 0 : pagination.offset) {
+        url.searchParams.set('offset', String(pagination.offset));
+    }
+    if (pagination === null || pagination === void 0 ? void 0 : pagination.sort) {
+        url.searchParams.set('order_by', (pagination.sort.desc ? '-' : '') + pagination.sort.id);
+    }
+    if (pagination === null || pagination === void 0 ? void 0 : pagination.index) {
+        url.searchParams.set('index', String(pagination.index));
+    }
+    return url;
+}
+/**
+ * Retrieve the value of a data variable from the backend
+ *
+ * @param uid
+ * @param extras request extras to be merged into the options
+ * @param filters
+ * @param pagination
+ */
+export function fetchDataVariable(uid, extras, filters, pagination) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = createDataUrl(`/api/core/data-variable/${uid}`, pagination);
+        const response = yield request(url, { body: JSON.stringify({ filters }), method: HTTP_METHOD.POST }, extras);
+        yield handleAuthErrors(response, true);
+        yield validateResponse(response, 'Failed to fetch data variable');
+        return response.json();
+    });
+}
+export function isDataResponse(response) {
+    return typeof response === 'object' && 'data' in response && 'totalCount' in response;
+}
+/**
+ * Retrieve the value of a derived data variable from the backend
+ *
+ * @param uid
+ * @param extras request extras to be merged into the options
+ * @param filters
+ * @param pagination
+ * @param cacheKey - cache key of the underlying DV, required for DerivedDataVariables
+ * @param wsChannel - websocket channel, required for DerivedDataVariables
+ */
+export function fetchDerivedDataVariable(uid, extras, cacheKey, wsChannel, filters, pagination) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = createDataUrl(`/api/core/data-variable/${uid}`, pagination);
+        const response = yield request(url, { body: JSON.stringify({ cache_key: cacheKey, filters, ws_channel: wsChannel }), method: HTTP_METHOD.POST }, extras);
+        yield handleAuthErrors(response, true);
+        yield validateResponse(response, 'Failed to fetch data variable');
+        return response.json();
+    });
+}
+/**
+ * Get total count of data in a data variable
+ *
+ * @param uid uid of the variable
+ * @param extras request extras to be merged into the options
+ * @param cacheKey cache key of the underlying DV in the case of derived data variables
+ */
+function fetchDataVariableCount(uid, extras, filters, cacheKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield request(`/api/core/data-variable/${uid}/count`, { body: JSON.stringify({ cache_key: cacheKey, filters }), method: HTTP_METHOD.POST }, extras);
+        yield handleAuthErrors(response, true);
+        yield validateResponse(response, 'Failed to fetch data variable total count');
+        return response.json();
+    });
+}
+/**
+ * Get data variable schema
+ *
+ * @param uid uid of the variable
+ * @param extras request extras to be merged into the options
+ * @param cacheKey cache key of the underlying DV in the case of derived data variables
+ */
+function fetchDataVariableSchema(uid, extras, cacheKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const queryString = cacheKey ? new URLSearchParams({ cache_key: cacheKey }).toString() : '';
+        const response = yield request(`/api/core/data-variable/${uid}/schema?${queryString}`, { method: HTTP_METHOD.GET }, extras);
+        yield handleAuthErrors(response, true);
+        yield validateResponse(response, 'Failed to fetch data variable schema');
+        return response.json();
+    });
+}
+/**
+ * Get a callback to fetch data variable from the backend
+ *
+ * @param variable variable instance
+ * @param serverTriggerCounter a counter to force recreation of the callback
+ */
+export function useFetchDataVariable(variable, serverTriggerCounter) {
+    const eventBus = useEventBus();
+    const extras = useRequestExtras();
+    const dataCallback = useCallback((filters, pagination, options) => __awaiter(this, void 0, void 0, function* () {
+        const mergedFilters = combineFilters('AND', [variable.filters, filters]);
+        const data = yield fetchDataVariable(variable.uid, extras, mergedFilters, pagination);
+        const [totalCount, schema = null] = yield Promise.all([
+            fetchDataVariableCount(variable.uid, extras, mergedFilters),
+            ...((options === null || options === void 0 ? void 0 : options.schema) ? [fetchDataVariableSchema(variable.uid, extras)] : []),
+        ]);
+        // publish the event
+        eventBus.publish('DATA_VARIABLE_LOADED', { variable, value: { data, totalCount } });
+        return Object.assign({ data,
+            totalCount }, (schema !== null && { schema }));
+    }), [variable, extras, serverTriggerCounter, eventBus]);
+    return dataCallback;
+}
+/**
+ * Get a callback to fetch derived data variable from the backend.
+ * Throws a TaskCancelledError when the backend task is cancelled.
+ *
+ * @param variable variable instance
+ * @param taskContext global task context
+ * @param wsClient websocket client instance
+ * @param dvValuePromise promise representing underlying derived variable state
+ */
+export function useFetchDerivedDataVariable(variable, taskContext, wsClient, dvValuePromise) {
+    const eventBus = useEventBus();
+    const extras = useRequestExtras();
+    const previousResult = useRef({ data: null, totalCount: 0, schema: { fields: [], primaryKey: [] } });
+    const dataCallback = useCallback((filters, pagination, options) => __awaiter(this, void 0, void 0, function* () {
+        const mergedFilters = combineFilters('AND', [variable.filters, filters]);
+        const dvValue = yield dvValuePromise;
+        const response = yield fetchDerivedDataVariable(variable.uid, extras, dvValue.cache_key, yield wsClient.getChannel(), mergedFilters, pagination);
+        let data = null;
+        const variableTaskId = `${variable.uid}-filter`;
+        // cancel previously running filter tasks
+        taskContext.cleanupRunningTasks(variableTaskId);
+        // if task was returned, wait for it to complete and fetch task result
+        if (response && 'task_id' in response) {
+            const taskId = response.task_id;
+            // add task to currently running tasks
+            taskContext.startTask(taskId, variableTaskId);
+            try {
+                yield wsClient.waitForTask(taskId);
+            }
+            catch (_a) {
+                eventBus.publish('DERIVED_DATA_VARIABLE_LOADED', { variable, value: null });
+                // If an error occurred (i.e. task was cancelled) return the previous result.
+                // This would also cause the callback's identity to change so if the consuming component is
+                // honouring the contract, it should execute the callback again
+                return previousResult.current;
+            }
+            finally {
+                taskContext.endTask(taskId);
+            }
+            data = yield fetchTaskResult(taskId, extras);
+        }
+        else {
+            // otherwise use response directly
+            data = response;
+        }
+        // For derived data variables count can only be fetched when task is not running so we have to make the request here
+        // As the total count could have changed because of the underlying DV changing
+        const [totalCount, schema = null] = yield Promise.all([
+            fetchDataVariableCount(variable.uid, extras, mergedFilters, dvValue.cache_key),
+            ...((options === null || options === void 0 ? void 0 : options.schema) ? [fetchDataVariableSchema(variable.uid, extras, dvValue.cache_key)] : []),
+        ]);
+        previousResult.current = Object.assign({ data,
+            totalCount }, (schema !== null && { schema }));
+        // publish the event
+        eventBus.publish('DERIVED_DATA_VARIABLE_LOADED', { variable, value: { data, totalCount } });
+        return Object.assign({ data,
+            totalCount }, (schema !== null && { schema }));
+    }), [variable, extras, dvValuePromise, eventBus]);
+    return dataCallback;
+}
+/**
+ * Register an empty atom for DataVariable.
+ * Used to check whether a variable is registered within the app.
+ *
+ * @param variable variable to register
+ */
+export function registerDataVariable(variable) {
+    if (!atomRegistry.has(variable.uid)) {
+        atomRegistry.set(variable.uid, atom({ default: true, key: variable.uid }));
+    }
+}
+//# sourceMappingURL=data-variable.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data-variable.js","sourceRoot":"","sources":["../../../js/shared/interactivity/data-variable.tsx"],"names":[],"mappings":";;;;;;;;;AAAA,gDAAgD;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAA4B,eAAe,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AACpF,OAAO,EAAiB,OAAO,EAAE,MAAM,YAAY,CAAC;AAIpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAsB;IACtD,OAAO;QACH,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,QAAQ,CAAC,GAAG;KACpB,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAY,EAAE,UAAuB;IACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAElD,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;QACpB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,EAAE,CAAC;QACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,EAAE,CAAC;QACnB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;QACpB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,iBAAiB,CACnC,GAAW,EACX,MAAqB,EACrB,OAAqB,EACrB,UAAuB;;QAEvB,MAAM,GAAG,GAAG,aAAa,CAAC,2BAA2B,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;QAC7G,MAAM,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,gBAAgB,CAAC,QAAQ,EAAE,+BAA+B,CAAC,CAAC;QAClE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;CAAA;AAuBD,MAAM,UAAU,cAAc,CAAC,QAAa;IACxC,OAAO,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,QAAQ,IAAI,YAAY,IAAI,QAAQ,CAAC;AAC1F,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAgB,wBAAwB,CAC1C,GAAW,EACX,MAAqB,EACrB,QAAgB,EAChB,SAAiB,EACjB,OAAqB,EACrB,UAAuB;;QAEvB,MAAM,GAAG,GAAG,aAAa,CAAC,2BAA2B,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC1B,GAAG,EACH,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,EAC3G,MAAM,CACT,CAAC;QACF,MAAM,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,gBAAgB,CAAC,QAAQ,EAAE,+BAA+B,CAAC,CAAC;QAClE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;CAAA;AAED;;;;;;GAMG;AACH,SAAe,sBAAsB,CACjC,GAAW,EACX,MAAqB,EACrB,OAAqB,EACrB,QAAiB;;QAEjB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC1B,2BAA2B,GAAG,QAAQ,EACtC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,EACpF,MAAM,CACT,CAAC;QACF,MAAM,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,gBAAgB,CAAC,QAAQ,EAAE,2CAA2C,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;CAAA;AAED;;;;;;GAMG;AACH,SAAe,uBAAuB,CAClC,GAAW,EACX,MAAqB,EACrB,QAAiB;;QAEjB,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5F,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC1B,2BAA2B,GAAG,WAAW,WAAW,EAAE,EACtD,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,EAC3B,MAAM,CACT,CAAC;QACF,MAAM,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,MAAM,gBAAgB,CAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAC;QACzE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;CAAA;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAChC,QAAsB,EACtB,oBAA4B;IAE5B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAElC,MAAM,YAAY,GAAG,WAAW,CAC5B,CAAO,OAAqB,EAAE,UAAuB,EAAE,OAA6B,EAAE,EAAE;QACpF,MAAM,aAAa,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;QAEtF,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAClD,sBAAsB,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC;YAC3D,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACrE,CAAC,CAAC;QAEZ,oBAAoB;QACpB,QAAQ,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAEpF,uBACI,IAAI;YACJ,UAAU,IACP,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC,EACpC;IACN,CAAC,CAAA,EACD,CAAC,QAAQ,EAAE,MAAM,EAAE,oBAAoB,EAAE,QAAQ,CAAC,CACrD,CAAC;IAEF,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CACvC,QAA6B,EAC7B,WAA8B,EAC9B,QAAkC,EAClC,cAA0D;IAE1D,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAClC,MAAM,cAAc,GAAG,MAAM,CAAe,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACnH,MAAM,YAAY,GAAG,WAAW,CAC5B,CAAO,OAAqB,EAAE,UAAuB,EAAE,OAA6B,EAAE,EAAE;QACpF,MAAM,aAAa,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC;QAErC,MAAM,QAAQ,GAAG,MAAM,wBAAwB,CAC3C,QAAQ,CAAC,GAAG,EACZ,MAAM,EACN,OAAO,CAAC,SAAS,EACjB,MAAM,QAAQ,CAAC,UAAU,EAAE,EAC3B,aAAa,EACb,UAAU,CACb,CAAC;QAEF,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,MAAM,cAAc,GAAG,GAAG,QAAQ,CAAC,GAAG,SAAS,CAAC;QAEhD,yCAAyC;QACzC,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAEhD,sEAAsE;QACtE,IAAI,QAAQ,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;YAEhC,sCAAsC;YACtC,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YAE9C,IAAI,CAAC;gBACD,MAAM,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACvC,CAAC;YAAC,WAAM,CAAC;gBACL,QAAQ,CAAC,OAAO,CAAC,8BAA8B,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBAE5E,6EAA6E;gBAC7E,2FAA2F;gBAC3F,+DAA+D;gBAC/D,OAAO,cAAc,CAAC,OAAO,CAAC;YAClC,CAAC;oBAAS,CAAC;gBACP,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChC,CAAC;YAED,IAAI,GAAG,MAAM,eAAe,CAAY,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACJ,kCAAkC;YAClC,IAAI,GAAG,QAA4B,CAAC;QACxC,CAAC;QAED,oHAAoH;QACpH,8EAA8E;QAC9E,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAClD,sBAAsB,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC;YAC9E,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACxF,CAAC,CAAC;QAEZ,cAAc,CAAC,OAAO,mBAClB,IAAI;YACJ,UAAU,IACP,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC,CACrC,CAAC;QAEF,oBAAoB;QACpB,QAAQ,CAAC,OAAO,CAAC,8BAA8B,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QAE5F,uBACI,IAAI;YACJ,UAAU,IACP,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC,EACpC;IACN,CAAC,CAAA,EACD,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAC/C,CAAC;IAEF,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAAsB;IACvD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC/E,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,160 @@
+import { GetRecoilValue, RecoilValue } from 'recoil';
+import { WebSocketClientInterface } from '../../api';
+import { RequestExtras } from '../../api/http';
+import { GlobalTaskContext } from '../../shared/context/global-task-context';
+import { AnyVariable, DerivedDataVariable, DerivedVariable, ResolvedDataVariable, ResolvedDerivedDataVariable, ResolvedDerivedVariable } from '../../types';
+import { TriggerIndexValue } from './store';
+export interface DerivedVariableValueResponse<T> {
+    cache_key: string;
+    value: T;
+}
+type DerivedVariableResponse<T> = DerivedVariableTaskResponse | DerivedVariableValueResponse<T>;
+export declare function isTaskResponse(dvResponse: DerivedVariableResponse<any>): dvResponse is DerivedVariableTaskResponse;
+interface DerivedVariableTaskResponse {
+    cache_key: string;
+    task_id: string;
+}
+/**
+ * Format values into a shape expected by the backend.
+ *
+ * @param values list of values - plain values or ResolvedDerivedVariable constructs with plain values nested inside
+ */
+export declare function formatDerivedVariableRequest(values: Array<any | ResolvedDerivedVariable>): any[];
+interface FetchDerivedVariableArgs {
+    cache: DerivedVariable['cache'];
+    extras: RequestExtras;
+    force: boolean;
+    is_data_variable?: boolean;
+    /**
+     * selector instance key  - each selector's requests should be treated separately
+     */
+    selectorKey: string;
+    values: Record<string | number, any>;
+    /**
+     * Variable uid
+     */
+    variableUid: string;
+    wsClient: WebSocketClientInterface;
+}
+/**
+ * Fetch the value of a derived variable from the backend
+ *
+ * @param input Function inputs
+ * - `cache`, the cache option for the derived variable.
+ * - `force`, send force=true in the request body
+ * - `extras`, request extras to be merged into the options
+ * - `uid`, the uid of the derived variable
+ * - `values`, values to pass in the request
+ * - `wsClient`, websocket client
+ */
+export declare function fetchDerivedVariable<T>({ cache, force, extras, variableUid, values, wsClient, is_data_variable, }: FetchDerivedVariableArgs): Promise<DerivedVariableResponse<T>>;
+/**
+ * Resolve a value to a format understood by the backend, resolving atoms to values.
+ *
+ * @param value value to resolve
+ * @param getter recoil getter function
+ */
+export declare function resolveValue(value: ResolvedDerivedVariable | ResolvedDerivedDataVariable | ResolvedDataVariable | RecoilValue<any>, getter: GetRecoilValue): any;
+/**
+ * Recursively build a deps array from a list of values
+ * Values not in deps array are replaced with empty array
+ *
+ * @param values array of primitives and ResolvedDerivedVariable objects
+ * @param deps array of indexes of dependencies to get values from
+ */
+export declare function getDeps(values: Array<ResolvedDerivedVariable | any>, deps?: number[]): any[];
+/**
+ * A helper hook that turns a DerivedVariable into its trigger index value.
+ * Useful to subscribe a component to forced trigger updates.
+ *
+ * @param variable variable to use
+ */
+export declare function useTriggerIndex(variable: DerivedVariable): TriggerIndexValue;
+/**
+ * DerivedVariable resolution result meaning that the value did not change since last time
+ * and should be returned from the previous entry.
+ */
+interface PreviousResult {
+    /**
+     * Previous entry in the depsRegistry found to not have been changed
+     */
+    entry: {
+        args: any[];
+        cacheKey: string;
+        result: any;
+    };
+    type: 'previous';
+}
+/**
+ * DerivedVariable resolution result meaning that the value changed since last time
+ * and should be refetched.
+ */
+interface CurrentResult {
+    /**
+     * Whether the refetch should be forcing
+     */
+    force: boolean;
+    /**
+     * List of new 'relevant' values which should be used to update the depsRegistry entry if refetch was successful
+     */
+    relevantValues: any[];
+    type: 'current';
+    /**
+     * List of values to use in the refetch request
+     */
+    values: any[];
+}
+/**
+ * Represents the result of a derived variable resolution.
+ */
+type DerivedResult = PreviousResult | CurrentResult;
+/**
+ * Resolve a derived value from a list of dependant variables and their resolved values.
+ *
+ * Handles a dependency array, where in case 'relevant' (i.e. present in deps) values did not change,
+ * an earlier result from the `depsRegistry` is returned.
+ *
+ * This is the core of the derived variable resolution logic, extracted so that it can be used in both
+ * DerivedVariable and py_component logic.
+ *
+ * @param key unique key to look up `depsRegistry` entry from
+ * @param variables dependant variables
+ * @param deps list of relevant dependant variables, akin to useEffect dependency array
+ * @param resolvedVariables resolved values of dependant variables - turned into primitives and Resolved forms
+ * @param wsClient websocket client
+ * @param get getter function to resolve atoms to values
+ * @param selfTrigger additional trigger index value to register as a dependency
+ */
+export declare function resolveDerivedValue(key: string, variables: AnyVariable<any>[], deps: AnyVariable<any>[], resolvedVariables: any[], wsClient: WebSocketClientInterface, get: GetRecoilValue, selfTrigger?: TriggerIndexValue): Promise<DerivedResult>;
+/**
+ * Get a derived variable from the selector registry, registering it if not already registered
+ *
+ * @param variable variable to register
+ * @param wsClient WebSocket client from context
+ * @param tasks tasks list from context
+ * @param currentExtras request extras to be merged into the options
+ */
+export declare function getOrRegisterDerivedVariable(variable: DerivedVariable | DerivedDataVariable, wsClient: WebSocketClientInterface, taskContext: GlobalTaskContext, currentExtras: RequestExtras): RecoilValue<DerivedVariableValueResponse<any>>;
+/**
+ * Get a derived selector for a derived variable.
+ * Retrieves the value of the derived variable directly instead of returning an object with cache_key and value.
+ *
+ * @param variable variable to register
+ * @param wsClient WebSocket client from context
+ * @param taskContext global task context
+ * @param search search query from location
+ * @param extras request extras to be merged into the options
+ */
+export declare function getOrRegisterDerivedVariableValue(variable: DerivedVariable, wsClient: WebSocketClientInterface, taskContext: GlobalTaskContext, currentExtras: RequestExtras): RecoilValue<any>;
+/**
+ * Helper hook to get the (data) derived variable selector, while correctly registering triggers and setting up polling interval.
+ *
+ * @param variable derived variable to use
+ * @param WsClient websocket client instance
+ * @param taskContext global task context
+ * @param search search query
+ * @param extras request extras to be merged into the options
+ */
+export declare function useDerivedVariable(variable: DerivedVariable | DerivedDataVariable, WsClient: WebSocketClientInterface, taskContext: GlobalTaskContext, extras: RequestExtras): RecoilValue<DerivedVariableValueResponse<any>>;
+export {};
+//# sourceMappingURL=derived-variable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"derived-variable.d.ts","sourceRoot":"","sources":["../../../js/shared/interactivity/derived-variable.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAqD,MAAM,QAAQ,CAAC;AAMxG,OAAO,EAAE,wBAAwB,EAA8C,MAAM,OAAO,CAAC;AAC7F,OAAO,EAAE,aAAa,EAA6B,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAIzE,OAAO,EACH,WAAW,EACX,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,2BAA2B,EAC3B,uBAAuB,EAM1B,MAAM,SAAS,CAAC;AAIjB,OAAO,EACH,iBAAiB,EAKpB,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,4BAA4B,CAAC,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,CAAC,CAAC;CACZ;AAED,KAAK,uBAAuB,CAAC,CAAC,IAAI,2BAA2B,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAAC;AAEhG,wBAAgB,cAAc,CAAC,UAAU,EAAE,uBAAuB,CAAC,GAAG,CAAC,GAAG,UAAU,IAAI,2BAA2B,CAElH;AAED,UAAU,2BAA2B;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AAEH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,GAAG,uBAAuB,CAAC,GAAG,GAAG,EAAE,CAiBhG;AAED,UAAU,wBAAwB;IAC9B,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,wBAAwB,CAAC;CACtC;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CAAC,CAAC,EAAE,EAC1C,KAAK,EACL,KAAK,EACL,MAAM,EACN,WAAW,EACX,MAAM,EACN,QAAQ,EACR,gBAAwB,GAC3B,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAqBhE;AAqDD;;;;;GAKG;AACH,wBAAgB,YAAY,CACxB,KAAK,EAAE,uBAAuB,GAAG,2BAA2B,GAAG,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,EACtG,MAAM,EAAE,cAAc,GACvB,GAAG,CAcL;AAED;;;;;;GAMG;AAEH,wBAAgB,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,uBAAuB,GAAG,GAAG,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE,CAU5F;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,eAAe,GAAG,iBAAiB,CAE5E;AAED;;;GAGG;AACH,UAAU,cAAc;IACpB;;OAEG;IACH,KAAK,EAAE;QACH,IAAI,EAAE,GAAG,EAAE,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,GAAG,CAAC;KACf,CAAC;IACF,IAAI,EAAE,UAAU,CAAC;CACpB;AAED;;;GAGG;AACH,UAAU,aAAa;IACnB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB,IAAI,EAAE,SAAS,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,KAAK,aAAa,GAAG,cAAc,GAAG,aAAa,CAAC;AAEpD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,mBAAmB,CACrC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,EAC7B,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,EACxB,iBAAiB,EAAE,GAAG,EAAE,EACxB,QAAQ,EAAE,wBAAwB,EAClC,GAAG,EAAE,cAAc,EACnB,WAAW,CAAC,EAAE,iBAAiB,GAChC,OAAO,CAAC,aAAa,CAAC,CAmGxB;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CACxC,QAAQ,EAAE,eAAe,GAAG,mBAAmB,EAC/C,QAAQ,EAAE,wBAAwB,EAClC,WAAW,EAAE,iBAAiB,EAC9B,aAAa,EAAE,aAAa,GAC7B,WAAW,CAAC,4BAA4B,CAAC,GAAG,CAAC,CAAC,CAsJhD;AAED;;;;;;;;;GASG;AACH,wBAAgB,iCAAiC,CAC7C,QAAQ,EAAE,eAAe,EACzB,QAAQ,EAAE,wBAAwB,EAClC,WAAW,EAAE,iBAAiB,EAC9B,aAAa,EAAE,aAAa,GAC7B,WAAW,CAAC,GAAG,CAAC,CAyClB;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAC9B,QAAQ,EAAE,eAAe,GAAG,mBAAmB,EAC/C,QAAQ,EAAE,wBAAwB,EAClC,WAAW,EAAE,iBAAiB,EAC9B,MAAM,EAAE,aAAa,GACtB,WAAW,CAAC,4BAA4B,CAAC,GAAG,CAAC,CAAC,CAqBhD"}