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

package/src/fields.ts

@@ -1,173 +1,170 @@
 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' }
+    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 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' }
+    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'
+    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'
+        }
     },
-    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' }
     }
-  },
-  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'
+    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 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: {
+    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'
+        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'
+        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' }
     }
-  },
-  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'
+    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'
+    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
+    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

@@ -5,14 +5,14 @@ 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,
+  const { 
+    unique_id, 
     user_profile_properties_to_set,
     user_profile_properties_to_set_once,
     user_profile_properties_to_increment
   } = payload
 
-  if (unique_id) {
+  if(unique_id) {
     mixpanel.identify(unique_id)
   }
 
@@ -30,9 +30,9 @@ export function sendIdentify(mixpanel: Mixpanel, payload: IdentifyPayload | Trac
 }
 
 export function sendGroup(mixpanel: Mixpanel, payload: GroupPayload | TrackPayload | TrackPageViewPayload) {
-  const {
+  const { 
     group_details: { group_key, group_id } = {},
-    group_profile_properties_to_set,
+    group_profile_properties_to_set, 
     group_profile_properties_to_set_once,
     group_profile_properties_to_union
   } = payload
@@ -49,9 +49,12 @@ export function sendGroup(mixpanel: Mixpanel, payload: GroupPayload | TrackPaylo
     }
     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
+        const {
+          list_name,
+          string_values
+        } = item
         group.union(list_name, string_values)
       })
     }
   }
-}
+}

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

@@ -36,6 +36,7 @@ describe('Mixpanel.group', () => {
   beforeEach(async () => {
     jest.restoreAllMocks()
     jest.spyOn(destination, 'initialize').mockImplementation(() => {
+
       mockGroup = {
         set: jest.fn(),
         set_once: jest.fn(),
@@ -69,15 +70,15 @@ describe('Mixpanel.group', () => {
         subscribe: 'type = "group"',
         mapping: {
           group_details: {
-            group_key: { '@path': '$.traits.group_key' },
-            group_id: { '@path': '$.groupId' }
+              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: { 
+              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' }
+              set_once_trait: { '@path': '$.traits.set_once_trait_1' },
           },
           group_profile_properties_to_union: { '@path': '$.traits.union_properties' }
         }

package/src/group/index.ts

@@ -3,8 +3,8 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 import type { Mixpanel } from '../types'
 import { sendGroup } from '../functions'
-import {
-  group_details,
+import { 
+  group_details, 
   group_profile_properties_to_set,
   group_profile_properties_to_set_once,
   group_profile_properties_to_union

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

@@ -36,6 +36,7 @@ describe('Mixpanel.identify', () => {
   beforeEach(async () => {
     jest.restoreAllMocks()
     jest.spyOn(destination, 'initialize').mockImplementation(() => {
+
       mockGroup = {
         set: jest.fn(),
         set_once: jest.fn(),
@@ -68,21 +69,21 @@ describe('Mixpanel.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' }
+          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' }
+              set_once_trait: { '@path': '$.traits.set_once_trait_1' },
           },
           user_profile_properties_to_increment: {
-            increment_property: { '@path': '$.traits.increment_property_1' }
+              increment_property: { '@path': '$.traits.increment_property_1' }
           }
         }
       }
@@ -115,7 +116,7 @@ describe('Mixpanel.identify', () => {
     await event.load(Context.system(), {} as Analytics)
     await event.identify?.(context)
 
-    expect(mockMPP.identify).toHaveBeenCalledWith('userId1')
+    expect(mockMPP.identify).toHaveBeenCalledWith("userId1")
     expect(mockMPP.people.set).toHaveBeenCalledWith({
       name: 'name1',
       last_name: 'lastName1',

package/src/identify/index.ts

@@ -3,8 +3,8 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 import type { Mixpanel } from '../types'
 import { sendIdentify } from '../functions'
-import {
-  unique_id,
+import { 
+  unique_id, 
   user_profile_properties_to_set,
   user_profile_properties_to_set_once,
   user_profile_properties_to_increment
@@ -16,7 +16,7 @@ const action: BrowserActionDefinition<Settings, Mixpanel, Payload> = {
   defaultSubscription: 'type = "identify"',
   platform: 'web',
   fields: {
-    unique_id,
+    unique_id, 
     user_profile_properties_to_set,
     user_profile_properties_to_set_once,
     user_profile_properties_to_increment

package/src/index.ts

@@ -72,20 +72,20 @@ export const destination: BrowserDestinationDefinition<Settings, Mixpanel> = {
     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'
-    }
+      {
+          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,

package/src/init-script.ts

@@ -1,63 +1,5 @@
 /* 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 || [])
-}
+    (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 || []);
+}