@xh/hoist 82.0.1 → 82.0.2

package/build/types/admin/tabs/userData/roles/details/members/DirectoryMembers.d.ts

@@ -0,0 +1,13 @@
+import { ColumnRenderer } from '@xh/hoist/cmp/grid';
+import { PlainObject } from '@xh/hoist/core';
+import './BaseMembers.scss';
+import { HoistRole } from '../../Types';
+import { BaseMembersModel } from './BaseMembersModel';
+export declare const directoryMembers: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<DirectoryMembersModel>>;
+declare class DirectoryMembersModel extends BaseMembersModel {
+    entityName: string;
+    get emptyText(): string;
+    getGridData(role: HoistRole): PlainObject[];
+    nameRenderer: ColumnRenderer;
+}
+export {};

package/build/types/admin/tabs/userData/roles/details/members/RoleMembers.d.ts

@@ -0,0 +1,16 @@
+import { PlainObject } from '@xh/hoist/core';
+import './BaseMembers.scss';
+import { ReactNode } from 'react';
+import { HoistRole } from '../../Types';
+import { BaseMembersModel } from './BaseMembersModel';
+export declare const roleMembers: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<RoleMembersModel>>;
+declare class RoleMembersModel extends BaseMembersModel {
+    get type(): 'inherited' | 'effective';
+    entityName: string;
+    get emptyText(): ReactNode;
+    getGridData(role: HoistRole): PlainObject[];
+    onRowDoubleClicked: ({ data: record }: {
+        data: any;
+    }) => void;
+}
+export {};

package/build/types/admin/tabs/userData/roles/details/members/UserMembers.d.ts

@@ -0,0 +1,15 @@
+import { ColumnRenderer } from '@xh/hoist/cmp/grid';
+import { PlainObject } from '@xh/hoist/core';
+import './BaseMembers.scss';
+import { HoistRole } from '../../Types';
+import { BaseMembersModel } from './BaseMembersModel';
+export declare const userMembers: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<UserMembersModel>>;
+declare class UserMembersModel extends BaseMembersModel {
+    entityName: string;
+    get emptyText(): string;
+    getGridData(role: HoistRole): PlainObject[];
+    private userSourceList;
+    sourcesRenderer: ColumnRenderer;
+    sourcesExportRenderer: ColumnRenderer;
+}
+export {};

package/build/types/admin/tabs/userData/roles/editor/RoleEditor.d.ts

@@ -0,0 +1,3 @@
+import { RoleEditorModel } from './RoleEditorModel';
+import './RoleEditor.scss';
+export declare const roleEditor: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<RoleEditorModel>>;

package/build/types/admin/tabs/userData/roles/editor/RoleEditorModel.d.ts

@@ -0,0 +1,23 @@
+import { HoistModel, TaskObserver } from '@xh/hoist/core';
+import { RoleModel } from '../RoleModel';
+import { HoistRole } from '../Types';
+import { RoleFormModel } from './form/RoleFormModel';
+export declare class RoleEditorModel extends HoistModel {
+    readonly roleModel: RoleModel;
+    readonly savingTask: TaskObserver;
+    readonly deletingTask: TaskObserver;
+    roleFormModel: RoleFormModel;
+    isOpen: boolean;
+    role?: HoistRole;
+    private resolve;
+    get saveDisabled(): boolean;
+    constructor(roleModel: RoleModel);
+    createAsync(roleSpec?: HoistRole): Promise<HoistRole>;
+    editAsync(role: HoistRole): Promise<HoistRole>;
+    saveAsync(): Promise<void>;
+    deleteAsync(): Promise<void>;
+    cancel(): void;
+    private openAsync;
+    private doCancel;
+    private close;
+}

package/build/types/admin/tabs/userData/roles/editor/form/RoleForm.d.ts

@@ -0,0 +1,3 @@
+import './RoleForm.scss';
+import { RoleFormModel } from './RoleFormModel';
+export declare const roleForm: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<RoleFormModel>>;

package/build/types/admin/tabs/userData/roles/editor/form/RoleFormModel.d.ts

