@elliemae/pui-app-sdk 5.40.5 → 5.41.0

package/demo/project.json

@@ -1 +1 @@
-{"generatedAt":1780087695087,"builder":{"name":"webpack5"},"hasCustomBabel":false,"hasCustomWebpack":true,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"pnpm","version":"8.15.9"},"typescriptOptions":{"check":false,"checkOptions":{},"reactDocgen":false,"reactDocgenTypescriptOptions":{"shouldExtractLiteralValuesFromEnum":true,"compilerOptions":{"allowSyntheticDefaultImports":false,"esModuleInterop":false}}},"features":{"fastRefresh":true,"storyStoreV7":true},"language":"javascript","storybookPackages":{},"framework":{"options":{"fastRefresh":true,"strictMode":true,"legacyRootApi":true}},"addons":{"@storybook/addon-docs":{"options":{"sourceLoaderOptions":{"injectStoryParameters":false}},"version":"6.5.16"},"@storybook/addon-essentials":{"options":{"docs":false},"version":"6.5.16"},"@storybook/addon-storysource":{"version":"6.5.16"},"@storybook/addon-links":{"version":"6.5.16"},"@storybook/addon-events":{"version":"6.2.9"},"@storybook/addon-interactions":{"version":"6.5.16"},"@storybook/addon-a11y":{"version":"6.5.16"},"storybook-addon-turbo-build":{"options":{"optimizationLevel":2,"esbuildMinifyOptions":{"target":"es2022"}},"version":"1.1.0"}}}
+{"generatedAt":1782148675244,"builder":{"name":"webpack5"},"hasCustomBabel":false,"hasCustomWebpack":true,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"pnpm","version":"8.15.9"},"typescriptOptions":{"check":false,"checkOptions":{},"reactDocgen":false,"reactDocgenTypescriptOptions":{"shouldExtractLiteralValuesFromEnum":true,"compilerOptions":{"allowSyntheticDefaultImports":false,"esModuleInterop":false}}},"features":{"fastRefresh":true,"storyStoreV7":true},"language":"javascript","storybookPackages":{},"framework":{"options":{"fastRefresh":true,"strictMode":true,"legacyRootApi":true}},"addons":{"@storybook/addon-docs":{"options":{"sourceLoaderOptions":{"injectStoryParameters":false}},"version":"6.5.16"},"@storybook/addon-essentials":{"options":{"docs":false},"version":"6.5.16"},"@storybook/addon-storysource":{"version":"6.5.16"},"@storybook/addon-links":{"version":"6.5.16"},"@storybook/addon-events":{"version":"6.2.9"},"@storybook/addon-interactions":{"version":"6.5.16"},"@storybook/addon-a11y":{"version":"6.5.16"},"storybook-addon-turbo-build":{"options":{"optimizationLevel":2,"esbuildMinifyOptions":{"target":"es2022"}},"version":"1.1.0"}}}

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

