@finos/legend-data-cube 0.1.0 → 0.1.1

package/lib/stores/view/grid/DataCubeGridState.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { debounce, guaranteeNonNullable, } from '@finos/legend-shared';
-import { action, makeObservable, observable } from 'mobx';
+import { action, makeObservable, observable, runInAction } from 'mobx';
 import { DataCubeGridClientServerSideDataSource, INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE, INTERNAL__GRID_CLIENT_DATA_FETCH_MANUAL_TRIGGER_COLUMN_ID, INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE, INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION, computeHashCodeForDataFetchManualTrigger, INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_CACHING, } from './DataCubeGridClientEngine.js';
 import { DataCubeQuerySnapshotController } from '../../services/DataCubeQuerySnapshotService.js';
 import { generateGridOptionsFromSnapshot } from './DataCubeGridConfigurationBuilder.js';
@@ -87,17 +87,27 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
         });
     }
     async setCachingEnabled(val) {
-        this.isCachingEnabled = val;
-        if (this.isCachingEnabled) {
-            this._client?.setGridOption('loading', true);
+        const currentVal = this.isCachingEnabled;
+        if (val === currentVal) {
+            return;
+        }
+        runInAction(() => {
+            this.isCachingEnabled = val;
+        });
+        if (val) {
             await this._view.initializeCache();
-            this._client?.setGridOption('loading', false);
+            if (this._view.processCacheState.hasFailed) {
+                this.isCachingEnabled = currentVal;
+                return;
+            }
         }
         else {
-            this._client?.setGridOption('loading', true);
-            await this._view.clearCache();
-            this._client?.setGridOption('loading', false);
+            await this._view.disposeCache();
         }
+        runInAction(() => {
+            // hard reset the grid, this will force the grid to fetch data again
+            this.clientDataSource = new DataCubeGridClientServerSideDataSource(this, this._view);
+        });
     }
     setScrollHintText(val) {
         this.scrollHintText = val;

package/lib/stores/view/grid/DataCubeGridState.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataCubeGridState.js","sourceRoot":"","sources":["../../../../src/stores/view/grid/DataCubeGridState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,QAAQ,EACR,oBAAoB,GAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAG1D,OAAO,EACL,sCAAsC,EACtC,8CAA8C,EAC9C,yDAAyD,EACzD,0CAA0C,EAC1C,+CAA+C,EAC/C,wCAAwC,EACxC,4CAA4C,GAC7C,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AAEjG,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,iBAAkB,SAAQ,+BAA+B;IACnD,KAAK,CAAoB;IAEjC,UAAU,CAA8B;IAExC,YAAY,CAAiC;IAC9C,OAAO,CAAuB;IACtC,gBAAgB,CAAyC;IAEzD,kBAAkB,CAAwB;IAC1C,QAAQ,CAAsB;IAC9B,mBAAmB,GAAG,+CAA+C,CAAC;IACtE,gBAAgB,GAAG,4CAA4C,CAAC;IAChE,cAAc,CAAsB;IACpC,4FAA4F;IAC5F,+FAA+F;IAC/F,0BAA0B,CAA6B;IAEvD,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAE9D,cAAc,CAAC,IAAI,EAAE;YACnB,gBAAgB,EAAE,UAAU;YAE5B,kBAAkB,EAAE,UAAU;YAE9B,QAAQ,EAAE,UAAU;YAEpB,mBAAmB,EAAE,UAAU;YAC/B,oBAAoB,EAAE,MAAM;YAE5B,gBAAgB,EAAE,UAAU;YAC5B,iBAAiB,EAAE,MAAM;YAEzB,cAAc,EAAE,UAAU;YAC1B,iBAAiB,EAAE,MAAM;YAEzB,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,kBAAkB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;IACJ,CAAC;IAED,oBAAoB,CAAC,GAAY;QAC/B,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;QAE/B,oEAAoE;QACpE,sFAAsF;QACtF,0EAA0E;QAC1E,gEAAgE;QAChE,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;QACF,sFAAsF;QACtF,gGAAgG;QAChG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,cAAc,EAAE,GAAG;gBACjB,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,GAAY;QAClC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC;QAC5B,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,GAAuB;QACvC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;IAC7E,CAAC;IAED,eAAe,CAAC,GAAwB;QACtC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,IAAI,CAAC,0BAA0B,GAAG,QAAQ,CACxC,GAAG,EAAE,CAAC,GAAG,EAAE,kBAAkB,EAAE,EAC/B,GAAG,CACJ,CAAC;IACJ,CAAC;IAEQ,yBAAyB;QAChC,OAAO,MAAM,CAAC;IAChB,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,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAEpC,MAAM,WAAW,GAAG,+BAA+B,CACjD,QAAQ,EACR,aAAa,EACb,IAAI,CAAC,KAAK,CACX,CAAC;QACF,IACE,IAAI,CAAC,eAAe,CAAC,eAAe,CAClC,kBAAkB,CAAC,2BAA2B,CAC/C,EACD,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,EAAE;gBAC5C,cAAc;gBACd,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,GAAG,WAAW;YACd,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAC7C,kBAAkB,CAAC,uBAAuB,CAC3C;YACD,mBAAmB,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CACvD,kBAAkB,CAAC,mCAAmC,CACvD;YACD,sFAAsF;YACtF,gGAAgG;YAChG,cAAc,EAAE,IAAI,CAAC,mBAAmB;gBACtC,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;QAEH,+FAA+F;QAC/F,6FAA6F;QAC7F,gGAAgG;QAChG,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;YACzB,CAAC,yDAAyD,CAAC,EAAE;gBAC3D,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,wCAAwC,CAC9C,QAAQ,EACR,aAAa,CACd;aACF;SACF,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"DataCubeGridState.js","sourceRoot":"","sources":["../../../../src/stores/view/grid/DataCubeGridState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,QAAQ,EACR,oBAAoB,GAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAGvE,OAAO,EACL,sCAAsC,EACtC,8CAA8C,EAC9C,yDAAyD,EACzD,0CAA0C,EAC1C,+CAA+C,EAC/C,wCAAwC,EACxC,4CAA4C,GAC7C,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AAEjG,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,iBAAkB,SAAQ,+BAA+B;IACnD,KAAK,CAAoB;IAEjC,UAAU,CAA8B;IAExC,YAAY,CAAiC;IAC9C,OAAO,CAAuB;IACtC,gBAAgB,CAAyC;IAEzD,kBAAkB,CAAwB;IAC1C,QAAQ,CAAsB;IAC9B,mBAAmB,GAAG,+CAA+C,CAAC;IACtE,gBAAgB,GAAG,4CAA4C,CAAC;IAChE,cAAc,CAAsB;IACpC,4FAA4F;IAC5F,+FAA+F;IAC/F,0BAA0B,CAA6B;IAEvD,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAE9D,cAAc,CAAC,IAAI,EAAE;YACnB,gBAAgB,EAAE,UAAU;YAE5B,kBAAkB,EAAE,UAAU;YAE9B,QAAQ,EAAE,UAAU;YAEpB,mBAAmB,EAAE,UAAU;YAC/B,oBAAoB,EAAE,MAAM;YAE5B,gBAAgB,EAAE,UAAU;YAC5B,iBAAiB,EAAE,MAAM;YAEzB,cAAc,EAAE,UAAU;YAC1B,iBAAiB,EAAE,MAAM;YAEzB,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,kBAAkB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;IACJ,CAAC;IAED,oBAAoB,CAAC,GAAY;QAC/B,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;QAE/B,oEAAoE;QACpE,sFAAsF;QACtF,0EAA0E;QAC1E,gEAAgE;QAChE,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;QACF,sFAAsF;QACtF,gGAAgG;QAChG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,cAAc,EAAE,GAAG;gBACjB,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,GAAY;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACzC,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,WAAW,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,SAAS,EAAE,CAAC;gBAC3C,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;gBACnC,OAAO;YACT,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QAClC,CAAC;QAED,WAAW,CAAC,GAAG,EAAE;YACf,oEAAoE;YACpE,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,GAAuB;QACvC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;IAC7E,CAAC;IAED,eAAe,CAAC,GAAwB;QACtC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,IAAI,CAAC,0BAA0B,GAAG,QAAQ,CACxC,GAAG,EAAE,CAAC,GAAG,EAAE,kBAAkB,EAAE,EAC/B,GAAG,CACJ,CAAC;IACJ,CAAC;IAEQ,yBAAyB;QAChC,OAAO,MAAM,CAAC;IAChB,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,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAEpC,MAAM,WAAW,GAAG,+BAA+B,CACjD,QAAQ,EACR,aAAa,EACb,IAAI,CAAC,KAAK,CACX,CAAC;QACF,IACE,IAAI,CAAC,eAAe,CAAC,eAAe,CAClC,kBAAkB,CAAC,2BAA2B,CAC/C,EACD,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,EAAE;gBAC5C,cAAc;gBACd,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,GAAG,WAAW;YACd,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAC7C,kBAAkB,CAAC,uBAAuB,CAC3C;YACD,mBAAmB,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CACvD,kBAAkB,CAAC,mCAAmC,CACvD;YACD,sFAAsF;YACtF,gGAAgG;YAChG,cAAc,EAAE,IAAI,CAAC,mBAAmB;gBACtC,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;QAEH,+FAA+F;QAC/F,6FAA6F;QAC7F,gGAAgG;QAChG,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;YACzB,CAAC,yDAAyD,CAAC,EAAE;gBAC3D,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,wCAAwC,CAC9C,QAAQ,EACR,aAAa,CACd;aACF;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-data-cube",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Legend DataCube",
   "keywords": [
     "legend",
@@ -42,16 +42,16 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@finos/legend-art": "7.1.79",
-    "@finos/legend-code-editor": "2.0.42",
-    "@finos/legend-graph": "32.1.0",
-    "@finos/legend-shared": "11.0.1",
+    "@finos/legend-art": "7.1.80",
+    "@finos/legend-code-editor": "2.0.43",
+    "@finos/legend-graph": "32.1.1",
+    "@finos/legend-shared": "11.0.2",
     "@types/react": "19.0.8",
     "ag-grid-community": "33.0.4",
     "ag-grid-enterprise": "33.0.4",
     "ag-grid-react": "33.0.4",
-    "mathjs": "14.1.0",
-    "mobx": "6.13.5",
+    "mathjs": "14.2.1",
+    "mobx": "6.13.6",
     "mobx-react-lite": "4.1.0",
     "monaco-editor": "0.52.2",
     "react": "19.0.0",

package/src/components/view/grid/DataCubeGrid.tsx

@@ -44,6 +44,7 @@ import type {
 } from '../../../stores/core/model/DataCubeConfiguration.js';
 import { generateBaseGridOptions } from '../../../stores/view/grid/DataCubeGridConfigurationBuilder.js';
 import type { DataCubeViewState } from '../../../stores/view/DataCubeViewState.js';
+import { FormBadge_WIP } from '../../core/DataCubeFormUtils.js';
 
 // NOTE: This is a workaround to prevent ag-grid license key check from flooding the console screen
 // with its stack trace in Chrome.
@@ -318,8 +319,9 @@ const DataCubeGridStatusBar = observer((props: { view: DataCubeViewState }) => {
             Pagination
           </div>
         </button>
-        {view.dataCube.options?.enableCache !== undefined &&
-          view.dataCube.options.enableCache && (
+        {view.dataCube.options?.enableCache && (
+          <>
+            <div className="h-3 w-[1px] bg-neutral-200" />
             <button
               className="flex h-full items-center p-2"
               // eslint-disable-next-line @typescript-eslint/no-misused-promises
@@ -347,15 +349,16 @@ const DataCubeGridStatusBar = observer((props: { view: DataCubeViewState }) => {
                 disableFocusRipple={true}
               />
               <div
-                className={cn('text-sm', {
+                className={cn('flex items-center text-sm', {
                   'text-sky-600': grid.isCachingEnabled,
                   'text-neutral-500': !grid.isCachingEnabled,
                 })}
               >
-                Cache (BETA)
+                Cache <FormBadge_WIP />
               </div>
             </button>
-          )}
+          </>
+        )}
       </div>
     </div>
   );

package/src/index.tsx

@@ -19,12 +19,11 @@ export * from './stores/core/model/DataCubeSource.js';
 export { type DataCubeColumn } from './stores/core/model/DataCubeColumn.js';
 export * from './stores/core/model/DataCubeConfiguration.js';
 export * from './stores/core/model/AdhocQueryDataCubeSource.js';
+export { CachedDataCubeSource } from './stores/core/model/CachedDataCubeSource.js';
 
 export * from './stores/core/DataCubeEngine.js';
 export * from './stores/core/DataCubeQueryEngine.js';
-export * from './stores/core/DataCubeQueryBuilderUtils.js';
 export { DataCubeQuerySnapshot } from './stores/core/DataCubeQuerySnapshot.js';
-export * from './stores/core/filter/DataCubeQueryFilterOperation.js';
 
 export {
   type DataCubeSetting,
@@ -54,4 +53,10 @@ export * from './components/DataCube.js';
 export * from './components/core/DataCubeFormUtils.js';
 export * from './components/DataCubePlaceholder.js';
 
-export { CachedDataCubeSource } from './stores/core/model/CachedDataCubeSource.js';
+// some low-level/core utilities we expose for building DataCube extensions
+// or implementing DataCube engine
+export {
+  _function,
+  _lambda,
+  _elementPtr,
+} from './stores/core/DataCubeQueryBuilderUtils.js';

package/src/stores/DataCubeAPI.ts

@@ -15,6 +15,7 @@
  */
 
 import type { DataCubeQuery } from './core/model/DataCubeQuery.js';
+import type { DataCubeSource } from './core/model/DataCubeSource.js';
 import type { DataCubeState } from './DataCubeState.js';
 import type { DataCubeViewState } from './view/DataCubeViewState.js';
 
@@ -23,6 +24,10 @@ import type { DataCubeViewState } from './view/DataCubeViewState.js';
  * internal components and functionalities.
  */
 export interface DataCubeAPI {
+  /**
+   * Get the processed source of the DataCube.
+   */
+  getProcessedSource(): DataCubeSource | undefined;
   /**
    * Generates the data cube query (including the query, configuration, and source)
    * from the latest state of the DataCube.
@@ -61,6 +66,10 @@ export class INTERNAL__DataCubeAPI implements DataCubeAPI {
 
   // ----------------------------- API -----------------------------
 
+  getProcessedSource() {
+    return this._dataCube.view.getOriginalSource();
+  }
+
   generateDataCubeQuery() {
     return this._dataCube.view.generateDataCubeQuery();
   }

package/src/stores/DataCubeOptions.ts

@@ -127,7 +127,7 @@ export type DataCubeOptions = {
    */
   documentationUrl?: string | undefined;
   /**
-   * Enable/Disable caching of data for the application.
+   * Enables caching to suppport local query execution.
    */
   enableCache?: boolean | undefined;
 };

package/src/stores/core/DataCubeConfigurationBuilder.ts

@@ -133,7 +133,7 @@ export function newConfiguration(
   //
   // since we have made sure all groupBy sort columns must be of the same direction
   // we simply retrieve the direction from the one of the column provided
-  if (groupBySortColumns.length) {
+  if (groupBySortColumns?.length) {
     configuration.treeColumnSortDirection = at(groupBySortColumns, 0).direction;
   }
 

package/src/stores/core/DataCubeEngine.tsx

@@ -20,6 +20,8 @@ import {
   type TDSExecutionResult,
   type V1_AppliedFunction,
   PRIMITIVE_TYPE,
+  V1_deserializeValueSpecification,
+  V1_serializeValueSpecification,
 } from '@finos/legend-graph';
 import {
   getFilterOperation,
@@ -65,20 +67,25 @@ import { DataCubeQueryFilterOperation__EndWithCaseInsensitive } from './filter/D
 import { DataCubeQueryFilterOperation__NotEndWith } from './filter/DataCubeQueryFilterOperation__NotEndWith.js';
 import { DataCubeQueryFilterOperation__IsNull } from './filter/DataCubeQueryFilterOperation__IsNull.js';
 import { DataCubeQueryFilterOperation__IsNotNull } from './filter/DataCubeQueryFilterOperation__IsNotNull.js';
-import type { DataCubeQuerySnapshot } from './DataCubeQuerySnapshot.js';
+import { DataCubeQuerySnapshot } from './DataCubeQuerySnapshot.js';
 import { buildExecutableQuery } from './DataCubeQueryBuilder.js';
-import type { DataCubeColumn } from './model/DataCubeColumn.js';
+import { _toCol, type DataCubeColumn } from './model/DataCubeColumn.js';
 import {
   type DataCubeSource,
   INTERNAL__DataCubeSource,
 } from './model/DataCubeSource.js';
-import { _primitiveValue } from './DataCubeQueryBuilderUtils.js';
+import {
+  _primitiveValue,
+  _selectFunction,
+} from './DataCubeQueryBuilderUtils.js';
 import {
   type DocumentationEntry,
   type LogEvent,
   type PlainObject,
 } from '@finos/legend-shared';
 import type { CachedDataCubeSource } from './model/CachedDataCubeSource.js';
+import { DataCubeQuery } from './model/DataCubeQuery.js';
+import { newConfiguration } from './DataCubeConfigurationBuilder.js';
 
 export type CompletionItem = {
   completion: string;
@@ -168,6 +175,14 @@ export abstract class DataCubeEngine {
     return getAggregateOperation(value, this.aggregateOperations);
   }
 
+  deserializeValueSpecification(json: PlainObject<V1_ValueSpecification>) {
+    return V1_deserializeValueSpecification(json, []);
+  }
+
+  serializeValueSpecification(protocol: V1_ValueSpecification) {
+    return V1_serializeValueSpecification(protocol, []);
+  }
+
   /**
    * By default, for a function chain, Pure grammar composer will extract the first parameter of the first function
    * and render it as the caller of that function rather than a parameter
@@ -184,21 +199,34 @@ export abstract class DataCubeEngine {
     source.query = _primitiveValue(PRIMITIVE_TYPE.STRING, '');
     return (
       await this.getValueSpecificationCode(
-        buildExecutableQuery(
-          snapshot,
-          source,
-          () => undefined,
-          this.filterOperations,
-          this.aggregateOperations,
-        ),
+        buildExecutableQuery(snapshot, source, this, {
+          skipExecutionContext: true,
+        }),
         pretty,
       )
     ).substring(`''->`.length);
   }
 
+  async generateBaseQuery(sourceData: PlainObject) {
+    const source = await this.processQuerySource(sourceData);
+    const query = new DataCubeQuery();
+    query.source = sourceData;
+    query.query = await this.getValueSpecificationCode(
+      _selectFunction(source.columns),
+    );
+    const snapshot = DataCubeQuerySnapshot.create({});
+    snapshot.data.sourceColumns = source.columns.map(_toCol);
+    snapshot.data.selectColumns = source.columns.map(_toCol);
+    const configuration = newConfiguration({
+      snapshot,
+    });
+    query.configuration = configuration;
+    return query;
+  }
+
   // ---------------------------------- PROCESSOR ----------------------------------
 
-  abstract processQuerySource(value: PlainObject): Promise<DataCubeSource>;
+  abstract processQuerySource(sourceData: PlainObject): Promise<DataCubeSource>;
 
   abstract parseValueSpecification(
     code: string,
@@ -237,12 +265,7 @@ export abstract class DataCubeEngine {
     source: DataCubeSource,
   ): V1_AppliedFunction | undefined;
 
-  processInitialSnapshot?(
-    source: DataCubeSource,
-    snapshot: DataCubeQuerySnapshot,
-  ): DataCubeQuerySnapshot;
-
-  // ---------------------------------- CACHING --------------------------------------
+  // ---------------------------------- CACHING ----------------------------------
 
   async initializeCache(
     source: DataCubeSource,
@@ -250,9 +273,7 @@ export abstract class DataCubeEngine {
     return undefined;
   }
 
-  async clearCache() {
-    // do nothing
-  }
+  async disposeCache(source: CachedDataCubeSource) {}
 
   // ---------------------------------- APPLICATION ----------------------------------
 

package/src/stores/core/DataCubeQueryBuilder.ts

@@ -21,22 +21,24 @@
  * the query snapshot. The executable query is then used to fetch data.
  ***************************************************************************************/
 
-import { PRIMITIVE_TYPE, type V1_AppliedFunction } from '@finos/legend-graph';
+import {
+  PRIMITIVE_TYPE,
+  V1_Lambda,
+  type V1_AppliedFunction,
+} from '@finos/legend-graph';
 import { type DataCubeQuerySnapshot } from './DataCubeQuerySnapshot.js';
-import { at } from '@finos/legend-shared';
+import { at, guaranteeType } from '@finos/legend-shared';
 import {
   DataCubeFunction,
   DataCubeQuerySortDirection,
   type DataCubeQueryFunctionMap,
 } from './DataCubeQueryEngine.js';
 import { DataCubeConfiguration } from './model/DataCubeConfiguration.js';
-import type { DataCubeQueryFilterOperation } from './filter/DataCubeQueryFilterOperation.js';
 import {
   _col,
   _collection,
   _cols,
   _colSpec,
-  _deserializeLambda,
   _filter,
   _function,
   _groupByAggCols,
@@ -48,26 +50,21 @@ import {
   _functionCompositionProcessor,
   _extendRootAggregation,
 } from './DataCubeQueryBuilderUtils.js';
-import type { DataCubeQueryAggregateOperation } from './aggregation/DataCubeQueryAggregateOperation.js';
 import type { DataCubeSource } from './model/DataCubeSource.js';
 import { _findCol } from './model/DataCubeColumn.js';
+import type { DataCubeEngine } from './DataCubeEngine.js';
 
 export function buildExecutableQuery(
   snapshot: DataCubeQuerySnapshot,
   source: DataCubeSource,
-  executionContextBuilder: (
-    source: DataCubeSource,
-  ) => V1_AppliedFunction | undefined,
-  filterOperations: DataCubeQueryFilterOperation[],
-  aggregateOperations: DataCubeQueryAggregateOperation[],
+  engine: DataCubeEngine,
   options?: {
     postProcessor?: (
       snapshot: DataCubeQuerySnapshot,
       sequence: V1_AppliedFunction[],
       funcMap: DataCubeQueryFunctionMap,
       configuration: DataCubeConfiguration,
-      filterOperations: DataCubeQueryFilterOperation[],
-      aggregateOperations: DataCubeQueryAggregateOperation[],
+      engine: DataCubeEngine,
     ) => void;
     rootAggregation?:
       | {
@@ -101,8 +98,16 @@ export function buildExecutableQuery(
           _cols([
             _colSpec(
               col.name,
-              _deserializeLambda(col.mapFn),
-              col.reduceFn ? _deserializeLambda(col.reduceFn) : undefined,
+              guaranteeType(
+                engine.deserializeValueSpecification(col.mapFn),
+                V1_Lambda,
+              ),
+              col.reduceFn
+                ? guaranteeType(
+                    engine.deserializeValueSpecification(col.reduceFn),
+                    V1_Lambda,
+                  )
+                : undefined,
             ),
           ]),
         ]),
@@ -116,7 +121,7 @@ export function buildExecutableQuery(
     _process(
       'filter',
       _function(DataCubeFunction.FILTER, [
-        _lambda([_var()], [_filter(data.filter, filterOperations)]),
+        _lambda([_var()], [_filter(data.filter, engine.filterOperations)]),
       ]),
     );
   }
@@ -164,7 +169,7 @@ export function buildExecutableQuery(
             pivot.columns,
             snapshot,
             configuration,
-            aggregateOperations,
+            engine.aggregateOperations,
           ),
         ),
       ]),
@@ -194,7 +199,7 @@ export function buildExecutableQuery(
             groupBy.columns,
             snapshot,
             configuration,
-            aggregateOperations,
+            engine.aggregateOperations,
           ),
         ),
       ]),
@@ -227,8 +232,16 @@ export function buildExecutableQuery(
           _cols([
             _colSpec(
               col.name,
-              _deserializeLambda(col.mapFn),
-              col.reduceFn ? _deserializeLambda(col.reduceFn) : undefined,
+              guaranteeType(
+                engine.deserializeValueSpecification(col.mapFn),
+                V1_Lambda,
+              ),
+              col.reduceFn
+                ? guaranteeType(
+                    engine.deserializeValueSpecification(col.reduceFn),
+                    V1_Lambda,
+                  )
+                : undefined,
             ),
           ]),
         ]),
@@ -280,19 +293,14 @@ export function buildExecutableQuery(
 
   // --------------------------------- FINALIZE ---------------------------------
 
-  const executionContext = executionContextBuilder(source);
-  if (executionContext) {
-    sequence.push(executionContext);
+  if (!options?.skipExecutionContext) {
+    const executionContext = engine.buildExecutionContext(source);
+    if (executionContext) {
+      sequence.push(executionContext);
+    }
   }
 
-  options?.postProcessor?.(
-    snapshot,
-    sequence,
-    funcMap,
-    configuration,
-    filterOperations,
-    aggregateOperations,
-  );
+  options?.postProcessor?.(snapshot, sequence, funcMap, configuration, engine);
 
   if (sequence.length === 0) {
     return source.query;

package/src/stores/core/DataCubeQueryBuilderUtils.ts

@@ -43,7 +43,6 @@ import {
   V1_PackageableElementPtr,
   type V1_PrimitiveValueSpecification,
   V1_Variable,
-  V1_deserializeValueSpecification,
   extractElementNameFromPath,
   type V1_ValueSpecification,
   extractPackagePathFromPath,
@@ -53,7 +52,6 @@ import {
   V1_createGenericTypeWithRawType,
   V1_createRelationType,
   V1_createRelationTypeColumn,
-  V1_serializeValueSpecification,
 } from '@finos/legend-graph';
 import {
   type DataCubeQuerySnapshotFilterCondition,
@@ -67,8 +65,6 @@ import {
   guaranteeIsBoolean,
   guaranteeIsNumber,
   UnsupportedOperationError,
-  guaranteeType,
-  type PlainObject,
 } from '@finos/legend-shared';
 import {
   DataCubeFunction,
@@ -91,69 +87,6 @@ import {
 
 // --------------------------------- UTILITIES ---------------------------------
 
-export function _functionCompositionProcessor(
-  sequence: V1_AppliedFunction[],
-  funcMap: DataCubeQueryFunctionMap,
-) {
-  return (
-    key: keyof DataCubeQueryFunctionMap,
-    data: V1_AppliedFunction | V1_AppliedFunction[],
-  ) => {
-    switch (key) {
-      case 'leafExtend':
-      case 'groupExtend': {
-        if (Array.isArray(data)) {
-          data.forEach((func) => sequence.push(func));
-          funcMap[key] = data;
-        }
-        break;
-      }
-      default: {
-        funcMap[key] = data as V1_AppliedFunction;
-        sequence.push(data as V1_AppliedFunction);
-      }
-    }
-  };
-}
-
-export function _functionCompositionUnProcessor(
-  sequence: V1_AppliedFunction[],
-  funcMap: DataCubeQueryFunctionMap,
-) {
-  return (key: keyof DataCubeQueryFunctionMap) => {
-    const data = funcMap[key];
-    if (data) {
-      if (Array.isArray(data)) {
-        data.forEach((func) => sequence.splice(sequence.indexOf(func), 1));
-      } else {
-        sequence.splice(sequence.indexOf(data), 1);
-      }
-      funcMap[key] = undefined;
-    }
-  };
-}
-
-export function _deserializeLambda(json: PlainObject<V1_Lambda>) {
-  return guaranteeType(V1_deserializeValueSpecification(json, []), V1_Lambda);
-}
-
-export function _deserializeValueSpecification(
-  json: PlainObject<V1_ValueSpecification>,
-) {
-  return V1_deserializeValueSpecification(json, []);
-}
-
-export function _serializeValueSpecification(protocol: V1_ValueSpecification) {
-  return V1_serializeValueSpecification(protocol, []);
-}
-
-export function _deserializeFunction(json: PlainObject<V1_Lambda>) {
-  return guaranteeType(
-    V1_deserializeValueSpecification(json, []),
-    V1_AppliedFunction,
-  );
-}
-
 export function _var() {
   const variable = new V1_Variable();
   // NOTE: we simplify processing logic by forcing all variable names to default value, i.e. x
@@ -356,6 +289,48 @@ export function _cols(colSpecs: V1_ColSpec[]) {
 
 // --------------------------------- BUILDING BLOCKS ---------------------------------
 
+export function _functionCompositionProcessor(
+  sequence: V1_AppliedFunction[],
+  funcMap: DataCubeQueryFunctionMap,
+) {
+  return (
+    key: keyof DataCubeQueryFunctionMap,
+    data: V1_AppliedFunction | V1_AppliedFunction[],
+  ) => {
+    switch (key) {
+      case 'leafExtend':
+      case 'groupExtend': {
+        if (Array.isArray(data)) {
+          data.forEach((func) => sequence.push(func));
+          funcMap[key] = data;
+        }
+        break;
+      }
+      default: {
+        funcMap[key] = data as V1_AppliedFunction;
+        sequence.push(data as V1_AppliedFunction);
+      }
+    }
+  };
+}
+
+export function _functionCompositionUnProcessor(
+  sequence: V1_AppliedFunction[],
+  funcMap: DataCubeQueryFunctionMap,
+) {
+  return (key: keyof DataCubeQueryFunctionMap) => {
+    const data = funcMap[key];
+    if (data) {
+      if (Array.isArray(data)) {
+        data.forEach((func) => sequence.splice(sequence.indexOf(func), 1));
+      } else {
+        sequence.splice(sequence.indexOf(data), 1);
+      }
+      funcMap[key] = undefined;
+    }
+  };
+}
+
 export function _selectFunction(columns: DataCubeColumn[]) {
   return _function(DataCubeFunction.SELECT, [
     _cols(columns.map((col) => _colSpec(col.name))),

package/src/stores/core/DataCubeQuerySnapshot.ts

@@ -71,10 +71,10 @@ export type DataCubeQuerySnapshotPivot = {
 
 export type DataCubeQuerySnapshotProcessingContext = {
   snapshot: DataCubeQuerySnapshot;
-  pivotAggColumns: DataCubeQuerySnapshotAggregateColumn[];
-  pivotSortColumns: DataCubeQuerySnapshotSortColumn[];
-  groupByAggColumns: DataCubeQuerySnapshotAggregateColumn[];
-  groupBySortColumns: DataCubeQuerySnapshotSortColumn[];
+  pivotAggColumns?: DataCubeQuerySnapshotAggregateColumn[] | undefined;
+  pivotSortColumns?: DataCubeQuerySnapshotSortColumn[] | undefined;
+  groupByAggColumns?: DataCubeQuerySnapshotAggregateColumn[] | undefined;
+  groupBySortColumns?: DataCubeQuerySnapshotSortColumn[] | undefined;
 };
 
 export type DataCubeQuerySnapshotData = {
@@ -185,4 +185,15 @@ export class DataCubeQuerySnapshot {
     clone._hashCode = this._hashCode;
     return clone;
   }
+
+  serialize() {
+    const clone = this.clone();
+    return {
+      uuid: clone.uuid,
+      data: clone.data,
+      _isPatchChange: clone._isPatchChange,
+      _finalized: clone._finalized,
+      _hashCode: clone._hashCode,
+    };
+  }
 }