@xh/hoist 71.0.0-SNAPSHOT.1733262000771 → 71.0.0-SNAPSHOT.1733266596001

package/build/types/core/persist/viewmanager/Types.d.ts

@@ -1,48 +0,0 @@
-import { PlainObject } from '@xh/hoist/core';
-/**
- * Interface for a bundle of {@link PersistableState} managed by {@link ViewManagerModel}.
- * Views are persisted to / loaded from the server as {@link JsonBlob}s.
- */
-export interface View<T extends PlainObject = PlainObject> {
-    /** Either null for private views or special token "*" for globally shared views. */
-    acl: '*' | null;
-    dateCreated: number;
-    description: string;
-    /** Calculated display group - either "Shared [entityName]" or "My [entityName]". */
-    group: string;
-    /**
-     * True if user has tagged this view as a favorite. Note that a user's list of favorite views is
-     * persisted via `ViewManagerModel.persistWith` and *not* stored in the blob itself.
-     */
-    isFavorite: boolean;
-    /** True if this view has been shared (acl == "*") and is visible to all users. */
-    isShared: boolean;
-    lastUpdated: number;
-    lastUpdatedBy: string;
-    /** User-supplied descriptive name, including folder designating prefix. */
-    name: string;
-    /** User-supplied descriptive name, without folder designating prefix. */
-    shortName: string;
-    /** Original creator of the view, and the only user with access to it if not shared. */
-    owner: string;
-    token: string;
-    /** App-defined type discriminator, as per {@link ViewManagerConfig.viewType}. */
-    type: string;
-    value: T;
-}
-/**
- * Abstract representation of ViewManager views available for selection, potentially grouped into
- * hierarchical folders. Lightweight, user-driven organization into "folders" is supported by
- * inserting a "\" in the name of any view.
- */
-export type ViewTree = {
-    text: string;
-    selected: boolean;
-} & ({
-    type: 'folder';
-    items: ViewTree[];
-} | {
-    type: 'view';
-    token: string;
-    description: string;
-});

package/build/types/core/persist/viewmanager/ViewManagerModel.d.ts

