@segment/analytics-browser-actions-tiktok-pixel 1.0.1-CONMAN-533.1454

package/dist/cjs/generated-types.d.ts

@@ -0,0 +1,4 @@
+export interface Settings {
+    pixelCode: string;
+    useExistingPixel?: boolean;
+}

package/dist/cjs/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/cjs/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../src/generated-types.ts"],"names":[],"mappings":""}

package/dist/cjs/index.d.ts

@@ -0,0 +1,11 @@
+import type { Settings } from './generated-types';
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types';
+import { TikTokPixel } from './types';
+declare global {
+    interface Window {
+        ttq: TikTokPixel;
+    }
+}
+export declare const destination: BrowserDestinationDefinition<Settings, TikTokPixel>;
+declare const _default: import("@segment/browser-destination-runtime/types").PluginFactory;
+export default _default;

package/dist/cjs/index.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destination = void 0;
+const tslib_1 = require("tslib");
+const shim_1 = require("@segment/browser-destination-runtime/shim");
+const reportWebEvent_1 = tslib_1.__importDefault(require("./reportWebEvent"));
+const actions_core_1 = require("@segment/actions-core");
+const init_script_1 = require("./init-script");
+const productProperties = {
+    price: {
+        '@path': '$.price'
+    },
+    quantity: {
+        '@path': '$.quantity'
+    },
+    content_type: {
+        '@path': '$.category'
+    },
+    content_id: {
+        '@path': '$.product_id'
+    }
+};
+const singleProductContents = {
+    ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+const multiProductContents = {
+    ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties.products',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+exports.destination = {
+    name: 'TikTok Pixel',
+    slug: 'actions-tiktok-pixel',
+    mode: 'device',
+    presets: [
+        {
+            name: 'View Content',
+            subscribe: 'type="page"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'ViewContent'
+            }
+        },
+        {
+            name: 'Search',
+            subscribe: 'event = "Products Searched"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'Search'
+            }
+        },
+        {
+            name: 'Add to Wishlist',
+            subscribe: 'event = "Product Added to Wishlist"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToWishlist'
+            }
+        },
+        {
+            name: 'Add to Cart',
+            subscribe: 'event = "Product Added"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToCart'
+            }
+        },
+        {
+            name: 'Initiate Checkout',
+            subscribe: 'event = "Checkout Started"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'InitiateCheckout'
+            }
+        },
+        {
+            name: 'Add Payment Info',
+            subscribe: 'event = "Payment Info Entered"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'AddPaymentInfo'
+            }
+        },
+        {
+            name: 'Place an Order',
+            subscribe: 'event = "Order Completed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'PlaceAnOrder'
+            }
+        }
+    ],
+    settings: {
+        pixelCode: {
+            label: 'Pixel Code',
+            type: 'string',
+            description: "Your TikTok Pixel ID. Please see TikTok's [Pixel documentation](https://ads.tiktok.com/marketing_api/docs?id=1739583652957185) for information on how to find this value.",
+            required: true
+        },
+        useExistingPixel: {
+            label: 'Use Existing Pixel',
+            type: 'boolean',
+            description: 'Select "true" to use existing Pixel that is already installed on your website.'
+        }
+    },
+    initialize: async ({ settings }, deps) => {
+        if (!settings.useExistingPixel) {
+            init_script_1.initScript(settings.pixelCode);
+        }
+        await deps.resolveWhen(() => window.ttq != null, 100);
+        return window.ttq;
+    },
+    actions: {
+        reportWebEvent: reportWebEvent_1.default
+    }
+};
+exports.default = shim_1.browserDestination(exports.destination);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAEA,oEAA8E;AAC9E,8EAA6C;AAC7C,wDAAqD;AAErD,+CAA0C;AAQ1C,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY;KACtB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;CACF,CAAA;AAED,MAAM,qBAAqB,GAAG;IAC5B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,cAAc;YACd;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,oBAAoB,GAAG;IAC3B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAGY,QAAA,WAAW,GAAwD;IAC9E,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,aAAa;YACxB,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;SACF;QACD;YACE,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,6BAA6B;YACxC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,QAAQ;aAChB;SACF;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,SAAS,EAAE,qCAAqC;YAChD,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,eAAe;aACvB;SACF;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,yBAAyB;YACpC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,WAAW;aACnB;SACF;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,kBAAkB;aAC1B;SACF;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,gBAAgB;aACxB;SACF;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,cAAc;aACtB;SACF;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,2KAA2K;YAC7K,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,gFAAgF;SAC9F;KACF;IACD,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE;QACvC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE;YAC9B,wBAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;SAC/B;QACD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,GAAG,CAAC,CAAA;QACrD,OAAO,MAAM,CAAC,GAAG,CAAA;IACnB,CAAC;IACD,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;KACf;CACF,CAAA;AAED,kBAAe,yBAAkB,CAAC,mBAAW,CAAC,CAAA"}

