@elliemae/pui-app-bridge 2.9.4 → 2.16.6

package/dist/public/loan-object.js

@@ -1,3 +1,3 @@
-import{getAppBridge as t}from"./utils.js";const e=s=>document.getElementById(s);class o extends ice.ScriptingObject{constructor(){super("Loan"),this.loanId="ABC123",this.onSaved=new ice.Event({name:"onSaved",requiresFeedback:!1,so:this}),this.onPreSave=new ice.Event({name:"onPreSave",requiresFeedback:!0,so:this}),this.onLoanAmountChanged=new ice.Event({name:"onLoanAmountChanged",requiresFeedback:!1,so:this}),this.onLoanTermChanged=new ice.Event({name:"onLoanTermChanged",requiresFeedback:!1,so:this}),this.onDownPaymentChanged=new ice.Event({name:"onDownPaymentChanged",requiresFeedback:!1,so:this}),e("amount").addEventListener("blur",async a=>{(await t()).dispatchEvent({event:this.onLoanAmountChanged,eventParams:{amount:a.target.value}})}),e("term").addEventListener("blur",async a=>{(await t()).dispatchEvent({event:this.onLoanTermChanged,eventParams:{term:a.target.value}})}),e("downPayment").addEventListener("blur",async a=>{(await t()).dispatchEvent({event:this.onDownPaymentChanged,eventParams:{downPayment:a.target.value}})})}getLoanDetails=()=>({id:this.loanId,firstName:e("firstName").value,lastName:e("lastName").value,ssn:e("ssn").value,amount:e("amount").value,term:e("term").value,downPayment:e("downPayment").value,creditScore:e("creditScore").value});setCreditScore=a=>{const n=document.getElementById("creditScore");n&&(n.value=a)};saveLoan=async()=>{(await t()).dispatchEvent({event:this.onSaved,eventParams:{id:this.loanId}})}}export{o as Loan};
+import{getAppBridge as a}from"./utils.js";const e=o=>document.getElementById(o);class r extends ice.ScriptingObject{constructor(){super("Loan"),this.loanId="ABC123",this.onSaved=new ice.Event({name:"onSaved",objectId:this.constructor.name}),this.onPreSave=new ice.Event({name:"onPreSave",objectId:this.constructor.name}),this.onLoanAmountChanged=new ice.Event({name:"onLoanAmountChanged",objectId:this.constructor.name}),this.onLoanTermChanged=new ice.Event({name:"onLoanTermChanged",objectId:this.constructor.name}),this.onDownPaymentChanged=new ice.Event({name:"onDownPaymentChanged",objectId:this.constructor.name}),e("amount").addEventListener("blur",async n=>{(await a()).dispatchEvent({event:this.onLoanAmountChanged,eventParams:{amount:n.target.value}})}),e("term").addEventListener("blur",async n=>{(await a()).dispatchEvent({event:this.onLoanTermChanged,eventParams:{term:n.target.value}})}),e("downPayment").addEventListener("blur",async n=>{(await a()).dispatchEvent({event:this.onDownPaymentChanged,eventParams:{downPayment:n.target.value}})})}getLoanDetails=()=>({id:this.loanId,firstName:e("firstName").value,lastName:e("lastName").value,ssn:e("ssn").value,amount:e("amount").value,term:e("term").value,downPayment:e("downPayment").value,creditScore:e("creditScore").value});setCreditScore=n=>{const t=document.getElementById("creditScore");t&&(t.value=n)};saveLoan=async()=>{(await a()).dispatchEvent({event:this.onSaved,eventParams:{id:this.loanId}})}}export{r as Loan};
 
 //# sourceMappingURL=loan-object.js.map

package/dist/public/loan-object.js.map

