@xh/hoist 78.0.0-SNAPSHOT.1763606028729 → 78.0.0-SNAPSHOT.1763665705643

package/CHANGELOG.md

@@ -2,21 +2,29 @@
 
 ## 78.0.0-SNAPSHOT - unreleased
 
+### 💥 Breaking Changes
+
+* `GridModel.cleanColumnState` is now private (not expected to impact applications).
+* `GridModel.setColumnState` no longer patches existing column state, but instead replaces it
+  wholesale. Applications that were relying on the prior patching behavior will need to
+  call `GridModel.applyColumnStateChanges` instead.
+
 ### 🎁 New Features
 
-*  `FieldFilter` implementation expanded to support `not begins` and `not ends` operators.
+* `FieldFilter` implementation expanded to support `not begins` and `not ends` operators.
 
 ### 🐞 Bug Fixes
 
 * Fixed `GridModel` not appending children to the parents correctly when loaded data uses a
   numerical ID.
+* Fixed issue where newly added columns appearing in the Displayed Columns section of the column
+  chooser after loading grid state that was persisted before the columns were added to the grid.
 
 ### ⚙️ Technical
 
 * `FetchService` will recognize variants on the `application/json` content-type when processing
   failed responses and decoding exceptions - e.g. `application/problem+json`.
 
-
 ## 77.1.1 - 2025-11-12
 
 ### 🎁 New Features

package/build/types/cmp/ag-grid/AgGridModel.d.ts

