@elliemae/pui-app-bridge 2.0.0-next.26 → 2.0.0-next.27

package/dist/cjs/config/app.js

@@ -66,9 +66,34 @@ class CAppConfig {
         delete data.env;
       __privateSet(this, _gAppConfig, (0, import_merge.default)(data, activeEnvConfig));
     });
+    /**
+     * Get value for the given app config key
+     *
+     * @param key key to get value for
+     * @param defaultValue default value to return if key is not found
+     * @returns value for the given key
+     */
     this.get = (key = "", defaultValue = null) => (0, import_clone.default)((0, import_get.default)(__privateGet(this, _gAppConfig), key, defaultValue));
+    /**
+     * Set value for the given app config key
+     *
+     * @param key key to set value for
+     * @param value value to set
+     * @returns app config instance
+     */
     this.set = (key, value) => (0, import_set.default)(__privateGet(this, _gAppConfig), key, value);
+    /**
+     * Check if the given key exists in app config
+     *
+     * @param key key to check
+     * @returns true if key exists
+     */
     this.has = (key = "") => (0, import_has.default)(__privateGet(this, _gAppConfig), key);
+    /**
+     * load application configuration from the given asset path
+     *
+     * @param assetPath url path to load app config from
+     */
     this.load = async (assetPath = "latest/") => {
       const response = await fetch(
         `${assetPath.replace(/\/?$/, "/")}app.config.json`

package/dist/cjs/index.js

@@ -18,10 +18,10 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var lib_exports = {};
 __export(lib_exports, {
-  CMicroAppFactory: () => import_microAppFactory.CMicroAppFactory,
+  CMicroAppFactory: () => import_microfeFactory.CMicroAppFactory,
   Event: () => import_em_ssf_common.Event,
   ScriptingObject: () => import_em_ssf_common.ScriptingObject
 });
 module.exports = __toCommonJS(lib_exports);
 var import_em_ssf_common = require("@elliemae/em-ssf-common");
-var import_microAppFactory = require("./microAppFactory.js");
+var import_microfeFactory = require("./microfeFactory.js");

package/dist/cjs/{microAppFactory.js → microfeFactory.js}

@@ -34,22 +34,27 @@ var __privateSet = (obj, member, value, setter) => {
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var microAppFactory_exports = {};
-__export(microAppFactory_exports, {
+var microfeFactory_exports = {};
+__export(microfeFactory_exports, {
   CMicroAppFactory: () => CMicroAppFactory
 });
-module.exports = __toCommonJS(microAppFactory_exports);
+module.exports = __toCommonJS(microfeFactory_exports);
 var import_frame = require("./frame.js");
 var import_window = require("./window.js");
 var import_app = require("./config/app.js");
 var import_microFE = require("./config/microFE.js");
 var import_loaders = require("./loaders/index.js");
-var import_microAppHost = require("./microAppHost.js");
+var import_microfeHost = require("./microfeHost.js");
 var _logger, _scriptLoader, _styleLoader, _appConfig, _microFEConfig, _host, _activeGuests, _activeApps, _removeAssetsFromDOM, _addAppToActiveAppList, _waitAndInitApplication, _initApplication, _loadApp, _unloadApp, _mountApp, _unmountApp;
 const APP_CONTAINER_ID_PREFIX = "pui-app-container-";
 const cssType = /\.css$/;
 const isCss = (fileName) => cssType.test(fileName);
 class CMicroAppFactory {
+  /**
+   * Create a new instance of the MicroAppFactory
+   *
+   * @param {MicroAppFactoryParams} params - parameter for the constructor
+   */
   constructor(params) {
     __privateAdd(this, _logger, void 0);
     __privateAdd(this, _scriptLoader, void 0);
@@ -193,8 +198,52 @@ class CMicroAppFactory {
         containerId: `${APP_CONTAINER_ID_PREFIX}${id}`
       });
     });
-    this.getGuests = () => Array.from(__privateGet(this, _activeGuests).values());
+    /**
+     * Close all active guest micro frontend applications
+     */
+    this.closeAllApps = async () => {
+      await Promise.all(Object.keys(__privateGet(this, _activeApps)).map(this.closeApp));
+    };
+    /**
+     * Close guest micro frontend application
+     *
+     * @param id unique id of guest application
+     */
+    this.closeApp = async (id) => {
+      if (!id)
+        throw new Error("id is required");
+      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
+      if (!appConfig) {
+        throw new Error(`Application with id ${id} is not found`);
+      }
+      const { name, hostUrl } = appConfig;
+      try {
+        await __privateGet(this, _unmountApp).call(this, { id, name });
+      } finally {
+        const frameEle = import_frame.Frame.get(id);
+        if (!frameEle?.contentDocument) {
+          throw new Error(`Iframe for application with id ${id} is not found`);
+        }
+        __privateGet(this, _unloadApp).call(this, { id, hostUrl, documentEle: frameEle.contentDocument });
+        import_frame.Frame.remove(id);
+      }
+    };
+    /**
+     * Get guest by id
+     *
+     * @param guestId unique id of guest
+     * @returns guest instance
+     */
     this.getGuest = (guestId) => __privateGet(this, _activeGuests).get(guestId);
+    /**
+     * Get list of active guests
+     *
+     * @returns list of active guests
+     */
+    this.getGuests = () => Array.from(__privateGet(this, _activeGuests).values());
+    /**
+     * Initialize factory
+     */
     this.init = async () => {
       await __privateGet(this, _appConfig).load();
       __privateGet(this, _microFEConfig).init({
@@ -202,8 +251,28 @@ class CMicroAppFactory {
         appConfig: __privateGet(this, _appConfig)
       });
     };
-    this.openApp = async (options) => {
-      const { id, frameOptions, history, theme } = options;
+    /**
+     * Mount guest micro frontend application into DOM
+     *
+     * @param id unique id of guest micro frontend application
+     * @throws Error if application with given id is not found in configuration
+     */
+    this.mountApp = async (id) => {
+      if (!id)
+        throw new Error("id is required");
+      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
+      if (!appConfig) {
+        throw new Error(`Application with id ${id} is not found`);
+      }
+      await __privateGet(this, _mountApp).call(this, appConfig);
+    };
+    /**
+     * Open guest micro frontend application
+     *
+     * @param {OpenAppParams} params - options to open guest application
+     */
+    this.openApp = async (params) => {
+      const { id, frameOptions, history, theme } = params;
       const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
       if (!appConfig) {
         throw new Error(`Application with id ${id} is not found`);
@@ -234,34 +303,12 @@ class CMicroAppFactory {
         throw err;
       }
     };
-    this.closeApp = async (id) => {
-      if (!id)
-        throw new Error("id is required");
-      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
-      if (!appConfig) {
-        throw new Error(`Application with id ${id} is not found`);
-      }
-      const { name, hostUrl } = appConfig;
-      try {
-        await __privateGet(this, _unmountApp).call(this, { id, name });
-      } finally {
-        const frameEle = import_frame.Frame.get(id);
-        if (!frameEle?.contentDocument) {
-          throw new Error(`Iframe for application with id ${id} is not found`);
-        }
-        __privateGet(this, _unloadApp).call(this, { id, hostUrl, documentEle: frameEle.contentDocument });
-        import_frame.Frame.remove(id);
-      }
-    };
-    this.mountApp = async (id) => {
-      if (!id)
-        throw new Error("id is required");
-      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
-      if (!appConfig) {
-        throw new Error(`Application with id ${id} is not found`);
-      }
-      await __privateGet(this, _mountApp).call(this, appConfig);
-    };
+    /**
+     * Unmount guest micro frontend application from DOM
+     *
+     * @param id unique id of guest micro frontend application
+     * @throws Error if application with given id is not found in configuration
+     */
     this.unmountApp = async (id) => {
       if (!id)
         throw new Error("id is required");
@@ -271,18 +318,19 @@ class CMicroAppFactory {
       }
       await __privateGet(this, _unmountApp).call(this, appConfig);
     };
-    this.closeAllApps = async () => {
-      await Promise.all(Object.keys(__privateGet(this, _activeApps)).map(this.closeApp));
-    };
     const { logger } = params;
     if (!logger)
       throw new Error("logger is required");
     __privateSet(this, _logger, params.logger);
     __privateSet(this, _scriptLoader, new import_loaders.ScriptLoader(logger));
     __privateSet(this, _styleLoader, new import_loaders.StyleLoader(logger));
-    __privateSet(this, _host, new import_microAppHost.CMicroAppHost(params));
+    __privateSet(this, _host, new import_microfeHost.CMicroFEHost(params));
   }
-  // public api
+  /**
+   * Get instance of host
+   *
+   * @returns instance of host
+   */
   get host() {
     return __privateGet(this, _host);
   }

package/dist/cjs/{microAppHost.js → microfeHost.js}

@@ -34,38 +34,40 @@ var __privateSet = (obj, member, value, setter) => {
   setter ? setter.call(obj, value) : member.set(obj, value);
   return value;
 };
-var microAppHost_exports = {};
-__export(microAppHost_exports, {
-  CMicroAppHost: () => CMicroAppHost
+var microfeHost_exports = {};
+__export(microfeHost_exports, {
+  CMicroFEHost: () => CMicroFEHost
 });
-module.exports = __toCommonJS(microAppHost_exports);
+module.exports = __toCommonJS(microfeHost_exports);
 var import_pubsub_js = require("pubsub-js");
 var import_em_ssf_common = require("@elliemae/em-ssf-common");
 var import_frame = require("./frame.js");
 var import_constant = require("./constant.js");
 var _logger, _version, _eventManager, _scriptingObjects;
-class CMicroAppHost {
+class CMicroFEHost {
+  /**
+   * Create new instance of the host frontend application
+   *
+   * @param {CMicroFEHostParams} params - constructor parameters
+   */
   constructor(params) {
     __privateAdd(this, _logger, void 0);
     __privateAdd(this, _version, void 0);
     __privateAdd(this, _eventManager, void 0);
     __privateAdd(this, _scriptingObjects, /* @__PURE__ */ new Map());
-    this.setAppWindowSize = (appSize) => {
-      const { appId, size } = appSize;
-      const frameEle = document.getElementById(
-        `${import_frame.FRAME_CONTAINER_ID_PREFIX}${appId}`
-      );
-      if (frameEle) {
-        frameEle.style.height = `${size.height}px`;
-      }
-    };
-    // Scripting Object methods
-    this.getObject = (objectId) => {
-      const id = objectId.toLowerCase();
-      const data = __privateGet(this, _scriptingObjects).get(id);
-      return Promise.resolve(data || null);
-    };
-    this.registerScriptingObject = (so) => {
+    /**
+     * add listener to the scripting object event
+     *
+     * @param {AddEventListenerParams<EventId, EventType>} params - parameters to add event listener
+     * @returns subscription id
+     */
+    this.addEventListener = (params) => __privateGet(this, _eventManager).subscribe(params);
+    /**
+     * registers scripting object to the host
+     *
+     * @param so scripting object to publish
+     */
+    this.addScriptingObject = (so) => {
       if (!so?.id || !so?._toJSON) {
         throw new Error("Object is not derived from ScriptingObject");
       }
@@ -78,31 +80,86 @@ class CMicroAppHost {
         throw new Error(`Scripting Object ${so.id} already exists`);
       __privateGet(this, _scriptingObjects).set(objectId, so);
     };
-    this.unregisterScriptingObject = (objectId) => {
+    /**
+     * dispatch event to guest microfrontend application
+     *
+     * @param {DispatchEventParams<EventId, Params>} params - event parameters
+     */
+    this.dispatchEvent = async (params) => __privateGet(this, _eventManager).dispatchEvent(params);
+    /**
+     * Get reference to the scripting object (or proxy) by name
+     *
+     * @param name unique name of the scripting object
+     * @param objectId
+     * @returns scripting object reference
+     */
+    this.getObject = (objectId) => {
+      const id = objectId.toLowerCase();
+      const data = __privateGet(this, _scriptingObjects).get(id);
+      return Promise.resolve(data || null);
+    };
+    /**
+     * removes listener from the scripting object event
+     *
+     * @param {RemoveEventListenerParams<EventId>} params - parameters to remove event listener
+     */
+    this.removeEventListener = (params) => {
+      __privateGet(this, _eventManager).unsubscribe(params);
+    };
+    /**
+     * remove all listeners
+     */
+    this.removeAllEventListeners = () => {
+      __privateGet(this, _eventManager).unsubscribeAll();
+    };
+    /**
+     * removes scripting object from the host
+     *
+     * @param objectId unique id of the scripting object
+     */
+    this.removeScriptingObject = (objectId) => {
       __privateGet(this, _scriptingObjects).delete(
         objectId.toLowerCase()
       );
     };
-    this.dispatchEvent = async ({
-      event: { id, name, requiresFeedback, scriptingObject },
-      eventParams
-    }) => __privateGet(this, _eventManager).dispatchEvent({
-      event: { id, name, requiresFeedback, scriptingObject },
-      eventParams
-    });
-    this.addEventListener = ({
-      eventId,
-      listener
-    }) => __privateGet(this, _eventManager).subscribe({ eventId, listener });
-    this.removeEventListener = ({
-      eventId,
-      subscriptionId
-    }) => __privateGet(this, _eventManager).unsubscribe({ eventId, subscriptionId });
-    this.removeAllEventListeners = () => __privateGet(this, _eventManager).unsubscribeAll();
-    // deprecated methods
+    /**
+     * set the size of the guest application iframe window
+     *
+     * @param {AppWindowSize} appSize window size of the application
+     */
+    this.setAppWindowSize = (appSize) => {
+      const { appId, size } = appSize;
+      const frameEle = document.getElementById(
+        `${import_frame.FRAME_CONTAINER_ID_PREFIX}${appId}`
+      );
+      if (frameEle) {
+        frameEle.style.height = `${size.height}px`;
+      }
+    };
+    // deprecated legacy eventing methods (to be removed)
+    /**
+     * emit event to all subscribers (deprecated)
+     *
+     * @param eventId unique id of the event. The format is <scripting object name>.<event name>
+     * @param data data to be sent to the subscribers of the event
+     * @returns true if event is published successfully
+     */
     this.publish = (eventId, data) => (0, import_pubsub_js.publish)(eventId, data);
+    /**
+     * subscribe to an scripting object event (deprecated)
+     *
+     * @param eventId unique id of the event. The format is <scripting object name>.<event name>
+     * @param listener callback function to be called when the event is fired
+     * @returns token to be used to unsubscribe
+     */
     // eslint-disable-next-line @typescript-eslint/ban-types
     this.subscribe = (eventId, listener) => (0, import_pubsub_js.subscribe)(eventId, listener);
+    /**
+     * unsubscribe from an scripting object event (deprecated)
+     *
+     * @param token unique token returned by subscribe
+     * @param eventId unique id of the event. The format is <scripting object name>.<event name>
+     */
     this.unsubscribe = (token) => {
       (0, import_pubsub_js.unsubscribe)(token);
     };
@@ -110,6 +167,11 @@ class CMicroAppHost {
     __privateSet(this, _version, params?.version || import_constant.LATEST_VERSION);
     __privateSet(this, _eventManager, new import_em_ssf_common.EventManager());
   }
+  /**
+   * application release version
+   *
+   * @returns release version
+   */
   get version() {
     return __privateGet(this, _version);
   }

package/dist/esm/config/app.js

@@ -33,9 +33,34 @@ class CAppConfig {
         delete data.env;
       __privateSet(this, _gAppConfig, lodashMerge(data, activeEnvConfig));
     });
+    /**
+     * Get value for the given app config key
+     *
+     * @param key key to get value for
+     * @param defaultValue default value to return if key is not found
+     * @returns value for the given key
+     */
     this.get = (key = "", defaultValue = null) => lodashClone(lodashGet(__privateGet(this, _gAppConfig), key, defaultValue));
+    /**
+     * Set value for the given app config key
+     *
+     * @param key key to set value for
+     * @param value value to set
+     * @returns app config instance
+     */
     this.set = (key, value) => lodashSet(__privateGet(this, _gAppConfig), key, value);
+    /**
+     * Check if the given key exists in app config
+     *
+     * @param key key to check
+     * @returns true if key exists
+     */
     this.has = (key = "") => lodashHas(__privateGet(this, _gAppConfig), key);
+    /**
+     * load application configuration from the given asset path
+     *
+     * @param assetPath url path to load app config from
+     */
     this.load = async (assetPath = "latest/") => {
       const response = await fetch(
         `${assetPath.replace(/\/?$/, "/")}app.config.json`

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 import { Event, ScriptingObject } from "@elliemae/em-ssf-common";
-import { CMicroAppFactory } from "./microAppFactory.js";
+import { CMicroAppFactory } from "./microfeFactory.js";
 export {
   CMicroAppFactory,
   Event,

package/dist/esm/{microAppFactory.js → microfeFactory.js}

@@ -22,11 +22,16 @@ import { getCurrentBreakpoint, getViewportSize } from "./window.js";
 import { CAppConfig } from "./config/app.js";
 import { CMicroFEConfig } from "./config/microFE.js";
 import { StyleLoader, ScriptLoader, ManifestLoader } from "./loaders/index.js";
-import { CMicroAppHost } from "./microAppHost.js";
+import { CMicroFEHost } from "./microfeHost.js";
 const APP_CONTAINER_ID_PREFIX = "pui-app-container-";
 const cssType = /\.css$/;
 const isCss = (fileName) => cssType.test(fileName);
 class CMicroAppFactory {
+  /**
+   * Create a new instance of the MicroAppFactory
+   *
+   * @param {MicroAppFactoryParams} params - parameter for the constructor
+   */
   constructor(params) {
     __privateAdd(this, _logger, void 0);
     __privateAdd(this, _scriptLoader, void 0);
@@ -170,8 +175,52 @@ class CMicroAppFactory {
         containerId: `${APP_CONTAINER_ID_PREFIX}${id}`
       });
     });
-    this.getGuests = () => Array.from(__privateGet(this, _activeGuests).values());
+    /**
+     * Close all active guest micro frontend applications
+     */
+    this.closeAllApps = async () => {
+      await Promise.all(Object.keys(__privateGet(this, _activeApps)).map(this.closeApp));
+    };
+    /**
+     * Close guest micro frontend application
+     *
+     * @param id unique id of guest application
+     */
+    this.closeApp = async (id) => {
+      if (!id)
+        throw new Error("id is required");
+      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
+      if (!appConfig) {
+        throw new Error(`Application with id ${id} is not found`);
+      }
+      const { name, hostUrl } = appConfig;
+      try {
+        await __privateGet(this, _unmountApp).call(this, { id, name });
+      } finally {
+        const frameEle = Frame.get(id);
+        if (!frameEle?.contentDocument) {
+          throw new Error(`Iframe for application with id ${id} is not found`);
+        }
+        __privateGet(this, _unloadApp).call(this, { id, hostUrl, documentEle: frameEle.contentDocument });
+        Frame.remove(id);
+      }
+    };
+    /**
+     * Get guest by id
+     *
+     * @param guestId unique id of guest
+     * @returns guest instance
+     */
     this.getGuest = (guestId) => __privateGet(this, _activeGuests).get(guestId);
+    /**
+     * Get list of active guests
+     *
+     * @returns list of active guests
+     */
+    this.getGuests = () => Array.from(__privateGet(this, _activeGuests).values());
+    /**
+     * Initialize factory
+     */
     this.init = async () => {
       await __privateGet(this, _appConfig).load();
       __privateGet(this, _microFEConfig).init({
@@ -179,8 +228,28 @@ class CMicroAppFactory {
         appConfig: __privateGet(this, _appConfig)
       });
     };
-    this.openApp = async (options) => {
-      const { id, frameOptions, history, theme } = options;
+    /**
+     * Mount guest micro frontend application into DOM
+     *
+     * @param id unique id of guest micro frontend application
+     * @throws Error if application with given id is not found in configuration
+     */
+    this.mountApp = async (id) => {
+      if (!id)
+        throw new Error("id is required");
+      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
+      if (!appConfig) {
+        throw new Error(`Application with id ${id} is not found`);
+      }
+      await __privateGet(this, _mountApp).call(this, appConfig);
+    };
+    /**
+     * Open guest micro frontend application
+     *
+     * @param {OpenAppParams} params - options to open guest application
+     */
+    this.openApp = async (params) => {
+      const { id, frameOptions, history, theme } = params;
       const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
       if (!appConfig) {
         throw new Error(`Application with id ${id} is not found`);
@@ -211,34 +280,12 @@ class CMicroAppFactory {
         throw err;
       }
     };
-    this.closeApp = async (id) => {
-      if (!id)
-        throw new Error("id is required");
-      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
-      if (!appConfig) {
-        throw new Error(`Application with id ${id} is not found`);
-      }
-      const { name, hostUrl } = appConfig;
-      try {
-        await __privateGet(this, _unmountApp).call(this, { id, name });
-      } finally {
-        const frameEle = Frame.get(id);
-        if (!frameEle?.contentDocument) {
-          throw new Error(`Iframe for application with id ${id} is not found`);
-        }
-        __privateGet(this, _unloadApp).call(this, { id, hostUrl, documentEle: frameEle.contentDocument });
-        Frame.remove(id);
-      }
-    };
-    this.mountApp = async (id) => {
-      if (!id)
-        throw new Error("id is required");
-      const appConfig = __privateGet(this, _microFEConfig).getConfigById(id);
-      if (!appConfig) {
-        throw new Error(`Application with id ${id} is not found`);
-      }
-      await __privateGet(this, _mountApp).call(this, appConfig);
-    };
+    /**
+     * Unmount guest micro frontend application from DOM
+     *
+     * @param id unique id of guest micro frontend application
+     * @throws Error if application with given id is not found in configuration
+     */
     this.unmountApp = async (id) => {
       if (!id)
         throw new Error("id is required");
@@ -248,18 +295,19 @@ class CMicroAppFactory {
       }
       await __privateGet(this, _unmountApp).call(this, appConfig);
     };
-    this.closeAllApps = async () => {
-      await Promise.all(Object.keys(__privateGet(this, _activeApps)).map(this.closeApp));
-    };
     const { logger } = params;
     if (!logger)
       throw new Error("logger is required");
     __privateSet(this, _logger, params.logger);
     __privateSet(this, _scriptLoader, new ScriptLoader(logger));
     __privateSet(this, _styleLoader, new StyleLoader(logger));
-    __privateSet(this, _host, new CMicroAppHost(params));
+    __privateSet(this, _host, new CMicroFEHost(params));
   }
-  // public api
+  /**
+   * Get instance of host
+   *
+   * @returns instance of host
+   */
   get host() {
     return __privateGet(this, _host);
   }