@@ -1 +1 @@
-{"version":3,"sources":["webpack://ice/loan-object.js"],"sourcesContent":["import { getAppBridge } from './utils.js';\n\nconst getLoanField = (name) => document.getElementById(name);\n\nclass Loan extends ice.ScriptingObject {\n  constructor() {\n    super('Loan');\n    this.loanId = 'ABC123';\n    this.onSaved = new ice.Event({\n      name: 'onSaved',\n      requiresFeedback: false,\n      so: this,\n    });\n    this.onPreSave = new ice.Event({\n      name: 'onPreSave',\n      requiresFeedback: true,\n      so: this,\n    });\n    this.onLoanAmountChanged = new ice.Event({\n      name: 'onLoanAmountChanged',\n      requiresFeedback: false,\n      so: this,\n    });\n    this.onLoanTermChanged = new ice.Event({\n      name: 'onLoanTermChanged',\n      requiresFeedback: false,\n      so: this,\n    });\n    this.onDownPaymentChanged = new ice.Event({\n      name: 'onDownPaymentChanged',\n      requiresFeedback: false,\n      so: this,\n    });\n\n    getLoanField('amount').addEventListener('blur', async (e) => {\n      const appBridge = await getAppBridge();\n      appBridge.dispatchEvent({\n        event: this.onLoanAmountChanged,\n        eventParams: {\n          amount: e.target.value,\n        },\n      });\n    });\n\n    getLoanField('term').addEventListener('blur', async (e) => {\n      const appBridge = await getAppBridge();\n      appBridge.dispatchEvent({\n        event: this.onLoanTermChanged,\n        eventParams: { term: e.target.value },\n      });\n    });\n\n    getLoanField('downPayment').addEventListener('blur', async (e) => {\n      const appBridge = await getAppBridge();\n      appBridge.dispatchEvent({\n        event: this.onDownPaymentChanged,\n        eventParams: {\n          downPayment: e.target.value,\n        },\n      });\n    });\n  }\n\n  getLoanDetails = () => ({\n    id: this.loanId,\n    firstName: getLoanField('firstName').value,\n    lastName: getLoanField('lastName').value,\n    ssn: getLoanField('ssn').value,\n    amount: getLoanField('amount').value,\n    term: getLoanField('term').value,\n    downPayment: getLoanField('downPayment').value,\n    creditScore: getLoanField('creditScore').value,\n  });\n\n  setCreditScore = (creditScore) => {\n    const creditScoreElement = document.getElementById('creditScore');\n    if (creditScoreElement) creditScoreElement.value = creditScore;\n  };\n\n  saveLoan = async () => {\n    const appBridge = await getAppBridge();\n    appBridge.dispatchEvent({\n      event: this.onSaved,\n      eventParams: { id: this.loanId },\n    });\n  };\n}\n\nexport { Loan };\n"],"mappings":"AAAA,OAAS,gBAAAA,MAAoB,aAE7B,MAAMC,EAAgBC,GAAS,SAAS,eAAeA,CAAI,EAE3D,MAAMC,UAAa,IAAI,eAAgB,CACrC,aAAc,CACZ,MAAM,MAAM,EACZ,KAAK,OAAS,SACd,KAAK,QAAU,IAAI,IAAI,MAAM,CAC3B,KAAM,UACN,iBAAkB,GAClB,GAAI,IACN,CAAC,EACD,KAAK,UAAY,IAAI,IAAI,MAAM,CAC7B,KAAM,YACN,iBAAkB,GAClB,GAAI,IACN,CAAC,EACD,KAAK,oBAAsB,IAAI,IAAI,MAAM,CACvC,KAAM,sBACN,iBAAkB,GAClB,GAAI,IACN,CAAC,EACD,KAAK,kBAAoB,IAAI,IAAI,MAAM,CACrC,KAAM,oBACN,iBAAkB,GAClB,GAAI,IACN,CAAC,EACD,KAAK,qBAAuB,IAAI,IAAI,MAAM,CACxC,KAAM,uBACN,iBAAkB,GAClB,GAAI,IACN,CAAC,EAEDF,EAAa,QAAQ,EAAE,iBAAiB,OAAQ,MAAOG,GAAM,EACzC,MAAMJ,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,oBACZ,YAAa,CACX,OAAQI,EAAE,OAAO,KACnB,CACF,CAAC,CACH,CAAC,EAEDH,EAAa,MAAM,EAAE,iBAAiB,OAAQ,MAAOG,GAAM,EACvC,MAAMJ,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,kBACZ,YAAa,CAAE,KAAMI,EAAE,OAAO,KAAM,CACtC,CAAC,CACH,CAAC,EAEDH,EAAa,aAAa,EAAE,iBAAiB,OAAQ,MAAOG,GAAM,EAC9C,MAAMJ,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,qBACZ,YAAa,CACX,YAAaI,EAAE,OAAO,KACxB,CACF,CAAC,CACH,CAAC,CACH,CAEA,eAAiB,KAAO,CACtB,GAAI,KAAK,OACT,UAAWH,EAAa,WAAW,EAAE,MACrC,SAAUA,EAAa,UAAU,EAAE,MACnC,IAAKA,EAAa,KAAK,EAAE,MACzB,OAAQA,EAAa,QAAQ,EAAE,MAC/B,KAAMA,EAAa,MAAM,EAAE,MAC3B,YAAaA,EAAa,aAAa,EAAE,MACzC,YAAaA,EAAa,aAAa,EAAE,KAC3C,GAEA,eAAkBI,GAAgB,CAChC,MAAMC,EAAqB,SAAS,eAAe,aAAa,EAC5DA,IAAoBA,EAAmB,MAAQD,EACrD,EAEA,SAAW,SAAY,EACH,MAAML,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,QACZ,YAAa,CAAE,GAAI,KAAK,MAAO,CACjC,CAAC,CACH,CACF,CAEA,OAASG,KAAA","names":["getAppBridge","getLoanField","name","Loan","e","creditScore","creditScoreElement"],"sourceRoot":"","file":"loan-object.js"}
+{"version":3,"sources":["webpack://ice/loan-object.js"],"sourcesContent":["import { getAppBridge } from './utils.js';\n\nconst getLoanField = (name) => document.getElementById(name);\n\nclass Loan extends ice.ScriptingObject {\n  constructor() {\n    super('Loan');\n    this.loanId = 'ABC123';\n    this.onSaved = new ice.Event({\n      name: 'onSaved',\n      objectId: this.constructor.name,\n    });\n    this.onPreSave = new ice.Event({\n      name: 'onPreSave',\n      objectId: this.constructor.name,\n    });\n    this.onLoanAmountChanged = new ice.Event({\n      name: 'onLoanAmountChanged',\n      objectId: this.constructor.name,\n    });\n    this.onLoanTermChanged = new ice.Event({\n      name: 'onLoanTermChanged',\n      objectId: this.constructor.name,\n    });\n    this.onDownPaymentChanged = new ice.Event({\n      name: 'onDownPaymentChanged',\n      objectId: this.constructor.name,\n    });\n\n    getLoanField('amount').addEventListener('blur', async (e) => {\n      const appBridge = await getAppBridge();\n      appBridge.dispatchEvent({\n        event: this.onLoanAmountChanged,\n        eventParams: {\n          amount: e.target.value,\n        },\n      });\n    });\n\n    getLoanField('term').addEventListener('blur', async (e) => {\n      const appBridge = await getAppBridge();\n      appBridge.dispatchEvent({\n        event: this.onLoanTermChanged,\n        eventParams: { term: e.target.value },\n      });\n    });\n\n    getLoanField('downPayment').addEventListener('blur', async (e) => {\n      const appBridge = await getAppBridge();\n      appBridge.dispatchEvent({\n        event: this.onDownPaymentChanged,\n        eventParams: {\n          downPayment: e.target.value,\n        },\n      });\n    });\n  }\n\n  getLoanDetails = () => ({\n    id: this.loanId,\n    firstName: getLoanField('firstName').value,\n    lastName: getLoanField('lastName').value,\n    ssn: getLoanField('ssn').value,\n    amount: getLoanField('amount').value,\n    term: getLoanField('term').value,\n    downPayment: getLoanField('downPayment').value,\n    creditScore: getLoanField('creditScore').value,\n  });\n\n  setCreditScore = (creditScore) => {\n    const creditScoreElement = document.getElementById('creditScore');\n    if (creditScoreElement) creditScoreElement.value = creditScore;\n  };\n\n  saveLoan = async () => {\n    const appBridge = await getAppBridge();\n    appBridge.dispatchEvent({\n      event: this.onSaved,\n      eventParams: { id: this.loanId },\n    });\n  };\n}\n\nexport { Loan };\n"],"mappings":"AAAA,OAAS,gBAAAA,MAAoB,aAE7B,MAAMC,EAAgBC,GAAS,SAAS,eAAeA,CAAI,EAE3D,MAAMC,UAAa,IAAI,eAAgB,CACrC,aAAc,CACZ,MAAM,MAAM,EACZ,KAAK,OAAS,SACd,KAAK,QAAU,IAAI,IAAI,MAAM,CAC3B,KAAM,UACN,SAAU,KAAK,YAAY,IAC7B,CAAC,EACD,KAAK,UAAY,IAAI,IAAI,MAAM,CAC7B,KAAM,YACN,SAAU,KAAK,YAAY,IAC7B,CAAC,EACD,KAAK,oBAAsB,IAAI,IAAI,MAAM,CACvC,KAAM,sBACN,SAAU,KAAK,YAAY,IAC7B,CAAC,EACD,KAAK,kBAAoB,IAAI,IAAI,MAAM,CACrC,KAAM,oBACN,SAAU,KAAK,YAAY,IAC7B,CAAC,EACD,KAAK,qBAAuB,IAAI,IAAI,MAAM,CACxC,KAAM,uBACN,SAAU,KAAK,YAAY,IAC7B,CAAC,EAEDF,EAAa,QAAQ,EAAE,iBAAiB,OAAQ,MAAOG,GAAM,EACzC,MAAMJ,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,oBACZ,YAAa,CACX,OAAQI,EAAE,OAAO,KACnB,CACF,CAAC,CACH,CAAC,EAEDH,EAAa,MAAM,EAAE,iBAAiB,OAAQ,MAAOG,GAAM,EACvC,MAAMJ,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,kBACZ,YAAa,CAAE,KAAMI,EAAE,OAAO,KAAM,CACtC,CAAC,CACH,CAAC,EAEDH,EAAa,aAAa,EAAE,iBAAiB,OAAQ,MAAOG,GAAM,EAC9C,MAAMJ,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,qBACZ,YAAa,CACX,YAAaI,EAAE,OAAO,KACxB,CACF,CAAC,CACH,CAAC,CACH,CAEA,eAAiB,KAAO,CACtB,GAAI,KAAK,OACT,UAAWH,EAAa,WAAW,EAAE,MACrC,SAAUA,EAAa,UAAU,EAAE,MACnC,IAAKA,EAAa,KAAK,EAAE,MACzB,OAAQA,EAAa,QAAQ,EAAE,MAC/B,KAAMA,EAAa,MAAM,EAAE,MAC3B,YAAaA,EAAa,aAAa,EAAE,MACzC,YAAaA,EAAa,aAAa,EAAE,KAC3C,GAEA,eAAkBI,GAAgB,CAChC,MAAMC,EAAqB,SAAS,eAAe,aAAa,EAC5DA,IAAoBA,EAAmB,MAAQD,EACrD,EAEA,SAAW,SAAY,EACH,MAAML,EAAa,GAC3B,cAAc,CACtB,MAAO,KAAK,QACZ,YAAa,CAAE,GAAI,KAAK,MAAO,CACjC,CAAC,CACH,CACF,CAEA,OAASG,KAAA","names":["getAppBridge","getLoanField","name","Loan","e","creditScore","creditScoreElement"],"sourceRoot":"","file":"loan-object.js"}

