@elliemae/ssf-guest 2.9.9 → 2.17.0

package/dist/esm/guest.js

@@ -5,7 +5,8 @@ import {
   sendMessage,
   MessageType,
   getEventId,
-  ProxyEvent
+  ProxyEvent,
+  ScriptingObjectProxy
 } from "@elliemae/microfe-common";
 import {
   logger as puiLogger,
@@ -15,7 +16,6 @@ import {
   webvitals,
   logUnhandledErrors
 } from "@elliemae/pui-diagnostics";
-import { Proxy } from "./proxy.js";
 import {
   getOrigin,
   isEmbedded,
@@ -23,6 +23,7 @@ import {
   getHostDetails,
   getParentWindowLocation
 } from "./utils.js";
+import { setupV1Adapter, setScriptOnlyGuest } from "./v1-adapter.js";
 var ResponseType = /* @__PURE__ */ ((ResponseType2) => {
   ResponseType2["OBJECT"] = "object";
   ResponseType2["VALUE"] = "value";
@@ -52,8 +53,21 @@ const onLoad = () => {
 if (isEmbedded()) {
   window.addEventListener("load", onLoad);
 }
-const DIAGNOSTICS_URL = "https://api.elliemae.com/diagnostics/v2/logging";
+const diagnosticsEndpoint = {
+  "cdn.ice.com": "https://api.elliemae.com/diagnostics/v2/logging",
+  "cdn.np.ice.com": "https://stg.api.elliemae.com/diagnostics/v2/logging",
+  "cdn.uat.ice.com": "https://concept.api.elliemae.com/diagnostics/v2/logging",
+  "cdn.pt1.ice.com": "https://pel1.api.ellielabs.com/diagnostics/v2/logging",
+  "cdn.qa1.ice.com": "https://int.api.ellielabs.com/diagnostics/v2/logging",
+  "cdn.dev1.ice.com": "https://int.api.ellielabs.com/diagnostics/v2/logging",
+  localhost: "https://int.api.ellielabs.com/diagnostics/v2/logging"
+};
 const userInteractionEvents = ["click", "scroll", "keypress", "touchstart"];
+const getDiagnosticsAPIUrl = () => {
+  const scriptUrl = document.currentScript?.src || import.meta.url;
+  const hostName = scriptUrl ? new URL(scriptUrl).hostname : "localhost";
+  return diagnosticsEndpoint[hostName] || diagnosticsEndpoint["cdn.qa1.ice.com"];
+};
 class SSFGuest {
   /* eslint-enable indent */
   #correlationId;
@@ -104,21 +118,22 @@ class SSFGuest {
    * Create new guest
    * @param {GuestOption} options - options for the guest
    */
+  // eslint-disable-next-line complexity
   constructor(options) {
     const {
       console: logToConsole = false,
       // eslint-disable-next-line no-underscore-dangle
-      url = window.__ICE__?.diagnosticsUrl || DIAGNOSTICS_URL,
-      index,
-      team,
-      appName
+      url = window.__ICE__?.diagnosticsUrl || getDiagnosticsAPIUrl(),
+      index = "ssf-guest-v2",
+      team = "ICE",
+      appName = "SSF Guest V2 Application"
     } = options?.logger ?? {};
     this.#loggerOptions = options?.logger;
     this.#usesDevConnectAPI = options?.usesDevConnectAPI ?? false;
     this.#keepAlive = options?.keepAlive ?? true;
     this.#keepAliveInterval = options?.keepAliveInterval ?? KEEP_ALIVE_INTERVAL;
     const transport = logToConsole ? Console() : http(url);
-    this.#logger = puiLogger({
+    this.#logger = options?.appLogger ?? puiLogger({
       transport,
       index,
       team,
@@ -128,6 +143,7 @@ class SSFGuest {
     logUnhandledErrors(this.#logger);
     this.#correlationId = uuidv4();
     this.#remoting = new Remoting(this.#logger, this.#correlationId);
+    setupV1Adapter(this);
     this.#logger.audit({
       message: "Guest created",
       guestUrl: window.location.href,
@@ -151,7 +167,7 @@ class SSFGuest {
       );
       throw new Error("Cannot deserialize object JSON into proxy.");
     }
-    const ctrl = new Proxy(soJSON.objectId, soJSON.objectType);
+    const ctrl = new ScriptingObjectProxy(soJSON.objectId, soJSON.objectType);
     if (soJSON.functions) {
       soJSON.functions.forEach((functionName) => {
         Object.defineProperty(ctrl, functionName, {
@@ -169,7 +185,8 @@ class SSFGuest {
         Object.defineProperty(ctrl, eventName, {
           value: new ProxyEvent({
             objectId: ctrl.id,
-            name: eventName
+            name: eventName,
+            eventSrc: this
           }),
           enumerable: true
         });
@@ -448,19 +465,27 @@ class SSFGuest {
    */
   #useParentApplicationLogger = async () => {
     try {
-      const appObj = await this.getObject("application");
-      if (appObj?.log && !this.#loggerOptions.console) {
-        const { index, team, appName } = this.#loggerOptions;
+      const moduleObj = await this.getObject("module");
+      if (moduleObj?.log && !this.#loggerOptions.console) {
+        const {
+          index = "",
+          team = "",
+          appName = ""
+        } = this.#loggerOptions || {};
+        if (!index || !team || !appName)
+          throw new Error(
+            "Missing one of required logger options: index, team, appName"
+          );
         this.#logger = puiLogger({
-          transport: parentApp(appObj),
+          transport: parentApp(moduleObj),
           index,
           team,
           appName
         });
       }
     } catch (e) {
-      this.#logger.error(
-        `Error getting application object. ${e.message}`
+      this.#logger.info(
+        `Module object not exposed from hosting application. using local logger instance. ${e.message}`
       );
     }
   };
@@ -474,10 +499,12 @@ class SSFGuest {
       await this.connect();
       const scriptEle = document.createElement("script");
       scriptEle.setAttribute("src", scriptUri);
+      scriptEle.setAttribute("type", "module");
       await new Promise((resolve) => {
         const onScriptLoad = () => {
           scriptEle?.removeEventListener?.("load", onScriptLoad);
           this.#created = true;
+          setScriptOnlyGuest(true);
           resolve();
         };
         scriptEle.addEventListener("load", onScriptLoad);
@@ -568,7 +595,6 @@ class SSFGuest {
       this.#handleParentClose();
       if (this.#usesDevConnectAPI) await this.getAuthToken();
       await this.#startKeepSessionAlive();
-      await this.#useParentApplicationLogger();
       window.addEventListener("beforeunload", this.close);
       this.#logger.audit({
         message: "Guest connected to host",
@@ -611,6 +637,7 @@ class SSFGuest {
     this.#logger.debug(
       `Retrieving scripting object "${objectId}" from host...`
     );
+    if (!this.#isConnected) throw new Error("Not connected to host");
     const response = await this.#remoting.invoke({
       targetWin: this.#hostWindow,
       targetOrigin: this.#hostOrigin,
@@ -627,6 +654,28 @@ class SSFGuest {
     });
     return obj;
   };
+  /**
+   * Get names of scripting objects exposed by the host
+   * @returns scripting objects exposed by the host
+   */
+  listObjects = async () => {
+    this.#logger.debug(
+      `Retrieving names of scripting objects exposed by host...`
+    );
+    if (!this.#isConnected) throw new Error("Not connected to host");
+    const objects = await this.#remoting.invoke({
+      targetWin: this.#hostWindow,
+      targetOrigin: this.#hostOrigin,
+      messageType: MessageType.ListObjects,
+      messageBody: {}
+    });
+    this.#logger.audit({
+      message: "Received names of all scripting objects exposed by host",
+      objects,
+      ...this.#getGuestInfo()
+    });
+    return objects;
+  };
   /**
    * remove the guest from the host
    */
@@ -648,30 +697,30 @@ class SSFGuest {
   };
   /**
    * subscribe to an scripting object event
-   * @param {GuestSubscribeParam<EventId, AppEvents[EventId]>} param - parameters for subscribing to an event
+   * @param {SubscribeParam<EventId, AppEvents[EventId]>} param - parameters for subscribing to an event
    * @returns subscription token
    */
   subscribe = (param) => {
     const { eventId, callback } = param;
     this.#logger.debug(`Registering subscription for event ${eventId}`);
-    const listeners = this.#eventListeners.get(eventId) || [];
+    const listeners = this.#eventListeners.get(eventId.toLowerCase()) || [];
     const token = uuidv4();
     listeners.push({ callback, token });
-    this.#eventListeners.set(eventId, listeners);
+    this.#eventListeners.set(eventId.toLowerCase(), listeners);
     return token;
   };
   /**
    * unsubscribe from an scripting object event
-   * @param {GuestUnsubscribeParam<EventId>} param - parameters for unsubscribing from an event
+   * @param {UnsubscribeParam<EventId>} param - parameters for unsubscribing from an event
    */
   unsubscribe = (param) => {
     const { eventId, token } = param;
-    let listeners = this.#eventListeners.get(eventId);
+    let listeners = this.#eventListeners.get(eventId.toLowerCase());
     if (listeners) {
       listeners = listeners.filter(
         (callbackInfo) => callbackInfo.token !== token
       );
-      this.#eventListeners.set(eventId, listeners);
+      this.#eventListeners.set(eventId.toLowerCase(), listeners);
     }
   };
 }

package/dist/esm/loanValidation.html

@@ -10,7 +10,7 @@
         margin: 0px;
       }
     </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 class="px-2">
     <script src="./loanValidation.js" type="module"></script>

package/dist/esm/pricingService.html

@@ -6,7 +6,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Pricing Service</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 class="px-2">
     <main>

package/dist/esm/tests/utils.js

@@ -130,9 +130,19 @@ const applicationScriptingObject = {
   },
   type: "object"
 };
+const moduleScriptingObject = {
+  object: {
+    events: [],
+    functions: ["getParameters", "getCapabilities", "log", "unload"],
+    objectId: "module",
+    objectType: "Object"
+  },
+  type: "object"
+};
 const hostObjects = {
   application: applicationScriptingObject,
-  auth: authScriptingObject
+  auth: authScriptingObject,
+  module: moduleScriptingObject
 };
 const setupHost = (hostWindow) => {
   const onMessage = ({ data }) => {

package/dist/esm/titleService.html

@@ -1,31 +1,30 @@
 <!DOCTYPE html>
 <html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Title Service</title>
+    <style>
+      body {
+        margin: 0px;
+      }
+    </style>
+    <script src="https://cdn.tailwindcss.com?plugins=forms"></script>
+    <script src="https://cdn.qa1.ice.com/pui-diagnostics@3"></script>
+  </head>
 
-<head>
-  <meta charset="UTF-8" />
-  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Title Service</title>
-  <style>
-    body {
-      margin: 0px;
-    }
-  </style>
-  <script src="https://cdn.tailwindcss.com?plugins=forms"></script>
-  <script src="https://qa.assets.rd.elliemae.io/pui-diagnostics@3"></script>
-</head>
-
-<body class="px-2">
-  <h3 class="text-lg font-medium leading-6 text-gray-900">
-    Title
-  </h3>
-  <div class="mt-5 flex flex-col">
-    <button id="order" type="button"
-      class="rounded-md border border-transparent bg-indigo-600 px-4 py-2 text-sm font-medium text-white shadow-sm hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:ring-offset-2">
-      Order
-    </button>
-  </div>
-  <script src="./titleService.js" type="module"></script>
-</body>
-
-</html>
+  <body class="px-2">
+    <h3 class="text-lg font-medium leading-6 text-gray-900">Title</h3>
+    <div class="mt-5 flex flex-col">
+      <button
+        id="order"
+        type="button"
+        class="rounded-md border border-transparent bg-indigo-600 px-4 py-2 text-sm font-medium text-white shadow-sm hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:ring-offset-2"
+      >
+        Order
+      </button>
+    </div>
+    <script src="./titleService.js" type="module"></script>
+  </body>
+</html>

package/dist/esm/v1-adapter.js

@@ -0,0 +1,72 @@
+let scriptOnlyGuest = false;
+const setScriptOnlyGuest = (value) => {
+  scriptOnlyGuest = value;
+};
+const setupV1Adapter = (guestV2 = null) => {
+  let guest = guestV2;
+  const getGuest = () => {
+    if (!guest) {
+      guest = window.ice?.guest?.SSFGuest ? new window.ice.guest.SSFGuest() : null;
+      if (!guest) {
+        throw new Error("Guest definition not found");
+      }
+    }
+    return guest;
+  };
+  window.elli = window.elli ?? {};
+  window.elli.script = {
+    guest: {
+      create: async (scriptUri, element) => getGuest().addScript(scriptUri, element)
+    },
+    connect: async (params) => {
+      console.warn(
+        "elli.script.connect is deprecated. Please use connect method of SSFGuest class instead, const guest = new ice.guest.SSFGuest(); await guest.connect(params);"
+      );
+      return getGuest().connect(params);
+    },
+    getObject: async (objectName) => {
+      if (!scriptOnlyGuest)
+        console.warn(
+          "elli.script.getObject is deprecated. Please use getObject method of SSFGuest class instead, const guest = new ice.guest.SSFGuest(); await guest.getObject(objectName);"
+        );
+      return getGuest().getObject(objectName);
+    },
+    setLogLevel: (level) => {
+      if (!scriptOnlyGuest)
+        console.warn(
+          "elli.script.setLogLevel is deprecated. Please use setLogLevel method of SSFGuest class instead, const guest = new ice.guest.SSFGuest(); guest.setLogLevel(level);"
+        );
+      return getGuest().setLogLevel(level);
+    },
+    subscribe: (objectId, eventName, callback) => {
+      if (!scriptOnlyGuest)
+        console.warn(
+          // eslint-disable-next-line no-template-curly-in-string
+          "elli.script.subscribe is deprecated. Please use subscribe method of SSFGuest class instead, const guest = new ice.guest.SSFGuest(); guest.subscribe({ eventId: `${objectId}.${eventName}`, callback: (event) => { console.log(event); });"
+        );
+      return getGuest().subscribe({
+        eventId: `${objectId}.${eventName}`,
+        // eslint-disable-line @typescript-eslint/no-unsafe-assignment
+        callback: (event) => callback(event?.obj, event?.eventParams, event?.eventOptions)
+        // eslint-disable-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
+      });
+    },
+    unsubscribe: (objectId, eventName, token) => {
+      if (!scriptOnlyGuest)
+        console.warn(
+          // eslint-disable-next-line no-template-curly-in-string
+          "elli.script.unsubscribe is deprecated. Please use unsubscribe method of SSFGuest class instead, const guest = new ice.guest.SSFGuest(); guest.unsubscribe({ eventId: `${objectId}.${eventName}`, token });"
+        );
+      return getGuest().unsubscribe({
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        eventId: `${objectId}.${eventName}`,
+        token
+      });
+    }
+  };
+};
+setupV1Adapter();
+export {
+  setScriptOnlyGuest,
+  setupV1Adapter
+};

package/dist/esm/v2-guest.html

@@ -4,7 +4,7 @@
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Guest V2</title>
-    <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>
     <h2>Guest V2</h2>
@@ -13,10 +13,6 @@
       <p id="loan-pre-save-event-details"></p>
     </div>
     <script type="module">
-      window.__ICE__ = {
-        diagnosticsUrl: 'https://int.api.ellielabs.com/diagnostics/v2/logging',
-      };
-
       window.addEventListener('load', async () => {
         const guestV2 = new ice.guest.SSFGuest({
           logger: {

package/dist/public/creditService.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width,initial-scale=1"/><title>Credit Service</title><style>body{margin:0}</style><script src="https://qa.assets.rd.elliemae.io/pui-diagnostics@3"></script><script>window.addEventListener("DOMContentLoaded",(async()=>{window.__ICE__={diagnosticsUrl:"https://int.api.ellielabs.com/diagnostics/v2/logging"};const e=new URL(window.location),i=e?.searchParams?.get?.("src");window.__ICE__.ssfGuest=new ice.guest.SSFGuest({logger:{index:"creditServiceGuest",team:"ui platform",appName:"credit-service"}}),await window.__ICE__.ssfGuest.addScript(i,document.body)}))</script><script defer="defer" src="js/emuiSsfGuest.f2e6a00ee4685efdf26f.js"></script></head><body></body></html>
+<!doctype html><html lang="en"><head><meta charset="UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width,initial-scale=1"/><title>Credit Service</title><style>body{margin:0}</style><script src="https://cdn.qa1.ice.com/pui-diagnostics@3"></script><script>window.addEventListener("DOMContentLoaded",(async()=>{window.__ICE__={diagnosticsUrl:"https://int.api.ellielabs.com/diagnostics/v2/logging"};const e=new URL(window.location),i=e?.searchParams?.get?.("src");window.__ICE__.ssfGuest=new ice.guest.SSFGuest({logger:{index:"creditServiceGuest",team:"ui platform",appName:"credit-service"}}),await window.__ICE__.ssfGuest.addScript(i,document.body)}))</script><script defer="defer" src="js/emuiSsfGuest.a6277961cb41c8cde6b0.js"></script></head><body></body></html>

package/dist/public/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en" style="height:100%"><head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Plugin</title><script src="https://cdn.tailwindcss.com?plugins=forms"></script><script defer="defer" src="js/emuiSsfGuest.f2e6a00ee4685efdf26f.js"></script></head><body class="px-2 h-full"><main class="h-full"><h1 class="text-md font-bold">Credit Score Service</h1><div class="h-full mt-2"><output id="msg" class="mt-2 p-2"></output></div></main></body></html>
+<!doctype html><html lang="en" style="height:100%"><head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Plugin</title><script src="https://cdn.tailwindcss.com?plugins=forms"></script><script defer="defer" src="js/emuiSsfGuest.a6277961cb41c8cde6b0.js"></script></head><body class="px-2 h-full"><main class="h-full"><h1 class="text-md font-bold">Credit Score Service</h1><div class="h-full mt-2"><output id="msg" class="mt-2 p-2"></output></div></main></body></html>