@envive-ai/react-hooks 0.3.11 → 0.3.13

package/src/services/ga4ProjectionService/ga4ProjectionService.ts

@@ -0,0 +1,137 @@
+import Logger from 'src/application/logging/logger';
+import { EnviveMetricsEventName } from '../amplitudeService/eventNames';
+import { GA4ProjectedEventConfig, GA4_EVENT_SCHEMA } from './ga4EventSchema';
+
+const filterToSchema = (
+  eventProps: Record<string, unknown>,
+  allowedFields: readonly string[],
+): Record<string, unknown> => {
+  const result: Record<string, unknown> = {};
+  for (const field of allowedFields) {
+    if (field in eventProps) {
+      result[field] = eventProps[field];
+    }
+  }
+  return result;
+};
+
+// "context.page_type" → "context_page_type"
+const flattenDotKeys = (obj: Record<string, unknown>): Record<string, unknown> => {
+  const result: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(obj)) {
+    result[key.replace(/\./g, '_')] = value;
+  }
+  return result;
+};
+
+// Omit context.page_id for non-pdp/plp page types. The current implementation for context.page_id is:
+// PDP: product_id
+// PLP: plp_id
+// Search: search query
+// Other: page url
+// We want to omit all but pdp and plp page types to provide a clear, consistent interface for merchants.
+const sanitizePageId = (filtered: Record<string, unknown>): Record<string, unknown> => {
+  const pageType = filtered['context.page_type'];
+  if (pageType === 'pdp' || pageType === 'plp') {
+    return filtered;
+  }
+  const rest = { ...filtered };
+  delete rest['context.page_id'];
+  return rest;
+};
+
+// Extract whitelisted sub-fields from trigger.widget_interaction_data
+const projectWidgetInteractionData = (
+  eventProps: Record<string, unknown>,
+  config: GA4ProjectedEventConfig,
+): Record<string, unknown> => {
+  if (!config.widgetInteractionDataProjections) {
+    return {};
+  }
+
+  const interaction = eventProps['trigger.widget_interaction'];
+  if (typeof interaction !== 'string') {
+    return {};
+  }
+
+  const projectionMap = config.widgetInteractionDataProjections[interaction];
+  if (!projectionMap) {
+    return {};
+  }
+
+  const interactionData = eventProps['trigger.widget_interaction_data'];
+  if (
+    interactionData === null ||
+    interactionData === undefined ||
+    typeof interactionData !== 'object'
+  ) {
+    return {};
+  }
+
+  const data = interactionData as Record<string, unknown>;
+  const result: Record<string, unknown> = {};
+  for (const [gaKey, sourceField] of Object.entries(projectionMap)) {
+    if (sourceField in data) {
+      result[gaKey] = data[sourceField];
+    }
+  }
+  return result;
+};
+
+const truncateString = (value: unknown): unknown => {
+  if (typeof value === 'string' && value.length > 100) {
+    return `${value.substring(0, 97)}...`;
+  }
+  return value;
+};
+
+const truncateValues = (obj: Record<string, unknown>): Record<string, unknown> => {
+  const result: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(obj)) {
+    result[key] = truncateString(value);
+  }
+  return result;
+};
+
+const pushToDataLayer = (gaEvent: Record<string, unknown>): void => {
+  if (typeof window !== 'undefined' && window.dataLayer) {
+    window.dataLayer.push(gaEvent);
+  }
+};
+
+export const projectToGA4 = (
+  eventName: EnviveMetricsEventName,
+  eventProps?: Record<string, unknown>,
+): void => {
+  try {
+    const schemaEntry = GA4_EVENT_SCHEMA[eventName];
+
+    if (schemaEntry.gaEventName === null) {
+      return;
+    }
+
+    const config = schemaEntry;
+    const props = eventProps ?? {};
+
+    let filtered = filterToSchema(props, config.allowedFields);
+    filtered = sanitizePageId(filtered);
+
+    const interactionFields = projectWidgetInteractionData(props, config);
+
+    const flatParams = {
+      ...flattenDotKeys(filtered),
+      ...interactionFields,
+    };
+
+    const truncatedParams = truncateValues(flatParams);
+
+    pushToDataLayer({
+      event: config.gaEventName,
+      ...truncatedParams,
+    });
+  } catch (err) {
+    Logger.logError('[envive-ai] Error projecting event to GA4', err, {
+      eventName,
+    });
+  }
+};

