@segment/analytics-browser-mixpanel-web-actions 1.0.1-staging-294d81392.0

package/src/fields.ts

@@ -0,0 +1,173 @@
+import { InputField } from '@segment/actions-core'
+
+export const event_name: InputField = {
+  label: 'Event Name',
+  description: 'The name of the event to track in Mixpanel.',
+  required: true,
+  type: 'string',
+  default: { '@path': '$.event' }
+}
+
+export const properties: InputField = {
+  label: 'Event Properties',
+  description: 'Properties to associate with the event.',
+  required: false,
+  type: 'object',
+  default: { '@path': '$.properties' }
+}
+
+export const unique_id: InputField = {
+  label: 'Unique ID',
+  description: 'The unique ID to associate with the user.',
+  required: true,
+  type: 'string',
+  default: { '@path': '$.userId' }
+}
+
+export const user_profile_properties_to_set: InputField = {
+  label: 'User Profile Properties to Set',
+  description: 'User Profile Properties to set on the user profile in Mixpanel.',
+  required: false,
+  defaultObjectUI: 'keyvalue',
+  additionalProperties: true,
+  type: 'object',
+  properties: {
+    name: {
+      label: 'Name',
+      description: 'The name of the user.',
+      type: 'string'
+    },
+    first_name: {
+      label: 'First Name',
+      description: 'The first name of the user.',
+      type: 'string'
+    },
+    last_name: {
+      label: 'Last Name',
+      description: 'The last name of the user.',
+      type: 'string'
+    },
+    email: {
+      label: 'Email',
+      description: 'The email of the user.',
+      type: 'string',
+      format: 'email'
+    },
+    phone: {
+      label: 'Phone',
+      description: 'The phone number of the user.',
+      type: 'string'
+    },
+    avatar: {
+      label: 'Avatar',
+      description: 'The avatar URL of the user.',
+      type: 'string',
+      format: 'uri'
+    },
+    created: {
+      label: 'Created',
+      description: 'The creation date of the user profile.',
+      type: 'string',
+      format: 'date-time'
+    }
+  },
+  default: {
+    name: { '@path': '$.traits.name' },
+    first_name: { '@path': '$.traits.first_name' },
+    last_name: { '@path': '$.traits.last_name' },
+    email: { '@path': '$.traits.email' },
+    phone: { '@path': '$.traits.phone' },
+    avatar: { '@path': '$.traits.avatar' },
+    created: { '@path': '$.traits.created' }
+  }
+}
+
+export const user_profile_properties_to_set_once: InputField = {
+  label: 'User Profile Properties to Set Once',
+  description:
+    'User Profile Properties to set once on the user profile in Mixpanel. Values which get set once cannot be overwritten later.',
+  required: false,
+  defaultObjectUI: 'keyvalue',
+  type: 'object'
+}
+
+export const user_profile_properties_to_increment: InputField = {
+  label: 'User Profile Properties to Increment',
+  description: 'User Profile Properties to increment on the user profile in Mixpanel. Values must be numeric.',
+  required: false,
+  defaultObjectUI: 'keyvalue',
+  type: 'object'
+}
+
+export const group_details: InputField = {
+  label: 'Group Details',
+  description: 'Details for the group to be created or updated in Mixpanel.',
+  type: 'object',
+  defaultObjectUI: 'keyvalue:only',
+  additionalProperties: false,
+  required: true,
+  properties: {
+    group_key: {
+      label: 'Group Key',
+      description:
+        'The Group Key / type of group to associate with the user. This group key should already be defined in your Mixpanel project.',
+      required: true,
+      type: 'string'
+    },
+    group_id: {
+      label: 'Group ID',
+      description: 'The unique ID to associate with the group.',
+      required: true,
+      type: 'string'
+    }
+  },
+  default: {
+    group_key: { '@path': '$.traits.group_key' },
+    group_id: { '@path': '$.groupId' }
+  }
+}
+
+export const group_profile_properties_to_set: InputField = {
+  label: 'Group properties to Set',
+  description: 'Group Profile Properties to set on the group in Mixpanel.',
+  required: false,
+  defaultObjectUI: 'keyvalue',
+  type: 'object'
+}
+
+export const group_profile_properties_to_set_once: InputField = {
+  label: 'Group properties to set once',
+  description:
+    'Group Profile Properties to set once on the group profile in Mixpanel. Values which get set once cannot be overwritten later.',
+  required: false,
+  defaultObjectUI: 'keyvalue',
+  type: 'object'
+}
+
+export const group_profile_properties_to_union: InputField = {
+  label: 'Group list properties to union',
+  description: 'Merge a list into a list group property. Duplicates will be removed.',
+  required: false,
+  type: 'object',
+  multiple: true,
+  defaultObjectUI: 'arrayeditor',
+  additionalProperties: false,
+  properties: {
+    list_name: {
+      label: 'List Name',
+      description: 'The name of the list property to union values into.',
+      type: 'string',
+      allowNull: false,
+      required: true
+    },
+    string_values: {
+      label: 'Values',
+      description:
+        'An array of string values to merge into the list. Non string lists cannot be updated. Duplicates will be removed.',
+      type: 'string',
+      required: true,
+      allowNull: false,
+      multiple: true
+    }
+  }
+}

