@segment/analytics-browser-actions-tiktok-pixel 1.94.1-staging-108b283de.0 → 1.95.0

package/src/{common_fields.ts → fields/common_fields.ts}

@@ -1,21 +1,6 @@
 import { InputField } from '@segment/actions-core'
 
-export const commonFields: Record<string, InputField> = {
-  event: {
-    label: 'Event Name',
-    type: 'string',
-    required: true,
-    description:
-      'Conversion event name. Please refer to the "Supported Web Events" section on in TikTok’s [Pixel SDK documentation](https://business-api.tiktok.com/portal/docs?id=1739585696931842) for accepted event names.'
-  },
-  event_id: {
-    label: 'Event ID',
-    type: 'string',
-    description: 'Any hashed ID that can identify a unique user/session.',
-    default: {
-      '@path': '$.messageId'
-    }
-  },
+export const common_fields: Record<string, InputField> = {
   phone_number: {
     label: 'Phone Number',
     description:
@@ -127,22 +112,6 @@ export const commonFields: Record<string, InputField> = {
       }
     }
   },
-  order_id: {
-    label: 'Order ID',
-    type: 'string',
-    description: 'Order ID of the transaction.',
-    default: {
-      '@path': '$.properties.order_id'
-    }
-  },
-  shop_id: {
-    label: 'Shop ID',
-    type: 'string',
-    description: 'Shop ID of the transaction.',
-    default: {
-      '@path': '$.properties.shop_id'
-    }
-  },
   external_id: {
     label: 'External ID',
     description:
@@ -156,87 +125,5 @@ export const commonFields: Record<string, InputField> = {
         else: { '@path': '$.anonymousId' }
       }
     }
-  },
-  contents: {
-    label: 'Contents',
-    type: 'object',
-    multiple: true,
-    description: 'Related item details for the event.',
-    properties: {
-      price: {
-        label: 'Price',
-        description: 'Price of the item.',
-        type: 'number'
-      },
-      quantity: {
-        label: 'Quantity',
-        description: 'Number of items.',
-        type: 'number'
-      },
-      content_category: {
-        label: 'Content Category',
-        description: 'Category of the product item.',
-        type: 'string'
-      },
-      content_id: {
-        label: 'Content ID',
-        description: 'ID of the product item.',
-        type: 'string'
-      },
-      content_name: {
-        label: 'Content Name',
-        description: 'Name of the product item.',
-        type: 'string'
-      },
-      brand: {
-        label: 'Brand',
-        description: 'Brand name of the product item.',
-        type: 'string'
-      }
-    }
-  },
-  content_type: {
-    label: 'Content Type',
-    description:
-      'Type of the product item. When the `content_id` in the `Contents` field is specified as a `sku_id`, set this field to `product`. When the `content_id` in the `Contents` field is specified as an `item_group_id`, set this field to `product_group`.',
-    type: 'string',
-    choices: [
-      { label: 'product', value: 'product' },
-      { label: 'product_group', value: 'product_group' }
-    ],
-    default: 'product'
-  },
-  currency: {
-    label: 'Currency',
-    type: 'string',
-    description: 'Currency for the value specified as ISO 4217 code.',
-    default: {
-      '@path': '$.properties.currency'
-    }
-  },
-  value: {
-    label: 'Value',
-    type: 'number',
-    description: 'Value of the order or items sold.',
-    default: {
-      '@if': {
-        exists: { '@path': '$.properties.value' },
-        then: { '@path': '$.properties.value' },
-        else: { '@path': '$.properties.revenue' }
-      }
-    }
-  },
-  description: {
-    label: 'Description',
-    type: 'string',
-    description: 'A string description of the web event.'
-  },
-  query: {
-    label: 'Query',
-    type: 'string',
-    description: 'The text string that was searched for.',
-    default: {
-      '@path': '$.properties.query'
-    }
   }
 }

package/src/identify/generated-types.ts

