@elliemae/pui-app-sdk 5.40.0-beta.2 → 5.40.0-beta.4

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

@@ -445,9 +445,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/cjs/utils/micro-frontend/host.js

@@ -51,6 +51,7 @@ class CMicroAppHost {
   scriptingObjects;
   #ssfHostRef;
   #appBridge = null;
+  #selfInitialize;
   // eslint-disable-next-line max-statements
   constructor(params) {
     this.appId = (0, import_config.getAppConfigValue)("appId");
@@ -58,6 +59,7 @@ class CMicroAppHost {
     this.logger = params?.logger || import_console_logger.consoleLogger;
     (0, import_logger.setLogger)(this.logger);
     this.onRenewSessionTimer = params?.onRenewSessionTimer;
+    this.#selfInitialize = params?.selfInitialize ?? false;
     this.props = {
       systemVersion: params?.version ?? "latest",
       history: params?.history ?? import_history2.browserHistory,
@@ -89,15 +91,17 @@ class CMicroAppHost {
         leading: true
       }
     );
-    (0, import_app_config.loadAppConfig)().then(() => {
-      (0, import_app_bridge.getAppBridge)().then((appBridge) => {
-        this.#appBridge = appBridge;
-        if (this.onInit) this.onInit(this.props);
-      }).catch((ex) => {
-        throw ex;
+    if (!this.#selfInitialize) {
+      (0, import_app_config.loadAppConfig)().then(() => {
+        (0, import_app_bridge.getAppBridge)().then((appBridge) => {
+          this.#appBridge = appBridge;
+          if (this.onInit) this.onInit(this.props);
+        }).catch((ex) => {
+          throw ex;
+        });
+      }).catch(() => {
       });
-    }).catch(() => {
-    });
+    }
     (0, import_pui_analytics_so.updateBAEventParameters)({ appId: this.appId });
   }
   static getInstance(params) {
@@ -109,6 +113,19 @@ class CMicroAppHost {
   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() {
+    await (0, import_app_config.loadAppConfig)();
+    const appBridge = await (0, import_app_bridge.getAppBridge)();
+    this.#appBridge = appBridge;
+    if (this.onInit) this.onInit(this.props);
+    return this.props;
+  }
   getProps() {
     return this.props;
   }
@@ -197,9 +214,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/cjs/utils/micro-frontend/module-so.js

@@ -65,13 +65,9 @@ class GuestModule extends import_ssf_host.ScriptingObject {
   _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;
@@ -79,11 +75,11 @@ class GuestModule extends import_ssf_host.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/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

@@ -412,9 +412,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,15 +76,17 @@ 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) {
@@ -94,6 +98,19 @@ class CMicroAppHost {
   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() {
+    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 +199,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

@@ -40,13 +40,9 @@ class GuestModule extends ScriptingObject {
   _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 +50,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/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

@@ -112,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

@@ -43,10 +43,10 @@ export declare class GuestModule extends ScriptingObject implements IModule {
      * @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>;
+    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;