package/src/types/customerService.ts

@@ -11,6 +11,7 @@ export enum CustomerServiceType {
   gladly = 'gladly',
   richpanel = 'richpanel',
   zendesk = 'zendesk',
+  eightByEight = '8x8',
   unsupported = 'unsupported',
 }
 export enum CustomerServiceIntegrationMode {

package/src/types/enviveConfig.ts

@@ -1,4 +1,6 @@
 import { FrontendConfigOverrides, VariantInfo } from 'src/application/models';
+import type { HardcopyResponse } from 'src/contexts/hardcopyContext/hardcopyContext';
+import type { WidgetTypeV3 } from 'src/contexts/typesV3';
 
 export interface EnviveConfig {
   publicKey?: string;
@@ -15,6 +17,7 @@ export interface EnviveConfig {
   initialOpenSearchOverlay?: boolean;
   WidgetMountingOverride?: Record<string, any>[];
   configChanges?: FrontendConfigOverrides[];
+  hardcopyOverride?: Partial<Record<WidgetTypeV3, HardcopyResponse>>;
 }
 
 declare global {

package/dist/hooks/IdentifyUser/index.cjs

@@ -1,3 +0,0 @@
-const require_useIdentifyUser = require('./useIdentifyUser.cjs');
-
-exports.useIdentifyUser = require_useIdentifyUser.useIdentifyUser;

package/dist/hooks/IdentifyUser/index.d.cts

@@ -1,2 +0,0 @@
-import { useIdentifyUser } from "./useIdentifyUser.cjs";
-export { useIdentifyUser };

package/dist/hooks/IdentifyUser/index.d.ts

@@ -1,2 +0,0 @@
-import { useIdentifyUser } from "./useIdentifyUser.js";
-export { useIdentifyUser };

package/dist/hooks/IdentifyUser/index.js

@@ -1,3 +0,0 @@
-import { useIdentifyUser } from "./useIdentifyUser.js";
-
-export { useIdentifyUser };

package/dist/hooks/IdentifyUser/useIdentifyUser.cjs

@@ -1,35 +0,0 @@
-const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
-const require_userIdentityContext = require('../../contexts/userIdentityContext/userIdentityContext.cjs');
-let react = require("react");
-
-//#region src/hooks/IdentifyUser/useIdentifyUser.ts
-const useIdentifyUser = () => {
-	const { identifyUser, isReady } = require_userIdentityContext.useUserIdentity();
-	const [loading, setLoading] = (0, react.useState)(false);
-	const [error, setError] = (0, react.useState)(null);
-	return {
-		loading,
-		error,
-		executeIdentifyUser: (0, react.useCallback)(async () => {
-			if (!isReady) {
-				setError(/* @__PURE__ */ new Error("UserIdentityContext not ready."));
-				return;
-			}
-			setLoading(true);
-			setError(null);
-			try {
-				await identifyUser();
-			} catch (err) {
-				setError(err instanceof Error ? err : /* @__PURE__ */ new Error("Unknown error during user identification."));
-				throw err;
-			} finally {
-				setLoading(false);
-			}
-		}, [identifyUser, isReady]),
-		isReady
-	};
-};
-
-//#endregion
-exports.useIdentifyUser = useIdentifyUser;
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlSWRlbnRpZnlVc2VyLmNqcyIsIm5hbWVzIjpbInVzZVVzZXJJZGVudGl0eSJdLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ob29rcy9JZGVudGlmeVVzZXIvdXNlSWRlbnRpZnlVc2VyLnRzIl0sInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IHVzZUNhbGxiYWNrLCB1c2VTdGF0ZSB9IGZyb20gJ3JlYWN0JztcbmltcG9ydCB7IHVzZVVzZXJJZGVudGl0eSB9IGZyb20gJ3NyYy9jb250ZXh0cy91c2VySWRlbnRpdHlDb250ZXh0L3VzZXJJZGVudGl0eUNvbnRleHQnO1xuXG5leHBvcnQgY29uc3QgdXNlSWRlbnRpZnlVc2VyID0gKCkgPT4ge1xuICBjb25zdCB7IGlkZW50aWZ5VXNlciwgaXNSZWFkeSB9ID0gdXNlVXNlcklkZW50aXR5KCk7XG4gIGNvbnN0IFtsb2FkaW5nLCBzZXRMb2FkaW5nXSA9IHVzZVN0YXRlKGZhbHNlKTtcbiAgY29uc3QgW2Vycm9yLCBzZXRFcnJvcl0gPSB1c2VTdGF0ZTxFcnJvciB8IG51bGw+KG51bGwpO1xuXG4gIGNvbnN0IGV4ZWN1dGVJZGVudGlmeVVzZXIgPSB1c2VDYWxsYmFjayhhc3luYyAoKSA9PiB7XG4gICAgaWYgKCFpc1JlYWR5KSB7XG4gICAgICBzZXRFcnJvcihuZXcgRXJyb3IoJ1VzZXJJZGVudGl0eUNvbnRleHQgbm90IHJlYWR5LicpKTtcbiAgICAgIHJldHVybjtcbiAgICB9XG5cbiAgICBzZXRMb2FkaW5nKHRydWUpO1xuICAgIHNldEVycm9yKG51bGwpO1xuXG4gICAgdHJ5IHtcbiAgICAgIGF3YWl0IGlkZW50aWZ5VXNlcigpO1xuICAgIH0gY2F0Y2ggKGVycikge1xuICAgICAgc2V0RXJyb3IoZXJyIGluc3RhbmNlb2YgRXJyb3IgPyBlcnIgOiBuZXcgRXJyb3IoJ1Vua25vd24gZXJyb3IgZHVyaW5nIHVzZXIgaWRlbnRpZmljYXRpb24uJykpO1xuICAgICAgdGhyb3cgZXJyO1xuICAgIH0gZmluYWxseSB7XG4gICAgICBzZXRMb2FkaW5nKGZhbHNlKTtcbiAgICB9XG4gIH0sIFtpZGVudGlmeVVzZXIsIGlzUmVhZHldKTtcblxuICByZXR1cm4geyBsb2FkaW5nLCBlcnJvciwgZXhlY3V0ZUlkZW50aWZ5VXNlciwgaXNSZWFkeSB9O1xufTtcbiJdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFHQSxNQUFhLHdCQUF3QjtDQUNuQyxNQUFNLEVBQUUsY0FBYyxZQUFZQSw2Q0FBaUI7Q0FDbkQsTUFBTSxDQUFDLFNBQVMsa0NBQXVCLE1BQU07Q0FDN0MsTUFBTSxDQUFDLE9BQU8sZ0NBQW1DLEtBQUs7QUFxQnRELFFBQU87RUFBRTtFQUFTO0VBQU8sNENBbkJlLFlBQVk7QUFDbEQsT0FBSSxDQUFDLFNBQVM7QUFDWiw2QkFBUyxJQUFJLE1BQU0saUNBQWlDLENBQUM7QUFDckQ7O0FBR0YsY0FBVyxLQUFLO0FBQ2hCLFlBQVMsS0FBSztBQUVkLE9BQUk7QUFDRixVQUFNLGNBQWM7WUFDYixLQUFLO0FBQ1osYUFBUyxlQUFlLFFBQVEsc0JBQU0sSUFBSSxNQUFNLDRDQUE0QyxDQUFDO0FBQzdGLFVBQU07YUFDRTtBQUNSLGVBQVcsTUFBTTs7S0FFbEIsQ0FBQyxjQUFjLFFBQVEsQ0FBQztFQUVtQjtFQUFTIn0=

package/dist/hooks/IdentifyUser/useIdentifyUser.d.cts

@@ -1,10 +0,0 @@
-//#region src/hooks/IdentifyUser/useIdentifyUser.d.ts
-declare const useIdentifyUser: () => {
-  loading: boolean;
-  error: Error | null;
-  executeIdentifyUser: () => Promise<void>;
-  isReady: boolean;
-};
-//#endregion
-export { useIdentifyUser };
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlSWRlbnRpZnlVc2VyLmQuY3RzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ob29rcy9JZGVudGlmeVVzZXIvdXNlSWRlbnRpZnlVc2VyLmQudHMiXSwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGRlY2xhcmUgY29uc3QgdXNlSWRlbnRpZnlVc2VyOiAoKSA9PiB7XG4gICAgbG9hZGluZzogYm9vbGVhbjtcbiAgICBlcnJvcjogRXJyb3IgfCBudWxsO1xuICAgIGV4ZWN1dGVJZGVudGlmeVVzZXI6ICgpID0+IFByb21pc2U8dm9pZD47XG4gICAgaXNSZWFkeTogYm9vbGVhbjtcbn07XG4iXSwibWFwcGluZ3MiOiI7QUFBQSxJQUFXLGtCQUFrQjtDQUFDO09BQVc7T0FBRztDQUFBIn0=

package/dist/hooks/IdentifyUser/useIdentifyUser.d.ts

@@ -1,10 +0,0 @@
-//#region src/hooks/IdentifyUser/useIdentifyUser.d.ts
-declare const useIdentifyUser: () => {
-  loading: boolean;
-  error: Error | null;
-  executeIdentifyUser: () => Promise<void>;
-  isReady: boolean;
-};
-//#endregion
-export { useIdentifyUser };
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlSWRlbnRpZnlVc2VyLmQudHMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2hvb2tzL0lkZW50aWZ5VXNlci91c2VJZGVudGlmeVVzZXIuZC50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgZGVjbGFyZSBjb25zdCB1c2VJZGVudGlmeVVzZXI6ICgpID0+IHtcbiAgICBsb2FkaW5nOiBib29sZWFuO1xuICAgIGVycm9yOiBFcnJvciB8IG51bGw7XG4gICAgZXhlY3V0ZUlkZW50aWZ5VXNlcjogKCkgPT4gUHJvbWlzZTx2b2lkPjtcbiAgICBpc1JlYWR5OiBib29sZWFuO1xufTtcbiJdLCJtYXBwaW5ncyI6IjtBQUFBLElBQVcsa0JBQWtCO0NBQUM7T0FBVztPQUFHO0NBQUEifQ==

package/dist/hooks/IdentifyUser/useIdentifyUser.js

@@ -1,34 +0,0 @@
-import { useUserIdentity } from "../../contexts/userIdentityContext/userIdentityContext.js";
-import { useCallback, useState } from "react";
-
-//#region src/hooks/IdentifyUser/useIdentifyUser.ts
-const useIdentifyUser = () => {
-	const { identifyUser, isReady } = useUserIdentity();
-	const [loading, setLoading] = useState(false);
-	const [error, setError] = useState(null);
-	return {
-		loading,
-		error,
-		executeIdentifyUser: useCallback(async () => {
-			if (!isReady) {
-				setError(/* @__PURE__ */ new Error("UserIdentityContext not ready."));
-				return;
-			}
-			setLoading(true);
-			setError(null);
-			try {
-				await identifyUser();
-			} catch (err) {
-				setError(err instanceof Error ? err : /* @__PURE__ */ new Error("Unknown error during user identification."));
-				throw err;
-			} finally {
-				setLoading(false);
-			}
-		}, [identifyUser, isReady]),
-		isReady
-	};
-};
-
-//#endregion
-export { useIdentifyUser };
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlSWRlbnRpZnlVc2VyLmpzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ob29rcy9JZGVudGlmeVVzZXIvdXNlSWRlbnRpZnlVc2VyLnRzIl0sInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IHVzZUNhbGxiYWNrLCB1c2VTdGF0ZSB9IGZyb20gJ3JlYWN0JztcbmltcG9ydCB7IHVzZVVzZXJJZGVudGl0eSB9IGZyb20gJ3NyYy9jb250ZXh0cy91c2VySWRlbnRpdHlDb250ZXh0L3VzZXJJZGVudGl0eUNvbnRleHQnO1xuXG5leHBvcnQgY29uc3QgdXNlSWRlbnRpZnlVc2VyID0gKCkgPT4ge1xuICBjb25zdCB7IGlkZW50aWZ5VXNlciwgaXNSZWFkeSB9ID0gdXNlVXNlcklkZW50aXR5KCk7XG4gIGNvbnN0IFtsb2FkaW5nLCBzZXRMb2FkaW5nXSA9IHVzZVN0YXRlKGZhbHNlKTtcbiAgY29uc3QgW2Vycm9yLCBzZXRFcnJvcl0gPSB1c2VTdGF0ZTxFcnJvciB8IG51bGw+KG51bGwpO1xuXG4gIGNvbnN0IGV4ZWN1dGVJZGVudGlmeVVzZXIgPSB1c2VDYWxsYmFjayhhc3luYyAoKSA9PiB7XG4gICAgaWYgKCFpc1JlYWR5KSB7XG4gICAgICBzZXRFcnJvcihuZXcgRXJyb3IoJ1VzZXJJZGVudGl0eUNvbnRleHQgbm90IHJlYWR5LicpKTtcbiAgICAgIHJldHVybjtcbiAgICB9XG5cbiAgICBzZXRMb2FkaW5nKHRydWUpO1xuICAgIHNldEVycm9yKG51bGwpO1xuXG4gICAgdHJ5IHtcbiAgICAgIGF3YWl0IGlkZW50aWZ5VXNlcigpO1xuICAgIH0gY2F0Y2ggKGVycikge1xuICAgICAgc2V0RXJyb3IoZXJyIGluc3RhbmNlb2YgRXJyb3IgPyBlcnIgOiBuZXcgRXJyb3IoJ1Vua25vd24gZXJyb3IgZHVyaW5nIHVzZXIgaWRlbnRpZmljYXRpb24uJykpO1xuICAgICAgdGhyb3cgZXJyO1xuICAgIH0gZmluYWxseSB7XG4gICAgICBzZXRMb2FkaW5nKGZhbHNlKTtcbiAgICB9XG4gIH0sIFtpZGVudGlmeVVzZXIsIGlzUmVhZHldKTtcblxuICByZXR1cm4geyBsb2FkaW5nLCBlcnJvciwgZXhlY3V0ZUlkZW50aWZ5VXNlciwgaXNSZWFkeSB9O1xufTtcbiJdLCJtYXBwaW5ncyI6Ijs7OztBQUdBLE1BQWEsd0JBQXdCO0NBQ25DLE1BQU0sRUFBRSxjQUFjLFlBQVksaUJBQWlCO0NBQ25ELE1BQU0sQ0FBQyxTQUFTLGNBQWMsU0FBUyxNQUFNO0NBQzdDLE1BQU0sQ0FBQyxPQUFPLFlBQVksU0FBdUIsS0FBSztBQXFCdEQsUUFBTztFQUFFO0VBQVM7RUFBTyxxQkFuQkcsWUFBWSxZQUFZO0FBQ2xELE9BQUksQ0FBQyxTQUFTO0FBQ1osNkJBQVMsSUFBSSxNQUFNLGlDQUFpQyxDQUFDO0FBQ3JEOztBQUdGLGNBQVcsS0FBSztBQUNoQixZQUFTLEtBQUs7QUFFZCxPQUFJO0FBQ0YsVUFBTSxjQUFjO1lBQ2IsS0FBSztBQUNaLGFBQVMsZUFBZSxRQUFRLHNCQUFNLElBQUksTUFBTSw0Q0FBNEMsQ0FBQztBQUM3RixVQUFNO2FBQ0U7QUFDUixlQUFXLE1BQU07O0tBRWxCLENBQUMsY0FBYyxRQUFRLENBQUM7RUFFbUI7RUFBUyJ9

package/src/hooks/IdentifyUser/index.ts

@@ -1 +0,0 @@
-export * from './useIdentifyUser';

package/src/hooks/IdentifyUser/useIdentifyUser.ts

@@ -1,29 +0,0 @@
-import { useCallback, useState } from 'react';
-import { useUserIdentity } from 'src/contexts/userIdentityContext/userIdentityContext';
-
-export const useIdentifyUser = () => {
-  const { identifyUser, isReady } = useUserIdentity();
-  const [loading, setLoading] = useState(false);
-  const [error, setError] = useState<Error | null>(null);
-
-  const executeIdentifyUser = useCallback(async () => {
-    if (!isReady) {
-      setError(new Error('UserIdentityContext not ready.'));
-      return;
-    }
-
-    setLoading(true);
-    setError(null);
-
-    try {
-      await identifyUser();
-    } catch (err) {
-      setError(err instanceof Error ? err : new Error('Unknown error during user identification.'));
-      throw err;
-    } finally {
-      setLoading(false);
-    }
-  }, [identifyUser, isReady]);
-
-  return { loading, error, executeIdentifyUser, isReady };
-};