@@ -1,14 +1,6 @@
 // Generated file. DO NOT MODIFY IT BY HAND.
 
 export interface Payload {
-  /**
-   * Conversion event name. Please refer to the "Supported Web Events" section on in TikTok’s [Pixel SDK documentation](https://business-api.tiktok.com/portal/docs?id=1739585696931842) for accepted event names.
-   */
-  event: string
-  /**
-   * Any hashed ID that can identify a unique user/session.
-   */
-  event_id?: string
   /**
    * A single phone number in E.164 standard format. TikTok Pixel will hash this value before sending to TikTok. e.g. +14150000000. Segment will hash this value before sending to TikTok.
    */
@@ -46,65 +38,8 @@ export interface Payload {
      */
     state?: string
   }
-  /**
-   * Order ID of the transaction.
-   */
-  order_id?: string
-  /**
-   * Shop ID of the transaction.
-   */
-  shop_id?: string
   /**
    * Uniquely identifies the user who triggered the conversion event. TikTok Pixel will hash this value before sending to TikTok.
    */
   external_id?: string[]
-  /**
-   * Related item details for the event.
-   */
-  contents?: {
-    /**
-     * Price of the item.
-     */
-    price?: number
-    /**
-     * Number of items.
-     */
-    quantity?: number
-    /**
-     * Category of the product item.
-     */
-    content_category?: string
-    /**
-     * ID of the product item.
-     */
-    content_id?: string
-    /**
-     * Name of the product item.
-     */
-    content_name?: string
-    /**
-     * Brand name of the product item.
-     */
-    brand?: string
-  }[]
-  /**
-   * Type of the product item. When the `content_id` in the `Contents` field is specified as a `sku_id`, set this field to `product`. When the `content_id` in the `Contents` field is specified as an `item_group_id`, set this field to `product_group`.
-   */
-  content_type?: string
-  /**
-   * Currency for the value specified as ISO 4217 code.
-   */
-  currency?: string
-  /**
-   * Value of the order or items sold.
-   */
-  value?: number
-  /**
-   * A string description of the web event.
-   */
-  description?: string
-  /**
-   * The text string that was searched for.
-   */
-  query?: string
 }

package/src/identify/index.ts

@@ -1,9 +1,9 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import { formatPhone, handleArrayInput, formatString, formatAddress } from '../formatter'
+import { getUser } from '../utils'
 import { TikTokPixel } from '../types'
-import { commonFields } from '../common_fields'
+import { common_fields } from '../fields/common_fields'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, TikTokPixel, Payload> = {
@@ -13,25 +13,25 @@ const action: BrowserActionDefinition<Settings, TikTokPixel, Payload> = {
   defaultSubscription: 'type = "identify"',
   platform: 'web',
   fields: {
-    ...commonFields,
+    ...common_fields,
     phone_number: {
-      ...commonFields.phone_number,
+      ...common_fields.phone_number,
       default: { '@path': '$.traits.phone' }
     },
     email: {
-      ...commonFields.email,
+      ...common_fields.email,
       default: { '@path': '$.traits.email' }
     },
     first_name: {
-      ...commonFields.first_name,
+      ...common_fields.first_name,
       default: { '@path': '$.traits.first_name' }
     },
     last_name: {
-      ...commonFields.last_name,
+      ...common_fields.last_name,
       default: { '@path': '$.traits.last_name' }
     },
     address: {
-      ...commonFields.address,
+      ...common_fields.address,
       default: {
         city: { '@path': '$.traits.address.city' },
         country: { '@path': '$.traits.address.country' },
@@ -40,19 +40,9 @@ const action: BrowserActionDefinition<Settings, TikTokPixel, Payload> = {
       }
     }
   },
-  perform: (ttq, { payload }) => {
+  perform: (ttq, { payload, settings }) => {
     if (payload.email || payload.phone_number || payload.external_id) {
-      ttq.identify({
-        email: handleArrayInput(payload.email),
-        phone_number: formatPhone(handleArrayInput(payload.phone_number)),
-        external_id: handleArrayInput(payload.external_id),
-        first_name: formatString(payload.first_name),
-        last_name: formatString(payload.last_name),
-        city: formatAddress(payload.address?.city),
-        state: formatAddress(payload.address?.state),
-        country: formatAddress(payload.address?.country),
-        zip_code: formatString(payload.address?.zip_code)
-      })
+      ttq.instance(settings.pixelCode).identify(getUser(payload))
     }
   }
 }