@xh/hoist 74.0.0-SNAPSHOT.1748340686867 → 74.0.0-SNAPSHOT.1748449301934

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## 74.0.0-SNAPSHOT - unreleased
 
+### 🎁 New Features
++ Add `ViewManagerModel.preserveUnsavedChanges` flag to opt-out of that behaviour.
+
+### 🐞 Bug Fixes
++ Improves `ViewManagerModel.settleTime` by comparing to when the view is pushed to components
+  rather than when view is loaded from the server.
+
 ## v73.0.1 - 2025-05-19
 
 ### 🐞 Bug Fixes

package/build/types/cmp/viewmanager/ViewManagerModel.d.ts

@@ -43,6 +43,11 @@ export interface ViewManagerConfig {
      * True (default) to allow users to share their views with other users.
      */
     enableSharing?: boolean;
+    /**
+     * True (default) to save pending state to SessionStorage so that it can be restored across
+     * browser refreshes. Unlike auto-save, this does not write to the database.
+     */
+    preserveUnsavedChanges?: boolean;
     /**
      * Function to determine the initial view for a user, when no view has already been persisted.
      * Will be passed a list of views available to the current user.  Implementations where
@@ -132,6 +137,7 @@ export declare class ViewManagerModel<T = PlainObject> extends HoistModel {
     readonly enableDefault: boolean;
     readonly enableGlobal: boolean;
     readonly enableSharing: boolean;
+    readonly preserveUnsavedChanges: boolean;
     readonly manageGlobal: boolean;
     readonly settleTime: number;
     readonly initialViewSpec: (views: ViewInfo[]) => ViewInfo;
@@ -198,6 +204,7 @@ export declare class ViewManagerModel<T = PlainObject> extends HoistModel {
     resetAsync(): Promise<void>;
     getValue(): Partial<T>;
     setValue(value: Partial<T>): void;
+    noteStatePushed(): void;
     userPin(view: ViewInfo): void;
     userUnpin(view: ViewInfo): void;
     isUserPinned(view: ViewInfo): boolean | null;

package/build/types/core/persist/provider/ViewManagerProvider.d.ts

@@ -1,10 +1,12 @@
+import { Persistable } from '@xh/hoist/core';
 import { PersistenceProvider, PersistenceProviderConfig } from '../PersistenceProvider';
 import type { ViewManagerModel } from '@xh/hoist/cmp/viewmanager/ViewManagerModel';
 export declare class ViewManagerProvider<S> extends PersistenceProvider<S> {
     readonly viewManagerModel: ViewManagerModel;
     constructor(cfg: PersistenceProviderConfig<S>);
     pushStateToTarget(): void;
-    readRaw(): Partial<import("../..").PlainObject>;
+    bindToTarget(target: Persistable<S>): void;
+    readRaw(): Partial<import("@xh/hoist/core").PlainObject>;
     writeRaw(data: Record<typeof this.path, S>): void;
     destroy(): void;
 }

package/cmp/viewmanager/ViewManagerModel.ts

@@ -74,6 +74,12 @@ export interface ViewManagerConfig {
      */
     enableSharing?: boolean;
 
+    /**
+     * True (default) to save pending state to SessionStorage so that it can be restored across
+     * browser refreshes. Unlike auto-save, this does not write to the database.
+     */
+    preserveUnsavedChanges?: boolean;
+
     /**
      * Function to determine the initial view for a user, when no view has already been persisted.
      * Will be passed a list of views available to the current user.  Implementations where
@@ -176,6 +182,7 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
     readonly enableDefault: boolean;
     readonly enableGlobal: boolean;
     readonly enableSharing: boolean;
+    readonly preserveUnsavedChanges: boolean;
     readonly manageGlobal: boolean;
     readonly settleTime: number;
     readonly initialViewSpec: (views: ViewInfo[]) => ViewInfo;
@@ -296,6 +303,7 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
         enableDefault = true,
         enableGlobal = true,
         enableSharing = true,
+        preserveUnsavedChanges = true,
         settleTime = 1000,
         initialViewSpec = null
     }: ViewManagerConfig) {
@@ -317,6 +325,7 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
         this.enableGlobal = enableGlobal;
         this.enableSharing = enableSharing;
         this.enableAutoSave = enableAutoSave;
+        this.preserveUnsavedChanges = preserveUnsavedChanges;
         this.settleTime = settleTime;
         this.initialViewSpec = initialViewSpec;
 
@@ -438,6 +447,10 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
         }
     }
 
+    noteStatePushed() {
+        this.lastPushed = Date.now();
+    }
+
     //------------------
     // Pinning
     //------------------
@@ -515,7 +528,9 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
                 this.views = views;
                 this.userPinned = state.userPinned;
                 this.autoSave = state.autoSave;
-                this.pendingValue = XH.sessionStorageService.get(pendingValueStorageKey);
+                if (this.preserveUnsavedChanges) {
+                    this.pendingValue = XH.sessionStorageService.get(pendingValueStorageKey);
+                }
             });
 
             // 2) Initialize/choose initial view.  Null is ok, and will yield default.
@@ -537,7 +552,7 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
         }
 
         this.addReaction(
-            this.pendingValueReaction(),
+            this.preserveUnsavedChanges ? this.pendingValueReaction() : null,
             this.autoSaveReaction(),
             ...this.stateReactions(initialState)
         );
@@ -588,7 +603,6 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
             .thenAction(latest => {
                 this.setAsView(latest, pendingValue?.token == token ? pendingValue : null);
                 this.providers.forEach(it => it.pushStateToTarget());
-                this.lastPushed = Date.now();
             })
             .linkTo(this.selectTask);
     }

package/core/persist/provider/ViewManagerProvider.ts

@@ -5,6 +5,7 @@
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
 
+import {Persistable} from '@xh/hoist/core';
 import {throwIf} from '@xh/hoist/utils/js';
 import {pull} from 'lodash';
 import {PersistenceProvider, PersistenceProviderConfig} from '../PersistenceProvider';
@@ -24,11 +25,17 @@ export class ViewManagerProvider<S> extends PersistenceProvider<S> {
     pushStateToTarget() {
         const state = this.read();
         this.target.setPersistableState(state ? state : this.defaultState);
+        this.viewManagerModel.noteStatePushed();
     }
 
     //----------------
     // Implementation
     //----------------
+    override bindToTarget(target: Persistable<S>) {
+        super.bindToTarget(target);
+        this.viewManagerModel.noteStatePushed();
+    }
+
     override readRaw() {
         return this.viewManagerModel.getValue();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "74.0.0-SNAPSHOT.1748340686867",
+  "version": "74.0.0-SNAPSHOT.1748449301934",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",