@elliemae/pui-app-sdk 5.40.4 → 5.40.5

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

@@ -13,6 +13,10 @@ import {
   getLogger,
   getMicroFrontEndAppConfig
 } from "../utils/micro-frontend/index.js";
+import {
+  resolveGuestOpenHistory,
+  resolveNestedGuestFrameOptions
+} from "../utils/micro-frontend/guest-host-context.js";
 const Div = styled.div`
   display: flex;
   width: 100%;
@@ -31,13 +35,22 @@ const useAppRenderer = (props) => {
     onUnloadComplete,
     containerId,
     ssfAppOptions,
-    disableWaitMessage = false
+    disableWaitMessage = false,
+    frameOptions: userFrameOptions
   } = props;
   const dispatch = useDispatch();
   const stableSsfAppOptions = useMemo(
     () => ssfAppOptions ?? {},
     [ssfAppOptions]
   );
+  const guestHistory = useMemo(
+    () => resolveGuestOpenHistory(history),
+    [history]
+  );
+  const resolvedFrameOptions = useMemo(
+    () => resolveNestedGuestFrameOptions(userFrameOptions),
+    [userFrameOptions]
+  );
   const getConfig = useCallback(
     () => getMicroFrontEndAppConfig({
       id
@@ -113,11 +126,12 @@ const useAppRenderer = (props) => {
               id,
               selfInitialize: configSelfInitialize,
               frameOptions: {
+                ...resolvedFrameOptions,
                 containerId,
                 queryParams: buildLogRocketQueryParams(),
                 signal: abortController.signal
               },
-              history,
+              history: guestHistory,
               homeRoute,
               initialRoute
             });
@@ -185,7 +199,7 @@ const useAppRenderer = (props) => {
   }, [
     containerId,
     dispatch,
-    history,
+    guestHistory,
     homeRoute,
     initialRoute,
     id,
@@ -193,7 +207,8 @@ const useAppRenderer = (props) => {
     onUnloadComplete,
     getConfig,
     stableSsfAppOptions,
-    disableWaitMessage
+    disableWaitMessage,
+    resolvedFrameOptions
   ]);
 };
 const GuestMicroApp = memo(

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

@@ -0,0 +1,40 @@
+import type { History } from 'history';
+type NestedGuestFrameOptions = {
+    src?: string;
+};
+/**
+ * History object to use when **opening** a child guest via {@link GuestMicroApp}.
+ * {@link createGuestModule} applies the same resolution for module scripting
+ * objects automatically.
+ *
+ * This only affects what the **host** passes into app-bridge `openApp`. The
+ * **child guest** still decides its final router history during
+ * {@link CMicroAppGuest.initialize} from **its own** `app.config.json`
+ * `useParentHistory` flag:
+ *
+ * - `useParentHistory: true` (default) — uses the history received from the host
+ * - `useParentHistory: false` — uses independent `memoryHistory` inside the
+ *   iframe and ignores the host-provided history
+ *
+ * When this host runs inside a parent iframe and shares parent history itself
+ * (`useParentHistory: true`, the default), the exported `browserHistory`
+ * singleton tracks the iframe shell URL (e.g. `/latest/frame.html`), not the
+ * shared grandparent route (e.g. `/prospects/incomplete-apps`). In that case
+ * the history bound during {@link CMicroAppGuest.initialize} is returned
+ * automatically so shared-history children receive the correct object.
+ *
+ * Hosts with `useParentHistory: false` are unchanged: callers keep passing
+ * `explicitHistory ?? browserHistory`, and guests that want their own URL space
+ * opt out via their own config.
+ * @param explicitHistory
+ */
+export declare const resolveGuestOpenHistory: (explicitHistory?: History) => History;
+/**
+ * Frame options for nested hosts whose bundled frame.html URL targets the
+ * guest dev-server origin while JS executes in the parent iframe document.
+ * App Bridge rewrites cross-origin frame shells; this supplies an explicit
+ * same-origin src when callers pass custom frameOptions.
+ * @param userFrameOptions
+ */
+export declare const resolveNestedGuestFrameOptions: (userFrameOptions?: NestedGuestFrameOptions) => NestedGuestFrameOptions | undefined;
+export {};

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

@@ -73,7 +73,9 @@ export type ModuleOverrides = {
  *
  * Internally calls {@link buildModuleParams} to merge the app config
  * values (hostUrl, manifestPath, homeRoute) with host-provided values
- * (theme, history, initialRoute).
+ * (theme, history, initialRoute). When nested under a parent iframe,
+ * {@link resolveGuestOpenHistory} is applied to `params.history` automatically
+ * (same behavior as {@link GuestMicroApp}).
  *
  * Register the returned object via {@link CMicroApp.addScriptingObject}
  * (not directly on the app bridge) so it is added to both the App Bridge

package/dist/types/lib/utils/micro-frontend/tests/guest-host-context.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+/** Clears the guest singleton between tests. */
+export declare const resetCMicroAppGuestInstance: () => void;

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

@@ -37,6 +37,10 @@ export type GuestMicroAppParams = OpenAppParams & {
  * 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}.
+ *
+ * When this app is itself a nested guest (running inside a parent iframe),
+ * {@link GuestMicroApp} automatically forwards the shared grandparent history
+ * to child guests — callers do not need to pass `history` explicitly.
  * @param props - The props for the MicroApp component.
  */
 export declare const GuestMicroApp: import("react").NamedExoticComponent<Omit<GuestMicroAppParams, "containerId">>;