@segment/analytics-browser-actions-tiktok-pixel 1.48.0 → 1.51.0

package/dist/cjs/identify/index.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const formatter_1 = require("../formatter");
-const common_fields_1 = require("../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: {
-        ...common_fields_1.commonFields,
-        phone_number: {
-            ...common_fields_1.commonFields.phone_number,
-            default: { '@path': '$.traits.phone' }
-        },
-        email: {
-            ...common_fields_1.commonFields.email,
-            default: { '@path': '$.traits.email' }
-        },
-        first_name: {
-            ...common_fields_1.commonFields.first_name,
-            default: { '@path': '$.traits.first_name' }
-        },
-        last_name: {
-            ...common_fields_1.commonFields.last_name,
-            default: { '@path': '$.traits.last_name' }
-        },
-        address: {
-            ...common_fields_1.commonFields.address,
-            default: {
-                city: { '@path': '$.traits.address.city' },
-                country: { '@path': '$.traits.address.country' },
-                zip_code: { '@path': '$.traits.address.postal_code' },
-                state: { '@path': '$.traits.address.state' }
-            }
-        }
-    },
-    perform: (ttq, { payload }) => {
-        if (payload.email || payload.phone_number || payload.external_id) {
-            ttq.identify({
-                email: formatter_1.handleArrayInput(payload.email),
-                phone_number: formatter_1.formatPhone(formatter_1.handleArrayInput(payload.phone_number)),
-                external_id: formatter_1.handleArrayInput(payload.external_id),
-                first_name: formatter_1.formatString(payload.first_name),
-                last_name: formatter_1.formatString(payload.last_name),
-                city: formatter_1.formatAddress(payload.address?.city),
-                state: formatter_1.formatAddress(payload.address?.state),
-                country: formatter_1.formatAddress(payload.address?.country),
-                zip_code: formatter_1.formatString(payload.address?.zip_code)
-            });
-        }
-    }
-};
-exports.default = action;
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identify/index.ts"],"names":[],"mappings":";;AAGA,4CAAyF;AAEzF,oDAA+C;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,4BAAY;QACf,YAAY,EAAE;YACZ,GAAG,4BAAY,CAAC,YAAY;YAC5B,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACvC;QACD,KAAK,EAAE;YACL,GAAG,4BAAY,CAAC,KAAK;YACrB,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACvC;QACD,UAAU,EAAE;YACV,GAAG,4BAAY,CAAC,UAAU;YAC1B,OAAO,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;SAC5C;QACD,SAAS,EAAE;YACT,GAAG,4BAAY,CAAC,SAAS;YACzB,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;SAC3C;QACD,OAAO,EAAE;YACP,GAAG,4BAAY,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;YAChE,GAAG,CAAC,QAAQ,CAAC;gBACX,KAAK,EAAE,4BAAgB,CAAC,OAAO,CAAC,KAAK,CAAC;gBACtC,YAAY,EAAE,uBAAW,CAAC,4BAAgB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACjE,WAAW,EAAE,4BAAgB,CAAC,OAAO,CAAC,WAAW,CAAC;gBAClD,UAAU,EAAE,wBAAY,CAAC,OAAO,CAAC,UAAU,CAAC;gBAC5C,SAAS,EAAE,wBAAY,CAAC,OAAO,CAAC,SAAS,CAAC;gBAC1C,IAAI,EAAE,yBAAa,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;gBAC1C,KAAK,EAAE,yBAAa,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;gBAC5C,OAAO,EAAE,yBAAa,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC;gBAChD,QAAQ,EAAE,wBAAY,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC;aAClD,CAAC,CAAA;SACH;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/esm/formatter.d.ts

@@ -1,4 +0,0 @@
-export declare function formatPhone(phone: string | undefined): string | undefined;
-export declare function handleArrayInput(mightBeArray: string[] | string | undefined): string;
-export declare function formatString(str: string | undefined | null): string;
-export declare function formatAddress(address: string | undefined | null): string;

package/dist/esm/formatter.js

@@ -1,32 +0,0 @@
-export 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;
-}
-export function handleArrayInput(mightBeArray) {
-    if (typeof mightBeArray === 'string')
-        return mightBeArray;
-    if (typeof mightBeArray === 'undefined')
-        return '';
-    if (Array.isArray(mightBeArray)) {
-        return mightBeArray.length > 0 ? mightBeArray[0] : '';
-    }
-    return '';
-}
-export function formatString(str) {
-    if (!str)
-        return '';
-    return str.replace(/\s/g, '').toLowerCase();
-}
-export function formatAddress(address) {
-    if (!address)
-        return '';
-    return address.replace(/[^A-Za-z0-9]/g, '').toLowerCase();
-}
-//# sourceMappingURL=formatter.js.map

package/dist/esm/formatter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../src/formatter.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,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;AAED,MAAM,UAAU,gBAAgB,CAAC,YAA2C;IAC1E,IAAI,OAAO,YAAY,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAA;IACzD,IAAI,OAAO,YAAY,KAAK,WAAW;QAAE,OAAO,EAAE,CAAA;IAClD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QAC/B,OAAO,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;KACtD;IACD,OAAO,EAAE,CAAA;AACX,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAA8B;IACzD,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAA;IACnB,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;AAC7C,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAkC;IAC9D,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAA;IACvB,OAAO,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;AAC3D,CAAC"}

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

@@ -1,30 +0,0 @@
-export interface Payload {
-    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;
-        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/generated-types.js

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

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

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

package/dist/esm/identify/index.d.ts

@@ -1,6 +0,0 @@
-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/esm/identify/index.js

@@ -1,53 +0,0 @@
-import { formatPhone, handleArrayInput, formatString, formatAddress } from '../formatter';
-import { commonFields } from '../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,
-        phone_number: {
-            ...commonFields.phone_number,
-            default: { '@path': '$.traits.phone' }
-        },
-        email: {
-            ...commonFields.email,
-            default: { '@path': '$.traits.email' }
-        },
-        first_name: {
-            ...commonFields.first_name,
-            default: { '@path': '$.traits.first_name' }
-        },
-        last_name: {
-            ...commonFields.last_name,
-            default: { '@path': '$.traits.last_name' }
-        },
-        address: {
-            ...commonFields.address,
-            default: {
-                city: { '@path': '$.traits.address.city' },
-                country: { '@path': '$.traits.address.country' },
-                zip_code: { '@path': '$.traits.address.postal_code' },
-                state: { '@path': '$.traits.address.state' }
-            }
-        }
-    },
-    perform: (ttq, { payload }) => {
-        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)
-            });
-        }
-    }
-};
-export default action;
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"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;YAChE,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;SACH;IACH,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}