@xh/hoist 80.0.0-SNAPSHOT.1768415875152 → 80.0.0-SNAPSHOT.1768600489622

package/cmp/grid/Types.ts

@@ -7,23 +7,23 @@
 
 import {GridFilterFieldSpecConfig} from '@xh/hoist/cmp/grid/filter/GridFilterFieldSpec';
 import {HSide, PersistOptions, Some} from '@xh/hoist/core';
-import {Store, StoreRecord, View} from '@xh/hoist/data';
-import {ReactElement, ReactNode} from 'react';
-import {Column} from './columns/Column';
-import {ColumnGroup} from './columns/ColumnGroup';
-import {GridModel} from './GridModel';
+import {FilterBindTarget, FilterValueSource, Store, StoreRecord} from '@xh/hoist/data';
 
 import type {
     CellClassParams,
+    CustomCellEditorProps,
     HeaderClassParams,
     HeaderValueGetterParams,
     ICellRendererParams,
     IRowNode,
     ITooltipParams,
     RowClassParams,
-    ValueSetterParams,
-    CustomCellEditorProps
+    ValueSetterParams
 } from '@xh/hoist/kit/ag-grid';
+import type {ReactElement, ReactNode} from 'react';
+import type {Column, ColumnSpec} from './columns/Column';
+import type {ColumnGroup, ColumnGroupSpec} from './columns/ColumnGroup';
+import type {GridModel} from './GridModel';
 
 export interface ColumnState {
     colId: string;
@@ -87,10 +87,11 @@ export interface GridModelPersistOptions extends PersistOptions {
 
 export interface GridFilterModelConfig {
     /**
-     * Store / Cube View to be filtered as column filters are applied. Defaulted to the
-     * gridModel's store.
+     * Target (typically a {@link Store} or Cube {@link View}) to be filtered as column filters
+     * are applied and used as a source for unique values displayed in the filtering UI when
+     * applicable. Defaulted to the gridModel's store.
      */
-    bind?: Store | View;
+    bind?: GridFilterBindTarget;
 
     /**
      * True to update filters immediately after each change made in the column-based filter UI.
@@ -100,8 +101,8 @@ export interface GridFilterModelConfig {
 
     /**
      * Specifies the fields this model supports for filtering. Should be configs for
-     * {@link GridFilterFieldSpec}, string names to match with Fields in bound Store/View, or omitted
-     * entirely to indicate that all fields should be filter-enabled.
+     * {@link GridFilterFieldSpec}, string names to match with Fields in bound Store/View, or
+     * omitted entirely to indicate that all fields should be filter-enabled.
      */
     fieldSpecs?: Array<string | GridFilterFieldSpecConfig>;
 
@@ -109,6 +110,12 @@ export interface GridFilterModelConfig {
     fieldSpecDefaults?: Omit<GridFilterFieldSpecConfig, 'field'>;
 }
 
+/**
+ * {@link GridFilterModel} currently accepts a single `bind` target that also provides available
+ * values. Note that both `Store` and `View` satisfy this intersection.
+ */
+export interface GridFilterBindTarget extends FilterBindTarget, FilterValueSource {}
+
 /**
  * Renderer for a group row
  * @param context - The group renderer params from ag-Grid
@@ -142,6 +149,13 @@ export interface ColChooserConfig {
     height?: string | number;
 }
 
+export type ColumnOrGroup = Column | ColumnGroup;
+export type ColumnOrGroupSpec = ColumnSpec | ColumnGroupSpec;
+
+export function isColumnSpec(spec: ColumnOrGroupSpec): spec is ColumnSpec {
+    return !('children' in spec);
+}
+
 /**
  * Sort comparator function for a grid column. Note that this comparator will also be called if
  * agGrid-provided column filtering is enabled: it is used to sort values shown for set filter
@@ -248,7 +262,7 @@ export type ColumnTooltipFn<T = any> = (
  * @returns CSS class(es) to use.
  */
 export type ColumnHeaderClassFn = (context: {
-    column: Column | ColumnGroup;
+    column: ColumnOrGroup;
     gridModel: GridModel;
     agParams: HeaderClassParams;
 }) => Some<string>;

package/cmp/grid/columns/ColumnGroup.ts

@@ -13,7 +13,7 @@ import {throwIf, withDefault} from '@xh/hoist/utils/js';
 import {clone, isEmpty, isFunction, isString, keysIn} from 'lodash';
 import {ReactNode} from 'react';
 import {GridModel} from '../GridModel';
-import {ColumnHeaderClassFn, ColumnHeaderNameFn} from '../Types';
+import {ColumnHeaderClassFn, ColumnHeaderNameFn, ColumnOrGroup} from '../Types';
 import {Column, ColumnSpec} from './Column';
 
 export interface ColumnGroupSpec {
@@ -51,7 +51,7 @@ export interface ColumnGroupSpec {
  * Provided to GridModels as plain configuration objects.
  */
 export class ColumnGroup {
-    readonly children: Array<ColumnGroup | Column>;
+    readonly children: ColumnOrGroup[];
     readonly gridModel: GridModel;
     readonly groupId: string;
     readonly headerName: ReactNode | ColumnHeaderNameFn;
@@ -79,11 +79,7 @@ export class ColumnGroup {
      *
      * @internal
      */
-    constructor(
-        config: ColumnGroupSpec,
-        gridModel: GridModel,
-        children: Array<Column | ColumnGroup>
-    ) {
+    constructor(config: ColumnGroupSpec, gridModel: GridModel, children: ColumnOrGroup[]) {
         const {
             children: childrenSpecs,
             groupId,

package/cmp/grid/filter/GridFilterModel.ts

@@ -5,7 +5,12 @@
  * Copyright © 2026 Extremely Heavy Industries Inc.
  */
 
-import {GridFilterFieldSpec, GridFilterModelConfig} from '@xh/hoist/cmp/grid';
+import {
+    GridFilterBindTarget,
+    GridFilterFieldSpec,
+    GridFilterFieldSpecConfig,
+    GridFilterModelConfig
+} from '@xh/hoist/cmp/grid';
 import {HoistModel, managed} from '@xh/hoist/core';
 import {
     CompoundFilter,
@@ -13,8 +18,6 @@ import {
     Filter,
     FilterLike,
     flattenFilter,
-    Store,
-    View,
     withFilterByField,
     withFilterByTypes
 } from '@xh/hoist/data';
@@ -31,7 +34,7 @@ export class GridFilterModel extends HoistModel {
     override xhImpl = true;
 
     gridModel: GridModel;
-    bind: Store | View;
+    bind: GridFilterBindTarget;
     @bindable commitOnChange: boolean;
     @managed fieldSpecs: GridFilterFieldSpec[] = [];
 
@@ -66,7 +69,7 @@ export class GridFilterModel extends HoistModel {
     setColumnFilters(field: string, filter: FilterLike) {
         // If current bound filter is a CompoundFilter for a single column, wrap it
         // in an 'AND' CompoundFilter so new columns get 'ANDed' alongside it.
-        let currFilter = this.filter as any;
+        let currFilter: FilterLike = this.filter;
         if (currFilter instanceof CompoundFilter && currFilter.field) {
             currFilter = {filters: [currFilter], op: 'AND'};
         }
@@ -144,7 +147,10 @@ export class GridFilterModel extends HoistModel {
     //--------------------------------
     // Implementation
     //--------------------------------
-    private parseFieldSpecs(specs, fieldSpecDefaults) {
+    private parseFieldSpecs(
+        specs: Array<string | GridFilterFieldSpecConfig>,
+        fieldSpecDefaults: Omit<GridFilterFieldSpecConfig, 'field'>
+    ) {
         const {bind} = this;
 
         // If no specs provided, include all source fields.

package/cmp/grid/impl/Utils.ts

@@ -4,8 +4,8 @@
  *
  * Copyright © 2026 Extremely Heavy Industries Inc.
  */
-import {Column, ColumnGroup, ColumnRenderer, GroupRowRenderer} from '@xh/hoist/cmp/grid';
-import {HeaderClassParams} from '@xh/hoist/kit/ag-grid';
+import {Column, ColumnOrGroup, ColumnRenderer, GroupRowRenderer} from '@xh/hoist/cmp/grid';
+import type {HeaderClassParams} from '@xh/hoist/kit/ag-grid';
 import {logWarn} from '@xh/hoist/utils/js';
 import {castArray, isFunction} from 'lodash';
 
@@ -31,9 +31,7 @@ export function managedRenderer<T extends ColumnRenderer | GroupRowRenderer>(
  *
  *   @internal
  */
-export function getAgHeaderClassFn(
-    column: Column | ColumnGroup
-): (params: HeaderClassParams) => string[] {
+export function getAgHeaderClassFn(column: ColumnOrGroup): (params: HeaderClassParams) => string[] {
     const {headerClass, headerAlign, gridModel} = column;
 
     return agParams => {

package/cmp/tab/TabContainerModel.ts

@@ -123,7 +123,7 @@ export class TabContainerModel extends HoistModel {
 
     /**
      * @param config - TabContainer configuration.
-     * @param [depth] - Depth in hierarchy of nested TabContainerModels. Not for application use.
+     * @param depth - Depth in hierarchy of nested TabContainerModels. Not for application use.
      */
     constructor(
         {
@@ -138,7 +138,7 @@ export class TabContainerModel extends HoistModel {
             xhImpl = false,
             switcher = {mode: 'static'}
         }: TabContainerConfig,
-        depth = 0
+        depth: number = 0
     ) {
         super();
         makeObservable(this);

package/data/Field.ts

@@ -181,3 +181,8 @@ export function genDisplayName(fieldName: string): string {
     // Handle common cases of "id" -> "ID" and "foo_id" -> "Foo ID" (vs "Foo Id")
     return startCase(fieldName).replace(/(^| )Id\b/g, '$1ID');
 }
+
+/** Convenience function to return the name of a field from one of several common inputs. */
+export function getFieldName(field: string | Field | FieldSpec): string {
+    return field ? (isString(field) ? field : field.name) : null;
+}

package/data/cube/Cube.ts

@@ -8,17 +8,17 @@
 import {HoistBase, managed, PlainObject, Some} from '@xh/hoist/core';
 import {action, makeObservable, observable} from '@xh/hoist/mobx';
 import {forEachAsync} from '@xh/hoist/utils/async';
-import {CubeField, CubeFieldSpec} from './CubeField';
-import {ViewRowData} from './ViewRowData';
-import {Query, QueryConfig} from './Query';
-import {View} from './View';
+import {defaultsDeep, isEmpty} from 'lodash';
 import {Store, StoreRecordIdSpec, StoreTransaction} from '../Store';
 import {StoreRecord} from '../StoreRecord';
+import {BucketSpec} from './BucketSpec';
+import {CubeField, CubeFieldSpec} from './CubeField';
+import {Query, QueryConfig} from './Query';
 import {AggregateRow} from './row/AggregateRow';
-import {BucketRow} from './row/BucketRow';
 import {BaseRow} from './row/BaseRow';
-import {BucketSpec} from './BucketSpec';
-import {defaultsDeep, isEmpty} from 'lodash';
+import {BucketRow} from './row/BucketRow';
+import {View} from './View';
+import {ViewRowData} from './ViewRowData';
 
 export interface CubeConfig {
     fields: CubeField[] | CubeFieldSpec[];
@@ -160,6 +160,10 @@ export class Cube extends HoistBase {
         return this._connectedViews.size;
     }
 
+    getField(name: string): CubeField {
+        return this.store.getField(name) as CubeField;
+    }
+
     //------------------
     // Querying API
     //-----------------

package/package.json

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