package/dist/cjs/init-script.d.ts

@@ -0,0 +1 @@
+export declare function initScript(pixelCode: any): void;

package/dist/cjs/init-script.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initScript = void 0;
+function initScript(pixelCode) {
+    !(function (w, d, t) {
+        w.TiktokAnalyticsObject = t;
+        var ttq = (w[t] = w[t] || []);
+        (ttq.methods = [
+            'page',
+            'track',
+            'identify',
+            'instances',
+            'debug',
+            'on',
+            'off',
+            'once',
+            'ready',
+            'alias',
+            'group',
+            'enableCookie',
+            'disableCookie'
+        ]),
+            (ttq.setAndDefer = function (t, e) {
+                t[e] = function () {
+                    t.push([e].concat(Array.prototype.slice.call(arguments, 0)));
+                };
+            });
+        for (var i = 0; i < ttq.methods.length; i++)
+            ttq.setAndDefer(ttq, ttq.methods[i]);
+        (ttq.instance = function (t) {
+            for (var e = ttq._i[t] || [], n = 0; n < ttq.methods.length; n++)
+                ttq.setAndDefer(e, ttq.methods[n]);
+            return e;
+        }),
+            (ttq.load = function (e, n) {
+                var i = 'https://analytics.tiktok.com/i18n/pixel/events.js';
+                (ttq._i = ttq._i || {}),
+                    (ttq._i[e] = []),
+                    (ttq._i[e]._u = i),
+                    (ttq._t = ttq._t || {}),
+                    (ttq._t[e] = +new Date()),
+                    (ttq._o = ttq._o || {}),
+                    (ttq._o[e] = n || {});
+                var o = document.createElement('script');
+                (o.type = 'text/javascript'), (o.async = !0), (o.src = i + '?sdkid=' + e + '&lib=' + t);
+                var a = document.getElementsByTagName('script')[0];
+                a.parentNode.insertBefore(o, a);
+            });
+        ttq.load(pixelCode);
+        ttq.page();
+    })(window, document, 'ttq');
+}
+exports.initScript = initScript;
+//# sourceMappingURL=init-script.js.map

package/dist/cjs/init-script.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-script.js","sourceRoot":"","sources":["../../src/init-script.ts"],"names":[],"mappings":";;;AAEA,SAAgB,UAAU,CAAC,SAAS;IAClC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;QACjB,CAAC,CAAC,qBAAqB,GAAG,CAAC,CAAA;QAC3B,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAC5B;QAAA,CAAC,GAAG,CAAC,OAAO,GAAG;YACd,MAAM;YACN,OAAO;YACP,UAAU;YACV,WAAW;YACX,OAAO;YACP,IAAI;YACJ,KAAK;YACL,MAAM;YACN,OAAO;YACP,OAAO;YACP,OAAO;YACP,cAAc;YACd,eAAe;SAChB,CAAC;YACA,CAAC,GAAG,CAAC,WAAW,GAAG,UAAU,CAAC,EAAE,CAAC;gBAC/B,CAAC,CAAC,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;gBAC9D,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;YAAE,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAChF;QAAA,CAAC,GAAG,CAAC,QAAQ,GAAG,UAAU,CAAC;YAC1B,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;gBAAE,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;YACpG,OAAO,CAAC,CAAA;QACV,CAAC,CAAC;YACA,CAAC,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,mDAAmD,CAC1D;gBAAA,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;oBACtB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;oBAChB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;oBAClB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;oBACvB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;oBACzB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;oBACvB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;gBACvB,IAAI,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CACvC;gBAAA,CAAC,CAAC,CAAC,IAAI,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC,CAAA;gBACxF,IAAI,CAAC,GAAG,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;gBAClD,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACjC,CAAC,CAAC,CAAA;QAEJ,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACnB,GAAG,CAAC,IAAI,EAAE,CAAA;IACZ,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;AAC7B,CAAC;AA/CD,gCA+CC"}