package/dist/types/lib/appBridge.d.ts

@@ -1,9 +1,9 @@
 import { Logger } from '@elliemae/pui-diagnostics';
-import { Events, ScriptingObjectTypes } from '@elliemae/pui-scripting-object';
-import type { EventListeners, AddScriptingObjectParams } from '@elliemae/microfe-common';
+import { Events, ScriptingObjectTypes, IScriptingObjectProxy } from '@elliemae/pui-scripting-object';
+import { EventListeners, AddScriptingObjectParams, DispatchEventParam, EventOptions, ScriptingObjects } from '@elliemae/microfe-common';
 import { IMicroFEGuest } from './typings/guest.js';
 import { OpenAppParams } from './typings/host.js';
-import { ScriptingObjects, DispatchEventParam, ValueOf } from './typings/common.js';
+import { ValueOf } from './typings/common.js';
 /**
  * AppBridge constructor parameter
  */
@@ -23,6 +23,11 @@ export type AppBridgeParams = {
      * instance of the pui diagnostics logger
      */
     logger: Logger;
+    /**
+     * Extend parent session when user interacts with the guest application
+     * @defaultValue true
+     */
+    extendSession?: boolean;
 };
 /**
  * AppBridge implementation. This class is responsible for creating & managing the Micro FrontEnd Guest instances. It also exposes scripting objects to all the Micro FrontEnd Guests.
@@ -33,76 +38,81 @@ export declare class CAppBridge<AppObjects extends ScriptingObjects = Partial<Sc
     #private;
     /**
      * Create a new instance of the AppBridge
-     * @param {AppBridgeParams} params - parameter for the constructor
+     * @param {AppBridgeParams} options - App Bridge constructor parameters
      */
