@elliemae/pui-app-sdk 5.43.0 → 5.44.1

package/demo/{main.45c6548c9a377d9f942a.manager.bundle.js → main.e50da2045dbe0d31db54.manager.bundle.js}

@@ -1 +1 @@
-(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[792],{11792(i,t,o){"use strict";var p=o(59443),m=o(96778),v=Object.defineProperty,l=Object.getOwnPropertySymbols,s=Object.prototype.hasOwnProperty,_=Object.prototype.propertyIsEnumerable,f=(e,a,r)=>a in e?v(e,a,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[a]=r,b=(e,a)=>{for(var r in a||(a={}))s.call(a,r)&&f(e,r,a[r]);if(l)for(var r of l(a))_.call(a,r)&&f(e,r,a[r]);return e},d=(e,a)=>{var r={};for(var n in e)s.call(e,n)&&a.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&l)for(var n of l(e))a.indexOf(n)<0&&_.call(e,n)&&(r[n]=e[n]);return r};const h=e=>{var a=e,{base:r="light",brandTitle:n="Platform UI Components"}=a,u=d(a,["base","brandTitle"]);return(0,m.vt)(b({base:r,brandTitle:`${n} v5.43.0`},u))};(e=>{p.MC.setConfig({panelPosition:"bottom",theme:h(e)})})({brandTitle:"Application SDK",brandUrl:"https://git.elliemae.io/platform-ui/pui-app-sdk.git"})},22179(){}},i=>{var t=p=>i(i.s=p);i.O(0,[659],()=>(t(54176),t(11792),t(68082),t(34023),t(72247),t(40652),t(41420),t(48510),t(75963),t(4547),t(15869),t(74157),t(28061),t(99789),t(40166),t(29923)));var o=i.O()}]);
+(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[792],{11792(i,t,o){"use strict";var p=o(59443),m=o(96778),v=Object.defineProperty,l=Object.getOwnPropertySymbols,s=Object.prototype.hasOwnProperty,_=Object.prototype.propertyIsEnumerable,f=(e,a,r)=>a in e?v(e,a,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[a]=r,b=(e,a)=>{for(var r in a||(a={}))s.call(a,r)&&f(e,r,a[r]);if(l)for(var r of l(a))_.call(a,r)&&f(e,r,a[r]);return e},d=(e,a)=>{var r={};for(var n in e)s.call(e,n)&&a.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&l)for(var n of l(e))a.indexOf(n)<0&&_.call(e,n)&&(r[n]=e[n]);return r};const h=e=>{var a=e,{base:r="light",brandTitle:n="Platform UI Components"}=a,u=d(a,["base","brandTitle"]);return(0,m.vt)(b({base:r,brandTitle:`${n} v5.44.1`},u))};(e=>{p.MC.setConfig({panelPosition:"bottom",theme:h(e)})})({brandTitle:"Application SDK",brandUrl:"https://git.elliemae.io/platform-ui/pui-app-sdk.git"})},22179(){}},i=>{var t=p=>i(i.s=p);i.O(0,[659],()=>(t(54176),t(11792),t(68082),t(34023),t(72247),t(40652),t(41420),t(48510),t(75963),t(4547),t(15869),t(74157),t(28061),t(99789),t(40166),t(29923)));var o=i.O()}]);

package/demo/project.json

