@xh/hoist 57.0.0 → 57.0.1

package/build/types/admin/tabs/server/memory/MemoryMonitorPanel.d.ts

@@ -0,0 +1,2 @@
+import { MemoryMonitorModel } from '@xh/hoist/admin/tabs/server/memory/MemoryMonitorModel';
+export declare const memoryMonitorPanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<MemoryMonitorModel>>;

package/build/types/admin/tabs/server/services/ServiceModel.d.ts

@@ -0,0 +1,8 @@
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel, LoadSpec } from '@xh/hoist/core';
+export declare class ServiceModel extends HoistModel {
+    gridModel: GridModel;
+    clearCachesAsync(): Promise<void>;
+    doLoadAsync(loadSpec: LoadSpec): Promise<any>;
+    private processRawData;
+}

package/build/types/admin/tabs/server/services/ServicePanel.d.ts

@@ -0,0 +1,2 @@
+import { ServiceModel } from './ServiceModel';
+export declare const servicePanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<ServiceModel>>;

package/build/types/admin/tabs/server/websocket/WebSocketColumns.d.ts

@@ -0,0 +1,8 @@
+import { ColumnSpec } from '@xh/hoist/cmp/grid/columns';
+export declare const isOpen: ColumnSpec;
+export declare const key: ColumnSpec;
+export declare const createdTime: ColumnSpec;
+export declare const sentMessageCount: ColumnSpec;
+export declare const lastSentTime: ColumnSpec;
+export declare const receivedMessageCount: ColumnSpec;
+export declare const lastReceivedTime: ColumnSpec;

package/build/types/admin/tabs/server/websocket/WebSocketModel.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { HoistModel, LoadSpec } from '@xh/hoist/core';
+import { GridModel } from '@xh/hoist/cmp/grid';
+export declare class WebSocketModel extends HoistModel {
+    viewRef: import("react").RefObject<HTMLElement>;
+    lastRefresh: number;
+    gridModel: GridModel;
+    private _timer;
+    constructor();
+    doLoadAsync(loadSpec: LoadSpec): Promise<void>;
+    forceSuspendOnSelectedAsync(): Promise<void>;
+}

package/build/types/admin/tabs/server/websocket/WebSocketPanel.d.ts

@@ -0,0 +1,2 @@
+import { WebSocketModel } from '@xh/hoist/admin/tabs/server/websocket/WebSocketModel';
+export declare const webSocketPanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<WebSocketModel>>;

package/build/types/admin/tabs/userData/JsonBlobColumns.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { ColumnSpec } from '@xh/hoist/cmp/grid/columns';
+export declare const owner: ColumnSpec;
+export declare const token: ColumnSpec;
+export declare const meta: ColumnSpec;
+export declare const acl: ColumnSpec;
+export declare const archived: ColumnSpec;
+export declare const archivedDate: ColumnSpec;
+export declare function archivedDateRenderer(v: any): import("react").ReactNode;

package/build/types/admin/tabs/userData/JsonBlobModel.d.ts

@@ -0,0 +1,15 @@
+import { HoistModel } from '@xh/hoist/core';
+import { RestGridModel } from '@xh/hoist/desktop/cmp/rest';
+import { LoadSpec } from '../../../core';
+import { DifferModel } from '../../differ/DifferModel';
+export declare class JsonBlobModel extends HoistModel {
+    persistWith: {
+        localStorageKey: string;
+    };
+    gridModel: RestGridModel;
+    differModel: DifferModel;
+    constructor();
+    doLoadAsync(loadSpec: LoadSpec): Promise<any>;
+    openDiffer(): void;
+    closeDiffer(): void;
+}

package/build/types/admin/tabs/userData/JsonBlobPanel.d.ts

@@ -0,0 +1,2 @@
+import { JsonBlobModel } from './JsonBlobModel';
+export declare const jsonBlobPanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<JsonBlobModel>>;

package/build/types/admin/tabs/userData/PreferenceModel.d.ts

