@elliemae/pui-app-sdk 5.44.2 → 5.46.0

package/demo/project.json

@@ -1 +1 @@
-{"generatedAt":1784931104289,"builder":{"name":"webpack5"},"hasCustomBabel":false,"hasCustomWebpack":true,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"pnpm","version":"8.15.9"},"typescriptOptions":{"check":false,"checkOptions":{},"reactDocgen":false,"reactDocgenTypescriptOptions":{"shouldExtractLiteralValuesFromEnum":true,"compilerOptions":{"allowSyntheticDefaultImports":false,"esModuleInterop":false}}},"features":{"fastRefresh":true,"storyStoreV7":true},"language":"javascript","storybookPackages":{},"framework":{"options":{"fastRefresh":true,"strictMode":true,"legacyRootApi":true}},"addons":{"@storybook/addon-docs":{"options":{"sourceLoaderOptions":{"injectStoryParameters":false}},"version":"6.5.16"},"@storybook/addon-essentials":{"options":{"docs":false},"version":"6.5.16"},"@storybook/addon-storysource":{"version":"6.5.16"},"@storybook/addon-links":{"version":"6.5.16"},"@storybook/addon-events":{"version":"6.2.9"},"@storybook/addon-interactions":{"version":"6.5.16"},"@storybook/addon-a11y":{"version":"6.5.16"},"storybook-addon-turbo-build":{"options":{"optimizationLevel":2,"esbuildMinifyOptions":{"target":"es2022"}},"version":"1.1.0"}}}
+{"generatedAt":1786491336743,"builder":{"name":"webpack5"},"hasCustomBabel":false,"hasCustomWebpack":true,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"pnpm","version":"8.15.9"},"typescriptOptions":{"check":false,"checkOptions":{},"reactDocgen":false,"reactDocgenTypescriptOptions":{"shouldExtractLiteralValuesFromEnum":true,"compilerOptions":{"allowSyntheticDefaultImports":false,"esModuleInterop":false}}},"features":{"fastRefresh":true,"storyStoreV7":true},"language":"javascript","storybookPackages":{},"framework":{"options":{"fastRefresh":true,"strictMode":true,"legacyRootApi":true}},"addons":{"@storybook/addon-docs":{"options":{"sourceLoaderOptions":{"injectStoryParameters":false}},"version":"6.5.16"},"@storybook/addon-essentials":{"options":{"docs":false},"version":"6.5.16"},"@storybook/addon-storysource":{"version":"6.5.16"},"@storybook/addon-links":{"version":"6.5.16"},"@storybook/addon-events":{"version":"6.2.9"},"@storybook/addon-interactions":{"version":"6.5.16"},"@storybook/addon-a11y":{"version":"6.5.16"},"storybook-addon-turbo-build":{"options":{"optimizationLevel":2,"esbuildMinifyOptions":{"target":"es2022"}},"version":"1.1.0"}}}

package/dist/cjs/index.js

@@ -137,6 +137,7 @@ __export(index_exports, {
   setAppConfigValue: () => import_config.setAppConfigValue,
   setHostAppData: () => import_store2.setHostAppData,
   setLoginParams: () => import_loginParams.setLoginParams,
+  setSessionTimeoutInterval: () => import_session.setSessionTimeoutInterval,
   startSideEffect: () => import_listenerMiddleware.startSideEffect,
   subscribeToResetSession: () => import_session.subscribeToResetSession,
   subscribeToSessionExpiry: () => import_session.subscribeToSessionExpiry,

package/dist/cjs/package.json

@@ -3,8 +3,5 @@
   "sideEffects": [
     "*.css",
     "*.html"
-  ],
-  "publishConfig": {
-    "access": "public"
-  }
+  ]
 }

package/dist/cjs/utils/constants.js

