@xh/hoist 82.0.1 → 82.0.3

package/build/types/cmp/form/field/SubformsFieldModel.d.ts

@@ -0,0 +1,70 @@
+import { PlainObject, Thunkable } from '@xh/hoist/core';
+import { ValidationResult, ValidationState } from '@xh/hoist/data';
+import { FormModel } from '../FormModel';
+import { BaseFieldModel, BaseFieldConfig } from './BaseFieldModel';
+import { FormConfig } from '../FormModel';
+export interface SubformsFieldConfig extends BaseFieldConfig {
+    /**
+     * Config for a {@link FormModel} to be auto-created to manage and validate the data for each
+     * object in this field's collection.
+     */
+    subforms: FormConfig;
+    /**
+     * Initial value of this field. If a function, will be executed dynamically when form is
+     * initialized to provide value.
+     */
+    initialValue?: Thunkable<PlainObject[]>;
+}
+export interface SubformAddOptions {
+    /** Initial values for the new object/subform. */
+    initialValues?: PlainObject;
+    /** Index within the collection where the new subform should be inserted. */
+    index?: number;
+}
+/**
+ * A data field in a form whose value is a collection of nested objects - all of the same shape, but
+ * with arbitrary internal complexity. A dedicated {@link FormModel} is auto-created to manage and
+ * validate each object independently.
+ *
+ * Applications should initialize this field with an array of objects. These values will be loaded
+ * into an array of managed FormModels which will form the value of this field.
+ *
+ * Applications should *not* modify the value property directly, unless they wish to reinitialize
+ * all existing form contents to new values. Call {@link add} or {@link remove} on one of these
+ * fields to adjust the contents of its collection while preserving existing state.
+ *
+ * Validation rules for the entire collection may be specified as for any field, but ValidationResults on
+ * the subforms will also bubble up to this field, affecting its overall validation state.
+ */
+export declare class SubformsFieldModel extends BaseFieldModel {
+    value: FormModel[];
+    initialValue: FormModel[];
+    /** (Sub)FormModels created by this model, tracked to support cleanup. */
+    private createdModels;
+    private formConfig;
+    private readonly origInitialValues;
+    constructor({ subforms, initialValue, ...rest }: SubformsFieldConfig);
+    get hasFocus(): boolean;
+    focus(): void;
+    blur(): void;
+    getDataOrProxy(): PlainObject[];
+    getData(): any[];
+    init(value: any): void;
+    setValue(v: any): void;
+    get formModel(): FormModel;
+    set formModel(formModel: FormModel);
+    get allValidationResults(): ValidationResult[];
+    reset(): void;
+    displayValidation(includeSubforms?: boolean): void;
+    get isValidationPending(): boolean;
+    get isDirty(): boolean;
+    validateAsync(opts?: {
+        display?: boolean;
+    }): Promise<boolean>;
+    protected deriveValidationState(): ValidationState;
+    /** Add a new object (subform) to this field's collection. */
+    add(opts?: SubformAddOptions): void;
+    remove(formModel: FormModel): void;
+    private parseValue;
+    private cleanupModels;
+}

package/build/types/cmp/form/formfieldset/FormFieldSet.d.ts

@@ -0,0 +1,17 @@
+import { BoxProps, HoistProps, type LayoutProps, type TestSupportProps } from '@xh/hoist/core';
+import { FormFieldSetModel } from '@xh/hoist/cmp/form/formfieldset/FormFieldSetModel';
+import { ReactElement, type ReactNode } from 'react';
+import './FormFieldSet.scss';
+export interface FormFieldSetProps extends HoistProps<FormFieldSetModel>, TestSupportProps, LayoutProps {
+    /** An icon placed left of the title. */
+    icon?: ReactElement;
+    /** The title to display. */
+    title?: ReactNode;
+    /** Additional props to pass to the inner content box. */
+    contentBoxProps?: BoxProps;
+}
+/**
+ * A container for grouping related form fields, with optional title and icon. Displays validation
+ * for all contained fields and child FormFieldSets.
+ */
+export declare const FormFieldSet: import("react").FC<FormFieldSetProps>, formFieldSet: import("@xh/hoist/core").ElementFactory<FormFieldSetProps>;

package/build/types/cmp/form/formfieldset/FormFieldSetModel.d.ts