@@ -0,0 +1,16 @@
+import { HoistModel, LoadSpec } from '@xh/hoist/core';
+import { RestGridModel } from '@xh/hoist/desktop/cmp/rest';
+import { DifferModel } from '../../differ/DifferModel';
+import { RegroupDialogModel } from '../../regroup/RegroupDialogModel';
+export declare class PreferenceModel extends HoistModel {
+    persistWith: {
+        localStorageKey: string;
+    };
+    regroupDialogModel: RegroupDialogModel;
+    gridModel: RestGridModel;
+    differModel: DifferModel;
+    constructor();
+    doLoadAsync(loadSpec: LoadSpec): Promise<any>;
+    openDiffer(): void;
+    closeDiffer(): void;
+}

package/build/types/admin/tabs/userData/PreferencePanel.d.ts

@@ -0,0 +1,2 @@
+import { PreferenceModel } from './PreferenceModel';
+export declare const preferencePanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<PreferenceModel>>;

package/build/types/admin/tabs/userData/UserDataTab.d.ts

@@ -0,0 +1 @@
+export declare const userDataTab: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<import("@xh/hoist/core").HoistModel>>;

package/build/types/admin/tabs/userData/UserPreferencePanel.d.ts

@@ -0,0 +1 @@
+export declare const userPreferencePanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<import("@xh/hoist/core").HoistModel>>;

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

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import { AboutDialogItem, HoistModel } from '@xh/hoist/core';
+/**
+ * @internal
+ */
+export declare class AboutDialogModel extends HoistModel {
+    xhImpl: boolean;
+    isOpen: boolean;
+    constructor();
+    init(): void;
+    show(): void;
+    hide(): void;
+    getTable(): import("react").ReactElement<import("react").DetailedHTMLProps<import("react").TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, any>;
+    getItems(): AboutDialogItem[];
+}

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

@@ -0,0 +1,43 @@
+import { HoistModel, RootRefreshContextModel, TaskObserver } from '@xh/hoist/core';
+import { AboutDialogModel } from './AboutDialogModel';
+import { BannerSourceModel } from './BannerSourceModel';
+import { ChangelogDialogModel } from './ChangelogDialogModel';
+import { ExceptionDialogModel } from './ExceptionDialogModel';
+import { FeedbackDialogModel } from './FeedbackDialogModel';
+import { ImpersonationBarModel } from './ImpersonationBarModel';
+import { MessageSourceModel } from './MessageSourceModel';
+import { OptionsDialogModel } from './OptionsDialogModel';
+import { SizingModeModel } from './SizingModeModel';
+import { ViewportSizeModel } from './ViewportSizeModel';
+import { ThemeModel } from './ThemeModel';
+import { ToastSourceModel } from './ToastSourceModel';
+/**
+ * Root object for Framework GUI State.
+ */
+export declare class AppContainerModel extends HoistModel {
+    /** Link any async operations that should mask the entire application to this model. */
+    appLoadModel: TaskObserver;
+    aboutDialogModel: AboutDialogModel;
+    changelogDialogModel: ChangelogDialogModel;
+    exceptionDialogModel: ExceptionDialogModel;
+    feedbackDialogModel: FeedbackDialogModel;
+    impersonationBarModel: ImpersonationBarModel;
+    optionsDialogModel: OptionsDialogModel;
+    bannerSourceModel: BannerSourceModel;
+    messageSourceModel: MessageSourceModel;
+    toastSourceModel: ToastSourceModel;
+    refreshContextModel: RootRefreshContextModel;
+    sizingModeModel: SizingModeModel;
+    viewportSizeModel: ViewportSizeModel;
+    themeModel: ThemeModel;
+    init(): void;
+    /**
+     * Show the update Banner. Called by EnvironmentService when the server reports that a
+     * new (or at least different) version is available and the user should be prompted.
+     *
+     * @param version - updated version from server.
+     * @param build - updated build from server - included for snapshot version prompts.
+     */
+    showUpdateBanner(version: string, build?: string): void;
+    hasAboutDialog(): boolean;
+}

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

