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

package/src/identify/generated-types.ts

@@ -0,0 +1,54 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The unique ID to associate with the user.
+   */
+  unique_id: string
+  /**
+   * User Profile Properties to set on the user profile in Mixpanel.
+   */
+  user_profile_properties_to_set?: {
+    /**
+     * The name of the user.
+     */
+    name?: string
+    /**
+     * The first name of the user.
+     */
+    first_name?: string
+    /**
+     * The last name of the user.
+     */
+    last_name?: string
+    /**
+     * The email of the user.
+     */
+    email?: string
+    /**
+     * The phone number of the user.
+     */
+    phone?: string
+    /**
+     * The avatar URL of the user.
+     */
+    avatar?: string
+    /**
+     * The creation date of the user profile.
+     */
+    created?: string
+    [k: string]: unknown
+  }
+  /**
+   * User Profile Properties to set once on the user profile in Mixpanel. Values which get set once cannot be overwritten later.
+   */
+  user_profile_properties_to_set_once?: {
+    [k: string]: unknown
+  }
+  /**
+   * User Profile Properties to increment on the user profile in Mixpanel. Values must be numeric.
+   */
+  user_profile_properties_to_increment?: {
+    [k: string]: unknown
+  }
+}

package/src/identify/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 { sendIdentify } from '../functions'
+import {
+  unique_id,
+  user_profile_properties_to_set,
+  user_profile_properties_to_set_once,
+  user_profile_properties_to_increment
+} from '../fields'
+
+const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
+  title: 'Identify',
+  description: 'Sync user profile data to Mixpanel.',
+  defaultSubscription: 'type = "identify"',
+  platform: 'web',
+  fields: {
+    unique_id,
+    user_profile_properties_to_set,
+    user_profile_properties_to_set_once,
+    user_profile_properties_to_increment
+  },
+  perform: (mixpanel, { payload }) => {
+    sendIdentify(mixpanel, payload)
+  }
+}
+
+export default action

package/src/index.ts

@@ -0,0 +1,99 @@
+import type { Settings } from './generated-types'
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types'
+import { browserDestination } from '@segment/browser-destination-runtime/shim'
+import type { Mixpanel, PageViewUrlConfigOption, PersistenceOptions, Config } from './types'
+import { defaultValues } from '@segment/actions-core'
+import { AUTOCAPTURE_OPTIONS } from './constants'
+import { settingFields } from './setting-fields'
+import track from './track'
+import trackPageView from './trackPageView'
+import identify from './identify'
+import group from './group'
+import alias from './alias'
+import { initScript } from './init-script'
+declare global {
+  interface Window {
+    mixpanel: Mixpanel
+  }
+}
+
+// Switch from unknown to the partner SDK client types
+export const destination: BrowserDestinationDefinition<Settings, Mixpanel> = {
+  name: 'Mixpanel Web (actions)',
+  slug: 'mixpanel-web-actions',
+  mode: 'device',
+  settings: settingFields,
+  initialize: async ({ settings }, deps) => {
+    await initScript()
+    await deps.resolveWhen(() => window?.mixpanel != null, 100)
+    const mixpanel = window.mixpanel
+
+    const {
+      projectToken,
+      name,
+      autocapture,
+      pageview,
+      click,
+      dead_click,
+      input,
+      rage_click,
+      scroll,
+      submit,
+      capture_text_content,
+      persistence,
+      ...rest
+    } = settings
+
+    const config: Config = {
+      autocapture:
+        autocapture === AUTOCAPTURE_OPTIONS.CUSTOM
+          ? {
+              pageview: pageview as PageViewUrlConfigOption,
+              click,
+              dead_click,
+              input,
+              rage_click,
+              scroll,
+              submit,
+              capture_text_content
+            }
+          : autocapture === AUTOCAPTURE_OPTIONS.ENABLED
+          ? true
+          : false,
+      persistence: persistence as PersistenceOptions,
+      ...rest
+    }
+
+    if (name) {
+      mixpanel.init(projectToken, config, name)
+    } else {
+      mixpanel.init(projectToken, config)
+    }
+    return mixpanel
+  },
+  presets: [
+    {
+      name: 'Track',
+      subscribe: 'type = "track"',
+      partnerAction: 'track',
+      mapping: defaultValues(track.fields),
+      type: 'automatic'
+    },
+    {
+      name: 'Identify',
+      subscribe: 'type = "identify"',
+      partnerAction: 'identify',
+      mapping: defaultValues(identify.fields),
+      type: 'automatic'
+    }
+  ],
+  actions: {
+    track,
+    trackPageView,
+    identify,
+    group,
+    alias
+  }
+}
+
+export default browserDestination(destination)