@@ -0,0 +1,40 @@
+import { CardModel } from '@xh/hoist/cmp/card/CardModel';
+import { FieldModel } from '@xh/hoist/cmp/form';
+import { type PersistOptions } from '@xh/hoist/core';
+import { ValidationSeverity } from '@xh/hoist/data';
+export interface FormFieldSetConfig {
+    /** Can form field set be collapsed? */
+    collapsible?: boolean;
+    /** Default collapsed state. */
+    defaultCollapsed?: boolean;
+    /** True to disable all descendant fields. */
+    disabled?: boolean;
+    /** True to make all descendant fields readonly. */
+    readonly?: boolean;
+    /** Options governing persistence. */
+    persistWith?: PersistOptions;
+}
+export declare class FormFieldSetModel extends CardModel {
+    config: FormFieldSetConfig;
+    parent: FormFieldSetModel;
+    private childFormFieldSetModels;
+    private childFieldModels;
+    private isDisabled;
+    private isReadonly;
+    get disabled(): boolean;
+    get readonly(): boolean;
+    get displayedSeverity(): ValidationSeverity;
+    get displayedValidationMessages(): string[];
+    constructor({ disabled, readonly, ...rest }?: FormFieldSetConfig);
+    setDisabled(disabled: boolean): void;
+    setReadonly(readonly: boolean): void;
+    private get fieldModels();
+    /** @internal */
+    registerChildFieldModel(fieldModel: FieldModel): void;
+    /** @internal */
+    unregisterChildFieldModel(fieldModel: FieldModel): void;
+    /** @internal */
+    registerChildFormFieldSetModel(formFieldSetModel: FormFieldSetModel): void;
+    /** @internal */
+    unregisterChildFormFieldSetModel(formFieldSetModel: FormFieldSetModel): void;
+}

package/build/types/cmp/form/index.d.ts

@@ -0,0 +1,8 @@
+export * from './Form';
+export * from './FormModel';
+export * from './field/BaseFieldModel';
+export * from './field/FieldModel';
+export * from './field/SubformsFieldModel';
+export * from './formfieldset/FormFieldSet';
+export * from './formfieldset/FormFieldSetModel';
+export * from './BaseFormFieldProps';

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