@@ -0,0 +1,38 @@
+import { FormModel } from '@xh/hoist/cmp/form';
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel, SelectOption, TaskObserver } from '@xh/hoist/core';
+import { RecordActionSpec } from '@xh/hoist/data';
+import { RoleModel } from '../../RoleModel';
+import { HoistRole, RoleModuleConfig } from '../../Types';
+export declare class RoleFormModel extends HoistModel {
+    readonly ADD_ASSIGNMENT_ACTION: RecordActionSpec;
+    readonly ACTIONS: RecordActionSpec[];
+    readonly directoryGroupLookupTask: TaskObserver;
+    readonly roleModel: RoleModel;
+    readonly formModel: FormModel;
+    readonly usersGridModel: GridModel;
+    readonly directoryGroupsGridModel: GridModel;
+    readonly rolesGridModel: GridModel;
+    isEditingExistingRole: boolean;
+    invalidNames: string[];
+    categoryOptions: string[];
+    userOptions: string[];
+    directoryGroupOptions: string[];
+    roleOptions: SelectOption[];
+    get isDirty(): boolean;
+    get hasDirtyMembers(): boolean;
+    get isValid(): boolean;
+    get moduleConfig(): RoleModuleConfig;
+    get roleName(): string;
+    constructor(roleModel: RoleModel);
+    init(allRoles: HoistRole[], role?: Partial<HoistRole>): void;
+    validateAsync(): Promise<boolean>;
+    getData(): HoistRole;
+    private createFormModel;
+    private createGridModel;
+    private filterSelected;
+    private createAddAssigmentAction;
+    private createRemoveAssignmentAction;
+    private clearDegenerateRowReaction;
+    private lookupDirectoryGroupAsync;
+}

package/build/types/admin/tabs/userData/roles/graph/RoleGraph.d.ts

@@ -0,0 +1,3 @@
+import { RoleGraphModel } from './RoleGraphModel';
+import './RoleGraph.scss';
+export declare const roleGraph: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<RoleGraphModel>>;

package/build/types/admin/tabs/userData/roles/graph/RoleGraphModel.d.ts

@@ -0,0 +1,24 @@
+import { ChartModel } from '@xh/hoist/cmp/chart';
+import { HoistModel } from '@xh/hoist/core';
+import { RoleModel } from '../RoleModel';
+import { EffectiveRoleMember, HoistRole } from '../Types';
+export declare class RoleGraphModel extends HoistModel {
+    readonly roleModel: RoleModel;
+    readonly chartModel: ChartModel;
+    relationship: 'effective' | 'inherited';
+    inverted: boolean;
+    widthScale: number;
+    limitToOneLevel: boolean;
+    get relatedRoles(): EffectiveRoleMember[];
+    get role(): HoistRole;
+    get size(): {
+        width: number;
+        height: number;
+    };
+    constructor();
+    onLinked(): void;
+    private getSeriesData;
+    private createChartModel;
+    private get leafCount();
+    private get maxDepth();
+}

package/build/types/admin/tabs/userData/roles/recategorize/RecategorizeDialog.d.ts

@@ -0,0 +1,2 @@
+import { RecategorizeDialogModel } from '@xh/hoist/admin/tabs/userData/roles/recategorize/RecategorizeDialogModel';
+export declare const recategorizeDialog: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<RecategorizeDialogModel>>;

package/build/types/admin/tabs/userData/roles/recategorize/RecategorizeDialogModel.d.ts

@@ -0,0 +1,31 @@
+import { HoistModel, TaskObserver } from '@xh/hoist/core';
+import { StoreRecord } from '@xh/hoist/data';
+export declare class RecategorizeDialogModel extends HoistModel {
+    private parent;
+    selectedRecords: StoreRecord[];
+    readonly savingTask: TaskObserver;
+    categoryName: any;
+    isOpen: boolean;
+    recategorizeAction(): {
+        text: string;
+        icon: any;
+        recordsRequired: boolean;
+        actionFn: ({ selectedRecords }: {
+            selectedRecords: any;
+        }) => void;
+        displayFn: ({ selectedRecords }: {
+            selectedRecords: any;
+        }) => {
+            hidden: boolean;
+            disabled: boolean;
+        };
+    };
+    get options(): (string | {
+        value: string;
+        label: string;
+    })[];
+    constructor(parent: any);
+    saveAsync(): Promise<void>;
+    close(): void;
+    open(selectedRecords: any): void;
+}

package/build/types/admin/tabs/userData/roles/warning/WarningBanner.d.ts