@@ -0,0 +1,23 @@
+import { AppOptionSpec } from '@xh/hoist/core';
+/**
+ * Options specification for the app-wide options dialog.
+ *
+ * Option can be sourced from / set to a preference via the `prefName` config. Alternatively,
+ * the `valueGetter` and `valueSetter` config functions allow for custom handling if required.
+ *
+ * Apps will typically specify AppOption configurations in HoistAppModel.getAppOptions(). Implement
+ * this method and return one or more AppOption configs to enable the Options menu option in the
+ * primary AppBar menu.
+ */
+export declare class AppOption {
+    name: any;
+    prefName: any;
+    fieldModel: any;
+    formField: any;
+    valueGetter: any;
+    valueSetter: any;
+    reloadRequired: any;
+    constructor({ name, prefName, formField, fieldModel, valueGetter, valueSetter, reloadRequired }: AppOptionSpec);
+    getValueAsync(name: any): Promise<any>;
+    setValueAsync(name: any, value: any): Promise<void>;
+}

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

@@ -0,0 +1,26 @@
+import { BannerSpec, HoistModel } from '@xh/hoist/core';
+/**
+ * Model for a single instance of a banner. Immutable.
+ * @internal
+ */
+export declare class BannerModel extends HoistModel {
+    xhImpl: boolean;
+    category: any;
+    icon: any;
+    message: any;
+    intent: any;
+    sortOrder: any;
+    className: any;
+    enableClose: any;
+    onClose: any;
+    onClick: any;
+    actionButtonProps: any;
+    /**
+     * Sort order for Hoist-provided banners.
+     */
+    static BANNER_SORTS: {
+        APP_UPDATE: number;
+        ADMIN_ALERT: number;
+    };
+    constructor(spec: BannerSpec);
+}

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

@@ -0,0 +1,15 @@
+import { HoistModel, BannerSpec } from '@xh/hoist/core';
+import { BannerModel } from './BannerModel';
+/**
+ * Supporting model for managing the display of one or more app-wide banners.
+ * @see XH.showBanner()
+ * @internal
+ */
+export declare class BannerSourceModel extends HoistModel {
+    xhImpl: boolean;
+    bannerModels: BannerModel[];
+    constructor();
+    show(spec: BannerSpec): BannerModel;
+    hide(category: string): void;
+    private getBanner;
+}

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

@@ -0,0 +1,9 @@
+import { HoistModel } from '@xh/hoist/core';
+export declare class ChangelogDialogModel extends HoistModel {
+    xhImpl: boolean;
+    isOpen: boolean;
+    constructor();
+    init(): void;
+    show(): void;
+    hide(): void;
+}

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

@@ -0,0 +1,16 @@
+import { Component } from 'react';
+/**
+ * A minimal component implementing a React error boundary.
+ * Any errors during rendering will yield a simple error string and a call to the onError callback.
+ *
+ * @internal
+ */
+export declare class ErrorBoundary extends Component {
+    constructor(props: any);
+    render(): any;
+    componentDidCatch(e: any, info: any): void;
+    static getDerivedStateFromError(e: any): {
+        caughtError: any;
+    };
+}
+export declare const errorBoundary: import("@xh/hoist/core").ElementFactory<any>;

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

@@ -0,0 +1,28 @@
+import { ExceptionHandlerOptions, HoistException, HoistModel } from '@xh/hoist/core';
+/**
+ * Manages the default display of exceptions.
+ *
+ * Currently, we allow only a single exception (the latest) to be displayed at a time.
+ * Consider modifying to allow stacking, as with Message.
+ *
+ * @internal
+ */
+export declare class ExceptionDialogModel extends HoistModel {
+    xhImpl: boolean;
+    displayData: {
+        exception: HoistException;
+        options: ExceptionHandlerOptions;
+    };
+    detailsIsOpen: boolean;
+    /** Exception currently being displayed */
+    get exception(): HoistException;
+    /** Options for exception currently being displayed */
+    get options(): any;
+    /** Optional user supplied message */
+    userMessage: string;
+    constructor();
+    show(exception: HoistException, options: ExceptionHandlerOptions): void;
+    close(): void;
+    openDetails(): void;
+    sendReportAsync(): Promise<void>;
+}

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

@@ -0,0 +1,24 @@
+import { HoistModel } from '@xh/hoist/core';
+/**
+ * Manages built-in collection of user feedback.
+ * @internal
+ */
+export declare class FeedbackDialogModel extends HoistModel {
+    xhImpl: boolean;
+    isOpen: boolean;
+    message: string;
+    constructor();
+    init(): void;
+    show({ message }?: {
+        message?: any;
+    }): void;
+    hide(): void;
+    setMessage(message: string): void;
+    /**
+     * Submit the feedback entry. Username, browser info, environment info, and datetime will be
+     * recorded automatically by the server. Feedback entries are viewable via the Admin console,
+     * and feedback submissions can trigger server-side notifications.
+     * See FeedbackService.groovy within hoist-core for details.
+     */
+    submitAsync(): Promise<void>;
+}

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

