@xh/hoist 82.0.1 → 82.0.2

package/build/types/appcontainer/SizingModeModel.d.ts

@@ -0,0 +1,13 @@
+import { HoistModel, SizingMode } from '@xh/hoist/core';
+/**
+ * @internal
+ */
+export declare class SizingModeModel extends HoistModel {
+    xhImpl: boolean;
+    sizingMode: SizingMode;
+    constructor();
+    setSizingMode(sizingMode: SizingMode): void;
+    init(): void;
+    private getPref;
+    private getPlatform;
+}

package/build/types/appcontainer/ThemeModel.d.ts

@@ -0,0 +1,13 @@
+import { HoistModel, Theme } from '@xh/hoist/core';
+/**
+ * @internal
+ */
+export declare class ThemeModel extends HoistModel {
+    xhImpl: boolean;
+    darkTheme: boolean;
+    constructor();
+    toggleTheme(): void;
+    setDarkTheme(value: boolean): void;
+    setTheme(value: Theme, persist?: boolean): void;
+    init(): void;
+}

package/build/types/appcontainer/ToastModel.d.ts

@@ -0,0 +1,27 @@
+import { HoistModel, ToastSpec } from '@xh/hoist/core';
+import { ReactNode, ReactElement } from 'react';
+/**
+ * Model for a single instance of a pop-up Toast alert.
+ *
+ * An instance of this class is returned by the primary `XH.toast()` API and its variants.
+ * It is primarily useful for its `dismiss()` method, which can be called to programmatically
+ * dismiss a Toast at any time.
+ *
+ * All other properties on this object should be considered immutable - attempting to change them
+ * will have no effect.
+ */
+export declare class ToastModel extends HoistModel {
+    xhImpl: boolean;
+    message: ReactNode;
+    icon: ReactElement;
+    timeout: number;
+    intent: string;
+    actionButtonProps: any;
+    position: string;
+    containerRef: HTMLElement;
+    isOpen: boolean;
+    constructor({ message, icon, timeout, intent, actionButtonProps, position, containerRef }: ToastSpec);
+    /** Hide this Toast immediately, if displayed. */
+    dismiss(): void;
+    destroy(): void;
+}

package/build/types/appcontainer/ToastSourceModel.d.ts

@@ -0,0 +1,13 @@
+import { HoistModel, ToastSpec } from '@xh/hoist/core';
+import { ToastModel } from './ToastModel';
+/**
+ *  Supports displaying a pop-up Toast.
+ *  @internal
+ */
+export declare class ToastSourceModel extends HoistModel {
+    xhImpl: boolean;
+    toastModels: ToastModel[];
+    constructor();
+    show(config: ToastSpec | string): ToastModel;
+    private addModel;
+}

package/build/types/appcontainer/UserAgentModel.d.ts

@@ -0,0 +1,13 @@
+import { HoistModel } from '@xh/hoist/core';
+/**
+ * Support for user agent parsing.
+ * @internal
+ */
+export declare class UserAgentModel extends HoistModel {
+    xhImpl: boolean;
+    private _uaParser;
+    get isPhone(): boolean;
+    get isTablet(): boolean;
+    get isDesktop(): boolean;
+    private get uaParser();
+}

package/build/types/appcontainer/ViewportSizeModel.d.ts

@@ -0,0 +1,19 @@
+import { HoistModel } from '@xh/hoist/core';
+/**
+ * Exposes width / height of browser viewport + device orientation as observables.
+ *
+ * @internal
+ */
+export declare class ViewportSizeModel extends HoistModel {
+    xhImpl: boolean;
+    size: {
+        width: number;
+        height: number;
+    };
+    isPortrait: boolean;
+    /** Observable inverse of isPortrait. */
+    get isLandscape(): boolean;
+    constructor();
+    private setViewportSize;
+    private updateOrientation;
+}

package/build/types/appcontainer/login/LoginPanelModel.d.ts

@@ -0,0 +1,15 @@
+import { HoistModel, TaskObserver } from '@xh/hoist/core';
+/**
+ * Supports username/password form-based login.
+ * @internal
+ */
+export declare class LoginPanelModel extends HoistModel {
+    username: string;
+    password: string;
+    warning: string;
+    loginInProgress: boolean;
+    loginTask: TaskObserver;
+    get isValid(): boolean;
+    constructor();
+    submitAsync(): Promise<void>;
+}

package/build/types/cmp/ag-grid/AgGrid.d.ts

