@xh/hoist 63.0.2 → 63.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 63.1.0 - 2024-04-23
+
+### 🎁 New Features
+
+* `Store` now supports multiple `summaryRecords`.
+
+## 63.0.3 - 2024-04-16
+
+### 🐞 Bug Fixes
+
+* Import BPs default datetime package css in addition to datetime2 css to support BP datetime components.
+
 ## 63.0.2 - 2024-04-16
 
 ### 🐞 Bug Fixes

package/cmp/grid/Grid.ts

@@ -326,7 +326,7 @@ export class GridLocalModel extends HoistModel {
         const {model} = this,
             {store} = model;
         return {
-            track: () => [model.isReady, store._filtered, model.showSummary, store.summaryRecord],
+            track: () => [model.isReady, store._filtered, model.showSummary, store.summaryRecords],
             run: () => {
                 if (model.isReady) this.syncData();
             }
@@ -583,11 +583,11 @@ export class GridLocalModel extends HoistModel {
             pinnedTopRowData = agGridModel.getPinnedTopRowData().filter(filterSummaryFn),
             pinnedBottomRowData = agGridModel.getPinnedBottomRowData().filter(filterSummaryFn);
 
-        if (showSummary && store.summaryRecord) {
+        if (showSummary && !isEmpty(store.summaryRecords)) {
             if (showSummary === 'bottom') {
-                pinnedBottomRowData.push(store.summaryRecord);
+                pinnedBottomRowData.push(...store.summaryRecords);
             } else {
-                pinnedTopRowData.unshift(store.summaryRecord);
+                pinnedTopRowData.unshift(...store.summaryRecords);
             }
         }
 

package/cmp/grid/GridModel.ts

@@ -123,7 +123,7 @@ export interface GridConfig {
     /** True if grid is a tree grid (default false). */
     treeMode?: boolean;
 
-    /** Location for a docked summary row. Requires `store.SummaryRecord` to be populated. */
+    /** Location for docked summary row(s). Requires `store.summaryRecords` to be populated. */
     showSummary?: boolean | VSide;
 
     /** Specification of selection behavior. Defaults to 'single' (desktop) and 'disabled' (mobile) */
@@ -1038,7 +1038,7 @@ export class GridModel extends HoistModel {
     }
 
     /** Load the underlying store. */
-    loadData(rawData: any[], rawSummaryData?: PlainObject) {
+    loadData(rawData: any[], rawSummaryData?: Some<PlainObject>) {
         return this.store.loadData(rawData, rawSummaryData);
     }
 

package/cmp/zoneGrid/ZoneGridModel.ts

@@ -102,7 +102,7 @@ export interface ZoneGridConfig {
     /** True if grid is a tree grid (default false). */
     treeMode?: boolean;
 
-    /** Location for a docked summary row. Requires `store.SummaryRecord` to be populated. */
+    /** Location for docked summary row(s). Requires `store.summaryRecords` to be populated. */
     showSummary?: boolean | VSide;
 
     /** Specification of selection behavior. Defaults to 'single' (desktop) and 'disabled' (mobile) */
@@ -520,7 +520,7 @@ export class ZoneGridModel extends HoistModel {
         return this.gridModel.doLoadAsync(loadSpec);
     }
 
-    loadData(rawData: any[], rawSummaryData?: PlainObject) {
+    loadData(rawData: any[], rawSummaryData?: Some<PlainObject>) {
         return this.gridModel.loadData(rawData, rawSummaryData);
     }
 

package/data/Store.ts

@@ -21,7 +21,9 @@ import {
     isString,
     values,
     remove as lodashRemove,
-    uniq
+    uniq,
+    first,
+    some
 } from 'lodash';
 import {Field, FieldSpec} from './Field';
 import {parseFilter} from './filter/Utils';
@@ -143,11 +145,11 @@ export interface StoreTransaction {
     remove?: StoreRecordId[];
 
     /**
-     *  Update to the dedicated summary row for this store.  If the store has its
+     *  Update to the dedicated summary record(s) for this store.  If the store has its
      *  `loadRootAsSummary` flag set to true, the summary record should instead be provided via the
      *  `update` property.
      */
-    rawSummaryData?: PlainObject;
+    rawSummaryData?: Some<PlainObject>;
 }
 
 export interface ChildRawData {
@@ -197,9 +199,9 @@ export class Store extends HoistBase {
     @observable
     lastLoaded: number = null;
 
-    /** Record containing summary data. */
+    /** Records containing summary data. */
     @observable.ref
-    summaryRecord: StoreRecord = null;
+    summaryRecords: StoreRecord[] = null;
 
     /** @internal - used internally by any StoreFilterField bound to this store. */
     @observable
@@ -290,23 +292,25 @@ export class Store extends HoistBase {
      * created with its `loadRootAsSummary` flag set to true.
      *
      * @param rawData - source data to load
-     * @param rawSummaryData - source data for an optional summary record, representing
-     *      a custom aggregation to show as a "grand total" for the dataset, if desired.
+     * @param rawSummaryData - source data for optional summary record(s), representing
+     *      custom aggregations for the dataset, if desired.
      */
     @action
     @logWithDebug
-    loadData(rawData: PlainObject[], rawSummaryData?: PlainObject) {
+    loadData(rawData: PlainObject[], rawSummaryData?: Some<PlainObject>) {
         // Extract rootSummary if loading non-empty data[] (i.e. not clearing) and loadRootAsSummary
         if (rawData.length !== 0 && this.loadRootAsSummary) {
             throwIf(
-                rawData.length !== 1 || rawSummaryData,
+                rawData.length !== 1 || !isEmpty(rawSummaryData),
                 'Incorrect call to loadData with loadRootAsSummary=true. Summary data should be in a single root node with top-level row data as its children.'
             );
             rawSummaryData = rawData[0];
             rawData = rawData[0].children ?? [];
         }
 
-        this.summaryRecord = rawSummaryData ? this.createRecord(rawSummaryData, null, true) : null;
+        this.summaryRecords = rawSummaryData
+            ? castArray(rawSummaryData).map(it => this.createRecord(it, null, true))
+            : null;
 
         const records = this.createRecords(rawData, null);
         this._committed = this._current = this._committed.withNewRecords(records);
@@ -381,7 +385,7 @@ export class Store extends HoistBase {
                         'In order to update grid data, records must have stable ids. Note: XH.genId() will not provide such ids.'
                     ),
                     parent = rec.parent,
-                    isSummary = recId === this.summaryRecord?.id;
+                    isSummary = some(this.summaryRecords, {id: recId});
                 return this.createRecord(it, parent, isSummary);
             });
         }
@@ -398,20 +402,22 @@ export class Store extends HoistBase {
             });
         }
 
-        // 2) Pre-process summary record, peeling it out of updates if needed
-        const {summaryRecord} = this;
-        let summaryUpdateRec;
-        if (summaryRecord) {
-            [summaryUpdateRec] = lodashRemove(updateRecs, {id: summaryRecord.id});
+        // 2) Pre-process summary records, peeling them out of updates if needed
+        const {summaryRecords} = this;
+        let summaryUpdateRecs: StoreRecord[];
+        if (!isEmpty(summaryRecords)) {
+            summaryUpdateRecs = lodashRemove(updateRecs, ({id}) => some(summaryRecords, {id}));
         }
 
-        if (!summaryUpdateRec && rawSummaryData) {
-            summaryUpdateRec = this.createRecord(rawSummaryData, null, true);
+        if (isEmpty(summaryUpdateRecs) && rawSummaryData) {
+            summaryUpdateRecs = castArray(rawSummaryData).map(it =>
+                this.createRecord(it, null, true)
+            );
         }
 
-        if (summaryUpdateRec) {
-            this.summaryRecord = summaryUpdateRec;
-            changeLog.summaryRecord = this.summaryRecord;
+        if (!isEmpty(summaryUpdateRecs)) {
+            this.summaryRecords = summaryUpdateRecs;
+            changeLog.summaryRecords = this.summaryRecords;
         }
 
         // 3) Apply changes
@@ -672,6 +678,15 @@ export class Store extends HoistBase {
         return this._current.rootList;
     }
 
+    /** Record containing summary data. */
+    get summaryRecord(): StoreRecord {
+        throwIf(
+            this.summaryRecords.length > 1,
+            'Store has multiple summary records. Use Store.summaryRecords.'
+        );
+        return first(this.summaryRecords);
+    }
+
     /** True if the store has changes which need to be committed. */
     @computed
     get isModified(): boolean {
@@ -787,7 +802,8 @@ export class Store extends HoistBase {
      */
     getById(id: StoreRecordId, respectFilter: boolean = false): StoreRecord {
         if (isNil(id)) return null;
-        if (id === this.summaryRecord?.id) return this.summaryRecord;
+        const summaryRecord = this.summaryRecords?.find(it => it.id === id);
+        if (summaryRecord) return summaryRecord;
 
         const rs = respectFilter ? this._filtered : this._current;
         return rs.getById(id);
@@ -892,7 +908,7 @@ export class Store extends HoistBase {
     @action
     private resetRecords() {
         this._committed = this._current = this._filtered = new RecordSet(this);
-        this.summaryRecord = null;
+        this.summaryRecords = null;
     }
 
     private parseFields(fields: any[], defaults: any): Field[] {
@@ -965,7 +981,7 @@ export class Store extends HoistBase {
                 {id} = rec;
 
             throwIf(
-                recordMap.has(id) || this.summaryRecord?.id === id,
+                recordMap.has(id) || this.summaryRecords?.some(it => it.id === id),
                 `ID ${id} is not unique. Use the 'Store.idSpec' config to resolve a unique ID for each record.`
             );
 

package/kit/blueprint/index.ts

@@ -19,6 +19,7 @@ import {
     useHotkeys
 } from '@blueprintjs/core';
 import '@blueprintjs/core/lib/css/blueprint.css';
+import '@blueprintjs/datetime/lib/css/blueprint-datetime.css';
 import '@blueprintjs/datetime2/lib/css/blueprint-datetime2.css';
 import {elementFactory} from '@xh/hoist/core';
 import './styles.scss';

package/package.json

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

package/svc/GridAutosizeService.ts

@@ -139,8 +139,8 @@ export class GridAutosizeService extends HoistService {
         }
 
         // Ensure the summary record is always included, since it is likely to contain the largest values.
-        if (gridModel.showSummary && store.summaryRecord) {
-            ret.push(store.summaryRecord);
+        if (gridModel.showSummary && !isEmpty(store.summaryRecords)) {
+            ret.push(...store.summaryRecords);
         }
         return ret;
     }

package/svc/GridExportService.ts

@@ -75,7 +75,7 @@ export class GridExportService extends HoistService {
 
         const config = XH.configService.get('xhExportConfig', {}),
             exportColumns = this.getExportableColumns(gridModel, columns),
-            summaryRecord = gridModel.store.summaryRecord,
+            summaryRecords = gridModel.store.summaryRecords,
             records = gridModel.store.rootRecords,
             meta = this.getColumnMetadata(exportColumns);
 
@@ -84,18 +84,17 @@ export class GridExportService extends HoistService {
             return;
         }
 
-        // If the grid includes a summary row, add it to the export payload as a root-level node.
-        const rows =
-            gridModel.showSummary && summaryRecord
-                ? [
-                      this.getHeaderRow(exportColumns, type, gridModel),
-                      this.getRecordRow(gridModel, summaryRecord, exportColumns, type, 0),
-                      ...this.getRecordRowsRecursive(gridModel, records, exportColumns, type, 1)
-                  ]
-                : [
-                      this.getHeaderRow(exportColumns, type, gridModel),
-                      ...this.getRecordRowsRecursive(gridModel, records, exportColumns, type, 0)
-                  ];
+        // If the grid includes summary rows, add them to the export payload as root-level nodes.
+        const rows = [
+            this.getHeaderRow(exportColumns, type, gridModel),
+            ...(gridModel.showSummary && !isEmpty(summaryRecords)
+                ? summaryRecords.map(summaryRecord =>
+                      this.getRecordRow(gridModel, summaryRecord, exportColumns, type, 0)
+                  )
+                : []),
+
+            ...this.getRecordRowsRecursive(gridModel, records, exportColumns, type, 1)
+        ];
 
         // Show separate 'started' toasts for larger (i.e. slower) exports.
         let startToast = null,