@elliemae/ssf-guest 2.4.0 → 2.5.0

package/dist/cjs/guest.js

@@ -22,6 +22,7 @@ __export(guest_exports, {
 });
 module.exports = __toCommonJS(guest_exports);
 var import_uuid = require("uuid");
+var import_lodash = require("lodash");
 var import_microfe_common = require("@elliemae/microfe-common");
 var import_pui_diagnostics = require("@elliemae/pui-diagnostics");
 var import_proxy = require("./proxy.js");
@@ -32,6 +33,7 @@ var ResponseType = /* @__PURE__ */ ((ResponseType2) => {
   ResponseType2["VALUE"] = "value";
   return ResponseType2;
 })(ResponseType || {});
+const KEEP_ALIVE_INTERVAL = 12e4;
 const capabilities = {
   eventFeedback: true
 };
@@ -56,6 +58,7 @@ if ((0, import_utils.isEmbedded)()) {
   window.addEventListener("load", onLoad);
 }
 const DIAGNOSTICS_URL = "https://api.ellielabs.com/diagnostics/v2/logging";
+const userInteractionEvents = ["click", "scroll", "keypress", "touchstart"];
 class SSFGuest {
   /* eslint-enable indent */
   #correlationId;
@@ -70,6 +73,34 @@ class SSFGuest {
   #url = null;
   #hostOrigin = null;
   #hostWindow = null;
+  /**
+   * flag to get & cache auth token
+   */
+  #cacheAuthToken = false;
+  /**
+   * auth token to access api
+   */
+  #authToken = null;
+  /**
+   * oauth client id
+   */
+  #authClientId = null;
+  /**
+   * api host domain
+   */
+  #hostDomain = null;
+  /**
+   * flag to keep host session alive
+   */
+  #keepAlive = false;
+  /**
+   * interval to keep host session alive.
+   */
+  #keepAliveInterval = KEEP_ALIVE_INTERVAL;
+  /**
+   * throttled keep alive function
+   */
+  #throttledKeepAlive = null;
   /**
    * Create new guest
    * @param {GuestOption} options - options for the guest
@@ -83,6 +114,9 @@ class SSFGuest {
       team,
       appName
     } = options?.logger || {};
+    this.#cacheAuthToken = options?.cacheAuthToken ?? false;
+    this.#keepAlive = options?.keepAlive ?? false;
+    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)({
       transport,
@@ -277,6 +311,54 @@ class SSFGuest {
       }
     }
   };
+  /**
+   * Extend token lifetime
+   */
+  #extendTokenLifetime = async () => {
+    if (!this.#authToken || !this.#authClientId || !this.#hostDomain)
+      return;
+    await fetch(`${this.#hostDomain}/oauth2/v1/token/introspection`, {
+      headers: {
+        "content-type": "application/x-www-form-urlencoded;charset=UTF-8"
+      },
+      body: `token=${this.#authToken}&client_id=${this.#authClientId}`,
+      method: "POST"
+    });
+  };
+  /**
+   * Start session keep alive
+   */
+  #startKeepSessionAlive = async () => {
+    if (this.#keepAlive) {
+      try {
+        const appObj = await this.getObject("Application");
+        if (appObj) {
+          this.#throttledKeepAlive = (0, import_lodash.throttle)(
+            async () => {
+              try {
+                await appObj.keepSessionAlive();
+                await this.#extendTokenLifetime();
+              } catch (e) {
+                this.#logger.error(
+                  `Error keeping session alive. ${e.message}`
+                );
+              }
+            },
+            this.#keepAliveInterval,
+            // throttle time
+            { leading: false }
+          );
+          userInteractionEvents.forEach((eventType) => {
+            document.addEventListener(eventType, this.#throttledKeepAlive);
+          });
+        }
+      } catch (e) {
+        this.#logger.error(
+          `Error getting application object. ${e.message}`
+        );
+      }
+    }
+  };
   /**
    * Initialize guest using script
    * @param scriptUri uri of the script
@@ -315,6 +397,11 @@ class SSFGuest {
       window: this.#hostWindow
     });
     this.#remoting.close();
+    if (this.#throttledKeepAlive) {
+      userInteractionEvents.forEach((eventType) => {
+        document.removeEventListener(eventType, this.#throttledKeepAlive);
+      });
+    }
     this.#isConnected = false;
     this.#logger.audit({
       message: "Guest disconnected from host",
@@ -328,6 +415,7 @@ class SSFGuest {
    * Connect to the host
    * @param {ConnectParam} param - reference to the guest window or options
    */
