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

package/dist/cjs/types.d.ts

@@ -1,34 +1,90 @@
 export interface TikTokPixel {
     page: () => void;
     instance: (pixel_code: string) => TikTokPixel;
-    identify: ({ email, phone_number, external_id, first_name, last_name, city, state, country, zip_code }: {
-        email: string | undefined;
-        phone_number: string | undefined;
-        external_id: string | undefined;
-        first_name: string | undefined;
-        last_name: string | undefined;
-        city: string | undefined;
-        state: string | undefined;
-        country: string | undefined;
-        zip_code: string | undefined;
-    }) => void;
-    track: (event: string, { contents, content_type, currency, value, description, query, order_id, shop_id }: {
-        contents: {
-            price?: number | undefined;
-            quantity?: number | undefined;
-            content_category?: string | undefined;
-            content_id?: string | undefined;
-            content_name?: string | undefined;
-            brand?: string | undefined;
-        }[] | [];
-        content_type: string | undefined;
-        currency: string | undefined;
-        value: number | undefined;
-        description: string | undefined;
-        query: string | undefined;
-        order_id: string | undefined;
-        shop_id: string | undefined;
-    }, { event_id }: {
-        event_id: string | undefined;
+    identify: (user: TTUser) => void;
+    track: (event: string, { ...props }: TTBaseProps & TTTravelProps & TTAutoProps, { event_id }: {
+        event_id?: string;
     }) => void;
 }
+export interface TTUser {
+    external_id: string;
+    phone_number: string | undefined;
+    email: string;
+    locale?: string;
+    first_name?: string;
+    last_name?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    zip_code?: string;
+}
+export interface TTBaseProps {
+    contents: TTContentItem[];
+    content_type?: string;
+    currency?: string;
+    value?: number;
+    query?: string;
+    description?: string;
+    order_id?: string;
+    shop_id?: string;
+    content_ids?: string[];
+    num_items?: number;
+    search_string?: string;
+}
+export interface TTTravelProps {
+    city?: string;
+    region?: string;
+    country?: string;
+    checkin_date?: string;
+    checkout_date?: string;
+    num_adults?: number;
+    num_children?: number;
+    num_infants?: number;
+    suggested_hotels?: string[];
+    departing_departure_date?: string;
+    returning_departure_date?: string;
+    origin_airport?: string;
+    destination_airiport?: string;
+    destination_ids?: string[];
+    departing_arrival_date?: string;
+    returning_arrival_date?: string;
+    travel_class?: string;
+    user_score?: number;
+    preferred_num_stops?: number;
+    travel_start?: string;
+    travel_end?: string;
+    suggested_destinations?: string[];
+}
+export interface TTAutoProps {
+    postal_code?: string;
+    make?: string;
+    model?: string;
+    year?: number;
+    state_of_vehicle?: string;
+    mileage?: {
+        value?: number;
+        unit?: string;
+    };
+    exterior_color?: string;
+    transmission?: string;
+    body_style?: string;
+    fuel_type?: string;
+    drivetrain?: string;
+    preferred_price_range?: number[];
+    trim?: string;
+    vin?: string;
+    interior_color?: string;
+    condition_of_vehicle?: string;
+    viewcontent_type?: string;
+    search_type?: string;
+    registration_type?: string;
+}
+interface TTContentItem {
+    price?: number;
+    quantity?: number;
+    content_category?: string;
+    content_id?: string;
+    content_name?: string;
+    brand?: string;
+}
+export {};

package/dist/cjs/utils.d.ts

@@ -0,0 +1,4 @@
+import { Payload as IdentifyPayload } from './identify/generated-types';
+import { Payload as TrackPayload } from './reportWebEvent/generated-types';
+import { TTUser } from './types';
+export declare function getUser(payload: IdentifyPayload | TrackPayload): TTUser;

package/dist/cjs/utils.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUser = getUser;
+const formatter_1 = require("./formatter");
+function getUser(payload) {
+    return {
+        email: (0, formatter_1.handleArrayInput)(payload.email),
+        phone_number: (0, formatter_1.formatPhone)((0, formatter_1.handleArrayInput)(payload.phone_number)),
+        external_id: (0, formatter_1.handleArrayInput)(payload.external_id),
+        first_name: (0, formatter_1.formatString)(payload.first_name),
+        last_name: (0, formatter_1.formatString)(payload.last_name),
+        city: (0, formatter_1.formatAddress)(payload.address?.city),
+        state: (0, formatter_1.formatAddress)(payload.address?.state),
+        country: (0, formatter_1.formatAddress)(payload.address?.country),
+        zip_code: (0, formatter_1.formatString)(payload.address?.zip_code)
+    };
+}
+//# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;AAKA,0BAYC;AAfD,2CAAwF;AAGxF,SAAgB,OAAO,CAAC,OAAuC;IAC7D,OAAO;QACL,KAAK,EAAE,IAAA,4BAAgB,EAAC,OAAO,CAAC,KAAK,CAAC;QACtC,YAAY,EAAE,IAAA,uBAAW,EAAC,IAAA,4BAAgB,EAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACjE,WAAW,EAAE,IAAA,4BAAgB,EAAC,OAAO,CAAC,WAAW,CAAC;QAClD,UAAU,EAAE,IAAA,wBAAY,EAAC,OAAO,CAAC,UAAU,CAAC;QAC5C,SAAS,EAAE,IAAA,wBAAY,EAAC,OAAO,CAAC,SAAS,CAAC;QAC1C,IAAI,EAAE,IAAA,yBAAa,EAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;QAC1C,KAAK,EAAE,IAAA,yBAAa,EAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;QAC5C,OAAO,EAAE,IAAA,yBAAa,EAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC;QAChD,QAAQ,EAAE,IAAA,wBAAY,EAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC;KAClD,CAAA;AACH,CAAC"}

package/dist/esm/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const VEHICLE_FIELDS = "vehicle_fields";
+export declare const TRAVEL_FIELDS = "travel_fields";

package/dist/esm/constants.js

@@ -0,0 +1,3 @@
+export const VEHICLE_FIELDS = 'vehicle_fields';
+export const TRAVEL_FIELDS = 'travel_fields';
+//# sourceMappingURL=constants.js.map

package/dist/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAA;AAC9C,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAA"}

package/dist/esm/fields/common_fields.d.ts

@@ -0,0 +1,2 @@
+import { InputField } from '@segment/actions-core';
+export declare const common_fields: Record<string, InputField>;

package/dist/esm/{common_fields.js → fields/common_fields.js}

@@ -1,18 +1,4 @@
-export const commonFields = {
-    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 = {
     phone_number: {
         label: 'Phone Number',
         description: '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.',
@@ -121,22 +107,6 @@ export const commonFields = {
             }
         }
     },
-    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: 'Uniquely identifies the user who triggered the conversion event. TikTok Pixel will hash this value before sending to TikTok.',
@@ -149,87 +119,6 @@ export const commonFields = {
                 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'
-        }
     }
 };
 //# sourceMappingURL=common_fields.js.map

package/dist/esm/fields/common_fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common_fields.js","sourceRoot":"","sources":["../../../src/fields/common_fields.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAA+B;IACvD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,uLAAuL;QACzL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC5C;SACF;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,WAAW,EAAE,wFAAwF;QACrG,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC5C;SACF;KACF;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,WAAW,EACT,0HAA0H;QAC5H,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;gBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;gBAC5C,IAAI,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE;aACjD;SACF;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE,WAAW;QAClB,WAAW,EACT,yHAAyH;QAC3H,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC7C,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE;aAChD;SACF;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sBAAsB;aACpC;YACD,OAAO,EAAE;gBACP,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yBAAyB;aACvC;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0BAA0B;aACxC;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uBAAuB;aACrC;SACF;QACD,OAAO,EAAE;YACP,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;oBAChD,IAAI,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;oBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE;iBACnD;aACF;YACD,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE;oBACnD,IAAI,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE;oBACjD,IAAI,EAAE,EAAE,OAAO,EAAE,kCAAkC,EAAE;iBACtD;aACF;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,kCAAkC,EAAE;oBACvD,IAAI,EAAE,EAAE,OAAO,EAAE,kCAAkC,EAAE;oBACrD,IAAI,EAAE,EAAE,OAAO,EAAE,sCAAsC,EAAE;iBAC1D;aACF;YACD,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE;oBACjD,IAAI,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE;oBAC/C,IAAI,EAAE,EAAE,OAAO,EAAE,gCAAgC,EAAE;iBACpD;aACF;SACF;KACF;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,8HAA8H;QAChI,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;aACnC;SACF;KACF;CACF,CAAA"}

package/dist/esm/identify/generated-types.d.ts

@@ -1,6 +1,4 @@
 export interface Payload {
-    event: string;
-    event_id?: string;
     phone_number?: string[];
     email?: string[];
     first_name?: string;
@@ -11,20 +9,5 @@ export interface Payload {
         zip_code?: string;
         state?: string;
     };
-    order_id?: string;
-    shop_id?: string;
     external_id?: string[];
-    contents?: {
-        price?: number;
-        quantity?: number;
-        content_category?: string;
-        content_id?: string;
-        content_name?: string;
-        brand?: string;
-    }[];
-    content_type?: string;
-    currency?: string;
-    value?: number;
-    description?: string;
-    query?: string;
 }

package/dist/esm/identify/index.js

@@ -1,30 +1,30 @@
-import { formatPhone, handleArrayInput, formatString, formatAddress } from '../formatter';
-import { commonFields } from '../common_fields';
+import { getUser } from '../utils';
+import { common_fields } from '../fields/common_fields';
 const action = {
     title: 'Identify',
     description: 'Use a Segment identify() call to sent PII data to TikTok Pixel. Note that the PII information will be sent with the next track() call.',
     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' },
@@ -33,19 +33,9 @@ const action = {
             }
         }
     },
