Post processing functions on query

CHANGELOG.md

@@ -1,13 +1,16 @@
 # Changelog
 
-## 60.0.0-SNAPSHOT - unreleased
+## 59.2.0 - 2023-10-16
 
 ### 🎁 New Features
 
 * New `DockViewConfig.onClose` hook invoked when a user attempts to remove a `DockContainer` view
 * Add `GridModel` APIs to lookup and show / hide entire column groups
 * Left / right borders are now rendered along `Grid` `ColumnGroup` edges by default.  Control
  with new boolean property `ColumnGroupSpec.borders`
+* The Cube package has been enhanced to support `Query` specific post-processing functions.  See
+new properties `Query.omitFn`, `Query.bucketSpecFn` and `Query.lockFn`.  These properties default
+to their respective properties on `Cube`.
 
 ### 🐞 Bug Fixes
 

data/cube/Query.ts

@@ -5,7 +5,7 @@
  * Copyright © 2023 Extremely Heavy Industries Inc.
  */
 
-import {Filter, parseFilter, StoreRecord} from '@xh/hoist/data';
+import {BucketSpecFn, Filter, LockFn, OmitFn, parseFilter, StoreRecord} from '@xh/hoist/data';
 import {isEqual, find} from 'lodash';
 import {FilterLike, FilterTestFn} from '../filter/Types';
 import {CubeField} from './CubeField';
@@ -51,6 +51,25 @@ export interface QueryConfig {
 
     /** True to include leaf nodes in return.*/
     includeLeaves?: boolean;
+
+    /**
+     * Optional function to be called for each aggregate node to determine if it should be "locked",
+     * preventing drill-down into its children.  Defaults to Cube.lockFn.
+     */
+    lockFn?: LockFn;
+
+    /**
+     * Optional function to be called for each dimension during row generation to determine if the
+     * children of that dimension should be bucketed into additional dynamic dimensions.
+     * Defaults to Cube.bucketSpecFn.
+     */
+    bucketSpecFn?: BucketSpecFn;
+
+    /**
+     * Optional function to be called on all single child rows during view processing.
+     * Return true to omit the row. Defaults to Cube.omitFn.
+     */
+    omitFn?: OmitFn;
 }
 
 /** {@inheritDoc QueryConfig} */
@@ -61,6 +80,9 @@ export class Query {
     readonly includeRoot: boolean;
     readonly includeLeaves: boolean;
     readonly cube: Cube;
+    readonly lockFn: LockFn;
+    readonly bucketSpecFn: BucketSpecFn;
+    readonly omitFn: OmitFn;
 
     private readonly _testFn: FilterTestFn;
 
@@ -70,14 +92,20 @@ export class Query {
         dimensions,
         filter = null,
         includeRoot = false,
-        includeLeaves = false
+        includeLeaves = false,
+        lockFn = cube.lockFn,
+        bucketSpecFn = cube.bucketSpecFn,
+        omitFn = cube.omitFn
     }: QueryConfig) {
         this.cube = cube;
         this.fields = this.parseFields(fields);
         this.dimensions = this.parseDimensions(dimensions);
         this.includeRoot = includeRoot;
         this.includeLeaves = includeLeaves;
         this.filter = parseFilter(filter);
+        this.lockFn = lockFn;
+        this.bucketSpecFn = bucketSpecFn;
+        this.omitFn = omitFn;
 
         this._testFn = this.filter?.getTestFn(this.cube.store) ?? null;
     }
@@ -89,6 +117,9 @@ export class Query {
             filter: this.filter,
             includeRoot: this.includeRoot,
             includeLeaves: this.includeLeaves,
+            lockFn: this.lockFn,
+            bucketSpecFn: this.bucketSpecFn,
+            omitFn: this.omitFn,
             cube: this.cube,
             ...overrides
         };
@@ -121,7 +152,10 @@ export class Query {
             isEqual(this.dimensions, other.dimensions) &&
             this.cube === other.cube &&
             this.includeRoot === other.includeRoot &&
-            this.includeLeaves === other.includeLeaves
+            this.includeLeaves === other.includeLeaves &&
+            this.bucketSpecFn == other.bucketSpecFn &&
+            this.omitFn == other.omitFn &&
+            this.lockFn == other.lockFn
         );
     }
 

data/cube/View.ts

@@ -351,9 +351,9 @@ export class View extends HoistBase {
         parentId: string,
         appliedDimensions: PlainObject
     ): BaseRow[] {
-        if (!this.cube.bucketSpecFn) return rows;
+        if (!this.query.bucketSpecFn) return rows;
 
-        const bucketSpec = this.cube.bucketSpecFn(rows);
+        const bucketSpec = this.query.bucketSpecFn(rows);
         if (!bucketSpec) return rows;
 
         if (!this.query.includeLeaves && rows[0]?.isLeaf) return rows;

data/cube/row/BaseRow.ts

@@ -59,7 +59,7 @@ export abstract class BaseRow {
         let dataChildren = this.getVisibleChildrenDatas();
 
         // 2) If omitting ourselves, we are done, return visible children.
-        if (!isLeaf && view.cube.omitFn?.(this as any)) return dataChildren;
+        if (!isLeaf && view.query.omitFn?.(this as any)) return dataChildren;
 
         // 3) Otherwise, we can attach this data to the children data and return.
 
@@ -89,7 +89,7 @@ export abstract class BaseRow {
         }
 
         // Skip all children in a locked node
-        if (view.cube.lockFn?.(this as any)) {
+        if (view.query.lockFn?.(this as any)) {
             this.locked = true;
             return null;
         }