@@ -0,0 +1,143 @@
+import { GridApi } from '@xh/hoist/kit/ag-grid';
+import { ColumnState } from '@xh/hoist/cmp/grid';
+import { HoistModel, HoistProps, LayoutProps, PlainObject, ReactionSpec, TestSupportProps } from '@xh/hoist/core';
+import { RecordSet } from '@xh/hoist/data/impl/RecordSet';
+import type { ColDef, ColGroupDef, GetContextMenuItemsParams, GridOptions, GridReadyEvent, ProcessCellForExportParams } from '@xh/hoist/kit/ag-grid';
+import './Grid.scss';
+import { GridModel } from './GridModel';
+export interface GridProps<M extends GridModel = GridModel> extends HoistProps<M>, LayoutProps, TestSupportProps {
+    /**
+     * Options for ag-Grid's API.
+     *
+     * This constitutes an 'escape hatch' for applications that need to get to the underlying
+     * ag-Grid API. It should be used with care. Settings made here might be overwritten and/or
+     * interfere with the implementation of this component and its use of the ag-Grid API.
+     *
+     * Note that changes to these options after the component's initial render will be ignored.
+     */
+    agOptions?: GridOptions;
+    /**
+     * Callback when the grid has initialized. The component will call this with the ag-Grid
+     * event after running its internal handler to associate the ag-Grid APIs with its model.
+     */
+    onGridReady?: (e: GridReadyEvent) => void;
+}
+/**
+ * The primary rich data grid component within the Hoist toolkit.
+ * It is a highly managed wrapper around ag-Grid and is the main display component for GridModel.
+ *
+ * Applications should typically configure and interact with Grids via a GridModel, which provides
+ * support for specifying the Grid's data Store, Column definitions, sorting and grouping state,
+ * selection API, and more.
+ *
+ * For advanced ag-Grid use-cases that are not well supported by this component, note that the
+ * {@link AgGrid} Hoist component provides much thinner and less opinionated wrapper around ag-Grid
+ * while still retaining consistent styling and some additional conveniences. However a number of
+ * core Hoist integrations and features will *not* be available with that thinner wrapper.
+ *
+ * @see {@link https://www.ag-grid.com/javascript-grid-reference-overview/|ag-Grid Docs}
+ * @see GridModel
+ */
+export declare const Grid: import("react").FC<GridProps<GridModel>>, grid: import("@xh/hoist/core").ElementFactory<GridProps<GridModel>>;
+export declare class GridLocalModel extends HoistModel {
+    xhImpl: boolean;
+    private model;
+    agOptions: GridOptions;
+    viewRef: import("react").RefObject<HTMLElement> & import("react").RefCallback<HTMLElement>;
+    private rowKeyNavSupport;
+    private prevRs;
+    /** @returns true if any root-level records have children */
+    get isHierarchical(): boolean;
+    get emptyText(): import("react").ReactNode;
+    constructor();
+    onLinked(): void;
+    private createDefaultAgOptions;
+    getColumnDefs(): Array<ColDef | ColGroupDef>;
+    getContextMenuItems: (params: GetContextMenuItemsParams) => (string | import("ag-grid-community").MenuItemDef<any, any>)[];
+    dataReaction(): {
+        track: () => (boolean | import("../../data").StoreRecord[] | RecordSet | import("@xh/hoist/core").VSide)[];
+        run: () => void;
+    };
+    selectionReaction(): {
+        track: () => (boolean | import("../../data").StoreRecord[])[];
+        run: () => void;
+    };
+    sortReaction(): {
+        track: () => (import("@xh/hoist/cmp/grid").GridSorter[] | GridApi<any>)[];
+        run: ([agApi, sortBy]: [any, any]) => void;
+    };
+    groupReaction(): {
+        track: () => (string[] | GridApi<any>)[];
+        run: ([agApi, groupBy]: [any, any]) => void;
+    };
+    get calculatedRowHeight(): any;
+    get calculatedGroupRowHeight(): any;
+    defaultGetRowHeight: ({ node }: {
+        node: any;
+    }) => any;
+    rowHeightReaction(): {
+        track: () => any[];
+        run: () => void;
+        debounce: number;
+    };
+    get useScrollOptimization(): boolean;
+    applyScrollOptimization(): void;
+    columnsReaction(): {
+        track: () => (import("@xh/hoist/cmp/grid").ColumnOrGroup[] | GridApi<any>)[];
+        run: ([api]: [any]) => void;
+    };
+    columnStateReaction(): ReactionSpec<[GridApi, ColumnState[]]>;
+    sizingModeReaction(): {
+        track: () => import("@xh/hoist/core").SizingMode;
+        run: () => void;
+    };
+    validationDisplayReaction(): {
+        track: () => (boolean | import("../../data").StoreValidationMessagesMap)[];
+        run: () => void;
+        debounce: number;
+    };
+    modalReaction(): {
+        track: () => any;
+        run: () => void;
+        debounce: number;
+    };
+    dashContainerReaction(): {
+        track: () => any;
+        run: (elem: any) => void;
+        debounce: number;
+    };
+    updatePinnedSummaryRowData(): void;
+    genTransaction(newRs: any, prevRs: any): any;
+    syncData(): void;
+    syncSelection(): void;
+    transactionIsEmpty(t: any): boolean;
+    private genTxnLogMsgs;
+    getDataPath: (record: any) => any;
+    onSelectionChanged: import("lodash").DebouncedFunc<() => void>;
+    onDragStopped: (ev: any) => void;
+    onColumnResized: (ev: any) => void;
+    onColumnRowGroupChanged: (ev: any) => void;
+    onRowGroupOpened: () => void;
+    onColumnPinned: (ev: any) => void;
+    onColumnVisible: (ev: any) => void;
+    groupSortComparator: ({ nodeA, nodeB }: {
+        nodeA: any;
+        nodeB: any;
+    }) => number;
+    doWithPreservedState({ filters }: PlainObject, fn: any): void;
+    readFilterState(): import("ag-grid-community").FilterModel;
+    writeFilterState(filterState: any): void;
+    processCellForClipboard: ({ value, node, column }: ProcessCellForExportParams) => any;
+    navigateToNextCell: (agParams: any) => import("ag-grid-community").CellPosition;
+    onCellMouseDown: (evt: any) => void;
+    onKeyDown: (evt: any) => void;
+    onRowClicked: (evt: any) => void;
+    onRowDoubleClicked: (evt: any) => void;
+    /**
+     * When a `Grid` context menu is open at the same time as a BP `Overlay2` with `enforceFocus`,
+     * the context menu will lose focus, causing menu items not to highlight on hover. Prevent this
+     * by conditionally stopping the focus event from propagating.
+     */
+    private static didAddFocusFixListener;
+    static addFocusFixListener(): void;
+}

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

