@xh/hoist 73.0.0-SNAPSHOT.1741790055811 → 73.0.0-SNAPSHOT.1741793208717

package/CHANGELOG.md

@@ -6,6 +6,7 @@
 
 * Modify `TabContainerModel` to make more methods `protected`, improving extensibility for advanced
 use-cases.
+* Enhance `XH.reloadApp` with new argument to clear query parameters before loading.
 * Enhance exception handling in `FetchService` to capture messages returned as raw strings, or without
 explicit names.
 

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

@@ -9,7 +9,7 @@ import { AppContainerModel } from '../appcontainer/AppContainerModel';
 import { BannerModel } from '../appcontainer/BannerModel';
 import { ToastModel } from '../appcontainer/ToastModel';
 import '../styles/XH.scss';
-import { AppSpec, AppState, AppSuspendData, BannerSpec, ExceptionHandler, ExceptionHandlerOptions, HoistAppModel, HoistException, HoistService, HoistServiceClass, HoistUser, MessageSpec, PageState, PlainObject, SizingMode, TaskObserver, Theme, ToastSpec, TrackOptions } from './';
+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 = "28.0";
 /**
@@ -193,13 +193,13 @@ export declare class XHApi {
     /**
      * Trigger a full reload of the current application.
      *
-     * @param path - relative path to reload (e.g. 'mobile/').  Defaults to the
-     * existing location pathname.
+     * @param opts - options to govern reload. To support legacy usages, a provided
+     *       string will be treated as `ReloadAppOptions.path`.
      *
      * This method will reload the entire application document in the browser - to trigger a
      * refresh of the loadable content within the app, use {@link refreshAppAsync} instead.
      */
-    reloadApp(path?: string): void;
+    reloadApp(opts?: ReloadAppOptions | string): void;
     /**
      * Refresh the current application.
      *

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

@@ -19,6 +19,15 @@ export interface HoistUser {
     hasRole(s: string): boolean;
     hasGate(s: string): boolean;
 }
+/**
+ * Options governing XH.reloadApp().
+ */
+export interface ReloadAppOptions {
+    /** Relative path to reload (e.g. 'mobile/').  Defaults to the existing location pathname. */
+    path?: string;
+    /** Should the query parameters be removed from the url before reload.  Default false. */
+    removeQueryParams?: boolean;
+}
 /**
  * Options for showing a "toast" notification that appears and then automatically dismisses.
  */

package/core/XH.ts

@@ -54,6 +54,7 @@ import {
     MessageSpec,
     PageState,
     PlainObject,
+    ReloadAppOptions,
     SizingMode,
     TaskObserver,
     Theme,
@@ -392,18 +393,25 @@ export class XHApi {
     /**
      * Trigger a full reload of the current application.
      *
-     * @param path - relative path to reload (e.g. 'mobile/').  Defaults to the
-     * existing location pathname.
+     * @param opts - options to govern reload. To support legacy usages, a provided
+     *       string will be treated as `ReloadAppOptions.path`.
      *
      * This method will reload the entire application document in the browser - to trigger a
      * refresh of the loadable content within the app, use {@link refreshAppAsync} instead.
      */
     @action
-    reloadApp(path?: string) {
+    reloadApp(opts?: ReloadAppOptions | string) {
         never().linkTo(this.appLoadModel);
+
+        opts = isString(opts) ? {path: opts} : (opts ?? {});
+
         const {location} = window,
-            href = path ? `${location.origin}/${path.replace(/^\/+/, '')}` : location.href,
+            href = opts.path
+                ? `${location.origin}/${opts.path.replace(/^\/+/, '')}`
+                : location.href,
             url = new URL(href);
+
+        if (opts.removeQueryParams) url.search = '';
         // Add a unique query param to force a full reload without using the browser cache.
         url.searchParams.set('xhCacheBuster', Date.now().toString());
         document.location.assign(url);

package/core/types/Interfaces.ts

@@ -28,6 +28,17 @@ export interface HoistUser {
     hasGate(s: string): boolean;
 }
 
+/**
+ * Options governing XH.reloadApp().
+ */
+export interface ReloadAppOptions {
+    /** Relative path to reload (e.g. 'mobile/').  Defaults to the existing location pathname. */
+    path?: string;
+
+    /** Should the query parameters be removed from the url before reload.  Default false. */
+    removeQueryParams?: boolean;
+}
+
 /**
  * Options for showing a "toast" notification that appears and then automatically dismisses.
  */

package/desktop/appcontainer/ExceptionDialog.ts

@@ -79,7 +79,7 @@ export const dismissButton = hoistCmp.factory<ExceptionDialogModel>(({model}) =>
               icon: Icon.refresh(),
               text: 'Reload App',
               autoFocus: true,
-              onClick: () => XH.reloadApp()
+              onClick: () => XH.reloadApp({removeQueryParams: true})
           })
         : button({
               text: 'Close',

package/package.json

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