@elliemae/pui-app-sdk 5.21.1 → 5.22.0-beta.1

package/dist/cjs/analytics/index.js

@@ -38,7 +38,8 @@ const sendBAEvent = ({
   self = true
 }) => {
   if (!self) {
-    const sendEvent = import_guest.CMicroAppGuest.getInstance()?.getHost()?.sendBAEvent;
+    const host = import_guest.CMicroAppGuest.getInstance()?.getHost();
+    const sendEvent = host?.sendBAEvent;
     if (sendEvent) {
       sendEvent(data);
     } else {

package/dist/cjs/index.js

@@ -32,6 +32,7 @@ __export(index_exports, {
   Analytics: () => import_analytics2.Analytics,
   AppRoot: () => import_app_root.AppRoot,
   Autocomplete: () => import_autocomplete.Autocomplete,
+  CMicroApp: () => import_guest.CMicroAppGuest,
   CMicroAppGuest: () => import_guest.CMicroAppGuest,
   CMicroAppHost: () => import_host.CMicroAppHost,
   CheckBox: () => import_check_box.CheckBox,
@@ -48,6 +49,7 @@ __export(index_exports, {
   FormItemLayout: () => import_form_item_layout.FormItemLayout,
   FormLayoutBlockItem: () => import_form_layout_block_item.FormLayoutBlockItem,
   FormSubmitButton: () => import_submit_button.FormSubmitButton,
+  GuestMicroApp: () => import_guest_microapp.GuestMicroApp,
   InputMask: () => import_input_mask.InputMask,
   InputText: () => import_input_text.InputText,
   LargeTextBox: () => import_large_text_box.LargeTextBox,
@@ -233,6 +235,7 @@ var import_live_message = require("./data/live-message/index.js");
 var import_error = require("./data/error/index.js");
 var import_actions4 = require("./data/logout/actions.js");
 var import_micro_app = require("./view/micro-app/index.js");
+var import_guest_microapp = require("./view/guest-microapp.js");
 var import_micro_iframe_app = require("./view/micro-iframe-app/index.js");
 var import_utils = require("./view/micro-app/utils.js");
 var import_store3 = require("./data/store.js");

package/dist/cjs/utils/micro-frontend/app-bridge.js

@@ -0,0 +1,40 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var app_bridge_exports = {};
+__export(app_bridge_exports, {
+  getAppBridge: () => getAppBridge
+});
+module.exports = __toCommonJS(app_bridge_exports);
+var import_pui_app_bridge = require("@elliemae/pui-app-bridge");
+var import_logger = require("../logger.js");
+var import_analytics = require("./scripting-objects/analytics.js");
+let appBridge = null;
+const getAppBridge = async () => {
+  if (!appBridge) {
+    const logger = (0, import_logger.getLogger)();
+    const version = window.emui?.version || "latest";
+    appBridge = new import_pui_app_bridge.CAppBridge({
+      logger,
+      version
+    });
+    await appBridge.init();
+    appBridge.addScriptingObject(new import_analytics.Analytics({ logger }));
+  }
+  return appBridge;
+};

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

@@ -34,6 +34,7 @@ module.exports = __toCommonJS(guest_exports);
 var import_lodash = __toESM(require("lodash"));
 var import_uuid = require("uuid");
 var import_pui_theme = require("@elliemae/pui-theme");
+var import_ssf_guest = require("@elliemae/ssf-guest");
 var import_window = require("../window.js");
 var import_app_config = require("../app-config/index.js");
 var import_config = require("../app-config/config.js");
@@ -43,8 +44,7 @@ var import_logger = require("../logger.js");
 var import_web_storage = require("../web-storage.js");
 var import_web_analytics = require("./scripting-objects/web-analytics.js");
 var import_appdynamics = require("../../analytics/appdynamics.js");
-var import_ssfguest_adapter = require("./ssfguest-adapter.js");
-var import_host_app = require("./host-app.js");
+var import_app_bridge = require("./app-bridge.js");
 const isCrossDomain = () => {
   try {
     window.parent.document;
@@ -53,6 +53,11 @@ const isCrossDomain = () => {
     return true;
   }
 };
+var CommunicationMethod = /* @__PURE__ */ ((CommunicationMethod2) => {
+  CommunicationMethod2["SSF"] = "ssf";
+  CommunicationMethod2["APPSDK"] = "app-sdk";
+  return CommunicationMethod2;
+})(CommunicationMethod || {});
 class CMicroAppGuest {
   /**
    * unique microapp id
@@ -63,6 +68,14 @@ class CMicroAppGuest {
   appId;
   props;
   containerId;
+  /**
+   * communication method used between microapps
+   */
+  #communicationMethod;
+  /**
+   * AppBridge instance
+   */
+  #appBridge = null;
   onInit;
   onMount;
   onUnmount;
@@ -73,6 +86,7 @@ class CMicroAppGuest {
     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;
+    this.#communicationMethod = "app-sdk" /* APPSDK */;
     this.props = {
       host: null,
       hostUrl: null,
@@ -94,7 +108,7 @@ class CMicroAppGuest {
   }
   static getInstance(params) {
     if (!this.instance) {
-      this.instance = new this(params);
+      this.instance = new CMicroAppGuest(params);
     }
     return this.instance;
   }
@@ -110,6 +124,46 @@ class CMicroAppGuest {
   getLogger() {
     return this.logger;
   }
+  getObject(objectId) {
+    let host = null;
+    if (this.#communicationMethod === "ssf" /* SSF */) {
+      host = this.getHost();
+      return host.getObject(objectId);
+    }
+    host = this.getHost();
+    if (!host) return Promise.resolve(null);
+    return host.getObject(objectId);
+  }
+  /**
+   * subscribe to the scripting object event
+   * @param {SubscribeParam<EventId, AppEvents[EventId]>} params - the parameters for the subscription
+   * @param {string} params.soName - the name of the scripting object
+   * @param {string} params.eventName - the name of the event
+   * @param {Function} params.callback - the callback function to be called when the event is triggered
+   * @returns {void}
+   */
+  subscribe(params) {
+    let host = null;
+    if (this.#communicationMethod === "ssf" /* SSF */) {
+      host = this.getHost();
+      return host.subscribe(params);
+    }
+    host = this.getHost();
+    return host.subscribe(params);
+  }
+  /**
+   * unsubscribe from the scripting object event
+   * @param params - parameters for the unsubscription
+   */
+  unsubscribe(params) {
+    let host = null;
+    if (this.#communicationMethod === "ssf" /* SSF */) {
+      host = this.getHost();
+      host.unsubscribe(params);
+    }
+    host = this.getHost();
+    host.unsubscribe(params);
+  }
   getProps() {
     return this.props;
   }
@@ -174,21 +228,22 @@ class CMicroAppGuest {
   }
   getSessionStorageItem(key) {
     let value = sessionStorage.getItem(key);
-    if (!value && this.props.host?.getItem) {
-      value = this.props.host.getItem(key);
+    const host = this.getHost();
+    if (!value && host?.getItem) {
+      value = host.getItem(key);
     }
     return value;
   }
-  async getSSFAdapter() {
+  async findHost() {
     let host = null;
     if (window.parent !== window) {
       if (!isCrossDomain()) {
-        host = window.parent?.emui?.MicroAppHost || null;
+        host = window.parent?.emui?.MicroAppHost ?? null;
       }
       if (!host) {
-        const ssfAdapter = new import_ssfguest_adapter.SSFGuestAdapter();
-        if (!await ssfAdapter.init()) return null;
-        host = ssfAdapter;
+        host = new import_ssf_guest.SSFGuest({ appLogger: this.logger });
+        await host.connect();
+        this.#communicationMethod = "ssf" /* SSF */;
       }
     }
     return host;
@@ -200,17 +255,21 @@ class CMicroAppGuest {
     this.props = import_lodash.default.merge(this.props, options);
     this.props.history = options?.history || this.props.history;
     if (!this.props.host) {
-      const host = await this.getSSFAdapter();
-      if (host) this.props.host = host;
+      const host = await this.findHost();
+      if (host) {
+        this.props.host = host;
+      }
     }
-    if (this.props.host) (0, import_host_app.setHostApp)(this.props.host);
     __webpack_public_path__ = __webpack_public_path__.replace(/\/?$/, "/");
     return (0, import_app_config.loadAppConfig)().then(() => {
       const instanceId = this.getSessionStorageItem("instanceId") || "";
       const userId = this.getSessionStorageItem("userId") || "";
       (0, import_web_analytics.updateBAEventParameters)({ appId: this.appId, instanceId, userId });
       (0, import_appdynamics.setAppDynamicsUserData)({ appId: this.appId, instanceId, userId });
-      if (this.onInit) this.onInit(this.props);
+      return (0, import_app_bridge.getAppBridge)().then((appBridge) => {
+        this.#appBridge = appBridge;
+        if (this.onInit) this.onInit(this.props);
+      });
     });
   }
   mount(options = { containerId: "app-container" }) {
@@ -231,4 +290,32 @@ class CMicroAppGuest {
   navigate(url, state) {
     if (url) this.props.history.push(url, state);
   }
+  /**
+   * add scripting object for child microapp to use
+   * @param so - The scripting object to be added.
+   * @param params - Optional parameters for adding the scripting object.
+   */
+  addScriptingObject(so, params) {
+    if (this.#appBridge) {
+      this.#appBridge.addScriptingObject(so, params);
+    }
+  }
+  /**
+   * dispatch event to child microapp
+   * @param {DispatchEventParams<EventId, Params>} params - event parameters
+   */
+  async dispatchEvent(params) {
+    if (this.#appBridge) {
+      await this.#appBridge.dispatchEvent(params);
+    }
+  }
+  /**
+   * removes scripting object from child microapp use
+   * @param objectId unique id of the scripting object
+   */
+  removeScriptingObject(objectId) {
+    if (this.#appBridge) {
+      this.#appBridge.removeScriptingObject(objectId);
+    }
+  }
 }

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

@@ -39,7 +39,7 @@ var import_appdynamics = require("../../analytics/appdynamics.js");
 var import_analytics = require("./scripting-objects/analytics.js");
 var import_web_analytics = require("./scripting-objects/web-analytics.js");
 var import_session = require("../session.js");
-var import_host_app = require("./host-app.js");
+var import_app_bridge = require("./app-bridge.js");
 class CMicroAppHost {
   static instance;
   logger;
@@ -51,6 +51,7 @@ class CMicroAppHost {
   throttleRenewSessionTimer;
   scriptingObjects;
   #ssfHostRef;
+  #appBridge = null;
   // eslint-disable-next-line max-statements
   constructor(params) {
     this.appId = (0, import_config.getAppConfigValue)("appId");
@@ -91,6 +92,11 @@ class CMicroAppHost {
       }
     );
     (0, import_app_config.loadAppConfig)().then(() => {
+      (0, import_app_bridge.getAppBridge)().then((appBridge) => {
+        this.#appBridge = appBridge;
+      }).catch((ex) => {
+        throw ex;
+      });
       if (this.onInit) this.onInit(this.props);
     }).catch(() => {
     });
@@ -101,8 +107,7 @@ class CMicroAppHost {
   }
   static getInstance(params) {
     if (!this.instance) {
-      this.instance = new this(params);
-      (0, import_host_app.setHostApp)(this.instance);
+      this.instance = new CMicroAppHost(params);
     }
     return this.instance;
   }
@@ -196,4 +201,32 @@ class CMicroAppHost {
   async getObject(name) {
     return this.scriptingObjects[name];
   }
+  /**
+   * add scripting object for child microapp to use
+   * @param so - The scripting object to be added.
+   * @param params - Optional parameters for adding the scripting object.
+   */
+  addScriptingObject(so, params) {
+    if (this.#appBridge) {
+      this.#appBridge.addScriptingObject(so, params);
+    }
+  }
+  /**
+   * dispatch event to child microapp
+   * @param {DispatchEventParams<EventId, Params>} params - event parameters
+   */
+  async dispatchEvent(params) {
+    if (this.#appBridge) {
+      await this.#appBridge.dispatchEvent(params);
+    }
+  }
+  /**
+   * removes scripting object from child microapp use
+   * @param objectId unique id of the scripting object
+   */
+  removeScriptingObject(objectId) {
+    if (this.#appBridge) {
+      this.#appBridge.removeScriptingObject(objectId);
+    }
+  }
 }

package/dist/cjs/utils/micro-frontend/scripting-objects/analytics.js

@@ -1,9 +1,7 @@
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -17,25 +15,17 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var analytics_exports = {};
 __export(analytics_exports, {
   Analytics: () => Analytics
 });
 module.exports = __toCommonJS(analytics_exports);
-var import_em_ssf_host = __toESM(require("@elliemae/em-ssf-host"));
+var import_ssf_host = require("@elliemae/ssf-host");
 var import_web_analytics = require("./web-analytics.js");
 var import_helpers = require("../../helpers.js");
 var import_headSampler = require("../../headSampler.js");
-class Analytics extends import_em_ssf_host.default.ScriptingObject {
+class Analytics extends import_ssf_host.ScriptingObject {
   /**
    * logger instance
    */

package/dist/cjs/utils/micro-frontend/tests/app.config.json

@@ -0,0 +1,200 @@
+{
+  "appId": "microfe",
+  "activeEnv": "localhost",
+  "googleTagManager": true,
+  "sessionTimeoutWarnInterval": "7200000",
+  "sessionTimeoutInterval": "9000000",
+  "microFrontendApps": {
+    "loanapp": {
+      "name": "Loan",
+      "hostUrl": "./loan",
+      "development": {
+        "files": ["index.js"]
+      },
+      "production": {
+        "files": ["index.js"]
+      }
+    },
+    "taskapp": {
+      "name": "Task",
+      "hostUrl": "./task",
+      "mode": "development",
+      "development": {
+        "files": ["index.dev.js"]
+      },
+      "production": {
+        "files": ["index.js"]
+      }
+    },
+    "travelhub": {
+      "name": "TravelHub",
+      "hostUrl": "./travelhub",
+      "development": {
+        "files": ["app.js", "landing.js", "app.css", "landing.css"]
+      },
+      "production": {
+        "files": ["app.js", "landing.js", "app.css", "landing.css"]
+      }
+    },
+    "flights": {
+      "name": "Flights",
+      "hostUrl": "./flights",
+      "development": {
+        "files": ["app.js", "app.css"]
+      },
+      "production": {
+        "files": ["app.js", "app.css"]
+      }
+    },
+    "hotels": {
+      "name": "Hotels",
+      "hostUrl": "./hotels",
+      "development": {
+        "files": ["app.js", "app.css"]
+      },
+      "production": {
+        "files": ["app.js", "app.css"]
+      }
+    }
+  },
+  "serviceEndpoints": {
+    "api": "",
+    "idp": "https://int.idp.ellielabs.com",
+    "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+  },
+  "env": {
+    "localhost": {
+      "serviceEndpoints": {
+        "api": "",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "dev": {
+      "serviceEndpoints": {
+        "api": "https://dev.api.puiservice.rd.elliemae.io",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "dev2": {
+      "serviceEndpoints": {
+        "api": "https://int.api.ellielabs.com",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "qa": {
+      "serviceEndpoints": {
+        "api": "https://dev.api.puiservice.rd.elliemae.io",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "qa2": {
+      "serviceEndpoints": {
+        "api": "https://int.api.ellielabs.com",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "qa3": {
+      "serviceEndpoints": {
+        "api": "https://int.api.ellielabs.com",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "int": {
+      "serviceEndpoints": {
+        "api": "https://int.api.ellielabs.com",
+        "idp": "https://int.idp.ellielabs.com",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg-osb1": {
+      "serviceEndpoints": {
+        "api": "https://encompass-peg-api.elliemae.com",
+        "idp": "https://peg.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg-osb2": {
+      "serviceEndpoints": {
+        "api": "https://encompass-peg2-api.elliemae.com",
+        "idp": "https://peg.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg": {
+      "serviceEndpoints": {
+        "api": "https://peg2-west.api.ellielabs.com",
+        "idp": "https://peg.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg-oapi-west": {
+      "serviceEndpoints": {
+        "api": "https://peg2-west.api.ellielabs.com",
+        "idp": "https://peg.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg-oapi-east": {
+      "serviceEndpoints": {
+        "api": "https://peg2-east.api.ellielabs.com",
+        "idp": "https://peg.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg2-oapi-east": {
+      "serviceEndpoints": {
+        "api": "https://peg2-east.api.ellielabs.com",
+        "idp": "https://peg.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "peg3": {
+      "serviceEndpoints": {
+        "api": "https://pel1.api.ellielabs.com",
+        "idp": "https://peg3.idp.ellielabs.com/authorize",
+        "logger": "https://int.api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "stage": {
+      "serviceEndpoints": {
+        "api": "https://stg.api.elliemae.com",
+        "idp": "https://stg.idp.elliemae.com/authorize",
+        "logger": "https://api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "beta": {
+      "serviceEndpoints": {
+        "api": "https://concept.api.elliemae.com",
+        "idp": "https://concept.idp.elliemae.com/authorize",
+        "logger": "https://api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "demo": {
+      "serviceEndpoints": {
+        "api": "https://concept.api.elliemae.com",
+        "idp": "https://concept.idp.elliemae.com/authorize",
+        "logger": "https://api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "epc": {
+      "serviceEndpoints": {
+        "api": "https://concept.api.elliemae.com",
+        "idp": "https://concept.idp.elliemae.com/authorize",
+        "logger": "https://api.ellielabs.com/diagnostics/v2/logging"
+      }
+    },
+    "prod": {
+      "serviceEndpoints": {
+        "api": "https://api.elliemae.com",
+        "idp": "https://idp.elliemae.com/authorize",
+        "logger": "https://api.ellielabs.com/diagnostics/v2/logging"
+      }
+    }
+  }
+}