@elliemae/pui-app-sdk 5.40.0-beta.1 → 5.40.0-beta.10

package/dist/cjs/view/tests/constants.js

@@ -26,6 +26,7 @@ __export(constants_exports, {
   LATEST_VERSION: () => LATEST_VERSION,
   LOAN_APP_ID: () => LOAN_APP_ID,
   LOAN_SAVED_EVENT: () => LOAN_SAVED_EVENT,
+  LOAN_SELF_INIT_APP_ID: () => LOAN_SELF_INIT_APP_ID,
   PRE_COMMIT_EVENT: () => PRE_COMMIT_EVENT,
   RELEASE_VERSION: () => RELEASE_VERSION,
   SSF_APP_ID: () => SSF_APP_ID,
@@ -35,6 +36,7 @@ module.exports = __toCommonJS(constants_exports);
 const LATEST_VERSION = "latest";
 const RELEASE_VERSION = "23.1.0";
 const LOAN_APP_ID = "loanapp";
+const LOAN_SELF_INIT_APP_ID = "loanapp-selfinit";
 const SSF_APP_ID = "ssfapp";
 const TASK_APP_ID = "taskapp";
 const FLIGHTS_APP_ID = "flights";

package/dist/esm/index.js

@@ -64,7 +64,9 @@ import {
   CMicroAppGuest,
   CMicroAppGuest as CMicroAppGuest2
 } from "./utils/micro-frontend/guest.js";
-import { CMicroAppHost } from "./utils/micro-frontend/host.js";
+import {
+  CMicroAppHost
+} from "./utils/micro-frontend/host.js";
 import {
   buildModuleParams,
   createGuestModule,

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

@@ -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;
   }
@@ -292,12 +297,20 @@ class CMicroAppGuest {
     }
     return null;
   }
+  #exposeGetHost() {
+    window.emui = window.emui || {};
+    window.emui.getHost = () => this.props.host ?? null;
+  }
+  async #initAppBridge() {
+    this.#appBridge = await getAppBridge();
+  }
   #applyModuleParams(params) {
     if (params.homeRoute) this.props.homeRoute = params.homeRoute;
     if (params.theme) this.props.theme = params.theme;
     if (params.hostUrl) this.props.hostUrl = params.hostUrl;
     if (params.manifestPath)
       this.props.manifestPath = params.manifestPath;
+    if (params.containerId) this.containerId = params.containerId;
     this.#applyHistoryFromParams(params);
   }
   #applyHistoryFromParams(params) {
