@xh/hoist 57.0.0 → 57.0.2

package/build/types/cmp/grid/columns/Core.d.ts

@@ -0,0 +1,9 @@
+import { ColumnSpec } from './Column';
+/** Column config to render truthy values with a standardized green check icon. */
+export declare const boolCheck: ColumnSpec;
+export declare const number: ColumnSpec;
+export declare const fileExt: ColumnSpec;
+export declare const tags: ColumnSpec;
+export declare const boolCheckCol: ColumnSpec;
+export declare const numberCol: ColumnSpec;
+export declare const fileExtCol: ColumnSpec;

package/build/types/cmp/grid/columns/DatesTimes.d.ts

@@ -0,0 +1,12 @@
+import { ColumnSpec } from '@xh/hoist/cmp/grid';
+export declare const date: ColumnSpec;
+export declare const time: ColumnSpec;
+export declare const dateTime: ColumnSpec;
+export declare const dateTimeSec: ColumnSpec;
+export declare const compactDate: ColumnSpec;
+export declare const localDate: ColumnSpec;
+export declare const dateCol: ColumnSpec;
+export declare const timeCol: ColumnSpec;
+export declare const dateTimeCol: ColumnSpec;
+export declare const compactDateCol: ColumnSpec;
+export declare const localDateCol: ColumnSpec;

package/build/types/cmp/grid/columns/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Core';
+export * from './DatesTimes';
+export * from './Column';
+export * from './ColumnGroup';

package/build/types/cmp/grid/enums/ExcelFormat.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Data-type specific cell formats used in server-side Excel exports.
+ * Specify for a Grid Column via the `Column.excelFormat` config.
+ */
+export declare const ExcelFormat: {
+    DEFAULT: string;
+    LONG_TEXT: string;
+    NUM: string;
+    NUM_1DP: string;
+    NUM_2DP: string;
+    NUM_4DP: string;
+    NUM_DELIMITED: string;
+    NUM_DELIMITED_1DP: string;
+    NUM_DELIMITED_2DP: string;
+    NUM_DELIMITED_4DP: string;
+    LEDGER: string;
+    LEDGER_1DP: string;
+    LEDGER_2DP: string;
+    LEDGER_4DP: string;
+    LEDGER_COLOR: string;
+    LEDGER_COLOR_1DP: string;
+    LEDGER_COLOR_2DP: string;
+    LEDGER_COLOR_4DP: string;
+    THOUSANDS: string;
+    MILLIONS: string;
+    BILLIONS: string;
+    PCT: string;
+    PCT_1DP: string;
+    PCT_2DP: string;
+    PCT_4DP: string;
+    DATE_FMT: string;
+    DATETIME_FMT: string;
+};

package/build/types/cmp/grid/enums/GridAutosizeMode.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Mode for Grid governing Autosize behavior.
+ */
+export declare const GridAutosizeMode: Readonly<{
+    /** Grid will not allow autosizing of columns.*/
+    DISABLED: "disabled";
+    /**
+     * Grid will offer affordances such as context menus and gestures to allow users to manually
+     * trigger an autosize only. Applications should trigger with autosizeAsync().
+     */
+    ON_DEMAND: "onDemand";
+    /**
+     * Grid will autosize columns when the GridModel's sizingMode changes.
+     * Also offers the affordances provided by ON_DEMAND.
+     */
+    ON_SIZING_MODE_CHANGE: "onSizingModeChange";
+    /**
+     * Grid will autosize columns when the GridModel's sizingMode changes or data is loaded,
+     * unless the user has manually modified their column widths.
+     * Also offers the affordances provided by ON_DEMAND.
+     */
+    MANAGED: "managed";
+}>;
+export type GridAutosizeMode = (typeof GridAutosizeMode)[keyof typeof GridAutosizeMode];

