@xh/hoist 79.0.0-SNAPSHOT.1764976082522 → 79.0.0-SNAPSHOT.1765206353828

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## 79.0.0-SNAPSHOT - unreleased
 
+### 💥 Breaking Changes
+
+* Renamed `GridModel.applyColumnStateChanges()` to `updateColumnState()` for clarity and better
+  symmetry with `setColumnState()`. The prior method remains as an alias but is now deprecated and
+  scheduled for removal in v82.
+
 ### 🐞 Bug Fixes
 
 * Defaulted Highcharts font to Hoist default (--xh-font-family)

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

@@ -1,9 +1,9 @@
-import { CellClickedEvent, CellContextMenuEvent, CellDoubleClickedEvent, CellEditingStartedEvent, CellEditingStoppedEvent, AgColumnState, RowClickedEvent, RowDoubleClickedEvent } from '@xh/hoist/kit/ag-grid';
 import { AgGridModel } from '@xh/hoist/cmp/ag-grid';
 import { Column, ColumnGroup, ColumnGroupSpec, ColumnSpec, GridAutosizeMode, GridFilterModelConfig, GridGroupSortFn, TreeStyle } from '@xh/hoist/cmp/grid';
 import { GridFilterModel } from '@xh/hoist/cmp/grid/filter/GridFilterModel';
 import { Awaitable, HoistModel, HSide, PlainObject, SizingMode, Some, TaskObserver, Thunkable, VSide } from '@xh/hoist/core';
 import { Store, StoreConfig, StoreRecord, StoreRecordId, StoreRecordOrId, StoreSelectionConfig, StoreSelectionModel, StoreTransaction } from '@xh/hoist/data';
+import { AgColumnState, CellClickedEvent, CellContextMenuEvent, CellDoubleClickedEvent, CellEditingStartedEvent, CellEditingStoppedEvent, RowClickedEvent, RowDoubleClickedEvent } from '@xh/hoist/kit/ag-grid';
 import { ExportOptions } from '@xh/hoist/svc/GridExportService';
 import { ReactNode, RefObject } from 'react';
 import { GridAutosizeOptions } from './GridAutosizeOptions';
