@elliemae/ssf-host 2.9.9 → 2.17.0

package/dist/cjs/host.js

@@ -201,7 +201,9 @@ class SSFHost {
       if (!Object.prototype.hasOwnProperty.call(func, "callContext")) {
         Object.defineProperty(func, "callContext", {
           value: { guest },
-          enumerable: true
+          configurable: true,
+          enumerable: true,
+          writable: true
         });
       }
       resolve(func(...functionParams));
@@ -291,6 +293,35 @@ class SSFHost {
       }
     }
   };
+  // Handles list objects requests from the remote automation framework
+  #handleListObjects = ({
+    sourceWin,
+    sourceOrigin,
+    requestId
+  }) => {
+    this.#logger.debug(
+      `Processing listObjects request. requestId = ${requestId}`
+    );
+    const guest = this.#getGuestForWindow(sourceWin);
+    if (!guest) {
+      this.#logger.warn("Rejected object request from unknown guest window");
+      return false;
+    }
+    const objects = this.#soManager.listScriptingObjects(guest.id);
+    this.#remoting.respond({
+      targetWin: sourceWin,
+      targetOrigin: sourceOrigin,
+      requestId,
+      response: objects
+    });
+    this.#logger.audit({
+      message: `name of scripting objects returned`,
+      requestId,
+      objects,
+      ...guest.getInfo()
+    });
+    return true;
+  };
   // Handles object get requests from the remote automation framework
   #handleObjectGet = ({
     sourceWin,
@@ -305,12 +336,6 @@ class SSFHost {
     const guest = this.#getGuestForWindow(sourceWin);
     if (!guest) {
       this.#logger.warn("Rejected object request from unknown guest window");
-      this.#remoting.raiseException({
-        targetWin: sourceWin,
-        targetOrigin: sourceOrigin,
-        requestId,
-        ex: "Specified window is not a known guest"
-      });
       return false;
     }
     const obj = this.getScriptingObject(objectId, { guest });
@@ -373,18 +398,12 @@ class SSFHost {
       this.#logger.warn(
         "Rejected method invocation request from unknown guest window"
       );
-      this.#remoting.raiseException({
-        targetWin: sourceWin,
-        targetOrigin: sourceOrigin,
-        requestId,
-        ex: "Specified window is not a known guest"
-      });
       return false;
     }
     this.#logger.debug(
       `Function ${objectId}.${String(body.functionName)}() called from guest "${guest.id}" (requestId = ${requestId})`
     );
-    const obj = this.getScriptingObject(objectId);
+    const obj = this.getScriptingObject(objectId, { guest });
     if (!obj) {
       this.#logger.warn(
         `Invocation of unknown or unauthorized object ${objectId} from guest ${guest.id}`
@@ -472,6 +491,10 @@ class SSFHost {
       // eslint-disable-next-line  @typescript-eslint/no-misused-promises
       callback: this.#handleGuestClose
     });
+    this.#remoting.listen({
+      messageType: import_microfe_common.MessageType.ListObjects,
+      callback: this.#handleListObjects
+    });
     this.#remoting.listen({
       messageType: import_microfe_common.MessageType.ObjectGet,
       callback: this.#handleObjectGet
