@xh/hoist 78.0.0-SNAPSHOT.1762201137843 → 78.0.0-SNAPSHOT.1762285014309

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## 78.0.0-SNAPSHOT - unreleased
 
+### 🎁 New Features
+*  New method `StoreRecord.getModifiedValues()` to gather edited data from a store record.
+
+### 🐞 Bug Fixes
+*  StoreRecord will no longer report `isModified` as `true` if a field has been edited and
+   then returned to its original value in a subsequent edit.
+
 ## 77.0.1 - 2025-10-29
 
 ### 💥 Breaking Changes

package/admin/tabs/general/config/ConfigPanelModel.ts

@@ -7,7 +7,7 @@
 import {exportFilenameWithDate} from '@xh/hoist/admin/AdminUtils';
 import {AppModel} from '@xh/hoist/admin/AppModel';
 import * as Col from '@xh/hoist/admin/columns';
-import {hbox, hspacer} from '@xh/hoist/cmp/layout';
+import {br, fragment, hbox, hspacer} from '@xh/hoist/cmp/layout';
 import {HoistModel, LoadSpec, managed, XH} from '@xh/hoist/core';
 import {FieldSpec} from '@xh/hoist/data';
 import {defaultReadonlyRenderer} from '@xh/hoist/desktop/cmp/form';
@@ -17,14 +17,14 @@ import {
     cloneAction,
     deleteAction,
     editAction,
-    RestGridModel,
-    RestStore
+    RestGridModel
 } from '@xh/hoist/desktop/cmp/rest';
+import {Icon} from '@xh/hoist/icon';
 import {action, makeObservable, observable} from '@xh/hoist/mobx';
+import {pluralize} from '@xh/hoist/utils/js';
 import {isNil, truncate} from 'lodash';
 import {DifferModel} from '../../../differ/DifferModel';
 import {RegroupDialogModel} from '../../../regroup/RegroupDialogModel';