@@ -322,35 +335,60 @@ class CMicroAppGuest {
     if (route) this.props.history.push(route);
   }
   /**
-   * Guest-initiated lifecycle: discovers the host, pulls module parameters,
-   * and applies them. After this resolves the guest is ready to render.
+   * Guest-initiated lifecycle: discovers the host and applies module
+   * parameters if available. After this resolves the guest is ready to render.
    * Requires selfInitialize: true in the constructor so the bridge
    * skips calling init() / mount() on this guest.
-   * @returns module parameters provided by the host
+   *
+   * The module scripting object is optional — if the host did not register
+   * 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, 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();
+      await this.#initAppBridge();
       this.logger.info("Running in standalone mode \u2014 skipping host discovery");
       if (this.onInit) this.onInit(this.props);
       return { moduleId: this.appId };
     }
-    const [host] = await Promise.all([this.#discoverHost(), loadAppConfig()]);
+    const [host] = await Promise.all([
+      this.#discoverHost(),
+      loadAppConfig().then(() => this.#initAppBridge())
+    ]);
     if (!host) {
       throw new Error(
         "Unable to discover host. Ensure the host uses an updated pui-app-sdk and pui-microfe, or use the host-initiated model (onInit/onMount)."
       );
     }
     this.props.host = host;
-    const module = await host.getObject("module");
-    if (!module) {
-      throw new Error(
-        `Host did not register a module scripting object for guest "${this.appId}". Ensure the host registers a module SO before rendering GuestMicroApp.`
+    this.#exposeGetHost();
+    let params = { moduleId: this.appId };
+    try {
+      const module = await host.getObject("module");
+      if (module) {
+        params = await module.getParameters();
+        this.#applyModuleParams(params);
+      } else {
+        this.logger.warn(
+          `Host did not register a module scripting object for "${this.appId}". Proceeding without host-provided parameters (history, theme, initialRoute).`
+        );
+      }
+    } catch (ex) {
+      this.logger.warn(
+        `Failed to retrieve module parameters for "${this.appId}". Proceeding without host-provided parameters.`
       );
     }
-    const params = await module.getParameters();
-    this.#applyModuleParams(params);
+    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;
   }
@@ -363,6 +401,7 @@ class CMicroAppGuest {
         this.props.host = host;
       } else this.logger.warn("unable to connect to host microapp");
     }
+    this.#exposeGetHost();
     __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
     return loadAppConfig().then(() => {
       const instanceId = this.getSessionStorageItem("instanceId") || "";
@@ -401,9 +440,12 @@ class CMicroAppGuest {
     if (url) this.props.history.push(url, state);
   }
   /**
-   * add scripting object for child microapp to use
+   * Register a scripting object for child micro-apps to use.
+   * Adds the object to both the App Bridge and the SSF Host so guests
+   * using either transport can discover it. Always prefer this method
+   * over calling appBridge.addScriptingObject() directly.
    * @param so - The scripting object to be added.
-   * @param params - Optional parameters for adding the scripting object.
+   * @param params - Optional parameters (e.g. `{ guestId }` to scope to a specific guest).
    */
   addScriptingObject(so, params) {
     if (this.#appBridge) {

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

@@ -36,6 +36,7 @@ class CMicroAppHost {
   scriptingObjects;
   #ssfHostRef;
   #appBridge = null;
+  #selfInitialize;
   // eslint-disable-next-line max-statements
   constructor(params) {
     this.appId = getAppConfigValue("appId");
@@ -43,6 +44,7 @@ class CMicroAppHost {
     this.logger = params?.logger || consoleLogger;
     setLogger(this.logger);
     this.onRenewSessionTimer = params?.onRenewSessionTimer;
+    this.#selfInitialize = params?.selfInitialize ?? false;
     this.props = {
       systemVersion: params?.version ?? "latest",
       history: params?.history ?? browserHistory,
@@ -74,26 +76,47 @@ class CMicroAppHost {
         leading: true
       }
     );
-    loadAppConfig().then(() => {
-      getAppBridge().then((appBridge) => {
-        this.#appBridge = appBridge;
-        if (this.onInit) this.onInit(this.props);
-      }).catch((ex) => {
-        throw ex;
+    if (!this.#selfInitialize) {
+      loadAppConfig().then(() => {
+        getAppBridge().then((appBridge) => {
+          this.#appBridge = appBridge;
+          if (this.onInit) this.onInit(this.props);
+        }).catch((ex) => {
+          throw ex;
+        });
+      }).catch(() => {
       });
-    }).catch(() => {
-    });
+    }
     updateBAEventParameters({ appId: this.appId });
   }
   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;
   }
   static isInitialized() {
     return !!this.instance;
   }
+  /**
+   * Host-initiated lifecycle: loads app config, initializes the app bridge,
+   * and calls the onInit callback. Call this instead of relying on the
+   * automatic constructor chain when `selfInitialize: true`.
+   * @returns host options (systemVersion, history, theme)
+   */
+  async initialize() {
+    __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
+    await loadAppConfig();
+    const appBridge = await getAppBridge();
+    this.#appBridge = appBridge;
+    if (this.onInit) this.onInit(this.props);
+    return this.props;
+  }
   getProps() {
     return this.props;
   }
@@ -182,9 +205,12 @@ class CMicroAppHost {
     return this.scriptingObjects[name];
   }
   /**
-   * add scripting object for child microapp to use
+   * Register a scripting object for child micro-apps to use.
+   * Adds the object to both the App Bridge and the SSF Host so guests
+   * using either transport can discover it. Always prefer this method
+   * over calling appBridge.addScriptingObject() directly.
    * @param so - The scripting object to be added.
-   * @param params - Optional parameters for adding the scripting object.
+   * @param params - Optional parameters (e.g. `{ guestId }` to scope to a specific guest).
    */
   addScriptingObject(so, params) {
     if (this.#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
   };
 };
@@ -37,16 +39,12 @@ class GuestModule extends ScriptingObject {
    * @param handler
    */
   // eslint-disable-next-line no-underscore-dangle
-  _setUnloadHandler(handler) {
+  _setUnloadHandler = (handler) => {
     this.#onUnload = handler;
-  }
-  getParameters() {
-    return Promise.resolve(this.#params);
-  }
-  getCapabilities() {
-    return Promise.resolve({});
-  }
-  log(message, logLevel) {
+  };
+  getParameters = () => Promise.resolve(this.#params);
+  getCapabilities = () => Promise.resolve({});
+  log = (message, logLevel) => {
     const logger = window.emui?.logger;
     if (!logger) return Promise.resolve();
     const text = typeof message === "string" ? message : message.message;
@@ -54,11 +52,11 @@ class GuestModule extends ScriptingObject {
     const logFn = logger[method];
     if (logFn) logFn(text);
     return Promise.resolve();
-  }
-  unload() {
+  };
+  unload = () => {
     if (this.#onUnload) return this.#onUnload();
     return Promise.resolve();
-  }
+  };
 }
 const createGuestModule = (guestId, params = {}, overrides = {}) => {
   const mod = new GuestModule(guestId, params);

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

@@ -60,6 +60,7 @@ const useAppRenderer = (props) => {
           hostUrl,
           title,
           name,
+          selfInitialize: configSelfInitialize,
           ssfAppOptions: configSsfAppOptions = {}
         } = getConfig();
         const mergedSsfAppOptions = {
@@ -107,6 +108,7 @@ const useAppRenderer = (props) => {
           if (isMounted) {
             instanceId = await appBridge.openApp({
               id,
+              selfInitialize: configSelfInitialize,
               frameOptions: {
                 containerId,
                 queryParams: buildLogRocketQueryParams()

package/dist/esm/view/tests/app.config.json

@@ -25,6 +25,17 @@
         "style": "border: 2px solid red;"
       }
     },
+    "loanapp-selfinit": {
+      "name": "Loan Self Init",
+      "hostUrl": "./loan",
+      "selfInitialize": true,
+      "development": {
+        "files": ["index.js"]
+      },
+      "production": {
+        "files": ["index.js"]
+      }
+    },
     "taskapp": {
       "name": "Task",
       "hostUrl": "./task",

package/dist/esm/view/tests/constants.js

@@ -1,6 +1,7 @@
 const LATEST_VERSION = "latest";
 const RELEASE_VERSION = "23.1.0";
 const LOAN_APP_ID = "loanapp";
+const LOAN_SELF_INIT_APP_ID = "loanapp-selfinit";
 const SSF_APP_ID = "ssfapp";
 const TASK_APP_ID = "taskapp";
 const FLIGHTS_APP_ID = "flights";
@@ -19,6 +20,7 @@ export {
   LATEST_VERSION,
   LOAN_APP_ID,
   LOAN_SAVED_EVENT,
+  LOAN_SELF_INIT_APP_ID,
   PRE_COMMIT_EVENT,
   RELEASE_VERSION,
   SSF_APP_ID,

package/dist/types/lib/index.d.ts

@@ -30,7 +30,8 @@ export { subscribeToSessionExpiryWarning, subscribeToSessionExpiry, subscribeToR
 export { waitMessage as waitMessageAction } from './data/wait-message/actions.js';
 export { initServiceWorker } from './utils/service-worker.js';
 export { CMicroAppGuest, CMicroAppGuest as CMicroApp, } from './utils/micro-frontend/guest.js';
-export { CMicroAppHost } from './utils/micro-frontend/host.js';
+/** @deprecated Use CMicroApp with selfInitialize: true instead */
+export { CMicroAppHost, type HostOptions, } from './utils/micro-frontend/host.js';
 export { buildModuleParams, createGuestModule, GuestModule, } from './utils/micro-frontend/module-so.js';
 export type { HostProvidedParams, ModuleOverrides, } from './utils/micro-frontend/module-so.js';
 export { enableReactAppForHostIntegration } from './utils/app-host-integration/react.js';

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

@@ -96,11 +96,14 @@ export declare class CMicroAppGuest<AppObjects extends ScriptingObjects = Partia
     private findHost;
     get uuid(): string;
     /**
-     * Guest-initiated lifecycle: discovers the host, pulls module parameters,
-     * and applies them. After this resolves the guest is ready to render.
+     * Guest-initiated lifecycle: discovers the host and applies module
+     * parameters if available. After this resolves the guest is ready to render.
      * Requires selfInitialize: true in the constructor so the bridge
      * skips calling init() / mount() on this guest.
-     * @returns module parameters provided by the host
+     *
+     * The module scripting object is optional — if the host did not register
+     * 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
      */
     initialize(): Promise<ModuleParameters>;
     init(options: InitOptions<AppObjects, AppEvents>): Promise<void>;
@@ -109,9 +112,12 @@ export declare class CMicroAppGuest<AppObjects extends ScriptingObjects = Partia
     getRef<T>(): T | null;
     navigate(url: To, state?: any): void;
     /**
-     * add scripting object for child microapp to use
+     * Register a scripting object for child micro-apps to use.
+     * Adds the object to both the App Bridge and the SSF Host so guests
+     * using either transport can discover it. Always prefer this method
+     * over calling appBridge.addScriptingObject() directly.
      * @param so - The scripting object to be added.
-     * @param params - Optional parameters for adding the scripting object.
+     * @param params - Optional parameters (e.g. `{ guestId }` to scope to a specific guest).
      */
     addScriptingObject<SO extends AppObjects[keyof AppObjects]>(so: SO, params?: AddScriptingObjectParams): void;
     /**

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

@@ -6,7 +6,7 @@ import { BAEvent, ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-o
 import type { ScriptingObjects, EventListeners, AddScriptingObjectParams, DispatchEventParam, EventOptions } from '@elliemae/microfe-common';
 import { Analytics } from '@elliemae/pui-analytics-so';
 import { MicroFrontEndLogger } from '../types.js';
-type HostOptions = {
+export type HostOptions = {
     systemVersion: string;
     history: History;
     theme: DefaultTheme;
@@ -22,11 +22,18 @@ type ConstructorParams = {
     onInit?: OnInitCallback;
     ssfHostRef?: SSFHost<ScriptingObjectTypes, Events> | null;
     analytics?: Analytics;
+    /**
+     * When true the host drives its own lifecycle via {@link CMicroAppHost.initialize}.
+     * The constructor skips the automatic loadAppConfig → getAppBridge → onInit chain.
+     */
+    selfInitialize?: boolean;
 };
 /**
  * Micro-frontend host application class (singleton).
  * Manages hosting and coordination of multiple micro-frontend guest applications.
  * Provides shared services like navigation, theming, analytics, and state management.
+ * @deprecated Use {@link CMicroAppGuest | CMicroApp} instead. CMicroApp now supports
+ * both guest and host use cases via `selfInitialize: true` and `initialize()`.
  * @template AppObjects - Type of custom scripting objects
  * @template AppEvents - Type of custom event listeners
  * @example
@@ -57,6 +64,13 @@ export declare class CMicroAppHost<AppObjects extends ScriptingObjects = Partial
     private constructor();
     static getInstance<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>, AppEvents extends EventListeners = Events>(params?: ConstructorParams): CMicroAppHost<AppObjects, AppEvents>;
     static isInitialized(): boolean;
+    /**
+     * Host-initiated lifecycle: loads app config, initializes the app bridge,
+     * and calls the onInit callback. Call this instead of relying on the
+     * automatic constructor chain when `selfInitialize: true`.
+     * @returns host options (systemVersion, history, theme)
+     */
+    initialize(): Promise<HostOptions>;
     getProps(): HostOptions;
     getLogger(): MicroFrontEndLogger;
     getItem(key: string): string | null;
@@ -85,9 +99,12 @@ export declare class CMicroAppHost<AppObjects extends ScriptingObjects = Partial
     sendBAEvent(data: BAEvent): void;
     getObject<T>(name: string): Promise<T>;
     /**
-     * add scripting object for child microapp to use
+     * Register a scripting object for child micro-apps to use.
+     * Adds the object to both the App Bridge and the SSF Host so guests
+     * using either transport can discover it. Always prefer this method
+     * over calling appBridge.addScriptingObject() directly.
      * @param so - The scripting object to be added.
-     * @param params - Optional parameters for adding the scripting object.
+     * @param params - Optional parameters (e.g. `{ guestId }` to scope to a specific guest).
      */
     addScriptingObject<SO extends AppObjects[keyof AppObjects]>(so: SO, params?: AddScriptingObjectParams): void;
     /**

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

@@ -42,11 +42,11 @@ export declare class GuestModule extends ScriptingObject implements IModule {
      * The App Bridge auto-binds this in openApp().
      * @param handler
      */
-    _setUnloadHandler(handler: () => Promise<void>): void;
-    getParameters(): Promise<ModuleParameters>;
-    getCapabilities(): Promise<Record<string, unknown>>;
-    log(message: LogMessage | string, logLevel: keyof typeof LogLevels): Promise<void>;
-    unload(): Promise<void>;
+    _setUnloadHandler: (handler: () => Promise<void>) => void;
+    getParameters: () => Promise<ModuleParameters>;
+    getCapabilities: () => Promise<Record<string, unknown>>;
+    log: (message: LogMessage | string, logLevel: keyof typeof LogLevels) => Promise<void>;
+    unload: () => Promise<void>;
 }
 /**
  * Optional method overrides the host can supply to customise
@@ -74,9 +74,13 @@ export type ModuleOverrides = {
  * Internally calls {@link buildModuleParams} to merge the app config
  * 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.
  * @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 addScriptingObject()
+ * @returns IModule scripting object ready for CMicroAppHost/CMicroApp.addScriptingObject()
  */
 export declare const createGuestModule: (guestId: string, params?: HostProvidedParams, overrides?: ModuleOverrides) => IModule;

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

@@ -127,6 +127,12 @@ export type MicroAppConfig = {
      * options for ssf based micro-frontend applications.
      */
     ssfAppOptions?: SSFAppOptions<Record<string, string | number | boolean>>;
+    /**
+     * When true the guest drives its own lifecycle via `initialize()` and
+     * the bridge skips calling `init()` / `mount()` on the guest.
+     * Set this in the `microFrontendApps` section of `app.config.json`.
+     */
+    selfInitialize?: boolean;
     /**
      * The Document object associated with the micro-frontend application.
      */

package/dist/types/lib/utils/window.d.ts

@@ -15,6 +15,7 @@ export type EMUI<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTy
     version: string;
     MicroAppHost?: IMicroFEHost<AppObjects, AppEvents> | IMicroAppHost | SSFGuest<AppObjects, AppEvents>;
     __host?: IMicroFEHost<AppObjects, AppEvents>;
+    getHost?: () => IMicroFEHost<AppObjects, AppEvents> | SSFGuest<AppObjects, AppEvents> | IMicroAppHost | null;
     logger?: Logger;
     logRocket?: typeof LogRocket;
     logRocketConfig?: {

package/dist/types/lib/view/tests/constants.d.ts

@@ -1,6 +1,7 @@
 export declare const LATEST_VERSION = "latest";
 export declare const RELEASE_VERSION = "23.1.0";
 export declare const LOAN_APP_ID = "loanapp";
+export declare const LOAN_SELF_INIT_APP_ID = "loanapp-selfinit";
 export declare const SSF_APP_ID = "ssfapp";
 export declare const TASK_APP_ID = "taskapp";
 export declare const FLIGHTS_APP_ID = "flights";