@segment/analytics-browser-actions-facebook-conversions-api-web 1.9.0 → 1.9.1-staging-c01044061.0

package/src/functions.ts

@@ -1,64 +1,52 @@
-import { WindowWithOptionalFbq, InitOptions, LDU, UserData, FBClient} from './types'
+import { WindowWithOptionalFbq, InitOptions, LDU, UserData, FBClient } from './types'
 import type { Settings } from './generated-types'
-import { USER_DATA_KEY, INIT_COUNT_KEY} from './constants'
+import { USER_DATA_KEY, INIT_COUNT_KEY } from './constants'
 import { UniversalStorage, Analytics } from '@segment/analytics-next'
 
 export function initScript(settings: Settings, analytics: Analytics) {
-  const { 
-    pixelId, 
-    disablePushState, 
-    disableAutoConfig, 
-    disableFirstPartyCookies,
-    agent,
-    ldu 
-  } = settings as Settings & { ldu: keyof typeof LDU }
-
-  (function(
-    f: WindowWithOptionalFbq, 
-    b: Document, 
-    e: 'script', 
-    v: string, 
-    n: FBClient | undefined = undefined, 
-    t: HTMLScriptElement | undefined = undefined, 
+  const { pixelId, disablePushState, disableAutoConfig, disableFirstPartyCookies, agent, ldu } =
+    settings as Settings & { ldu: keyof typeof LDU }
+
+  ;(function (
+    f: WindowWithOptionalFbq,
+    b: Document,
+    e: 'script',
+    v: string,
+    n: FBClient | undefined = undefined,
+    t: HTMLScriptElement | undefined = undefined,
     s: Element | null = null
-  ){
-    if (f.fbq) return;
-    n = f.fbq = function() {
+  ) {
+    if (f.fbq) return
+    n = f.fbq = function () {
       /* eslint-disable */
       // @ts-expect-error - n is defined by the time this executes
-      n.callMethod ? n.callMethod.apply(n, arguments) : n.queue.push(arguments);
+      n.callMethod ? n.callMethod.apply(n, arguments) : n.queue.push(arguments)
       /* eslint-enable */
-    };
-    if (!f._fbq) f._fbq = n;
-    n.push = n;
-    n.loaded = true;
-    n.version = '2.0';
-    n.queue = [];
-    t = b.createElement(e);
-    t.async = true;
-    t.src = v;
-    s = b.getElementsByTagName(e)[0];
+    }
+    if (!f._fbq) f._fbq = n
+    n.push = n
+    n.loaded = true
+    n.version = '2.0'
+    n.queue = []
+    t = b.createElement(e)
+    t.async = true
+    t.src = v
+    s = b.getElementsByTagName(e)[0]
     if (s && s.parentNode) {
-      s.parentNode.insertBefore(t, s);
+      s.parentNode.insertBefore(t, s)
     }
-  })(
-    window, 
-    document, 
-    'script', 
-    'https://connect.facebook.net/en_US/fbevents.js'
-  );
-
-  if(ldu === LDU.Disabled.key) {
+  })(window, document, 'script', 'https://connect.facebook.net/en_US/fbevents.js')
+
+  if (ldu === LDU.Disabled.key) {
     window.fbq('dataProcessingOptions', [])
-  }
-  else {
+  } else {
     const lduObj = getLDU(ldu)
     window.fbq('dataProcessingOptions', ['LDU'], lduObj.country, lduObj.state)
   }
 
-  if(disablePushState) {
+  if (disablePushState) {
     window.fbq.disablePushState = true
-  } 
+  }
 
   if (disableAutoConfig) {
     window.fbq('set', 'autoConfig', false, pixelId)
@@ -69,13 +57,13 @@ export function initScript(settings: Settings, analytics: Analytics) {
   }
 
   const userData = getStoredUserData(analytics)
-  const options: InitOptions | undefined = ( agent ? { agent } : undefined)
+  const options: InitOptions | undefined = agent ? { agent } : undefined
   const initArgs: [string, UserData?, InitOptions?] = [pixelId]
 
   if (userData && Object.keys(userData).length > 0) {
-    initArgs.push(userData);
+    initArgs.push(userData)
     if (options) {
-      initArgs.push(options);
+      initArgs.push(options)
     }
   } else if (options) {
     initArgs.push(undefined, options)
@@ -86,7 +74,7 @@ export function initScript(settings: Settings, analytics: Analytics) {
   setStorageInitCount(analytics, 1)
   deleteStorageUserData(analytics)
 
-  if(!disablePushState) {
+  if (!disablePushState) {
     window.fbq('trackSingle', pixelId, 'PageView')
   }
 }
@@ -118,24 +106,29 @@ export function deleteStorageUserData(analytics: Analytics) {
   storage.set(USER_DATA_KEY, '')
 }
 
-function getStoredUserData(analytics: Analytics): UserData | undefined { 
-    const storage = (analytics.storage as UniversalStorage<Record<string, string>>) ?? storageFallback
-    const userDataFromStorage: string | null = storage.get(USER_DATA_KEY)
-    if(userDataFromStorage) {
-        try {
-            const parsed = JSON.parse(userDataFromStorage)
-            if(!parsed || typeof parsed !== 'object' || Array.isArray(parsed) || Object.keys(parsed as object).length === 0) {
-                return undefined
-            }
-            return parsed as UserData
-        } catch {
-            return undefined
-        }
+function getStoredUserData(analytics: Analytics): UserData | undefined {
+  const storage = (analytics.storage as UniversalStorage<Record<string, string>>) ?? storageFallback
+  const userDataFromStorage: string | null = storage.get(USER_DATA_KEY)
+  if (userDataFromStorage) {
+    try {
+      const parsed = JSON.parse(userDataFromStorage)
+      if (
+        !parsed ||
+        typeof parsed !== 'object' ||
+        Array.isArray(parsed) ||
+        Object.keys(parsed as object).length === 0
+      ) {
+        return undefined
+      }
+      return parsed as UserData
+    } catch {
+      return undefined
     }
-    return undefined
+  }
+  return undefined
 }
 
 function getLDU(ldu: keyof typeof LDU) {
-    const lduObj = LDU[ldu]
-    return { country: lduObj.country, state: lduObj.state }
-}
+  const lduObj = LDU[ldu]
+  return { country: lduObj.country, state: lduObj.state }
+}

package/src/index.ts

@@ -8,7 +8,7 @@ import { defaultValues } from '@segment/actions-core'
 
 declare global {
   interface Window {
-    fbq: FBClient,
+    fbq: FBClient
     _fbq: FBClient
   }
 }
@@ -23,22 +23,25 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       description: 'The Pixel ID associated with your Facebook Pixel.',
       label: 'Pixel ID',
       type: 'string',
-      required: true  
+      required: true
     },
     disablePushState: {
-      description: "If set to true, prevents Facebook Pixel from sending PageView events on history state changes. Set to true if you want to trigger PageView events manually via the pageView Action.",
+      description:
+        'If set to true, prevents Facebook Pixel from sending PageView events on history state changes. Set to true if you want to trigger PageView events manually via the pageView Action.',
       label: 'Disable Push State',
       type: 'boolean',
       default: false
     },
     disableAutoConfig: {
-      description: "Control whether Facebook’s Meta Pixel automatically collects additional page and button data to optimize ads and measurement. When this toggle is on, Auto Config is disabled and only basic pixel tracking will occur. Turning it off enables Auto Config, allowing the Pixel to automatically send page metadata and button interactions to improve ad delivery and reporting.",
+      description:
+        'Control whether Facebook’s Meta Pixel automatically collects additional page and button data to optimize ads and measurement. When this toggle is on, Auto Config is disabled and only basic pixel tracking will occur. Turning it off enables Auto Config, allowing the Pixel to automatically send page metadata and button interactions to improve ad delivery and reporting.',
       label: 'Disable Auto Config',
       type: 'boolean',
       default: true
     },
     disableFirstPartyCookies: {
-      description: "Control whether Facebook’s Meta Pixel uses first-party cookies. When this toggle is on, first-party cookies are disabled, enhancing user privacy. Turning it off enables the use of first-party cookies for more accurate tracking.",
+      description:
+        'Control whether Facebook’s Meta Pixel uses first-party cookies. When this toggle is on, first-party cookies are disabled, enhancing user privacy. Turning it off enables the use of first-party cookies for more accurate tracking.',
       label: 'Disable First Party Cookies',
       type: 'boolean',
       default: false
@@ -55,8 +58,8 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       type: 'string',
       required: true,
       choices: [
-        { label: 'LDU disabled', value: LDU.Disabled.key},
-        { label: "LDU enabled - Use Meta Geolocation Logic", value: LDU.GeolocationLogic.key },
+        { label: 'LDU disabled', value: LDU.Disabled.key },
+        { label: 'LDU enabled - Use Meta Geolocation Logic', value: LDU.GeolocationLogic.key },
         { label: 'LDU enabled - California only', value: LDU.California.key },
         { label: 'LDU enabled - Colorado only', value: LDU.Colorado.key },
         { label: 'LDU enabled - Connecticut only', value: LDU.Connecticut.key },
@@ -87,8 +90,7 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       name: 'AddPaymentInfo',
       subscribe: 'event = "Payment Info Entered"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'AddPaymentInfo',
@@ -101,8 +103,7 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       name: 'AddToCart',
       subscribe: 'event = "Product Added"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'AddToCart',
@@ -117,13 +118,12 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
         value: { '@path': '$.properties.price' }
       },
       type: 'automatic'
-    },    
+    },
     {
       name: 'AddToWishlist',
       subscribe: 'event = "Product Added To Wishlist"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'AddToWishlist',
@@ -143,8 +143,7 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       name: 'CompleteRegistration',
       subscribe: 'event = "Signed Up"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'CompleteRegistration',
@@ -152,13 +151,12 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
         }
       },
       type: 'automatic'
-    }, 
+    },
     {
       name: 'InitiateCheckout',
       subscribe: 'event = "Checkout Started"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'InitiateCheckout',
@@ -186,14 +184,13 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       name: 'Purchase',
       subscribe: 'event = "Order Completed"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'Purchase',
           show_fields: false
         },
-        value: { '@path': '$.properties.revenue' }, 
+        value: { '@path': '$.properties.revenue' },
         custom_data: {
           order_id: { '@path': '$.properties.order_id' }
         }
@@ -204,8 +201,7 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       name: 'Search',
       subscribe: 'event = "Products Searched"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'Search',
@@ -224,8 +220,7 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
       name: 'ViewContent',
       subscribe: 'event = "Product Viewed"',
       partnerAction: 'send',
-      mapping: 
-      { 
+      mapping: {
         ...defaultValues(send.fields),
         event_config: {
           event_name: 'ViewContent',
@@ -235,7 +230,7 @@ export const destination: BrowserDestinationDefinition<Settings, FBClient> = {
           id: { '@path': '$.properties.product_id' },
           quantity: { '@path': '$.properties.quantity' },
           item_price: { '@path': '$.properties.price' }
-        }, 
+        },
         content_ids: { '@path': '$.properties.product_id' },
         value: { '@path': '$.properties.price' }
       },

package/src/send/depends-on.ts

@@ -2,47 +2,79 @@ import { DependsOnConditions, Condition } from '@segment/actions-core/destinatio
 import type { FBStandardEventType, FBNonStandardEventType } from '../types'
 
 export const fieldDependencies: Record<string, (FBStandardEventType | FBNonStandardEventType)[]> = {
-    custom_event_name: ['CustomEvent'],
-    content_category: ['PageView', 'ViewContent', 'Search'],
-    content_ids: ['AddPaymentInfo','AddToCart','AddToWishlist','InitiateCheckout','Purchase','Search','ViewContent'],
-    content_name: ['PageView', 'ViewContent', 'Search'],
-    content_type: ['AddToCart', 'Purchase', 'Search', 'ViewContent'],
-    contents: ['AddPaymentInfo', 'AddToCart', 'AddToWishlist', 'InitiateCheckout', 'Purchase', 'Search', 'ViewContent'],
-    currency: ['AddPaymentInfo', 'AddToCart', 'AddToWishlist', 'CompleteRegistration', 'InitiateCheckout', 'Lead', 'Purchase', 'Search', 'StartTrial', 'Subscribe', 'ViewContent'],
-    delivery_category: ['Purchase', 'InitiateCheckout'],
-    num_items: ['InitiateCheckout'],
-    predicted_ltv: ['Purchase', 'Subscribe', 'StartTrial', 'CompleteRegistration', 'AddPaymentInfo', 'CustomEvent' ],
-    net_revenue: ['Purchase'],
-    search_string: ['Search'],
-    status: ['CompleteRegistration'],
-    value: ['AddPaymentInfo', 'AddToCart', 'AddToWishlist', 'CompleteRegistration', 'InitiateCheckout', 'Lead', 'Purchase', 'Search', 'StartTrial', 'Subscribe', 'ViewContent'],
+  custom_event_name: ['CustomEvent'],
+  content_category: ['PageView', 'ViewContent', 'Search'],
+  content_ids: [
+    'AddPaymentInfo',
+    'AddToCart',
+    'AddToWishlist',
+    'InitiateCheckout',
+    'Purchase',
+    'Search',
+    'ViewContent'
+  ],
+  content_name: ['PageView', 'ViewContent', 'Search'],
+  content_type: ['AddToCart', 'Purchase', 'Search', 'ViewContent'],
+  contents: ['AddPaymentInfo', 'AddToCart', 'AddToWishlist', 'InitiateCheckout', 'Purchase', 'Search', 'ViewContent'],
+  currency: [
+    'AddPaymentInfo',
+    'AddToCart',
+    'AddToWishlist',
+    'CompleteRegistration',
+    'InitiateCheckout',
+    'Lead',
+    'Purchase',
+    'Search',
+    'StartTrial',
+    'Subscribe',
+    'ViewContent'
+  ],
+  delivery_category: ['Purchase', 'InitiateCheckout'],
+  num_items: ['InitiateCheckout'],
+  predicted_ltv: ['Purchase', 'Subscribe', 'StartTrial', 'CompleteRegistration', 'AddPaymentInfo', 'CustomEvent'],
+  net_revenue: ['Purchase'],
+  search_string: ['Search'],
+  status: ['CompleteRegistration'],
+  value: [
+    'AddPaymentInfo',
+    'AddToCart',
+    'AddToWishlist',
+    'CompleteRegistration',
+    'InitiateCheckout',
+    'Lead',
+    'Purchase',
+    'Search',
+    'StartTrial',
+    'Subscribe',
+    'ViewContent'
+  ]
 }
 
 export function getDependenciesFor(fieldName: string): DependsOnConditions {
   const conditions: Condition[] = [
-      {
-          fieldKey: 'event_config.show_fields',
-          operator: 'is',
-          value: 'true'
-      }
+    {
+      fieldKey: 'event_config.show_fields',
+      operator: 'is',
+      value: 'true'
+    }
   ]
 
   if (fieldDependencies[fieldName]) {
-      conditions.push({
-          fieldKey: 'event_config.event_name',
-          operator: 'is',
-          value: fieldDependencies[fieldName]
-      })
+    conditions.push({
+      fieldKey: 'event_config.event_name',
+      operator: 'is',
+      value: fieldDependencies[fieldName]
+    })
   }
 
   return {
-      match: 'any',
-      conditions
+    match: 'any',
+    conditions
   }
 }
 
 export function getNotVisibleForEvent(event: FBStandardEventType | FBNonStandardEventType): string[] {
-    return Object.entries(fieldDependencies)
-        .filter(([_, events]) => !events.includes(event))
-        .map(([fieldName]) => fieldName)
-}
+  return Object.entries(fieldDependencies)
+    .filter(([_, events]) => !events.includes(event))
+    .map(([fieldName]) => fieldName)
+}