-    constructor(params: AppBridgeParams);
+    constructor(options: AppBridgeParams);
     /**
      * registers scripting object to the host
      * @param {ValueOf<AppObjects>} so scripting object
      * @param {AddScriptingObjectParams} params params to add scripting object
      */
     addScriptingObject: <SO extends ValueOf<AppObjects>>(so: SO, params?: AddScriptingObjectParams) => void;
+    /**
+     * Create new Scripting Object from SSF scripting object proxy
+     * @param proxy - reference to the scripting object obtained through getObject method
+     * @returns cloned version of the scripting object
+     */
+    cloneScriptingObject: <ObjectId extends Extract<keyof AppObjects, string>>(proxy: IScriptingObjectProxy) => AppObjects[ObjectId];
     /**
      * Close all active guest micro frontend applications
      */
     closeAllApps: () => Promise<void>;
     /**
      * Close guest micro frontend application
-     * @param id unique id of guest application
+     * @param instanceId unique instance id of the application
      */
-    closeApp: (id: string) => Promise<void>;
+    closeApp: (instanceId: string) => Promise<void>;
     /**
      * dispatch event to guest microfrontend application
-     * @param {DispatchEventParams<EventId, Params>} params - event parameters
+     * @param {DispatchEventParams<EventId, Params, Options>} params - event parameters
      */
-    dispatchEvent: <EventId extends Extract<keyof AppEvents, string>, Params extends Parameters<AppEvents[EventId]>[0]["eventParams"]>(params: DispatchEventParam<EventId, Params>) => Promise<void | any[]>;
+    dispatchEvent: <EventId extends Extract<keyof AppEvents, string>, Params extends Parameters<AppEvents[EventId]>[0]["eventParams"], Options extends EventOptions>(params: DispatchEventParam<EventId, Params, Options>) => Promise<void | any[]>;
     /**
-     * Get guest by id
+     * Get App by instanceId
      * @param id unique id of guest
+     * @param instanceId
      * @returns guest instance
      */
-    getGuest: <T extends IMicroFEGuest>(id: string) => T | null;
+    getApp: <T extends IMicroFEGuest>(instanceId: string) => T;
     /**
-     * Get list of active guests
+     * Get list of active apps
      * @returns list of active guests
      */