@@ -0,0 +1,30 @@
+import { HoistProps, LayoutProps, TestSupportProps } from '@xh/hoist/core';
+import { GridOptions } from '@xh/hoist/kit/ag-grid';
+import './AgGrid.scss';
+import { AgGridModel } from './AgGridModel';
+export interface AgGridProps extends HoistProps<AgGridModel>, GridOptions, LayoutProps, TestSupportProps {
+}
+/**
+ * Minimal wrapper for AgGridReact, supporting direct use of the ag-Grid component with limited
+ * enhancements for consistent Hoist themes/styling, layout support, and a
+ * backing model for convenient access to the ag-Grid APIs and other utility methods.
+ *
+ * All ag-Grid Grid Properties can be passed as props directly to this component.
+ * See {@link https://www.ag-grid.com/javascript-grid-properties/}.  Pass an {@link AgGridModel}
+ * via the `model` prop to control additional Hoist customizations.
+ *
+ * This component complements and contrasts with the primary Hoist `Grid` class, which provides a
+ * significantly more managed and opinionated use of ag-Grid and a number of Hoist-specific
+ * extensions and customizations. That fully managed component is expected to cover the majority of
+ * use cases within Hoist apps and is recommended as the primary grid class within the toolkit.
+ *
+ * This wrapper is provided for advanced usages of grid that wish to leverage features of the
+ * underlying component not yet supported by the Hoist layer - most notably pivoting - where the
+ * managed option would conflict with or complicate access to those features.
+ *
+ * Note that this component uses the ag-Grid `getRowHeight` prop to provide the grid with row
+ * heights.  As of 4/2023, this may cause scrolling to be slow in large data sets, and
+ * applications may wish to set this prop to `null` and use either a fixed `rowWidth` property, or
+ * an explicit per-row setting instead. See GridModel for a more efficient, data aware approach.
+ */
+export declare const AgGrid: any, agGrid: import("@xh/hoist/core").ElementFactory<AgGridProps>;

package/build/types/cmp/ag-grid/AgGridModel.d.ts