@@ -18,11 +18,17 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var constants_exports = {};
 __export(constants_exports, {
+  DEFAULT_SESSION_WARN: () => DEFAULT_SESSION_WARN,
   HOST_WINDOW_BREAKPOINT_CHANGED: () => HOST_WINDOW_BREAKPOINT_CHANGED,
   HOST_WINDOW_RESIZED: () => HOST_WINDOW_RESIZED,
+  MAX_SESSION_TIMEOUT: () => MAX_SESSION_TIMEOUT,
+  MIN_SESSION_TIMEOUT: () => MIN_SESSION_TIMEOUT,
+  SESSION_EXPIRY_GREATER_THAN_MAX_ERROR: () => SESSION_EXPIRY_GREATER_THAN_MAX_ERROR,
+  SESSION_EXPIRY_LESS_THAN_MIN_ERROR: () => SESSION_EXPIRY_LESS_THAN_MIN_ERROR,
   SESSION_RENEWAL_INTERVAL: () => SESSION_RENEWAL_INTERVAL,
   SESSION_TIMEOUT_INTERVAL: () => SESSION_TIMEOUT_INTERVAL,
   Themes: () => Themes,
+  WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR: () => WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR,
   default: () => constants_default
 });
 module.exports = __toCommonJS(constants_exports);