@@ -0,0 +1,49 @@
+import { Some } from '@xh/hoist/core';
+import { Column } from './columns';
+import { GridAutosizeMode } from './enums/GridAutosizeMode';
+export interface GridAutosizeOptions {
+    /** Mode governing when resize occurs. Defaults to GridAutosizeMode.ON_SIZING_MODE_CHANGE.*/
+    mode?: GridAutosizeMode;
+    /**
+     * Additional pixels to add to the size of each column beyond its absolute minimum.
+     * May be used to adjust the spacing in the grid. Columns that wish to
+     * override this value may specify `Column.autosizeBufferPx`. Default is 5.
+     */
+    bufferPx?: number;
+    /**
+     *  True to show mask over the grid during the autosize operation. Default is true.
+     */
+    showMask?: boolean;
+    /**
+     * True to limit operation to rendered rows only. Default is false.
+     * Set to true for grids that contain many rows and columns, for which full autosizing
+     * of all data would be too slow.
+     */
+    renderedRowsOnly?: boolean;
+    /**
+     *  True to autosize all rows, even when hidden due to a collapsed ancestor row.
+     *  Only has an effect when renderedRowsOnly is false. Default is false.
+     *  Note that setting this to true can have performance impacts for large tree grids with many cells.
+     */
+    includeCollapsedChildren?: boolean;
+    /**
+     * True to also autosize hidden columns.
+     * Note that setting this to true can have performance impacts for grids with many columns hidden by default.
+     */
+    includeHiddenColumns?: boolean;
+    /**
+     * Columns ids to autosize, or a function for testing if the given column should be
+     * autosized. Typically used when calling autosizeAsync() manually. To generally exclude
+     * a column from autosizing, see the autosizable option on columns.
+     */
+    columns?: Some<string> | ((c: Column) => boolean);
+    /**
+     * How to fill remaining space after the columns have been autosized. Valid
+     * options are ['all', 'left', 'right', 'none']. Default is 'none'. Note this
+     * option is an advanced option that should be used with care - setting it will mean that all
+     * available horizontal space will be allocated. If the grid is subsequently compressed in
+     * width, or content added to it, horizontal scrolling of the columns may result that may
+     * require an additional autosize.
+     */
+    fillMode?: string;
+}

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

@@ -0,0 +1,28 @@
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { RecordActionLike } from '@xh/hoist/data';
+import { GetContextMenuItemsParams } from '@xh/hoist/kit/ag-grid';
+/**
+ * If a String, value can be '-' for a separator, or a token supported by ag-Grid
+ * for its native menu items, or a Hoist specific token.
+ * {@link https://www.ag-grid.com/javascript-grid-context-menu/#built-in-menu-items}
+ */
+export type GridContextMenuItemLike = RecordActionLike | GridContextMenuToken | string;
+/**
+ * Hoist tokens, all of which require a GridModel:
+ *          `autosizeColumns` - autosize columns to fit their contents.
+ *          `copyCell` - copy cell value to clipboard.
+ *          `colChooser` - display column chooser for a grid.
+ *          `expandCollapse` - expand/collapse parent rows on grouped or tree grid.
+ *          `export` - export grid data to excel via Hoist's server-side export capabilities.
+ *          `exportExcel` - alias for `export`.
+ *          `exportCsv` - export to CSV via Hoist's server-side export capabilities.
+ *          `exportLocal` - export to Excel via ag-Grid's built-in client side export.
+ *          'filter' - Sub menu to filter grid. Requires grid filtering.
+ *          `restoreDefaults` - restore column, sorting, and grouping configs and clear any
+ *              persistent grid state. See {@link GridModel.restoreDefaults}
+ */
+export type GridContextMenuToken = 'autosizeColumns' | 'copyCell' | 'colChooser' | 'expandCollapseAll' | 'expandCollapse' | 'export' | 'exportExcel' | 'exportCsv' | 'exportLocal' | 'filter' | 'restoreDefaults';
+/**
+ * Specification for a GridContextMenu.  Either a list of items, or a function to produce one.
+ */
+export type GridContextMenuSpec = GridContextMenuItemLike[] | ((agParams: GetContextMenuItemsParams, gridModel: GridModel) => GridContextMenuItemLike[]);