@@ -534,7 +557,7 @@ class SSFHost {
         this.unloadGuest(id);
         const callbacks = this.#guestCloseCallbackList.get(id);
         callbacks?.forEach((callback) => {
-          callback().catch(() => {
+          callback({ id }).catch(() => {
           });
         });
       });
@@ -601,7 +624,8 @@ class SSFHost {
       fitToContent = false,
       disableSandbox = false,
       sandboxValues = [],
-      style = ""
+      style = "",
+      permissionPolicy = ""
     } = options;
     if (!title) throw new Error("title is required");
     if (fitToContent) this.#subscribeToGuestResizeEvent();
@@ -624,6 +648,7 @@ class SSFHost {
     }
     frame.setAttribute("title", title);
     frame.setAttribute("src", url);
+    if (permissionPolicy) frame.setAttribute("allow", permissionPolicy);
     targetElement.appendChild(frame);
     const guestFrameEle = targetElementDocument.getElementById(
       guestId
@@ -651,7 +676,12 @@ class SSFHost {
    * @param {AddScriptingObjectParams} params params to add scripting object
    */
   addScriptingObject = (so, params) => {
-    this.#soManager.addScriptingObject(so, params);
+    if ((0, import_microfe_common.isScriptingObjectProxy)(so)) {
+      const clonedSo = this.cloneScriptingObject(so);
+      this.#soManager.addScriptingObject(clonedSo, params);
+    } else {
+      this.#soManager.addScriptingObject(so, params);
+    }
   };
   /**
    * Clone parent host's scripting object for exposing to grand children
@@ -659,29 +689,22 @@ class SSFHost {
    * @param guest - reference to the ssf guest
    * @returns cloned version of the scripting object
    */
-  cloneScriptingObject = (proxy, guest) => {
+  cloneScriptingObject = (proxy) => {
     if (!proxy) throw new Error("proxy is required");
-    if (!guest) throw new Error("guest is required");
     const so = new import_microfe_common.ScriptingObject(proxy.id, proxy.objectType);
     let unsubscribers = [];
     Object.keys(proxy).forEach((propName) => {
       const propValue = proxy[propName];
       if (this.#isProxyEvent(propValue)) {
-        let event;
-        if (propValue?.subscribe !== "function") {
-          event = new import_microfe_common.Event({
-            name: propValue.name || propName,
-            requiresFeedback: false,
-            so
-          });
-        } else {
-          event = new automation.Event();
-        }
+        const event = new import_microfe_common.Event({
+          name: propValue.name || propName,
+          objectId: so.id
+        });
         Object.defineProperty(so, propName, {
           value: event,
           enumerable: true
         });
-        if (guest.subscribe) {
+        if (propValue instanceof import_microfe_common.ProxyEvent) {
           const listener = ({
             eventParams,
             eventOptions
@@ -692,13 +715,11 @@ class SSFHost {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             eventOptions
           });
-          const token = guest.subscribe({
-            eventId: propValue.id,
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            callback: listener
-          });
+          const token = propValue.subscribe(
+            listener
+          );
           unsubscribers.push(() => {
-            guest.unsubscribe({ eventId: propValue.id, token });
+            propValue.unsubscribe(token);
           });
         } else {
           const token = propValue.subscribe?.(
@@ -718,7 +739,7 @@ class SSFHost {
         Object.defineProperty(so, propName, {
           value: async (...args) => {
             const retVal = await propValue(...args);
-            return (0, import_utils.isProxy)(retVal) ? this.cloneScriptingObject(retVal, guest) : retVal;
+            return (0, import_microfe_common.isScriptingObjectProxy)(retVal) ? this.cloneScriptingObject(retVal) : retVal;
           },
           enumerable: true
         });
@@ -756,20 +777,31 @@ class SSFHost {
   };
   /**
    * dispatch event to guest application(s)
-   * @param {EventDetail} details details of the event to be dispatched
+   * @param {EventDetail} params details of the event to be dispatched
    * @returns promise that resolves to an array with result from each guest application
    */
-  dispatchEvent = async (details) => {
+  dispatchEvent = async (params) => {
     const {
-      event: { id, name, scriptingObject },
+      event: { id, name },
       eventParams,
       eventOptions = {}
-    } = details;
+    } = params;
     const {
       eventHandler = null,
       timeout = null,
-      window: targetWindow = null
+      window: targetWindow = null,
+      guestId
     } = eventOptions;
+    const objectId = id.split(".")[0];
+    const guestIdorWnd = guestId || targetWindow;
+    const targetGuest = guestIdorWnd ? this.#findGuest(guestIdorWnd) : null;
+    const scriptingObject = targetGuest ? this.getScriptingObject(objectId, { guest: targetGuest }) : this.getScriptingObject(objectId);
+    if (!scriptingObject) {
+      this.#logger.warn(
+        `Attempt to dispatch event ${name} on unknown object ${objectId}`
+      );
+      return Promise.resolve([]);
+    }
     const eventObj = {
       // eslint-disable-next-line no-underscore-dangle
       object: scriptingObject._toJSON(),

package/dist/cjs/index.html

@@ -7,7 +7,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Host</title>
   <script src="https://cdn.tailwindcss.com?plugins=forms"></script>
-  <script src="https://qa.assets.rd.elliemae.io/pui-diagnostics@3"></script>
+  <script src="https://cdn.qa1.ice.com/pui-diagnostics@3"></script>
 </head>
 
 <body>

package/dist/cjs/tests/scriptingObjects/appObjects.js

@@ -19,8 +19,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var appObjects_exports = {};
 __export(appObjects_exports, {
   APPLICATION_SERVICE_OBJECT: () => APPLICATION_SERVICE_OBJECT,
+  MODULE_OBJECT: () => MODULE_OBJECT,
   applicationScriptingObject: () => applicationScriptingObject,
-  authScriptingObject: () => authScriptingObject
+  authScriptingObject: () => authScriptingObject,
+  moduleScriptingObject: () => moduleScriptingObject
 });
 module.exports = __toCommonJS(appObjects_exports);
 const applicationScriptingObject = {
@@ -55,6 +57,7 @@ const applicationScriptingObject = {
   type: "object"
 };
 const APPLICATION_SERVICE_OBJECT = "application";
+const MODULE_OBJECT = "module";
 const authScriptingObject = {
   object: {
     events: [],
@@ -64,3 +67,12 @@ const authScriptingObject = {
   },
   type: "object"
 };
+const moduleScriptingObject = {
+  object: {
+    events: [],
+    functions: ["getParameters", "getCapabilities", "log", "unload"],
+    objectId: "module",
+    objectType: "Object"
+  },
+  type: "object"
+};

package/dist/cjs/tests/scriptingObjects/appraisalServiceModule.js

@@ -31,23 +31,19 @@ class AppraisalService extends import_microfe_common.ScriptingObject {
   #creditScore;
   Close = new import_microfe_common.Event({
     name: "Close",
-    requiresFeedback: false,
-    so: this
+    objectId: this.constructor.name
   });
   Unloading = new import_microfe_common.Event({
     name: "Unloading",
-    requiresFeedback: false,
-    so: this
+    objectId: this.constructor.name
   });
   onPreCommit = new import_microfe_common.Event({
     name: "onPreCommit",
-    requiresFeedback: true,
-    so: this
+    objectId: this.constructor.name
   });
   onSaved = new import_microfe_common.Event({
     name: "onSaved",
-    requiresFeedback: false,
-    so: this
+    objectId: this.constructor.name
   });
   constructor({
     loanId,
@@ -83,6 +79,10 @@ class AppraisalService extends import_microfe_common.ScriptingObject {
   delete = () => {
     throw new Error("Not implemented");
   };
+  log = async (message, level) => {
+    console.log(message, level);
+    return Promise.resolve();
+  };
   unload = async () => {
   };
 }

package/dist/cjs/tests/scriptingObjects/floodServiceModule.js

@@ -29,13 +29,11 @@ class FloodService extends import_microfe_common.ScriptingObject {
   lastName;
   Close = new import_microfe_common.Event({
     name: "Close",
-    requiresFeedback: false,
-    so: this
+    objectId: this.constructor.name
   });
   Unloading = new import_microfe_common.Event({
     name: "Unloading",
-    requiresFeedback: true,
-    so: this
+    objectId: this.constructor.name
   });
   constructor() {
     super("FloodService");
@@ -50,6 +48,10 @@ class FloodService extends import_microfe_common.ScriptingObject {
   getParameters = () => Promise.resolve({
     moduleId: "floodService"
   });
+  log = async (message, level) => {
+    console.log(message, level);
+    return Promise.resolve();
+  };
   unload = () => Promise.resolve();
   _dispose = () => {
   };

package/dist/cjs/utils.js

@@ -22,7 +22,6 @@ __export(utils_exports, {
   getObjectId: () => getObjectId,
   getOrigin: () => getOrigin,
   isFunction: () => isFunction,
-  isProxy: () => isProxy,
   isScriptingObject: () => isScriptingObject
 });
 module.exports = __toCommonJS(utils_exports);
@@ -54,8 +53,4 @@ const isScriptingObject = (value) => (
 function isFunction(value) {
   return typeof value === "function";
 }
-const isProxy = (value) => (
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-  value?.constructor?.name === "Proxy"
-);
 const getObjectId = (elementOrId) => elementOrId?.id ?? elementOrId;

package/dist/cjs/v1-guest-v2-host.html

@@ -21,7 +21,7 @@
         height: 100%;
       }
     </style>
-    <script src="https://qa.assets.rd.elliemae.io/pui-diagnostics@3"></script>
+    <script src="https://cdn.qa1.ice.com/pui-diagnostics@3"></script>
     <script src="https://cdn.elliemae.io/elliemae/core/ssf/1.0/elli.ssf.guest.js"></script>
   </head>
   <body>

package/dist/cjs/v2-host-v1-guest.html

@@ -21,7 +21,7 @@
         height: 100%;
       }
     </style>
-    <script src="https://qa.assets.rd.elliemae.io/pui-diagnostics@3"></script>
+    <script src="https://cdn.qa1.ice.com/pui-diagnostics@3"></script>
   </head>
   <body>
     <main>

package/dist/esm/host.js

@@ -5,14 +5,15 @@ import {
   MessageType,
   Event,
   ScriptingObjectManager,
-  ProxyEvent
+  ProxyEvent,
+  isScriptingObjectProxy
 } from "@elliemae/microfe-common";
 import {
   IFrameSandboxValues,
   OpenMode
 } from "./types.js";
 import { Guest } from "./guest.js";
-import { flatten, isFunction, isProxy } from "./utils.js";
+import { flatten, isFunction } from "./utils.js";
 const SANDBOX_DEFAULT = [
   IFrameSandboxValues.AllowScripts,
   IFrameSandboxValues.AllowPopups,
@@ -188,7 +189,9 @@ class SSFHost {
       if (!Object.prototype.hasOwnProperty.call(func, "callContext")) {
         Object.defineProperty(func, "callContext", {
           value: { guest },
-          enumerable: true
+          configurable: true,
+          enumerable: true,
+          writable: true
         });
       }
       resolve(func(...functionParams));
@@ -278,6 +281,35 @@ class SSFHost {
       }
     }
   };
+  // Handles list objects requests from the remote automation framework
+  #handleListObjects = ({
+    sourceWin,
+    sourceOrigin,
+    requestId
+  }) => {
+    this.#logger.debug(
+      `Processing listObjects request. requestId = ${requestId}`
+    );
+    const guest = this.#getGuestForWindow(sourceWin);
+    if (!guest) {
+      this.#logger.warn("Rejected object request from unknown guest window");
+      return false;
+    }
+    const objects = this.#soManager.listScriptingObjects(guest.id);
+    this.#remoting.respond({
+      targetWin: sourceWin,
+      targetOrigin: sourceOrigin,
+      requestId,
+      response: objects
+    });
+    this.#logger.audit({
+      message: `name of scripting objects returned`,
+      requestId,
+      objects,
+      ...guest.getInfo()
+    });
+    return true;
+  };
   // Handles object get requests from the remote automation framework
   #handleObjectGet = ({
     sourceWin,
@@ -292,12 +324,6 @@ class SSFHost {
     const guest = this.#getGuestForWindow(sourceWin);
     if (!guest) {
       this.#logger.warn("Rejected object request from unknown guest window");
-      this.#remoting.raiseException({
-        targetWin: sourceWin,
-        targetOrigin: sourceOrigin,
-        requestId,
-        ex: "Specified window is not a known guest"
-      });
       return false;
     }
     const obj = this.getScriptingObject(objectId, { guest });
@@ -360,18 +386,12 @@ class SSFHost {
       this.#logger.warn(
         "Rejected method invocation request from unknown guest window"
       );
-      this.#remoting.raiseException({
-        targetWin: sourceWin,
-        targetOrigin: sourceOrigin,
-        requestId,
-        ex: "Specified window is not a known guest"
-      });
       return false;
     }
     this.#logger.debug(
       `Function ${objectId}.${String(body.functionName)}() called from guest "${guest.id}" (requestId = ${requestId})`
     );
-    const obj = this.getScriptingObject(objectId);
+    const obj = this.getScriptingObject(objectId, { guest });
     if (!obj) {
       this.#logger.warn(
         `Invocation of unknown or unauthorized object ${objectId} from guest ${guest.id}`
@@ -459,6 +479,10 @@ class SSFHost {
       // eslint-disable-next-line  @typescript-eslint/no-misused-promises
       callback: this.#handleGuestClose
     });
+    this.#remoting.listen({
+      messageType: MessageType.ListObjects,
+      callback: this.#handleListObjects
+    });
     this.#remoting.listen({
       messageType: MessageType.ObjectGet,
       callback: this.#handleObjectGet
@@ -521,7 +545,7 @@ class SSFHost {
         this.unloadGuest(id);
         const callbacks = this.#guestCloseCallbackList.get(id);
         callbacks?.forEach((callback) => {
-          callback().catch(() => {
+          callback({ id }).catch(() => {
           });
         });
       });
@@ -588,7 +612,8 @@ class SSFHost {
       fitToContent = false,
       disableSandbox = false,
       sandboxValues = [],
-      style = ""
+      style = "",
+      permissionPolicy = ""
     } = options;
     if (!title) throw new Error("title is required");
     if (fitToContent) this.#subscribeToGuestResizeEvent();
@@ -611,6 +636,7 @@ class SSFHost {
     }
     frame.setAttribute("title", title);
     frame.setAttribute("src", url);
+    if (permissionPolicy) frame.setAttribute("allow", permissionPolicy);
     targetElement.appendChild(frame);
     const guestFrameEle = targetElementDocument.getElementById(
       guestId
@@ -638,7 +664,12 @@ class SSFHost {
    * @param {AddScriptingObjectParams} params params to add scripting object
    */
   addScriptingObject = (so, params) => {
-    this.#soManager.addScriptingObject(so, params);
+    if (isScriptingObjectProxy(so)) {
+      const clonedSo = this.cloneScriptingObject(so);
+      this.#soManager.addScriptingObject(clonedSo, params);
+    } else {
+      this.#soManager.addScriptingObject(so, params);
+    }
   };
   /**
    * Clone parent host's scripting object for exposing to grand children
@@ -646,29 +677,22 @@ class SSFHost {
    * @param guest - reference to the ssf guest
    * @returns cloned version of the scripting object
    */
-  cloneScriptingObject = (proxy, guest) => {
+  cloneScriptingObject = (proxy) => {
     if (!proxy) throw new Error("proxy is required");
-    if (!guest) throw new Error("guest is required");
     const so = new ScriptingObject(proxy.id, proxy.objectType);
     let unsubscribers = [];
     Object.keys(proxy).forEach((propName) => {
       const propValue = proxy[propName];
       if (this.#isProxyEvent(propValue)) {
-        let event;
-        if (propValue?.subscribe !== "function") {
-          event = new Event({
-            name: propValue.name || propName,
-            requiresFeedback: false,
-            so
-          });
-        } else {
-          event = new automation.Event();
-        }
+        const event = new Event({
+          name: propValue.name || propName,
+          objectId: so.id
+        });
         Object.defineProperty(so, propName, {
           value: event,
           enumerable: true
         });
-        if (guest.subscribe) {
+        if (propValue instanceof ProxyEvent) {
           const listener = ({
             eventParams,
             eventOptions
@@ -679,13 +703,11 @@ class SSFHost {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             eventOptions
           });
-          const token = guest.subscribe({
-            eventId: propValue.id,
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            callback: listener
-          });
+          const token = propValue.subscribe(
+            listener
+          );
           unsubscribers.push(() => {
-            guest.unsubscribe({ eventId: propValue.id, token });
+            propValue.unsubscribe(token);
           });
         } else {
           const token = propValue.subscribe?.(
@@ -705,7 +727,7 @@ class SSFHost {
         Object.defineProperty(so, propName, {
           value: async (...args) => {
             const retVal = await propValue(...args);
-            return isProxy(retVal) ? this.cloneScriptingObject(retVal, guest) : retVal;
+            return isScriptingObjectProxy(retVal) ? this.cloneScriptingObject(retVal) : retVal;
           },
           enumerable: true
         });
@@ -743,20 +765,31 @@ class SSFHost {
   };
   /**
    * dispatch event to guest application(s)
-   * @param {EventDetail} details details of the event to be dispatched
+   * @param {EventDetail} params details of the event to be dispatched
    * @returns promise that resolves to an array with result from each guest application
    */
-  dispatchEvent = async (details) => {
+  dispatchEvent = async (params) => {
     const {
-      event: { id, name, scriptingObject },
+      event: { id, name },
       eventParams,
       eventOptions = {}
-    } = details;
+    } = params;
     const {
       eventHandler = null,
       timeout = null,
-      window: targetWindow = null
+      window: targetWindow = null,
+      guestId
     } = eventOptions;
+    const objectId = id.split(".")[0];
+    const guestIdorWnd = guestId || targetWindow;
+    const targetGuest = guestIdorWnd ? this.#findGuest(guestIdorWnd) : null;
+    const scriptingObject = targetGuest ? this.getScriptingObject(objectId, { guest: targetGuest }) : this.getScriptingObject(objectId);
+    if (!scriptingObject) {
+      this.#logger.warn(
+        `Attempt to dispatch event ${name} on unknown object ${objectId}`
+      );
+      return Promise.resolve([]);
+    }
     const eventObj = {
       // eslint-disable-next-line no-underscore-dangle
       object: scriptingObject._toJSON(),

package/dist/esm/index.html

@@ -7,7 +7,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Host</title>
   <script src="https://cdn.tailwindcss.com?plugins=forms"></script>
-  <script src="https://qa.assets.rd.elliemae.io/pui-diagnostics@3"></script>
+  <script src="https://cdn.qa1.ice.com/pui-diagnostics@3"></script>
 </head>
 
 <body>

package/dist/esm/tests/scriptingObjects/appObjects.js

@@ -30,6 +30,7 @@ const applicationScriptingObject = {
   type: "object"
 };
 const APPLICATION_SERVICE_OBJECT = "application";
+const MODULE_OBJECT = "module";
 const authScriptingObject = {
   object: {
     events: [],
@@ -39,8 +40,19 @@ const authScriptingObject = {
   },
   type: "object"
 };
+const moduleScriptingObject = {
+  object: {
+    events: [],
+    functions: ["getParameters", "getCapabilities", "log", "unload"],
+    objectId: "module",
+    objectType: "Object"
+  },
+  type: "object"
+};
 export {
   APPLICATION_SERVICE_OBJECT,
+  MODULE_OBJECT,
   applicationScriptingObject,
-  authScriptingObject
+  authScriptingObject,
+  moduleScriptingObject
 };