@@ -43,3 +49,9 @@ const Themes = {
 const HOST_WINDOW_RESIZED = "HOST_WINDOW_RESIZED";
 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 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/cjs/utils/session-timeout-config.js

@@ -21,17 +21,28 @@ __export(session_timeout_config_exports, {
   getSessionExpiryIntervalMs: () => getSessionExpiryIntervalMs,
   getSessionTimeoutMs: () => getSessionTimeoutMs,
   getSessionWarnIntervalMs: () => getSessionWarnIntervalMs,
-  resetSessionTimeoutCache: () => resetSessionTimeoutCache
+  resetSessionTimeoutCache: () => resetSessionTimeoutCache,
+  setSessionTimeoutCache: () => setSessionTimeoutCache
 });
 module.exports = __toCommonJS(session_timeout_config_exports);
 var import_config = require("./app-config/config.js");
 var import_constants = require("./constants.js");
 let cachedWarnIntervalMs;
 let cachedExpiryIntervalMs;
+const minutesToMs = (minutes) => minutes * 6e4;
 const resetSessionTimeoutCache = () => {
   cachedWarnIntervalMs = void 0;
   cachedExpiryIntervalMs = void 0;
 };
+const setSessionTimeoutCache = ({
+  sessionExpiryInterval,
+  sessionWarnInterval
+}) => {
+  cachedWarnIntervalMs = minutesToMs(
+    sessionExpiryInterval - sessionWarnInterval
+  );
+  cachedExpiryIntervalMs = minutesToMs(sessionExpiryInterval);
+};
 const getSessionTimeoutMs = (key, fallback) => {
   const value = (0, import_config.getAppConfigValue)(key);
   if (value == null || value === "") return fallback;

package/dist/cjs/utils/session.js

@@ -22,6 +22,7 @@ __export(session_exports, {
   initSessionMonitoring: () => initSessionMonitoring,
   renewSession: () => renewSession,
   resetUserIdleTime: () => resetUserIdleTime,
+  setSessionTimeoutInterval: () => setSessionTimeoutInterval,
   stopSessionMonitoring: () => stopSessionMonitoring,
   subscribeToResetSession: () => subscribeToResetSession,
   subscribeToSessionExpiry: () => subscribeToSessionExpiry,
@@ -71,6 +72,19 @@ const resetUserIdleTime = (resetWarningModal = false) => {
   if (!enforceIdleThresholds(resetWarningModal === true)) return;
   markUserActive(resetWarningModal);
 };
+const setSessionTimeoutInterval = ({
+  sessionExpiryInterval = import_constants.MIN_SESSION_TIMEOUT,
+  sessionWarnInterval = import_constants.DEFAULT_SESSION_WARN
+}) => {
+  if (sessionExpiryInterval < import_constants.MIN_SESSION_TIMEOUT)
+    throw new Error(import_constants.SESSION_EXPIRY_LESS_THAN_MIN_ERROR);
+  if (sessionExpiryInterval > import_constants.MAX_SESSION_TIMEOUT)
+    throw new Error(import_constants.SESSION_EXPIRY_GREATER_THAN_MAX_ERROR);
+  if (sessionWarnInterval >= sessionExpiryInterval)
+    throw new Error(import_constants.WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR);
+  (0, import_session_timeout_config.setSessionTimeoutCache)({ sessionExpiryInterval, sessionWarnInterval });
+  resetUserIdleTime(true);
+};
 const renewSession = async (explicit = false) => {
   if (!enforceIdleThresholds(explicit === true)) return;
   const loginParams = (0, import_loginParams.getLoginParams)();

package/dist/esm/index.js

@@ -55,6 +55,7 @@ import {
   subscribeToSessionExpiryWarning,
   subscribeToSessionExpiry,
   subscribeToResetSession,
+  setSessionTimeoutInterval,
   resetUserIdleTime,
   trackActivity
 } from "./utils/session.js";
@@ -261,6 +262,7 @@ export {
   setAppConfigValue,
   setHostAppData,
   setLoginParams,
+  setSessionTimeoutInterval,
   startSideEffect,
   subscribeToResetSession,
   subscribeToSessionExpiry,

package/dist/esm/package.json

@@ -3,8 +3,5 @@
   "sideEffects": [
     "*.css",
     "*.html"
-  ],
-  "publishConfig": {
-    "access": "public"
-  }
+  ]
 }

package/dist/esm/utils/constants.js

@@ -15,11 +15,23 @@ const Themes = {
 const HOST_WINDOW_RESIZED = "HOST_WINDOW_RESIZED";
 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 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.";
 export {
+  DEFAULT_SESSION_WARN,
   HOST_WINDOW_BREAKPOINT_CHANGED,
   HOST_WINDOW_RESIZED,
+  MAX_SESSION_TIMEOUT,
+  MIN_SESSION_TIMEOUT,
+  SESSION_EXPIRY_GREATER_THAN_MAX_ERROR,
+  SESSION_EXPIRY_LESS_THAN_MIN_ERROR,
   SESSION_RENEWAL_INTERVAL,
   SESSION_TIMEOUT_INTERVAL,
   Themes,
+  WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR,
   constants_default as default
 };

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

@@ -2,10 +2,20 @@ import { getAppConfigValue } from "./app-config/config.js";
 import { SESSION_TIMEOUT_INTERVAL } from "./constants.js";
 let cachedWarnIntervalMs;
 let cachedExpiryIntervalMs;
+const minutesToMs = (minutes) => minutes * 6e4;
 const resetSessionTimeoutCache = () => {
   cachedWarnIntervalMs = void 0;
   cachedExpiryIntervalMs = void 0;
 };
+const setSessionTimeoutCache = ({
+  sessionExpiryInterval,
+  sessionWarnInterval
+}) => {
+  cachedWarnIntervalMs = minutesToMs(
+    sessionExpiryInterval - sessionWarnInterval
+  );
+  cachedExpiryIntervalMs = minutesToMs(sessionExpiryInterval);
+};
 const getSessionTimeoutMs = (key, fallback) => {
   const value = getAppConfigValue(key);
   if (value == null || value === "") return fallback;
@@ -36,5 +46,6 @@ export {
   getSessionExpiryIntervalMs,
   getSessionTimeoutMs,
   getSessionWarnIntervalMs,
-  resetSessionTimeoutCache
+  resetSessionTimeoutCache,
+  setSessionTimeoutCache
 };

package/dist/esm/utils/session.js

@@ -5,12 +5,21 @@ import { introspectToken } from "../api/auth/index.js";
 import { getLogger } from "./logger.js";
 import { logRecords } from "./log-records.js";
 import { endSession } from "./auth/index.js";
-import { SESSION_RENEWAL_INTERVAL } from "./constants.js";
+import {
+  DEFAULT_SESSION_WARN,
+  MIN_SESSION_TIMEOUT,
+  MAX_SESSION_TIMEOUT,
+  SESSION_RENEWAL_INTERVAL,
+  SESSION_EXPIRY_GREATER_THAN_MAX_ERROR,
+  SESSION_EXPIRY_LESS_THAN_MIN_ERROR,
+  WARN_INTERVAL_NOT_LESS_THAN_EXPIRY_ERROR
+} from "./constants.js";
 import { subscribeToPageWake } from "./page-wake.js";
 import {
   getSessionWarnIntervalMs,
   getSessionExpiryIntervalMs,
-  resetSessionTimeoutCache
+  resetSessionTimeoutCache,
+  setSessionTimeoutCache
 } from "./session-timeout-config.js";
 let lastUserActivityTimeStamp = Date.now();
 const warnListeners = [];
@@ -44,6 +53,19 @@ const resetUserIdleTime = (resetWarningModal = false) => {
   if (!enforceIdleThresholds(resetWarningModal === true)) return;
   markUserActive(resetWarningModal);
 };
+const setSessionTimeoutInterval = ({
+  sessionExpiryInterval = MIN_SESSION_TIMEOUT,
+  sessionWarnInterval = DEFAULT_SESSION_WARN
+}) => {
+  if (sessionExpiryInterval < MIN_SESSION_TIMEOUT)
+    throw new Error(SESSION_EXPIRY_LESS_THAN_MIN_ERROR);
+  if (sessionExpiryInterval > MAX_SESSION_TIMEOUT)
+    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 });
+  resetUserIdleTime(true);
+};
 const renewSession = async (explicit = false) => {
   if (!enforceIdleThresholds(explicit === true)) return;
   const loginParams = getLoginParams();
@@ -168,6 +190,7 @@ export {
   initSessionMonitoring,
   renewSession,
   resetUserIdleTime,
+  setSessionTimeoutInterval,
   stopSessionMonitoring,
   subscribeToResetSession,
   subscribeToSessionExpiry,

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

@@ -26,7 +26,7 @@ export { ACTIONS as NavigationPromptActions } from './data/navigation-prompt/act
 export { loadable } from './view/loadable/index.js';
 export { WaitMessage } from './view/wait-message/index.js';
 export { SessionTimeout } from './view/session-timeout/index.js';
-export { subscribeToSessionExpiryWarning, subscribeToSessionExpiry, subscribeToResetSession, resetUserIdleTime, trackActivity, } from './utils/session.js';
+export { subscribeToSessionExpiryWarning, subscribeToSessionExpiry, subscribeToResetSession, setSessionTimeoutInterval, resetUserIdleTime, trackActivity, } from './utils/session.js';
 export { waitMessage as waitMessageAction } from './data/wait-message/actions.js';
 export { initServiceWorker } from './utils/service-worker.js';
 export { CMicroAppGuest, CMicroAppGuest as CMicroApp, } from './utils/micro-frontend/guest.js';

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

@@ -14,3 +14,9 @@ export declare const Themes: {
 export declare const HOST_WINDOW_RESIZED = "HOST_WINDOW_RESIZED";
 export declare const HOST_WINDOW_BREAKPOINT_CHANGED = "HOST_WINDOW_BREAKPOINT_CHANGED";
 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 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/session-timeout-config.d.ts

@@ -1,5 +1,9 @@
 type SessionTimeoutKey = 'sessionTimeoutWarnInterval' | 'sessionTimeoutInterval';
 export declare const resetSessionTimeoutCache: () => void;
+export declare const setSessionTimeoutCache: ({ sessionExpiryInterval, sessionWarnInterval, }: {
+    sessionExpiryInterval: number;
+    sessionWarnInterval: number;
+}) => void;
 export declare const getSessionTimeoutMs: (key: SessionTimeoutKey, fallback: number) => number;
 export declare const getSessionWarnIntervalMs: () => number;
 export declare const getSessionExpiryIntervalMs: () => number;

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

@@ -16,6 +16,18 @@ type LISTENER = {
  *   listeners so the warning modal can close. Only for explicit user actions.
  */
 export declare const resetUserIdleTime: ResetUserIdleTimeFn;
+/**
+ * Allows developers to provide a custom value for session expiry.
+ * @param {object} Customize session timeout warn and expiry intervals
+ * @param Customize.sessionExpiryInterval
+ * @param sessionExpiryInterval Custom session expiry value in minutes
+ * @param sessionWarnInterval Custom session warning value in minutes
+ * @param Customize.sessionWarnInterval
+ */
+export declare const setSessionTimeoutInterval: ({ sessionExpiryInterval, sessionWarnInterval, }: {
+    sessionExpiryInterval: number;
+    sessionWarnInterval: number;
+}) => void;
 /**
  * Extends the PSS (Encompass) session via token introspection and resets idle.
  * @param {boolean} [explicit=false] - Pass true for deliberate user actions