@elliemae/pui-app-sdk 5.10.10 → 5.11.0

package/dist/cjs/analytics/index.js

@@ -22,7 +22,7 @@ __export(analytics_exports, {
 });
 module.exports = __toCommonJS(analytics_exports);
 var import_guest = require("../utils/micro-frontend/guest.js");
-var import_web_analytics = require("./web-analytics.js");
+var import_web_analytics = require("../utils/micro-frontend/scripting-objects/web-analytics.js");
 var import_redact_pii = require("../utils/redact-pii.js");
 const sendBAEventToSelf = (data) => {
   const redactedData = (0, import_redact_pii.redactPii)(data);

package/dist/cjs/analytics/user-session-event.js

@@ -23,7 +23,7 @@ __export(user_session_event_exports, {
 });
 module.exports = __toCommonJS(user_session_event_exports);
 var import_index = require("./index.js");
-var import_web_analytics = require("./web-analytics.js");
+var import_web_analytics = require("../utils/micro-frontend/scripting-objects/web-analytics.js");
 const loginEvent = ({
   instanceId,
   userId

package/dist/cjs/index.js

@@ -233,5 +233,5 @@ var import_store3 = require("./data/store.js");
 var import_guest_with_service = require("./utils/guest-with-service.js");
 var import_appdynamics = require("./analytics/appdynamics.js");
 var import_analytics = require("./analytics/index.js");
-var import_web_analytics = require("./analytics/web-analytics.js");
+var import_web_analytics = require("./utils/micro-frontend/scripting-objects/web-analytics.js");
 var import_redact_pii = require("./utils/redact-pii.js");

package/dist/cjs/utils/app-config/index.js

@@ -35,7 +35,7 @@ module.exports = __toCommonJS(app_config_exports);
 var import_lodash = __toESM(require("lodash"));
 var import_config = require("./config.js");
 var import_appdynamics = require("../../analytics/appdynamics.js");
-var import_web_analytics = require("../../analytics/web-analytics.js");
+var import_web_analytics = require("../micro-frontend/scripting-objects/web-analytics.js");
 var import_window = require("../window.js");
 var import_config2 = require("./config.js");
 const parseAppConfig = (data) => {

package/dist/cjs/utils/micro-frontend/guest.js

@@ -40,7 +40,7 @@ var import_history2 = require("../history.js");
 var import_console_logger = require("../console-logger.js");
 var import_logger = require("../logger.js");
 var import_web_storage = require("../web-storage.js");
-var import_web_analytics = require("../../analytics/web-analytics.js");
+var import_web_analytics = require("./scripting-objects/web-analytics.js");
 var import_appdynamics = require("../../analytics/appdynamics.js");
 var import_ssfguest_adapter = require("./ssfguest-adapter.js");
 const isCrossDomain = () => {

package/dist/cjs/utils/micro-frontend/host.js

@@ -34,9 +34,9 @@ var import_console_logger = require("../console-logger.js");
 var import_logger = require("../logger.js");
 var import_constants = require("../constants.js");
 var import_window = require("../window.js");
-var import_analytics = require("../../analytics/index.js");
 var import_appdynamics = require("../../analytics/appdynamics.js");
-var import_web_analytics = require("../../analytics/web-analytics.js");
+var import_analytics = require("./scripting-objects/analytics.js");
+var import_web_analytics = require("./scripting-objects/web-analytics.js");
 var import_session = require("../session.js");
 class CMicroAppHost {
   static instance;
@@ -47,6 +47,8 @@ class CMicroAppHost {
   onInit;
   onRenewSessionTimer;
   scriptingObjects;
+  #ssfHostRef;
+  // eslint-disable-next-line max-statements
   constructor(params) {
     this.appId = (0, import_config.getAppConfigValue)("appId");
     this.onInit = params?.onInit;
@@ -59,7 +61,13 @@ class CMicroAppHost {
       theme: params?.theme ?? (0, import_pui_theme.getDefaultTheme)()
     };
     this.activeGuests = {};
-    this.scriptingObjects = params?.scriptingObjects ?? {};
+    this.#ssfHostRef = params?.ssfHostRef || null;
+    const analyticsObj = new import_analytics.Analytics(this.logger);
+    this.scriptingObjects = {
+      analytics: analyticsObj,
+      ...params?.scriptingObjects ?? {}
+    };
+    this.#ssfHostRef?.publish(analyticsObj);
     this.getProps = this.getProps.bind(this);
     this.getLogger = this.getLogger.bind(this);
     this.getGuests = this.getGuests.bind(this);
@@ -165,7 +173,8 @@ class CMicroAppHost {
     this.props.systemVersion = version;
   }
   sendBAEvent(data) {
-    (0, import_analytics.sendBAEvent)({ data, self: true });
+    this.scriptingObjects.analytics.sendBAEvent(data).catch(() => {
+    });
   }
   // eslint-disable-next-line @typescript-eslint/require-await
   async getObject(name) {

package/dist/cjs/utils/micro-frontend/scripting-objects/analytics.js

@@ -0,0 +1,107 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var analytics_exports = {};
+__export(analytics_exports, {
+  Analytics: () => Analytics
+});
+module.exports = __toCommonJS(analytics_exports);
+var import_em_ssf_host = __toESM(require("@elliemae/em-ssf-host"));
+var import_redact_pii = require("../../redact-pii.js");
+var import_web_analytics = require("./web-analytics.js");
+class Analytics extends import_em_ssf_host.default.ScriptingObject {
+  #logger;
+  constructor(logger) {
+    super("analytics");
+    this.#logger = logger;
+    this.#monitorPerformance();
+  }
+  /**
+   * monitor performance and report to GTM
+   */
+  #monitorPerformance = () => {
+    try {
+      const po = new PerformanceObserver((list) => {
+        for (const entry of list.getEntries()) {
+          switch (entry.entryType) {
+            case "measure":
+              this.sendBAEvent({
+                event: "performance",
+                name: entry.name,
+                duration: entry.duration.toString(),
+                startTime: new Date(
+                  performance.timeOrigin + entry.startTime
+                ).toISOString()
+              }).catch(() => {
+              });
+              break;
+            default:
+              break;
+          }
+        }
+      });
+      po.observe({ type: "measure", buffered: true });
+    } catch (e) {
+      this.#logger.error({
+        message: "Error while recording performance",
+        exception: e
+      });
+    }
+  };
+  /**
+   * send business analytics event
+   * @param event business analytics event
+   * @returns promise
+   */
+  sendBAEvent = (event) => {
+    const eventEx = { ...(0, import_web_analytics.getBAEventParameters)(), ...event };
+    const redactedData = (0, import_redact_pii.redactPii)(eventEx);
+    window.gtmDataLayer = window.gtmDataLayer || [];
+    window.gtmDataLayer.push(redactedData);
+    return Promise.resolve();
+  };
+  /**
+   * start a performance mark
+   * @param name name of the performance mark
+   * @returns start performance mark
+   */
+  perfMarkStart = (name) => {
+    if (!name) throw new Error("name is required");
+    return Promise.resolve(performance.mark(name));
+  };
+  /**
+   * end a performance mark
+   * @param startMark start mark
+   * @returns promise
+   */
+  perfMarkEnd = (startMark) => {
+    if (!startMark) throw new Error("startMark is required");
+    performance.measure(startMark.name, { start: startMark.startTime });
+    return Promise.resolve();
+  };
+}

package/dist/esm/analytics/index.js

@@ -1,5 +1,5 @@
 import { CMicroAppGuest } from "../utils/micro-frontend/guest.js";
-import { getBAEventParameters } from "./web-analytics.js";
+import { getBAEventParameters } from "../utils/micro-frontend/scripting-objects/web-analytics.js";
 import { redactPii } from "../utils/redact-pii.js";
 const sendBAEventToSelf = (data) => {
   const redactedData = redactPii(data);

package/dist/esm/analytics/user-session-event.js

@@ -1,5 +1,5 @@
 import { sendBAEvent } from "./index.js";
-import { updateBAEventParameters } from "./web-analytics.js";
+import { updateBAEventParameters } from "../utils/micro-frontend/scripting-objects/web-analytics.js";
 const loginEvent = ({
   instanceId,
   userId

package/dist/esm/index.js

@@ -131,7 +131,7 @@ import { getStore } from "./data/store.js";
 import { RegisterService } from "./utils/guest-with-service.js";
 import { setAppDynamicsUserData } from "./analytics/appdynamics.js";
 import { sendBAEvent } from "./analytics/index.js";
-import { updateBAEventParameters } from "./analytics/web-analytics.js";
+import { updateBAEventParameters } from "./utils/micro-frontend/scripting-objects/web-analytics.js";
 import { redactPii } from "./utils/redact-pii.js";
 export {
   AppRoot,

package/dist/esm/utils/app-config/index.js

@@ -1,7 +1,7 @@
 import _ from "lodash";
 import { setAppConfig } from "./config.js";
 import { setAppDynamicsUserData } from "../../analytics/appdynamics.js";
-import { updateBAEventParameters } from "../../analytics/web-analytics.js";
+import { updateBAEventParameters } from "../micro-frontend/scripting-objects/web-analytics.js";
 import { getAssetPath } from "../window.js";
 import { getAppConfigValue } from "./config.js";
 const parseAppConfig = (data) => {

package/dist/esm/utils/micro-frontend/guest.js

@@ -7,7 +7,7 @@ import { browserHistory } from "../history.js";
 import { consoleLogger } from "../console-logger.js";
 import { setLogger } from "../logger.js";
 import { removeStorageEvents } from "../web-storage.js";
-import { updateBAEventParameters } from "../../analytics/web-analytics.js";
+import { updateBAEventParameters } from "./scripting-objects/web-analytics.js";
 import { setAppDynamicsUserData } from "../../analytics/appdynamics.js";
 import { SSFGuestAdapter } from "./ssfguest-adapter.js";
 const isCrossDomain = () => {

package/dist/esm/utils/micro-frontend/host.js

@@ -18,9 +18,9 @@ import {
   getCurrentBreakpoint,
   getViewportSize as getWindowViewportSize
 } from "../window.js";
-import { sendBAEvent } from "../../analytics/index.js";
 import { setAppDynamicsUserData } from "../../analytics/appdynamics.js";
-import { updateBAEventParameters } from "../../analytics/web-analytics.js";
+import { Analytics } from "./scripting-objects/analytics.js";
+import { updateBAEventParameters } from "./scripting-objects/web-analytics.js";
 import { renewSession } from "../session.js";
 class CMicroAppHost {
   static instance;
@@ -31,6 +31,8 @@ class CMicroAppHost {
   onInit;
   onRenewSessionTimer;
   scriptingObjects;
+  #ssfHostRef;
+  // eslint-disable-next-line max-statements
   constructor(params) {
     this.appId = getAppConfigValue("appId");
     this.onInit = params?.onInit;
@@ -43,7 +45,13 @@ class CMicroAppHost {
       theme: params?.theme ?? getDefaultTheme()
     };
     this.activeGuests = {};
-    this.scriptingObjects = params?.scriptingObjects ?? {};
+    this.#ssfHostRef = params?.ssfHostRef || null;
+    const analyticsObj = new Analytics(this.logger);
+    this.scriptingObjects = {
+      analytics: analyticsObj,
+      ...params?.scriptingObjects ?? {}
+    };
+    this.#ssfHostRef?.publish(analyticsObj);
     this.getProps = this.getProps.bind(this);
     this.getLogger = this.getLogger.bind(this);
     this.getGuests = this.getGuests.bind(this);
@@ -149,7 +157,8 @@ class CMicroAppHost {
     this.props.systemVersion = version;
   }
   sendBAEvent(data) {
-    sendBAEvent({ data, self: true });
+    this.scriptingObjects.analytics.sendBAEvent(data).catch(() => {
+    });
   }
   // eslint-disable-next-line @typescript-eslint/require-await
   async getObject(name) {

package/dist/esm/utils/micro-frontend/scripting-objects/analytics.js

@@ -0,0 +1,77 @@
+import ssfHost from "@elliemae/em-ssf-host";
+import { redactPii } from "../../redact-pii.js";
+import { getBAEventParameters } from "./web-analytics.js";
+class Analytics extends ssfHost.ScriptingObject {
+  #logger;
+  constructor(logger) {
+    super("analytics");
+    this.#logger = logger;
+    this.#monitorPerformance();
+  }
+  /**
+   * monitor performance and report to GTM
+   */
+  #monitorPerformance = () => {
+    try {
+      const po = new PerformanceObserver((list) => {
+        for (const entry of list.getEntries()) {
+          switch (entry.entryType) {
+            case "measure":
+              this.sendBAEvent({
+                event: "performance",
+                name: entry.name,
+                duration: entry.duration.toString(),
+                startTime: new Date(
+                  performance.timeOrigin + entry.startTime
+                ).toISOString()
+              }).catch(() => {
+              });
+              break;
+            default:
+              break;
+          }
+        }
+      });
+      po.observe({ type: "measure", buffered: true });
+    } catch (e) {
+      this.#logger.error({
+        message: "Error while recording performance",
+        exception: e
+      });
+    }
+  };
+  /**
+   * send business analytics event
+   * @param event business analytics event
+   * @returns promise
+   */
+  sendBAEvent = (event) => {
+    const eventEx = { ...getBAEventParameters(), ...event };
+    const redactedData = redactPii(eventEx);
+    window.gtmDataLayer = window.gtmDataLayer || [];
+    window.gtmDataLayer.push(redactedData);
+    return Promise.resolve();
+  };
+  /**
+   * start a performance mark
+   * @param name name of the performance mark
+   * @returns start performance mark
+   */
+  perfMarkStart = (name) => {
+    if (!name) throw new Error("name is required");
+    return Promise.resolve(performance.mark(name));
+  };
+  /**
+   * end a performance mark
+   * @param startMark start mark
+   * @returns promise
+   */
+  perfMarkEnd = (startMark) => {
+    if (!startMark) throw new Error("startMark is required");
+    performance.measure(startMark.name, { start: startMark.startTime });
+    return Promise.resolve();
+  };
+}
+export {
+  Analytics
+};

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

@@ -85,7 +85,7 @@ export { getStore } from './data/store.js';
 export { RegisterService } from './utils/guest-with-service.js';
 export { setAppDynamicsUserData } from './analytics/appdynamics.js';
 export { sendBAEvent } from './analytics/index.js';
-export { updateBAEventParameters } from './analytics/web-analytics.js';
+export { updateBAEventParameters } from './utils/micro-frontend/scripting-objects/web-analytics.js';
 export { redactPii } from './utils/redact-pii.js';
 export type { EMUI } from './utils/window.js';
 export type { Await } from './utils/await.js';

package/dist/types/lib/utils/micro-frontend/host.d.ts

@@ -1,6 +1,9 @@
+/// <reference types="lib/typings/elliemae.js" />
 import { History, To } from 'history';
 import { DefaultTheme } from 'styled-components';
-import { IMicroAppHost, ResizeEventHandler, BreakpointChangeEventHandler, SubscriptionListener, BAEvent } from '@elliemae/pui-micro-frontend-base';
+import { IMicroAppHost, ResizeEventHandler, BreakpointChangeEventHandler, SubscriptionListener } from '@elliemae/pui-micro-frontend-base';
+import ssfHost from '@elliemae/em-ssf-host';
+import { BAEvent } from '@elliemae/pui-scripting-object';
 import { MicroFrontEndLogger } from '../types.js';
 type HostOptions = {
     systemVersion: string;
@@ -16,8 +19,10 @@ type ConstructorParams = {
     scriptingObjects?: Record<string, any>;
     onRenewSessionTimer?: () => void;
     onInit?: OnInitCallback;
+    ssfHostRef?: typeof ssfHost.Host;
 };
 export declare class CMicroAppHost implements IMicroAppHost {
+    #private;
     private static instance;
     private readonly logger;
     private readonly appId;
@@ -54,7 +59,7 @@ export declare class CMicroAppHost implements IMicroAppHost {
     onResizeEvent(eventHandler: ResizeEventHandler): string;
     onBreakpointChangeEvent(eventHandler: BreakpointChangeEventHandler): string;
     setSystemVersion(version?: string): void;
-    sendBAEvent(this: void, data: BAEvent): void;
+    sendBAEvent(data: BAEvent): void;
     getObject<T>(name: string): Promise<T>;
 }
 export {};

package/dist/types/lib/utils/micro-frontend/scripting-objects/analytics.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="lib/typings/elliemae.js" />
+import ssfHost from '@elliemae/em-ssf-host';
+import { IAnalytics, BAEvent } from '@elliemae/pui-scripting-object';
+import { MicroFrontEndLogger } from '../../types.js';
+/**
+ * Analytics scripting object
+ */
+export declare class Analytics extends ssfHost.ScriptingObject implements IAnalytics {
+    #private;
+    constructor(logger: MicroFrontEndLogger);
+    /**
+     * send business analytics event
+     * @param event business analytics event
+     * @returns promise
+     */
+    sendBAEvent: (event: BAEvent) => Promise<void>;
+    /**
+     * start a performance mark
+     * @param name name of the performance mark
+     * @returns start performance mark
+     */
+    perfMarkStart: (name: string) => Promise<PerformanceMark>;
+    /**
+     * end a performance mark
+     * @param startMark start mark
+     * @returns promise
+     */
+    perfMarkEnd: (startMark: PerformanceMeasure) => Promise<void>;
+}