package/build/types/cmp/grid/enums/TreeStyle.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Options controlling treeMode-specific styles (row background highlights and borders) for Grids.
+ */
+export declare const TreeStyle: Readonly<{
+    /** Highlight parent nodes in tree */
+    HIGHLIGHTS: "highlights";
+    COLORS: "colors";
+    /** Separate groups by placing a border above top level parent nodes */
+    BORDERS: "borders";
+    HIGHLIGHTS_AND_BORDERS: "highlightsAndBorders";
+    COLORS_AND_BORDERS: "colorsAndBorders";
+    NONE: "none";
+}>;
+export type TreeStyle = (typeof TreeStyle)[keyof typeof TreeStyle];
+export declare function getTreeStyleClasses(treeStyle: any): "xh-grid--tree-style-highlights" | "xh-grid--tree-style-colors" | "xh-grid--tree-style-borders" | "xh-grid--tree-style-highlights xh-grid--tree-style-borders" | "xh-grid--tree-style-colors xh-grid--tree-style-borders";

package/build/types/cmp/grid/filter/GridFilterFieldSpec.d.ts

@@ -0,0 +1,38 @@
+import { ColumnRenderer } from '@xh/hoist/cmp/grid';
+import { HoistInputProps } from '@xh/hoist/cmp/input';
+import { PlainObject } from '@xh/hoist/core';
+import { FieldFilterOperator } from '@xh/hoist/data';
+import { BaseFilterFieldSpec, BaseFilterFieldSpecConfig } from '@xh/hoist/data/filter/BaseFilterFieldSpec';
+import { GridFilterModel } from './GridFilterModel';
+export interface GridFilterFieldSpecConfig extends BaseFilterFieldSpecConfig {
+    /** GridFilterModel instance owning this fieldSpec. */
+    filterModel?: GridFilterModel;
+    /**
+     * Function returning a formatted string for each value in this values filter display.
+     * If not provided, the Column's renderer will be used.
+     */
+    renderer?: ColumnRenderer;
+    /**
+     * Props to pass through to the HoistInput components used on the custom filter tab.
+     * Note that the HoistInput component used is decided by fieldType.
+     */
+    inputProps?: HoistInputProps;
+    /** Default operator displayed in custom filter tab. */
+    defaultOp?: FieldFilterOperator;
+}
+/**
+ * Apps should NOT instantiate this class directly.
+ * Instead, provide a config for this object to the GridModel's `filterModel` config.
+ */
+export declare class GridFilterFieldSpec extends BaseFilterFieldSpec {
+    filterModel: GridFilterModel;
+    renderer: ColumnRenderer;
+    inputProps: PlainObject;
+    defaultOp: FieldFilterOperator;
+    valueCount: number;
+    constructor({ filterModel, renderer, inputProps, defaultOp, ...rest }: GridFilterFieldSpecConfig);
+    loadValuesFromSource(): void;
+    cleanFilter(filter: any): any;
+    valueFromRecord(record: any): any;
+    getUniqueValue(value: any): any;
+}

package/build/types/cmp/grid/filter/GridFilterModel.d.ts

@@ -0,0 +1,44 @@
+import { GridFilterFieldSpec, GridFilterModelConfig } from '@xh/hoist/cmp/grid';
+import { HoistModel } from '@xh/hoist/core';
+import { CompoundFilter, FieldFilter, Filter, FilterLike, Store, View } from '@xh/hoist/data';
+import { GridModel } from '../GridModel';
+/**
+ * Model for managing a Grid's column filters.
+ * @internal
+ */
+export declare class GridFilterModel extends HoistModel {
+    xhImpl: boolean;
+    gridModel: GridModel;
+    bind: Store | View;
+    commitOnChange: boolean;
+    fieldSpecs: GridFilterFieldSpec[];
+    get filter(): Filter;
+    dialogOpen: boolean;
+    static BLANK_PLACEHOLDER: string;
+    constructor({ bind, commitOnChange, fieldSpecs, fieldSpecDefaults }: GridFilterModelConfig, gridModel: GridModel);
+    /**
+     * Set / replace the filters for a given field.
+     * @param field - field to identify this filter
+     * @param filter - Filter to apply. If null, the filter will be removed
+     */
+    setColumnFilters(field: string, filter: FilterLike): void;
+    /**
+     * Appends the value of a new filter into the existing filter on the same field and operator.
+     * If such no filter exists, one will be created. Only applicable for filters with multi-value operators.
+     * @param field - field to identify this filter
+     * @param filter - Filter to apply. If null, the filter will be removed
+     */
+    mergeColumnFilters(field: string, filter: FilterLike): void;
+    clear(): void;
+    getColumnFilters(field: string): FieldFilter[];
+    /** The CompoundFilter that wraps the filters for specified field. */
+    getColumnCompoundFilter(field: string): CompoundFilter;
+    getFieldSpec(field: string): GridFilterFieldSpec;
+    toDisplayValue(value: any): any;
+    fromDisplayValue(value: any): any;
+    openDialog(): void;
+    closeDialog(): void;
+    setFilter(filter: any): void;
+    private parseFieldSpecs;
+    private getOuterCompoundFilter;
+}

