@elliemae/ssf-guest 2.8.0 → 2.9.1

package/dist/cjs/guest.js

@@ -91,11 +91,15 @@ class SSFGuest {
   /**
    * flag to keep host session alive
    */
-  #keepAlive = false;
+  #keepAlive = true;
   /**
    * interval to keep host session alive.
    */
   #keepAliveInterval = KEEP_ALIVE_INTERVAL;
+  /**
+   * options for the logger
+   */
+  #loggerOptions;
   /**
    * throttled keep alive function
    */
@@ -112,9 +116,10 @@ class SSFGuest {
       index,
       team,
       appName
-    } = options?.logger || {};
+    } = options?.logger ?? {};
+    this.#loggerOptions = options?.logger;
     this.#usesDevConnectAPI = options?.usesDevConnectAPI ?? false;
-    this.#keepAlive = options?.keepAlive ?? false;
+    this.#keepAlive = options?.keepAlive ?? true;
     this.#keepAliveInterval = options?.keepAliveInterval ?? KEEP_ALIVE_INTERVAL;
     const transport = logToConsole ? (0, import_pui_diagnostics.Console)() : (0, import_pui_diagnostics.http)(url);
     this.#logger = (0, import_pui_diagnostics.logger)({
@@ -410,7 +415,7 @@ class SSFGuest {
   #startKeepSessionAlive = async () => {
     if (this.#keepAlive) {
       try {
-        const appObj = await this.getObject("Application");
+        const appObj = await this.getObject("application");
         if (appObj) {
           this.#throttledKeepAlive = (0, import_lodash.throttle)(
             async () => {
@@ -430,6 +435,10 @@ class SSFGuest {
           userInteractionEvents.forEach((eventType) => {
             document.addEventListener(eventType, this.#throttledKeepAlive);
           });
+        } else {
+          this.#logger.warn(
+            "Application object not available to send keep alive"
+          );
         }
       } catch (e) {
         this.#logger.error(
@@ -438,6 +447,27 @@ class SSFGuest {
       }
     }
   };
+  /**
+   * send all log messages to parent
+   */
+  #useParentApplicationLogger = async () => {
+    try {
+      const appObj = await this.getObject("application");
+      if (appObj?.log && !this.#loggerOptions.console) {
+        const { index, team, appName } = this.#loggerOptions;
+        this.#logger = (0, import_pui_diagnostics.logger)({
+          transport: (0, import_pui_diagnostics.parentApp)(appObj),
+          index,
+          team,
+          appName
+        });
+      }
+    } catch (e) {
+      this.#logger.error(
+        `Error getting application object. ${e.message}`
+      );
+    }
+  };
   /**
    * Initialize guest using script
    * @param scriptUri uri of the script
@@ -539,14 +569,15 @@ class SSFGuest {
         messageBody: guestOptions
       });
       this.#isConnected = true;
-      this.#logger.audit({
-        message: "Guest connected to host",
-        guestUrl: window.location.href
-      });
       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",
+        guestUrl: window.location.href
+      });
     }
   };
   /**
@@ -556,13 +587,16 @@ class SSFGuest {
   getAuthToken = async () => {
     if (!this.#authToken && this.#isConnected) {
       try {
-        const authObj = await this.getObject("Auth");
+        const authObj = await this.getObject("auth");
         if (authObj) {
           const tokenInfo = await authObj.getAccessToken();
           this.#authToken = tokenInfo?.access_token;
           this.#hostDomain = tokenInfo?.host_name;
           this.#authClientId = tokenInfo?.client_id;
-        }
+        } else
+          this.#logger.warn(
+            "Auth object not available to get access token from host"
+          );
       } catch (e) {
         console.dir(e, { depth: null });
         this.#logger.error(

package/dist/cjs/tests/utils.js

@@ -33,10 +33,11 @@ var import_utils = require("../utils.js");
 const createGuest = ({
   keepAlive,
   usesDevConnectAPI,
-  keepAliveInterval
+  keepAliveInterval,
+  console
 }) => new import__.SSFGuest({
   logger: {
-    console: true,
+    console: console ?? true,
     index: "ssf",
     team: "UI Platform",
     appName: "SSF Guest"
@@ -116,7 +117,7 @@ const authScriptingObject = {
   object: {
     events: [],
     functions: ["getAccessToken", "createAuthCode", "getUser"],
-    objectId: "Auth",
+    objectId: "auth",
     objectType: "Object"
   },
   type: "object"
@@ -147,14 +148,14 @@ const applicationScriptingObject = {
       "supportsAction",
       "supportsNavigateTo"
     ],
-    objectId: "Application",
+    objectId: "application",
     objectType: "Object"
   },
   type: "object"
 };
 const hostObjects = {
-  Application: applicationScriptingObject,
-  Auth: authScriptingObject
+  application: applicationScriptingObject,
+  auth: authScriptingObject
 };
 const setupHost = (hostWindow) => {
   const onMessage = ({ data }) => {

package/dist/esm/guest.js

@@ -11,6 +11,7 @@ import {
   logger as puiLogger,
   Console,
   http,
+  parentApp,
   webvitals,
   logUnhandledErrors
 } from "@elliemae/pui-diagnostics";
@@ -86,11 +87,15 @@ class SSFGuest {
   /**
    * flag to keep host session alive
    */