package/src/init-script.ts

@@ -0,0 +1,63 @@
+/* eslint-disable */
+// @ts-nocheck
+export async function initScript() {
+  ;(function (f, b) {
+    if (!b.__SV) {
+      var e, g, i, h
+      window.mixpanel = b
+      b._i = []
+      b.init = function (e, f, c) {
+        function g(a, d) {
+          var b = d.split('.')
+          2 == b.length && ((a = a[b[0]]), (d = b[1]))
+          a[d] = function () {
+            a.push([d].concat(Array.prototype.slice.call(arguments, 0)))
+          }
+        }
+        var a = b
+        'undefined' !== typeof c ? (a = b[c] = []) : (c = 'mixpanel')
+        a.people = a.people || []
+        a.toString = function (a) {
+          var d = 'mixpanel'
+          'mixpanel' !== c && (d += '.' + c)
+          a || (d += ' (stub)')
+          return d
+        }
+        a.people.toString = function () {
+          return a.toString(1) + '.people (stub)'
+        }
+        i =
+          'disable time_event track track_pageview track_links track_forms track_with_groups add_group set_group remove_group register register_once alias unregister identify name_tag set_config reset opt_in_tracking opt_out_tracking has_opted_in_tracking has_opted_out_tracking clear_opt_in_out_tracking start_batch_senders people.set people.set_once people.unset people.increment people.append people.union people.track_charge people.clear_charges people.delete_user people.remove'.split(
+            ' '
+          )
+        for (h = 0; h < i.length; h++) g(a, i[h])
+        var j = 'set set_once union unset remove delete'.split(' ')
+        a.get_group = function () {
+          function b(c) {
+            d[c] = function () {
+              call2_args = arguments
+              call2 = [c].concat(Array.prototype.slice.call(call2_args, 0))
+              a.push([e, call2])
+            }
+          }
+          for (var d = {}, e = ['get_group'].concat(Array.prototype.slice.call(arguments, 0)), c = 0; c < j.length; c++)
+            b(j[c])
+          return d
+        }
+        b._i.push([e, f, c])
+      }
+      b.__SV = 1.2
+      e = f.createElement('script')
+      e.type = 'text/javascript'
+      e.async = !0
+      e.src =
+        'undefined' !== typeof MIXPANEL_CUSTOM_LIB_URL
+          ? MIXPANEL_CUSTOM_LIB_URL
+          : 'file:' === f.location.protocol && '//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js'.match(/^\/\//)
+          ? 'https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js'
+          : '//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js'
+      g = f.getElementsByTagName('script')[0]
+      g.parentNode.insertBefore(e, g)
+    }
+  })(document, window.mixpanel || [])
+}

package/src/setting-fields.ts

@@ -0,0 +1,273 @@
+import { PAGE_VIEW_URL_CONFIG_OPTIONS, PERSISTENCE_OPTIONS, AUTOCAPTURE_OPTIONS } from './constants'
+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'
+        }
+      ]
+    }
+  },
+  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'
+        }
+      ]
+    }
+  },
+  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'
+        }
+      ]
+    }
+  },
+  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'
+        }
+      ]
+    }
+  },
+  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
+  }
+}