@@ -0,0 +1,20 @@
+import { HoistModel } from '@xh/hoist/core';
+/**
+ *  @internal
+ */
+export declare class ImpersonationBarModel extends HoistModel {
+    xhImpl: boolean;
+    showRequested: boolean;
+    targets: string[];
+    pendingTarget: string;
+    constructor();
+    init(): void;
+    get isOpen(): boolean;
+    show(): void;
+    hide(): void;
+    toggleVisibility(): void;
+    readonly onCommit: () => Promise<void>;
+    readonly onClose: () => void;
+    private ensureTargetsLoaded;
+    private setTargets;
+}

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

@@ -0,0 +1,35 @@
+import { FormModel } from '@xh/hoist/cmp/form';
+import { HoistModel, MessageSpec } from '@xh/hoist/core';
+/**
+ * Model for a single instance of a modal dialog.
+ * Not intended for direct application use.
+ * @see XHClass.message()
+ * @internal
+ */
+export declare class MessageModel extends HoistModel {
+    xhImpl: boolean;
+    title: any;
+    icon: any;
+    message: any;
+    messageKey: any;
+    className: any;
+    input: any;
+    confirmProps: any;
+    cancelProps: any;
+    cancelAlign: any;
+    onConfirm: any;
+    onCancel: any;
+    dismissable: any;
+    cancelOnDismiss: any;
+    result: any;
+    _resolver: any;
+    formModel: FormModel;
+    isOpen: boolean;
+    constructor({ title, icon, message, messageKey, className, input, confirmProps, cancelProps, cancelAlign, onConfirm, onCancel, dismissable, cancelOnDismiss }: MessageSpec);
+    doConfirmAsync(): Promise<void>;
+    doCancel(): void;
+    doEscape(): void;
+    close(): void;
+    destroy(): void;
+    private parseButtonProps;
+}

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

@@ -0,0 +1,18 @@
+import { HoistModel, MessageSpec } from '@xh/hoist/core';
+import { MessageModel } from './MessageModel';
+/**
+ * Supports managed display of modal message dialogs via `XH.message()` and friends.
+ * Not intended for direct application use.
+ * @see XHClass.message()
+ * @internal
+ */
+export declare class MessageSourceModel extends HoistModel {
+    xhImpl: boolean;
+    msgModels: MessageModel[];
+    constructor();
+    message(config: MessageSpec): any;
+    alert(config: any): any;
+    confirm(config: any): any;
+    prompt(config: any): any;
+    addModel(model: any): void;
+}

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

@@ -0,0 +1,23 @@
+import { AppOptionSpec, HoistModel, TaskObserver } from '@xh/hoist/core';
+/**
+ * Manages built-in setting of options.
+ * @internal
+ */
+export declare class OptionsDialogModel extends HoistModel {
+    xhImpl: boolean;
+    isOpen: boolean;
+    options: any[];
+    loadTask: TaskObserver;
+    formModel: any;
+    constructor();
+    init(): void;
+    setOptions(options: AppOptionSpec[]): void;
+    get hasOptions(): boolean;
+    get reloadRequired(): boolean;
+    show(): void;
+    hide(): void;
+    toggleVisibility(): void;
+    initAsync(): Promise<void>;
+    saveAsync(): Promise<void>;
+    doSaveAsync(): Promise<void>;
+}

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/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,31 @@
+/// <reference types="react" />
+import { LayoutProps, HoistProps } from '@xh/hoist/core';
+import './AgGrid.scss';
+import { AgGridModel } from './AgGridModel';
+import { GridOptions } from '@xh/hoist/kit/ag-grid';
+export interface AgGridProps extends HoistProps<AgGridModel>, GridOptions, LayoutProps {
+}
+/**
+ * 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: import("react").FC<AgGridProps>, agGrid: import("@xh/hoist/core").ElementFactory<AgGridProps>;