@@ -1,145 +0,0 @@
-import { HoistModel, LoadSpec, Persistable, PersistableState, PersistOptions, PlainObject, TaskObserver, Thunkable, ViewManagerProvider } from '@xh/hoist/core';
-import { SaveDialogModel } from './impl/SaveDialogModel';
-import { View, ViewTree } from './Types';
-export interface ViewManagerConfig {
-    /**
-     * True (default) to allow user to opt in to automatically saving changes to their private
-     * views - requires `persistWith`.
-     */
-    enableAutoSave?: boolean;
-    /**
-     * True (default) to allow the user to select a "Default" option that restores all persisted
-     * objects to their in-code defaults. If not enabled, at least one saved view should be created
-     * in advance, so that there is a clear initial selection for users without any private views.
-     */
-    enableDefault?: boolean;
-    /** True (default) to allow user to mark views as favorites. Requires `persistWith`. */
-    enableFavorites?: boolean;
-    /**
-     * True to allow the user to publish or edit globally shared views. Apps are expected to
-     * commonly set this based on user roles - e.g. `XH.getUser().hasRole('MANAGE_GRID_VIEWS')`.
-     */
-    enableSharing?: Thunkable<boolean>;
-    /** Used to persist the user's last selected + favorite views and autoSave preference. */
-    persistWith?: PersistOptions;
-    /**
-     * Required discriminator for the particular class of views to be loaded and managed by this
-     * model. Maps onto the `type` field of the persisted `JsonBlob`. Set to something descriptive
-     * and specific enough to be identifiable and allow for different viewManagers to be added
-     * to your app in the future - e.g. `portfolioGridView` or `tradeBlotterDashboard`.
-     */
-    viewType: string;
-    /**
-     * Optional user-facing display name for the view type, displayed in the ViewManager menu
-     * and associated management dialogs and prompts. Defaulted from `viewType` if not provided.
-     */
-    viewTypeDisplayName?: string;
-}
-/**
- *  ViewManagerModel coordinates the loading, saving, and management of user-defined bundles of
- *  {@link Persistable} component/model state.
- *
- *  - Models to be persisted are bound to this model via their `persistWith` config. One or more
- *    models can be bound to a single ViewManagerModel, allowing a single view to capture the state
- *    of multiple components - e.g. grouping and filtering options along with grid state.
- *  - Views are persisted back to the server as JsonBlob objects.
- *  - Views can be private to their owner, or optionally enabled for sharing to (all) other users.
- *  - Views can be marked as favorites for quick access.
- *  - See the desktop {@link ViewManager} component - the initial Hoist UI for this model.
- */
-export declare class ViewManagerModel<T extends PlainObject = PlainObject> extends HoistModel implements Persistable<ViewManagerModelPersistState> {
-    /**
-     * Factory to create new instances of this model and await its initial load before binding to
-     * any persistable component models. This ensures that bound models will have the expected
-     * initial persisted state applied within their constructor, before their components have
-     * rendered, and avoids thrashing of component state during initial load.
-     *
-     * To minimize the impact this async requirement has on the design and lifecycle of individual
-     * components within an app, consider eagerly constructing any viewManagerModels required within
-     * your `AppModel.initAsync` method and saving a reference to them there for component models
-     * to then use when they are mounted. The VM model instances will then be "ready to go" and
-     * usable within model constructors. (Initializing and referencing from one or more app
-     * services would be another, similar option.)
-     */
-    static createAsync(config: ViewManagerConfig): Promise<ViewManagerModel>;
-    /** Immutable configuration for this model. */
-    readonly viewType: string;
-    readonly displayName: string;
-    readonly DisplayName: string;
-    readonly enableDefault: boolean;
-    readonly enableAutoSave: boolean;
-    readonly enableFavorites: boolean;
-    /** Last selected, fully-persisted state of the active view. */
-    value: T;
-    /** Current state of the active view, can include not-yet-persisted changes. */
-    pendingValue: T;
-    /** Loaded saved view definitions - both private and shared. */
-    views: View<T>[];
-    /** Currently selected view, or null if in default mode. Token only will be set during pre-loading.*/
-    selectedToken: string;
-    selectedView: View<T>;
-    /** List of tokens for the user's favorite views. */
-    favorites: string[];
-    /**
-     * True if user has opted-in to automatically saving changes to personal views (if auto-save
-     * generally available as per `enableAutoSave`).
-     */
-    autoSave: boolean;
-    /**
-     * TaskObserver linked to {@link selectViewAsync}. If a change to the active view is likely to
-     * require intensive layout/grid work, consider masking affected components with this observer.
-     */
-    viewSelectionObserver: TaskObserver;
-    manageDialogOpen: boolean;
-    readonly saveDialogModel: SaveDialogModel;
-    private readonly _enableSharing;
-    /**
-     * @internal array of {@link ViewManagerProvider} instances bound to this model. Providers will
-     * push themselves onto this array when constructed with a reference to this model. Used to
-     * proactively push state to the target components when the model's selected `value` changes.
-     */
-    providers: ViewManagerProvider<any>[];
-    get enableSharing(): boolean;
-    get canSave(): boolean;
-    get canAutoSave(): boolean;
-    get autoSaveUnavailableReason(): string;
-    get isDirty(): boolean;
-    get isShared(): boolean;
-    get favoriteViews(): View<T>[];
-    get sharedViews(): View<T>[];
-    get privateViews(): View<T>[];
-    get sharedViewTree(): ViewTree[];
-    get privateViewTree(): ViewTree[];
-    /**
-     * Use the static {@link createAsync} factory to create an instance of this model and await its
-     * initial load before binding to persistable components.
-     */
-    private constructor();
-    doLoadAsync(loadSpec: LoadSpec): Promise<void>;
-    selectViewAsync(token: string): Promise<void>;
-    saveAsync(): Promise<void>;
-    saveAsAsync(): Promise<void>;
-    resetAsync(): Promise<void>;
-    setPendingValue(pendingValue: T): void;
-    openManageDialog(): void;
-    closeManageDialog(): void;
-    toggleFavorite(token: string): void;
-    addFavorite(token: string): void;
-    removeFavorite(token: string): void;
-    isFavorite(token: string): boolean;
-    getPersistableState(): PersistableState<ViewManagerModelPersistState>;
-    setPersistableState(state: PersistableState<ViewManagerModelPersistState>): void;
-    private selectViewInternalAsync;
-    private processRaw;
-    private setValue;
-    private cleanValue;
-    private confirmSaveForSharedViewAsync;
-    private maybeAutoSaveAsync;
-    private onFavoritesChange;
-}
-interface ViewManagerModelPersistState {
-    selectedToken?: string;
-    favorites?: string[];
-    autoSave?: boolean;
-}
-export {};

package/build/types/core/persist/viewmanager/impl/BuildViewTree.d.ts

@@ -1,8 +0,0 @@
-import { View, ViewManagerModel, ViewTree } from '@xh/hoist/core/persist/viewmanager';
-/**
- * Create a menu-friendly, tree representation of a set of views, using the `\`
- * in view names to create folders.
- *
- * @internal
- */
-export declare function buildViewTree(views: View[], model: ViewManagerModel): ViewTree[];

package/build/types/core/persist/viewmanager/impl/ManageDialogModel.d.ts

@@ -1,30 +0,0 @@
-import { FormModel } from '@xh/hoist/cmp/form';
-import { GridModel } from '@xh/hoist/cmp/grid';
-import { HoistModel, TaskObserver } from '@xh/hoist/core';
-export declare class ManageDialogModel extends HoistModel {
-    private viewManagerModel;
-    gridModel: GridModel;
-    formModel: FormModel;
-    readonly saveTask: TaskObserver;
-    readonly deleteTask: TaskObserver;
-    get selectedId(): string;
-    get selectedIds(): string[];
-    get hasMultiSelection(): boolean;
-    get selIsShared(): boolean;
-    get canDelete(): boolean;
-    get canEdit(): boolean;
-    get enableSharing(): boolean;
-    get showSaveButton(): boolean;
-    get displayName(): string;
-    get enableFavorites(): boolean;
-    constructor();
-    onLinked(): void;
-    doLoadAsync(): Promise<void>;
-    saveAsync(): Promise<void>;
-    deleteAsync(): Promise<void>;
-    private doSaveAsync;
-    private doDeleteAsync;
-    private ensureGridHasSelection;
-    private createGridModel;
-    private createFormModel;
-}

