@elliemae/pui-app-sdk 5.12.0 → 5.13.1

package/dist/cjs/analytics/index.js

@@ -23,23 +23,28 @@ __export(analytics_exports, {
 module.exports = __toCommonJS(analytics_exports);
 var import_guest = require("../utils/micro-frontend/guest.js");
 var import_web_analytics = require("../utils/micro-frontend/scripting-objects/web-analytics.js");
+var import_helpers = require("../utils/helpers.js");
 const sendBAEventToSelf = (data) => {
+  const eventData = {
+    ...(0, import_web_analytics.getBAEventParameters)(),
+    ...(0, import_helpers.getProductAppDetails)(),
+    ...data
+  };
   window.gtmDataLayer = window.gtmDataLayer || [];
-  window.gtmDataLayer.push(data);
+  window.gtmDataLayer.push(eventData);
 };
 const sendBAEvent = ({
   data,
   self = true
 }) => {
-  const eventData = { ...(0, import_web_analytics.getBAEventParameters)(), ...data };
   if (!self) {
     const sendEvent = import_guest.CMicroAppGuest.getInstance()?.getHost()?.sendBAEvent;
     if (sendEvent) {
-      sendEvent(eventData);
+      sendEvent(data);
     } else {
-      sendBAEventToSelf(eventData);
+      sendBAEventToSelf(data);
     }
   } else {
-    sendBAEventToSelf(eventData);
+    sendBAEventToSelf(data);
   }
 };

package/dist/cjs/analytics/page-view-event.js

@@ -22,29 +22,11 @@ __export(page_view_event_exports, {
 });
 module.exports = __toCommonJS(page_view_event_exports);
 var import_index = require("./index.js");
-const getWindow = () => {
-  try {
-    window.top?.document;
-    return window.top || window.self;
-  } catch (e) {
-    return window.self;
-  }
-};
 const pageViewEvent = ({ pageTitle }) => {
-  const pageWindow = getWindow();
-  const { pathname, href } = pageWindow.location;
-  const { title } = pageWindow.document;
-  const { pathname: guestPagePath, href: guestPageUrl } = window.location;
-  const { title: guestPageTitle } = document;
   (0, import_index.sendBAEvent)({
     data: {
       event: "pageView",
-      pageUrl: href,
-      pagePath: pathname,
-      pageTitle: title,
-      guestPageUrl,
-      guestPagePath,
-      guestPageTitle: pageTitle || guestPageTitle
+      appPageTitle: pageTitle
     }
   });
 };

package/dist/cjs/utils/helpers.js

@@ -19,10 +19,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var helpers_exports = {};
 __export(helpers_exports, {
   convertRelativeToAbsoluteUrl: () => convertRelativeToAbsoluteUrl,
+  getProductAppDetails: () => getProductAppDetails,
   isCIBuild: () => isCIBuild,
   isProd: () => isProd
 });
 module.exports = __toCommonJS(helpers_exports);
+var import_window = require("./window.js");
 const isProd = () => false;
 const isCIBuild = () => process.env.CI === "true";
 const PROTOCOL = /^(?:[a-z]+:)?\/\//;
@@ -32,3 +34,22 @@ const convertRelativeToAbsoluteUrl = (url) => {
   }
   return url;
 };
+const getProductAppDetails = () => {
+  const pageWindow = (0, import_window.getWindow)();
+  const { title: productPageTitle } = pageWindow.document;
+  const { title: appPageTitle } = document;
+  const productId = pageWindow?.emui?.appId ?? "";
+  const appId = window?.emui?.appId ?? "";
+  const { pathname: productPath, href: productUrl } = pageWindow.location;
+  const { pathname: appPath, href: appUrl } = window.location;
+  return {
+    productId,
+    productPath,
+    productUrl,
+    productPageTitle,
+    appId,
+    appPath,
+    appUrl,
+    appPageTitle
+  };
+};

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

@@ -33,6 +33,7 @@ __export(analytics_exports, {
 module.exports = __toCommonJS(analytics_exports);
 var import_em_ssf_host = __toESM(require("@elliemae/em-ssf-host"));
 var import_web_analytics = require("./web-analytics.js");
+var import_helpers = require("../../helpers.js");
 class Analytics extends import_em_ssf_host.default.ScriptingObject {
   /**
    * logger instance
@@ -64,6 +65,7 @@ class Analytics extends import_em_ssf_host.default.ScriptingObject {
                 startTime: new Date(
                   performance.timeOrigin + entry.startTime
                 ).toISOString(),
+                ...(0, import_web_analytics.getBAEventParameters)(),
                 ...detail
               }).catch(() => {
               });
@@ -88,57 +90,74 @@ class Analytics extends import_em_ssf_host.default.ScriptingObject {
    * @returns promise
    */
   sendBAEvent = (event) => {
-    const eventEx = { ...(0, import_web_analytics.getBAEventParameters)(), ...event };
+    const eventEx = {
+      ...(0, import_web_analytics.getBAEventParameters)(),
+      ...(0, import_helpers.getProductAppDetails)(),
+      ...event
+    };
     window.gtmDataLayer = window.gtmDataLayer || [];
     window.gtmDataLayer.push(eventEx);
     return Promise.resolve();
   };
   /**
-   * start a performance mark
-   * @param markName name of the performance mark
-   * @param markOptions
+   * start timing measure
+   * @param name unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced
+   * @param options additional details related to the measurement
    * @returns a promise that resolves to a PerformanceMeasure object
    */
-  perfMarkStart = (markName, markOptions) => {
-    if (!markName) throw new Error("markName is required");
-    const startMark = performance.mark(markName, markOptions);
+  startTiming = (name, options) => {
+    if (!name) throw new Error("parameter mark is required");
+    if (!options || !options?.appId || !options?.appUrl)
+      throw new Error("parameter options is required");
+    const startMark = performance.mark(name, { detail: options });
     return Promise.resolve(startMark);
   };
   /**
-   * end a performance mark
-   * @param startMarkNameorMark start mark name or start PerformanceMeasure object
-   * @param detail
-   * @returns a promise that resolves when the mark is ended
+   * end timing measure
+   * @param start name used to start timing measure or return value of the startTiming method
+   * @param options additional details related to the measurement
+   * @returns a promise that resolves when the timing measurement is ended
    * @example
    * ```typescript
-   * const startMark = await analytics.perfMarkStart('LongTask');
+   * const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });
    * // do some work
-   * await analytics.perfMarkEnd(startMark);
+   * await analytics.endTiming(longTaskMeasurement, { appId: 'myApp', appUrl: 'https://myapp.com' });
    * ```
    * ```typescript
-   * await analytics.perfMarkStart('LongTask');
+   * const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });
    * // do some work
-   * await analytics.perfMarkEnd('LongTask');
+   * await analytics.endTiming('LongTask', { appId: 'loanApp', appUrl: 'https://loanApp.com' });
    * ```
    */
-  perfMarkEnd = (startMarkNameorMark, detail) => {
-    if (!startMarkNameorMark)
-      throw new Error("startMarkNameorMark is required");
-    const markName = startMarkNameorMark.name ?? startMarkNameorMark;
-    if (performance.getEntriesByName(markName, "mark").length) {
-      if (typeof startMarkNameorMark === "string")
-        performance.measure(markName, {
+  endTiming = (start, options) => {
+    if (!start) throw new Error("parameter start is required");
+    if (!options || !options?.appId || !options?.appUrl)
+      throw new Error("parameter options is required");
+    const measurementName = start.name ?? start;
+    const startMark = performance.getEntriesByName(
+      measurementName,
+      "mark"
+    )?.[0];
+    const detail = {
+      startAppId: startMark?.detail?.appId ?? options.appId,
+      startAppUrl: startMark?.detail?.appUrl ?? options.appUrl,
+      endAppId: options.appId,
+      endAppUrl: options.appUrl
+    };
+    if (startMark) {
+      if (typeof start === "string")
+        performance.measure(measurementName, {
           detail,
-          start: markName
+          start: measurementName
         });
       else
-        performance.measure(markName, {
+        performance.measure(measurementName, {
           detail,
-          start: startMarkNameorMark.startTime
+          start: start.startTime
         });
-      performance.clearMarks(markName);
+      performance.clearMarks(measurementName);
     } else {
-      performance.measure(markName, { detail });
+      performance.measure(measurementName, { detail });
     }
     return Promise.resolve();
   };

package/dist/esm/analytics/index.js

@@ -1,23 +1,28 @@
 import { CMicroAppGuest } from "../utils/micro-frontend/guest.js";
 import { getBAEventParameters } from "../utils/micro-frontend/scripting-objects/web-analytics.js";
+import { getProductAppDetails } from "../utils/helpers.js";
 const sendBAEventToSelf = (data) => {
+  const eventData = {
+    ...getBAEventParameters(),
+    ...getProductAppDetails(),
+    ...data
+  };
   window.gtmDataLayer = window.gtmDataLayer || [];
-  window.gtmDataLayer.push(data);
+  window.gtmDataLayer.push(eventData);
 };
 const sendBAEvent = ({
   data,
   self = true
 }) => {
-  const eventData = { ...getBAEventParameters(), ...data };
   if (!self) {
     const sendEvent = CMicroAppGuest.getInstance()?.getHost()?.sendBAEvent;
     if (sendEvent) {
-      sendEvent(eventData);
+      sendEvent(data);
     } else {
-      sendBAEventToSelf(eventData);
+      sendBAEventToSelf(data);
     }
   } else {
-    sendBAEventToSelf(eventData);
+    sendBAEventToSelf(data);
   }
 };
 export {

package/dist/esm/analytics/page-view-event.js

@@ -1,27 +1,9 @@
 import { sendBAEvent } from "./index.js";
-const getWindow = () => {
-  try {
-    window.top?.document;
-    return window.top || window.self;
-  } catch (e) {
-    return window.self;
-  }
-};
 const pageViewEvent = ({ pageTitle }) => {
-  const pageWindow = getWindow();
-  const { pathname, href } = pageWindow.location;
-  const { title } = pageWindow.document;
-  const { pathname: guestPagePath, href: guestPageUrl } = window.location;
-  const { title: guestPageTitle } = document;
   sendBAEvent({
     data: {
       event: "pageView",
-      pageUrl: href,
-      pagePath: pathname,
-      pageTitle: title,
-      guestPageUrl,
-      guestPagePath,
-      guestPageTitle: pageTitle || guestPageTitle
+      appPageTitle: pageTitle
     }
   });
 };

package/dist/esm/utils/helpers.js

@@ -1,3 +1,4 @@
+import { getWindow } from "./window.js";
 const isProd = () => false;
 const isCIBuild = () => process.env.CI === "true";
 const PROTOCOL = /^(?:[a-z]+:)?\/\//;
@@ -7,8 +8,28 @@ const convertRelativeToAbsoluteUrl = (url) => {
   }
   return url;
 };
+const getProductAppDetails = () => {
+  const pageWindow = getWindow();
+  const { title: productPageTitle } = pageWindow.document;
+  const { title: appPageTitle } = document;
+  const productId = pageWindow?.emui?.appId ?? "";
+  const appId = window?.emui?.appId ?? "";
+  const { pathname: productPath, href: productUrl } = pageWindow.location;
+  const { pathname: appPath, href: appUrl } = window.location;
+  return {
+    productId,
+    productPath,
+    productUrl,
+    productPageTitle,
+    appId,
+    appPath,
+    appUrl,
+    appPageTitle
+  };
+};
 export {
   convertRelativeToAbsoluteUrl,
+  getProductAppDetails,
   isCIBuild,
   isProd
 };

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

@@ -1,5 +1,6 @@
 import ssfHost from "@elliemae/em-ssf-host";
 import { getBAEventParameters } from "./web-analytics.js";
+import { getProductAppDetails } from "../../helpers.js";
 class Analytics extends ssfHost.ScriptingObject {
   /**
    * logger instance
@@ -31,6 +32,7 @@ class Analytics extends ssfHost.ScriptingObject {
                 startTime: new Date(
                   performance.timeOrigin + entry.startTime
                 ).toISOString(),
+                ...getBAEventParameters(),
                 ...detail
               }).catch(() => {
               });
@@ -55,57 +57,74 @@ class Analytics extends ssfHost.ScriptingObject {
    * @returns promise
    */
   sendBAEvent = (event) => {
-    const eventEx = { ...getBAEventParameters(), ...event };
+    const eventEx = {
+      ...getBAEventParameters(),
+      ...getProductAppDetails(),
+      ...event
+    };
     window.gtmDataLayer = window.gtmDataLayer || [];
     window.gtmDataLayer.push(eventEx);
     return Promise.resolve();
   };
   /**
-   * start a performance mark
-   * @param markName name of the performance mark
-   * @param markOptions
+   * start timing measure
+   * @param name unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced
+   * @param options additional details related to the measurement
    * @returns a promise that resolves to a PerformanceMeasure object
    */
-  perfMarkStart = (markName, markOptions) => {
-    if (!markName) throw new Error("markName is required");
-    const startMark = performance.mark(markName, markOptions);
+  startTiming = (name, options) => {
+    if (!name) throw new Error("parameter mark is required");
+    if (!options || !options?.appId || !options?.appUrl)
+      throw new Error("parameter options is required");
+    const startMark = performance.mark(name, { detail: options });
     return Promise.resolve(startMark);
   };
   /**
-   * end a performance mark
-   * @param startMarkNameorMark start mark name or start PerformanceMeasure object
-   * @param detail
-   * @returns a promise that resolves when the mark is ended
+   * end timing measure
+   * @param start name used to start timing measure or return value of the startTiming method
+   * @param options additional details related to the measurement
+   * @returns a promise that resolves when the timing measurement is ended
    * @example
    * ```typescript
-   * const startMark = await analytics.perfMarkStart('LongTask');
+   * const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });
    * // do some work
-   * await analytics.perfMarkEnd(startMark);
+   * await analytics.endTiming(longTaskMeasurement, { appId: 'myApp', appUrl: 'https://myapp.com' });
    * ```
    * ```typescript
-   * await analytics.perfMarkStart('LongTask');
+   * const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });
    * // do some work
-   * await analytics.perfMarkEnd('LongTask');
+   * await analytics.endTiming('LongTask', { appId: 'loanApp', appUrl: 'https://loanApp.com' });
    * ```
    */
-  perfMarkEnd = (startMarkNameorMark, detail) => {
-    if (!startMarkNameorMark)
-      throw new Error("startMarkNameorMark is required");
-    const markName = startMarkNameorMark.name ?? startMarkNameorMark;
-    if (performance.getEntriesByName(markName, "mark").length) {
-      if (typeof startMarkNameorMark === "string")
-        performance.measure(markName, {
+  endTiming = (start, options) => {
+    if (!start) throw new Error("parameter start is required");
+    if (!options || !options?.appId || !options?.appUrl)
+      throw new Error("parameter options is required");
+    const measurementName = start.name ?? start;
+    const startMark = performance.getEntriesByName(
+      measurementName,
+      "mark"
+    )?.[0];
+    const detail = {
+      startAppId: startMark?.detail?.appId ?? options.appId,
+      startAppUrl: startMark?.detail?.appUrl ?? options.appUrl,
+      endAppId: options.appId,
+      endAppUrl: options.appUrl
+    };
+    if (startMark) {
+      if (typeof start === "string")
+        performance.measure(measurementName, {
           detail,
-          start: markName
+          start: measurementName
         });
       else
-        performance.measure(markName, {
+        performance.measure(measurementName, {
           detail,
-          start: startMarkNameorMark.startTime
+          start: start.startTime
         });
-      performance.clearMarks(markName);
+      performance.clearMarks(measurementName);
     } else {
-      performance.measure(markName, { detail });
+      performance.measure(measurementName, { detail });
     }
     return Promise.resolve();
   };

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

@@ -1,4 +1,11 @@
 import { BAEvent } from '@elliemae/pui-micro-frontend-base';
+/**
+ * Sends business analytics event
+ * @param root0
+ * @param root0.data
+ * @param root0.self
+ * @deprecated use Analytics.sendBAEvent scripting object method instead
+ */
 export declare const sendBAEvent: ({ data, self, }: {
     data: BAEvent;
     self?: boolean;

package/dist/types/lib/utils/helpers.d.ts

@@ -1,3 +1,13 @@
 export declare const isProd: () => boolean;
 export declare const isCIBuild: () => boolean;
 export declare const convertRelativeToAbsoluteUrl: (url: string) => string;
+export declare const getProductAppDetails: () => {
+    productId: string;
+    productPath: string;
+    productUrl: string;
+    productPageTitle: string;
+    appId: string;
+    appPath: string;
+    appUrl: string;
+    appPageTitle: string;
+};

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

@@ -1,5 +1,5 @@
 import ssfHost from '@elliemae/em-ssf-host';
-import { IAnalytics, BAEvent } from '@elliemae/pui-scripting-object';
+import { IAnalytics, BAEvent, TimingOptions } from '@elliemae/pui-scripting-object';
 import { MicroFrontEndLogger } from '../../types.js';
 /**
  * Analytics scripting object
@@ -18,28 +18,28 @@ export declare class Analytics extends ssfHost.ScriptingObject implements IAnaly
      */
     sendBAEvent: (event: BAEvent) => Promise<void>;
     /**
-     * start a performance mark
-     * @param markName name of the performance mark
-     * @param markOptions
+     * start timing measure
+     * @param name unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced
+     * @param options additional details related to the measurement
      * @returns a promise that resolves to a PerformanceMeasure object
      */
-    perfMarkStart: (markName: string, markOptions?: PerformanceMarkOptions) => Promise<PerformanceMark>;
+    startTiming: (name: string, options: TimingOptions) => Promise<PerformanceMark>;
     /**
-     * end a performance mark
-     * @param startMarkNameorMark start mark name or start PerformanceMeasure object
-     * @param detail
-     * @returns a promise that resolves when the mark is ended
+     * end timing measure
+     * @param start name used to start timing measure or return value of the startTiming method
+     * @param options additional details related to the measurement
+     * @returns a promise that resolves when the timing measurement is ended
      * @example
      * ```typescript
-     * const startMark = await analytics.perfMarkStart('LongTask');
+     * const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });
      * // do some work
-     * await analytics.perfMarkEnd(startMark);
+     * await analytics.endTiming(longTaskMeasurement, { appId: 'myApp', appUrl: 'https://myapp.com' });
      * ```
      * ```typescript
-     * await analytics.perfMarkStart('LongTask');
+     * const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });
      * // do some work
-     * await analytics.perfMarkEnd('LongTask');
+     * await analytics.endTiming('LongTask', { appId: 'loanApp', appUrl: 'https://loanApp.com' });
      * ```
      */
-    perfMarkEnd: (startMarkNameorMark: string | PerformanceMeasure, detail?: Record<string, unknown>) => Promise<void>;
+    endTiming: (start: string | PerformanceMeasure, options: TimingOptions) => Promise<void>;
 }