@finos/legend-data-cube 0.0.2

package/lib/stores/filter/DataCubeFilterEditorState.js

@@ -0,0 +1,228 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { action, computed, makeObservable, observable } from 'mobx';
+import { DataCubeQueryFilterGroupOperator, DataCubeQueryFilterOperator, } from '../core/DataCubeQueryEngine.js';
+import { deepClone, getNonNullableEntry, guaranteeNonNullable, } from '@finos/legend-shared';
+import { DataCubeFilterEditorConditionGroupTreeNode, DataCubeFilterEditorConditionTreeNode, buildFilterEditorTree, buildFilterQuerySnapshot, } from '../core/filter/DataCubeQueryFilterEditorState.js';
+import { DataCubeQuerySnapshotController } from '../core/DataCubeQuerySnapshotManager.js';
+import { DataCubeConfiguration, } from '../core/DataCubeConfiguration.js';
+import { DataCubeFilterEditor } from '../../components/filter/DataCubeFilterEditor.js';
+/**
+ * This query editor state backs the form editor for filter. It batches changes made
+ * to the filter in the form editor.
+ */
+export class DataCubeFilterEditorState extends DataCubeQuerySnapshotController {
+    display;
+    tree;
+    selectedNode;
+    columns = [];
+    constructor(view) {
+        super(view);
+        makeObservable(this, {
+            tree: observable.ref,
+            initializeTree: action,
+            refreshTree: action,
+            columns: observable.struct,
+            applySnapshot: action,
+            selectedNode: observable,
+            selectedGroupNode: computed,
+            setSelectedNode: action,
+            addFilterNode: action,
+            removeFilterNode: action,
+            layerFilterNode: action,
+        });
+        this.display = this.view.application.layout.newDisplay('Filter', () => _jsx(DataCubeFilterEditor, { view: this.view }), {
+            x: -50,
+            y: 50,
+            width: 600,
+            height: 400,
+            minWidth: 300,
+            minHeight: 200,
+            center: false,
+        });
+        this.tree = {
+            nodes: new Map(),
+        };
+    }
+    initializeTree() {
+        if (this.tree.root === undefined && this.tree.nodes.size === 0) {
+            const root = new DataCubeFilterEditorConditionGroupTreeNode(undefined, DataCubeQueryFilterGroupOperator.AND, undefined);
+            this.tree.nodes.set(root.uuid, root);
+            this.tree.root = root;
+            const condition = this.generateNewFilterNode(root);
+            if (condition) {
+                root.addChild(condition);
+                this.tree.nodes.set(condition.uuid, condition);
+            }
+            this.refreshTree();
+        }
+    }
+    refreshTree() {
+        this.tree = { ...this.tree };
+    }
+    get selectedGroupNode() {
+        return this.selectedNode instanceof
+            DataCubeFilterEditorConditionGroupTreeNode
+            ? this.selectedNode
+            : this.selectedNode?.parent;
+    }
+    setSelectedNode(node) {
+        this.selectedNode = node;
+    }
+    generateNewFilterNode(baseNode) {
+        if (baseNode instanceof DataCubeFilterEditorConditionTreeNode) {
+            return new DataCubeFilterEditorConditionTreeNode(undefined, baseNode.column, baseNode.operation, deepClone(baseNode.value), baseNode.not);
+        }
+        else if (baseNode instanceof DataCubeFilterEditorConditionGroupTreeNode) {
+            if (this.columns.length !== 0) {
+                const columnConfig = getNonNullableEntry(this.columns, 0);
+                const column = {
+                    name: columnConfig.name,
+                    type: columnConfig.type,
+                };
+                const operation = this.view.engine.getFilterOperation(DataCubeQueryFilterOperator.EQUAL);
+                return new DataCubeFilterEditorConditionTreeNode(undefined, column, operation, operation.generateDefaultValue(column), undefined);
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Add a new filter condition node just after the specified filter node.
+     * The added node is a clone of the specified node to make the filter's overall match unaffected,
+     * except if the specified node is a group node, then a new (default) condition will be added.
+     */
+    addFilterNode(baseNode) {
+        if (this.tree.root) {
+            const node = this.generateNewFilterNode(baseNode);
+            const parentNode = baseNode.parent;
+            if (parentNode && node) {
+                parentNode.addChild(node, baseNode instanceof DataCubeFilterEditorConditionTreeNode
+                    ? parentNode.children.indexOf(baseNode) + 1
+                    : undefined);
+                this.tree.nodes.set(node.uuid, node);
+                this.refreshTree();
+            }
+        }
+    }
+    /**
+     * Remove the specified filter node.
+     * If its parent node has just one child, then flatten the parent node if:
+     * 1. parent node is not the root node and has exactly one child left
+     * 2. OR parent node is the root node and has no child left, in this case,
+     *    flattening means completely remove the filter tree
+     */
+    removeFilterNode(nodeToRemove) {
+        if (this.tree.root) {
+            const parentNode = nodeToRemove.parent;
+            // skip root node
+            if (nodeToRemove !== this.tree.root && parentNode) {
+                // remove all nodes in the subtree
+                let childNodesToRemove = [nodeToRemove];
+                while (childNodesToRemove.length) {
+                    childNodesToRemove.forEach((node) => {
+                        if (node instanceof DataCubeFilterEditorConditionGroupTreeNode) {
+                            node.children.forEach((child) => {
+                                child.setParent(undefined);
+                            });
+                        }
+                        this.tree.nodes.delete(node.uuid);
+                    });
+                    childNodesToRemove = Array.from(this.tree.nodes.values()).filter((node) => node !== this.tree.root && !node.parent);
+                }
+                // remove node from parent
+                parentNode.removeChild(nodeToRemove);
+                this.tree.nodes.delete(nodeToRemove.uuid);
+                // flatten parent node if
+                // 1. parent node is not the root node and has exactly one child left
+                // 2. OR parent node is the root node and has no child left, in this case,
+                // flattening means completely remove the filter tree
+                if (parentNode.children.length === 1) {
+                    if (parentNode !== this.tree.root) {
+                        const childNode = getNonNullableEntry(parentNode.children, 0);
+                        const grandParentNode = guaranteeNonNullable(parentNode.parent);
+                        parentNode.removeChild(childNode);
+                        const parentNodeIndex = grandParentNode.children.indexOf(parentNode);
+                        grandParentNode.removeChild(parentNode);
+                        this.tree.nodes.delete(parentNode.uuid);
+                        grandParentNode.addChild(childNode, parentNodeIndex);
+                    }
+                }
+                else if (parentNode.children.length === 0) {
+                    if (parentNode === this.tree.root) {
+                        this.tree.root = undefined;
+                        this.tree.nodes.delete(parentNode.uuid);
+                    }
+                }
+                this.refreshTree();
+                if (this.selectedNode === nodeToRemove) {
+                    this.setSelectedNode(undefined);
+                }
+            }
+        }
+    }
+    /**
+     * Replace the specified filter node with a group which contains
+     * the specified node and a new condition node.
+     * The added node is a clone of the specified node to make the filter's overall match unaffected,
+     * except if the specified node is a group node, then a new (default) condition will be added.
+     */
+    layerFilterNode(baseNode) {
+        if (this.tree.root) {
+            const node = this.generateNewFilterNode(baseNode);
+            const parentNode = baseNode.parent;
+            if (parentNode && node) {
+                const baseNodeIndex = parentNode.children.indexOf(baseNode);
+                parentNode.removeChild(baseNode);
+                const subGroupNode = new DataCubeFilterEditorConditionGroupTreeNode(undefined, 
+                // Use OR condition when we create sub-group to relax filtering
+                DataCubeQueryFilterGroupOperator.OR, undefined);
+                subGroupNode.addChild(baseNode);
+                subGroupNode.addChild(node);
+                parentNode.addChild(subGroupNode, baseNodeIndex);
+                this.tree.nodes.set(subGroupNode.uuid, subGroupNode);
+                this.tree.nodes.set(node.uuid, node);
+                this.refreshTree();
+                if (this.selectedNode === baseNode) {
+                    this.setSelectedNode(subGroupNode);
+                }
+            }
+        }
+    }
+    async applySnapshot(snapshot, previousSnapshot) {
+        const configuration = DataCubeConfiguration.serialization.fromJson(snapshot.data.configuration);
+        // NOTE: filtering group-level extended columns is not supported
+        this.columns = configuration.columns.filter((column) => !snapshot.data.groupExtendedColumns.find((col) => col.name === column.name));
+        this.tree.nodes = new Map();
+        this.tree.root = snapshot.data.filter
+            ? buildFilterEditorTree(snapshot.data.filter, undefined, this.tree.nodes, (op) => this.view.engine.getFilterOperation(op))
+            : undefined;
+        this.setSelectedNode(undefined);
+        this.refreshTree();
+    }
+    applyChanges() {
+        const baseSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
+        const newSnapshot = baseSnapshot.clone();
+        newSnapshot.data.filter = this.tree.root
+            ? buildFilterQuerySnapshot(this.tree.root)
+            : undefined;
+        newSnapshot.finalize();
+        if (newSnapshot.hashCode !== baseSnapshot.hashCode) {
+            this.publishSnapshot(newSnapshot);
+        }
+    }
+}
+//# sourceMappingURL=DataCubeFilterEditorState.js.map

package/lib/stores/filter/DataCubeFilterEditorState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataCubeFilterEditorState.js","sourceRoot":"","sources":["../../../src/stores/filter/DataCubeFilterEditorState.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AACpE,OAAO,EACL,gCAAgC,EAChC,2BAA2B,GAC5B,MAAM,gCAAgC,CAAC;AAExC,OAAO,EACL,SAAS,EACT,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAGL,0CAA0C,EAC1C,qCAAqC,EACrC,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAAE,+BAA+B,EAAE,MAAM,yCAAyC,CAAC;AAC1F,OAAO,EACL,qBAAqB,GAEtB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AAEvF;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,+BAA+B;IACnE,OAAO,CAAe;IAE/B,IAAI,CAA2B;IAC/B,YAAY,CAA4C;IACxD,OAAO,GAAkC,EAAE,CAAC;IAE5C,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,cAAc,CAAC,IAAI,EAAE;YACnB,IAAI,EAAE,UAAU,CAAC,GAAG;YACpB,cAAc,EAAE,MAAM;YACtB,WAAW,EAAE,MAAM;YAEnB,OAAO,EAAE,UAAU,CAAC,MAAM;YAE1B,aAAa,EAAE,MAAM;YAErB,YAAY,EAAE,UAAU;YACxB,iBAAiB,EAAE,QAAQ;YAC3B,eAAe,EAAE,MAAM;YACvB,aAAa,EAAE,MAAM;YACrB,gBAAgB,EAAE,MAAM;YACxB,eAAe,EAAE,MAAM;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CACpD,QAAQ,EACR,GAAG,EAAE,CAAC,KAAC,oBAAoB,IAAC,IAAI,EAAE,IAAI,CAAC,IAAI,GAAI,EAC/C;YACE,CAAC,EAAE,CAAC,EAAE;YACN,CAAC,EAAE,EAAE;YACL,KAAK,EAAE,GAAG;YACV,MAAM,EAAE,GAAG;YACX,QAAQ,EAAE,GAAG;YACb,SAAS,EAAE,GAAG;YACd,MAAM,EAAE,KAAK;SACd,CACF,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG;YACV,KAAK,EAAE,IAAI,GAAG,EAAwC;SACvD,CAAC;IACJ,CAAC;IAED,cAAc;QACZ,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,0CAA0C,CACzD,SAAS,EACT,gCAAgC,CAAC,GAAG,EACpC,SAAS,CACV,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACtB,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,SAAS,EAAE,CAAC;gBACd,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACjD,CAAC;YACD,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,WAAW;QACT,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,IAAI,iBAAiB;QAGnB,OAAO,IAAI,CAAC,YAAY;YACtB,0CAA0C;YAC1C,CAAC,CAAC,IAAI,CAAC,YAAY;YACnB,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC;IAChC,CAAC;IAED,eAAe,CAAC,IAA8C;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAEO,qBAAqB,CAAC,QAAsC;QAClE,IAAI,QAAQ,YAAY,qCAAqC,EAAE,CAAC;YAC9D,OAAO,IAAI,qCAAqC,CAC9C,SAAS,EACT,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,SAAS,EAClB,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EACzB,QAAQ,CAAC,GAAG,CACb,CAAC;QACJ,CAAC;aAAM,IAAI,QAAQ,YAAY,0CAA0C,EAAE,CAAC;YAC1E,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9B,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAC1D,MAAM,MAAM,GAAG;oBACb,IAAI,EAAE,YAAY,CAAC,IAAI;oBACvB,IAAI,EAAE,YAAY,CAAC,IAAI;iBACxB,CAAC;gBACF,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CACnD,2BAA2B,CAAC,KAAK,CAClC,CAAC;gBACF,OAAO,IAAI,qCAAqC,CAC9C,SAAS,EACT,MAAM,EACN,SAAS,EACT,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,EACtC,SAAS,CACV,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,QAAsC;QAClD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;YACnC,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,UAAU,CAAC,QAAQ,CACjB,IAAI,EACJ,QAAQ,YAAY,qCAAqC;oBACvD,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAC3C,CAAC,CAAC,SAAS,CACd,CAAC;gBAEF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACrC,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,YAA0C;QACzD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC;YACvC,iBAAiB;YACjB,IAAI,YAAY,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;gBAClD,kCAAkC;gBAClC,IAAI,kBAAkB,GAAG,CAAC,YAAY,CAAC,CAAC;gBACxC,OAAO,kBAAkB,CAAC,MAAM,EAAE,CAAC;oBACjC,kBAAkB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;wBAClC,IAAI,IAAI,YAAY,0CAA0C,EAAE,CAAC;4BAC/D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gCAC9B,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;4BAC7B,CAAC,CAAC,CAAC;wBACL,CAAC;wBACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACpC,CAAC,CAAC,CAAC;oBACH,kBAAkB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC9D,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAClD,CAAC;gBACJ,CAAC;gBAED,0BAA0B;gBAC1B,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;gBAE1C,yBAAyB;gBACzB,qEAAqE;gBACrE,0EAA0E;gBAC1E,qDAAqD;gBACrD,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACrC,IAAI,UAAU,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBAClC,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;wBAC9D,MAAM,eAAe,GAAG,oBAAoB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;wBAEhE,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;wBAElC,MAAM,eAAe,GACnB,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;wBAC/C,eAAe,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;wBACxC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;wBAExC,eAAe,CAAC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;oBACvD,CAAC;gBACH,CAAC;qBAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC5C,IAAI,UAAU,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;wBAClC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;wBAC3B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,WAAW,EAAE,CAAC;gBAEnB,IAAI,IAAI,CAAC,YAAY,KAAK,YAAY,EAAE,CAAC;oBACvC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,QAAsC;QACpD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;YACnC,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC5D,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAEjC,MAAM,YAAY,GAAG,IAAI,0CAA0C,CACjE,SAAS;gBACT,+DAA+D;gBAC/D,gCAAgC,CAAC,EAAE,EACnC,SAAS,CACV,CAAC;gBAEF,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAChC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC5B,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;gBAEjD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBACrD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACrC,IAAI,CAAC,WAAW,EAAE,CAAC;gBAEnB,IAAI,IAAI,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;oBACnC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEQ,KAAK,CAAC,aAAa,CAC1B,QAA+B,EAC/B,gBAAmD;QAEnD,MAAM,aAAa,GAAG,qBAAqB,CAAC,aAAa,CAAC,QAAQ,CAChE,QAAQ,CAAC,IAAI,CAAC,aAAa,CAC5B,CAAC;QACF,gEAAgE;QAChE,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CACzC,CAAC,MAAM,EAAE,EAAE,CACT,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CACtC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAClC,CACJ,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAwC,CAAC;QAClE,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM;YACnC,CAAC,CAAC,qBAAqB,CACnB,QAAQ,CAAC,IAAI,CAAC,MAAM,EACpB,SAAS,EACT,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAChD;YACH,CAAC,CAAC,SAAS,CAAC;QACd,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAChC,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,YAAY;QACV,MAAM,YAAY,GAAG,oBAAoB,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACpE,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC;QAEzC,WAAW,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI;YACtC,CAAC,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1C,CAAC,CAAC,SAAS,CAAC;QAEd,WAAW,CAAC,QAAQ,EAAE,CAAC;QACvB,IAAI,WAAW,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;YACnD,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;CACF"}

package/lib/stores/grid/DataCubeGridClientEngine.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { GridApi, IServerSideDatasource, IServerSideGetRowsParams } from '@ag-grid-community/core';
+import type { DataCubeGridState } from './DataCubeGridState.js';
+import type { DataCubeConfiguration, DataCubeConfigurationColorKey } from '../core/DataCubeConfiguration.js';
+import { type DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
+export declare enum DataCubeGridClientExportFormat {
+    CSV = "CSV",
+    EXCEL = "EXCEL",
+    PLAIN_TEXT = "PLAIN_TEXT",
+    HTML = "HTML",
+    PDF = "PDF"
+}
+export declare enum INTERNAL__GridClientUtilityCssClassName {
+    ROOT = "data-cube-grid.ag-theme-quartz",
+    HIGHLIGHT_ROW = "data-cube-grid__utility--highlight-row",
+    SHOW_VERTICAL_GRID_LINES = "data-cube-grid__utility--show-vertical-grid-lines",
+    SHOW_HORIZONTAL_GRID_LINES = "data-cube-grid__utility--show-horizontal-grid-lines",
+    BLUR = "data-cube-grid__utility--blur",
+    FONT_FAMILY_PREFIX = "data-cube-grid__utility--font-family-",
+    FONT_SIZE_PREFIX = "data-cube-grid__utility--font-size-",
+    FONT_BOLD = "data-cube-grid__utility--font-style-bold",
+    FONT_ITALIC = "data-cube-grid__utility--font-style-italic",
+    FONT_UNDERLINE_PREFIX = "data-cube-grid__utility--font-style-underline-",
+    FONT_STRIKETHROUGH = "data-cube-grid__utility--font-style-strikethrough",
+    FONT_CASE_PREFIX = "data-cube-grid__utility--font-style-case-",
+    TEXT_ALIGN_PREFIX = "data-cube-grid__utility--text-align-",
+    TEXT_COLOR_PREFIX = "data-cube-grid__utility--text-color-",
+    BACKGROUND_COLOR_PREFIX = "data-cube-grid__utility--background-color-",
+    PIVOT_COLUMN_GROUP = "data-cube-grid__utility--pivot-column-group",
+    PIVOT_COLUMN_GROUP_PREFIX = "data-cube-grid__utility--pivot-column-group-"
+}
+export declare const generateFontFamilyUtilityClassName: (fontFamily: string) => string;
+export declare const generateFontSizeUtilityClassName: (fontSize: number) => string;
+export declare const generateFontUnderlineUtilityClassName: (variant: string | undefined) => string;
+export declare const generateFontCaseUtilityClassName: (fontCase: string | undefined) => string;
+export declare const generateTextAlignUtilityClassName: (alignment: string) => string;
+export declare const generateTextColorUtilityClassName: (color: string, key: DataCubeConfigurationColorKey) => string;
+export declare const generateBackgroundColorUtilityClassName: (color: string, key: DataCubeConfigurationColorKey) => string;
+export declare const INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE = 500;
+export declare const INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION = true;
+export declare const INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE = 10000;
+export declare const INTERNAL__GRID_CLIENT_PIVOT_COLUMN_GROUP_COLOR_ROTATION_SIZE = 5;
+export declare const INTERNAL__GRID_CLIENT_SIDE_BAR_WIDTH = 200;
+export declare const INTERNAL__GRID_CLIENT_COLUMN_MIN_WIDTH = 50;
+export declare const INTERNAL__GRID_CLIENT_HEADER_HEIGHT = 24;
+export declare const INTERNAL__GRID_CLIENT_ROW_HEIGHT = 20;
+export declare const INTERNAL__GRID_CLIENT_TOOLTIP_SHOW_DELAY = 1500;
+export declare const INTERNAL__GRID_CLIENT_AUTO_RESIZE_PADDING = 10;
+export declare const INTERNAL__GRID_CLIENT_MISSING_VALUE = "__MISSING";
+export declare const INTERNAL__GRID_CLIENT_TREE_COLUMN_ID = "ag-Grid-AutoColumn";
+export declare const INTERNAL__GRID_CLIENT_DATA_FETCH_MANUAL_TRIGGER_COLUMN_ID = "INTERNAL__dataFetchManualTrigger";
+export declare const INTERNAL__GRID_CLIENT_ROW_GROUPING_COUNT_AGG_COLUMN_ID = "INTERNAL__count";
+export declare enum GridClientPinnedAlignement {
+    LEFT = "left",
+    RIGHT = "right"
+}
+export declare enum GridClientSortDirection {
+    ASCENDING = "asc",
+    DESCENDING = "desc"
+}
+export declare function getDataForAllNodes<T>(client: GridApi<T>): T[];
+/**
+ * NOTE: this method does not work for server-side row model.
+ * It only works when client-side filter is being applied
+ */
+export declare function getDataForAllFilteredNodes<T>(client: GridApi<T>): T[];
+/**
+ * This method computes the hash code for the parts of the snapshot that should trigger data fetching.
+ * This is used to manually trigger server-side row model data source getRows() method.
+ */
+export declare function computeHashCodeForDataFetchManualTrigger(snapshot: DataCubeQuerySnapshot, configuration: DataCubeConfiguration): string;
+export declare class DataCubeGridClientServerSideDataSource implements IServerSideDatasource {
+    readonly grid: DataCubeGridState;
+    rowCount: number | undefined;
+    constructor(grid: DataCubeGridState);
+    fetchRows(params: IServerSideGetRowsParams<unknown, unknown>): Promise<void>;
+    getRows(params: IServerSideGetRowsParams<unknown, unknown>): void;
+}
+//# sourceMappingURL=DataCubeGridClientEngine.d.ts.map

package/lib/stores/grid/DataCubeGridClientEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataCubeGridClientEngine.d.ts","sourceRoot":"","sources":["../../../src/stores/grid/DataCubeGridClientEngine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EACV,OAAO,EAEP,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAkBhE,OAAO,KAAK,EACV,qBAAqB,EACrB,6BAA6B,EAC9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAEL,KAAK,qBAAqB,EAE3B,MAAM,kCAAkC,CAAC;AAc1C,oBAAY,8BAA8B;IACxC,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,GAAG,QAAQ;CACZ;AAED,oBAAY,uCAAuC;IACjD,IAAI,mCAAmC;IACvC,aAAa,2CAA2C;IACxD,wBAAwB,sDAAsD;IAC9E,0BAA0B,wDAAwD;IAElF,IAAI,kCAAkC;IAEtC,kBAAkB,0CAA0C;IAC5D,gBAAgB,wCAAwC;IACxD,SAAS,6CAA6C;IACtD,WAAW,+CAA+C;IAC1D,qBAAqB,mDAAmD;IACxE,kBAAkB,sDAAsD;IACxE,gBAAgB,8CAA8C;IAC9D,iBAAiB,yCAAyC;IAC1D,iBAAiB,yCAAyC;IAC1D,uBAAuB,+CAA+C;IAEtE,kBAAkB,gDAAgD;IAClE,yBAAyB,iDAAiD;CAC3E;AACD,eAAO,MAAM,kCAAkC,eAAgB,MAAM,WAC8B,CAAC;AACpG,eAAO,MAAM,gCAAgC,aAAc,MAAM,WACS,CAAC;AAC3E,eAAO,MAAM,qCAAqC,YACvC,MAAM,GAAG,SAAS,WAE2D,CAAC;AACzF,eAAO,MAAM,gCAAgC,aACjC,MAAM,GAAG,SAAS,WAEsD,CAAC;AACrF,eAAO,MAAM,iCAAiC,cAAe,MAAM,WACS,CAAC;AAC7E,eAAO,MAAM,iCAAiC,UACrC,MAAM,OACR,6BAA6B,WAEwD,CAAC;AAC7F,eAAO,MAAM,uCAAuC,UAC3C,MAAM,OACR,6BAA6B,WAE8D,CAAC;AAKnG,eAAO,MAAM,8CAA8C,MAAM,CAAC;AAClE,eAAO,MAAM,+CAA+C,OAAO,CAAC;AAGpE,eAAO,MAAM,0CAA0C,QAAM,CAAC;AAE9D,eAAO,MAAM,4DAA4D,IAAI,CAAC;AAC9E,eAAO,MAAM,oCAAoC,MAAM,CAAC;AACxD,eAAO,MAAM,sCAAsC,KAAK,CAAC;AACzD,eAAO,MAAM,mCAAmC,KAAK,CAAC;AACtD,eAAO,MAAM,gCAAgC,KAAK,CAAC;AACnD,eAAO,MAAM,wCAAwC,OAAO,CAAC;AAC7D,eAAO,MAAM,yCAAyC,KAAK,CAAC;AAC5D,eAAO,MAAM,mCAAmC,cAAc,CAAC;AAC/D,eAAO,MAAM,oCAAoC,uBAAuB,CAAC;AACzE,eAAO,MAAM,yDAAyD,qCAClC,CAAC;AACrC,eAAO,MAAM,sDAAsD,oBAChD,CAAC;AAEpB,oBAAY,0BAA0B;IACpC,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,oBAAY,uBAAuB;IACjC,SAAS,QAAQ;IACjB,UAAU,SAAS;CACpB;AAED,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAQ7D;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAQrE;AAED;;;GAGG;AACH,wBAAgB,wCAAwC,CACtD,QAAQ,EAAE,qBAAqB,EAC/B,aAAa,EAAE,qBAAqB,UA6BrC;AAuED,qBAAa,sCACX,YAAW,qBAAqB;IAEhC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAa;gBAE7B,IAAI,EAAE,iBAAiB;IAQ7B,SAAS,CAAC,MAAM,EAAE,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC;IAyMlE,OAAO,CAAC,MAAM,EAAE,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC;CAS3D"}