@@ -83,6 +83,7 @@ class CMicroAppGuest {
    */
   #useV2Guest;
   #selfInitialize;
+  #embeddedWithoutHost;
   /**
    * AppBridge instance
    */
@@ -97,7 +98,7 @@ class CMicroAppGuest {
   onMount;
   onUnmount;
   onGetRef;
-  // eslint-disable-next-line max-statements
+  // eslint-disable-next-line max-statements, complexity
   constructor(params) {
     window.emui.uuid = window.emui.uuid || (0, import_uuid.v4)();
     this.appId = window.emui?.appId || (0, import_config.getAppConfigValue)("appId");
@@ -118,10 +119,16 @@ class CMicroAppGuest {
     this.#ssfHostRef = (0, import_ssf_host2.getSSFHost)();
     this.#useV2Guest = params?.useV2Guest !== false;
     this.#selfInitialize = params?.selfInitialize ?? false;
+    this.#embeddedWithoutHost = params?.embeddedWithoutHost ?? false;
     this.onInit = params?.onInit;
     this.onMount = params?.onMount;
     this.onUnmount = params?.onUnmount;
     this.onGetRef = params?.onGetRef;
+    if (this.#embeddedWithoutHost && !this.#selfInitialize) {
+      this.logger.warn(
+        "embeddedWithoutHost requires selfInitialize: true \u2014 the flag only applies to initialize()"
+      );
+    }
     this.getHost = this.getHost.bind(this);
     this.getLogger = this.getLogger.bind(this);
     this.getProps = this.getProps.bind(this);
@@ -317,6 +324,10 @@ class CMicroAppGuest {
     if (window.emui?.__host) {
       return window.emui.__host;
     }
+    if (!isCrossDomain()) {
+      const legacyHost = window.parent?.emui?.MicroAppHost ?? null;
+      if (legacyHost) return legacyHost;
+    }
     if (this.#useV2Guest) {
       const ssfGuest = new import_ssf_guest.SSFGuest({ appLogger: this.logger });
       const failed = await (0, import_helpers.abortPromise)({
@@ -370,6 +381,33 @@ class CMicroAppGuest {
     const route = typeof params.initialRoute === "string" ? params.initialRoute : params.initialRoute.pathname;
     if (route) this.props.history.push(route);
   }
+  async #loadConfigAndBridge() {
+    await (0, import_app_config.loadAppConfig)();
+    await this.#initAppBridge();
+  }
+  #trackAnalyticsAndOnInit() {
+    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);
+  }
+  #completeWithoutHost(mode) {
+    if (mode === "standalone") {
+      this.logger.info("Running in standalone mode \u2014 skipping host discovery");
+      this.#exposeGetHost();
+      this.#resolveHistory();
+    } else if (mode === "embeddedWithoutHost") {
+      this.logger.info("embeddedWithoutHost enabled \u2014 skipping host discovery");
+      this.#exposeGetHost();
+    } else {
+      this.logger.warn(
+        "Unable to discover host. Proceeding with app.config.json values. Host-provided parameters (history, theme, initialRoute) will not be available."
+      );
+      this.#exposeGetHost();
+    }
+    this.#trackAnalyticsAndOnInit();
+    return { moduleId: this.appId };
+  }
   /**
    * Guest-initiated lifecycle: discovers the host and applies module
    * parameters if available. After this resolves the guest is ready to render.
@@ -385,20 +423,19 @@ class CMicroAppGuest {
     (0, import_webpack_public_path.syncWebpackPublicPathFromAssetPath)();
     const isStandalone = window.top === window.self && !window.opener;
     if (isStandalone) {
-      await (0, import_app_config.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 };
+      await this.#loadConfigAndBridge();
+      return this.#completeWithoutHost("standalone");
+    }
+    if (this.#embeddedWithoutHost) {
+      await this.#loadConfigAndBridge();
+      return this.#completeWithoutHost("embeddedWithoutHost");
     }
     const [host] = await Promise.all([
       this.#discoverHost(),
-      (0, import_app_config.loadAppConfig)().then(() => this.#initAppBridge())
+      this.#loadConfigAndBridge()
     ]);
     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)."
-      );
+      return this.#completeWithoutHost("discoveryFallback");
     }
     this.props.host = host;
     this.#exposeGetHost();
@@ -418,10 +455,7 @@ 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);
+    this.#trackAnalyticsAndOnInit();
     return params;
   }
   async init(options) {

package/dist/cjs/view/tests/scriptingObjects/loan.js

@@ -61,6 +61,10 @@ class Loan extends import_pui_app_bridge.ScriptingObject {
     name: "editmodechange",
     objectId: "loan"
   });
+  ExternallyModified = new import_pui_app_bridge.Event({
+    name: "externallyModified",
+    objectId: "loan"
+  });
   FieldChangeSync = new import_pui_app_bridge.Event({
     name: "fieldChangeSync",
     objectId: "loan"

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

@@ -50,6 +50,7 @@ class CMicroAppGuest {
    */
   #useV2Guest;
   #selfInitialize;
+  #embeddedWithoutHost;
   /**
    * AppBridge instance
    */
@@ -64,7 +65,7 @@ class CMicroAppGuest {
   onMount;
   onUnmount;
   onGetRef;
-  // eslint-disable-next-line max-statements
+  // eslint-disable-next-line max-statements, complexity
   constructor(params) {
     window.emui.uuid = window.emui.uuid || uuidv4();
     this.appId = window.emui?.appId || getAppConfigValue("appId");
@@ -85,10 +86,16 @@ class CMicroAppGuest {
     this.#ssfHostRef = getSSFHost();
     this.#useV2Guest = params?.useV2Guest !== false;
     this.#selfInitialize = params?.selfInitialize ?? false;
+    this.#embeddedWithoutHost = params?.embeddedWithoutHost ?? false;
     this.onInit = params?.onInit;
     this.onMount = params?.onMount;
     this.onUnmount = params?.onUnmount;
     this.onGetRef = params?.onGetRef;
+    if (this.#embeddedWithoutHost && !this.#selfInitialize) {
+      this.logger.warn(
+        "embeddedWithoutHost requires selfInitialize: true \u2014 the flag only applies to initialize()"
+      );
+    }
     this.getHost = this.getHost.bind(this);
     this.getLogger = this.getLogger.bind(this);
     this.getProps = this.getProps.bind(this);
@@ -284,6 +291,10 @@ class CMicroAppGuest {
     if (window.emui?.__host) {
       return window.emui.__host;
     }
+    if (!isCrossDomain()) {
+      const legacyHost = window.parent?.emui?.MicroAppHost ?? null;
+      if (legacyHost) return legacyHost;
+    }
     if (this.#useV2Guest) {
       const ssfGuest = new SSFGuest({ appLogger: this.logger });
       const failed = await abortPromise({
@@ -337,6 +348,33 @@ class CMicroAppGuest {
     const route = typeof params.initialRoute === "string" ? params.initialRoute : params.initialRoute.pathname;
     if (route) this.props.history.push(route);
   }
+  async #loadConfigAndBridge() {
+    await loadAppConfig();
+    await this.#initAppBridge();
+  }
+  #trackAnalyticsAndOnInit() {
+    const instanceId = this.getSessionStorageItem("instanceId") || "";
+    const userId = this.getSessionStorageItem("userId") || "";
+    updateBAEventParameters({ appId: this.appId, instanceId, userId });
+    if (this.onInit) this.onInit(this.props);
+  }
+  #completeWithoutHost(mode) {
+    if (mode === "standalone") {
+      this.logger.info("Running in standalone mode \u2014 skipping host discovery");
+      this.#exposeGetHost();
+      this.#resolveHistory();
+    } else if (mode === "embeddedWithoutHost") {
+      this.logger.info("embeddedWithoutHost enabled \u2014 skipping host discovery");
+      this.#exposeGetHost();
+    } else {
+      this.logger.warn(
+        "Unable to discover host. Proceeding with app.config.json values. Host-provided parameters (history, theme, initialRoute) will not be available."
+      );
+      this.#exposeGetHost();
+    }
+    this.#trackAnalyticsAndOnInit();
+    return { moduleId: this.appId };
+  }
   /**
    * Guest-initiated lifecycle: discovers the host and applies module
    * parameters if available. After this resolves the guest is ready to render.
@@ -352,20 +390,19 @@ class CMicroAppGuest {
     syncWebpackPublicPathFromAssetPath();
     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 };
+      await this.#loadConfigAndBridge();
+      return this.#completeWithoutHost("standalone");
+    }
+    if (this.#embeddedWithoutHost) {
+      await this.#loadConfigAndBridge();
+      return this.#completeWithoutHost("embeddedWithoutHost");
     }
     const [host] = await Promise.all([
       this.#discoverHost(),
-      loadAppConfig().then(() => this.#initAppBridge())
+      this.#loadConfigAndBridge()
     ]);
     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)."
-      );
+      return this.#completeWithoutHost("discoveryFallback");
     }
     this.props.host = host;
     this.#exposeGetHost();
@@ -385,10 +422,7 @@ 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);
+    this.#trackAnalyticsAndOnInit();
     return params;
   }
   async init(options) {

package/dist/esm/view/tests/scriptingObjects/loan.js

@@ -38,6 +38,10 @@ class Loan extends ScriptingObject {
     name: "editmodechange",
     objectId: "loan"
   });
+  ExternallyModified = new Event({
+    name: "externallyModified",
+    objectId: "loan"
+  });
   FieldChangeSync = new Event({
     name: "fieldChangeSync",
     objectId: "loan"

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

@@ -40,6 +40,12 @@ interface ConstructorParams {
      * the bridge will not call these methods.
      */
     selfInitialize?: boolean;
+    /**
+     * When true, the guest is embedded in an iframe but not hosted by PUI app
+     * bridge or SSF. Skips host discovery and initializes from app.config.json
+     * with in-memory history. Ignored when running standalone (top-level window).
+     */
+    embeddedWithoutHost?: boolean;
 }
 /**
  * Micro-frontend guest application class (singleton).

package/dist/types/lib/view/tests/scriptingObjects/loan.d.ts

@@ -8,6 +8,7 @@ export declare class Loan extends ScriptingObject implements ILoan {
     readonly Change: Event<Events>;
     readonly Committed: Event<Events>;
     readonly EditModeChange: Event<Events>;
+    readonly ExternallyModified: Event<Events>;
     readonly FieldChangeSync: Event<Events>;
     readonly MilestoneCompleted: Event<Events>;
     readonly Open: Event<Events>;