-    getGuests: () => IMicroFEGuest<Partial<ScriptingObjectTypes>, Events>[];
+    getApps: () => IMicroFEGuest<Partial<ScriptingObjectTypes>, Events>[];
     /**
      * Initialize appBridge
      */
     init: () => Promise<void>;
     /**
      * 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
+     * @param instanceId unique instance id of guest micro frontend application
+     * @throws Error if application with given instance id is not found in configuration
      */
-    mountApp: (id: string) => Promise<void>;
+    mountApp: (instanceId: string) => Promise<void>;
     /**
      * Open guest micro frontend application
      * @param {OpenAppParams} params - options to open guest application
      */
-    openApp: (params: OpenAppParams) => Promise<IMicroFEGuest<Partial<ScriptingObjectTypes>, Events> | undefined>;
+    openApp: (params: OpenAppParams) => Promise<string>;
     /**
-     * emit event to all subscribers (deprecated)
-     * @deprecated use dispatchEvent instead
-     * @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
+     * remove all listeners
      */
-    publish: <T>(eventId: string | symbol, data?: T) => boolean;
+    removeAllEventSubscriptions: () => void;
     /**
-     * remove all listeners
+     * removes all scripting objects from host
+     * @param guestId unique id of the guest application
      */
-    removeAllEventListeners: () => void;
+    removeAllScriptingObjects: (guestId?: string) => void;
     /**
      * removes scripting object from the host
      * @param objectId unique id of the scripting object
+     * @param guestId
      */
-    removeScriptingObject: (objectId: Extract<keyof AppObjects, string>) => void;
+    removeScriptingObject: (objectId: Extract<keyof AppObjects, string>, guestId?: string) => void;
     /**
      * Unmount guest micro frontend application from DOM
-     * @param id unique id of guest micro frontend application
+     * @param instanceId unique instance id of guest micro frontend application
      * @throws Error if application with given id is not found in configuration
      */
-    unmountApp: (id: string) => Promise<void>;
+    unmountApp: (instanceId: string) => Promise<void>;
 }

package/dist/types/lib/appRegistry.d.ts

@@ -0,0 +1,41 @@
+import { IMicroFEGuest } from './typings/guest.js';
+export declare class CAppRegistry {
+    #private;
+    constructor();
+    /**
+     * get micro app guest from window object
+     * @param param0 id and uuid
+     * @param param0.id app id
+     * @param param0.uuid unique instance id
+     * @param param0.instanceId
+     * @returns micro app guest
+     */
+    get: ({ id, instanceId }: {
+        id: string;
+        instanceId: string;
+    }) => Omit<IMicroFEGuest<Partial<import("@elliemae/pui-scripting-object").ScriptingObjectTypes>, import("@elliemae/pui-scripting-object").Events>, "guestWindow"> | null;
+    /**
+     * add app to global emui window variable
+     * @param id.id
+     * @param id app id
+     * @param instanceId unique instance id
+     * @param id.instanceId
+     * @param id.documentEle
+     */
+    add: ({ id, instanceId, documentEle, }: {
+        id: string;
+        instanceId: string;
+        documentEle: Document;
+    }) => void;
+    /**
+     * delete app from global emui window variable
+     * @param id.id app id
+     * @param id.instanceId unique instance id
+     * @param id.id.id
+     * @param id.id.instanceId
+     */
+    delete: ({ id, instanceId }: {
+        id: string;
+        instanceId: string;
+    }) => void;
+}

package/dist/types/lib/eventManager.d.ts

@@ -1,6 +1,5 @@
 import { IScriptingObject, Events } from '@elliemae/pui-scripting-object';
-import type { EventListeners, Listener } from '@elliemae/microfe-common';
-import { SubscribeParam, UnsubscribeParam, DispatchEventParam } from './typings/common.js';
+import type { EventListeners, Listener, SubscribeParam, UnsubscribeParam, DispatchEventParam, EventOptions } from '@elliemae/microfe-common';
 /**
  * details of an event listener
  */
@@ -12,7 +11,7 @@ type EventListenerDetails = {
     /**
      * subscription id
      */
-    subscriptionId: string;
+    token: string;
 };
 /**
  * parameters for emitting an event
@@ -42,9 +41,10 @@ export declare class EventManager<AppEvents extends EventListeners = Events> {
     #private;
     /**
      * dispatch an event
+     * @param scriptingObject
      * @param {DispatchEventParam<EventId, Params>} param - parameters for dispatching an event
      */