@@ -0,0 +1,7 @@
+import { HoistProps } from '@xh/hoist/core';
+import './WarningBanner.scss';
+export interface WarningBannerProps extends HoistProps {
+    compact?: boolean;
+    message: string;
+}
+export declare const warningBanner: import("@xh/hoist/core").ElementFactory<WarningBannerProps>;

package/build/types/admin/tabs/userData/users/UserModel.d.ts

@@ -0,0 +1,12 @@
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel, LoadSpec } from '@xh/hoist/core';
+export declare class UserModel extends HoistModel {
+    persistWith: {
+        localStorageKey: string;
+    };
+    activeOnly: boolean;
+    withRolesOnly: boolean;
+    gridModel: GridModel;
+    constructor();
+    doLoadAsync(loadSpec: LoadSpec): Promise<void>;
+}

package/build/types/admin/tabs/userData/users/UserPanel.d.ts

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

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

@@ -0,0 +1,14 @@
+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,93 @@
+import { AppSpec, HoistAppModel, HoistModel, IdentityInfo, RootRefreshContextModel, TaskObserver } from '@xh/hoist/core';
+import { ReactNode } from 'react';
+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';
+import { UserAgentModel } from './UserAgentModel';
+import { AppStateModel } from './AppStateModel';
+import { PageStateModel } from './PageStateModel';
+import { RouterModel } from './RouterModel';
+/**
+ * Root object for Framework GUI State.
+ */
+export declare class AppContainerModel extends HoistModel {
+    private initCalled;
+    appSpec: AppSpec;
+    appModel: HoistAppModel;
+    appLoadObserver: TaskObserver;
+    appStateModel: AppStateModel;
+    pageStateModel: PageStateModel;
+    routerModel: RouterModel;
+    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;
+    userAgentModel: UserAgentModel;
+    /**
+     * Message shown on spinner while the application is in a pre-running state.
+     * Update within `AppModel.initAsync()` to relay app-specific initialization status.
+     */
+    initializingLoadMaskMessage: ReactNode;
+    /**
+     * The last interactive login in the app. Hoist's security package will mark the last
+     * time spent during user interactive login.
+     *
+     * Used by `Promise.track`, to ensure this time is not counted in any elapsed time tracking
+     * for the app.
+     * @internal
+     */
+    lastRelogin: {
+        started: number;
+        completed: number;
+    };
+    constructor();
+    /**
+     * Main entry point. Initialize and render application code.
+     */
+    renderApp<T extends HoistAppModel>(appSpec: AppSpec<T>): void;
+    /**
+     * Called when {@link AppContainer} first mounted.
+     * Triggers initial authentication and initialization of Hoist and application.
+     */
+    initAsync(): Promise<unknown>;
+    /**
+     * Complete initialization. Called after the client has confirmed that the user is generally
+     * authenticated and known to the server (regardless of application roles at this point).
+     */
+    completeInitAsync(identity: IdentityInfo): Promise<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;
+    openAdmin(): void;
+    private setDocTitle;
+    private startRouter;
+    private startOptionsDialog;
+    private setAppState;
+    private bindInitSequenceToAppLoadObserver;
+    private setViewportContent;
+    private getViewportContent;
+}

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(): Promise<any>;
+    setValueAsync(value: any): Promise<void>;
+}

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

@@ -0,0 +1,28 @@
+import { AppState, AppSuspendData, HoistModel } from '@xh/hoist/core';
+/**
+ * Support for Core Hoist Application state and loading.
+ *
+ * @internal
+ */
+export declare class AppStateModel extends HoistModel {
+    xhImpl: boolean;
+    state: AppState;
+    lastActivityMs: number;
+    suspendData: AppSuspendData;
+    accessDeniedMessage: string;
+    /**
+     * Timestamp when the app first started loading, prior to even JS download/eval.
+     * Read from timestamp set on window within index.html.
+     */
+    readonly loadStarted: number;
+    readonly timings: Record<AppState, number>;
+    private lastStateChangeTime;
+    constructor();
+    setAppState(nextState: AppState): void;
+    suspendApp(suspendData: AppSuspendData): void;
+    checkAccess(): boolean;
+    private trackLoad;
+    private createActivityListeners;
+    private getScreenData;
+    private getWindowData;
+}

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/ExceptionDialogModel.d.ts