-    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));
         }
     }
 };

package/dist/esm/identify/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identify/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEzF,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAG/C,MAAM,MAAM,GAA4D;IACtE,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,wIAAwI;IAC1I,mBAAmB,EAAE,mBAAmB;IACxC,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,GAAG,YAAY;QACf,YAAY,EAAE;YACZ,GAAG,YAAY,CAAC,YAAY;YAC5B,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACvC;QACD,KAAK,EAAE;YACL,GAAG,YAAY,CAAC,KAAK;YACrB,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACvC;QACD,UAAU,EAAE;YACV,GAAG,YAAY,CAAC,UAAU;YAC1B,OAAO,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;SAC5C;QACD,SAAS,EAAE;YACT,GAAG,YAAY,CAAC,SAAS;YACzB,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;SAC3C;QACD,OAAO,EAAE;YACP,GAAG,YAAY,CAAC,OAAO;YACvB,OAAO,EAAE;gBACP,IAAI,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;gBAC1C,OAAO,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE;gBAChD,QAAQ,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE;gBACrD,KAAK,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC7C;SACF;KACF;IACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAC5B,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACjE,GAAG,CAAC,QAAQ,CAAC;gBACX,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC;gBACtC,YAAY,EAAE,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACjE,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC;gBAClD,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;gBAC5C,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC;gBAC1C,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;gBAC1C,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;gBAC5C,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC;gBAChD,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC;aAClD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identify/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAGvD,MAAM,MAAM,GAA4D;IACtE,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,wIAAwI;IAC1I,mBAAmB,EAAE,mBAAmB;IACxC,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,GAAG,aAAa;QAChB,YAAY,EAAE;YACZ,GAAG,aAAa,CAAC,YAAY;YAC7B,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACvC;QACD,KAAK,EAAE;YACL,GAAG,aAAa,CAAC,KAAK;YACtB,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACvC;QACD,UAAU,EAAE;YACV,GAAG,aAAa,CAAC,UAAU;YAC3B,OAAO,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;SAC5C;QACD,SAAS,EAAE;YACT,GAAG,aAAa,CAAC,SAAS;YAC1B,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;SAC3C;QACD,OAAO,EAAE;YACP,GAAG,aAAa,CAAC,OAAO;YACxB,OAAO,EAAE;gBACP,IAAI,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;gBAC1C,OAAO,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE;gBAChD,QAAQ,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE;gBACrD,KAAK,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC7C;SACF;KACF;IACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QACtC,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACjE,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/esm/reportWebEvent/fields.d.ts