@@ -0,0 +1,180 @@
+import { HoistModel, PlainObject, SizingMode, Some } from '@xh/hoist/core';
+import type { GridApi, IRowNode, SortDirection } from '@xh/hoist/kit/ag-grid';
+import { GridSorterLike } from '../grid/GridSorter';
+export interface AgGridModelConfig {
+    sizingMode?: SizingMode;
+    /** True to highlight the currently hovered row. */
+    showHover?: boolean;
+    /** True to render row borders. */
+    rowBorders?: boolean;
+    /** True to render row borders. */
+    cellBorders?: boolean;
+    /** True to render cell borders. */
+    stripeRows?: boolean;
+    /** True to highlight the focused cell with a border. */
+    showCellFocus?: boolean;
+    /** True to suppress display of the grid's header row. */
+    hideHeaders?: boolean;
+    /** @internal */
+    xhImpl?: boolean;
+}
+/**
+ * @see https://www.ag-grid.com/javascript-grid-column-definitions/#saving-and-restoring-column-state
+ */
+export interface AgGridColumnState {
+    isPivot: boolean;
+    /** State of each column in the grid. */
+    columns: any[];
+}
+export interface AgGridColumnSortState {
+    colId: string;
+    sort?: SortDirection;
+    sortIndex: number;
+}
+export interface AgGridMiscState {
+    /** Identifier of the currently open tool panel in the side bar*/
+    panelId: string;
+}
+export interface AgGridState {
+    columnState?: AgGridColumnState;
+    sortState?: AgGridColumnSortState[];
+    expandState?: any;
+    filterState?: any[];
+    miscState?: AgGridMiscState;
+    errors?: Record<string, string>;
+}
+/**
+ * Model for an AgGrid, provides reactive support for setting grid styling as well as access to the
+ * ag-Grid API and Column API references for interacting with ag-Grid.
+ *
+ * Also provides a series of utility methods that are generally useful when managing grid state.
+ * This includes the ability to get and set the full state of the grid in a serializable form,
+ * allowing applications to save "views" of the grid.
+ */
+export declare class AgGridModel extends HoistModel {
+    static AUTO_GROUP_COL_ID: string;
+    sizingMode: SizingMode;
+    rowBorders: boolean;
+    stripeRows: boolean;
+    cellBorders: boolean;
+    showHover: boolean;
+    showCellFocus: boolean;
+    hideHeaders: boolean;
+    agApi: GridApi;
+    private _prevSortBy;
+    constructor({ sizingMode, showHover, rowBorders, cellBorders, stripeRows, showCellFocus, hideHeaders, xhImpl }?: AgGridModelConfig);
+    /** True if the grid fully initialized and its state can be queried/mutated. */
+    get isReady(): boolean;
+    /**
+     * Retrieves the current state of the grid via ag-Grid APIs. This state is returned in a
+     * serializable form and can be later restored via setState.
+     */
+    getState(opts?: {
+        excludeColumnState?: boolean;
+        excludeSortState?: boolean;
+        excludeExpandState?: boolean;
+        excludeFilterState?: boolean;
+        excludeMiscState?: boolean;
+    }): AgGridState;
+    /**
+     * Sets the current state of the grid. This method should generally only be used with an object
+     * returned by getState.
+     *
+     * Calls to this method should be made after the columns have been set in the grid.
+     *
+     * Some of the state may be data-dependent. Specifically the expandState and filterState. It is
+     * recommended that applications wait until the data has been loaded in the grid before setting
+     * the state if including those elements. This method can be called immediately after the data
+     * has been loaded via `agApi.updateGridOptions({rowData: data})`.
+     */
+    setState(state: AgGridState): void;
+    getMiscState(): AgGridMiscState;
+    /**
+     * Sets the grid state which doesn't fit into the other buckets.
+     */
+    setMiscState(miscState: AgGridMiscState): void;
+    /**
+     * @returns Current filter state of the grid.
+     * @see https://www.ag-grid.com/javascript-grid-filtering/#get-set-all-filter-models
+     */
+    getFilterState(): PlainObject;
+    /**
+     * Sets the grid filter state.
+     * Note that this state may be data-dependent, depending on the types of filter being used.
+     */
+    setFilterState(filterState: any): void;
+    /**
+     * @returns current sort state of the grid.
+     * @see https://www.ag-grid.com/javascript-grid-sorting/#sorting-api
+     */
+    getSortState(): AgGridColumnSortState[];
+    /**
+     * Sets the grid sort state.
+     */
+    setSortState(sortState: AgGridColumnSortState[]): void;
+    /** @returns current column state of the grid, including pivot mode */
+    getColumnState(): AgGridColumnState;
+    /** Sets the columns state of the grid. */
+    setColumnState(colState: AgGridColumnState): void;
+    /**
+     * Sets the sort state on the grid's column state
+     */
+    applySortBy(value: Some<GridSorterLike>): void;
+    /**
+     * @returns the current row expansion state of the grid in a serializable form.
+     *      Returned object has keys for (stringified!) StoreRecordIds of all top-level
+     *      expanded rows and values of either `true` (if the row does not have any children, or
+     *      none are expanded) or a recursive object of the same shape (if children are expanded).
+     */
+    getExpandState(): PlainObject;
+    /**
+     * Sets the grid row expansion state
+     * @param expandState - grid expand state retrieved via getExpandState()
+     */
+    setExpandState(expandState: PlainObject): void;
+    /** @returns list of selected row node ids */
+    getSelectedRowNodeIds(): string[];
+    /**
+     * Sets the selected row node ids. Any rows currently selected which are not in the list will be
+     * deselected.
+     *
+     * @param ids - row node ids to mark as selected
+     */
+    setSelectedRowNodeIds(ids: string[]): void;
+    /**
+     * @returns the id of the first row in the grid, after sorting and filtering, which
+     *      has data associated with it (i.e. not a group or other synthetic row).
+     */
+    getFirstSelectableRowNodeId(): string;
+    /**
+     * @returns the first row in the grid, after sorting and filtering, which
+     *  has data associated with it (i.e. not a group or other synthetic row).
+     */
+    getFirstSelectableRowNode(): IRowNode;
+    /**
+     * Sets the data used for rows which appear pinned to the top of the grid
+     * @param data - the data to pin at the top of the grid
+     */
+    setPinnedTopRowData(data: PlainObject[]): void;
+    /**
+     * @returns row data pinned to the top of the grid
+     */
+    getPinnedTopRowData(): PlainObject[];
+    /**
+     * Sets the data used for rows which appear pinned to the bottom of the grid
+     * @param data - the data to pin at the bottom of the grid
+     */
+    setPinnedBottomRowData(data: PlainObject[]): void;
+    /**
+     * @returns row data pinned to the bottom of the grid
+     */
+    getPinnedBottomRowData(): PlainObject[];
+    handleGridReady({ api }: {
+        api: any;
+    }): void;
+    handleGridUnmount(): void;
+    private getPinnedRowData;
+    private getPivotColumnId;
+    private getGroupNodePath;
+    private throwIfNotReady;
+}

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