@@ -0,0 +1,30 @@
+import type { HoistException } from '@xh/hoist/exception';
+import { ExceptionHandlerOptions, 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;
+    showDetails(exception: HoistException, options: ExceptionHandlerOptions): void;
+    close(): void;
+    openDetails(): void;
+    sendReportAsync(): Promise<void>;
+}

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

@@ -0,0 +1,21 @@
+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 to the activity tracking system.
+     */
+    submitAsync(): Promise<void>;
+}

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

@@ -0,0 +1,22 @@
+import { HoistInputModel } from '@xh/hoist/cmp/input';
+import { HoistModel } from '@xh/hoist/core';
+/**
+ *  @internal
+ */
+export declare class ImpersonationBarModel extends HoistModel {
+    xhImpl: boolean;
+    showRequested: boolean;
+    targets: string[];
+    pendingTarget: string;
+    inputRef: import("react").RefObject<HoistInputModel>;
+    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,37 @@
+import { FormModel } from '@xh/hoist/cmp/form';
+import { HoistModel, MessageSpec } from '@xh/hoist/core';
+import { ReactNode } from 'react';
+/**
+ * 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;
+    extraConfirmLabel: ReactNode;
+    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, extraConfirmText, extraConfirmLabel, 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,17 @@
+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 - use helpers off of `XH` instead.
+ * @internal
+ */
+export declare class MessageSourceModel extends HoistModel {
+    xhImpl: boolean;
+    msgModels: MessageModel[];
+    constructor();
+    message(config: MessageSpec): any;
+    alert(config: MessageSpec): any;
+    confirm(config: MessageSpec): any;
+    prompt(config: MessageSpec): any;
+    private addModel;
+}

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

@@ -0,0 +1,25 @@
+import { FormModel } from '@xh/hoist/cmp/form';
+import { AppOptionSpec, HoistModel, TaskObserver } from '@xh/hoist/core';
+import { AppOption } from './AppOption';
+/**
+ * Manages built-in setting of options.
+ * @internal
+ */
+export declare class OptionsDialogModel extends HoistModel {
+    xhImpl: boolean;
+    isOpen: boolean;
+    options: AppOption[];
+    loadTask: TaskObserver;
+    formModel: FormModel;
+    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/PageStateModel.d.ts

@@ -0,0 +1,16 @@
+import { HoistModel, PageState } from '@xh/hoist/core';
+/**
+ * Implementation of PageState maintenance.
+ *
+ * Based on https://developer.chrome.com/blog/page-lifecycle-api/
+ *
+ * @internal
+ */
+export declare class PageStateModel extends HoistModel {
+    xhImpl: boolean;
+    state: PageState;
+    constructor();
+    private setState;
+    private getLiveState;
+    private addListeners;
+}

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

@@ -0,0 +1,41 @@
+import { HoistModel } from '../core';
+import { Router, State } from 'router5';
+/**
+ * Top-level model for managing application routing in Hoist.
+ *
+ * This observable model uses Router5 (https://router5.js.org/) to manage the
+ * underlying routes, presenting them to the application as a set of MobX observables.
+ */
+export declare class RouterModel extends HoistModel {
+    /** Router5 state object representing the current state. */
+    currentState: State;
+    /** Underlying Router5 Router object implementing the routing state. */
+    router: Router;
+    /**
+     * Does the routing system already have a given route?
+     */
+    hasRoute(routeName: string): boolean;
+    /**
+     * Add routes to the router.
+     *
+     * @param routes - collection of router5 route spec.
+     *      This method supports an additional keyword 'omit' on each spec, in order to allow declarative
+     *      exclusion.  Otherwise these are Router5 configs to be passed directly to the Router5 API.
+     */
+    addRoutes(routes: object[]): void;
+    /**
+     * Add a routeName to the current route, preserving params
+     * @param routeName - the routeName to append
+     * @param newParams - additional params for this routeName to be merged with existing params.
+     */
+    appendRoute(routeName: string, newParams?: object): import("router5/types/types/base").CancelFn;
+    /**
+     * Remove last routeName from the current route, preserving params
+     */
+    popRoute(): import("router5/types/types/base").CancelFn;
+    constructor();
+    private setCurrentState;
+    private getRouteNames;
+    private createRouter;
+    private preprocessRoutes;
+}