package/build/types/core/persist/viewmanager/impl/SaveDialogModel.d.ts

@@ -1,23 +0,0 @@
-import { FormModel } from '@xh/hoist/cmp/form';
-import { HoistModel, TaskObserver } from '@xh/hoist/core';
-import { ViewManagerModel } from '@xh/hoist/core/persist/viewmanager';
-import { JsonBlob } from '@xh/hoist/svc';
-import { View } from '../Types';
-export declare class SaveDialogModel extends HoistModel {
-    private readonly viewManagerModel;
-    readonly formModel: FormModel;
-    readonly saveTask: TaskObserver;
-    viewStub: Partial<View>;
-    isOpen: boolean;
-    private resolveOpen;
-    private invalidNames;
-    get type(): string;
-    get DisplayName(): string;
-    constructor(viewManagerModel: ViewManagerModel);
-    openAsync(viewStub: Partial<View>, invalidNames: string[]): Promise<JsonBlob>;
-    cancel(): void;
-    saveAsAsync(): Promise<void>;
-    private createFormModel;
-    private doSaveAsAsync;
-    private close;
-}

package/build/types/core/persist/viewmanager/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ViewManagerModel';
-export * from './Types';

package/build/types/desktop/cmp/viewmanager/impl/ManageDialog.d.ts

@@ -1,6 +0,0 @@
-import { HoistProps } from '@xh/hoist/core';
-import { ManageDialogModel } from '@xh/hoist/core/persist/viewmanager/impl/ManageDialogModel';
-export interface ManageDialogProps extends HoistProps<ManageDialogModel> {
-    onClose: () => void;
-}
-export declare const manageDialog: import("@xh/hoist/core").ElementFactory<ManageDialogProps>;

package/build/types/desktop/cmp/viewmanager/impl/SaveDialog.d.ts

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

package/build/types/svc/LocalStorageService.d.ts

@@ -1,24 +0,0 @@
-import { HoistService } from '@xh/hoist/core';
-/**
- * Service to provide simple key/value access to browser local storage, appropriately namespaced
- * by application code and username.
- *
- * In the unexpected case that local storage is not available, will provide a transient in-memory
- * storage to support its operations and API.
- *
- * Relied upon by Hoist features such as local preference values and grid state.
- */
-export declare class LocalStorageService extends HoistService {
-    static instance: LocalStorageService;
-    constructor();
-    get(key: string, defaultValue?: any): any;
-    set(key: string, value: any): void;
-    apply(key: string, newProps: object): void;
-    remove(key: string): void;
-    removeIf(predicateFn: (s: string) => boolean): void;
-    clear(): void;
-    keys(): string[];
-    get isFake(): boolean;
-    private getInstance;
-    private getNamespace;
-}

package/core/persist/viewmanager/Types.ts

@@ -1,53 +0,0 @@
-import {PlainObject} from '@xh/hoist/core';
-
-/**
- * Interface for a bundle of {@link PersistableState} managed by {@link ViewManagerModel}.
- * Views are persisted to / loaded from the server as {@link JsonBlob}s.
- */
-export interface View<T extends PlainObject = PlainObject> {
-    /** Either null for private views or special token "*" for globally shared views. */
-    acl: '*' | null;
-    dateCreated: number;
-    description: string;
-    /** Calculated display group - either "Shared [entityName]" or "My [entityName]". */
-    group: string;
-    /**
-     * True if user has tagged this view as a favorite. Note that a user's list of favorite views is
-     * persisted via `ViewManagerModel.persistWith` and *not* stored in the blob itself.
-     */
-    isFavorite: boolean;
-    /** True if this view has been shared (acl == "*") and is visible to all users. */
-    isShared: boolean;
-    lastUpdated: number;
-    lastUpdatedBy: string;
-    /** User-supplied descriptive name, including folder designating prefix. */
-    name: string;
-    /** User-supplied descriptive name, without folder designating prefix. */
-    shortName: string;
-    /** Original creator of the view, and the only user with access to it if not shared. */
-    owner: string;
-    token: string;
-    /** App-defined type discriminator, as per {@link ViewManagerConfig.viewType}. */
-    type: string;
-    value: T;
-}
-
-/**
- * Abstract representation of ViewManager views available for selection, potentially grouped into
- * hierarchical folders. Lightweight, user-driven organization into "folders" is supported by
- * inserting a "\" in the name of any view.
- */
-export type ViewTree = {
-    text: string;
-    selected: boolean;
-} & (
-    | {
-          type: 'folder';
-          items: ViewTree[];
-      }
-    | {
-          type: 'view';
-          token: string;
-          description: string;
-      }
-);