@elliemae/pui-app-sdk 5.40.0-beta.8 → 5.40.0

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

@@ -46,6 +46,7 @@ var import_web_storage = require("../web-storage.js");
 var import_app_bridge = require("./app-bridge.js");
 var import_helpers = require("../helpers.js");
 var import_ssf_host2 = require("./ssf-host.js");
+const DEFAULT_CONTAINER_ID = "app-container";
 const isCrossDomain = () => {
   try {
     window.parent.document;
@@ -68,7 +69,6 @@ class CMicroAppGuest {
   logger;
   appId;
   props;
-  containerId;
   /**
    * communication method used between microapps
    */
@@ -98,7 +98,6 @@ class CMicroAppGuest {
   onGetRef;
   // eslint-disable-next-line max-statements
   constructor(params) {
-    this.containerId = "app-container";
     window.emui.uuid = window.emui.uuid || (0, import_uuid.v4)();
     this.appId = window.emui?.appId || (0, import_config.getAppConfigValue)("appId");
     this.#uuid = window.emui.uuid;
@@ -109,7 +108,8 @@ class CMicroAppGuest {
       prevState: null,
       history: params?.history || import_history2.browserHistory,
       theme: (0, import_pui_theme.getDefaultTheme)(),
-      manifestPath: "./latest"
+      manifestPath: "./latest",
+      containerId: DEFAULT_CONTAINER_ID
     };
     this.logger = params?.logger || import_console_logger.consoleLogger;
     (0, import_logger.setLogger)(this.logger);
@@ -133,6 +133,11 @@ class CMicroAppGuest {
   static getInstance(params) {
     if (!this.instance) {
       this.instance = new CMicroAppGuest(params);
+      if (!params?.selfInitialize) {
+        (params?.logger || import_console_logger.consoleLogger).warn(
+          "CMicroApp.getInstance() called without selfInitialize: true \u2014 this legacy mode is deprecated. Pass { selfInitialize: true } and use initialize() instead."
+        );
+      }
     }
     return this.instance;
   }
@@ -249,7 +254,7 @@ class CMicroAppGuest {
       }
       delete window.emui.app;
     }
-    this.unmount({ containerId: this.containerId }).catch(() => {
+    this.unmount({ containerId: this.props.containerId }).catch(() => {
     });
   }
   getSessionStorageItem(key) {
@@ -338,6 +343,9 @@ class CMicroAppGuest {
     if (params.hostUrl) this.props.hostUrl = params.hostUrl;
     if (params.manifestPath)
       this.props.manifestPath = params.manifestPath;
+    if (params.containerId) {
+      this.props.containerId = params.containerId;
+    }
     this.#applyHistoryFromParams(params);
   }
   #applyHistoryFromParams(params) {
@@ -371,8 +379,13 @@ class CMicroAppGuest {
    * one, a warning is logged and the guest proceeds with its own config.
    * @returns module parameters provided by the host, or a minimal object with moduleId
    */
-  // eslint-disable-next-line max-statements
+  // eslint-disable-next-line max-statements, complexity
   async initialize() {
+    if (window.emui?._ASSET_PATH) {
+      __webpack_public_path__ = new URL("../", window.emui._ASSET_PATH).href;
+    } else {
+      __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
+    }
     const isStandalone = window.top === window.self && !window.opener;
     if (isStandalone) {
       await (0, import_app_config.loadAppConfig)();
@@ -408,6 +421,9 @@ class CMicroAppGuest {
         `Failed to retrieve module parameters for "${this.appId}". Proceeding without host-provided parameters.`
       );
     }
+    const instanceId = this.getSessionStorageItem("instanceId") || "";
+    const userId = this.getSessionStorageItem("userId") || "";
+    (0, import_pui_analytics_so.updateBAEventParameters)({ appId: this.appId, instanceId, userId });
     if (this.onInit) this.onInit(this.props);
     return params;
   }
@@ -436,8 +452,8 @@ class CMicroAppGuest {
       });
     });
   }
-  mount(options = { containerId: "app-container" }) {
-    this.containerId = options?.containerId;
+  mount(options = { containerId: DEFAULT_CONTAINER_ID }) {
+    this.props.containerId = options?.containerId;
     return Promise.resolve().then(() => {
       if (this.#pendingInitialRoute) {
         this.props.history.push(this.#pendingInitialRoute);

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

@@ -107,6 +107,11 @@ class CMicroAppHost {
   static getInstance(params) {
     if (!this.instance) {
       this.instance = new CMicroAppHost(params);
+      if (!params?.selfInitialize) {
+        (params?.logger || import_console_logger.consoleLogger).warn(
+          "CMicroAppHost.getInstance() called without selfInitialize: true \u2014 this legacy mode is deprecated. Pass { selfInitialize: true } and use initialize() instead."
+        );
+      }
     }
     return this.instance;
   }
@@ -120,6 +125,7 @@ class CMicroAppHost {
    * @returns host options (systemVersion, history, theme)
    */
   async initialize() {
+    __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
     await (0, import_app_config.loadAppConfig)();
     const appBridge = await (0, import_app_bridge.getAppBridge)();
     this.#appBridge = appBridge;

package/dist/cjs/utils/micro-frontend/module-so.js

@@ -25,6 +25,7 @@ __export(module_so_exports, {
 module.exports = __toCommonJS(module_so_exports);
 var import_ssf_host = require("@elliemae/ssf-host");
 var import_index = require("./index.js");
+var import_const = require("../../view/micro-app/const.js");
 const LOG_LEVEL_METHOD = {
   DEBUG: "debug",
   INFO: "info",
@@ -40,6 +41,7 @@ const buildModuleParams = (guestId, params = {}) => {
     hostUrl: config.hostUrl,
     manifestPath: config.manifestPath,
     homeRoute: config.homeRoute,
+    containerId: `${import_const.APP_CONTAINER_ID_PREFIX}${guestId}`,
     ...params
   };
 };

package/dist/cjs/utils/micro-frontend/tests/__snapshots__/guest.test.ts.snap

@@ -2,6 +2,7 @@
 
 exports[`CMicroAppGuest - Standalone calls onInit 1`] = `
 {
+  "containerId": "app-container",
   "history": {
     "action": "POP",
     "back": [Function],

package/dist/cjs/view/app-router.js

@@ -29,6 +29,13 @@ const AppRouter = ({ history, basename, ...props }) => {
     action: history.action,
     location: history.location
   });
+  (0, import_react.useLayoutEffect)(() => {
+    if (basename && state.location.pathname && !state.location.pathname.startsWith(basename)) {
+      console.warn(
+        `[AppRouter] basename "${basename}" does not match location.pathname "${state.location.pathname}". React Router will render nothing. Verify that "homeRoute" in app.config.json matches the guest's route.`
+      );
+    }
+  }, [basename, state.location.pathname]);
   (0, import_react.useLayoutEffect)(() => {
     const unlisten = history.listen((...args) => {
       if (args.length === 2) {

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

@@ -13,6 +13,7 @@ import { removeStorageEvents } from "../web-storage.js";
 import { getAppBridge } from "./app-bridge.js";
 import { abortPromise } from "../helpers.js";
 import { getSSFHost, setSSFHost } from "./ssf-host.js";
+const DEFAULT_CONTAINER_ID = "app-container";
 const isCrossDomain = () => {
   try {
     window.parent.document;
@@ -35,7 +36,6 @@ class CMicroAppGuest {
   logger;
   appId;
   props;
-  containerId;
   /**
    * communication method used between microapps
    */
@@ -65,7 +65,6 @@ class CMicroAppGuest {
   onGetRef;
   // eslint-disable-next-line max-statements
   constructor(params) {
-    this.containerId = "app-container";
     window.emui.uuid = window.emui.uuid || uuidv4();
     this.appId = window.emui?.appId || getAppConfigValue("appId");
     this.#uuid = window.emui.uuid;
@@ -76,7 +75,8 @@ class CMicroAppGuest {
       prevState: null,
       history: params?.history || browserHistory,
       theme: getDefaultTheme(),
-      manifestPath: "./latest"
+      manifestPath: "./latest",
+      containerId: DEFAULT_CONTAINER_ID
     };
     this.logger = params?.logger || consoleLogger;
     setLogger(this.logger);
@@ -100,6 +100,11 @@ class CMicroAppGuest {
   static getInstance(params) {
     if (!this.instance) {
       this.instance = new CMicroAppGuest(params);
+      if (!params?.selfInitialize) {
+        (params?.logger || consoleLogger).warn(
+          "CMicroApp.getInstance() called without selfInitialize: true \u2014 this legacy mode is deprecated. Pass { selfInitialize: true } and use initialize() instead."
+        );
+      }
     }
     return this.instance;
   }
@@ -216,7 +221,7 @@ class CMicroAppGuest {
       }
       delete window.emui.app;
     }
-    this.unmount({ containerId: this.containerId }).catch(() => {
+    this.unmount({ containerId: this.props.containerId }).catch(() => {
     });
   }
   getSessionStorageItem(key) {
@@ -305,6 +310,9 @@ class CMicroAppGuest {
     if (params.hostUrl) this.props.hostUrl = params.hostUrl;
     if (params.manifestPath)
       this.props.manifestPath = params.manifestPath;
+    if (params.containerId) {
+      this.props.containerId = params.containerId;
+    }
     this.#applyHistoryFromParams(params);
   }
   #applyHistoryFromParams(params) {
@@ -338,8 +346,13 @@ class CMicroAppGuest {
    * one, a warning is logged and the guest proceeds with its own config.
    * @returns module parameters provided by the host, or a minimal object with moduleId
    */
-  // eslint-disable-next-line max-statements
+  // eslint-disable-next-line max-statements, complexity
   async initialize() {
+    if (window.emui?._ASSET_PATH) {
+      __webpack_public_path__ = new URL("../", window.emui._ASSET_PATH).href;
+    } else {
+      __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
+    }
     const isStandalone = window.top === window.self && !window.opener;
     if (isStandalone) {
       await loadAppConfig();
@@ -375,6 +388,9 @@ class CMicroAppGuest {
         `Failed to retrieve module parameters for "${this.appId}". Proceeding without host-provided parameters.`
       );
     }
+    const instanceId = this.getSessionStorageItem("instanceId") || "";
+    const userId = this.getSessionStorageItem("userId") || "";
+    updateBAEventParameters({ appId: this.appId, instanceId, userId });
     if (this.onInit) this.onInit(this.props);
     return params;
   }
@@ -403,8 +419,8 @@ class CMicroAppGuest {
       });
     });
   }
-  mount(options = { containerId: "app-container" }) {
-    this.containerId = options?.containerId;
+  mount(options = { containerId: DEFAULT_CONTAINER_ID }) {
+    this.props.containerId = options?.containerId;
     return Promise.resolve().then(() => {
       if (this.#pendingInitialRoute) {
         this.props.history.push(this.#pendingInitialRoute);

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

@@ -92,6 +92,11 @@ class CMicroAppHost {
   static getInstance(params) {
     if (!this.instance) {
       this.instance = new CMicroAppHost(params);
+      if (!params?.selfInitialize) {
+        (params?.logger || consoleLogger).warn(
+          "CMicroAppHost.getInstance() called without selfInitialize: true \u2014 this legacy mode is deprecated. Pass { selfInitialize: true } and use initialize() instead."
+        );
+      }
     }
     return this.instance;
   }
@@ -105,6 +110,7 @@ class CMicroAppHost {
    * @returns host options (systemVersion, history, theme)
    */
   async initialize() {
+    __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
     await loadAppConfig();
     const appBridge = await getAppBridge();
     this.#appBridge = appBridge;

package/dist/esm/utils/micro-frontend/module-so.js

@@ -1,5 +1,6 @@
 import { ScriptingObject, Event } from "@elliemae/ssf-host";
 import { getMicroFrontEndAppConfig } from "./index.js";
+import { APP_CONTAINER_ID_PREFIX } from "../../view/micro-app/const.js";
 const LOG_LEVEL_METHOD = {
   DEBUG: "debug",
   INFO: "info",
@@ -15,6 +16,7 @@ const buildModuleParams = (guestId, params = {}) => {
     hostUrl: config.hostUrl,
     manifestPath: config.manifestPath,
     homeRoute: config.homeRoute,
+    containerId: `${APP_CONTAINER_ID_PREFIX}${guestId}`,
     ...params
   };
 };

package/dist/esm/utils/micro-frontend/tests/__snapshots__/guest.test.ts.snap

@@ -2,6 +2,7 @@
 
 exports[`CMicroAppGuest - Standalone calls onInit 1`] = `
 {
+  "containerId": "app-container",
   "history": {
     "action": "POP",
     "back": [Function],

package/dist/esm/view/app-router.js

@@ -6,6 +6,13 @@ const AppRouter = ({ history, basename, ...props }) => {
     action: history.action,
     location: history.location
   });
+  useLayoutEffect(() => {
+    if (basename && state.location.pathname && !state.location.pathname.startsWith(basename)) {
+      console.warn(
+        `[AppRouter] basename "${basename}" does not match location.pathname "${state.location.pathname}". React Router will render nothing. Verify that "homeRoute" in app.config.json matches the guest's route.`
+      );
+    }
+  }, [basename, state.location.pathname]);
   useLayoutEffect(() => {
     const unlisten = history.listen((...args) => {
       if (args.length === 2) {

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

@@ -11,6 +11,12 @@ export interface GuestProps<AppObjects extends ScriptingObjects = Partial<Script
     prevState: JSONValue | null;
     history: History;
     theme: DefaultTheme;
+    /**
+     * DOM element ID where the guest app should render. Defaults to
+     * {@link DEFAULT_CONTAINER_ID} and can be overridden by the host via module
+     * parameters or the {@link MountOptions} passed to `mount()`.
+     */
+    containerId: string;
 }
 export type OnInitCallback = (options: GuestProps) => void;
 export type OnMountCallback = (options: MountOptions) => void;
@@ -65,7 +71,6 @@ export declare class CMicroAppGuest<AppObjects extends ScriptingObjects = Partia
     private readonly logger;
     private readonly appId;
     private props;
-    private containerId;
     private readonly onInit?;
     private readonly onMount?;
     private readonly onUnmount?;