@@ -0,0 +1,2 @@
+export * from './AgGridModel';
+export * from './AgGrid';

package/build/types/cmp/badge/Badge.d.ts

@@ -0,0 +1,12 @@
+import { BoxProps, HoistProps, Intent } from '@xh/hoist/core';
+import './Badge.scss';
+export interface BadgeProps extends HoistProps, BoxProps {
+    /** Sets fontsize to half that of parent element (default false). */
+    compact?: boolean;
+    intent?: Intent;
+}
+/**
+ * Badge indicator, generally displayed inline with text/title, showing a count or other small
+ * indicator that something is new or has content.
+ */
+export declare const Badge: import("react").FC<BadgeProps>, badge: import("@xh/hoist/core").ElementFactory<BadgeProps>;

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

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

package/build/types/cmp/card/Card.d.ts

@@ -0,0 +1,23 @@
+import { BoxProps, HoistProps, Intent, LayoutProps, TestSupportProps } from '@xh/hoist/core';
+import { type ReactElement, type ReactNode } from 'react';
+import { CardModel } from './CardModel';
+import './Card.scss';
+export interface CardProps<M extends CardModel = CardModel> extends HoistProps<M>, TestSupportProps, LayoutProps {
+    /** An icon placed left of the title. */
+    icon?: ReactElement;
+    /** Intent to apply to the inline header and border. */
+    intent?: Intent;
+    /** The title to display. */
+    title?: ReactNode;
+    /** Tooltip to show when hovering over the inline header. */
+    tooltip?: ReactElement | string;
+    /** Additional props to pass to the inner box hosting the content. */
+    contentBoxProps?: BoxProps;
+}
+/**
+ * A bordered container for grouping related content with optional inline header and collapsibility.
+ * Children are arranged vertically in a flexbox container by default. contentBoxProps can be
+ * passed to control the flex direction and other layout aspects of the content container.
+ * This component leverages an HTML fieldset and legend to provide base styling.
+ */
+export declare const Card: import("react").FC<CardProps<CardModel>>, card: import("@xh/hoist/core").ElementFactory<CardProps<CardModel>>;

package/build/types/cmp/card/CardModel.d.ts

@@ -0,0 +1,29 @@
+import { HoistModel, Persistable, PersistableState, PersistOptions, RenderMode } from '@xh/hoist/core';
+export interface CardModelConfig {
+    /** Can card be collapsed? */
+    collapsible?: boolean;
+    /** Default collapsed state. */
+    defaultCollapsed?: boolean;
+    /** How should collapsed content be rendered? */
+    renderMode?: RenderMode;
+    /** Options governing persistence. */
+    persistWith?: PersistOptions;
+}
+export interface CardPersistState {
+    collapsed?: boolean;
+}
+/**
+ * CardModel supports configuration and state-management for user-driven expand/collapse,
+ * along with support for saving this state via a configured PersistenceProvider.
+ */
+export declare class CardModel extends HoistModel implements Persistable<CardPersistState> {
+    config: CardModelConfig;
+    readonly collapsible: boolean;
+    readonly defaultCollapsed: boolean;
+    readonly renderMode: RenderMode;
+    collapsed: boolean;
+    constructor({ collapsible, defaultCollapsed, renderMode, persistWith }?: CardModelConfig);
+    setCollapsed(collapsed: boolean): void;
+    getPersistableState(): PersistableState<CardPersistState>;
+    setPersistableState(state: PersistableState<CardPersistState>): void;
+}

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

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

package/build/types/cmp/chart/Chart.d.ts

@@ -0,0 +1,17 @@
+import { HoistProps, LayoutProps, TestSupportProps } from '@xh/hoist/core';
+import './Chart.scss';
+import { ChartModel } from './ChartModel';
+export interface ChartProps<M extends ChartModel = ChartModel> extends HoistProps<M>, LayoutProps, TestSupportProps {
+    /**
+     * Ratio of width-to-height of displayed chart.  If defined and greater than 0, the chart will
+     * respect this ratio within the available space.  Otherwise, the chart will stretch on both
+     * dimensions to take up all available space.
+     */
+    aspectRatio?: number;
+}
+/**
+ * Wrapper Component for a Highcharts chart. Provides basic rendering / lifecycle management
+ * as well as configuration and theme defaults. The chart's core configuration should be sourced
+ * from a ChartModel prop passed to this component.
+ */
+export declare const Chart: import("react").FC<ChartProps<ChartModel>>, chart: import("@xh/hoist/core").ElementFactory<ChartProps<ChartModel>>;

