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

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

@@ -1,7 +1,7 @@
 import { AgGridModel } from '@xh/hoist/cmp/ag-grid';
 import { Column, ColumnGroup, ColumnOrGroup, ColumnOrGroupSpec, 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 { Awaitable, HoistModel, HSide, LoadSpec, 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';
@@ -471,7 +471,7 @@ export declare class GridModel extends HoistModel {
      * This method is a no-op if provided any sorters without a corresponding column.
      */
     setSortBy(sorters: Some<GridSorterLike>): void;
-    doLoadAsync(loadSpec: any): Promise<any>;
+    doLoadAsync(loadSpec: LoadSpec): Promise<any>;
     /** Load the underlying store. */
     loadData(rawData: any[], rawSummaryData?: Some<PlainObject>): void;
     /** Update the underlying store. */
@@ -601,8 +601,6 @@ export declare class GridModel extends HoistModel {
     private collectIds;
     private formatValuesForExport;
     private parseAndSetColumnsAndStore;
-    private validateStoreConfig;
-    private validateColConfigs;
     private validateColumns;
     private cleanColumnState;
     private enhanceColConfigsFromStore;

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

@@ -76,7 +76,12 @@ export interface GridFilterModelConfig {
     /** Default properties to be assigned to all fieldSpecs created by this model. */
     fieldSpecDefaults?: Omit<GridFilterFieldSpecConfig, 'field'>;
 }
-export type GridFilterBindTarget = FilterBindTarget & FilterValueSource;
+/**
+ * {@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

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

@@ -80,3 +80,5 @@ export type FieldType = (typeof FieldType)[keyof typeof FieldType];
  * @returns fieldName transformed into user-facing / longer name for display.
  */
 export declare function genDisplayName(fieldName: string): string;
+/** Convenience function to return the name of a field from one of several common inputs. */
+export declare function getFieldName(field: string | Field | FieldSpec): string;

package/cmp/grid/GridModel.ts

@@ -25,6 +25,7 @@ import {
     Awaitable,
     HoistModel,
     HSide,
+    LoadSpec,
     managed,
     PlainObject,
     SizingMode,
@@ -37,6 +38,7 @@ import {
 import {
     Field,
     FieldSpec,
+    getFieldName,
     Store,
     StoreConfig,
     StoreRecord,
@@ -91,7 +93,6 @@ import {
     isEmpty,
     isFunction,
     isNil,
-    isPlainObject,
     isString,
     isUndefined,
     keysIn,
@@ -1150,7 +1151,7 @@ export class GridModel extends HoistModel {
         this.sortBy = newSorters;
     }
 
-    override async doLoadAsync(loadSpec) {
+    override async doLoadAsync(loadSpec: LoadSpec) {
         // Delegate to any store that has load support
         return (this.store as any).loadSupport?.loadAsync(loadSpec);
     }
@@ -1172,7 +1173,6 @@ export class GridModel extends HoistModel {
 
     @action
     setColumns(colConfigs: ColumnOrGroupSpec[]) {
-        this.validateColConfigs(colConfigs);
         colConfigs = this.enhanceColConfigsFromStore(colConfigs);
 
         const columns = compact(colConfigs.map(c => this.buildColumn(c)));
@@ -1614,9 +1614,7 @@ export class GridModel extends HoistModel {
         if (this.isGroupSpec(config)) {
             if (config.borders !== false) borderedGroup = config;
             const children = compact(config.children.map(c => this.buildColumn(c, borderedGroup)));
-            return !isEmpty(children)
-                ? new ColumnGroup(config as ColumnGroupSpec, this, children)
-                : null;
+            return !isEmpty(children) ? new ColumnGroup(config, this, children) : null;
         }
 
         if (borderedGroup) {
@@ -1694,45 +1692,26 @@ export class GridModel extends HoistModel {
     // in this case GridModel should work out the required Store fields from column definitions.
     private parseAndSetColumnsAndStore(
         colConfigs: ColumnOrGroupSpec[],
-        store: Store | StoreConfig = {}
+        storeOrConfig: Store | StoreConfig = {}
     ) {
-        // 1) Validate configs.
-        this.validateStoreConfig(store);
-        this.validateColConfigs(colConfigs);
+        // Enhance colConfigs with field-level metadata provided by store, if any.
+        colConfigs = this.enhanceColConfigsFromStore(colConfigs, storeOrConfig);
 
-        // 2) Enhance colConfigs with field-level metadata provided by store, if any.
-        colConfigs = this.enhanceColConfigsFromStore(colConfigs, store);
-
-        // 3) Create and set columns with (possibly) enhanced configs.
+        // Create and set columns with (possibly) enhanced configs.
         this.setColumns(colConfigs);
 
-        let newStore: Store;
-        // 4) Create store if needed
-        if (isPlainObject(store)) {
-            store = this.enhanceStoreConfigFromColumns(store);
-            newStore = new Store({loadTreeData: this.treeMode, ...store});
-            newStore.xhImpl = this.xhImpl;
-            this.markManaged(newStore);
+        // Set or create Store as needed.
+        let store: Store;
+        if (storeOrConfig instanceof Store) {
+            store = storeOrConfig;
         } else {
-            newStore = store as Store;
+            storeOrConfig = this.enhanceStoreConfigFromColumns(storeOrConfig);
+            store = new Store({loadTreeData: this.treeMode, ...storeOrConfig});
+            store.xhImpl = this.xhImpl;
+            this.markManaged(store);
         }
 
-        this.store = newStore;
-    }
-
-    private validateStoreConfig(store: Store | StoreConfig) {
-        throwIf(
-            !(store instanceof Store || isPlainObject(store)),
-            'GridModel.store config must be either an instance of a Store or a config to create one.'
-        );
-    }
-
-    private validateColConfigs(colConfigs: ColumnOrGroupSpec[]) {
-        throwIf(!isArray(colConfigs), 'GridModel.columns config must be an array.');
-        throwIf(
-            colConfigs.some(c => !isPlainObject(c)),
-            'GridModel.columns config only accepts plain objects for Column or ColumnGroup configs.'
-        );
+        this.store = store;
     }
 
     private validateColumns(cols: ColumnOrGroup[]) {
@@ -1833,7 +1812,7 @@ export class GridModel extends HoistModel {
                 };
             }
 
-            const colFieldName = isString(col.field) ? col.field : col.field?.name,
+            const colFieldName = getFieldName(col.field),
                 field = fieldsByName[colFieldName];
 
             if (!field) return col;
@@ -1863,7 +1842,7 @@ export class GridModel extends HoistModel {
     // config object, not an instance.
     private enhanceStoreConfigFromColumns(storeConfig: StoreConfig) {
         const fields = storeConfig.fields ?? [],
-            storeFieldNames = fields.map(it => (isString(it) ? it : it.name)),
+            storeFieldNames = fields.map(it => getFieldName(it)),
             leafColsByFieldName = this.leafColsByFieldName();
 
         const newFields: FieldSpec[] = [];

package/cmp/grid/Types.ts

@@ -110,7 +110,11 @@ export interface GridFilterModelConfig {
     fieldSpecDefaults?: Omit<GridFilterFieldSpecConfig, 'field'>;
 }
 
-export type GridFilterBindTarget = FilterBindTarget & FilterValueSource;
+/**
+ * {@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
@@ -149,7 +153,7 @@ export type ColumnOrGroup = Column | ColumnGroup;
 export type ColumnOrGroupSpec = ColumnSpec | ColumnGroupSpec;
 
 export function isColumnSpec(spec: ColumnOrGroupSpec): spec is ColumnSpec {
-    return !(spec as ColumnGroupSpec).children;
+    return !('children' in spec);
 }
 
 /**

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "80.0.0-SNAPSHOT.1768517142984",
+  "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",