@segment/analytics-browser-mixpanel-web-actions 1.3.1-staging-96646e7a8.0 → 1.3.1-staging-e5586ad4f.0

package/src/track/index.ts

@@ -3,7 +3,7 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 import type { Mixpanel } from '../types'
 import { sendIdentify, sendGroup } from '../functions'
-import { 
+import {
   event_name,
   properties,
   unique_id,
@@ -21,17 +21,18 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
   description: 'Sync Segment track events to Mixpanel.',
   platform: 'web',
   fields: {
-    event_name, 
+    event_name,
     properties,
     unique_id: {
       ...unique_id,
-      description: 'The unique ID to associate with the user. Settings this value will trigger a Mixpanel identify call before immediately the track event is sent.',
+      description:
+        'The unique ID to associate with the user. Settings this value will trigger a Mixpanel identify call before immediately the track event is sent.',
       default: undefined,
       required: false
     },
     user_profile_properties_to_set: {
       ...user_profile_properties_to_set,
-      default: { 
+      default: {
         name: {
           '@if': {
             exists: { '@path': '$.context.traits.name' },
@@ -59,7 +60,7 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
             then: { '@path': '$.context.traits.email' },
             else: { '@path': '$.properties.email' }
           }
-        },  
+        },
         phone: {
           '@if': {
             exists: { '@path': '$.context.traits.phone' },
@@ -88,7 +89,8 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
     group_details: {
       ...group_details,
       required: false,
-      description: 'Details for the group to be created or updated in Mixpanel. Setting this value will trigger a Mixpanel set_group call before the track event is sent.',
+      description:
+        'Details for the group to be created or updated in Mixpanel. Setting this value will trigger a Mixpanel set_group call before the track event is sent.',
       default: undefined
     },
     group_profile_properties_to_set,

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

@@ -36,7 +36,6 @@ describe('Mixpanel.trackPageView', () => {
   beforeEach(async () => {
     jest.restoreAllMocks()
     jest.spyOn(destination, 'initialize').mockImplementation(() => {
-
       mockGroup = {
         set: jest.fn(),
         set_once: jest.fn(),
@@ -71,32 +70,32 @@ describe('Mixpanel.trackPageView', () => {
         mapping: {
           event_name: undefined,
           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' }
         }
@@ -113,7 +112,7 @@ describe('Mixpanel.trackPageView', () => {
         prop2: 2,
         prop3: true,
         prop4: [1, 2, 3],
-        prop5: { subprop1: 'subvalue1', subprop2: 22}
+        prop5: { subprop1: 'subvalue1', subprop2: 22 }
       },
       context: {
         groupId: 'groupId1',
@@ -152,8 +151,8 @@ describe('Mixpanel.trackPageView', () => {
     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 +169,7 @@ describe('Mixpanel.trackPageView', () => {
       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 +189,7 @@ describe('Mixpanel.trackPageView', () => {
       prop2: 2,
       prop3: true,
       prop4: [1, 2, 3],
-      prop5: { subprop1: 'subvalue1', subprop2: 22}
+      prop5: { subprop1: 'subvalue1', subprop2: 22 }
     })
   })
 
@@ -214,13 +213,13 @@ describe('Mixpanel.trackPageView', () => {
       anonymousId: 'anonymousId',
       userId: 'userId1',
       properties: {
-        event_name: "Dis be an event name",
+        event_name: 'Dis be an event name',
         other_props: {
           prop1: 'value1',
           prop2: 2,
           prop3: true,
           prop4: [1, 2, 3],
-          prop5: { subprop1: 'subvalue1', subprop2: 22}
+          prop5: { subprop1: 'subvalue1', subprop2: 22 }
         }
       }
     })
@@ -235,15 +234,17 @@ describe('Mixpanel.trackPageView', () => {
     await event.group?.(context)
 
     // Track Page View related calls
-    expect(mockMPP.track_pageview).toHaveBeenCalledWith({
-      prop1: 'value1',
-      prop2: 2,
-      prop3: true,
-      prop4: [1, 2, 3],
-      prop5: { subprop1: 'subvalue1', subprop2: 22}
-    }, 
-    {
-      event_name: "Dis be an event name"
-    })
+    expect(mockMPP.track_pageview).toHaveBeenCalledWith(
+      {
+        prop1: 'value1',
+        prop2: 2,
+        prop3: true,
+        prop4: [1, 2, 3],
+        prop5: { subprop1: 'subvalue1', subprop2: 22 }
+      },
+      {
+        event_name: 'Dis be an event name'
+      }
+    )
   })
 })

package/src/trackPageView/index.ts

@@ -3,7 +3,7 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 import type { Mixpanel } from '../types'
 import { sendIdentify, sendGroup } from '../functions'
-import { 
+import {
   event_name,
   properties,
   unique_id,
@@ -30,12 +30,13 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
     properties,
     unique_id: {
       ...unique_id,
-      description: 'The unique ID to associate with the user. Settings this value will trigger a Mixpanel identify call before immediately the page event is sent.',
+      description:
+        'The unique ID to associate with the user. Settings this value will trigger a Mixpanel identify call before immediately the page event is sent.',
       default: undefined
     },
     user_profile_properties_to_set: {
       ...user_profile_properties_to_set,
-      default: { 
+      default: {
         name: {
           '@if': {
             exists: { '@path': '$.context.traits.name' },
@@ -63,7 +64,7 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
             then: { '@path': '$.context.traits.email' },
             else: { '@path': '$.properties.email' }
           }
-        },  
+        },
         phone: {
           '@if': {
             exists: { '@path': '$.context.traits.phone' },
@@ -92,7 +93,8 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
     group_details: {
       ...group_details,
       required: false,
-      description: 'Details for the group to be created or updated in Mixpanel. Setting this value will trigger a Mixpanel set_group call before the page event is sent.',
+      description:
+        'Details for the group to be created or updated in Mixpanel. Setting this value will trigger a Mixpanel set_group call before the page event is sent.',
       default: undefined
     },
     group_profile_properties_to_set,
@@ -103,10 +105,10 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
     sendIdentify(mixpanel, payload)
     sendGroup(mixpanel, payload)
     const { event_name, properties = {} } = payload
-    if(event_name){
-        mixpanel.track_pageview(properties || {}, { event_name } )
+    if (event_name) {
+      mixpanel.track_pageview(properties || {}, { event_name })
     } else {
-        mixpanel.track_pageview(properties || {})
+      mixpanel.track_pageview(properties || {})
     }
   }
 }

package/src/types.ts

@@ -29,36 +29,38 @@ export interface Mixpanel {
 
   get_group(group_key: string, group_id: string): Group
 
-  set_group( group_key: string, group_ids: string): void
+  set_group(group_key: string, group_ids: string): void
 
   people: People
 }
 
 export interface People {
-  set(prop: {[k: string]: unknown}): void
-  set_once(prop: {[k: string]: unknown}): void
-  increment(prop: {[k: string]: unknown}): void
+  set(prop: { [k: string]: unknown }): void
+  set_once(prop: { [k: string]: unknown }): void
+  increment(prop: { [k: string]: unknown }): void
 }
 
 export interface Group {
-  set(prop: {[k: string]: unknown}): void
-  set_once(prop: {[k: string]: unknown}): void
+  set(prop: { [k: string]: unknown }): void
+  set_once(prop: { [k: string]: unknown }): void
   union(list_name: string, values: (string | number | boolean)[]): void
 }
 
 export interface Config {
-  autocapture?: {
-    pageview?: PageViewUrlConfigOption
-    click?: boolean
-    dead_click?: boolean
-    input?: boolean
-    rage_click?: boolean
-    scroll?: boolean
-    submit?: boolean
-    capture_text_content?: boolean
-  } | boolean,
+  autocapture?:
+    | {
+        pageview?: PageViewUrlConfigOption
+        click?: boolean
+        dead_click?: boolean
+        input?: boolean
+        rage_click?: boolean
+        scroll?: boolean
+        submit?: boolean
+        capture_text_content?: boolean
+      }
+    | boolean
   cross_subdomain_cookie?: boolean
-  persistence?: PersistenceOptions,
+  persistence?: PersistenceOptions
   track_marketing?: boolean
   cookie_expiration?: number
   disable_persistence?: boolean
@@ -74,4 +76,3 @@ export interface Config {
   record_min_ms?: number
   record_sessions_percent?: number
 }
-