-    dispatchEvent: <EventId extends Extract<keyof AppEvents, string>, Params extends Parameters<AppEvents[EventId]>[0]["eventParams"]>(param: DispatchEventParam<EventId, Params>) => Promise<void | any[]>;
+    dispatchEvent: <EventId extends Extract<keyof AppEvents, string>, Params extends Parameters<AppEvents[EventId]>[0]["eventParams"], Options extends EventOptions>(scriptingObject: IScriptingObject, param: DispatchEventParam<EventId, Params, Options>) => Promise<void | any[]>;
     /**
      * Subscribe to an event
      * @param {SubscribeParam<EventId, AppEvents[EventId]>} param - parameters for subscribing to an event

package/dist/types/lib/frame.d.ts

@@ -1,14 +1,55 @@
+import { IApplication } from '@elliemae/pui-scripting-object';
+import { Logger } from '@elliemae/pui-diagnostics';
+/**
+ * Options for creating an iframe for a guest application
+ */
 export type FrameOptions = {
+    /**
+     * title of the iframe
+     */
     title: string;
+    /**
+     * sandbox attribute for the iframe
+     * check https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox for more details
+     */
     sandbox?: string;
+    /**
+     * source url for the iframe
+     */
     src?: string;
+    /**
+     * css style for the iframe
+     * @default 'flex-grow: 1;border: none;margin: 0;padding: 0;display: block;min-width: 100%;height: 100%;'
+     */
     style?: string;
+    /**
+     * unique identified of the iframe container
+     */
     containerId?: string;
+    /**
+     * application object for the guest application
+     */
+    appObj?: IApplication;
+    /**
+     * logger instance for the guest application
+     */
+    logger?: Logger;
+    /**
+     * permission policy for the guest iframe
+     * check https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe#allow for more details
+     * @example "microphone 'self' https://example.com; geolocation 'none'"
+     */
+    permissionPolicy?: string;
 };
-export declare const FRAME_CONTAINER_ID_PREFIX = "pui-iframe-container-";
 export declare const FRAME_APP_CONTAINER_ID_PREFIX = "pui-app-container-";
 export declare const Frame: {
-    create: (appId: string, options: FrameOptions) => Promise<HTMLIFrameElement>;
-    remove: (appId: string) => void;
-    get: (appId: string) => HTMLIFrameElement;
+    create: ({ id, instanceId, manifestPath, hostUrl, options, }: {
+        id: string;
+        instanceId: string;
+        manifestPath: string;
+        hostUrl: string;
+        options: FrameOptions;
+    }) => Promise<HTMLIFrameElement>;
+    remove: (instanceId: string) => void;
+    get: (instanceId: string) => HTMLIFrameElement;
 };

package/dist/types/lib/index.d.ts

@@ -1,10 +1,10 @@
 export type { MountParams, InitParams, IMicroFEGuest, } from './typings/guest.js';
-export type { SubscriptionListener, IMicroFEHost, OpenAppParams, } from './typings/host.js';
+export type { IMicroFEHost, OpenAppParams } from './typings/host.js';
 export { SecurityContext } from './typings/common.js';
-export type { DispatchEventParam, SubscribeParam, UnsubscribeParam, } from './typings/common.js';
 export type { AppBridgeParams } from './appBridge.js';
 export type { IAppConfig, MicroFrontendApp } from './config/app.js';
 export type { FrameOptions } from './frame.js';
-export type { Listener, AddScriptingObjectParams, } from '@elliemae/microfe-common';
+export type { Listener, EventListeners, AddScriptingObjectParams, SubscribeParam, UnsubscribeParam, } from '@elliemae/microfe-common';
 export { Event, ScriptingObject } from '@elliemae/microfe-common';
+export type { ScriptingObjects } from '@elliemae/microfe-common';
 export { CAppBridge } from './appBridge.js';

package/dist/types/lib/loaders/script.d.ts

