@segment/analytics-browser-mixpanel-web-actions 1.0.1-staging-b870c2b86.0 → 1.1.0

package/src/setting-fields.ts

@@ -2,272 +2,272 @@ import { PAGE_VIEW_URL_CONFIG_OPTIONS, PERSISTENCE_OPTIONS, AUTOCAPTURE_OPTIONS
 import { GlobalSetting } from '@segment/actions-core'
 
 export const settingFields: Record<string, GlobalSetting> = {
-  projectToken: {
-    description: 'Your Mixpanel project token.',
-    label: 'Project Token',
-    type: 'string',
-    required: true
-  },
-  name: {
-    label: 'Mixpanel Instance Name',
-    description: 'The name for the new mixpanel instance that you want created.',
-    type: 'string'
-  },
-  api_host: {
-    description: 'The Mixpanel API host to send data to.',
-    label: 'API Host',
-    type: 'string',
-    format: 'uri',
-    required: true,
-    default: 'https://api-js.mixpanel.com'
-  },
-  autocapture: {
-    description:
-      'Enable or disable Mixpanel autocapture functionality. Select "Custom" to specify fine grained control over which events are autocaptured.',
-    label: 'Autocapture',
-    type: 'string',
-    choices: [
-      { label: 'Enabled', value: AUTOCAPTURE_OPTIONS.ENABLED },
-      { label: 'Disabled', value: AUTOCAPTURE_OPTIONS.DISABLED },
-      { label: 'Custom', value: AUTOCAPTURE_OPTIONS.CUSTOM }
-    ],
-    default: AUTOCAPTURE_OPTIONS.ENABLED
-  },
-  pageview: {
-    description: 'Capture pageview events automatically',
-    label: 'Autocapture Pageview',
-    type: 'string',
-    choices: [
-      { label: 'Full URL', value: PAGE_VIEW_URL_CONFIG_OPTIONS.FULL_URL },
-      { label: 'URL with Path and Query String', value: PAGE_VIEW_URL_CONFIG_OPTIONS.URL_WITH_PATH_AND_QUERY_STRING },
-      { label: 'URL with Path', value: PAGE_VIEW_URL_CONFIG_OPTIONS.URL_WITH_PATH }
-    ],
-    default: PAGE_VIEW_URL_CONFIG_OPTIONS.FULL_URL,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    projectToken: {
+        description: 'Your Mixpanel project token.',
+        label: 'Project Token',
+        type: 'string',
+        required: true,
+    },
+    name: {
+        label: 'Mixpanel Instance Name',
+        description: 'The name for the new mixpanel instance that you want created.',
+        type: 'string'
+    },
+    api_host: {
+        description: 'The Mixpanel API host to send data to.',
+        label: 'API Host',
+        type: 'string',
+        format: 'uri',
+        required: true,
+        default: 'https://api-js.mixpanel.com'
+    },
+    autocapture: {
+        description:
+        'Enable or disable Mixpanel autocapture functionality. Select "Custom" to specify fine grained control over which events are autocaptured.',
+        label: 'Autocapture',
+        type: 'string',
+        choices: [
+        { label: 'Enabled', value: AUTOCAPTURE_OPTIONS.ENABLED },
+        { label: 'Disabled', value: AUTOCAPTURE_OPTIONS.DISABLED },
+        { label: 'Custom', value: AUTOCAPTURE_OPTIONS.CUSTOM }
+        ],
+        default: AUTOCAPTURE_OPTIONS.ENABLED
+    },
+    pageview: {
+        description: 'Capture pageview events automatically',
+        label: 'Autocapture Pageview',
+        type: 'string',
+        choices: [
+        { label: 'Full URL', value: PAGE_VIEW_URL_CONFIG_OPTIONS.FULL_URL },
+        { label: 'URL with Path and Query String', value: PAGE_VIEW_URL_CONFIG_OPTIONS.URL_WITH_PATH_AND_QUERY_STRING },
+        { label: 'URL with Path', value: PAGE_VIEW_URL_CONFIG_OPTIONS.URL_WITH_PATH }
+        ],
+        default: PAGE_VIEW_URL_CONFIG_OPTIONS.FULL_URL,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  click: {
-    description: 'Capture click events automatically',
-    label: 'Autocapture Click',
-    type: 'boolean',
-    default: true,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    click: {
+        description: 'Capture click events automatically',
+        label: 'Autocapture Click',
+        type: 'boolean',
+        default: true,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  dead_click: {
-    description: 'Capture dead click events automatically',
-    label: 'Autocapture Dead Click',
-    type: 'boolean',
-    default: true,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    dead_click: {
+        description: 'Capture dead click events automatically',
+        label: 'Autocapture Dead Click',
+        type: 'boolean',
+        default: true,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  input: {
-    description: 'Capture input events automatically',
-    label: 'Autocapture Input',
-    type: 'boolean',
-    default: true,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    input: {
+        description: 'Capture input events automatically',
+        label: 'Autocapture Input',
+        type: 'boolean',
+        default: true,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  rage_click: {
-    description: 'Capture rage click events automatically',
-    label: 'Autocapture Rage Click',
-    type: 'boolean',
-    default: true,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    rage_click: {
+        description: 'Capture rage click events automatically',
+        label: 'Autocapture Rage Click',
+        type: 'boolean',
+        default: true,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  scroll: {
-    description: 'Capture scroll events automatically',
-    label: 'Autocapture Scroll',
-    type: 'boolean',
-    default: true,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    scroll: {
+        description: 'Capture scroll events automatically',
+        label: 'Autocapture Scroll',
+        type: 'boolean',
+        default: true,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  submit: {
-    description: 'Capture form submit events automatically',
-    label: 'Autocapture Submit',
-    type: 'boolean',
-    default: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    submit: {
+        description: 'Capture form submit events automatically',
+        label: 'Autocapture Submit',
+        type: 'boolean',
+        default: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
-    }
-  },
-  capture_text_content: {
-    description: 'Capture text content of elements in autocaptured events',
-    label: 'Autocapture Capture Text Content',
-    type: 'boolean',
-    default: false,
-    required: true,
-    depends_on: {
-      conditions: [
-        {
-          fieldKey: 'autocapture',
-          operator: 'is',
-          value: 'custom'
+    },
+    capture_text_content: {
+        description: 'Capture text content of elements in autocaptured events',
+        label: 'Autocapture Capture Text Content',
+        type: 'boolean',
+        default: false,
+        required: true,
+        depends_on: {
+        conditions: [
+            {
+            fieldKey: 'autocapture',
+            operator: 'is',
+            value: 'custom'
+            }
+        ]
         }
-      ]
+    },
+    cross_subdomain_cookie: {
+        description: 'Enable or disable cross subdomain cookies for Mixpanel.',
+        label: 'Cross Subdomain Cookie',
+        type: 'boolean',
+        default: true
+    },
+    persistence: {
+        description: 'Set the persistence method for Mixpanel (cookie or localStorage).',
+        label: 'Persistence Method',
+        type: 'string',
+        choices: [
+        { label: 'Cookie', value: PERSISTENCE_OPTIONS.COOKIE },
+        { label: 'Local Storage', value: PERSISTENCE_OPTIONS.LOCAL_STORAGE }
+        ],
+        default: PERSISTENCE_OPTIONS.COOKIE
+    },
+    track_marketing: {
+        description:
+        'Enable or disable tracking of marketing campaigns in Mixpanel. Includes UTM parameters and click identifiers for various ad platforms.',
+        label: 'Track Marketing Campaigns',
+        type: 'boolean',
+        default: true
+    },
+    cookie_expiration: {
+        description: 'Set the cookie expiration time in days for Mixpanel cookies.',
+        label: 'Cookie Expiration (days)',
+        type: 'number',
+        default: 365
+    },
+    disable_persistence: {
+        description: 'Disable all persistence mechanisms for Mixpanel.',
+        label: 'Disable Persistence',
+        type: 'boolean',
+        default: false
+    },
+    ip: {
+        description: 'Enable or disable sending IP address information to Mixpanel.',
+        label: 'Send IP Address',
+        type: 'boolean',
+        default: true
+    },
+    record_block_class: {
+        description: 'CSS class to block elements from being recorded in session recordings.',
+        label: 'Record Block Class',
+        type: 'string',
+        default: 'mp-block'
+    },
+    record_block_selector: {
+        description: 'CSS selector to block elements from being recorded in session recordings.',
+        label: 'Record Block Selector',
+        type: 'string',
+        default: 'img, video, audio'
+    },
+    record_canvas: {
+        description: 'Enable or disable recording of canvas elements in session recordings.',
+        label: 'Record Canvas',
+        type: 'boolean',
+        default: false
+    },
+    record_heatmap_data: {
+        description: 'Enable or disable tracking of heatmap events in session recordings.',
+        label: 'Record Heatmap Data',
+        type: 'boolean',
+        default: false
+    },
+    record_idle_timeout_ms: {
+        description: 'Idle timeout in milliseconds for session recordings.',
+        label: 'Record Idle Timeout (ms)',
+        type: 'number',
+        default: 180_000
+    },
+    record_mask_text_class: {
+        description: 'CSS class to mask text elements in session recordings.',
+        label: 'Record Mask Text Class',
+        type: 'string',
+        default: 'mp-mask'
+    },
+    record_mask_text_selector: {
+        description: 'CSS selector to mask text elements in session recordings.',
+        label: 'Record Mask Text Selector',
+        type: 'string',
+        default: '*'
+    },
+    record_max_ms: {
+        description: 'Maximum recording time in milliseconds for session recordings.',
+        label: 'Record Max (ms)',
+        type: 'number',
+        default: 86_400_000
+    },
+    record_min_ms: {
+        description: 'Minimum recording time in milliseconds for session recordings.',
+        label: 'Record Min (ms)',
+        type: 'number',
+        default: 0,
+        minimum: 0,
+        maximum: 8_000
+    },
+    record_sessions_percent: {
+        description: 'Percentage of sessions to record for session recordings.',
+        label: 'Record Sessions Percent',
+        type: 'number',
+        default: 0,
+        minimum: 0,
+        maximum: 100
     }
-  },
-  cross_subdomain_cookie: {
-    description: 'Enable or disable cross subdomain cookies for Mixpanel.',
-    label: 'Cross Subdomain Cookie',
-    type: 'boolean',
-    default: true
-  },
-  persistence: {
-    description: 'Set the persistence method for Mixpanel (cookie or localStorage).',
-    label: 'Persistence Method',
-    type: 'string',
-    choices: [
-      { label: 'Cookie', value: PERSISTENCE_OPTIONS.COOKIE },
-      { label: 'Local Storage', value: PERSISTENCE_OPTIONS.LOCAL_STORAGE }
-    ],
-    default: PERSISTENCE_OPTIONS.COOKIE
-  },
-  track_marketing: {
-    description:
-      'Enable or disable tracking of marketing campaigns in Mixpanel. Includes UTM parameters and click identifiers for various ad platforms.',
-    label: 'Track Marketing Campaigns',
-    type: 'boolean',
-    default: true
-  },
-  cookie_expiration: {
-    description: 'Set the cookie expiration time in days for Mixpanel cookies.',
-    label: 'Cookie Expiration (days)',
-    type: 'number',
-    default: 365
-  },
-  disable_persistence: {
-    description: 'Disable all persistence mechanisms for Mixpanel.',
-    label: 'Disable Persistence',
-    type: 'boolean',
-    default: false
-  },
-  ip: {
-    description: 'Enable or disable sending IP address information to Mixpanel.',
-    label: 'Send IP Address',
-    type: 'boolean',
-    default: true
-  },
-  record_block_class: {
-    description: 'CSS class to block elements from being recorded in session recordings.',
-    label: 'Record Block Class',
-    type: 'string',
-    default: 'mp-block'
-  },
-  record_block_selector: {
-    description: 'CSS selector to block elements from being recorded in session recordings.',
-    label: 'Record Block Selector',
-    type: 'string',
-    default: 'img, video, audio'
-  },
-  record_canvas: {
-    description: 'Enable or disable recording of canvas elements in session recordings.',
-    label: 'Record Canvas',
-    type: 'boolean',
-    default: false
-  },
-  record_heatmap_data: {
-    description: 'Enable or disable tracking of heatmap events in session recordings.',
-    label: 'Record Heatmap Data',
-    type: 'boolean',
-    default: false
-  },
-  record_idle_timeout_ms: {
-    description: 'Idle timeout in milliseconds for session recordings.',
-    label: 'Record Idle Timeout (ms)',
-    type: 'number',
-    default: 180_000
-  },
-  record_mask_text_class: {
-    description: 'CSS class to mask text elements in session recordings.',
-    label: 'Record Mask Text Class',
-    type: 'string',
-    default: 'mp-mask'
-  },
-  record_mask_text_selector: {
-    description: 'CSS selector to mask text elements in session recordings.',
-    label: 'Record Mask Text Selector',
-    type: 'string',
-    default: '*'
-  },
-  record_max_ms: {
-    description: 'Maximum recording time in milliseconds for session recordings.',
-    label: 'Record Max (ms)',
-    type: 'number',
-    default: 86_400_000
-  },
-  record_min_ms: {
-    description: 'Minimum recording time in milliseconds for session recordings.',
-    label: 'Record Min (ms)',
-    type: 'number',
-    default: 0,
-    minimum: 0,
-    maximum: 8_000
-  },
-  record_sessions_percent: {
-    description: 'Percentage of sessions to record for session recordings.',
-    label: 'Record Sessions Percent',
-    type: 'number',
-    default: 0,
-    minimum: 0,
-    maximum: 100
-  }
-}
+}

package/src/track/__tests__/index.test.ts

@@ -36,6 +36,7 @@ describe('Mixpanel.track', () => {
   beforeEach(async () => {
     jest.restoreAllMocks()
     jest.spyOn(destination, 'initialize').mockImplementation(() => {
+
       mockGroup = {
         set: jest.fn(),
         set_once: jest.fn(),
@@ -70,32 +71,32 @@ describe('Mixpanel.track', () => {
         mapping: {
           event_name: { '@path': '$.event' },
           properties: { '@path': '$.properties' },
-          unique_id: { '@path': '$.userId' },
-          user_profile_properties_to_set: {
-            name: { '@path': '$.context.traits.user.name' },
-            first_name: { '@path': '$.context.traits.user.first_name' },
-            last_name: { '@path': '$.context.traits.user.last_name' },
-            email: { '@path': '$.context.traits.user.email' },
-            phone: { '@path': '$.context.traits.user.phone' },
-            avatar: { '@path': '$.context.traits.user.avatar' },
-            created: { '@path': '$.context.traits.user.created' }
+          unique_id:{ '@path': '$.userId' },
+          user_profile_properties_to_set: { 
+              name: { '@path': '$.context.traits.user.name' },
+              first_name: { '@path': '$.context.traits.user.first_name' },
+              last_name: { '@path': '$.context.traits.user.last_name' },
+              email: { '@path': '$.context.traits.user.email' },
+              phone: { '@path': '$.context.traits.user.phone' },
+              avatar: { '@path': '$.context.traits.user.avatar' },
+              created: { '@path': '$.context.traits.user.created' }
           },
           user_profile_properties_to_set_once: {
-            set_once_trait: { '@path': '$.context.traits.user.set_once_trait_1' }
+              set_once_trait: { '@path': '$.context.traits.user.set_once_trait_1' },
           },
           user_profile_properties_to_increment: {
-            increment_property: { '@path': '$.context.traits.user.increment_property_1' }
+              increment_property: { '@path': '$.context.traits.user.increment_property_1' }
           },
           group_details: {
-            group_key: { '@path': '$.context.traits.company.group_key' },
-            group_id: { '@path': '$.context.groupId' }
+              group_key: { '@path': '$.context.traits.company.group_key' },
+              group_id: { '@path': '$.context.groupId' }
           },
-          group_profile_properties_to_set: {
-            company_name: { '@path': '$.context.traits.company.company_name' },
-            number_employees: { '@path': '$.context.traits.company.number_employees' }
+          group_profile_properties_to_set: { 
+              company_name: { '@path': '$.context.traits.company.company_name' },
+              number_employees: { '@path': '$.context.traits.company.number_employees' }
           },
           group_profile_properties_to_set_once: {
-            set_once_trait: { '@path': '$.context.traits.company.set_once_trait_1' }
+              set_once_trait: { '@path': '$.context.traits.company.set_once_trait_1' },
           },
           group_profile_properties_to_union: { '@path': '$.context.traits.company.union_properties' }
         }
@@ -105,7 +106,7 @@ describe('Mixpanel.track', () => {
     const context = new Context({
       messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
       type: 'track',
-      event: 'Big Fat Test Event',
+      event: "Big Fat Test Event",
       anonymousId: 'anonymousId',
       userId: 'userId1',
       properties: {
@@ -113,7 +114,7 @@ describe('Mixpanel.track', () => {
         prop2: 2,
         prop3: true,
         prop4: [1, 2, 3],
-        prop5: { subprop1: 'subvalue1', subprop2: 22 }
+        prop5: { subprop1: 'subvalue1', subprop2: 22}
       },
       context: {
         groupId: 'groupId1',
@@ -152,8 +153,8 @@ describe('Mixpanel.track', () => {
     await event.load(Context.system(), {} as Analytics)
     await event.group?.(context)
 
-    // Identify related calls
-    expect(mockMPP.identify).toHaveBeenCalledWith('userId1')
+    // Identify related calls 
+    expect(mockMPP.identify).toHaveBeenCalledWith("userId1")
     expect(mockMPP.people.set).toHaveBeenCalledWith({
       name: 'User Name',
       last_name: 'Last',
@@ -170,7 +171,7 @@ describe('Mixpanel.track', () => {
       increment_property: 5
     })
 
-    // Group related calls
+    // Group related calls 
     expect(mockMPP.set_group).toHaveBeenCalledWith('company', 'groupId1')
     expect(mockMPP.get_group).toHaveBeenCalledWith('company', 'groupId1')
     expect(mockGroup.set).toHaveBeenCalledWith({
@@ -190,7 +191,7 @@ describe('Mixpanel.track', () => {
       prop2: 2,
       prop3: true,
       prop4: [1, 2, 3],
-      prop5: { subprop1: 'subvalue1', subprop2: 22 }
+      prop5: { subprop1: 'subvalue1', subprop2: 22}
     })
   })
 })