@reservamos/browser-analytics 1.0.0 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservamos/browser-analytics",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/reservamos/reservamos-browser-analytics.git"

package/src/profiles/createAnonymousProfile/createAnonymousProfile.ts

@@ -10,7 +10,8 @@ type IdentifierKey = 'phone' | 'email';
 interface AnonymousProfilePayload {
   identifier_key: IdentifierKey;
   identifier_value: string;
-  identifiers: AnonymousIdentifier[] 
+  identifiers: AnonymousIdentifier[];
+  details: Record<string, string>;
 }
 interface AnonymousProfileResponse {
   id: string;
@@ -23,11 +24,11 @@ interface AnonymousProfileResponse {
  */
 function getAnonymousProfilePayload(
   values: CreateAnonymousProfileProps,
-  identifiersProps: AnonymousIdentifier[] 
+  identifiersProps: AnonymousIdentifier[],
 ): AnonymousProfilePayload {
   let identifier_key: IdentifierKey = 'phone';
   let identifier_value: string = values.phone || '';
-  const identifiers: AnonymousIdentifier[] = []
+  const identifiers: AnonymousIdentifier[] = [];
 
   if (values.email) {
     identifier_key = 'email';
@@ -35,7 +36,14 @@ function getAnonymousProfilePayload(
   }
 
   // List of allowed keys for details
-  const allowedKeys = ['cpf', 'passport', 'rg', 'email', 'phone'];
+  const allowedKeys = [
+    'cpf',
+    'passport',
+    'rg',
+    'email',
+    'phone',
+    'salesforceid',
+  ];
 
   Object.entries(values).forEach(([key, value]) => {
     if (allowedKeys.includes(key.toLowerCase()) && value) {
@@ -45,13 +53,14 @@ function getAnonymousProfilePayload(
     }
   });
 
-  if(identifiersProps.length){
-     identifiersProps.forEach((item)=> identifiers.push(item))
+  if (identifiersProps.length) {
+    identifiersProps.forEach((item) => identifiers.push(item));
   }
 
   return {
     identifier_key,
     identifier_value,
+    details: {},
     identifiers,
   };
 }
@@ -68,7 +77,7 @@ interface AnonymousIdentifier {
  */
 async function createAnonymousProfile(
   payload: CreateAnonymousProfileProps,
-): Promise<AnonymousProfileResponse | undefined > {
+): Promise<AnonymousProfileResponse | undefined> {
   try {
     validatorService.validateProps(payload, CreateAnonymousProfileSchema);
 
@@ -80,13 +89,13 @@ async function createAnonymousProfile(
       identifiers.push({ key: 'fingerprint', value: userFingerprintId });
     if (distinctId) identifiers.push({ key: 'distinct_id', value: distinctId });
 
-    const dataPayload = getAnonymousProfilePayload(payload,identifiers);
-    
+    const dataPayload = getAnonymousProfilePayload(payload, identifiers);
+
     const result = await coreApi.createAnonymousProfile(dataPayload);
-    return result.data
+    return result.data;
   } catch (error) {
     console.error('Could not create anonymous profile:', error);
-    return undefined
+    return undefined;
   }
 }
 

package/src/track.ts

@@ -12,6 +12,13 @@ import validator from '@/services/validator';
  */
 const FP_TRIGGER_EVENTS = ['Search', 'View Results'];
 
+const EXTRA_UTM_FIELDS = {
+  utm_brand: 'UTM Brand',
+  utm_kxconfig: 'UTM KXConfig',
+  gad_source: 'GAD Source',
+  gclid: 'GCLID',
+};
+
 /**
  * Simplifies the structure of event data by flattening nested objects and arrays.
  * @param {object} data - The event data to simplify.
@@ -81,11 +88,13 @@ export async function trackEvent(
     const defaultProperties = {
       'User Fingerprint': fingerprint,
     };
+    const trackingParams = extractTrackingParams();
 
     const simplifiedData = flattenEventData(eventProperties);
     const properties = {
       ...defaultProperties,
       ...simplifiedData,
+      ...trackingParams,
       ...meta,
     };
 
@@ -94,3 +103,26 @@ export async function trackEvent(
     console.error(`Error tracking event '${eventName}':`, error);
   }
 }
+
+/**
+ * Extracts UTM and other tracking parameters from the current URL that match predefined fields.
+ * @returns {Record<string, string>} An object containing matched tracking parameters.
+ */
+function extractTrackingParams(): Record<string, string> {
+  try {
+    const urlParams = new URLSearchParams(window.location.search);
+    const trackingData: Record<string, string> = {};
+
+    Object.entries(EXTRA_UTM_FIELDS).forEach(([queryParam, displayName]) => {
+      const value = urlParams.get(queryParam);
+      if (value) {
+        trackingData[displayName] = value;
+      }
+    });
+
+    return trackingData;
+  } catch (error) {
+    console.error('Error extracting tracking parameters:', error);
+    return {};
+  }
+}