@xh/hoist 76.0.0-SNAPSHOT.1755780982882 → 76.0.0-SNAPSHOT.1756219543970

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -73,7 +73,7 @@
73
73
  * WebSockets are now enabled by default for client apps, as they have been on the server since Hoist
74
74
  Core v20.2. Maintaining a WebSocket connection back to the Hoist server enables useful Admin
75
75
  Console functionality and is recommended, but clients that must disable WebSockets can do so via
76
- `AppSpec.disableWebSockets`. Note `AppSpec.enableWebSockets` is deprecated and can be removed.
76
+ `AppSpec.disableWebSockets`. Note `AppSpec.webSocketsEnabled` is deprecated and can be removed.
77
77
  * Hoist now sets a reference to an app's singleton `AuthModel` on a static `instance` property of
78
78
  the app-specified class. App developers can declare a typed static `instance` property on their
79
79
  model class and use it to access the singleton with its proper type, vs. `XH.authModel`.
@@ -51,15 +51,16 @@ export declare class HoistAppModel extends HoistModel {
51
51
  /**
52
52
  * Resets user preferences and any persistent local application state.
53
53
  *
54
- * The default implementation for this method will clear all preferences, local storage, and
55
- * transient view state such as current, and pinned views. Views themselves are preserved.
54
+ * The default implementation for this method will clear all preferences, local + session
55
+ * storage, and transient {@link ViewManager} state such as last-selected and pinned views.
56
+ * (Views themselves are preserved.)
56
57
  *
57
58
  * Applications may wish to override this method to perform a more targeted clearing of state.
58
- * This is important for complex applications with smaller sub-applications, and/or device
59
+ * This is important for complex applications with smaller sub-applications and/or device
59
60
  * specific applications. These applications will typically want to perform a custom clearing
60
- * that is more targeted, and includes any additional app-specific state.
61
+ * that is more targeted and/or clears additional app-specific state.
61
62
  *
62
- * Not typically called directly by applications. Call XH.restoreDefaultsAsync() instead.
63
+ * Not typically called directly by apps - call {@link XHApi.restoreDefaultsAsync} instead.
63
64
  */
64
65
  restoreDefaultsAsync(): Promise<void>;
65
66
  }
@@ -397,7 +397,6 @@ export declare class XHApi {
397
397
  getStores(): Store[];
398
398
  /**
399
399
  * Reset user state and then reload the app.
400
- *
401
400
  * @see HoistAppModel.restoreDefaultsAsync()
402
401
  */
403
402
  restoreDefaultsAsync(): Promise<void>;
@@ -88,15 +88,16 @@ export class HoistAppModel extends HoistModel {
88
88
  /**
89
89
  * Resets user preferences and any persistent local application state.
90
90
  *
91
- * The default implementation for this method will clear all preferences, local storage, and
92
- * transient view state such as current, and pinned views. Views themselves are preserved.
91
+ * The default implementation for this method will clear all preferences, local + session
92
+ * storage, and transient {@link ViewManager} state such as last-selected and pinned views.
93
+ * (Views themselves are preserved.)
93
94
  *
94
95
  * Applications may wish to override this method to perform a more targeted clearing of state.
95
- * This is important for complex applications with smaller sub-applications, and/or device
96
+ * This is important for complex applications with smaller sub-applications and/or device
96
97
  * specific applications. These applications will typically want to perform a custom clearing
97
- * that is more targeted, and includes any additional app-specific state.
98
+ * that is more targeted and/or clears additional app-specific state.
98
99
  *
99
- * Not typically called directly by applications. Call XH.restoreDefaultsAsync() instead.
100
+ * Not typically called directly by apps - call {@link XHApi.restoreDefaultsAsync} instead.
100
101
  */
101
102
  async restoreDefaultsAsync() {
102
103
  const XH = window['XH'];
package/core/XH.ts CHANGED
@@ -773,13 +773,12 @@ export class XHApi {
773
773
 
774
774
  /**
775
775
  * Reset user state and then reload the app.
776
- *
777
776
  * @see HoistAppModel.restoreDefaultsAsync()
778
777
  */
779
778
  async restoreDefaultsAsync() {
780
779
  try {
781
780
  await this.appModel.restoreDefaultsAsync();
782
- XH.trackService.track({category: 'App', message: 'Restored app defaults'});
781
+ XH.track({category: 'App', message: 'Restored app defaults'});
783
782
  this.reloadApp();
784
783
  } catch (e) {
785
784
  XH.handleException(e, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xh/hoist",
3
- "version": "76.0.0-SNAPSHOT.1755780982882",
3
+ "version": "76.0.0-SNAPSHOT.1756219543970",
4
4
  "description": "Hoist add-on for building and deploying React Applications.",
5
5
  "repository": "github:xh/hoist-react",
6
6
  "homepage": "https://xh.io",