@xh/hoist 74.0.0-SNAPSHOT.1747924226267 → 74.0.0-SNAPSHOT.1748001673599

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

@@ -17,6 +17,11 @@ export declare class View<T extends PlainObject = PlainObject> {
      * state of the components is captured.
      */
     readonly value: Partial<T>;
+    /**
+     * Defaulted to value, but may be updated during ViewManagerModel's settleTime to be
+     * the "settled" state after loading. Used for comparison to determine dirtiness.
+     */
+    settledValue: Partial<T>;
     private readonly model;
     get name(): string;
     get group(): string;

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;

package/build/types/data/RecordAction.d.ts

@@ -55,7 +55,7 @@ export interface ActionFnData {
 }
 /**
  * A RecordAction encapsulates a shared set of configuration for items within components such as
- * a Grid Context Menu nd RecordActionBar (aka grid context menus and action columns).
+ * a Grid Context Menu and RecordActionBar (aka grid context menus and action columns).
  *
  * Components passed these actions will render them with an appropriate UI (e.g. menu item, button)
  * and call their `actionFn` when clicked, passing it a data object (if available) sourced from the

package/cmp/viewmanager/View.ts

@@ -27,6 +27,12 @@ export class View<T extends PlainObject = PlainObject> {
      */
     readonly value: Partial<T> = null;
 
+    /**
+     * Defaulted to value, but may be updated during ViewManagerModel's settleTime to be
+     * the "settled" state after loading. Used for comparison to determine dirtiness.
+     */
+    settledValue: Partial<T> = null;
+
     private readonly model: ViewManagerModel;
 
     get name(): string {
@@ -92,6 +98,7 @@ export class View<T extends PlainObject = PlainObject> {
     constructor(info: ViewInfo, value: Partial<T>, model: ViewManagerModel) {
         this.info = info;
         this.value = value;
+        this.settledValue = value;
         this.model = model;
     }
 }

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;
 
@@ -421,13 +430,15 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
 
     @action
     setValue(value: Partial<T>) {
+        value = this.cleanState(value);
+
         const {view, pendingValue, lastPushed, settleTime} = this;
         if (!pendingValue && settleTime && !olderThan(lastPushed, settleTime)) {
-            return;
+            this.view.settledValue = value;
         }
 
-        value = this.cleanState(value);
-        if (!isEqual(value, view.value)) {
+        // Todo: Consider how this interacts with the localStorage pending state
+        if (!isEqual(value, view.settledValue)) {
             this.pendingValue = {
                 token: pendingValue ? pendingValue.token : view.token,
                 baseUpdated: pendingValue ? pendingValue.baseUpdated : view.lastUpdated,
@@ -515,7 +526,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.
@@ -546,7 +559,10 @@ export class ViewManagerModel<T = PlainObject> extends HoistModel {
     private pendingValueReaction(): ReactionSpec {
         return {
             track: () => this.pendingValue,
-            run: v => XH.sessionStorageService.set(this.pendingValueStorageKey, v)
+            run: v => {
+                if (!this.preserveUnsavedChanges) return;
+                XH.sessionStorageService.set(this.pendingValueStorageKey, v);
+            }
         };
     }
 

package/data/RecordAction.ts

@@ -83,7 +83,7 @@ export interface ActionFnData {
 
 /**
  * A RecordAction encapsulates a shared set of configuration for items within components such as
- * a Grid Context Menu nd RecordActionBar (aka grid context menus and action columns).
+ * a Grid Context Menu and RecordActionBar (aka grid context menus and action columns).
  *
  * Components passed these actions will render them with an appropriate UI (e.g. menu item, button)
  * and call their `actionFn` when clicked, passing it a data object (if available) sourced from the

package/package.json

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