+  // eslint-disable-next-line max-statements
   connect = async (param) => {
     if (!this.#isConnected) {
       let guestWindow = window;
@@ -370,7 +458,34 @@ class SSFGuest {
         message: "Guest connected to host",
         guestUrl: window.location.href
       });
+      await this.getAuthToken();
+      await this.#startKeepSessionAlive();
+    }
+  };
+  /**
+   * Get bearer token to access api
+   * @returns auth token
+   */
+  getAuthToken = async () => {
+    if (!this.#cacheAuthToken)
+      return null;
+    if (!this.#authToken) {
+      try {
+        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;
+        }
+      } catch (e) {
+        console.dir(e, { depth: null });
+        this.#logger.error(
+          `Error getting access token from auth object. ${e.message}`
+        );
+      }
     }
+    return this.#authToken;
   };
   /**
    * Get scripting object proxy by id

package/dist/cjs/tests/utils.js

@@ -20,22 +20,30 @@ var utils_exports = {};
 __export(utils_exports, {
   appraisalServiceObject: () => appraisalServiceObject,
   connectGuest: () => connectGuest,
+  createGuest: () => createGuest,
   getAppraisalService: () => getAppraisalService,
   postMessage: () => postMessage,
-  ssfGuest: () => ssfGuest
+  setupHost: () => setupHost
 });
 module.exports = __toCommonJS(utils_exports);
 var import_microfe_common = require("@elliemae/microfe-common");
 var import__ = require("../index.js");
 var import_constant = require("./constant.js");
 var import_utils = require("../utils.js");
-const ssfGuest = new import__.SSFGuest({
+const createGuest = ({
+  keepAlive,
+  cacheAuthToken,
+  keepAliveInterval
+}) => new import__.SSFGuest({
   logger: {
     console: true,
     index: "ssf",
     team: "UI Platform",
     appName: "SSF Guest"
-  }
+  },
+  keepAlive,
+  cacheAuthToken,
+  keepAliveInterval
 });
 const postMessage = ({
   srcWindow,
@@ -54,7 +62,7 @@ const postMessage = ({
     })
   );
 };
-const connectGuest = (hostWindow) => new Promise((resolve) => {
+const connectGuest = (hostWindow, ssfGuest) => new Promise((resolve) => {
   const onMessage = ({ data }) => {
     if (data.type === import_microfe_common.MessageType.GuestReady) {
       hostWindow?.removeEventListener?.("message", onMessage);
@@ -87,7 +95,7 @@ const appraisalServiceObject = {
   },
   type: "object"
 };
-const getAppraisalService = (hostWindow) => new Promise((resolve, reject) => {
+const getAppraisalService = (hostWindow, ssfGuest) => new Promise((resolve, reject) => {
   const onMessage = ({ data }) => {
     if (data?.type !== import_microfe_common.MessageType.ObjectGet)
       return;
@@ -105,3 +113,66 @@ const getAppraisalService = (hostWindow) => new Promise((resolve, reject) => {
   hostWindow?.addEventListener?.("message", onMessage);
   ssfGuest.getObject(import_constant.OBJECT_NAME).then(resolve).catch(reject);
 });
+const authScriptingObject = {
+  object: {
+    events: [],
+    functions: ["getAccessToken", "createAuthCode", "getUser"],
+    objectId: "Auth",
+    objectType: "Object"
+  },
+  type: "object"
+};
+const applicationScriptingObject = {
+  object: {
+    events: [],
+    functions: [
+      "closeModal",
+      "extend",
+      "getApplicationContext",
+      "getCapabilities",
+      "getCompanySettings",
+      "getDescriptor",
+      "getPersonaAccess",
+      "getPoliciesDetails",
+      "getUserAccessRights",
+      "hideSpinner",
+      "keepSessionAlive",
+      "log",
+      "navigate",
+      "open",
+      "openModal",
+      "performAction",
+      "print",
+      "showError",
+      "showSpinner",
+      "supportsAction",
+      "supportsNavigateTo"
+    ],
+    objectId: "Application",
+    objectType: "Object"
+  },
+  type: "object"
+};
+const hostObjects = {
+  Application: applicationScriptingObject,
+  Auth: authScriptingObject
+};
+const setupHost = (hostWindow) => {
+  const onMessage = ({ data }) => {
+    if (data?.type !== import_microfe_common.MessageType.ObjectGet)
+      return;
+    const scriptingObject = hostObjects[data?.body?.objectId ?? ""] ?? null;
+    if (scriptingObject)
+      postMessage({
+        srcWindow: hostWindow,
+        targetWindow: window,
+        message: {
+          body: scriptingObject,
+          type: "elli:remoting:response",
+          requestId: data.requestId
+        }
+      });
+  };
+  hostWindow?.addEventListener?.("message", onMessage);
+  return () => hostWindow?.removeEventListener?.("message", onMessage);
+};

package/dist/cjs/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/dist/esm/guest.js

@@ -1,4 +1,5 @@
 import { v4 as uuidv4 } from "uuid";
+import { throttle } from "lodash";
 import {
   Remoting,
   sendMessage,
@@ -26,6 +27,7 @@ var ResponseType = /* @__PURE__ */ ((ResponseType2) => {
   ResponseType2["VALUE"] = "value";
   return ResponseType2;
 })(ResponseType || {});