-import {Icon} from '@xh/hoist/icon';
 
 export class ConfigPanelModel extends HoistModel {
     override persistWith = {localStorageKey: 'xhAdminConfigState'};
@@ -43,18 +43,27 @@ export class ConfigPanelModel extends HoistModel {
         super();
         makeObservable(this);
 
-        const required = true,
+        const {regroupAction} = this.regroupDialogModel,
+            required = true,
             enableCreate = true,
             hidden = true;
 
         this.gridModel = new RestGridModel({
-            readonly: AppModel.readonly,
-            persistWith: this.persistWith,
+            // Core config
+            autosizeOptions: {mode: 'managed', includeCollapsedChildren: true},
             colChooserModel: true,
             enableExport: true,
             exportOptions: {filename: exportFilenameWithDate('configs')},
+            filterFields: ['name', 'value', 'groupName', 'note'],
+            groupBy: 'groupName',
+            persistWith: this.persistWith,
+            prepareCloneFn: ({clone}) => (clone.name = `${clone.name}_CLONE`),
+            readonly: AppModel.readonly,
             selModel: 'multiple',
-            store: new RestStore({
+            sortBy: 'name',
+            unit: 'config',
+            // Store + fields
+            store: {
                 url: 'rest/configAdmin',
                 reloadLookupsOnLoad: true,
                 fieldDefaults: {enableXssProtection: false},
@@ -83,25 +92,8 @@ export class ConfigPanelModel extends HoistModel {
                         editable: false
                     }
                 ]
-            }),
-            actionWarning: {
-                del: records =>
-                    `Are you sure you want to delete ${records.length} config(s)? Deleting configs can break running apps.`
             },
-            toolbarActions: [addAction, editAction, cloneAction, deleteAction],
-            menuActions: [
-                addAction,
-                editAction,
-                cloneAction,
-                deleteAction,
-                '-',
-                this.regroupDialogModel.regroupAction
-            ],
-            prepareCloneFn: ({clone}) => (clone.name = `${clone.name}_CLONE`),
-            unit: 'config',
-            filterFields: ['name', 'value', 'groupName', 'note'],
-            sortBy: 'name',
-            groupBy: 'groupName',
+            // Cols + editors
             columns: [
                 {...Col.groupName, hidden},
                 {...Col.name},
@@ -138,7 +130,19 @@ export class ConfigPanelModel extends HoistModel {
                 {field: 'clientVisible'},
                 {field: 'lastUpdated'},
                 {field: 'lastUpdatedBy'}
-            ]
+            ],
+            // Actions
+            actionWarning: {
+                del: records =>
+                    fragment(
+                        `Are you sure you want to delete ${pluralize('selected config', records.length, true)}?`,
+                        br(),
+                        br(),
+                        `Deleting configs can break running apps.`
+                    )
+            },
+            menuActions: [addAction, editAction, cloneAction, deleteAction, '-', regroupAction],
+            toolbarActions: [addAction, editAction, cloneAction, deleteAction]
         });
     }
 

package/admin/tabs/userData/prefs/UserPreferenceModel.ts

@@ -25,12 +25,19 @@ export class UserPreferenceModel extends HoistModel {
             hidden = true;
 
         this.gridModel = new RestGridModel({
-            readonly: AppModel.readonly,
-            persistWith: {localStorageKey: 'xhAdminUserPreferenceState'},
+            // Core config
+            autosizeOptions: {mode: 'managed', includeCollapsedChildren: true},
             colChooserModel: true,
             enableExport: true,
             exportOptions: {filename: exportFilenameWithDate('user-prefs')},
+            filterFields: ['name', 'username'],
+            groupBy: 'groupName',
+            persistWith: {localStorageKey: 'xhAdminUserPreferenceState'},
+            readonly: AppModel.readonly,
             selModel: 'multiple',
+            sortBy: 'name',
+            unit: 'user preference',
+            // Store + fields
             store: {
                 url: 'rest/userPreferenceAdmin',
                 reloadLookupsOnLoad: true,
@@ -55,10 +62,7 @@ export class UserPreferenceModel extends HoistModel {
                     {...(Col.lastUpdatedBy.field as FieldSpec), editable: false}
                 ]
             },
-            sortBy: 'name',
-            groupBy: 'groupName',
-            unit: 'user preference',
-            filterFields: ['name', 'username'],
+            // Cols + editors
             columns: [
                 {...Col.name},
                 {...Col.type},

package/admin/tabs/userData/prefs/editor/PrefEditorModel.ts

@@ -7,11 +7,13 @@
 import {exportFilenameWithDate} from '@xh/hoist/admin/AdminUtils';
 import {AppModel} from '@xh/hoist/admin/AppModel';
 import * as Col from '@xh/hoist/admin/columns';
+import {br, fragment} from '@xh/hoist/cmp/layout';
 import {HoistModel, LoadSpec, managed, XH} from '@xh/hoist/core';
 import {FieldSpec} from '@xh/hoist/data';
 import {textArea} from '@xh/hoist/desktop/cmp/input';
 import {addAction, deleteAction, editAction, RestGridModel} from '@xh/hoist/desktop/cmp/rest';
 import {action, makeObservable, observable} from '@xh/hoist/mobx';
+import {pluralize} from '@xh/hoist/utils/js';
 import {DifferModel} from '../../../../differ/DifferModel';
 import {RegroupDialogModel} from '../../../../regroup/RegroupDialogModel';
 
@@ -32,18 +34,26 @@ export class PrefEditorModel extends HoistModel {
         super();
         makeObservable(this);
 
-        const required = true,
+        const {regroupAction} = this.regroupDialogModel,
+            required = true,
             enableCreate = true,
             hidden = true;
 
         this.gridModel = new RestGridModel({
-            readonly: AppModel.readonly,
-            persistWith: this.persistWith,
+            // Core config
+            autosizeOptions: {mode: 'managed', includeCollapsedChildren: true},
             colChooserModel: true,
             enableExport: true,
             exportOptions: {filename: exportFilenameWithDate('prefs')},
+            filterFields: ['name', 'groupName'],
+            groupBy: 'groupName',
+            persistWith: this.persistWith,
+            readonly: AppModel.readonly,
             selModel: 'multiple',
             showRefreshButton: true,
+            sortBy: 'name',
+            unit: 'preference',
+            // Store + fields
             store: {
                 url: 'rest/preferenceAdmin',
                 reloadLookupsOnLoad: true,
@@ -68,21 +78,7 @@ export class PrefEditorModel extends HoistModel {
                     {...(Col.lastUpdatedBy.field as FieldSpec), editable: false}
                 ]
             },
-            sortBy: 'name',
-            groupBy: 'groupName',
-            unit: 'preference',
-            filterFields: ['name', 'groupName'],
-            actionWarning: {
-                del: records =>
-                    `Are you sure you want to delete ${records.length} preference(s)? Deleting preferences can break running apps.`
-            },
-            menuActions: [
-                addAction,
-                editAction,
-                deleteAction,
-                '-',
-                this.regroupDialogModel.regroupAction
-            ],
+            // Cols + Editors
             columns: [
                 {...Col.name},
                 {...Col.type},
@@ -100,7 +96,18 @@ export class PrefEditorModel extends HoistModel {
                 {field: 'notes', formField: {item: textArea({height: 100})}},
                 {field: 'lastUpdated'},
                 {field: 'lastUpdatedBy'}
-            ]
+            ],
+            // Actions
+            actionWarning: {
+                del: records =>
+                    fragment(
+                        `Are you sure you want to delete ${pluralize('selected preference', records.length, true)}?`,
+                        br(),
+                        br(),
+                        `Deleting preference definitions can break running apps.`
+                    )
+            },
+            menuActions: [addAction, editAction, deleteAction, '-', regroupAction]
         });
     }
 

package/build/types/data/StoreRecord.d.ts

@@ -94,6 +94,14 @@ export declare class StoreRecord {
      * Field in the Store. Useful for cloning/iterating over all values (including defaults).
      */
     getValues(): PlainObject;
+    /**
+     * Get a map of modified values only.
+     *
+     * If record has no modifications, this method will return null.
+     * If modifications are returned, the returned object will include id,
+     * for convenience.
+     */
+    getModifiedValues(): PlainObject;
     /**
      * Construct a StoreRecord from a pre-processed `data` source object.
      *

package/build/types/desktop/cmp/rest/RestGridModel.d.ts

@@ -1,10 +1,11 @@
-import { RowDoubleClickedEvent } from '@xh/hoist/kit/ag-grid';
 import { BaseFieldConfig } from '@xh/hoist/cmp/form';
 import { GridConfig, GridModel } from '@xh/hoist/cmp/grid';
 import { ElementSpec, HoistModel, PlainObject } from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
 import { RecordAction, RecordActionSpec, StoreRecord } from '@xh/hoist/data';
+import { RowDoubleClickedEvent } from '@xh/hoist/kit/ag-grid';
 import { ExportOptions } from '@xh/hoist/svc';
+import { ReactNode } from 'react';
 import { FormFieldProps } from '../form';
 import { RestStore, RestStoreConfig } from './data/RestStore';
 import { RestFormModel } from './impl/RestFormModel';
@@ -22,9 +23,9 @@ export interface RestGridConfig extends GridConfig {
     showRefreshButton?: boolean;
     /** Warning to display before actions on a selection of records. */
     actionWarning?: {
-        add?: string | ((recs: StoreRecord[]) => string);
-        del?: string | ((recs: StoreRecord[]) => string);
-        edit?: string | ((recs: StoreRecord[]) => string);
+        add?: ReactNode | ((recs: StoreRecord[]) => ReactNode);
+        del?: ReactNode | ((recs: StoreRecord[]) => ReactNode);
+        edit?: ReactNode | ((recs: StoreRecord[]) => ReactNode);
     };
     /** Name that describes records in this grid. */
     unit?: string;

package/build/types/desktop/cmp/rest/impl/RestFormModel.d.ts

@@ -16,9 +16,9 @@ export declare class RestFormModel extends HoistModel {
     dialogRef: import("react").RefObject<HTMLElement>;
     get unit(): string;
     get actionWarning(): {
-        add?: string | ((recs: import("@xh/hoist/data").StoreRecord[]) => string);
-        del?: string | ((recs: import("@xh/hoist/data").StoreRecord[]) => string);
-        edit?: string | ((recs: import("@xh/hoist/data").StoreRecord[]) => string);
+        add?: import("react").ReactNode | ((recs: import("@xh/hoist/data").StoreRecord[]) => import("react").ReactNode);
+        del?: import("react").ReactNode | ((recs: import("@xh/hoist/data").StoreRecord[]) => import("react").ReactNode);
+        edit?: import("react").ReactNode | ((recs: import("@xh/hoist/data").StoreRecord[]) => import("react").ReactNode);
     };
     get actions(): (import("@xh/hoist/data").RecordActionSpec | import("@xh/hoist/data").RecordAction)[];
     get editors(): RestGridEditor[];

package/data/Store.ts

@@ -515,10 +515,12 @@ export class Store extends HoistBase {
 
             return new StoreRecord({
                 id,
-                data: parsedData,
                 store: this,
+                raw: null,
+                data: parsedData,
+                committedData: null,
                 parent,
-                committedData: null
+                isSummary: false
             });
         });
 
@@ -585,13 +587,22 @@ export class Store extends HoistBase {
             const currentRec = this.getOrThrow(id),
                 updatedData = this.parseUpdate(currentRec.data, mod);
 
+            // If after parsing, data is deep equal, its a no-op
+            if (equal(updatedData, currentRec.data)) return;
+
+            // Previously updated record might now be reverted to clean, normalize
+            const committedData =
+                currentRec.isModified && equal(currentRec.committedData, updatedData)
+                    ? updatedData
+                    : currentRec.committedData;
+
             const updatedRec = new StoreRecord({
                 id: currentRec.id,
+                store: currentRec.store,
                 raw: currentRec.raw,
                 data: updatedData,
+                committedData: committedData,
                 parent: currentRec.parent,
-                store: currentRec.store,
-                committedData: currentRec.committedData,
                 isSummary: currentRec.isSummary
             });
 
@@ -1036,7 +1047,15 @@ export class Store extends HoistBase {
         }
 
         data = this.parseRaw(data);
-        const ret = new StoreRecord({id, data, raw, parent, store: this, isSummary});
+        const ret = new StoreRecord({
+            id,
+            store: this,
+            raw,
+            data,
+            committedData: data,
+            parent,
+            isSummary
+        });
 
         // Finalize summary only.  Non-summary finalized by RecordSet
         if (isSummary) ret.finalize();
@@ -1093,7 +1112,7 @@ export class Store extends HoistBase {
         return ret;
     }
 
-    private parseUpdate(data, update) {
+    private parseUpdate(data: PlainObject, update: PlainObject): PlainObject {
         const {_fieldMap} = this;
 
         // a) clone the existing object
@@ -1151,9 +1170,11 @@ export class Store extends HoistBase {
 
             const ret = new StoreRecord({
                 id: recToRevert.id,
-                raw: recToRevert.raw,
-                data: {...recToRevert.committedData},
                 store: this,
+                raw: recToRevert.raw,
+                data: recToRevert.committedData,
+                committedData: recToRevert.committedData,
+                parent: null,
                 isSummary: true
             });
             ret.finalize();

package/data/StoreRecord.ts

@@ -6,11 +6,12 @@
  */
 import {PlainObject} from '@xh/hoist/core';
 import {throwIf} from '@xh/hoist/utils/js';
-import {isNil, flatMap, isMatch} from 'lodash';
+import {isNil, flatMap, isMatch, isEmpty, pickBy} from 'lodash';
 import {Store} from './Store';
 import {ValidationState} from './validation/ValidationState';
 import {RecordValidator} from './impl/RecordValidator';
 import {Field} from './Field';
+import equal from 'fast-deep-equal';
 
 /**
  * Wrapper object for each data element within a {@link Store}. Records must be assigned a unique ID
@@ -184,6 +185,26 @@ export class StoreRecord {
         return ret;
     }
 
+    /**
+     * Get a map of modified values only.
+     *
+     * If record has no modifications, this method will return null.
+     * If modifications are returned, the returned object will include id,
+     * for convenience.
+     */
+    getModifiedValues(): PlainObject {
+        if (!this.isModified) return null;
+
+        const {data, committedData} = this,
+            ret = pickBy(data, (v, k) => !equal(v, committedData[k]));
+        if (!isEmpty(ret)) {
+            ret.id = this.id;
+            return ret;
+        } else {
+            return null;
+        }
+    }
+
     /**
      * Construct a StoreRecord from a pre-processed `data` source object.
      *
@@ -195,15 +216,7 @@ export class StoreRecord {
      * @internal
      */
     constructor(config: StoreRecordConfig) {
-        const {
-            id,
-            store,
-            data,
-            raw = null,
-            committedData = data,
-            parent,
-            isSummary = false
-        } = config;
+        const {id, store, raw, data, committedData, parent, isSummary} = config;
         throwIf(
             isNil(id),
             "Record needs an ID. Use 'Store.idSpec' to specify a unique ID for each record."

package/data/cube/View.ts

@@ -373,7 +373,7 @@ export class View extends HoistBase {
             if (isNil(bucketVal)) {
                 ret.push(row);
             } else {
-                const bucketRows = buckets[bucketVal] ??= [];
+                const bucketRows = (buckets[bucketVal] ??= []);
                 bucketRows.push(row);
             }
         });

package/desktop/cmp/rest/RestGridModel.ts

@@ -5,15 +5,16 @@
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
 
-import {RowDoubleClickedEvent} from '@xh/hoist/kit/ag-grid';
 import {BaseFieldConfig} from '@xh/hoist/cmp/form';
 import {GridConfig, GridModel} from '@xh/hoist/cmp/grid';
 import {ElementSpec, HoistModel, managed, PlainObject, XH} from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
 import {RecordAction, RecordActionSpec, StoreRecord} from '@xh/hoist/data';
+import {RowDoubleClickedEvent} from '@xh/hoist/kit/ag-grid';
 import {ExportOptions} from '@xh/hoist/svc';
 import {pluralize, throwIf, withDefault} from '@xh/hoist/utils/js';
 import {isFunction} from 'lodash';
+import {ReactNode} from 'react';
 import {FormFieldProps} from '../form';
 import {addAction, deleteAction, editAction, viewAction} from './Actions';
 import {RestStore, RestStoreConfig} from './data/RestStore';
@@ -39,9 +40,9 @@ export interface RestGridConfig extends GridConfig {
 
     /** Warning to display before actions on a selection of records. */
     actionWarning?: {
-        add?: string | ((recs: StoreRecord[]) => string);
-        del?: string | ((recs: StoreRecord[]) => string);
-        edit?: string | ((recs: StoreRecord[]) => string);
+        add?: ReactNode | ((recs: StoreRecord[]) => ReactNode);
+        del?: ReactNode | ((recs: StoreRecord[]) => ReactNode);
+        edit?: ReactNode | ((recs: StoreRecord[]) => ReactNode);
     };
 
     /** Name that describes records in this grid. */
@@ -109,11 +110,7 @@ export class RestGridModel extends HoistModel {
         add: null,
         edit: null,
         del: recs =>
-            recs.length > 1
-                ? `Are you sure you want to delete the selected ${recs.length} ${pluralize(
-                      this.unit
-                  )}?`
-                : `Are you sure you want to delete the selected ${this.unit}?`
+            `Are you sure you want to delete ${pluralize(`selected ${this.unit}`, recs.length, true)}?`
     };
 
     @managed gridModel: GridModel = null;

package/package.json

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