@elliemae/pui-app-sdk 5.31.0 → 5.31.4

package/dist/cjs/view/fields/form-layout-block-item/index.js

@@ -24,14 +24,12 @@ module.exports = __toCommonJS(form_layout_block_item_exports);
 var import_jsx_runtime = require("react/jsx-runtime");
 var import_ds_form_layout_blocks = require("@elliemae/ds-form-layout-blocks");
 var import_react_hook_form = require("react-hook-form");
-var import_connect_form = require("../connect-form.js");
 const FormLayoutBlockItem = ({
   inputID,
   label,
   ...rest
-}) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_connect_form.ConnectForm, { children: ({
-  formState: { errors }
 }) => {
+  const { errors } = (0, import_react_hook_form.useFormState)({ name: inputID });
   const errorField = (0, import_react_hook_form.get)(errors, inputID);
   const hasError = !!errorField;
   const validationMessage = errorField?.message;
@@ -45,4 +43,4 @@ const FormLayoutBlockItem = ({
       ...rest
     }
   );
-} });
+};

package/dist/cjs/view/page.js

@@ -26,18 +26,11 @@ var import_jsx_runtime = require("react/jsx-runtime");
 var import_react_helmet = require("react-helmet");
 var import_page_view_event = require("../analytics/page-view-event.js");
 var import_logrocket = require("../utils/micro-frontend/scripting-objects/logrocket.js");