+const KEEP_ALIVE_INTERVAL = 12e4;
 const capabilities = {
   eventFeedback: true
 };
@@ -50,6 +52,7 @@ if (isEmbedded()) {
   window.addEventListener("load", onLoad);
 }
 const DIAGNOSTICS_URL = "https://api.ellielabs.com/diagnostics/v2/logging";
+const userInteractionEvents = ["click", "scroll", "keypress", "touchstart"];
 class SSFGuest {
   /* eslint-enable indent */
   #correlationId;
@@ -64,6 +67,34 @@ class SSFGuest {
   #url = null;
   #hostOrigin = null;
   #hostWindow = null;
+  /**
+   * flag to get & cache auth token
+   */
+  #cacheAuthToken = false;
+  /**
+   * auth token to access api
+   */
+  #authToken = null;
+  /**
+   * oauth client id
+   */
+  #authClientId = null;
+  /**
+   * api host domain
+   */
+  #hostDomain = null;
+  /**
+   * flag to keep host session alive
+   */
+  #keepAlive = false;
+  /**
+   * interval to keep host session alive.
+   */
+  #keepAliveInterval = KEEP_ALIVE_INTERVAL;
+  /**
+   * throttled keep alive function
+   */
+  #throttledKeepAlive = null;
   /**
    * Create new guest
    * @param {GuestOption} options - options for the guest
@@ -77,6 +108,9 @@ class SSFGuest {
       team,
       appName
     } = options?.logger || {};
+    this.#cacheAuthToken = options?.cacheAuthToken ?? false;
+    this.#keepAlive = options?.keepAlive ?? false;
+    this.#keepAliveInterval = options?.keepAliveInterval ?? KEEP_ALIVE_INTERVAL;
     const transport = logToConsole ? Console() : http(url);
     this.#logger = puiLogger({
       transport,
@@ -271,6 +305,54 @@ class SSFGuest {
       }
     }
   };
+  /**
+   * Extend token lifetime
+   */
+  #extendTokenLifetime = async () => {
+    if (!this.#authToken || !this.#authClientId || !this.#hostDomain)
+      return;
+    await fetch(`${this.#hostDomain}/oauth2/v1/token/introspection`, {
+      headers: {
+        "content-type": "application/x-www-form-urlencoded;charset=UTF-8"
+      },
+      body: `token=${this.#authToken}&client_id=${this.#authClientId}`,
+      method: "POST"
+    });
+  };
+  /**
+   * Start session keep alive
+   */
+  #startKeepSessionAlive = async () => {
+    if (this.#keepAlive) {
+      try {
+        const appObj = await this.getObject("Application");
+        if (appObj) {
+          this.#throttledKeepAlive = throttle(
+            async () => {
+              try {
+                await appObj.keepSessionAlive();
+                await this.#extendTokenLifetime();
+              } catch (e) {
+                this.#logger.error(
+                  `Error keeping session alive. ${e.message}`
+                );
+              }
+            },
+            this.#keepAliveInterval,
+            // throttle time
+            { leading: false }
+          );
+          userInteractionEvents.forEach((eventType) => {
+            document.addEventListener(eventType, this.#throttledKeepAlive);
+          });
+        }
+      } catch (e) {
+        this.#logger.error(
+          `Error getting application object. ${e.message}`
+        );
+      }
+    }
+  };
   /**
    * Initialize guest using script
    * @param scriptUri uri of the script
@@ -309,6 +391,11 @@ class SSFGuest {
       window: this.#hostWindow
     });
     this.#remoting.close();
+    if (this.#throttledKeepAlive) {
+      userInteractionEvents.forEach((eventType) => {
+        document.removeEventListener(eventType, this.#throttledKeepAlive);
+      });
+    }
     this.#isConnected = false;
     this.#logger.audit({
       message: "Guest disconnected from host",
@@ -322,6 +409,7 @@ class SSFGuest {
    * Connect to the host
    * @param {ConnectParam} param - reference to the guest window or options
    */