package/build/types/cmp/grid/helpers/GridCountLabel.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="react" />
+import { GridModel } from '../GridModel';
+import { BoxProps, HoistProps } from '@xh/hoist/core';
+export interface GridCountLabelProps extends HoistProps, BoxProps {
+    /** GridModel to which this component should bind. */
+    gridModel?: GridModel;
+    /**
+     * True to count nested child records.
+     * If false (default) only root records will be included in count.
+     */
+    includeChildren?: boolean;
+    /**
+     * Control display of selection count after overall records count: auto (default) to display
+     * count when greater than 1, or always/never to show/hide regardless of current count.
+     */
+    showSelectionCount?: 'always' | 'never' | 'auto';
+    /** Units label appropriate for records being counted (e.g. "user" will yield, e.g. "50 users"). */
+    unit?: string;
+}
+/**
+ * Displays the number of records loaded into a grid's store + (configurable) selection count.
+ *
+ * Alternative to more general {@link StoreCountLabel}.
+ */
+export declare const GridCountLabel: import("react").FC<GridCountLabelProps>, gridCountLabel: import("@xh/hoist/core").ElementFactory<GridCountLabelProps>;

package/build/types/cmp/grid/impl/ColumnGroupHeader.d.ts

@@ -0,0 +1,24 @@
+import { ColumnGroup, GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel, HoistProps } from '@xh/hoist/core';
+import type { AgColumnGroup, IHeaderGroupParams } from '@xh/hoist/kit/ag-grid';
+export interface ColumnGroupHeaderProps extends HoistProps<ColumnGroupHeaderModel>, IHeaderGroupParams {
+    gridModel: GridModel;
+    xhColumnGroup: ColumnGroup;
+}
+/**
+ * A custom ag-Grid group header component.
+ *
+ * @internal
+ */
+export declare const columnGroupHeader: import("@xh/hoist/core").ElementFactory<ColumnGroupHeaderProps>;
+declare class ColumnGroupHeaderModel extends HoistModel {
+    xhImpl: boolean;
+    isExpanded: boolean;
+    get isExpandable(): boolean;
+    get agColumnGroup(): AgColumnGroup;
+    constructor();
+    onLinked(): void;
+    destroy(): void;
+    syncIsExpanded: () => boolean;
+}
+export {};

package/build/types/cmp/grid/impl/ColumnHeader.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="react" />
+import { HoistModel, HoistProps } from '@xh/hoist/core';
+import { Column, GridModel } from '@xh/hoist/cmp/grid';
+import { GridSorter } from '../GridSorter';
+import type { IHeaderParams, AgColumn } from '@xh/hoist/kit/ag-grid';
+export interface ColumnHeaderProps extends HoistProps<ColumnHeaderModel>, IHeaderParams {
+    gridModel: GridModel;
+    xhColumn: Column;
+}
+/**
+ * A custom ag-Grid header component.
+ *
+ * Relays sorting events directly to the controlling GridModel. Supports absolute value sorting
+ * by checking `Column.absSort` to determine next sortBy and by rendering custom sort icons.
+ *
+ * @internal
+ */
+export declare const columnHeader: import("@xh/hoist/core").ElementFactory<ColumnHeaderProps>;
+declare class ColumnHeaderModel extends HoistModel {
+    xhImpl: boolean;
+    get gridModel(): GridModel;
+    get xhColumn(): Column;
+    get agColumn(): AgColumn;
+    get colId(): string;
+    get enableSorting(): boolean;
+    availableSorts: any;
+    enableFilter: any;
+    columnHeaderFilterModel: any;
+    isAgFiltered: boolean;
+    agFilterButtonRef: import("react").RefObject<HTMLElement> & ((instance: HTMLElement) => void);
+    private _doubleClick;
+    private _lastTouch;
+    private _lastTouchStart;
+    private _lastMouseDown;
+    constructor();
+    onLinked(): void;
+    destroy(): void;
+    get activeGridSorter(): GridSorter;
+    get hasNonPrimarySort(): boolean;
+    get isFiltered(): any;
+    onFilterChanged: () => void;
+    get rootsWithChildren(): number;
+    get majorityIsExpanded(): boolean;
+    onMouseDown: () => void;
+    onExpandOrCollapse: (e: any) => void;
+    onClick: (e: any) => void;
+    onDoubleClick: () => void;
+    onTouchStart: (e: any) => void;
+    onTouchEnd: (e: any) => void;
+    updateSort(shiftKey: any): void;
+    getNextSortBy(): any;
+    autosize(): void;
+    parseAvailableSorts(): GridSorter[];
+}
+export {};