@@ -0,0 +1,2 @@
+import { InputField } from '@segment/actions-core';
+export declare const track_fields: Record<string, InputField>;

package/dist/esm/reportWebEvent/fields.js

@@ -0,0 +1,158 @@
+import { VEHICLE_FIELDS, TRAVEL_FIELDS } from '../constants';
+export const track_fields = {
+    event_spec_type: {
+        label: 'Additional Fields',
+        type: 'string',
+        description: 'Include fields for travel or vehicle events.',
+        choices: [
+            { value: TRAVEL_FIELDS, label: 'Travel Fields' },
+            { value: VEHICLE_FIELDS, label: 'Vehicle Fields' }
+        ]
+    },
+    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'
+        }
+    },
+    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'
+        }
+    },
+    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_ids: {
+        label: 'Content IDs',
+        description: "Product IDs associated with the event, such as SKUs. Do not populate this field if the 'Contents' field is populated. This field accepts a single string value or an array of string values.",
+        type: 'string',
+        multiple: true,
+        default: {
+            '@path': '$.properties.content_ids'
+        }
+    },
+    num_items: {
+        label: 'Number of Items',
+        type: 'number',
+        description: 'Number of items when checkout was initiated. Used with the InitiateCheckout event.',
+        default: {
+            '@path': '$.properties.num_items'
+        }
+    },
+    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'
+        }
+    },
+    search_string: {
+        label: 'Search String',
+        type: 'string',
+        description: 'The text string entered by the user for the search. Optionally used with the Search event.',
+        default: {
+            '@path': '$.properties.search_string'
+        },
+        depends_on: {
+            conditions: [
+                {
+                    fieldKey: 'event',
+                    operator: 'is',
+                    value: 'Search'
+                }
+            ]
+        }
+    }
+};
+//# sourceMappingURL=fields.js.map