+  // eslint-disable-next-line max-statements
   connect = async (param) => {
     if (!this.#isConnected) {
       let guestWindow = window;
@@ -364,7 +452,34 @@ class SSFGuest {
         message: "Guest connected to host",
         guestUrl: window.location.href
       });
+      await this.getAuthToken();
+      await this.#startKeepSessionAlive();
+    }
+  };
+  /**
+   * Get bearer token to access api
+   * @returns auth token
+   */
+  getAuthToken = async () => {
+    if (!this.#cacheAuthToken)
+      return null;
+    if (!this.#authToken) {
+      try {
+        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;
+        }
+      } catch (e) {
+        console.dir(e, { depth: null });
+        this.#logger.error(
+          `Error getting access token from auth object. ${e.message}`
+        );
+      }
     }
+    return this.#authToken;
   };
   /**
    * Get scripting object proxy by id

package/dist/esm/tests/utils.js

@@ -7,13 +7,20 @@ import {
   UNLOADING_EVENT_NAME
 } from "./constant.js";
 import { getOrigin } from "../utils.js";
-const ssfGuest = new SSFGuest({
+const createGuest = ({
+  keepAlive,
+  cacheAuthToken,
+  keepAliveInterval
+}) => new SSFGuest({
   logger: {
     console: true,
     index: "ssf",
     team: "UI Platform",
     appName: "SSF Guest"
-  }
+  },
+  keepAlive,
+  cacheAuthToken,
+  keepAliveInterval
 });
 const postMessage = ({
   srcWindow,
@@ -32,7 +39,7 @@ const postMessage = ({
     })
   );
 };
-const connectGuest = (hostWindow) => new Promise((resolve) => {
+const connectGuest = (hostWindow, ssfGuest) => new Promise((resolve) => {
   const onMessage = ({ data }) => {
     if (data.type === MessageType.GuestReady) {
       hostWindow?.removeEventListener?.("message", onMessage);
@@ -65,7 +72,7 @@ const appraisalServiceObject = {
   },
   type: "object"
 };
-const getAppraisalService = (hostWindow) => new Promise((resolve, reject) => {
+const getAppraisalService = (hostWindow, ssfGuest) => new Promise((resolve, reject) => {
   const onMessage = ({ data }) => {
     if (data?.type !== MessageType.ObjectGet)
       return;
@@ -83,10 +90,74 @@ const getAppraisalService = (hostWindow) => new Promise((resolve, reject) => {
   hostWindow?.addEventListener?.("message", onMessage);
   ssfGuest.getObject(OBJECT_NAME).then(resolve).catch(reject);
 });
+const authScriptingObject = {
+  object: {
+    events: [],
+    functions: ["getAccessToken", "createAuthCode", "getUser"],
+    objectId: "Auth",
+    objectType: "Object"
+  },
+  type: "object"
+};
+const applicationScriptingObject = {
+  object: {
+    events: [],
+    functions: [
+      "closeModal",
+      "extend",
+      "getApplicationContext",
+      "getCapabilities",
+      "getCompanySettings",
+      "getDescriptor",
+      "getPersonaAccess",
+      "getPoliciesDetails",
+      "getUserAccessRights",
+      "hideSpinner",
+      "keepSessionAlive",
+      "log",
+      "navigate",
+      "open",
+      "openModal",
+      "performAction",
+      "print",
+      "showError",
+      "showSpinner",
+      "supportsAction",
+      "supportsNavigateTo"
+    ],
+    objectId: "Application",
+    objectType: "Object"
+  },
+  type: "object"
+};
+const hostObjects = {
+  Application: applicationScriptingObject,
+  Auth: authScriptingObject
+};
+const setupHost = (hostWindow) => {
+  const onMessage = ({ data }) => {
+    if (data?.type !== MessageType.ObjectGet)
+      return;
+    const scriptingObject = hostObjects[data?.body?.objectId ?? ""] ?? null;
+    if (scriptingObject)
+      postMessage({
+        srcWindow: hostWindow,
+        targetWindow: window,
+        message: {
+          body: scriptingObject,
+          type: "elli:remoting:response",
+          requestId: data.requestId
+        }
+      });
+  };
+  hostWindow?.addEventListener?.("message", onMessage);
+  return () => hostWindow?.removeEventListener?.("message", onMessage);
+};
 export {
   appraisalServiceObject,
   connectGuest,
+  createGuest,
   getAppraisalService,
   postMessage,
-  ssfGuest
+  setupHost
 };

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.fffbea0b33100b3a1ff1.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.11dd502cfb083007c6d1.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.fffbea0b33100b3a1ff1.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.11dd502cfb083007c6d1.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>