package/dist/cjs/reportWebEvent/formatter.d.ts

@@ -0,0 +1 @@
+export declare function formatPhone(phone: string | undefined): string | undefined;

package/dist/cjs/reportWebEvent/formatter.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPhone = void 0;
+function formatPhone(phone) {
+    if (!phone)
+        return undefined;
+    const validatedPhone = phone.match(/[0-9]{0,14}/g);
+    if (validatedPhone === null) {
+        throw new Error(`${phone} is not a valid E.164 phone number.`);
+    }
+    let formattedPhone = `+${phone.replace(/[^0-9]/g, '')}`;
+    formattedPhone = formattedPhone.substring(0, 15);
+    return formattedPhone;
+}
+exports.formatPhone = formatPhone;
+//# sourceMappingURL=formatter.js.map

package/dist/cjs/reportWebEvent/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/reportWebEvent/formatter.ts"],"names":[],"mappings":";;;AAKA,SAAgB,WAAW,CAAC,KAAyB;IACnD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAE5B,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,IAAI,cAAc,KAAK,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;KAC/D;IAED,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;IAEvD,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAChD,OAAO,cAAc,CAAA;AACvB,CAAC;AAZD,kCAYC"}

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

@@ -0,0 +1,16 @@
+export interface Payload {
+    event: string;
+    phone_number?: string;
+    email?: string;
+    external_id?: string;
+    contents?: {
+        price?: number;
+        quantity?: number;
+        content_type?: string;
+        content_id?: string;
+    }[];
+    currency?: string;
+    value?: number;
+    description?: string;
+    query?: string;
+}

package/dist/cjs/reportWebEvent/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/cjs/reportWebEvent/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/reportWebEvent/generated-types.ts"],"names":[],"mappings":""}

package/dist/cjs/reportWebEvent/index.d.ts

@@ -0,0 +1,6 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+import { TikTokPixel } from '../types';
+declare const action: BrowserActionDefinition<Settings, TikTokPixel, Payload>;
+export default action;