package/build/types/cmp/grid/impl/ColumnWidthCalculator.d.ts

@@ -0,0 +1,41 @@
+import { GridAutosizeOptions } from '@xh/hoist/cmp/grid/GridAutosizeOptions';
+import { Filter, StoreRecord } from '@xh/hoist/data';
+import { Column } from '../columns';
+import { GridModel } from '../GridModel';
+/**
+ * Calculates the column width required to display column.  Used by GridAutoSizeService.
+ *
+ * Uses Canvas, off-screen DOM, and heuristics to estimate the actual size requirement
+ * for a set of records when rendered in a column.
+ *
+ * @internal
+ */
+export declare class ColumnWidthCalculator {
+    /** Max number value to calculate size per column */
+    SIZE_CALC_SAMPLES: number;
+    private _canvasContext;
+    private _headerEl;
+    private _cellEl;
+    private _rowEl;
+    calcWidthAsync(gridModel: GridModel, records: StoreRecord[], colId: string, options: GridAutosizeOptions): Promise<any>;
+    calcHeaderWidth(gridModel: any, column: any, options: any): any;
+    calcDataWidthAsync(gridModel: any, records: any, column: any, options: any): Promise<number>;
+    calcLevelWidthAsync(gridModel: any, records: any, column: any, options: any, indentationPx?: number): Promise<number>;
+    getHeaderWidth(gridModel: any, column: any, includeHeaderIcons: any, bufferPx: any): any;
+    isColumnFiltered(filter: Filter, column: Column): boolean;
+    getHeaderHtml(gridModel: any, column: any): string;
+    resetHeaderClassNames(): void;
+    setHeaderClassNames(sizingMode: any, showSort: any, showMenu: any, headerClass: any): void;
+    getHeaderEl(): any;
+    getHeaderClass(gridModel: any, column: any): string;
+    getCellWidth(value: any, renderer: any): number;
+    resetClassNames(): void;
+    setClassNames(sizingMode: any, rowClass: any, cellClass: any): void;
+    getCellEl(): any;
+    getCellClass(gridModel: any, column: any, record: any, value: any): string;
+    getRowEl(): any;
+    getRowClass(gridModel: any, record: any): string;
+    getIndentation(depth: any): number;
+    getStringWidth(string: any): any;
+    getCanvasContext(): any;
+}

package/build/types/cmp/grid/impl/GridPersistenceModel.d.ts

@@ -0,0 +1,34 @@
+import { HoistModel, PersistenceProvider, PlainObject } from '@xh/hoist/core';
+import { GridModel } from '../GridModel';
+import { GridModelPersistOptions } from '../Types';
+/**
+ * Model to manage persisting state from GridModel.
+ * @internal
+ */
+export declare class GridPersistenceModel extends HoistModel {
+    xhImpl: boolean;
+    VERSION: number;
+    gridModel: GridModel;
+    state: PlainObject;
+    provider: PersistenceProvider;
+    constructor(gridModel: GridModel, { persistColumns, persistGrouping, persistSort, ...persistWith }: GridModelPersistOptions);
+    clear(): void;
+    columnReaction(): {
+        track: () => (import("../Types").AutosizeState | import("../Types").ColumnState[])[];
+        run: ([columnState, autosizeState]: [any, any]) => void;
+    };
+    updateGridColumns(): void;
+    sortReaction(): {
+        track: () => import("..").GridSorter[];
+        run: (sortBy: any) => void;
+    };
+    updateGridSort(): void;
+    groupReaction(): {
+        track: () => string[];
+        run: (groupBy: any) => void;
+    };
+    updateGridGroupBy(): void;
+    patchState(updates: any): void;
+    loadState(): any;
+    legacyState(): any;
+}