package/dist/esm/reportWebEvent/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../src/reportWebEvent/fields.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAE5D,MAAM,CAAC,MAAM,YAAY,GAA+B;IACpD,eAAe,EAAE;QACb,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE;YACT,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE;YAChD,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,gBAAgB,EAAE;SACjD;KACJ;IACD,KAAK,EAAE;QACH,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EACX,+MAA+M;KAClN;IACD,QAAQ,EAAE;QACN,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wDAAwD;QACrE,OAAO,EAAE;YACT,OAAO,EAAE,aAAa;SACrB;KACJ;IACD,QAAQ,EAAE;QACN,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE;YACT,OAAO,EAAE,uBAAuB;SAC/B;KACJ;IACD,OAAO,EAAE;QACL,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE;YACT,OAAO,EAAE,sBAAsB;SAC9B;KACJ;IACD,QAAQ,EAAE;QACN,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,qCAAqC;QAClD,UAAU,EAAE;YACZ,KAAK,EAAE;gBACH,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,oBAAoB;gBACjC,IAAI,EAAE,QAAQ;aACjB;YACD,QAAQ,EAAE;gBACN,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,QAAQ;aACjB;YACD,gBAAgB,EAAE;gBACd,KAAK,EAAE,kBAAkB;gBACzB,WAAW,EAAE,+BAA+B;gBAC5C,IAAI,EAAE,QAAQ;aACjB;YACD,UAAU,EAAE;gBACR,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,QAAQ;aACjB;YACD,YAAY,EAAE;gBACV,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,QAAQ;aACjB;YACD,KAAK,EAAE;gBACH,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,iCAAiC;gBAC9C,IAAI,EAAE,QAAQ;aACjB;SACA;KACJ;IACD,WAAW,EAAE;QACT,KAAK,EAAE,aAAa;QACpB,WAAW,EACX,8LAA8L;QAC9L,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACT,OAAO,EAAE,0BAA0B;SAClC;KACJ;IACD,SAAS,EAAE;QACP,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oFAAoF;QACjG,OAAO,EAAE;YACT,OAAO,EAAE,wBAAwB;SAChC;KACJ;IACD,YAAY,EAAE;QACV,KAAK,EAAE,cAAc;QACrB,WAAW,EACX,uPAAuP;QACvP,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACT,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;YACtC,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,EAAE;SACjD;QACD,OAAO,EAAE,SAAS;KACrB;IACD,QAAQ,EAAE;QACN,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE;YACT,OAAO,EAAE,uBAAuB;SAC/B;KACJ;IACD,KAAK,EAAE;QACH,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE;YACT,KAAK,EAAE;gBACH,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;aAC5C;SACA;KACJ;IACD,WAAW,EAAE;QACT,KAAK,EAAE,aAAa;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;KACxD;IACD,KAAK,EAAE;QACH,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;QACrD,OAAO,EAAE;YACT,OAAO,EAAE,oBAAoB;SAC5B;KACJ;IACD,aAAa,EAAE;QACX,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,4FAA4F;QACzG,OAAO,EAAE;YACT,OAAO,EAAE,4BAA4B;SACpC;QACD,UAAU,EAAE;YACZ,UAAU,EAAE;gBACR;oBACA,QAAQ,EAAE,OAAO;oBACjB,QAAQ,EAAE,IAAI;oBACd,KAAK,EAAE,QAAQ;iBACd;aACJ;SACA;KACJ;CACJ,CAAA"}