package/src/functions.ts

@@ -0,0 +1,57 @@
+import { Payload as GroupPayload } from './group/generated-types'
+import { Payload as TrackPayload } from './track/generated-types'
+import { Payload as IdentifyPayload } from './identify/generated-types'
+import { Payload as TrackPageViewPayload } from './trackPageView/generated-types'
+import type { Mixpanel } from './types'
+
+export function sendIdentify(mixpanel: Mixpanel, payload: IdentifyPayload | TrackPayload | TrackPageViewPayload) {
+  const {
+    unique_id,
+    user_profile_properties_to_set,
+    user_profile_properties_to_set_once,
+    user_profile_properties_to_increment
+  } = payload
+
+  if (unique_id) {
+    mixpanel.identify(unique_id)
+  }
+
+  if (user_profile_properties_to_set && Object.keys(user_profile_properties_to_set).length > 0) {
+    mixpanel.people.set(user_profile_properties_to_set)
+  }
+
+  if (user_profile_properties_to_set_once && Object.keys(user_profile_properties_to_set_once).length > 0) {
+    mixpanel.people.set_once(user_profile_properties_to_set_once)
+  }
+
+  if (user_profile_properties_to_increment && Object.keys(user_profile_properties_to_increment).length > 0) {
+    mixpanel.people.increment(user_profile_properties_to_increment)
+  }
+}
+
+export function sendGroup(mixpanel: Mixpanel, payload: GroupPayload | TrackPayload | TrackPageViewPayload) {
+  const {
+    group_details: { group_key, group_id } = {},
+    group_profile_properties_to_set,
+    group_profile_properties_to_set_once,
+    group_profile_properties_to_union
+  } = payload
+
+  if (group_key && group_id) {
+    mixpanel.set_group(group_key, group_id)
+    const group = mixpanel.get_group(group_key, group_id)
+
+    if (group_profile_properties_to_set && Object.keys(group_profile_properties_to_set).length > 0) {
+      group.set(group_profile_properties_to_set)
+    }
+    if (group_profile_properties_to_set_once && Object.keys(group_profile_properties_to_set_once).length > 0) {
+      group.set_once(group_profile_properties_to_set_once)
+    }
+    if (group_profile_properties_to_union && group_profile_properties_to_union.length > 0) {
+      group_profile_properties_to_union.forEach((item) => {
+        const { list_name, string_values } = item
+        group.union(list_name, string_values)
+      })
+    }
+  }
+}

package/src/generated-types.ts

