@xh/hoist 71.0.0-SNAPSHOT.1731709792477 → 71.0.0-SNAPSHOT.1732369566945

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## v71.0.0-SNAPSHOT - unreleased
 
+
+### ⚙️ Technical
+* Misc. Improvements to ViewManager
+
+
 ## v70.0.0 - 2024-11-15
 
 ### 💥 Breaking Changes (upgrade difficulty: 🟢 LOW - changes to advanced persistence APIs)

package/admin/tabs/cluster/ClusterTabModel.ts

@@ -32,6 +32,10 @@ export class ClusterTabModel extends HoistModel {
 
     @lookup(TabModel) private tabModel: TabModel;
 
+    @managed readonly gridModel: GridModel = this.createGridModel();
+    @managed readonly tabContainerModel: TabContainerModel = this.createTabContainerModel();
+    @managed readonly timer: Timer;
+
     shutdownAction: RecordActionSpec = {
         icon: Icon.skull(),
         text: 'Shutdown Instance',
@@ -41,10 +45,6 @@ export class ClusterTabModel extends HoistModel {
         recordsRequired: 1
     };
 
-    @managed readonly gridModel: GridModel = this.createGridModel();
-    @managed readonly tabContainerModel: TabContainerModel = this.createTabContainerModel();
-    @managed readonly timer: Timer;
-
     get instance(): PlainObject {
         return this.gridModel.selectedRecord?.data;
     }
@@ -59,7 +59,16 @@ export class ClusterTabModel extends HoistModel {
 
     override async doLoadAsync(loadSpec: LoadSpec) {
         const {gridModel} = this;
-        let data = await XH.fetchJson({url: 'clusterAdmin/allInstances', loadSpec});
+
+        let data = await XH.fetchJson({
+            url: 'clusterAdmin/allInstances',
+            // Tighter default timeout for background auto-refresh, to ensure we report connectivity
+            // issues promptly. This call should be quick, but still allow full default timeout for
+            // a manual refresh.
+            timeout: loadSpec.isAutoRefresh ? this.autoRefreshTimeout : undefined,
+            loadSpec
+        });
+
         data = data.map(row => ({
             ...row,
             isLocal: row.name == XH.environmentService.serverInstance,
@@ -78,7 +87,7 @@ export class ClusterTabModel extends HoistModel {
             runFn: () => {
                 if (this.tabModel?.isActive) this.autoRefreshAsync();
             },
-            interval: 5 * SECONDS,
+            interval: this.autoRefreshInterval,
             delay: true
         });
 
@@ -96,6 +105,16 @@ export class ClusterTabModel extends HoistModel {
         );
     }
 
+    formatInstance(instance: PlainObject): ReactNode {
+        const content = [instance.name];
+        if (instance.isPrimary) content.push(badge({item: 'primary', intent: 'primary'}));
+        if (instance.isLocal) content.push(badge('local'));
+        return hbox(content);
+    }
+
+    //------------------
+    // Implementation
+    //------------------
     private createGridModel() {
         return new GridModel({
             store: {
@@ -161,7 +180,7 @@ export class ClusterTabModel extends HoistModel {
         });
     }
 
-    createTabContainerModel() {
+    private createTabContainerModel() {
         return new TabContainerModel({
             route: 'default.cluster',
             switcher: false,
@@ -187,14 +206,7 @@ export class ClusterTabModel extends HoistModel {
         });
     }
 
-    formatInstance(instance: PlainObject): ReactNode {
-        const content = [instance.name];
-        if (instance.isPrimary) content.push(badge({item: 'primary', intent: 'primary'}));
-        if (instance.isLocal) content.push(badge('local'));
-        return hbox(content);
-    }
-
-    async shutdownInstanceAsync(instance: PlainObject) {
+    private async shutdownInstanceAsync(instance: PlainObject) {
         if (
             !(await XH.confirm({
                 message: `Are you SURE you want to shutdown instance ${instance.name}?`,
@@ -216,4 +228,12 @@ export class ClusterTabModel extends HoistModel {
             .linkTo({observer: this.loadModel, message: 'Attempting instance shutdown'})
             .catchDefault();
     }
+
+    private get autoRefreshInterval(): number {
+        return XH.getConf('xhAdminAppConfig', {}).clusterTabAutoRefreshInterval ?? 4 * SECONDS;
+    }
+
+    private get autoRefreshTimeout(): number {
+        return XH.getConf('xhAdminAppConfig', {}).clusterTabAutoRefreshTimeout ?? 2 * SECONDS;
+    }
 }

package/build/types/admin/tabs/cluster/ClusterTabModel.d.ts

@@ -9,17 +9,19 @@ export declare class ClusterTabModel extends HoistModel {
         localStorageKey: string;
     };
     private tabModel;
-    shutdownAction: RecordActionSpec;
     readonly gridModel: GridModel;
     readonly tabContainerModel: TabContainerModel;
     readonly timer: Timer;
+    shutdownAction: RecordActionSpec;
     get instance(): PlainObject;
     get instanceName(): string;
     get isMultiInstance(): boolean;
     doLoadAsync(loadSpec: LoadSpec): Promise<void>;
     constructor();
-    private createGridModel;
-    createTabContainerModel(): TabContainerModel;
     formatInstance(instance: PlainObject): ReactNode;
-    shutdownInstanceAsync(instance: PlainObject): Promise<void>;
+    private createGridModel;
+    private createTabContainerModel;
+    private shutdownInstanceAsync;
+    private get autoRefreshInterval();
+    private get autoRefreshTimeout();
 }

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

@@ -19,8 +19,10 @@ export interface View<T extends PlainObject = PlainObject> {
     isShared: boolean;
     lastUpdated: number;
     lastUpdatedBy: string;
-    /** User-supplied descriptive name. */
+    /** 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;

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

@@ -75,15 +75,16 @@ export declare class ViewManagerModel<T extends PlainObject = PlainObject> exten
     pendingValue: T;
     /** Loaded saved view definitions - both private and shared. */
     views: View<T>[];
-    /** Token identifier for the currently selected view, or null if in default mode. */
+    /** 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`).
      */
-    autoSaveActive: boolean;
+    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.
@@ -99,17 +100,9 @@ export declare class ViewManagerModel<T extends PlainObject = PlainObject> exten
      */
     providers: ViewManagerProvider<any>[];
     get enableSharing(): boolean;
-    get selectedView(): View<T>;
-    get isSharedViewSelected(): boolean;
     get canSave(): boolean;
-    /**
-     * True if displaying the save button is appropriate from the model's point of view, even if
-     * that button might be disabled due to no changes having been made. Works in concert with the
-     * desktop ViewManager component's `showSaveButton` prop.
-     */
-    get canShowSaveButton(): boolean;
-    get enableAutoSaveToggle(): boolean;
-    get disabledAutoSaveReason(): string;
+    get canAutoSave(): boolean;
+    get autoSaveUnavailableReason(): string;
     get isDirty(): boolean;
     get isShared(): boolean;
     get favoriteViews(): View<T>[];
@@ -124,31 +117,29 @@ export declare class ViewManagerModel<T extends PlainObject = PlainObject> exten
     private constructor();
     doLoadAsync(loadSpec: LoadSpec): Promise<void>;
     selectViewAsync(token: string): Promise<void>;
-    saveAsync(skipToast?: boolean): Promise<void>;
+    saveAsync(): Promise<void>;
     saveAsAsync(): Promise<void>;
     resetAsync(): Promise<void>;
     setPendingValue(pendingValue: T): void;
     openManageDialog(): void;
     closeManageDialog(): void;
-    getHierarchyDisplayName(name: string): string;
     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 buildViewTree;
-    private getNameHierarchySubstring;
-    private isFolderForEntry;
     private onFavoritesChange;
 }
 interface ViewManagerModelPersistState {
-    selectedToken: string;
-    favorites: string[];
+    selectedToken?: string;
+    favorites?: string[];
+    autoSave?: boolean;
 }
 export {};

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

@@ -0,0 +1,8 @@
+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/desktop/cmp/dash/container/DashContainerModel.d.ts

@@ -104,10 +104,7 @@ export declare class DashContainerModel extends DashModel<DashContainerViewSpec,
      * This method will clear the persistent state saved for this component, if any.
      */
     restoreDefaultsAsync(): Promise<void>;
-    /**
-     * Load state into the DashContainer, recreating its layout and contents
-     * @param state - State to load
-     */
+    /** Load state into the DashContainer, recreating its layout and contents */
     loadStateAsync(state: DashViewState[]): Promise<void>;
     /**
      * Add a view to the container.

package/build/types/desktop/cmp/viewmanager/ViewManager.d.ts

@@ -3,11 +3,25 @@ import { HoistProps } from '@xh/hoist/core';
 import './ViewManager.scss';
 import { ViewManagerModel } from '@xh/hoist/core/persist/viewmanager/ViewManagerModel';
 import { ButtonProps } from '@xh/hoist/desktop/cmp/button';
+/**
+ * Visibility options for save/revert button.
+ *
+ * 'never' to hide button.
+ * 'whenDirty' to only show when persistence state is dirty and button is therefore enabled.
+ * 'always' will always show button, unless autoSave is active.
+ *
+ *  Note that we never show the button when 'autoSave' is active because it would never be enabled
+ *  for more than a flash.
+ */
+export type ViewManagerStateButtonMode = 'whenDirty' | 'always' | 'never';
 export interface ViewManagerProps extends HoistProps<ViewManagerModel> {
     menuButtonProps?: Partial<ButtonProps>;
     saveButtonProps?: Partial<ButtonProps>;
-    /** 'whenDirty' to only show saveButton when persistence state is dirty. (Default 'whenDirty') */
-    showSaveButton?: 'whenDirty' | 'always' | 'never';
+    revertButtonProps?: Partial<ButtonProps>;
+    /** Default 'whenDirty' */
+    showSaveButton?: ViewManagerStateButtonMode;
+    /** Default 'never' */
+    showRevertButton?: ViewManagerStateButtonMode;
     /** True to render private views in sub-menu (Default false)*/
     showPrivateViewsInSubMenu?: boolean;
     /** True to render shared views in sub-menu (Default false)*/

package/build/types/desktop/cmp/viewmanager/index.d.ts

@@ -1,3 +1 @@
 export * from './ViewManager';
-export * from './cmp/ManageDialog';
-export * from './cmp/SaveDialog';

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

@@ -42,11 +42,11 @@ export declare class JsonBlobService extends HoistService {
     /** Retrieve a single JSONBlob by its unique token. */
     getAsync(token: string): Promise<JsonBlob>;
     /** Retrieve all blobs of a particular type that are visible to the current user. */
-    listAsync({ type, includeValue, loadSpec }: {
+    listAsync(spec: {
         type: string;
         includeValue?: boolean;
         loadSpec?: LoadSpec;
-    }): Promise<any>;
+    }): Promise<JsonBlob[]>;
     /** Persist a new JSONBlob back to the server. */
     createAsync({ acl, description, type, meta, name, value }: Partial<JsonBlob>): Promise<JsonBlob>;
     /** Modify mutable properties of an existing JSONBlob, as identified by its unique token. */

package/core/persist/viewmanager/Types.ts

@@ -20,8 +20,10 @@ export interface View<T extends PlainObject = PlainObject> {
     isShared: boolean;
     lastUpdated: number;
     lastUpdatedBy: string;
-    /** User-supplied descriptive name. */
+    /** 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;