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

package/src/trackPageView/generated-types.ts

@@ -0,0 +1,102 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The name of the event to track in Mixpanel.
+   */
+  event_name?: string
+  /**
+   * Properties to associate with the event.
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The unique ID to associate with the user. Settings this value will trigger a Mixpanel identify call before immediately the page event is sent.
+   */
+  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
+  }
+  /**
+   * 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.
+   */
+  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/trackPageView/index.ts

@@ -0,0 +1,116 @@
+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, sendGroup } from '../functions'
+import {
+  event_name,
+  properties,
+  unique_id,
+  user_profile_properties_to_set,
+  user_profile_properties_to_set_once,
+  user_profile_properties_to_increment,
+  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: 'Track Page View',
+  description: 'Sync Segment page events to Mixpanel.',
+  defaultSubscription: 'type = "page"',
+  platform: 'web',
+  fields: {
+    event_name: {
+      ...event_name,
+      default: undefined,
+      required: false
+    },
+    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.',
+      default: undefined
+    },
+    user_profile_properties_to_set: {
+      ...user_profile_properties_to_set,
+      default: {
+        name: {
+          '@if': {
+            exists: { '@path': '$.context.traits.name' },
+            then: { '@path': '$.context.traits.name' },
+            else: { '@path': '$.properties.name' }
+          }
+        },
+        first_name: {
+          '@if': {
+            exists: { '@path': '$.context.traits.first_name' },
+            then: { '@path': '$.context.traits.first_name' },
+            else: { '@path': '$.properties.first_name' }
+          }
+        },
+        last_name: {
+          '@if': {
+            exists: { '@path': '$.context.traits.last_name' },
+            then: { '@path': '$.context.traits.last_name' },
+            else: { '@path': '$.properties.last_name' }
+          }
+        },
+        email: {
+          '@if': {
+            exists: { '@path': '$.context.traits.email' },
+            then: { '@path': '$.context.traits.email' },
+            else: { '@path': '$.properties.email' }
+          }
+        },
+        phone: {
+          '@if': {
+            exists: { '@path': '$.context.traits.phone' },
+            then: { '@path': '$.context.traits.phone' },
+            else: { '@path': '$.properties.phone' }
+          }
+        },
+        avatar: {
+          '@if': {
+            exists: { '@path': '$.context.traits.avatar' },
+            then: { '@path': '$.context.traits.avatar' },
+            else: { '@path': '$.properties.avatar' }
+          }
+        },
+        created: {
+          '@if': {
+            exists: { '@path': '$.context.traits.created_at' },
+            then: { '@path': '$.context.traits.created_at' },
+            else: { '@path': '$.properties.created_at' }
+          }
+        }
+      }
+    },
+    user_profile_properties_to_set_once,
+    user_profile_properties_to_increment,
+    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.',
+      default: undefined
+    },
+    group_profile_properties_to_set,
+    group_profile_properties_to_set_once,
+    group_profile_properties_to_union
+  },
+  perform: (mixpanel, { payload }) => {
+    sendIdentify(mixpanel, payload)
+    sendGroup(mixpanel, payload)
+    const { event_name, properties = {} } = payload
+    if (event_name) {
+      mixpanel.track_pageview(properties || {}, { event_name })
+    } else {
+      mixpanel.track_pageview(properties || {})
+    }
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,78 @@
+import { PAGE_VIEW_URL_CONFIG_OPTIONS, PERSISTENCE_OPTIONS, AUTOCAPTURE_OPTIONS } from './constants'
+
+export type PageViewUrlConfigOption = typeof PAGE_VIEW_URL_CONFIG_OPTIONS[keyof typeof PAGE_VIEW_URL_CONFIG_OPTIONS]
+
+export type PersistenceOptions = typeof PERSISTENCE_OPTIONS[keyof typeof PERSISTENCE_OPTIONS]
+
+export type AutocaptureOptions = typeof AUTOCAPTURE_OPTIONS[keyof typeof AUTOCAPTURE_OPTIONS]
+
+export interface Mixpanel {
+  init(token: string, config: Config, name?: string): Mixpanel
+
+  track_pageview(
+    properties?: {
+      [k: string]: unknown
+    },
+    options?: { event_name?: string | undefined }
+  ): void
+
+  track(
+    event_name: string,
+    properties?: {
+      [k: string]: unknown
+    }
+  ): void
+
+  identify(unique_id?: string): void
+
+  alias(alias: string, original?: string): void
+
+  get_group(group_key: string, group_id: string): Group
+
+  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
+}
+
+export interface Group {
+  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
+  cross_subdomain_cookie?: boolean
+  persistence?: PersistenceOptions
+  track_marketing?: boolean
+  cookie_expiration?: number
+  disable_persistence?: boolean
+  ip?: boolean
+  record_block_class?: string
+  record_block_selector?: string
+  record_canvas?: boolean
+  record_heatmap_data?: boolean
+  record_idle_timeout_ms?: number
+  record_mask_text_class?: string
+  record_mask_text_selectors?: string
+  record_max_ms?: number
+  record_min_ms?: number
+  record_sessions_percent?: number
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "baseUrl": "."
+  },
+  "include": ["src"],
+  "exclude": ["dist", "**/__tests__"]
+}