package/dist/cjs/reportWebEvent/index.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const formatter_1 = require("./formatter");
+const action = {
+    title: 'Report Web Event',
+    description: 'Report events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.',
+    platform: 'web',
+    defaultSubscription: 'type = "track"',
+    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 documentation](https://ads.tiktok.com/marketing_api/docs?id=1739585696931842) for accepted event names.'
+        },
+        phone_number: {
+            label: 'Phone Number',
+            description: 'Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000. Segment will hash this value before sending to TikTok.',
+            type: 'string',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.phone' },
+                    then: { '@path': '$.properties.phone' },
+                    else: { '@path': '$.traits.phone' }
+                }
+            }
+        },
+        email: {
+            label: 'Email',
+            description: 'Email address of the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
+            type: 'string',
+            format: 'email',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.email' },
+                    then: { '@path': '$.properties.email' },
+                    else: { '@path': '$.traits.email' }
+                }
+            }
+        },
+        external_id: {
+            label: 'External ID',
+            description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
+            type: 'string',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.userId' },
+                    then: { '@path': '$.userId' },
+                    else: { '@path': '$.anonymousId' }
+                }
+            }
+        },
+        contents: {
+            label: 'Contents',
+            type: 'object',
+            multiple: true,
+            description: 'Related items in a web event.',
+            properties: {
+                price: {
+                    label: 'Price',
+                    description: 'Price of the item.',
+                    type: 'number'
+                },
+                quantity: {
+                    label: 'Quantity',
+                    description: 'Number of items.',
+                    type: 'number'
+                },
+                content_type: {
+                    label: 'Content Type',
+                    description: 'Type of the product item.',
+                    type: 'string'
+                },
+                content_id: {
+                    label: 'Content ID',
+                    description: 'ID of the product item.',
+                    type: 'string'
+                }
+            }
+        },
+        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.',
+            default: {
+                '@path': '$.properties.description'
+            }
+        },
+        query: {
+            label: 'Query',
+            type: 'string',
+            description: 'The text string that was searched for.',
+            default: {
+                '@path': '$.properties.query'
+            }
+        }
+    },
+    perform: (ttq, { payload }) => {
+        if (payload.email || payload.phone_number) {
+            ttq.identify({
+                email: payload.email,
+                phone_number: formatter_1.formatPhone(payload.phone_number)
+            });
+        }
+        ttq.track(payload.event, {
+            contents: payload.contents ? payload.contents : [],
+            currency: payload.currency ? payload.currency : 'USD',
+            value: payload.value ? payload.value : 0,
+            description: payload.description,
+            query: payload.query
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/cjs/reportWebEvent/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/reportWebEvent/index.ts"],"names":[],"mappings":";;AAGA,2CAAyC;AAGzC,MAAM,MAAM,GAA4D;IACtE,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,6JAA6J;IAC/J,QAAQ,EAAE,KAAK;IACf,mBAAmB,EAAE,gBAAgB;IACrC,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,yMAAyM;SAC5M;QAED,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EACT,kKAAkK;YACpK,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EACT,sHAAsH;YACxH,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,yHAAyH;YAC3H,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;iBACnC;aACF;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,+BAA+B;YAC5C,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,WAAW,EAAE,oBAAoB;oBACjC,IAAI,EAAE,QAAQ;iBACf;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,WAAW,EAAE,kBAAkB;oBAC/B,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,2BAA2B;oBACxC,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,YAAY;oBACnB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mCAAmC;YAChD,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;iBAC1C;aACF;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE;gBACP,OAAO,EAAE,0BAA0B;aACpC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;KACF;IACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAC5B,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,YAAY,EAAE;YACzC,GAAG,CAAC,QAAQ,CAAC;gBACX,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,YAAY,EAAE,uBAAW,CAAC,OAAO,CAAC,YAAY,CAAC;aAChD,CAAC,CAAA;SACH;QAED,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE;YACvB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAClD,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;YACrD,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/types.d.ts

@@ -0,0 +1,19 @@
+export interface TikTokPixel {
+    page: () => void;
+    identify: ({ email, phone_number }: {
+        email: string | undefined;
+        phone_number: string | undefined;
+    }) => void;
+    track: (event: string, { contents, currency, value, description, query }: {
+        contents: {
+            price?: number;
+            quantity?: number;
+            content_type?: string;
+            content_id?: string;
+        }[] | [];
+        currency: string;
+        value: number;
+        description: string | undefined;
+        query: string | undefined;
+    }) => void;
+}

package/dist/cjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,4 @@
+export interface Settings {
+    pixelCode: string;
+    useExistingPixel?: boolean;
+}

package/dist/esm/generated-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generated-types.js.map

package/dist/esm/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../src/generated-types.ts"],"names":[],"mappings":""}

package/dist/esm/index.d.ts

@@ -0,0 +1,11 @@
+import type { Settings } from './generated-types';
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types';
+import { TikTokPixel } from './types';
+declare global {
+    interface Window {
+        ttq: TikTokPixel;
+    }
+}
+export declare const destination: BrowserDestinationDefinition<Settings, TikTokPixel>;
+declare const _default: import("@segment/browser-destination-runtime/types").PluginFactory;
+export default _default;

package/dist/esm/index.js

@@ -0,0 +1,135 @@
+import { browserDestination } from '@segment/browser-destination-runtime/shim';
+import reportWebEvent from './reportWebEvent';
+import { defaultValues } from '@segment/actions-core';
+import { initScript } from './init-script';
+const productProperties = {
+    price: {
+        '@path': '$.price'
+    },
+    quantity: {
+        '@path': '$.quantity'
+    },
+    content_type: {
+        '@path': '$.category'
+    },
+    content_id: {
+        '@path': '$.product_id'
+    }
+};
+const singleProductContents = {
+    ...defaultValues(reportWebEvent.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+const multiProductContents = {
+    ...defaultValues(reportWebEvent.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties.products',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+export const destination = {
+    name: 'TikTok Pixel',
+    slug: 'actions-tiktok-pixel',
+    mode: 'device',
+    presets: [
+        {
+            name: 'View Content',
+            subscribe: 'type="page"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'ViewContent'
+            }
+        },
+        {
+            name: 'Search',
+            subscribe: 'event = "Products Searched"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'Search'
+            }
+        },
+        {
+            name: 'Add to Wishlist',
+            subscribe: 'event = "Product Added to Wishlist"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToWishlist'
+            }
+        },
+        {
+            name: 'Add to Cart',
+            subscribe: 'event = "Product Added"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToCart'
+            }
+        },
+        {
+            name: 'Initiate Checkout',
+            subscribe: 'event = "Checkout Started"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'InitiateCheckout'
+            }
+        },
+        {
+            name: 'Add Payment Info',
+            subscribe: 'event = "Payment Info Entered"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'AddPaymentInfo'
+            }
+        },
+        {
+            name: 'Place an Order',
+            subscribe: 'event = "Order Completed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'PlaceAnOrder'
+            }
+        }
+    ],
+    settings: {
+        pixelCode: {
+            label: 'Pixel Code',
+            type: 'string',
+            description: "Your TikTok Pixel ID. Please see TikTok's [Pixel documentation](https://ads.tiktok.com/marketing_api/docs?id=1739583652957185) for information on how to find this value.",
+            required: true
+        },
+        useExistingPixel: {
+            label: 'Use Existing Pixel',
+            type: 'boolean',
+            description: 'Select "true" to use existing Pixel that is already installed on your website.'
+        }
+    },
+    initialize: async ({ settings }, deps) => {
+        if (!settings.useExistingPixel) {
+            initScript(settings.pixelCode);
+        }
+        await deps.resolveWhen(() => window.ttq != null, 100);
+        return window.ttq;
+    },
+    actions: {
+        reportWebEvent
+    }
+};
+export default browserDestination(destination);
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAA;AAC9E,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAQ1C,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY;KACtB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;CACF,CAAA;AAED,MAAM,qBAAqB,GAAG;IAC5B,GAAG,aAAa,CAAC,cAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,cAAc;YACd;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,oBAAoB,GAAG;IAC3B,GAAG,aAAa,CAAC,cAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAGD,MAAM,CAAC,MAAM,WAAW,GAAwD;IAC9E,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,aAAa;YACxB,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;SACF;QACD;YACE,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,6BAA6B;YACxC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,QAAQ;aAChB;SACF;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,SAAS,EAAE,qCAAqC;YAChD,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,eAAe;aACvB;SACF;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,yBAAyB;YACpC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,WAAW;aACnB;SACF;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,kBAAkB;aAC1B;SACF;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,gBAAgB;aACxB;SACF;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,cAAc;aACtB;SACF;KACF;IACD,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,2KAA2K;YAC7K,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,gFAAgF;SAC9F;KACF;IACD,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE;QACvC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE;YAC9B,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;SAC/B;QACD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,GAAG,CAAC,CAAA;QACrD,OAAO,MAAM,CAAC,GAAG,CAAA;IACnB,CAAC;IACD,OAAO,EAAE;QACP,cAAc;KACf;CACF,CAAA;AAED,eAAe,kBAAkB,CAAC,WAAW,CAAC,CAAA"}

package/dist/esm/init-script.d.ts

@@ -0,0 +1 @@
+export declare function initScript(pixelCode: any): void;