-var import_web_analytics = require("../utils/micro-frontend/scripting-objects/web-analytics.js");
-var import_helpers = require("../utils/helpers.js");
 const onPageView = (pageTitle) => {
   (0, import_page_view_event.pageViewEvent)({ pageTitle });
-  const logRocket = (0, import_logrocket.getLogRocket)();
-  if (logRocket) {
-    logRocket.track("pageView", {
-      pageTitle,
-      ...(0, import_web_analytics.getBAEventParameters)(),
-      ...(0, import_helpers.getProductAppDetails)()
-    });
-  }
+  (0, import_logrocket.lrTrack)("page-view", {
+    pageTitle
+  });
 };
 const Page = ({ pageTitle = "ICE", children }) => {
   onPageView(pageTitle);

package/dist/cjs/view/tests/__snapshots__/guest-microapp.test.tsx.snap

@@ -7,7 +7,7 @@ exports[`GuestMicroApp with SSFHost should accept ssfAppOptions 1`] = `
 
 <iframe
   id="ssfapp"
-  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin "
+  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin"
   src="http://localhost:3111/ssfapp/?testParam=testValue"
   style="min-width: 100%; height: 100%; border: 0px; border: 10px solid blue;"
   title="SSF App"
@@ -50,7 +50,7 @@ exports[`GuestMicroApp with SSFHost should prefer ssfAppOptions sent in params i
 
 <iframe
   id="ssfapp"
-  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin "
+  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin"
   src="http://localhost:3111/ssfapp/?testParam=testValue"
   style="min-width: 100%; height: 100%; border: 0px; border: 2px solid red;"
   title="SSF App"

package/dist/cjs/view/wait-message/index.js

@@ -40,8 +40,6 @@ var import_react2 = require("../../data/react.js");
 var import_use_html_wait_message = require("./use-html-wait-message.js");
 var import_user_wait_event = require("../../analytics/user-wait-event.js");
 var import_logrocket = require("../../utils/micro-frontend/scripting-objects/logrocket.js");
-var import_web_analytics = require("../../utils/micro-frontend/scripting-objects/web-analytics.js");
-var import_helpers = require("../../utils/helpers.js");
 const StyledCircularIndicator = (0, import_styled_components.default)(import_ds_circular_progress_indicator.DSCircularIndeterminateIndicator)`
   position: absolute;
   left: 50%;
@@ -64,19 +62,13 @@ const WaitMessage = (0, import_react.memo)(
     const delay = (0, import_react2.useAppSelector)((state) => state.waitMessage?.delay);
     ref.current = isOpen ?? false;
     const message = (0, import_react2.useAppSelector)((state) => state.waitMessage?.message);
-    const logRocket = (0, import_logrocket.getLogRocket)();
     (0, import_react.useEffect)(() => {
       setTimeout(
         () => {
           if (isOpen && ref.current) {
             setShow(true);
             (0, import_user_wait_event.waitStartEvent)();
-            if (logRocket) {
-              logRocket.track("wait-spinner-start", {
-                ...(0, import_web_analytics.getBAEventParameters)(),
-                ...(0, import_helpers.getProductAppDetails)()
-              });
-            }
+            (0, import_logrocket.lrTrack)("wait-spinner-start");
           }
         },
         delay ? 1e3 : 0
@@ -84,14 +76,9 @@ const WaitMessage = (0, import_react.memo)(
       if (!isOpen) {
         setShow(false);
         (0, import_user_wait_event.waitEndEvent)();
-        if (logRocket) {
-          logRocket.track("wait-spinner-end", {
-            ...(0, import_web_analytics.getBAEventParameters)(),
-            ...(0, import_helpers.getProductAppDetails)()
-          });
-        }
+        (0, import_logrocket.lrTrack)("wait-spinner-end");
       }
-    }, [delay, isOpen, logRocket]);
+    }, [delay, isOpen]);
     (0, import_use_html_wait_message.useHTMLWaitMessage)(isOpen !== null);
     return show ? /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, { children: [
       /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_ds_backdrop.DSBackdrop, { zIndex: theme.zIndex.loader }),

package/dist/esm/package.json

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

package/dist/esm/utils/auth/index.js

@@ -6,13 +6,12 @@ import {
 } from "../../api/auth/index.js";
 import { getUser } from "../../api/users/index.js";
 import { loginEvent, logoutEvent } from "../../analytics/user-session-event.js";
+import { updateBAEventParameters } from "../micro-frontend/scripting-objects/web-analytics.js";
 import {
-  getBAEventParameters,
-  updateBAEventParameters
-} from "../micro-frontend/scripting-objects/web-analytics.js";
-import { getLogRocket } from "../micro-frontend/scripting-objects/logrocket.js";
+  lrIdentify,
+  lrTrack
+} from "../micro-frontend/scripting-objects/logrocket.js";
 import { getAuthorizationHeader, setAuthorizationHeader } from "./helper.js";
-import { getProductAppDetails } from "../helpers.js";
 import { getAppConfigValue } from "../app-config/config.js";
 import { logRecords } from "../log-records.js";
 import { setLoginParams } from "./loginParams.js";
@@ -66,14 +65,7 @@ const endSession = async ({
         token
       });
     logoutEvent();
-    const logRocket = getLogRocket();
-    if (logRocket) {
-      const eventData = {
-        ...getBAEventParameters(),
-        ...getProductAppDetails()
-      };
-      logRocket.track("logout", eventData);
-    }
+    lrTrack("logout");
     updateBAEventParameters({ instanceId: "", userId: "" });
     const idpHost = getAppConfigValue(IDP_ENDPOINT_CONFIG_KEY, "");
     const logoutUrl = new URL("/authorize", idpHost);
@@ -134,14 +126,12 @@ const authorize = async ({
     sessionStorage.setItem("userId", userName);
     loginEvent({ instanceId, userId: userName });
     updateBAEventParameters({ instanceId, userId: userName });
-    const logRocket = getLogRocket();
-    if (logRocket) {
-      const eventData = {
-        name: userName
-      };
-      logRocket.identify(userKey, eventData);
-      logRocket.track("login", eventData);
-    }
+    const eventData = {
+      name: userName,
+      instanceId
+    };
+    lrIdentify(userKey, eventData);
+    lrTrack("login", eventData);
     const data = await getUser({ userName, isConsumerUser });
     sessionStorage.setItem("userSettings", JSON.stringify(data));
     const pathName = new URL(redirectUri).pathname;

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

@@ -49,6 +49,10 @@ class CMicroAppGuest {
    * reference to SSFHost instance
    */
   #ssfHostRef;
+  /**
+   * true if the app prefers to use SSF V2 Guest from App SDK to communicate with host(optional, default: true)
+   */
+  #useV2Guest;
   /**
    * AppBridge instance
    */
@@ -78,6 +82,7 @@ class CMicroAppGuest {
     setLogRocket(this.#logRocket);
     if (params?.ssfHostRef) setSSFHost(params.ssfHostRef);
     this.#ssfHostRef = getSSFHost();
+    this.#useV2Guest = params?.useV2Guest !== false;
     this.onInit = params?.onInit;
     this.onMount = params?.onMount;
     this.onUnmount = params?.onUnmount;
@@ -220,7 +225,7 @@ class CMicroAppGuest {
     if (!isCrossDomain()) {
       host = window.parent?.emui?.MicroAppHost ?? null;
     }
-    if (!host) {
+    if (!host && this.#useV2Guest) {
       host = new SSFGuest({ appLogger: this.logger });
       if (await abortPromise({
         promise: host.connect(),

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

@@ -2,7 +2,7 @@ import { ScriptingObject } from "@elliemae/ssf-host";
 import { getBAEventParameters } from "./web-analytics.js";
 import { getProductAppDetails } from "../../helpers.js";
 import { HeadSampler } from "../../headSampler.js";
-import { getLogRocket } from "./logrocket.js";
+import { lrTrack } from "./logrocket.js";
 class Analytics extends ScriptingObject {
   /**
    * logger instance
@@ -99,10 +99,7 @@ class Analytics extends ScriptingObject {
     };
     window.gtmDataLayer = window.gtmDataLayer || [];
     window.gtmDataLayer.push({ ...eventEx, event });
-    const logRocket = getLogRocket();
-    if (logRocket) {
-      logRocket.track(event, eventEx);
-    }
+    lrTrack(event, eventEx);
     return Promise.resolve();
   };
   /**

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

@@ -1,9 +1,40 @@
+import { getProductAppDetails } from "../../helpers";
+import { getBAEventParameters } from "./web-analytics";
 let gLogRocket = null;
 const getLogRocket = () => gLogRocket;
 const setLogRocket = (logrocket) => {
   gLogRocket = logrocket || null;
 };
+const cleanupData = (data) => {
+  const cleanedData = {};
+  Object.entries(data).forEach(([key, value]) => {
+    cleanedData[key] = value === void 0 || value === null ? "" : value;
+  });
+  return cleanedData;
+};
+const getEventData = (eventEx) => {
+  const eventData = {
+    ...eventEx,
+    ...getBAEventParameters(),
+    ...getProductAppDetails()
+  };
+  return cleanupData(eventData);
+};
+const lrTrack = (event, eventEx = {}) => {
+  const logRocket = getLogRocket();
+  if (logRocket) {
+    logRocket.track(event, getEventData(eventEx));
+  }
+};
+const lrIdentify = (userId, eventEx) => {
+  const logRocket = getLogRocket();
+  if (logRocket) {
+    logRocket.identify(userId, cleanupData(eventEx));
+  }
+};
 export {
   getLogRocket,
+  lrIdentify,
+  lrTrack,
   setLogRocket
 };

package/dist/esm/view/fields/form-item-layout/index.js

@@ -1,10 +1,8 @@
 import { jsx } from "react/jsx-runtime";
 import { DSFormItemLayout } from "@elliemae/ds-form";
-import { get } from "react-hook-form";
-import { ConnectForm } from "../connect-form.js";
-const FormItemLayout = ({ name, ...rest }) => /* @__PURE__ */ jsx(ConnectForm, { children: ({
-  formState: { errors }
-}) => {
+import { useFormState, get } from "react-hook-form";
+const FormItemLayout = ({ name, ...rest }) => {
+  const { errors } = useFormState({ name });
   const errorField = get(errors, name);
   const hasError = !!errorField;
   const validationMessage = errorField?.message;
@@ -17,7 +15,7 @@ const FormItemLayout = ({ name, ...rest }) => /* @__PURE__ */ jsx(ConnectForm, {
       ...rest
     }
   );
-} });
+};
 export {
   FormItemLayout
 };

package/dist/esm/view/fields/form-layout-block-item/index.js

@@ -2,15 +2,13 @@ import { jsx } from "react/jsx-runtime";
 import {
   DSFormLayoutBlockItem
 } from "@elliemae/ds-form-layout-blocks";
-import { get } from "react-hook-form";
-import { ConnectForm } from "../connect-form.js";
+import { useFormState, get } from "react-hook-form";
 const FormLayoutBlockItem = ({
   inputID,
   label,
   ...rest
-}) => /* @__PURE__ */ jsx(ConnectForm, { children: ({
-  formState: { errors }
 }) => {
+  const { errors } = useFormState({ name: inputID });
   const errorField = get(errors, inputID);
   const hasError = !!errorField;
   const validationMessage = errorField?.message;
@@ -24,7 +22,7 @@ const FormLayoutBlockItem = ({
       ...rest
     }
   );
-} });
+};
 export {
   FormLayoutBlockItem
 };

package/dist/esm/view/page.js

@@ -1,19 +1,12 @@
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { Helmet } from "react-helmet";
 import { pageViewEvent } from "../analytics/page-view-event.js";
-import { getLogRocket } from "../utils/micro-frontend/scripting-objects/logrocket.js";
-import { getBAEventParameters } from "../utils/micro-frontend/scripting-objects/web-analytics.js";
-import { getProductAppDetails } from "../utils/helpers.js";
+import { lrTrack } from "../utils/micro-frontend/scripting-objects/logrocket.js";
 const onPageView = (pageTitle) => {
   pageViewEvent({ pageTitle });
-  const logRocket = getLogRocket();
-  if (logRocket) {
-    logRocket.track("pageView", {
-      pageTitle,
-      ...getBAEventParameters(),
-      ...getProductAppDetails()
-    });
-  }
+  lrTrack("page-view", {
+    pageTitle
+  });
 };
 const Page = ({ pageTitle = "ICE", children }) => {
   onPageView(pageTitle);

package/dist/esm/view/tests/__snapshots__/guest-microapp.test.tsx.snap

@@ -7,7 +7,7 @@ exports[`GuestMicroApp with SSFHost should accept ssfAppOptions 1`] = `
 
 <iframe
   id="ssfapp"
-  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin "
+  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin"
   src="http://localhost:3111/ssfapp/?testParam=testValue"
   style="min-width: 100%; height: 100%; border: 0px; border: 10px solid blue;"
   title="SSF App"
@@ -50,7 +50,7 @@ exports[`GuestMicroApp with SSFHost should prefer ssfAppOptions sent in params i
 
 <iframe
   id="ssfapp"
-  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin "
+  sandbox="allow-scripts allow-popups allow-modals allow-forms allow-downloads allow-same-origin"
   src="http://localhost:3111/ssfapp/?testParam=testValue"
   style="min-width: 100%; height: 100%; border: 0px; border: 2px solid red;"
   title="SSF App"

package/dist/esm/view/wait-message/index.js

@@ -9,9 +9,7 @@ import {
   waitStartEvent,
   waitEndEvent
 } from "../../analytics/user-wait-event.js";
-import { getLogRocket } from "../../utils/micro-frontend/scripting-objects/logrocket.js";
-import { getBAEventParameters } from "../../utils/micro-frontend/scripting-objects/web-analytics.js";
-import { getProductAppDetails } from "../../utils/helpers.js";
+import { lrTrack } from "../../utils/micro-frontend/scripting-objects/logrocket.js";
 const StyledCircularIndicator = styled(DSCircularIndeterminateIndicator)`
   position: absolute;
   left: 50%;
@@ -34,19 +32,13 @@ const WaitMessage = memo(
     const delay = useAppSelector((state) => state.waitMessage?.delay);
     ref.current = isOpen ?? false;
     const message = useAppSelector((state) => state.waitMessage?.message);
-    const logRocket = getLogRocket();
     useEffect(() => {
       setTimeout(
         () => {
           if (isOpen && ref.current) {
             setShow(true);
             waitStartEvent();
-            if (logRocket) {
-              logRocket.track("wait-spinner-start", {
-                ...getBAEventParameters(),
-                ...getProductAppDetails()
-              });
-            }
+            lrTrack("wait-spinner-start");
           }
         },
         delay ? 1e3 : 0
@@ -54,14 +46,9 @@ const WaitMessage = memo(
       if (!isOpen) {
         setShow(false);
         waitEndEvent();
-        if (logRocket) {
-          logRocket.track("wait-spinner-end", {
-            ...getBAEventParameters(),
-            ...getProductAppDetails()
-          });
-        }
+        lrTrack("wait-spinner-end");
       }
-    }, [delay, isOpen, logRocket]);
+    }, [delay, isOpen]);
     useHTMLWaitMessage(isOpen !== null);
     return show ? /* @__PURE__ */ jsxs(Fragment, { children: [
       /* @__PURE__ */ jsx(DSBackdrop, { zIndex: theme.zIndex.loader }),

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

@@ -26,6 +26,10 @@ interface ConstructorParams {
     onGetRef?: OnGetRefCallback;
     history?: History;
     ssfHostRef?: SSFHost<ScriptingObjectTypes, Events> | null;
+    /**
+     * true if the app prefers to use SSF V2 Guest from App SDK to communicate with host(optional, default: true)
+     */
+    useV2Guest?: boolean;
 }
 export declare class CMicroAppGuest<AppObjects extends ScriptingObjects = Partial<ScriptingObjectTypes>, AppEvents extends EventListeners = Events> implements IMicroAppGuest<AppObjects, AppEvents> {
     #private;

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

@@ -1,3 +1,15 @@
 import { LogRocket } from '@elliemae/pui-logrocket';
 export declare const getLogRocket: () => typeof LogRocket | null;
 export declare const setLogRocket: (logrocket?: typeof LogRocket) => void;
+/**
+ * Send custom events to LogRocket
+ * @param event event name
+ * @param eventEx event meta data
+ */
+export declare const lrTrack: (event: string, eventEx?: Record<string, any>) => void;
+/**
+ * Send user identification events to LogRocket
+ * @param userId user identifier
+ * @param eventEx event meta data
+ */
+export declare const lrIdentify: (userId: string, eventEx: Record<string, any>) => void;

package/dist/types/lib/view/fields/form-item-layout/index.d.ts

@@ -5,4 +5,4 @@ export type FormItemLayoutProps = {
     labelText?: string;
     [x: string]: any;
 };
-export declare const FormItemLayout: ({ name, ...rest }: FormItemLayoutProps) => import("react/jsx-runtime.js").JSX.Element;
+export declare const FormItemLayout: ({ name, ...rest }: FormItemLayoutProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/view/fields/form-layout-block-item/index.d.ts

@@ -1,3 +1,3 @@
 import { DSFormLayoutBlockItemT } from '@elliemae/ds-form-layout-blocks';
 export type FormLayoutBlockItemProps = DSFormLayoutBlockItemT.Props;
-export declare const FormLayoutBlockItem: ({ inputID, label, ...rest }: FormLayoutBlockItemProps) => import("react/jsx-runtime.js").JSX.Element;
+export declare const FormLayoutBlockItem: ({ inputID, label, ...rest }: FormLayoutBlockItemProps) => import("react/jsx-runtime").JSX.Element;