@envive-ai/react-hooks 0.3.22 → 0.3.24

package/src/services/ga4ProjectionService/ga4EventSchema.ts

@@ -34,6 +34,11 @@ export type WidgetInteractionDataProjection = Record<string, Record<string, stri
 export interface GA4ProjectedEventConfig {
   gaEventName: string;
   allowedFields: readonly string[];
+  /**
+   * When present, used instead of `allowedFields` to both filter and rename fields.
+   * Key: the desired GA4 parameter name. Value: the source dot-notation key in eventProps.
+   */
+  fieldProjections?: Record<string, string>;
   widgetInteractionDataProjections?: WidgetInteractionDataProjection;
 }
 
@@ -44,34 +49,36 @@ export interface GA4ExcludedEventConfig {
 export type GA4EventSchemaEntry = GA4ProjectedEventConfig | GA4ExcludedEventConfig;
 
 const WIDGET_INTERACTION_DATA_PROJECTIONS: WidgetInteractionDataProjection = {
-  widget_collapsed: { trigger_collapse_source: 'collapse_source' },
-  product_card_clicked: { trigger_product_id: 'product_id' },
-  suggestion_scrolled: { trigger_suggestion_id: 'suggestion_id' },
+  widget_collapsed: { interaction_collapse_source: 'widget_collapsed.collapse_source' },
+  product_card_clicked: { interaction_product_id: 'product_card_clicked.product_id' },
+  suggestion_scrolled: { interaction_suggestion_id: 'suggestion_scrolled.suggestion_id' },
 };
 
 export const GA4_EVENT_SCHEMA: Record<EnviveMetricsEventName, GA4EventSchemaEntry> = {
   [EnviveMetricsEventName.WidgetRendered]: {
     gaEventName: 'envive_widget_rendered',
-    allowedFields: [
-      'context.page_type',
-      'context.page_id',
-      'trigger.widget',
-      'trigger.widget_role',
-      'context.surface',
-    ],
+    allowedFields: [],
+    fieldProjections: {
+      page_type: 'context.page_type',
+      page_id: 'context.page_id',
+      surface: 'context.surface',
+      widget: 'trigger.widget',
+      widget_role: 'trigger.widget_role',
+    },
   },
 
-  // This event is not currently implemented
   [EnviveMetricsEventName.WidgetInteraction]: {
     gaEventName: 'envive_widget_interaction',
-    allowedFields: [
-      'context.page_type',
-      'context.page_id',
-      'trigger.widget',
-      'trigger.widget_interaction',
-      'trigger.entity_role',
-      'context.surface',
-    ],
+    allowedFields: [],
+    fieldProjections: {
+      page_type: 'context.page_type',
+      page_id: 'context.page_id',
+      surface: 'context.surface',
+      widget: 'trigger.widget',
+      interaction_type: 'trigger.widget_interaction',
+      interaction_class: 'trigger.interaction_class',
+      widget_role: 'trigger.widget_role',
+    },
     widgetInteractionDataProjections: WIDGET_INTERACTION_DATA_PROJECTIONS,
   },
 
@@ -120,14 +127,15 @@ export const GA4_EVENT_SCHEMA: Record<EnviveMetricsEventName, GA4EventSchemaEntr
   // This event is not currently implemented
   [EnviveMetricsEventName.PageViewed]: {
     gaEventName: 'envive_page_context_evaluated',
-    allowedFields: [
-      'context.page_type',
-      'context.page_id',
-      'context.supported',
-      'context.ready',
-      'context.page_variant_id',
-      'environment.envive_enabled',
-    ],
+    allowedFields: [],
+    fieldProjections: {
+      page_type: 'context.page_type',
+      page_id: 'context.page_id',
+      context_supported: 'context.supported',
+      context_ready: 'context.ready',
+      context_page_variant_id: 'context.page_variant_id',
+      environment_envive_enabled: 'environment.envive_enabled',
+    },
   },
 
   [EnviveMetricsEventName.WidgetTextRequest]: {

package/src/services/ga4ProjectionService/ga4ProjectionService.ts

@@ -17,6 +17,42 @@ const filterToSchema = (
   return result;
 };
 
+// Flatten only true top-level nested objects (keys with no dots) one level deep.
+// Keys that already contain dots are left intact so that e.g.
+// `trigger.widget_interaction_data: { ... }` is preserved for downstream extraction.
+const flattenOneLevel = (obj: Record<string, unknown>): Record<string, unknown> => {
+  const result: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (
+      !key.includes('.') &&
+      value !== null &&
+      typeof value === 'object' &&
+      !Array.isArray(value)
+    ) {
+      for (const [subKey, subValue] of Object.entries(value as Record<string, unknown>)) {
+        result[`${key}.${subKey}`] = subValue;
+      }
+    } else {
+      result[key] = value;
+    }
+  }
+  return result;
+};
+
+// Apply a GA4 projection map { ga4Key: sourceKey } to extract and rename fields.
+const filterWithProjections = (
+  eventProps: Record<string, unknown>,
+  projections: Record<string, string>,
+): Record<string, unknown> => {
+  const result: Record<string, unknown> = {};
+  for (const [ga4Key, sourceKey] of Object.entries(projections)) {
+    if (sourceKey in eventProps) {
+      result[ga4Key] = eventProps[sourceKey];
+    }
+  }
+  return result;
+};
+
 // "context.page_type" → "context_page_type"
 const flattenDotKeys = (obj: Record<string, unknown>): Record<string, unknown> => {
   const result: Record<string, unknown> = {};
@@ -32,16 +68,28 @@ const flattenDotKeys = (obj: Record<string, unknown>): Record<string, unknown> =
 // 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.
+// Handles both dot-notation keys (allowedFields path) and renamed GA4 keys (fieldProjections path).
 const sanitizePageId = (filtered: Record<string, unknown>): Record<string, unknown> => {
-  const pageType = filtered['context.page_type'];
+  const pageType = filtered['page_type'] ?? filtered['context.page_type'];
   if (pageType === 'pdp' || pageType === 'plp') {
     return filtered;
   }
   const rest = { ...filtered };
+  delete rest['page_id'];
   delete rest['context.page_id'];
   return rest;
 };
 
+const getNestedValue = (obj: Record<string, unknown>, path: string): unknown => {
+  const parts = path.split('.');
+  let current: unknown = obj;
+  for (const part of parts) {
+    if (current === null || typeof current !== 'object') return undefined;
+    current = (current as Record<string, unknown>)[part];
+  }
+  return current;
+};
+
 // Extract whitelisted sub-fields from trigger.widget_interaction_data
 const projectWidgetInteractionData = (
   eventProps: Record<string, unknown>,
@@ -72,9 +120,10 @@ const projectWidgetInteractionData = (
 
   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];
+  for (const [gaKey, sourcePath] of Object.entries(projectionMap)) {
+    const value = getNestedValue(data, sourcePath);
+    if (value !== undefined) {
+      result[gaKey] = value;
     }
   }
   return result;
@@ -113,9 +162,14 @@ export const projectToGA4 = (
     }
 
     const config = schemaEntry;
-    const props = eventProps ?? {};
+    const props = flattenOneLevel(eventProps ?? {});
 
-    let filtered = filterToSchema(props, config.allowedFields);
+    let filtered: Record<string, unknown>;
+    if (config.fieldProjections) {
+      filtered = filterWithProjections(props, config.fieldProjections);
+    } else {
+      filtered = filterToSchema(props, config.allowedFields);
+    }
     filtered = sanitizePageId(filtered);
 
     const interactionFields = projectWidgetInteractionData(props, config);