@@ -0,0 +1,116 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Settings {
+  /**
+   * Your Mixpanel project token.
+   */
+  projectToken: string
+  /**
+   * The name for the new mixpanel instance that you want created.
+   */
+  name?: string
+  /**
+   * The Mixpanel API host to send data to.
+   */
+  api_host: string
+  /**
+   * Enable or disable Mixpanel autocapture functionality. Select "Custom" to specify fine grained control over which events are autocaptured.
+   */
+  autocapture?: string
+  /**
+   * Capture pageview events automatically
+   */
+  pageview: string
+  /**
+   * Capture click events automatically
+   */
+  click: boolean
+  /**
+   * Capture dead click events automatically
+   */
+  dead_click: boolean
+  /**
+   * Capture input events automatically
+   */
+  input: boolean
+  /**
+   * Capture rage click events automatically
+   */
+  rage_click: boolean
+  /**
+   * Capture scroll events automatically
+   */
+  scroll: boolean
+  /**
+   * Capture form submit events automatically
+   */
+  submit?: boolean
+  /**
+   * Capture text content of elements in autocaptured events
+   */
+  capture_text_content: boolean
+  /**
+   * Enable or disable cross subdomain cookies for Mixpanel.
+   */
+  cross_subdomain_cookie?: boolean
+  /**
+   * Set the persistence method for Mixpanel (cookie or localStorage).
+   */
+  persistence?: string
+  /**
+   * Enable or disable tracking of marketing campaigns in Mixpanel. Includes UTM parameters and click identifiers for various ad platforms.
+   */
+  track_marketing?: boolean
+  /**
+   * Set the cookie expiration time in days for Mixpanel cookies.
+   */
+  cookie_expiration?: number
+  /**
+   * Disable all persistence mechanisms for Mixpanel.
+   */
+  disable_persistence?: boolean
+  /**
+   * Enable or disable sending IP address information to Mixpanel.
+   */
+  ip?: boolean
+  /**
+   * CSS class to block elements from being recorded in session recordings.
+   */
+  record_block_class?: string
+  /**
+   * CSS selector to block elements from being recorded in session recordings.
+   */
+  record_block_selector?: string
+  /**
+   * Enable or disable recording of canvas elements in session recordings.
+   */
+  record_canvas?: boolean
+  /**
+   * Enable or disable tracking of heatmap events in session recordings.
+   */
+  record_heatmap_data?: boolean
+  /**
+   * Idle timeout in milliseconds for session recordings.
+   */
+  record_idle_timeout_ms?: number
+  /**
+   * CSS class to mask text elements in session recordings.
+   */
+  record_mask_text_class?: string
+  /**
+   * CSS selector to mask text elements in session recordings.
+   */
+  record_mask_text_selector?: string
+  /**
+   * Maximum recording time in milliseconds for session recordings.
+   */
+  record_max_ms?: number
+  /**
+   * Minimum recording time in milliseconds for session recordings.
+   */
+  record_min_ms?: number
+  /**
+   * Percentage of sessions to record for session recordings.
+   */
+  record_sessions_percent?: number
+}

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

@@ -0,0 +1,126 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import { Subscription } from '@segment/browser-destination-runtime'
+import MixpanelDestination, { destination } from '../../index'
+import { Mixpanel } from '../../types'
+import { AUTOCAPTURE_OPTIONS, PERSISTENCE_OPTIONS } from '../../constants'
+import { Group } from '../../types'
+
+describe('Mixpanel.group', () => {
+  const settings = {
+    projectToken: 'projectToken1',
+    name: 'name1',
+    default: 'https://api-js.mixpanel.com',
+    autocapture: AUTOCAPTURE_OPTIONS.ENABLED,
+    cross_subdomain_cookie: true,
+    persistence: PERSISTENCE_OPTIONS.COOKIE,
+    track_marketing: true,
+    cookie_expiration: 365,
+    disable_persistence: false,
+    ip: true,
+    record_block_class: 'mp-block',
+    record_block_selector: 'img, video, audio',
+    record_canvas: false,
+    record_heatmap_data: false,
+    record_idle_timeout_ms: 180_000,
+    record_mask_text_class: 'mp-mask',
+    record_mask_text_selector: '*',
+    record_max_ms: 86_400_000,
+    record_min_ms: 8_000,
+    record_sessions_percent: 0
+  }
+
+  let mockMPP: Mixpanel
+  let mockGroup: Group
+  let event: any
+
+  beforeEach(async () => {
+    jest.restoreAllMocks()
+    jest.spyOn(destination, 'initialize').mockImplementation(() => {
+      mockGroup = {
+        set: jest.fn(),
+        set_once: jest.fn(),
+        union: jest.fn()
+      }
+
+      mockMPP = {
+        init: jest.fn(),
+        track_pageview: jest.fn(),
+        track: jest.fn(),
+        identify: jest.fn(),
+        alias: jest.fn(),
+        get_group: jest.fn().mockReturnValue(mockGroup),
+        set_group: jest.fn(),
+        people: {
+          set: jest.fn(),
+          set_once: jest.fn(),
+          increment: jest.fn()
+        }
+      }
+      return Promise.resolve(mockMPP)
+    })
+  })
+
+  test('group() handled correctly', async () => {
+    const subscriptions: Subscription[] = [
+      {
+        partnerAction: 'group',
+        name: 'Group',
+        enabled: true,
+        subscribe: 'type = "group"',
+        mapping: {
+          group_details: {
+            group_key: { '@path': '$.traits.group_key' },
+            group_id: { '@path': '$.groupId' }
+          },
+          group_profile_properties_to_set: {
+            company_name: { '@path': '$.traits.company_name' },
+            number_employees: { '@path': '$.traits.number_employees' }
+          },
+          group_profile_properties_to_set_once: {
+            set_once_trait: { '@path': '$.traits.set_once_trait_1' }
+          },
+          group_profile_properties_to_union: { '@path': '$.traits.union_properties' }
+        }
+      }
+    ]
+
+    const context = new Context({
+      messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+      type: 'group',
+      anonymousId: 'anonymousId',
+      userId: 'userId1',
+      groupId: 'groupId1',
+      traits: {
+        group_key: 'company',
+        company_name: 'MicroMegaCorpSoftware',
+        number_employees: 1000,
+        set_once_trait_1: 'set_once_value_1',
+        union_properties: [
+          { list_name: 'Interests', string_values: ['sports', 'music'] },
+          { list_name: 'Regions', string_values: ['north-america', 'europe'] }
+        ]
+      }
+    })
+
+    const [groupEvent] = await MixpanelDestination({
+      ...settings,
+      subscriptions
+    })
+    event = groupEvent
+
+    await event.load(Context.system(), {} as Analytics)
+    await event.group?.(context)
+    expect(mockMPP.set_group).toHaveBeenCalledWith('company', 'groupId1')
+    expect(mockMPP.get_group).toHaveBeenCalledWith('company', 'groupId1')
+    expect(mockGroup.set).toHaveBeenCalledWith({
+      company_name: 'MicroMegaCorpSoftware',
+      number_employees: 1000
+    })
+    expect(mockGroup.set_once).toHaveBeenCalledWith({
+      set_once_trait: 'set_once_value_1'
+    })
+    expect(mockGroup.union).toHaveBeenCalledTimes(2)
+    expect(mockGroup.union).toHaveBeenNthCalledWith(1, 'Interests', ['sports', 'music'])
+    expect(mockGroup.union).toHaveBeenNthCalledWith(2, 'Regions', ['north-america', 'europe'])
+  })
+})