@@ -483,6 +483,8 @@ export declare class GridModel extends HoistModel {
      * @param colStateChanges - changes to apply to the columns. If all leaf
      *     columns are represented in these changes then the sort order will be applied as well.
      */
+    updateColumnState(colStateChanges: Partial<ColumnState>[]): void;
+    /** @deprecated - use {@link updateColumnState} instead. */
     applyColumnStateChanges(colStateChanges: Partial<ColumnState>[]): void;
     getColumn(colId: string): Column;
     getColumnGroup(groupId: string): ColumnGroup;

package/cmp/grid/GridModel.ts

@@ -4,17 +4,6 @@
  *
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
-import {
-    CellClickedEvent,
-    CellContextMenuEvent,
-    CellDoubleClickedEvent,
-    CellEditingStartedEvent,
-    CellEditingStoppedEvent,
-    ColumnEvent,
-    AgColumnState,
-    RowClickedEvent,
-    RowDoubleClickedEvent
-} from '@xh/hoist/kit/ag-grid';
 import {AgGridModel} from '@xh/hoist/cmp/ag-grid';
 import {
     Column,
@@ -56,15 +45,27 @@ import {
 import {ColChooserModel as DesktopColChooserModel} from '@xh/hoist/dynamics/desktop';
 import {ColChooserModel as MobileColChooserModel} from '@xh/hoist/dynamics/mobile';
 import {Icon} from '@xh/hoist/icon';
+import {
+    AgColumnState,
+    CellClickedEvent,
+    CellContextMenuEvent,
+    CellDoubleClickedEvent,
+    CellEditingStartedEvent,
+    CellEditingStoppedEvent,
+    ColumnEvent,
+    RowClickedEvent,
+    RowDoubleClickedEvent
+} from '@xh/hoist/kit/ag-grid';
 import {action, bindable, makeObservable, observable, when} from '@xh/hoist/mobx';
 import {wait, waitFor} from '@xh/hoist/promise';
 import {ExportOptions} from '@xh/hoist/svc/GridExportService';
 import {SECONDS} from '@xh/hoist/utils/datetime';
 import {
-    sharePendingPromise,
+    apiDeprecated,
     deepFreeze,
     executeIfFunction,
     logWithDebug,
+    sharePendingPromise,
     throwIf,
     warnIf,
     withDefault
@@ -1183,7 +1184,7 @@ export class GridModel extends HoistModel {
         );
 
         pull(colStateChanges, null);
-        this.applyColumnStateChanges(colStateChanges);
+        this.updateColumnState(colStateChanges);
     }
 
     @action
@@ -1214,7 +1215,7 @@ export class GridModel extends HoistModel {
         const col = this.findColumn(this.columns, colId);
         if (!width || !col || col.flex) return;
         const colStateChanges = [{colId, width, manuallySized: true}];
-        this.applyColumnStateChanges(colStateChanges);
+        this.updateColumnState(colStateChanges);
     }
 
     /**
@@ -1230,7 +1231,7 @@ export class GridModel extends HoistModel {
      *     columns are represented in these changes then the sort order will be applied as well.
      */
     @action
-    applyColumnStateChanges(colStateChanges: Partial<ColumnState>[]) {
+    updateColumnState(colStateChanges: Partial<ColumnState>[]): void {
         if (isEmpty(colStateChanges)) return;
 
         let columnState = cloneDeep(this.columnState);
@@ -1260,6 +1261,16 @@ export class GridModel extends HoistModel {
         }
     }
 
+    /** @deprecated - use {@link updateColumnState} instead. */
+    applyColumnStateChanges(colStateChanges: Partial<ColumnState>[]): void {
+        apiDeprecated('GridModel.applyColumnStateChanges()', {
+            msg: 'Use updateColumnState() instead.',
+            v: '82',
+            source: GridModel
+        });
+        this.updateColumnState(colStateChanges);
+    }
+
     getColumn(colId: string): Column {
         return this.findColumn(this.columns, colId);
     }
@@ -1295,7 +1306,7 @@ export class GridModel extends HoistModel {
     }
 
     setColumnVisible(colId: string, visible: boolean) {
-        this.applyColumnStateChanges([{colId, hidden: !visible}]);
+        this.updateColumnState([{colId, hidden: !visible}]);
     }
 
     showColumn(colId: string) {
@@ -1307,7 +1318,7 @@ export class GridModel extends HoistModel {
     }
 
     setColumnGroupVisible(groupId: string, visible: boolean) {
-        this.applyColumnStateChanges(
+        this.updateColumnState(
             this.getColumnGroup(groupId)
                 .getLeafColumns()
                 .map(({colId}) => ({colId, hidden: !visible}))

package/desktop/cmp/grid/impl/colchooser/ColChooserModel.ts

@@ -95,7 +95,7 @@ export class ColChooserModel extends HoistModel {
             }
         });
 
-        gridModel.applyColumnStateChanges(colChanges);
+        gridModel.updateColumnState(colChanges);
         if (autosizeOnCommit && colChanges.length) gridModel.autosizeAsync({showMask: true});
     }
 

package/mobile/cmp/grid/impl/ColChooserModel.ts

@@ -132,7 +132,7 @@ export class ColChooserModel extends HoistModel {
             return {colId, hidden, pinned};
         });
 
-        gridModel.applyColumnStateChanges(colChanges);
+        gridModel.updateColumnState(colChanges);
         if (autosizeOnCommit) gridModel.autosizeAsync({showMask: true});
     }
 

package/package.json

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

package/svc/GridAutosizeService.ts

@@ -79,7 +79,7 @@ export class GridAutosizeService extends HoistService {
 
         runInAction(() => {
             // Apply calculated widths to grid.
-            gridModel.applyColumnStateChanges(requiredWidths);
+            gridModel.updateColumnState(requiredWidths);
             this.logDebug(
                 `Auto-sized ${requiredWidths.length} columns`,
                 `${records.length} records`
@@ -94,7 +94,7 @@ export class GridAutosizeService extends HoistService {
                     fillMode,
                     asManuallySized
                 );
-                gridModel.applyColumnStateChanges(fillWidths);
+                gridModel.updateColumnState(fillWidths);
                 this.logDebug(`Auto-sized ${fillWidths.length} columns using fillMode`);
             }
         });