@xh/hoist 76.0.0-SNAPSHOT.1755706915375 → 76.0.0-SNAPSHOT.1755807786142

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 76.0.0-SNAPSHOT - unreleased
 
+### 💥 Breaking Changes (upgrade difficulty: 🟢 LOW - requires hoist-core v31.2)
+
 ### 🎁 New Features
 
 * Added new `extraConfirmText`, `extraConfirmLabel` properties to `MessageOptions`. Use this option
@@ -15,6 +17,9 @@
 * Handled an edge-case `ViewManager` bug where `enableDefault` changed to `false` after some user
   state had already been persisted w/users pointed at in-code default view. The manager now calls
   its configured `initialViewSpec` function as expected in this case.
+  
+* `XH.restoreDefaultsAsync` will now clear basic view state.  Views themselves will be preserved.
+  Requires hoist-core v31.2
 
 ### ⚙️ Technical
 

package/build/types/core/HoistAppModel.d.ts

@@ -51,12 +51,16 @@ export declare class HoistAppModel extends HoistModel {
     /**
      * Resets user preferences and any persistent local application state.
      *
-     * The default implementation for this method will clear *all* preferences and local storage.
+     * The default implementation for this method will clear all preferences, local + session
+     * storage, and transient {@link ViewManager} state such as last-selected and pinned views.
+     * (Views themselves are preserved.)
      *
-     * Applications may wish to override this method to do a more targeted clearing of state.
-     * This is important for complex applications with smaller sub-applications, and/or device
+     * Applications may wish to override this method to perform a more targeted clearing of state.
+     * This is important for complex applications with smaller sub-applications and/or device
      * specific applications. These applications will typically want to perform a custom clearing
-     * that is more targeted, and includes any additional app-specific state.
+     * that is more targeted and/or clears additional app-specific state.
+     *
+     * Not typically called directly by apps - call {@link XHApi.restoreDefaultsAsync} instead.
      */
     restoreDefaultsAsync(): Promise<void>;
 }

package/build/types/core/XH.d.ts

@@ -11,7 +11,7 @@ import { ToastModel } from '../appcontainer/ToastModel';
 import '../styles/XH.scss';
 import { AppSpec, AppState, AppSuspendData, BannerSpec, ExceptionHandler, ExceptionHandlerOptions, HoistAppModel, HoistException, HoistService, HoistServiceClass, HoistUser, MessageSpec, PageState, PlainObject, ReloadAppOptions, SizingMode, TaskObserver, Theme, ToastSpec, TrackOptions } from './';
 import { HoistModel, ModelSelector, RefreshContextModel } from './model';
-export declare const MIN_HOIST_CORE_VERSION = "30.1";
+export declare const MIN_HOIST_CORE_VERSION = "31.2";
 /**
  * Top-level Singleton model for Hoist. This is the main entry point for the API.
  *
@@ -396,7 +396,8 @@ export declare class XHApi {
     /** All Stores registered with this application. */
     getStores(): Store[];
     /**
-     * Reset user preferences and any persistent local application state, then reload the app.
+     * Reset user state and then reload the app.
+     * @see HoistAppModel.restoreDefaultsAsync()
      */
     restoreDefaultsAsync(): Promise<void>;
     /**

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

@@ -56,11 +56,6 @@ export declare class PrefService extends HoistService {
      * before making another call that relies on its updated value being read on the server.
      */
     pushAsync(key: string, value: any): Promise<void>;
-    /**
-     * Reset *all* preferences, reverting their effective values back to defaults.
-     * @returns a Promise that resolves when preferences have been cleared and defaults reloaded.
-     */
-    clearAllAsync(): Promise<void>;
     /**
      * Push any pending buffered updates to persist newly set values to server.
      * Called automatically by this app on page unload to avoid dropping changes when e.g. a user

package/core/HoistAppModel.ts

@@ -88,16 +88,23 @@ export class HoistAppModel extends HoistModel {
     /**
      * Resets user preferences and any persistent local application state.
      *
-     * The default implementation for this method will clear *all* preferences and local storage.
+     * The default implementation for this method will clear all preferences, local + session
+     * storage, and transient {@link ViewManager} state such as last-selected and pinned views.
+     * (Views themselves are preserved.)
      *
-     * Applications may wish to override this method to do a more targeted clearing of state.
-     * This is important for complex applications with smaller sub-applications, and/or device
+     * Applications may wish to override this method to perform a more targeted clearing of state.
+     * This is important for complex applications with smaller sub-applications and/or device
      * specific applications. These applications will typically want to perform a custom clearing
-     * that is more targeted, and includes any additional app-specific state.
+     * that is more targeted and/or clears additional app-specific state.
+     *
+     * Not typically called directly by apps - call {@link XHApi.restoreDefaultsAsync} instead.
      */
     async restoreDefaultsAsync() {
         const XH = window['XH'];
-        await XH.prefService.clearAllAsync();
+        await XH.fetchJson({
+            url: 'xh/clearUserState',
+            params: {clientUsername: XH.getUsername()}
+        });
         XH.localStorageService.clear();
         XH.sessionStorageService.clear();
     }

package/core/XH.ts

@@ -67,7 +67,7 @@ import {instanceManager} from './impl/InstanceManager';
 import {HoistModel, ModelSelector, RefreshContextModel} from './model';
 import ShortUniqueId from 'short-unique-id';
 
-export const MIN_HOIST_CORE_VERSION = '30.1';
+export const MIN_HOIST_CORE_VERSION = '31.2';
 
 declare const xhAppCode: string;
 declare const xhAppName: string;
@@ -772,11 +772,20 @@ export class XHApi {
     }
 
     /**
-     * Reset user preferences and any persistent local application state, then reload the app.
+     * Reset user state and then reload the app.
+     * @see HoistAppModel.restoreDefaultsAsync()
      */
     async restoreDefaultsAsync() {
-        await this.appModel.restoreDefaultsAsync();
-        this.reloadApp();
+        try {
+            await this.appModel.restoreDefaultsAsync();
+            XH.track({category: 'App', message: 'Restored app defaults'});
+            this.reloadApp();
+        } catch (e) {
+            XH.handleException(e, {
+                message: 'Failed to restore app defaults',
+                requireReload: true
+            });
+        }
     }
 
     /**

package/package.json

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

package/svc/PrefService.ts

@@ -110,18 +110,6 @@ export class PrefService extends HoistService {
         return this.pushPendingAsync();
     }
 
-    /**
-     * Reset *all* preferences, reverting their effective values back to defaults.
-     * @returns a Promise that resolves when preferences have been cleared and defaults reloaded.
-     */
-    async clearAllAsync() {
-        await XH.fetchJson({
-            url: 'xh/clearPrefs',
-            params: {clientUsername: XH.getUsername()}
-        });
-        return this.loadPrefsAsync();
-    }
-
     /**
      * Push any pending buffered updates to persist newly set values to server.
      * Called automatically by this app on page unload to avoid dropping changes when e.g. a user