package/src/group/generated-types.ts

@@ -0,0 +1,42 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * Details for the group to be created or updated in Mixpanel.
+   */
+  group_details: {
+    /**
+     * The Group Key / type of group to associate with the user. This group key should already be defined in your Mixpanel project.
+     */
+    group_key: string
+    /**
+     * The unique ID to associate with the group.
+     */
+    group_id: string
+  }
+  /**
+   * Group Profile Properties to set on the group in Mixpanel.
+   */
+  group_profile_properties_to_set?: {
+    [k: string]: unknown
+  }
+  /**
+   * Group Profile Properties to set once on the group profile in Mixpanel. Values which get set once cannot be overwritten later.
+   */
+  group_profile_properties_to_set_once?: {
+    [k: string]: unknown
+  }
+  /**
+   * Merge a list into a list group property. Duplicates will be removed.
+   */
+  group_profile_properties_to_union?: {
+    /**
+     * The name of the list property to union values into.
+     */
+    list_name: string
+    /**
+     * An array of string values to merge into the list. Non string lists cannot be updated. Duplicates will be removed.
+     */
+    string_values: string[]
+  }[]
+}

package/src/group/index.ts

@@ -0,0 +1,29 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import type { Mixpanel } from '../types'
+import { sendGroup } from '../functions'
+import {
+  group_details,
+  group_profile_properties_to_set,
+  group_profile_properties_to_set_once,
+  group_profile_properties_to_union
+} from '../fields'
+
+const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
+  title: 'Group',
+  description: 'Sync Group data to Mixpanel.',
+  defaultSubscription: 'type = "group"',
+  platform: 'web',
+  fields: {
+    group_details,
+    group_profile_properties_to_set,
+    group_profile_properties_to_set_once,
+    group_profile_properties_to_union
+  },
+  perform: (mixpanel, { payload }) => {
+    sendGroup(mixpanel, payload)
+  }
+}
+
+export default action

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