package/build/types/cmp/grid/impl/MenuSupport.d.ts

@@ -0,0 +1,7 @@
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { GridContextMenuSpec } from '../GridContextMenu';
+import type { GetContextMenuItemsParams, MenuItemDef } from '@xh/hoist/kit/ag-grid';
+/**
+ * @internal
+ */
+export declare function getAgGridMenuItems(params: GetContextMenuItemsParams, model: GridModel, spec: GridContextMenuSpec): Array<string | MenuItemDef>;

package/build/types/cmp/grid/impl/RowKeyNavSupport.d.ts

@@ -0,0 +1,11 @@
+import { GridModel } from '../GridModel';
+import type { CellPosition, NavigateToNextCellParams } from '@xh/hoist/kit/ag-grid';
+/**
+ * Add support for row based navigation to GridModel.
+ */
+export declare class RowKeyNavSupport {
+    gridModel: GridModel;
+    constructor(gridModel: GridModel);
+    navigateToNextCell(agParams: NavigateToNextCellParams): CellPosition;
+    findNextSelectable(index: any, isUp: any, agApi: any): any;
+}

package/build/types/cmp/grid/impl/Utils.d.ts

@@ -0,0 +1,5 @@
+import { ColumnRenderer, GroupRowRenderer } from '@xh/hoist/cmp/grid';
+/**
+ * @internal
+ */
+export declare function managedRenderer<T extends ColumnRenderer | GroupRowRenderer>(fn: T, identifier: string): T;

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

@@ -0,0 +1,15 @@
+export * from './enums/TreeStyle';
+export * from './enums/GridAutosizeMode';
+export * from './enums/ExcelFormat';
+export * from './GridAutosizeOptions';
+export * from './GridSorter';
+export * from './GridContextMenu';
+export * from './Types';
+export * from './columns';
+export * from './helpers/GridCountLabel';
+export * from './renderers/MultiFieldRenderer';
+export * from './renderers/TagsRenderer';
+export * from './filter/GridFilterModel';
+export * from './filter/GridFilterFieldSpec';
+export * from './Grid';
+export * from './GridModel';

package/build/types/cmp/grid/renderers/MultiFieldRenderer.d.ts

@@ -0,0 +1,27 @@
+import { ColumnRenderer } from '@xh/hoist/cmp/grid';
+import { ReactNode } from 'react';
+/**
+ * A grid rendererFn that renders a collection of additional SubFields in a row beneath the main column field.
+ *
+ * Requires the column to also specify a multiFieldConfig in its `appData`.
+ *
+ * The configs `subFields` act as pointers to other columns that exist in the GridModel's columns collection
+ * (often hidden). They will be rendered using the same rendererFn, headerName and value as the column
+ * they refer to.
+ */
+export declare function multiFieldRenderer(value: any, context: any): ReactNode;
+export interface MultiFieldConfig {
+    /** Array of SubField specifications to render. */
+    subFields: MultiFieldSubField[];
+    /** Renderer for primary field. */
+    mainRenderer?: ColumnRenderer;
+    /** string rendered between consecutive SubFields. */
+    delimiter?: string;
+}
+export interface MultiFieldSubField {
+    colId: string;
+    /** True to include the Column's headerName as label, or string. */
+    label?: boolean | 'string';
+    /** Where to render the sub field. Default 'bottom'. */
+    position?: 'top' | 'bottom';
+}

package/build/types/cmp/grid/renderers/TagsRenderer.d.ts

