@elliemae/pui-app-sdk 5.40.3 → 5.40.4

package/dist/cjs/utils/micro-frontend/guest.js

@@ -506,11 +506,12 @@ class CMicroAppGuest {
   /**
    * removes scripting object from child microapp use
    * @param objectId unique id of the scripting object
+   * @param guestId optional guest id when removing a guest-scoped object
    */
-  removeScriptingObject(objectId) {
+  removeScriptingObject(objectId, guestId) {
     if (this.#appBridge) {
-      this.#appBridge.removeScriptingObject(objectId);
+      this.#appBridge.removeScriptingObject(objectId, guestId);
     }
-    this.#ssfHostRef.removeScriptingObject(objectId);
+    this.#ssfHostRef.removeScriptingObject(objectId, guestId);
   }
 }

package/dist/cjs/utils/micro-frontend/host.js

@@ -254,11 +254,12 @@ class CMicroAppHost {
   /**
    * removes scripting object from child microapp use
    * @param objectId unique id of the scripting object
+   * @param guestId optional guest id when removing a guest-scoped object
    */
-  removeScriptingObject(objectId) {
+  removeScriptingObject(objectId, guestId) {
     if (this.#appBridge) {
-      this.#appBridge.removeScriptingObject(objectId);
+      this.#appBridge.removeScriptingObject(objectId, guestId);
     }
-    this.#ssfHostRef.removeScriptingObject(objectId);
+    this.#ssfHostRef.removeScriptingObject(objectId, guestId);
   }
 }

package/dist/cjs/utils/micro-frontend/index.js

@@ -58,6 +58,7 @@ const getVersionedPath = (path) => {
     majorMinorVersion && majorMinorVersion[0] || "latest"
   );
 };
+const appendTrailingSlash = (path) => path?.replace?.(/\/?$/, "/");
 const getMicroFrontEndAppConfig = (appInfo) => {
   const microFEAppConfig = (0, import_config.getAppConfigValue)(
     `microFrontendApps.${appInfo.id}`
@@ -84,6 +85,8 @@ const getMicroFrontEndAppConfig = (appInfo) => {
   microFEConfig.hostUrl = (0, import_helpers.convertRelativeToAbsoluteUrl)(
     microFEConfig.hostUrl.replace(/\/?$/, "/")
   );
-  microFEConfig.manifestPath = getVersionedPath(microFEConfig.manifestPath);
+  microFEConfig.manifestPath = appendTrailingSlash(
+    getVersionedPath(microFEConfig.manifestPath)
+  );
   return microFEConfig;
 };

package/dist/cjs/view/guest-microapp.js

@@ -48,6 +48,7 @@ const Div = import_styled_components.default.div`
   flex-direction: column;
   overflow: hidden;
 `;
+const isAbortError = (error) => error instanceof DOMException ? error.name === "AbortError" : error instanceof Error && error.name === "AbortError";
 const useAppRenderer = (props) => {
   const {
     id,
@@ -77,8 +78,10 @@ const useAppRenderer = (props) => {
     let ssfHost = null;
     let unloadInProgress = Promise.resolve();
     let instanceId = null;
+    const abortController = new AbortController();
     (async () => {
       await unloadInProgress;
+      if (!isMounted || abortController.signal.aborted) return;
       if (!disableWaitMessage) {
         dispatch(import_actions.waitMessage.open());
       }
@@ -101,7 +104,7 @@ const useAppRenderer = (props) => {
             throw new Error(`Failed to load ${id}, SSFHost not initialized`);
           if (!hostUrl)
             throw new Error(`Failed to load ${id}, hostUrl not configured`);
-          if (isMounted) {
+          if (isMounted && !abortController.signal.aborted) {
             const { searchParams, ...guestOptions } = mergedSsfAppOptions;
             const ssfUrlObj = new URL(hostUrl);
             if (initialRoute) {
@@ -133,18 +136,24 @@ const useAppRenderer = (props) => {
           appBridge = await (0, import_app_bridge.getAppBridge)();
           if (!appBridge)
             throw new Error(`Failed to load ${id}, AppBridge not initialized`);
-          if (isMounted) {
+          if (isMounted && !abortController.signal.aborted) {
             instanceId = await appBridge.openApp({
               id,
               selfInitialize: configSelfInitialize,
               frameOptions: {
                 containerId,
-                queryParams: (0, import_pui_logrocket.buildLogRocketQueryParams)()
+                queryParams: (0, import_pui_logrocket.buildLogRocketQueryParams)(),
+                signal: abortController.signal
               },
               history,
               homeRoute,
               initialRoute
             });
+            if (!isMounted || abortController.signal.aborted) {
+              await appBridge.closeApp(instanceId);
+              instanceId = null;
+              return;
+            }
             setTimeout(() => {
               try {
                 onLoadComplete?.(instanceId);
@@ -158,6 +167,7 @@ const useAppRenderer = (props) => {
           }
         }
       } catch (ex) {
+        if (isAbortError(ex)) return;
         (0, import_micro_frontend.getLogger)().error({
           message: `Failed to load ${id}`,
           exception: ex
@@ -167,7 +177,6 @@ const useAppRenderer = (props) => {
           unloadInProgress = appBridge.closeApp(instanceId);
         if (ssfHost && instanceId)
           unloadInProgress = Promise.resolve(ssfHost.unloadGuest(instanceId));
-        throw ex;
       } finally {
         if (!disableWaitMessage) {
           dispatch(import_actions.waitMessage.close());
@@ -175,6 +184,7 @@ const useAppRenderer = (props) => {
       }
     })();
     return () => {
+      abortController.abort();
       isMounted = false;
       if (ssfHost && instanceId) {
         unloadInProgress = Promise.resolve(ssfHost.unloadGuest(instanceId));

package/dist/cjs/view/tests/__snapshots__/micro-iframe-app.test.tsx.snap

@@ -156,7 +156,7 @@ exports[`MicroIFrameApp should close previous instance of app before loading new
   
   
   <base
-    href="http://localhost:3111/loan/latest"
+    href="http://localhost:3111/loan/latest/"
   />
   <link
     crossorigin="anonymous"
@@ -286,7 +286,7 @@ exports[`MicroIFrameApp should open loanapp and call init and mount methods 1`]
   
   
   <base
-    href="http://localhost:3111/loan/latest"
+    href="http://localhost:3111/loan/latest/"
   />
   <link
     crossorigin="anonymous"

package/dist/esm/utils/micro-frontend/guest.js

@@ -473,12 +473,13 @@ class CMicroAppGuest {
   /**
    * removes scripting object from child microapp use
    * @param objectId unique id of the scripting object
+   * @param guestId optional guest id when removing a guest-scoped object
    */
-  removeScriptingObject(objectId) {
+  removeScriptingObject(objectId, guestId) {
     if (this.#appBridge) {
-      this.#appBridge.removeScriptingObject(objectId);
+      this.#appBridge.removeScriptingObject(objectId, guestId);
     }
-    this.#ssfHostRef.removeScriptingObject(objectId);
+    this.#ssfHostRef.removeScriptingObject(objectId, guestId);
   }
 }
 export {

package/dist/esm/utils/micro-frontend/host.js

@@ -239,12 +239,13 @@ class CMicroAppHost {
   /**
    * removes scripting object from child microapp use
    * @param objectId unique id of the scripting object
+   * @param guestId optional guest id when removing a guest-scoped object
    */
-  removeScriptingObject(objectId) {
+  removeScriptingObject(objectId, guestId) {
     if (this.#appBridge) {
-      this.#appBridge.removeScriptingObject(objectId);
+      this.#appBridge.removeScriptingObject(objectId, guestId);
     }
-    this.#ssfHostRef.removeScriptingObject(objectId);
+    this.#ssfHostRef.removeScriptingObject(objectId, guestId);
   }
 }
 export {

package/dist/esm/utils/micro-frontend/index.js

@@ -21,6 +21,7 @@ const getVersionedPath = (path) => {
     majorMinorVersion && majorMinorVersion[0] || "latest"
   );
 };
+const appendTrailingSlash = (path) => path?.replace?.(/\/?$/, "/");
 const getMicroFrontEndAppConfig = (appInfo) => {
   const microFEAppConfig = getAppConfigValue(
     `microFrontendApps.${appInfo.id}`
@@ -47,7 +48,9 @@ const getMicroFrontEndAppConfig = (appInfo) => {
   microFEConfig.hostUrl = convertRelativeToAbsoluteUrl(
     microFEConfig.hostUrl.replace(/\/?$/, "/")
   );
-  microFEConfig.manifestPath = getVersionedPath(microFEConfig.manifestPath);
+  microFEConfig.manifestPath = appendTrailingSlash(
+    getVersionedPath(microFEConfig.manifestPath)
+  );
   return microFEConfig;
 };
 export {

package/dist/esm/view/guest-microapp.js

@@ -20,6 +20,7 @@ const Div = styled.div`
   flex-direction: column;
   overflow: hidden;
 `;
+const isAbortError = (error) => error instanceof DOMException ? error.name === "AbortError" : error instanceof Error && error.name === "AbortError";
 const useAppRenderer = (props) => {
   const {
     id,
@@ -49,8 +50,10 @@ const useAppRenderer = (props) => {
     let ssfHost = null;
     let unloadInProgress = Promise.resolve();
     let instanceId = null;
+    const abortController = new AbortController();
     (async () => {
       await unloadInProgress;
+      if (!isMounted || abortController.signal.aborted) return;
       if (!disableWaitMessage) {
         dispatch(waitMessage.open());
       }
@@ -73,7 +76,7 @@ const useAppRenderer = (props) => {
             throw new Error(`Failed to load ${id}, SSFHost not initialized`);
           if (!hostUrl)
             throw new Error(`Failed to load ${id}, hostUrl not configured`);
-          if (isMounted) {
+          if (isMounted && !abortController.signal.aborted) {
             const { searchParams, ...guestOptions } = mergedSsfAppOptions;
             const ssfUrlObj = new URL(hostUrl);
             if (initialRoute) {
@@ -105,18 +108,24 @@ const useAppRenderer = (props) => {
           appBridge = await getAppBridge();
           if (!appBridge)
             throw new Error(`Failed to load ${id}, AppBridge not initialized`);
-          if (isMounted) {
+          if (isMounted && !abortController.signal.aborted) {
             instanceId = await appBridge.openApp({
               id,
               selfInitialize: configSelfInitialize,
               frameOptions: {
                 containerId,
-                queryParams: buildLogRocketQueryParams()
+                queryParams: buildLogRocketQueryParams(),
+                signal: abortController.signal
               },
               history,
               homeRoute,
               initialRoute
             });
+            if (!isMounted || abortController.signal.aborted) {
+              await appBridge.closeApp(instanceId);
+              instanceId = null;
+              return;
+            }
             setTimeout(() => {
               try {
                 onLoadComplete?.(instanceId);
@@ -130,6 +139,7 @@ const useAppRenderer = (props) => {
           }
         }
       } catch (ex) {
+        if (isAbortError(ex)) return;
         getLogger().error({
           message: `Failed to load ${id}`,
           exception: ex
@@ -139,7 +149,6 @@ const useAppRenderer = (props) => {
           unloadInProgress = appBridge.closeApp(instanceId);
         if (ssfHost && instanceId)
           unloadInProgress = Promise.resolve(ssfHost.unloadGuest(instanceId));
-        throw ex;
       } finally {
         if (!disableWaitMessage) {
           dispatch(waitMessage.close());
@@ -147,6 +156,7 @@ const useAppRenderer = (props) => {
       }
     })();
     return () => {
+      abortController.abort();
       isMounted = false;
       if (ssfHost && instanceId) {
         unloadInProgress = Promise.resolve(ssfHost.unloadGuest(instanceId));

package/dist/esm/view/tests/__snapshots__/micro-iframe-app.test.tsx.snap

@@ -156,7 +156,7 @@ exports[`MicroIFrameApp should close previous instance of app before loading new
   
   
   <base
-    href="http://localhost:3111/loan/latest"
+    href="http://localhost:3111/loan/latest/"
   />
   <link
     crossorigin="anonymous"
@@ -286,7 +286,7 @@ exports[`MicroIFrameApp should open loanapp and call init and mount methods 1`]
   
   
   <base
-    href="http://localhost:3111/loan/latest"
+    href="http://localhost:3111/loan/latest/"
   />
   <link
     crossorigin="anonymous"

package/dist/types/lib/utils/micro-frontend/guest.d.ts

@@ -134,7 +134,8 @@ export declare class CMicroAppGuest<AppObjects extends ScriptingObjects = Partia
     /**
      * removes scripting object from child microapp use
      * @param objectId unique id of the scripting object
+     * @param guestId optional guest id when removing a guest-scoped object
      */
-    removeScriptingObject(objectId: Extract<keyof AppObjects, string>): void;
+    removeScriptingObject(objectId: Extract<keyof AppObjects, string>, guestId?: string): void;
 }
 export {};

package/dist/types/lib/utils/micro-frontend/host.d.ts

@@ -116,7 +116,8 @@ export declare class CMicroAppHost<AppObjects extends ScriptingObjects = Partial
     /**
      * removes scripting object from child microapp use
      * @param objectId unique id of the scripting object
+     * @param guestId optional guest id when removing a guest-scoped object
      */
-    removeScriptingObject(objectId: Extract<keyof AppObjects, string>): void;
+    removeScriptingObject(objectId: Extract<keyof AppObjects, string>, guestId?: string): void;
 }
 export {};

package/dist/types/lib/utils/micro-frontend/module-so.d.ts

@@ -75,12 +75,12 @@ export type ModuleOverrides = {
  * values (hostUrl, manifestPath, homeRoute) with host-provided values
  * (theme, history, initialRoute).
  *
- * Register the returned object via {@link CMicroAppHost.addScriptingObject}
- * or {@link CMicroAppGuest.addScriptingObject} (not directly on the app
- * bridge) so it is added to both the App Bridge and the SSF Host.
+ * Register the returned object via {@link CMicroApp.addScriptingObject}
+ * (not directly on the app bridge) so it is added to both the App Bridge
+ * and the SSF Host.
  * @param guestId - App id as defined in app.config.json (e.g. 'loanapp')
  * @param params - Host-provided values (theme, history, initialRoute, custom keys)
  * @param overrides - Method overrides / additions (e.g. custom getCapabilities)
- * @returns IModule scripting object ready for CMicroAppHost/CMicroApp.addScriptingObject()
+ * @returns IModule scripting object ready for {@link CMicroApp.addScriptingObject}
  */
 export declare const createGuestModule: (guestId: string, params?: HostProvidedParams, overrides?: ModuleOverrides) => IModule;

package/dist/types/lib/view/guest-microapp.d.ts

@@ -29,7 +29,14 @@ export type GuestMicroAppParams = OpenAppParams & {
     disableWaitMessage?: boolean;
 };
 /**
- * Component to load a guest microapp
+ * Component to load a guest microapp.
+ *
+ * For guests with `selfInitialize: true`, the host must register a module
+ * scripting object (via {@link createGuestModule} or a {@link GuestModule}
+ * subclass) through {@link CMicroApp.addScriptingObject} before rendering
+ * this component, and remove it on teardown. Host-provided `theme` and
+ * `history` for self-initializing guests belong on that module SO — not on
+ * {@link GuestMicroApp} / {@link OpenAppParams}.
  * @param props - The props for the MicroApp component.
  */
 export declare const GuestMicroApp: import("react").NamedExoticComponent<Omit<GuestMicroAppParams, "containerId">>;