@@ -6,11 +6,12 @@ type ResourceOptions = {
     documentEle: Document;
     fileName: string;
     index: number;
+    isJsModule?: boolean;
 };
 export declare class ScriptLoader {
     #private;
     constructor(logger: Logger);
-    add: ({ name, hostUrl, documentEle, fileName, index, }: ResourceOptions) => Promise<string>;
+    add: ({ name, hostUrl, documentEle, fileName, index, isJsModule, }: ResourceOptions) => Promise<string>;
     remove: (elementId?: string, documentEle?: Document) => Promise<void>;
     removeDynamicImportedScripts: (hostUrl: string, documentEle: Document) => void;
     removePrefetchLinks: (hostUrl: string, documentEle: Document) => void;

package/dist/types/lib/microfeHost.d.ts

@@ -1,14 +1,17 @@
 import { Events, ScriptingObjectTypes } from '@elliemae/pui-scripting-object';
 import { Logger } from '@elliemae/pui-diagnostics';
-import type { EventListeners, GuestContext } from '@elliemae/microfe-common';
-import { ScriptingObjectManager } from '@elliemae/microfe-common';
+import type { EventListeners, GuestContext, SubscribeParam, UnsubscribeParam } from '@elliemae/microfe-common';
+import { ScriptingObjectManager, ScriptingObjects } from '@elliemae/microfe-common';
 import { EventManager } from './eventManager.js';
-import { IMicroFEHost, SubscriptionListener, AppWindowSize } from './typings/host.js';
-import { ScriptingObjects, SubscribeParam, UnsubscribeParam } from './typings/common.js';
+import { IMicroFEHost, AppWindowSize } from './typings/host.js';
 /**
  * Constructor parameters for the host application
  */
 export type CMicroFEHostParams<AppObjects extends ScriptingObjects, AppEvents extends EventListeners> = {
+    /**
+     * unique id of the iframe container
+     */
+    containerId?: string;
     /**
      * unique id of the guest application
      */
@@ -42,12 +45,6 @@ export declare class CMicroFEHost<AppObjects extends ScriptingObjects = Partial<
      * @param {CMicroFEHostParams} params - constructor parameters
      */
     constructor(params: CMicroFEHostParams<AppObjects, AppEvents>);
-    /**
-     * add listener to the scripting object event
-     * @param {SubscribeParam<EventId, EventListener>} params - parameters to add event listener
-     * @returns subscription id
-     */
-    addEventListener: <EventId extends Extract<keyof AppEvents, string>>(params: SubscribeParam<EventId, AppEvents[EventId]>) => string;
     /**
      * application release version
      * @returns release version
@@ -59,28 +56,21 @@ export declare class CMicroFEHost<AppObjects extends ScriptingObjects = Partial<
      * @param objectId
      * @returns scripting object reference
      */
-    getObject: <ObjectId extends Extract<keyof AppObjects, string>>(objectId: ObjectId) => Promise<Awaited<AppObjects[ObjectId]> | null>;
-    /**
-     * removes listener from the scripting object event
-     * @param {UnsubscribeParam<EventId>} params - parameters to remove event listener
-     */
-    removeEventListener: <EventId extends Extract<keyof AppEvents, string>>(params: UnsubscribeParam<EventId>) => void;
+    getObject: <ObjectId extends Extract<keyof AppObjects, string>>(objectId: ObjectId) => Promise<Awaited<AppObjects[ObjectId]>> | Promise<null>;
     /**
      * set the size of the guest application iframe window
      * @param {AppWindowSize} appSize window size of the application
      */
     setAppWindowSize: (appSize: AppWindowSize) => void;
     /**
-     * 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
+     * add listener to the scripting object event
+     * @param {SubscribeParam<EventId, EventListener>} params - parameters to add event listener
+     * @returns subscription id
      */
-    subscribe: <T>(eventId: string | symbol, listener: SubscriptionListener<T>) => string;
+    subscribe: <EventId extends Extract<keyof AppEvents, string>>(params: SubscribeParam<EventId, AppEvents[EventId]>) => string;
     /**
-     * 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]
+     * removes listener from the scripting object event
+     * @param {UnsubscribeParam<EventId>} params - parameters to remove event listener
      */
-    unsubscribe: (token: string) => void;
+    unsubscribe: <EventId extends Extract<keyof AppEvents, string>>(params: UnsubscribeParam<EventId>) => void;
 }

package/dist/types/lib/tests/flights/23.1/app.checksum1.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "flights";
+declare const appName: "Flights App";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: Window;

package/dist/types/lib/tests/flights/latest/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "flights";
+declare const appName: "Flights App";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: Window;

package/dist/types/lib/tests/hotels/23.1/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "hotels";
+declare const appName: "Hotels App";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: Window;

package/dist/types/lib/tests/hotels/latest/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "hotels";
+declare const appName: "Hotels App";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: Window;

package/dist/types/lib/tests/loan/latest/index.d.ts

@@ -0,0 +1,11 @@
+declare const appId: "loanapp";
+declare const appName: "Loan App";
+declare const appElementId: "pui-app-container-flights";
+declare const pipelinePath: "/pipeline";
+declare const pipelineLinkText: "Pipeline";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare function setFrameSize(): void;
+declare const browserWindow: Window;

package/dist/types/lib/tests/scriptingObjects/analytics.d.ts

@@ -2,7 +2,7 @@ import { IAnalytics, BAEvent, TimingOptions } from '@elliemae/pui-scripting-obje
 import { ScriptingObject } from '@elliemae/microfe-common';
 export declare class Analytics extends ScriptingObject implements IAnalytics {
     constructor();
-    sendBAEvent(event: BAEvent): Promise<void>;
-    startTiming(name: string, options: TimingOptions): Promise<PerformanceMark>;
-    endTiming(start: string | PerformanceMeasure, options: TimingOptions): Promise<void>;
+    sendBAEvent: (event: BAEvent) => Promise<void>;
+    startTiming: (name: string, options: TimingOptions) => Promise<PerformanceMark>;
+    endTiming: (start: string | PerformanceMeasure, options: TimingOptions) => Promise<void>;
 }

package/dist/types/lib/tests/scriptingObjects/appraisalServiceModule.d.ts

@@ -1,4 +1,4 @@
-import { IModule, Listener, Events } from '@elliemae/pui-scripting-object';
+import { IModule, Listener, Events, LogLevels, LogMessage } from '@elliemae/pui-scripting-object';
 import { ScriptingObject, Event } from '@elliemae/microfe-common';
 export type AppraisalServiceEvents = {
     'appraisalservice.onprecommit': Listener<AppraisalService, {
@@ -31,5 +31,6 @@ export declare class AppraisalService extends ScriptingObject implements IModule
     saveLoan: () => Promise<void>;
     commit: () => Promise<unknown>;
     delete: () => never;
+    log: (message: string | LogMessage, level: keyof typeof LogLevels) => Promise<void>;
     unload: () => Promise<void>;
 }

package/dist/types/lib/tests/task/latest/index.d.ts

@@ -0,0 +1,10 @@
+declare const appId: "taskapp";
+declare const appName: "Task App";
+declare const appElementId: "pui-app-container-flights";
+declare const pipelinePath: "/pipeline";
+declare const pipelineLinkText: "Pipeline";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: Window;

package/dist/types/lib/tests/task/latest/index.dev.d.ts

@@ -0,0 +1,10 @@
+declare const appId: "taskapp";
+declare const appName: "Task App Dev";
+declare const appElementId: "pui-app-container-flights";
+declare const pipelinePath: "/pipeline";
+declare const pipelineLinkText: "Pipeline";
+declare function getWindow(): Window;
+declare let host: null;
+declare let parentHistory: null;
+declare let logger: null;
+declare const browserWindow: Window;

package/dist/types/lib/tests/travelhub/23.1/app.checksum.d.ts

@@ -0,0 +1,7 @@
+declare const appId: "travelhub";
+declare const appName: "Travel Hub";
+declare function getWindow(): Window;
+declare const browserWindow: Window;
+declare const mainElement: HTMLElement;
+declare const pageHeaderEle: HTMLHeadingElement;
+declare const versionEle: HTMLParagraphElement;

package/dist/types/lib/tests/travelhub/23.1/landing.checksum1.d.ts

@@ -0,0 +1,2 @@
+declare const mainElement: HTMLElement | null;
+declare const contentEle: HTMLParagraphElement;

package/dist/types/lib/typings/appInfo.d.ts

@@ -5,5 +5,6 @@ export type AppInfo = {
     hostUrl: string;
     manifestPath: string;
     homeRoute: string;
+    isJsModule: boolean;
     files: Array<string>;
 };

package/dist/types/lib/typings/common.d.ts

@@ -1,9 +1,3 @@
-import { IScriptingObject } from '@elliemae/pui-scripting-object';
-import type { Listener } from '@elliemae/microfe-common';
-/**
- * collection of scripting objects
- */
-export type ScriptingObjects = Record<string, IScriptingObject>;
 export type ValueOf<T> = T[keyof T];
 /**
  * security context under which the guest application is running
@@ -18,63 +12,3 @@ export declare enum SecurityContext {
      */
     PARTNER = "PARTNER"
 }
-/**
- * parameters for subscribing to an event
- */
-export type SubscribeParam<EventId, EventListener extends Listener<any, any, any, any>> = {
-    /**
-     * unique id of the event
-     */
-    eventId: EventId;
-    /**
-     * event listener
-     */
-    listener: EventListener;
-};
-/**
- * parameters for unsubscribing from an event
- */
-export type UnsubscribeParam<EventId> = {
-    /**
-     * unique id of the event
-     */
-    eventId: EventId;
-    /**
-     * subscription id
-     */
-    subscriptionId?: string;
-};
-/**
- * parameters for dispatching an event
- */
-export type DispatchEventParam<EventId, Params> = {
-    /**
-     * event details
-     */
-    event: {
-        /**
-         * unique id of the event
-         */
-        id: EventId;
-        /**
-         * name of the event
-         */
-        name: string;
-        /**
-         * flag indicating this event requires feedback from all of the listeners
-         */
-        requiresFeedback: boolean;
-        /**
-         * scripting object that owns this event
-         */
-        scriptingObject: IScriptingObject;
-    };
-    /**
-     * event parameters
-     */
-    eventParams: Params;
-    /**
-     * time to wait for feedback from listeners. milliseconds
-     */
-    feedbackWaitTime?: number;
-};

package/dist/types/lib/typings/guest.d.ts

@@ -1,10 +1,9 @@
-import { History } from 'history';
+import { History, To } from 'history';
 import { DefaultTheme } from 'styled-components';
 import { Logger } from '@elliemae/pui-diagnostics';
 import { BreakPoint } from '@elliemae/pui-theme';
 import { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
-import type { EventListeners } from '@elliemae/microfe-common';
-import { ScriptingObjects } from './common.js';
+import type { EventListeners, ScriptingObjects } from '@elliemae/microfe-common';
 import { IMicroFEHost } from './host.js';
 /**
  * Viewport size
@@ -43,6 +42,10 @@ export type InitParams<AppObjects extends ScriptingObjects = Partial<ScriptingOb
      * home route of the application
      */
     homeRoute?: string;
+    /**
+     * initial route of the application
+     */
+    initialRoute?: To;
     /**
      * previous state of the application
      */
@@ -91,6 +94,10 @@ export type MountParams = {
  * @typeParam AppEvents - scripting object events
  */
 export interface IMicroFEGuest<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>, AppEvents extends EventListeners = Events> {
+    /**
+     * unique guest instance id
+     */
+    uuid: string;
     /**
      * guest window object
      */