package/build/types/cmp/chart/ChartModel.d.ts

@@ -0,0 +1,55 @@
+import type { ChartContextMenuSpec, ChartMenuToken } from '@xh/hoist/cmp/chart/Types';
+import { HoistModel, PlainObject, Some } from '@xh/hoist/core';
+interface ChartConfig {
+    /** The initial highchartsConfig for this chart. */
+    highchartsConfig: PlainObject;
+    /** The initial data series to be displayed. */
+    series?: Some<any>;
+    /**
+     * True (default) to show default ContextMenu. Supported on desktop only.
+     */
+    contextMenu?: ChartContextMenuSpec;
+    /** @internal */
+    xhImpl?: boolean;
+}
+/**
+ * Model to hold and maintain the configuration and data series for a Highcharts chart.
+ */
+export declare class ChartModel extends HoistModel {
+    highchartsConfig: PlainObject;
+    series: any[];
+    contextMenu: ChartContextMenuSpec;
+    static defaultContextMenu: ChartMenuToken[];
+    /**
+     * The HighCharts instance currently being displayed. This may be used for reading
+     * information about the chart, but any mutations to the chart should
+     * be done via {@link setHighchartsConfig} or {@link setSeries}.
+     */
+    highchart: any;
+    /** True if this chart has no series to display */
+    get empty(): boolean;
+    constructor(config?: ChartConfig);
+    /**
+     *  Update the Highcharts instance configuration.
+     *
+     *  See also {@link updateHighchartsConfig} for a method that will allow updating individual
+     *  properties in this object.
+     *
+     *  @param config - Highcharts configuration object. May include any Highcharts options other
+     *      than `series`, which should be set via `setSeries()`.
+     */
+    setHighchartsConfig(config: any): void;
+    /**
+     * Merge new properties settings into the Highcharts configuration (Deep merge)
+     *
+     * @param update - Updates to Highcharts configuration settings.  May include any
+     *      Highcharts options other than `series`, which should be set via `setSeries()`.
+     */
+    updateHighchartsConfig(update: any): void;
+    /** @param series - one or more data series to be charted. */
+    setSeries(series: any | any[]): void;
+    /** Remove all series from this chart. */
+    clear(): void;
+    private parseContextMenu;
+}
+export {};

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

@@ -0,0 +1,20 @@
+import { ChartModel } from '@xh/hoist/cmp/chart/ChartModel';
+import type { ContextMenuSpec, MenuContext, MenuToken } from '@xh/hoist/core';
+/**
+ * Highcharts supported tokens {@link https://api.highcharts.com/highcharts/exporting.buttons.contextButton.menuItems}
+ * plus Hoist's `copyToClipboard`.
+ */
+export type ChartMenuToken = 'viewFullscreen' | 'printChart' | 'downloadJPEG' | 'downloadPNG' | 'downloadSVG' | 'downloadCSV' | 'downloadXLS' | 'downloadPDF' | 'copyToClipboard' | MenuToken;
+export interface ChartMenuContext extends MenuContext {
+    chartModel: ChartModel;
+    /**
+     * Single point is the active series point the mouse is closest to
+     */
+    point: any;
+    /**
+     * Points array is the list of points hovered over in each series. When
+     * there are multiple series and tooltip.shared = true, points.length less than 1.
+     */
+    points: any[];
+}
+export type ChartContextMenuSpec = ContextMenuSpec<ChartMenuToken, ChartMenuContext>;

package/build/types/cmp/chart/impl/ChartContextMenuItems.d.ts

@@ -0,0 +1,4 @@
+import type { ChartMenuContext, ChartMenuToken } from '@xh/hoist/cmp/chart/Types';
+import { type MenuItem, type MenuItemLike } from '@xh/hoist/core';
+/** @internal */
+export declare function getContextMenuItems(items: MenuItemLike<ChartMenuToken>[], context: ChartMenuContext): (MenuItem<ChartMenuToken, ChartMenuContext> | '-')[];

package/build/types/cmp/chart/impl/copyToClipboard.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copy the chart in its current state to the clipboard - supported for webkit based browsers only.
+ * @internal
+ */
+export declare function installCopyToClipboard(Highcharts: any): void;

package/build/types/cmp/chart/impl/zoomout.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Transform the "select right-to-left" gesture into "zoom out" for charts with x-axis zooming.
+ * Gesture can be used in place of the default "reset zoom" button.
+ */
+export declare function installZoomoutGesture(Highcharts: any): void;

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

@@ -0,0 +1,2 @@
+export * from './Chart';
+export * from './ChartModel';