@@ -0,0 +1,135 @@
+import { Analytics, Context } from '@segment/analytics-next'
+import { Subscription } from '@segment/browser-destination-runtime'
+import MixpanelDestination, { destination } from '../../index'
+import { Mixpanel } from '../../types'
+import { AUTOCAPTURE_OPTIONS, PERSISTENCE_OPTIONS } from '../../constants'
+import { Group } from '../../types'
+
+describe('Mixpanel.identify', () => {
+  const settings = {
+    projectToken: 'projectToken1',
+    name: 'name1',
+    default: 'https://api-js.mixpanel.com',
+    autocapture: AUTOCAPTURE_OPTIONS.ENABLED,
+    cross_subdomain_cookie: true,
+    persistence: PERSISTENCE_OPTIONS.COOKIE,
+    track_marketing: true,
+    cookie_expiration: 365,
+    disable_persistence: false,
+    ip: true,
+    record_block_class: 'mp-block',
+    record_block_selector: 'img, video, audio',
+    record_canvas: false,
+    record_heatmap_data: false,
+    record_idle_timeout_ms: 180_000,
+    record_mask_text_class: 'mp-mask',
+    record_mask_text_selector: '*',
+    record_max_ms: 86_400_000,
+    record_min_ms: 8_000,
+    record_sessions_percent: 0
+  }
+
+  let mockMPP: Mixpanel
+  let mockGroup: Group
+  let event: any
+
+  beforeEach(async () => {
+    jest.restoreAllMocks()
+    jest.spyOn(destination, 'initialize').mockImplementation(() => {
+      mockGroup = {
+        set: jest.fn(),
+        set_once: jest.fn(),
+        union: jest.fn()
+      }
+
+      mockMPP = {
+        init: jest.fn(),
+        track_pageview: jest.fn(),
+        track: jest.fn(),
+        identify: jest.fn(),
+        alias: jest.fn(),
+        get_group: jest.fn().mockReturnValue(mockGroup),
+        set_group: jest.fn(),
+        people: {
+          set: jest.fn(),
+          set_once: jest.fn(),
+          increment: jest.fn()
+        }
+      }
+      return Promise.resolve(mockMPP)
+    })
+  })
+
+  test('identify() handled correctly', async () => {
+    const subscriptions: Subscription[] = [
+      {
+        partnerAction: 'identify',
+        name: 'Identify',
+        enabled: true,
+        subscribe: 'type = "identify"',
+        mapping: {
+          unique_id: { '@path': '$.userId' },
+          user_profile_properties_to_set: {
+            name: { '@path': '$.traits.name' },
+            first_name: { '@path': '$.traits.first_name' },
+            last_name: { '@path': '$.traits.last_name' },
+            email: { '@path': '$.traits.email' },
+            phone: { '@path': '$.traits.phone' },
+            avatar: { '@path': '$.traits.avatar' },
+            created: { '@path': '$.traits.created' }
+          },
+          user_profile_properties_to_set_once: {
+            set_once_trait: { '@path': '$.traits.set_once_trait_1' }
+          },
+          user_profile_properties_to_increment: {
+            increment_property: { '@path': '$.traits.increment_property_1' }
+          }
+        }
+      }
+    ]
+
+    const context = new Context({
+      messageId: 'ajs-71f386523ee5dfa90c7d0fda28b6b5c6',
+      type: 'identify',
+      anonymousId: 'anonymousId',
+      userId: 'userId1',
+      traits: {
+        name: 'name1',
+        last_name: 'lastName1',
+        first_name: 'firstName1',
+        email: 'aaa@aaa.com',
+        phone: '+12345678900',
+        avatar: 'https://example.com/avatar.png',
+        created: '2020-01-01T00:05:02.010Z',
+        set_once_trait_1: 'set_once_value_1',
+        increment_property_1: 5
+      }
+    })
+
+    const [identifyEvent] = await MixpanelDestination({
+      ...settings,
+      subscriptions
+    })
+    event = identifyEvent
+
+    await event.load(Context.system(), {} as Analytics)
+    await event.identify?.(context)
+
+    expect(mockMPP.identify).toHaveBeenCalledWith('userId1')
+    expect(mockMPP.people.set).toHaveBeenCalledWith({
+      name: 'name1',
+      last_name: 'lastName1',
+      first_name: 'firstName1',
+      email: 'aaa@aaa.com',
+      phone: '+12345678900',
+      avatar: 'https://example.com/avatar.png',
+      created: '2020-01-01T00:05:02.010Z'
+    })
+    expect(mockMPP.people.set_once).toHaveBeenCalledWith({
+      set_once_trait: 'set_once_value_1'
+    })
+    expect(mockMPP.people.increment).toHaveBeenCalledWith({
+      increment_property: 5
+    })
+  })
+})