package/dist/esm/reportWebEvent/generated-types.d.ts

@@ -1,19 +1,9 @@
 export interface Payload {
+    event_spec_type?: string;
     event: string;
     event_id?: string;
-    phone_number?: string[];
-    email?: string[];
-    first_name?: string;
-    last_name?: string;
-    address?: {
-        city?: string;
-        country?: string;
-        zip_code?: string;
-        state?: string;
-    };
     order_id?: string;
     shop_id?: string;
-    external_id?: string[];
     contents?: {
         price?: number;
         quantity?: number;
@@ -22,9 +12,70 @@ export interface Payload {
         content_name?: string;
         brand?: string;
     }[];
+    content_ids?: string[];
+    num_items?: number;
     content_type?: string;
     currency?: string;
     value?: number;
     description?: string;
     query?: string;
+    search_string?: string;
+    phone_number?: string[];
+    email?: string[];
+    first_name?: string;
+    last_name?: string;
+    address?: {
+        city?: string;
+        country?: string;
+        zip_code?: string;
+        state?: string;
+    };
+    external_id?: string[];
+    vehicle_fields?: {
+        postal_code?: string;
+        make?: string;
+        model?: string;
+        year?: number;
+        state_of_vehicle?: string;
+        mileage_value?: number;
+        mileage_unit?: string;
+        exterior_color?: string;
+        transmission?: string;
+        body_style?: string;
+        fuel_type?: string;
+        drivetrain?: string;
+        preferred_price_range_min?: number;
+        preferred_price_range_max?: number;
+        trim?: string;
+        vin?: string;
+        interior_color?: string;
+        condition_of_vehicle?: string;
+        viewcontent_type?: string;
+        search_type?: string;
+        registration_type?: string;
+    };
+    travel_fields?: {
+        city?: string;
+        region?: string;
+        country?: string;
+        checkin_date?: string;
+        checkout_date?: string;
+        num_adults?: number;
+        num_children?: number;
+        num_infants?: number;
+        suggested_hotels?: string[];
+        departing_departure_date?: string;
+        returning_departure_date?: string;
+        origin_airport?: string;
+        destination_airport?: string;
+        destination_ids?: string[];
+        departing_arrival_date?: string;
+        returning_arrival_date?: string;
+        travel_class?: string;
+        user_score?: number;
+        preferred_num_stops?: number;
+        travel_start?: string;
+        travel_end?: string;
+        suggested_destinations?: string[];
+    };
 }