@@ -1 +1 @@
-{"generatedAt":1784844182384,"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":1784919464096,"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

@@ -49,6 +49,7 @@ var import_ssf_host2 = require("./ssf-host.js");
 var import_webpack_public_path = require("./webpack-public-path.js");
 const DEFAULT_CONTAINER_ID = "app-container";
 const MODULE_SCRIPTING_OBJECT_TIMEOUT_MS = 2e3;
+const SSF_CONNECT_TIMEOUT_MS = 1e3;
 const isCrossDomain = () => {
   try {
     window.parent.document;
@@ -224,11 +225,20 @@ class CMicroAppGuest {
     const browserWindow = (0, import_window.getWindow)();
     if (!browserWindow) return;
     browserWindow.emui = browserWindow.emui || {};
+    const performUnmount = this.unmount.bind(this);
     const app = {
       uuid: this.#uuid,
       init: this.init.bind(this),
       mount: this.mount.bind(this),
-      unmount: this.unmount.bind(this),
+      unmount: (options) => {
+        if (options?.containerId) {
+          this.props.containerId = options.containerId;
+        }
+        if (this.props.host) {
+          return this.#internalTeardown().then(() => null);
+        }
+        return performUnmount(options);
+      },
       getRef: this.getRef.bind(this),
       navigate: this.navigate.bind(this)
     };
@@ -257,23 +267,36 @@ class CMicroAppGuest {
     window.emui.app = app;
     window.addEventListener("beforeunload", this.#boundOnWindowUnload);
   }
+  /**
+   * Removes legacy registerApp entries from the parent window and current window.
+   */
+  #removeLegacyGlobalRegistration() {
+    if (this.#selfInitialize) return;
+    const browserWindow = (0, import_window.getWindow)();
+    if (!browserWindow?.emui) return;
+    if (Array.isArray(browserWindow.emui[this.appId])) {
+      const existingApps = browserWindow.emui[this.appId];
+      const index = existingApps.findIndex((app) => app.uuid === this.#uuid);
+      if (index > -1) existingApps.splice(index, 1);
+      if (existingApps.length === 0) {
+        delete browserWindow.emui[this.appId];
+      }
+    } else {
+      delete browserWindow.emui[this.appId];
+    }
+    delete window.emui.app;
+  }
   /**
    * remove the microapp from the global variable from the parent window and current window
    */
   #onWindowUnload() {
+    if (this.props.host) {
+      this.#internalTeardown().catch(() => {
+      });
+      return;
+    }
     if (!this.#selfInitialize) {
-      const browserWindow = (0, import_window.getWindow)();
-      if (Array.isArray(browserWindow.emui[this.appId])) {
-        const existingApps = browserWindow.emui[this.appId];
-        const index = existingApps.findIndex((app) => app.uuid === this.#uuid);
-        if (index > -1) existingApps.splice(index, 1);
-        if (existingApps.length === 0) {
-          delete browserWindow.emui[this.appId];
-        }
-      } else {
-        delete browserWindow.emui[this.appId];
-      }
-      delete window.emui.app;
+      this.#removeLegacyGlobalRegistration();
       this.unmount({ containerId: this.props.containerId }).catch(() => {
       });
       return;
@@ -289,22 +312,31 @@ class CMicroAppGuest {
     }
     return value;
   }
-  async findHost() {
-    let host = null;
-    if (!isCrossDomain()) {
-      host = window.parent?.emui?.MicroAppHost ?? null;
-    }
-    if (!host && this.#useV2Guest) {
-      host = new import_ssf_guest.SSFGuest({ appLogger: this.logger });
-      if (await (0, import_helpers.abortPromise)({
-        promise: host.connect(),
-        delay: 1e3,
-        retValue: false
-      })) {
-        host = null;
-      } else this.#communicationMethod = "ssf" /* SSF */;
+  #getLegacyParentHost() {
+    if (isCrossDomain()) return null;
+    return window.parent?.emui?.MicroAppHost ?? null;
+  }
+  async #tryConnectSSFGuest() {
+    const ssfGuest = new import_ssf_guest.SSFGuest({ appLogger: this.logger });
+    try {
+      const failed = await (0, import_helpers.abortPromise)({
+        promise: ssfGuest.connect(),
+        delay: SSF_CONNECT_TIMEOUT_MS,
+        retValue: true
+      });
+      if (!failed) {
+        this.#communicationMethod = "ssf" /* SSF */;
+        return ssfGuest;
+      }
+    } catch {
     }
-    return host;
+    return null;
+  }
+  async findHost() {
+    const legacyHost = this.#getLegacyParentHost();
+    if (legacyHost) return legacyHost;
+    if (!this.#useV2Guest) return null;
+    return this.#tryConnectSSFGuest();
   }
   get uuid() {
     return this.#uuid;
@@ -340,23 +372,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)({
-        promise: ssfGuest.connect(),
-        delay: 1e3,
-        retValue: true
-      });
-      if (!failed) {
-        this.#communicationMethod = "ssf" /* SSF */;
-        return ssfGuest;
-      }
-    }
-    return null;
+    const legacyHost = this.#getLegacyParentHost();
+    if (legacyHost) return legacyHost;
+    if (!this.#useV2Guest) return null;
+    return this.#tryConnectSSFGuest();
   }
   #exposeGetHost() {
     window.emui = window.emui || {};
@@ -413,9 +432,13 @@ class CMicroAppGuest {
    */
   #internalTeardown() {
     if (!this.#hostTeardownPromise) {
-      this.#hostTeardownPromise = this.unmount({
-        containerId: this.props.containerId
-      }).then(() => {
+      this.#hostTeardownPromise = Promise.resolve().then(() => {
+        this.#removeLegacyGlobalRegistration();
+      }).then(
+        () => this.unmount({
+          containerId: this.props.containerId
+        })
+      ).then(() => {
         this.#unbindModuleUnmountListener();
       }).catch((err) => {
         this.#hostTeardownPromise = null;
@@ -425,16 +448,22 @@ class CMicroAppGuest {
     return this.#hostTeardownPromise;
   }
   /**
-   * Self-init guests subscribe to `module.unmount` so the host can signal
-   * SDK teardown after the `module.unloading` veto phase.
+   * Hosted guests subscribe to `module.unmount` so the host can signal SDK
+   * teardown after the `module.unloading` veto phase (SSF always; App Bridge
+   * when selfInitialize is true).
    */
   #bindModuleUnmountListener() {
-    if (!this.#selfInitialize || this.#moduleUnmountSubToken || !this.props.host)
-      return;
-    this.#moduleUnmountSubToken = this.subscribe({
-      eventId: MODULE_UNMOUNT_EVENT_ID,
-      callback: this.#handleModuleUnmount
-    });
+    if (this.#moduleUnmountSubToken || !this.props.host) return;
+    try {
+      this.#moduleUnmountSubToken = this.subscribe({
+        eventId: MODULE_UNMOUNT_EVENT_ID,
+        callback: this.#handleModuleUnmount
+      });
+    } catch {
+      this.logger.warn(
+        "Unable to subscribe to module.unmount from host \u2014 continuing without host teardown listener"
+      );
+    }
   }
   #unbindModuleUnmountListener() {
     if (!this.#moduleUnmountSubToken) return;
@@ -549,6 +578,7 @@ class CMicroAppGuest {
       return (0, import_app_bridge.getAppBridge)().then((appBridge) => {
         this.#appBridge = appBridge;
         if (this.onInit) this.onInit(this.props);
+        this.#bindModuleUnmountListener();
       });
     });
   }

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

@@ -21,18 +21,7 @@ exports[`CMicroAppGuest - Standalone calls onInit 1`] = `
     "push": [Function],
     "replace": [Function],
   },
-  "host": SSFGuest {
-    "addScript": [Function],
-    "close": [Function],
-    "connect": [Function],
-    "getAuthToken": [Function],
-    "getObject": [Function],
-    "listObjects": [Function],
-    "removeScript": [Function],
-    "setLogLevel": [Function],
-    "subscribe": [Function],
-    "unsubscribe": [Function],
-  },
+  "host": null,
   "hostUrl": null,
   "manifestPath": "./latest",
   "prevState": null,

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

@@ -16,6 +16,7 @@ import { getSSFHost, setSSFHost } from "./ssf-host.js";
 import { syncWebpackPublicPathFromAssetPath } from "./webpack-public-path.js";
 const DEFAULT_CONTAINER_ID = "app-container";
 const MODULE_SCRIPTING_OBJECT_TIMEOUT_MS = 2e3;
+const SSF_CONNECT_TIMEOUT_MS = 1e3;
 const isCrossDomain = () => {
   try {
     window.parent.document;
@@ -191,11 +192,20 @@ class CMicroAppGuest {
     const browserWindow = getWindow();
     if (!browserWindow) return;
     browserWindow.emui = browserWindow.emui || {};
+    const performUnmount = this.unmount.bind(this);
     const app = {
       uuid: this.#uuid,
       init: this.init.bind(this),
       mount: this.mount.bind(this),
-      unmount: this.unmount.bind(this),
+      unmount: (options) => {
+        if (options?.containerId) {
+          this.props.containerId = options.containerId;
+        }
+        if (this.props.host) {
+          return this.#internalTeardown().then(() => null);
+        }
+        return performUnmount(options);
+      },
       getRef: this.getRef.bind(this),
       navigate: this.navigate.bind(this)
     };
@@ -224,23 +234,36 @@ class CMicroAppGuest {
     window.emui.app = app;
     window.addEventListener("beforeunload", this.#boundOnWindowUnload);
   }
+  /**
+   * Removes legacy registerApp entries from the parent window and current window.
+   */
+  #removeLegacyGlobalRegistration() {
+    if (this.#selfInitialize) return;
+    const browserWindow = getWindow();
+    if (!browserWindow?.emui) return;
+    if (Array.isArray(browserWindow.emui[this.appId])) {
+      const existingApps = browserWindow.emui[this.appId];
+      const index = existingApps.findIndex((app) => app.uuid === this.#uuid);
+      if (index > -1) existingApps.splice(index, 1);
+      if (existingApps.length === 0) {
+        delete browserWindow.emui[this.appId];
+      }
+    } else {
+      delete browserWindow.emui[this.appId];
+    }
+    delete window.emui.app;
+  }
   /**
    * remove the microapp from the global variable from the parent window and current window
    */
   #onWindowUnload() {
+    if (this.props.host) {
+      this.#internalTeardown().catch(() => {
+      });
+      return;
+    }
     if (!this.#selfInitialize) {
-      const browserWindow = getWindow();
-      if (Array.isArray(browserWindow.emui[this.appId])) {
-        const existingApps = browserWindow.emui[this.appId];
-        const index = existingApps.findIndex((app) => app.uuid === this.#uuid);
-        if (index > -1) existingApps.splice(index, 1);
-        if (existingApps.length === 0) {
-          delete browserWindow.emui[this.appId];
-        }
-      } else {
-        delete browserWindow.emui[this.appId];
-      }
-      delete window.emui.app;
+      this.#removeLegacyGlobalRegistration();
       this.unmount({ containerId: this.props.containerId }).catch(() => {
       });
       return;
@@ -256,22 +279,31 @@ class CMicroAppGuest {
     }
     return value;
   }
-  async findHost() {
-    let host = null;
-    if (!isCrossDomain()) {
-      host = window.parent?.emui?.MicroAppHost ?? null;
-    }
-    if (!host && this.#useV2Guest) {
-      host = new SSFGuest({ appLogger: this.logger });
-      if (await abortPromise({
-        promise: host.connect(),
-        delay: 1e3,
-        retValue: false
-      })) {
-        host = null;
-      } else this.#communicationMethod = "ssf" /* SSF */;
+  #getLegacyParentHost() {
+    if (isCrossDomain()) return null;
+    return window.parent?.emui?.MicroAppHost ?? null;
+  }
+  async #tryConnectSSFGuest() {
+    const ssfGuest = new SSFGuest({ appLogger: this.logger });
+    try {
+      const failed = await abortPromise({
+        promise: ssfGuest.connect(),
+        delay: SSF_CONNECT_TIMEOUT_MS,
+        retValue: true
+      });
+      if (!failed) {
+        this.#communicationMethod = "ssf" /* SSF */;
+        return ssfGuest;
+      }
+    } catch {
     }
-    return host;
+    return null;
+  }
+  async findHost() {
+    const legacyHost = this.#getLegacyParentHost();
+    if (legacyHost) return legacyHost;
+    if (!this.#useV2Guest) return null;
+    return this.#tryConnectSSFGuest();
   }
   get uuid() {
     return this.#uuid;
@@ -307,23 +339,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({
-        promise: ssfGuest.connect(),
-        delay: 1e3,
-        retValue: true
-      });
-      if (!failed) {
-        this.#communicationMethod = "ssf" /* SSF */;
-        return ssfGuest;
-      }
-    }
-    return null;
+    const legacyHost = this.#getLegacyParentHost();
+    if (legacyHost) return legacyHost;
+    if (!this.#useV2Guest) return null;
+    return this.#tryConnectSSFGuest();
   }
   #exposeGetHost() {
     window.emui = window.emui || {};
@@ -380,9 +399,13 @@ class CMicroAppGuest {
    */
   #internalTeardown() {
     if (!this.#hostTeardownPromise) {
-      this.#hostTeardownPromise = this.unmount({
-        containerId: this.props.containerId
-      }).then(() => {
+      this.#hostTeardownPromise = Promise.resolve().then(() => {
+        this.#removeLegacyGlobalRegistration();
+      }).then(
+        () => this.unmount({
+          containerId: this.props.containerId
+        })
+      ).then(() => {
         this.#unbindModuleUnmountListener();
       }).catch((err) => {
         this.#hostTeardownPromise = null;
@@ -392,16 +415,22 @@ class CMicroAppGuest {
     return this.#hostTeardownPromise;
   }
   /**
-   * Self-init guests subscribe to `module.unmount` so the host can signal
-   * SDK teardown after the `module.unloading` veto phase.
+   * Hosted guests subscribe to `module.unmount` so the host can signal SDK
+   * teardown after the `module.unloading` veto phase (SSF always; App Bridge
+   * when selfInitialize is true).
    */
   #bindModuleUnmountListener() {
-    if (!this.#selfInitialize || this.#moduleUnmountSubToken || !this.props.host)
-      return;
-    this.#moduleUnmountSubToken = this.subscribe({
-      eventId: MODULE_UNMOUNT_EVENT_ID,
-      callback: this.#handleModuleUnmount
-    });
+    if (this.#moduleUnmountSubToken || !this.props.host) return;
+    try {
+      this.#moduleUnmountSubToken = this.subscribe({
+        eventId: MODULE_UNMOUNT_EVENT_ID,
+        callback: this.#handleModuleUnmount
+      });
+    } catch {
+      this.logger.warn(
+        "Unable to subscribe to module.unmount from host \u2014 continuing without host teardown listener"
+      );
+    }
   }
   #unbindModuleUnmountListener() {
     if (!this.#moduleUnmountSubToken) return;
@@ -516,6 +545,7 @@ class CMicroAppGuest {
       return getAppBridge().then((appBridge) => {
         this.#appBridge = appBridge;
         if (this.onInit) this.onInit(this.props);
+        this.#bindModuleUnmountListener();
       });
     });
   }

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

@@ -21,18 +21,7 @@ exports[`CMicroAppGuest - Standalone calls onInit 1`] = `
     "push": [Function],
     "replace": [Function],
   },
-  "host": SSFGuest {
-    "addScript": [Function],
-    "close": [Function],
-    "connect": [Function],
-    "getAuthToken": [Function],
-    "getObject": [Function],
-    "listObjects": [Function],
-    "removeScript": [Function],
-    "setLogLevel": [Function],
-    "subscribe": [Function],
-    "unsubscribe": [Function],
-  },
+  "host": null,
   "hostUrl": null,
   "manifestPath": "./latest",
   "prevState": null,