@xh/hoist 75.0.0-SNAPSHOT.1754329446115 → 75.0.0-SNAPSHOT.1754347635253

package/data/cube/row/BaseRow.ts

@@ -7,17 +7,20 @@
 
 import {PlainObject, Some} from '@xh/hoist/core';
 import {BucketSpec} from '@xh/hoist/data/cube/BucketSpec';
+import {ViewRowData} from '@xh/hoist/data/cube/ViewRowData';
 import {compact, isEmpty, reduce} from 'lodash';
 import {View} from '../View';
 import {RowUpdate} from './RowUpdate';
 
 /**
- * Base class for a view row.
+ * Base class for a row within a dataset produced by a Cube / View.
+ *
+ * This is an internal data structure - {@link ViewRowData} is the public row-level data API.
  */
 export abstract class BaseRow {
     readonly view: View = null;
     readonly id: string = null;
-    readonly data: PlainObject;
+    readonly data: ViewRowData;
 
     // readonly, but set by subclasses
     parent: BaseRow = null;
@@ -38,37 +41,48 @@ export abstract class BaseRow {
     constructor(view: View, id: string) {
         this.view = view;
         this.id = id;
-        this.data = {id, _meta: this};
+        this.data = new ViewRowData(id);
     }
 
     //-----------------------
     // For all rows types
     //------------------------
     noteBucketed(bucketSpec: BucketSpec, bucketVal: any) {
-        this.data.buckets = this.data.buckets ?? {};
-        this.data.buckets[bucketSpec.name] = bucketVal;
+        this.data.cubeBuckets ??= {};
+        this.data.cubeBuckets[bucketSpec.name] = bucketVal;
         this.children?.forEach(it => it.noteBucketed(bucketSpec, bucketVal));
     }
 
     // Determine what should be exposed as the actual children in the
     // row data.  This where we lock, skip degenerate rows, etc.
-    getVisibleDatas(): Some<PlainObject> {
-        let {view, data, isLeaf} = this;
-
-        // 1) Get visible children nodes recursively
-        let dataChildren = this.getVisibleChildrenDatas();
+    getVisibleDatas(): Some<ViewRowData> {
+        const {view, data, isLeaf} = this,
+            {query} = view,
+            {omitRedundantNodes, provideLeaves, includeLeaves} = query;
+
+        // 1) Get children nodes recursively
+        let dataChildren = this.getChildrenDatas();
+
+        // End hierarchy at cube leaves, if so configured. But be sure to hold on to them if needed
+        if (dataChildren && !includeLeaves && dataChildren[0]?.isCubeLeaf) {
+            if (provideLeaves) {
+                data._cubeLeafChildren = dataChildren;
+            }
+            dataChildren = null;
+        }
 
         // 2) If omitting ourselves, we are done, return visible children.
-        if (!isLeaf && view.query.omitFn?.(this as any)) return dataChildren;
+        if (!isLeaf && query.omitFn?.(this as any)) return dataChildren;
 
         // 3) Otherwise, we can attach this data to the children data and return.
 
         // 3a) Before attaching examine that we don't have a chain of redundant nodes
         // (not sure if loop needed -- are these redundant relations transitive?)
-        if (view.query.omitRedundantNodes) {
+        if (omitRedundantNodes) {
+            const rowCache = view._rowCache;
             while (dataChildren?.length === 1) {
-                const childRow = dataChildren[0]._meta;
-                if (this.isRedundantChild(this, childRow)) {
+                const childRow = rowCache.get(dataChildren[0].id);
+                if (childRow && this.isRedundantChild(this, childRow)) {
                     dataChildren = childRow.data.children;
                 } else {
                     break;
@@ -76,20 +90,16 @@ export abstract class BaseRow {
             }
         }
 
+        // Wire up visible data children and leaves, as needed.
         data.children = dataChildren;
         return data;
     }
 
-    private getVisibleChildrenDatas(): PlainObject[] {
+    private getChildrenDatas(): ViewRowData[] {
         let {children, view} = this;
 
         if (!children) return null;
 
-        // Skip all leaves from the data if the query is not configured to include leaves and
-        if (!view.query.includeLeaves && children[0]?.isLeaf) {
-            return null;
-        }
-
         // Skip all children in a locked node
         if (view.query.lockFn?.(this as any)) {
             this.locked = true;

package/data/cube/row/BucketRow.ts

@@ -11,7 +11,11 @@ import {BucketSpec} from '../BucketSpec';
 import {View} from '../View';
 
 /**
- *  Object used by views to gather bucket rows.
+ *  Row within a dataset produced by a Cube / View representing aggregated data on a dimension that
+ *  has been further grouped into a dynamic child "bucket" - a subset of the dimension-level
+ *  {@link AggregateRow} produced as per a specified {@link Query.bucketSpecFn}.
+ *
+ * This is an internal data structure - {@link ViewRowData} is the public row-level data API.
  */
 export class BucketRow extends BaseRow {
     override get isBucket() {

package/data/cube/row/LeafRow.ts

@@ -13,15 +13,16 @@ import {BaseRow} from './BaseRow';
 import {RowUpdate} from './RowUpdate';
 
 /**
- * Represents a leaf row returned by a {@link View} or call to {@link Cube.executeQuery}.
- *
- * These rows are 1-1 with the source records loaded into the Cube's internal store - i.e. they are
- * not computed aggregates - although the data they contain is a shallow copy of the original and
+ * Row within a dataset produced by a Cube or View representing leaf-level data. These rows have a
+ * 1-1 relationship with the source records loaded into the Cube's internal store - i.e. they are
+ * not computed aggregates, although the data they contain is a shallow copy of the original and
  * limited to the fields requested by the View / Query that produced them.
+ *
+ * This is an internal data structure - {@link ViewRowData} is the public row-level data API.
  */
 export class LeafRow extends BaseRow {
     /**
-     * Id of the StoreRecord within the Cube that was used to construct this leaf row.
+     * ID of the `StoreRecord` within the Cube that was used to construct this leaf row.
      * Useful if you need to update this leaf's data via {@link Cube.updateDataAsync}.
      */
     readonly cubeRecordId: StoreRecordId;
@@ -34,7 +35,8 @@ export class LeafRow extends BaseRow {
         super(view, id);
 
         this.cubeRecordId = rawRecord.id;
-        this.data.cubeLabel = rawRecord.id;
+        this.data.cubeLabel = rawRecord.id.toString();
+        this.data.cubeDimension = null;
 
         view.fields.forEach(({name}) => {
             this.data[name] = rawRecord.data[name];

package/data/index.ts

@@ -36,6 +36,7 @@ export * from './cube/Cube';
 export * from './cube/CubeField';
 export * from './cube/Query';
 export * from './cube/View';
+export * from './cube/ViewRowData';
 
 export * from './validation/constraints';
 export * from './validation/Rule';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "75.0.0-SNAPSHOT.1754329446115",
+  "version": "75.0.0-SNAPSHOT.1754347635253",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",