@elliemae/pui-app-sdk 5.49.0 → 5.50.1

package/dist/esm/analytics/push-to-data-layer.js

@@ -0,0 +1,14 @@
+import { getBAEventParameters } from "@elliemae/pui-analytics-so";
+import { getProductAppDetails } from "../utils/product-app-details.js";
+const pushBAEventToDataLayer = (data) => {
+  const eventData = {
+    ...getBAEventParameters(),
+    ...getProductAppDetails(),
+    ...data
+  };
+  window.gtmDataLayer = window.gtmDataLayer || [];
+  window.gtmDataLayer.push(eventData);
+};
+export {
+  pushBAEventToDataLayer
+};

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

@@ -1,21 +1,17 @@
 import { updateBAEventParameters } from "@elliemae/pui-analytics-so";
-import { sendBAEvent } from "./index.js";
+import { pushBAEventToDataLayer } from "./push-to-data-layer.js";
 const loginEvent = ({
   instanceId,
   userId
 }) => {
   updateBAEventParameters({ instanceId, userId });
-  sendBAEvent({
-    data: {
-      event: "login"
-    }
+  pushBAEventToDataLayer({
+    event: "login"
   });
 };
 const logoutEvent = () => {
-  sendBAEvent({
-    data: {
-      event: "logout"
-    }
+  pushBAEventToDataLayer({
+    event: "logout"
   });
   updateBAEventParameters({ instanceId: "", userId: "" });
 };

package/dist/esm/utils/constants.js

@@ -17,7 +17,7 @@ const HOST_WINDOW_BREAKPOINT_CHANGED = "HOST_WINDOW_BREAKPOINT_CHANGED";
 const SESSION_RENEWAL_INTERVAL = 6e4;
 const MIN_SESSION_TIMEOUT = 15;
 const MAX_SESSION_TIMEOUT = 60;
-const DEFAULT_SESSION_WARN = 3;
+const DEFAULT_SESSION_WARN = 12;
 const SESSION_EXPIRY_LESS_THAN_MIN_ERROR = `Session timeout interval must be at least ${MIN_SESSION_TIMEOUT} minutes.`;
 const SESSION_EXPIRY_GREATER_THAN_MAX_ERROR = `Session timeout interval can not exceed ${MAX_SESSION_TIMEOUT} minutes.`;
 const WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR = "Session warning interval must be less than session timeout interval.";

package/dist/esm/utils/get-window.js

@@ -0,0 +1,11 @@
+const getWindow = () => {
+  try {
+    window.parent.document;
+    return window.parent;
+  } catch (err) {
+    return window;
+  }
+};
+export {
+  getWindow
+};

package/dist/esm/utils/helpers.js

@@ -1,6 +1,6 @@
-import { getWindow } from "./window.js";
 const isProd = () => false;
 const isCIBuild = () => process.env.CI === "true";
+import { getProductAppDetails } from "./product-app-details.js";
 const PROTOCOL = /^(?:[a-z]+:)?\/\//;
 const convertRelativeToAbsoluteUrl = (url) => {
   if (!PROTOCOL.test(url)) {
@@ -8,27 +8,6 @@ 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 version = pageWindow?.emui?.version ?? "";
-  const appId = window?.emui?.appId ?? "";
-  const { pathname: productPath, href: productUrl } = pageWindow.location;
-  const { pathname: appPath, href: appUrl } = window.location;
-  return {
-    productId,
-    productPath,
-    productUrl,
-    productPageTitle,
-    version,
-    appId,
-    appPath,
-    appUrl,
-    appPageTitle
-  };
-};
 const abortPromise = ({
   promise,
   delay,

package/dist/esm/utils/product-app-details.js

@@ -0,0 +1,25 @@
+import { getWindow } from "./get-window.js";
+const getProductAppDetails = () => {
+  const pageWindow = getWindow();
+  const { title: productPageTitle } = pageWindow.document;
+  const { title: appPageTitle } = document;
+  const productId = pageWindow?.emui?.appId ?? "";
+  const version = pageWindow?.emui?.version ?? "";
+  const appId = window?.emui?.appId ?? "";
+  const { pathname: productPath, href: productUrl } = pageWindow.location;
+  const { pathname: appPath, href: appUrl } = window.location;
+  return {
+    productId,
+    productPath,
+    productUrl,
+    productPageTitle,
+    version,
+    appId,
+    appPath,
+    appUrl,
+    appPageTitle
+  };
+};
+export {
+  getProductAppDetails
+};

package/dist/esm/utils/session-timeout-config.js

@@ -11,9 +11,7 @@ const setSessionTimeoutCache = ({
   sessionExpiryInterval,
   sessionWarnInterval
 }) => {
-  cachedWarnIntervalMs = minutesToMs(
-    sessionExpiryInterval - sessionWarnInterval
-  );
+  cachedWarnIntervalMs = minutesToMs(sessionWarnInterval);
   cachedExpiryIntervalMs = minutesToMs(sessionExpiryInterval);
 };
 const getSessionTimeoutMs = (key, fallback) => {

package/dist/esm/utils/session.js

@@ -31,6 +31,7 @@ let sessionExpired = false;
 let timerHandle;
 let removeWakeListener;
 let sessionExpiryWarningNotifiedAt;
+let updateComponentConfig;
 const resetIdleStateFlags = () => {
   sessionExpired = false;
   sessionExpiryWarningNotified = false;
@@ -63,8 +64,8 @@ const setSessionTimeoutInterval = ({
     throw new Error(SESSION_EXPIRY_GREATER_THAN_MAX_ERROR);
   if (sessionWarnInterval >= sessionExpiryInterval)
     throw new Error(WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR);
-  setSessionTimeoutCache({ sessionExpiryInterval, sessionWarnInterval });
-  initSessionMonitoring(false);
+  if (updateComponentConfig)
+    updateComponentConfig({ sessionExpiryInterval, sessionWarnInterval });
 };
 const renewSession = async (explicit = false) => {
   if (!enforceIdleThresholds(explicit === true)) return;
@@ -149,11 +150,16 @@ const addEventListeners = () => {
     document.addEventListener(eventType, renewSessionAtInterval);
   });
 };
-const initSessionMonitoring = (resetCache = true) => {
+const initSessionMonitoring = ({
+  sessionExpiryInterval = 0,
+  sessionWarnInterval = 0
+} = {}) => {
   clearInterval(timerHandle);
   removeWakeListener?.();
   removeActivityEventListeners();
-  if (resetCache) {
+  if (sessionExpiryInterval && sessionWarnInterval) {
+    setSessionTimeoutCache({ sessionExpiryInterval, sessionWarnInterval });
+  } else {
     resetSessionTimeoutCache();
   }
   resetIdleStateFlags();
@@ -173,6 +179,9 @@ const subscribeToResetSession = (onResetListener) => {
   resetListeners.push(onResetListener);
   return removeListeners.bind(null, resetListeners, onResetListener);
 };
+const setUpdateComponentConfig = (updateMethod) => {
+  updateComponentConfig = updateMethod;
+};
 const trackActivity = (element, cb) => {
   if (!element) return () => {
   };
@@ -193,6 +202,7 @@ export {
   renewSession,
   resetUserIdleTime,
   setSessionTimeoutInterval,
+  setUpdateComponentConfig,
   stopSessionMonitoring,
   subscribeToResetSession,
   subscribeToSessionExpiry,

package/dist/esm/utils/window.js

@@ -1,12 +1,5 @@
 import { getDefaultTheme } from "@elliemae/pui-theme";
-const getWindow = () => {
-  try {
-    window.parent.document;
-    return window.parent;
-  } catch (err) {
-    return window;
-  }
-};
+import { getWindow } from "./get-window.js";
 const getViewportSize = () => ({
   width: Math.max(
     document.documentElement.clientWidth || 0,

package/dist/esm/view/session-timeout/index.js

@@ -8,7 +8,8 @@ import {
   subscribeToSessionExpiryWarning,
   subscribeToResetSession,
   subscribeToSessionExpiry,
-  resetUserIdleTime
+  resetUserIdleTime,
+  setUpdateComponentConfig
 } from "../../utils/session.js";
 import { SessionExpiry } from "../modals/session-expiry/index.js";
 import { httpClientProps } from "../../communication/http-client/props.js";
@@ -16,9 +17,14 @@ const SessionTimeout = () => {
   const dispatch = useAppDispatch();
   const [showSessionExpiryWarning, setSessionExpiryWarning] = useState(false);
   const [warningNotifiedAt, setwarningNotifiedAt] = useState();
+  const [sessionConfig, setSessionConfig] = useState({
+    sessionExpiryInterval: 0,
+    sessionWarnInterval: 0
+  });
+  setUpdateComponentConfig(setSessionConfig);
   useEffect(() => {
     httpClientProps.resetUserIdleTime = resetUserIdleTime;
-    initSessionMonitoring();
+    initSessionMonitoring(sessionConfig);
     const warningCb = subscribeToSessionExpiryWarning(
       (sessionExpiryWarningNotifiedAt) => {
         if (!sessionExpiryWarningNotifiedAt) return;
@@ -41,7 +47,7 @@ const SessionTimeout = () => {
       sessionExpiredCb();
       stopSessionMonitoring();
     };
-  }, [dispatch]);
+  }, [dispatch, sessionConfig]);
   return /* @__PURE__ */ jsx("div", { children: showSessionExpiryWarning && /* @__PURE__ */ jsx(SessionExpiry, { open: true, warningNotifiedAt }) });
 };
 export {

package/dist/types/lib/analytics/push-to-data-layer.d.ts

@@ -0,0 +1,6 @@
+import { BAEvent } from '@elliemae/pui-micro-frontend-base';
+/**
+ * Push a business analytics event to the local GTM data layer.
+ * @param data
+ */
+export declare const pushBAEventToDataLayer: (data: BAEvent) => void;

package/dist/types/lib/analytics/tests/push-to-data-layer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/analytics/tests/send-ba-event.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/analytics/tests/user-session-event.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -16,7 +16,7 @@ export declare const HOST_WINDOW_BREAKPOINT_CHANGED = "HOST_WINDOW_BREAKPOINT_CH
 export declare const SESSION_RENEWAL_INTERVAL = 60000;
 export declare const MIN_SESSION_TIMEOUT = 15;
 export declare const MAX_SESSION_TIMEOUT = 60;
-export declare const DEFAULT_SESSION_WARN = 3;
+export declare const DEFAULT_SESSION_WARN = 12;
 export declare const SESSION_EXPIRY_LESS_THAN_MIN_ERROR = "Session timeout interval must be at least 15 minutes.";
 export declare const SESSION_EXPIRY_GREATER_THAN_MAX_ERROR = "Session timeout interval can not exceed 60 minutes.";
 export declare const WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR = "Session warning interval must be less than session timeout interval.";

package/dist/types/lib/utils/get-window.d.ts

@@ -0,0 +1,2 @@
+/** Return the parent window when same-origin, otherwise the current window. */
+export declare const getWindow: () => WindowProxy;

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

@@ -1,17 +1,7 @@
 export declare const isProd: () => boolean;
 export declare const isCIBuild: () => boolean;
+export { getProductAppDetails } from './product-app-details.js';
 export declare const convertRelativeToAbsoluteUrl: (url: string) => string;
-export declare const getProductAppDetails: () => {
-    productId: string;
-    productPath: string;
-    productUrl: string;
-    productPageTitle: string;
-    version: string;
-    appId: string;
-    appPath: string;
-    appUrl: string;
-    appPageTitle: string;
-};
 export declare const abortPromise: ({ promise, delay, retValue, throwError, errMsg, }: {
     promise: Promise<unknown>;
     delay: number;

package/dist/types/lib/utils/product-app-details.d.ts

@@ -0,0 +1,12 @@
+/** Collect host and guest page metadata for analytics events. */
+export declare const getProductAppDetails: () => {
+    productId: string;
+    productPath: string;
+    productUrl: string;
+    productPageTitle: string;
+    version: string;
+    appId: string;
+    appPath: string;
+    appUrl: string;
+    appPageTitle: string;
+};

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

@@ -8,6 +8,13 @@ type RESETLISTENER = {
 type LISTENER = {
     (): void;
 };
+type SessionConfigType = {
+    sessionExpiryInterval: number;
+    sessionWarnInterval: number;
+};
+type UPDATECOMPONENTCONFIGTYPE = {
+    (arg0: SessionConfigType): void;
+};
 /**
  * Resets the user idle clock without calling the auth introspection API.
  * Used by the HTTP request interceptor. Runs through `enforceIdleThresholds()`
@@ -52,8 +59,13 @@ export declare const addEventListeners: () => void;
  * Safe to call more than once; clears previous listeners and timers first.
  * Typically wired up once via the `SessionTimeout` component.
  * @param resetCache
+ * @param resetCache.sessionExpiryInterval
+ * @param resetCache.sessionWarnInterval
  */
-export declare const initSessionMonitoring: (resetCache?: boolean) => void;
+export declare const initSessionMonitoring: ({ sessionExpiryInterval, sessionWarnInterval, }?: {
+    sessionExpiryInterval?: number | undefined;
+    sessionWarnInterval?: number | undefined;
+}) => void;
 /**
  * Registers a callback when idle time crosses the warn threshold.
  * @param {WARNLISTENER} onSessionExpiryWarn - Timestamp the warning was shown.
@@ -72,6 +84,11 @@ export declare const subscribeToSessionExpiry: (onSessionExpiry: LISTENER) => ()
  * @returns {Function} Unsubscribe function.
  */
 export declare const subscribeToResetSession: (onResetListener: RESETLISTENER) => () => void;
+/**
+ * Register a callback that updates the session timeout component with a new configuration
+ * @param updateMethod updates the component with the new configuration
+ */
+export declare const setUpdateComponentConfig: (updateMethod: UPDATECOMPONENTCONFIGTYPE) => void;
 /**
  * Tracks user interaction on a document and invokes a callback (iframe guests).
  * Does not run `enforceIdleThresholds`; callback should use a guarded renewal path.

package/dist/types/lib/utils/tests/get-window.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/utils/tests/product-app-details.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -7,6 +7,7 @@ import { Logger } from '@elliemae/pui-diagnostics';
 import { IMicroFEHost } from '@elliemae/pui-app-bridge';
 import type LogRocket from 'logrocket';
 import { LoginParams } from './auth/types';
+export { getWindow } from './get-window.js';
 export type EMUI<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>, AppEvents extends EventListeners = Events> = {
     [key: string]: IMicroAppGuest<AppObjects, AppEvents> | IMicroAppGuest<AppObjects, AppEvents>[];
 } & {
@@ -38,7 +39,6 @@ declare global {
         };
     }
 }
-export declare const getWindow: () => WindowProxy;
 export declare const getViewportSize: () => {
     width: number;
     height: number;