-  #keepAlive = false;
+  #keepAlive = true;
   /**
    * interval to keep host session alive.
    */
   #keepAliveInterval = KEEP_ALIVE_INTERVAL;
+  /**
+   * options for the logger
+   */
+  #loggerOptions;
   /**
    * throttled keep alive function
    */
@@ -107,9 +112,10 @@ class SSFGuest {
       index,
       team,
       appName
-    } = options?.logger || {};
+    } = options?.logger ?? {};
+    this.#loggerOptions = options?.logger;
     this.#usesDevConnectAPI = options?.usesDevConnectAPI ?? false;
-    this.#keepAlive = options?.keepAlive ?? false;
+    this.#keepAlive = options?.keepAlive ?? true;
     this.#keepAliveInterval = options?.keepAliveInterval ?? KEEP_ALIVE_INTERVAL;
     const transport = logToConsole ? Console() : http(url);
     this.#logger = puiLogger({
@@ -405,7 +411,7 @@ class SSFGuest {
   #startKeepSessionAlive = async () => {
     if (this.#keepAlive) {
       try {
-        const appObj = await this.getObject("Application");
+        const appObj = await this.getObject("application");
         if (appObj) {
           this.#throttledKeepAlive = throttle(
             async () => {
@@ -425,6 +431,10 @@ class SSFGuest {
           userInteractionEvents.forEach((eventType) => {
             document.addEventListener(eventType, this.#throttledKeepAlive);
           });
+        } else {
+          this.#logger.warn(
+            "Application object not available to send keep alive"
+          );
         }
       } catch (e) {
         this.#logger.error(
@@ -433,6 +443,27 @@ class SSFGuest {
       }
     }
   };
+  /**
+   * send all log messages to parent
+   */
+  #useParentApplicationLogger = async () => {
+    try {
+      const appObj = await this.getObject("application");
+      if (appObj?.log && !this.#loggerOptions.console) {
+        const { index, team, appName } = this.#loggerOptions;
+        this.#logger = puiLogger({
+          transport: parentApp(appObj),
+          index,
+          team,
+          appName
+        });
+      }
+    } catch (e) {
+      this.#logger.error(
+        `Error getting application object. ${e.message}`
+      );
+    }
+  };
   /**
    * Initialize guest using script
    * @param scriptUri uri of the script
@@ -534,14 +565,15 @@ class SSFGuest {
         messageBody: guestOptions
       });
       this.#isConnected = true;
-      this.#logger.audit({
-        message: "Guest connected to host",
-        guestUrl: window.location.href
-      });
       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",
+        guestUrl: window.location.href
+      });
     }
   };
   /**
@@ -551,13 +583,16 @@ class SSFGuest {
   getAuthToken = async () => {
     if (!this.#authToken && this.#isConnected) {
       try {
-        const authObj = await this.getObject("Auth");
+        const authObj = await this.getObject("auth");
         if (authObj) {
           const tokenInfo = await authObj.getAccessToken();
           this.#authToken = tokenInfo?.access_token;
           this.#hostDomain = tokenInfo?.host_name;
           this.#authClientId = tokenInfo?.client_id;
-        }
+        } else
+          this.#logger.warn(
+            "Auth object not available to get access token from host"
+          );
       } catch (e) {
         console.dir(e, { depth: null });
         this.#logger.error(

package/dist/esm/tests/utils.js

@@ -10,10 +10,11 @@ import { getOrigin } from "../utils.js";
 const createGuest = ({
   keepAlive,
   usesDevConnectAPI,
-  keepAliveInterval
+  keepAliveInterval,
+  console
 }) => new SSFGuest({
   logger: {
-    console: true,
+    console: console ?? true,
     index: "ssf",
     team: "UI Platform",
     appName: "SSF Guest"
@@ -93,7 +94,7 @@ const authScriptingObject = {
   object: {
     events: [],
     functions: ["getAccessToken", "createAuthCode", "getUser"],
-    objectId: "Auth",
+    objectId: "auth",
     objectType: "Object"
   },
   type: "object"
@@ -124,14 +125,14 @@ const applicationScriptingObject = {
       "supportsAction",
       "supportsNavigateTo"
     ],
-    objectId: "Application",
+    objectId: "application",
     objectType: "Object"
   },
   type: "object"
 };
 const hostObjects = {
-  Application: applicationScriptingObject,
-  Auth: authScriptingObject
+  application: applicationScriptingObject,
+  auth: authScriptingObject
 };
 const setupHost = (hostWindow) => {
   const onMessage = ({ data }) => {

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.59063f8f6a686a1e289c.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://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.9130e23170c7f40514b8.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.59063f8f6a686a1e289c.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.9130e23170c7f40514b8.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>