@@ -0,0 +1,3 @@
+import './TagsRenderer.scss';
+import { ReactNode } from 'react';
+export declare function tagsRenderer(v: any): ReactNode;

package/build/types/cmp/grouping/GroupingChooserModel.d.ts

@@ -0,0 +1,89 @@
+/// <reference types="react" />
+import { HoistModel, PersistenceProvider, PersistOptions, PlainObject } from '@xh/hoist/core';
+export interface GroupingChooserConfig {
+    /**
+     * Dimensions available for selection. When using GroupingChooser to create Cube queries,
+     * it is recommended to pass the `dimensions` from the related cube (or a subset thereof).
+     * Note that {@link CubeField} meets the `DimensionSpec` interface.
+     */
+    dimensions?: (DimensionSpec | string)[];
+    /** Initial value as an array of dimension names, or a function to produce such an array. */
+    initialValue?: string[] | (() => string[]);
+    /** Initial favorites as an array of dim name arrays, or a function to produce such an array. */
+    initialFavorites?: string[][] | (() => string[][]);
+    /** Options governing persistence. */
+    persistWith?: GroupingChooserPersistOptions;
+    /** True to accept an empty list as a valid value. */
+    allowEmpty?: boolean;
+    /** Maximum number of dimensions allowed in a single grouping. */
+    maxDepth?: number;
+    /**
+     * False (default) waits for the user to dismiss the popover before updating the
+     * external/observable value.
+     */
+    commitOnChange?: boolean;
+}
+/**
+ * Metadata for dimensions that are available for selection via a GroupingChooser control.
+ * Note that {@link CubeField} instances satisfy this interface.
+ */
+export interface DimensionSpec {
+    /** Shortname or code (almost always a `CubeField.name`). */
+    name: string;
+    /** User-friendly / longer name for display. */
+    displayName?: string;
+}
+export interface GroupingChooserPersistOptions extends PersistOptions {
+    /** True (default) to save value to state. */
+    persistValue?: boolean;
+    /** True (default) to include favorites. */
+    persistFavorites?: boolean;
+}
+export declare class GroupingChooserModel extends HoistModel {
+    value: string[];
+    favorites: string[][];
+    dimensions: Record<string, DimensionSpec>;
+    dimensionNames: string[];
+    allowEmpty: boolean;
+    maxDepth: number;
+    commitOnChange: boolean;
+    provider: PersistenceProvider;
+    persistValue: boolean;
+    persistFavorites: boolean;
+    pendingValue: string[];
+    editorIsOpen: boolean;
+    favoritesIsOpen: boolean;
+    popoverRef: import("react").RefObject<HTMLElement> & ((instance: HTMLElement) => void);
+    get availableDims(): string[];
+    get isValid(): boolean;
+    get isAddEnabled(): boolean;
+    constructor({ dimensions, initialValue, initialFavorites, persistWith, allowEmpty, maxDepth, commitOnChange }: GroupingChooserConfig);
+    setValue(value: string[]): void;
+    toggleEditor(): void;
+    toggleFavoritesMenu(): void;
+    closePopover(): void;
+    addPendingDim(dimName: string): void;
+    replacePendingDimAtIdx(dimName: string, idx: number): void;
+    removePendingDimAtIdx(idx: number): void;
+    movePendingDimToIndex(dimName: string, toIdx: number): void;
+    commitPendingValueAndClose(): void;
+    validateValue(value: any): boolean;
+    normalizeDimensions(dims: Array<DimensionSpec | string>): Record<string, DimensionSpec>;
+    createDimension(src: DimensionSpec | string): {
+        /** Shortname or code (almost always a `CubeField.name`). */
+        name: string;
+        displayName: string;
+    };
+    getValueLabel(value: string[]): string;
+    getDimDisplayName(dimName: string): string;
+    onDragEnd(result: any): void;
+    get favoritesOptions(): {
+        value: string[];
+        label: string;
+    }[];
+    setFavorites(favorites: string[][]): void;
+    addFavorite(value: string[]): void;
+    removeFavorite(value: string[]): void;
+    isFavorite(value: string[]): string[];
+    get persistState(): PlainObject;
+}

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

@@ -0,0 +1 @@
+export * from './GroupingChooserModel';