@@ -122,8 +122,9 @@ export declare class AgGridModel extends HoistModel {
     applySortBy(value: Some<GridSorterLike>): void;
     /**
      * @returns the current row expansion state of the grid in a serializable form.
-     *      Returned object has keys for StoreRecordIds of top-level, expanded records and values
-     *      of either `true` or an object with keys of StoreRecordIds of expanded child records.
+     *      Returned object has keys for (stringified!) StoreRecordIds of all top-level
+     *      expanded rows and values of either `true` (if the row does not have any children, or
+     *      none are expanded) or a recursive object of the same shape (if children are expanded).
      */
     getExpandState(): PlainObject;
     /**

package/build/types/cmp/grid/GridModel.d.ts

@@ -464,7 +464,7 @@ export declare class GridModel extends HoistModel {
     /** Clear the underlying store, removing all rows. */
     clear(): void;
     setColumns(colConfigs: Array<ColumnSpec | ColumnGroupSpec>): void;
-    setColumnState(colState: Partial<ColumnState>[]): void;
+    setColumnState(colState: ColumnState[]): void;
     showColChooser(): void;
     noteAgColumnStateChanged(agColState: AgColumnState[]): void;
     setExpandState(expandState: any): void;
@@ -583,7 +583,7 @@ export declare class GridModel extends HoistModel {
     private validateStoreConfig;
     private validateColConfigs;
     private validateColumns;
-    cleanColumnState(columnState: any): any;
+    private cleanColumnState;
     private enhanceColConfigsFromStore;
     private enhanceStoreConfigFromColumns;
     private leafColsByFieldName;
@@ -597,4 +597,5 @@ export declare class GridModel extends HoistModel {
     private readonly RIGHT_BORDER_CLASS;
     private enhanceConfigWithGroupBorders;
     private createGroupBorderFn;
+    private getDefaultStateForColumn;
 }

package/cmp/ag-grid/AgGridModel.ts

@@ -408,8 +408,9 @@ export class AgGridModel extends HoistModel {
 
     /**
      * @returns the current row expansion state of the grid in a serializable form.
-     *      Returned object has keys for StoreRecordIds of top-level, expanded records and values
-     *      of either `true` or an object with keys of StoreRecordIds of expanded child records.
+     *      Returned object has keys for (stringified!) StoreRecordIds of all top-level
+     *      expanded rows and values of either `true` (if the row does not have any children, or
+     *      none are expanded) or a recursive object of the same shape (if children are expanded).
      */
     getExpandState(): PlainObject {
         this.throwIfNotReady();

package/cmp/grid/GridModel.ts

@@ -98,6 +98,7 @@ import {
     pull,
     take
 } from 'lodash';
+import {computed} from 'mobx';
 import {createRef, ReactNode, RefObject} from 'react';
 import {GridAutosizeOptions} from './GridAutosizeOptions';
 import {GridContextMenuSpec} from './GridContextMenu';
@@ -442,6 +443,7 @@ export class GridModel extends HoistModel {
     @observable.ref groupBy: string[] = null;
     @observable expandLevel: number = 0;
 
+    @computed.struct
     get persistableColumnState(): ColumnState[] {
         return this.cleanColumnState(this.columnState);
     }
@@ -1147,19 +1149,11 @@ export class GridModel extends HoistModel {
         this.validateColumns(columns);
 
         this.columns = columns;
-        this.columnState = this.getLeafColumns().map(it => ({
-            ...pick(it, ['colId', 'width', 'hidden', 'pinned']),
-            // If not in managed auto-size mode, treat in-code column widths as manuallySized so
-            // widths are not omitted from persistableColumnState. This is important because
-            // PersistanceProvider.getPersistableState() expects a complete snapshot of initial
-            // state in order to detect changes and restore initial state correctly.
-            // See https://github.com/xh/hoist-react/issues/4102.
-            manuallySized: !!(it.width && this.autosizeOptions.mode !== 'managed')
-        }));
+        this.columnState = this.getLeafColumns().map(it => this.getDefaultStateForColumn(it));
     }
 
-    setColumnState(colState: Partial<ColumnState>[]) {
-        this.applyColumnStateChanges(this.cleanColumnState(colState));
+    setColumnState(colState: ColumnState[]) {
+        this.columnState = this.cleanColumnState(colState);
     }
 
     showColChooser() {
@@ -1706,7 +1700,7 @@ export class GridModel extends HoistModel {
         );
     }
 
-    cleanColumnState(columnState) {
+    private cleanColumnState(columnState) {
         const gridCols = this.getLeafColumns();
 
         // REMOVE any state columns that are no longer found in the grid. These were likely saved
@@ -1715,9 +1709,9 @@ export class GridModel extends HoistModel {
 
         // ADD any grid columns that are not found in state. These are newly added to the code.
         // Insert these columns in position based on the index at which they are defined.
-        gridCols.forEach(({colId}, idx) => {
-            if (!find(ret, {colId})) {
-                ret.splice(idx, 0, {colId});
+        gridCols.forEach((col, idx) => {
+            if (!find(ret, {colId: col.colId})) {
+                ret.splice(idx, 0, this.getDefaultStateForColumn(col));
             }
         });
 
@@ -1958,4 +1952,16 @@ export class GridModel extends HoistModel {
             }
         };
     }
+
+    private getDefaultStateForColumn(column: Column): ColumnState {
+        return {
+            ...pick(column, ['colId', 'width', 'hidden', 'pinned']),
+            // If not in managed auto-size mode, treat in-code column widths as manuallySized so
+            // widths are not omitted from persistableColumnState. This is important because
+            // PersistanceProvider.getPersistableState() expects a complete snapshot of initial
+            // state in order to detect changes and restore initial state correctly.
+            // See https://github.com/xh/hoist-react/issues/4102.
+            manuallySized: !!(column.width && this.autosizeOptions.mode !== 'managed')
+        };
+    }
 }

package/cmp/grid/impl/InitPersist.ts

@@ -39,9 +39,7 @@ export function initPersist(
                     new PersistableColumnState(gridModel.persistableColumnState),
                 setPersistableState: ({value}) =>
                     runInAction(() => {
-                        // Set columnState directly since GridModel.setColumnState will merge the
-                        // provided state with the current state, which is not what we want here.
-                        gridModel.columnState = gridModel.cleanColumnState(value);
+                        gridModel.setColumnState(value);
                         if (gridModel.autosizeOptions.mode === 'managed') {
                             const columns = gridModel.columnState
                                 .filter(it => !it.manuallySized)

package/package.json

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