@segment/action-destinations 3.244.0 → 3.246.0-snap-connector

package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.performSnapCAPIv3 = exports.buildRequestURL = exports.validateAppOrPixelID = exports.formatPayload = exports.validatePayload = void 0;
+const utils_1 = require("./utils");
+const snap_capi_properties_1 = require("../snap-capi-properties");
+const validatePayload = (payload) => {
+    utils_1.raiseMisconfiguredRequiredFieldErrorIf(!utils_1.isNullOrUndefined(payload.currency) && !snap_capi_properties_1.CURRENCY_ISO_4217_CODES.has(payload.currency.toUpperCase()), `${payload.currency} is not a valid currency code.`);
+    utils_1.raiseMisconfiguredRequiredFieldErrorIf(utils_1.isNullOrUndefined(payload.email) &&
+        utils_1.isNullOrUndefined(payload.phone_number) &&
+        utils_1.isNullOrUndefined(payload.mobile_ad_id) &&
+        (utils_1.isNullOrUndefined(payload.ip_address) || utils_1.isNullOrUndefined(payload.user_agent)), `Payload must contain values for Email or Phone Number or Mobile Ad Identifier or both IP Address and User Agent fields`);
+    return payload;
+};
+exports.validatePayload = validatePayload;
+const eventConversionTypeToActionSource = {
+    WEB: 'website',
+    MOBILE_APP: 'app'
+};
+const iosAppIDRegex = new RegExp('^[0-9]+$');
+const formatPayload = (payload, settings, isTest = true) => {
+    const action_source = eventConversionTypeToActionSource[payload.event_conversion_type] ?? 'other';
+    const event_id = utils_1.emptyToUndefined(payload.client_dedup_id);
+    const email = utils_1.hashEmailSafe(payload.email?.replace(/\s/g, '').toLowerCase());
+    const phone_number = utils_1.hash(payload.phone_number?.replace(/\D|^0+/g, ''));
+    const madid = payload.mobile_ad_id?.toLowerCase();
+    const products = (payload.products ?? []).filter(({ item_id }) => item_id != null);
+    const { content_ids, content_category, brands, num_items } = products.length > 0
+        ? {
+            content_ids: products.map(({ item_id }) => item_id),
+            content_category: products.map(({ item_category }) => item_category),
+            brands: products.map((product) => product.brand ?? ''),
+            num_items: products.length
+        }
+        : {
+            content_ids: utils_1.splitListValueToArray(payload.item_ids ?? ''),
+            content_category: utils_1.splitListValueToArray(payload.item_category ?? ''),
+            brands: payload.brands,
+            num_items: payload.number_items
+        };
+    const extInfoVersion = iosAppIDRegex.test((settings.app_id ?? '').trim()) ? 'i2' : 'a2';
+    const result = {
+        data: [
+            {
+                integration: 'segment',
+                event_id,
+                event_name: payload.event_type,
+                event_source_url: payload.page_url,
+                event_time: Date.parse(payload.timestamp),
+                user_data: utils_1.emptyObjectToUndefined({
+                    client_ip_address: payload.ip_address,
+                    client_user_agent: payload.user_agent,
+                    em: utils_1.box(email),
+                    madid,
+                    ph: utils_1.box(phone_number),
+                    sc_click_id: payload.click_id,
+                    sc_cookie1: payload.uuid_c1
+                }),
+                custom_data: utils_1.emptyObjectToUndefined({
+                    brands,
+                    content_category,
+                    content_ids,
+                    currency: payload.currency,
+                    num_items,
+                    order_id: utils_1.emptyToUndefined(payload.transaction_id),
+                    search_string: payload.search_string,
+                    sign_up_method: payload.sign_up_method,
+                    value: payload.price
+                }),
+                action_source,
+                app_data: !utils_1.isNullOrUndefined(payload.os_version ?? payload.device_model)
+                    ? {
+                        extinfo: [
+                            extInfoVersion,
+                            '',
+                            '',
+                            '',
+                            payload.os_version ?? '',
+                            payload.device_model ?? '',
+                            '',
+                            '',
+                            '',
+                            '',
+                            '',
+                            '',
+                            '',
+                            '',
+                            '',
+                            ''
+                        ]
+                    }
+                    : undefined
+            }
+        ],
+        ...(isTest ? { test_event_code: 'segment_test' } : {})
+    };
+    return result;
+};
+exports.formatPayload = formatPayload;
+const validateAppOrPixelID = (settings, event_conversion_type) => {
+    const { snap_app_id, pixel_id } = settings;
+    const snapAppID = utils_1.emptyToUndefined(snap_app_id);
+    const snapPixelID = utils_1.emptyToUndefined(pixel_id);
+    const appOrPixelID = snapAppID ?? snapPixelID;
+    utils_1.raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined(appOrPixelID, 'Missing valid app or pixel ID');
+    utils_1.raiseMisconfiguredRequiredFieldErrorIf(event_conversion_type === 'MOBILE_APP' && utils_1.isNullOrUndefined(snapAppID), 'If event conversion type is "MOBILE_APP" then Snap App ID and App ID must be defined');
+    utils_1.raiseMisconfiguredRequiredFieldErrorIf(event_conversion_type === 'WEB' && utils_1.isNullOrUndefined(snapPixelID), `If event conversion type is "${event_conversion_type}" then Pixel ID must be defined`);
+    return appOrPixelID;
+};
+exports.validateAppOrPixelID = validateAppOrPixelID;
+const buildRequestURL = (appOrPixelID, authToken) => `https://tr.snapchat.com/v3/${appOrPixelID}/events?access_token=${authToken}`;
+exports.buildRequestURL = buildRequestURL;
+const performSnapCAPIv3 = async (request, data, isTest = true) => {
+    const { payload, settings } = data;
+    const { event_conversion_type } = payload;
+    const authToken = data.auth?.accessToken;
+    utils_1.raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined(authToken, 'Missing valid auth token');
+    const url = exports.buildRequestURL(exports.validateAppOrPixelID(settings, event_conversion_type), authToken);
+    const json = exports.formatPayload(exports.validatePayload(payload), settings, isTest);
+    return request(url, {
+        method: 'post',
+        json
+    });
+};
+exports.performSnapCAPIv3 = performSnapCAPIv3;
+//# sourceMappingURL=snap-capi-v3.js.map

package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snap-capi-v3.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.ts"],"names":[],"mappings":";;;AAGA,mCAUgB;AAChB,kEAAiE;AAE1D,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAW,EAAE;IAC3D,8CAAsC,CACpC,CAAC,yBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,8CAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EACpG,GAAG,OAAO,CAAC,QAAQ,gCAAgC,CACpD,CAAA;IAED,8CAAsC,CACpC,yBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9B,yBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC;QACvC,yBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC;QACvC,CAAC,yBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,yBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,EAClF,wHAAwH,CACzH,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAfY,QAAA,eAAe,mBAe3B;AAED,MAAM,iCAAiC,GAA+B;IACpE,GAAG,EAAE,SAAS;IACd,UAAU,EAAE,KAAK;CAClB,CAAA;AAED,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;AAErC,MAAM,aAAa,GAAG,CAAC,OAAgB,EAAE,QAAkB,EAAE,MAAM,GAAG,IAAI,EAAU,EAAE;IAC3F,MAAM,aAAa,GAAG,iCAAiC,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,OAAO,CAAA;IAEjG,MAAM,QAAQ,GAAG,wBAAgB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IAG1D,MAAM,KAAK,GAAG,qBAAa,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;IAG5E,MAAM,YAAY,GAAG,YAAI,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAA;IAGvE,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,EAAE,WAAW,EAAE,CAAA;IAGjD,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,CAAA;IAElF,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,GACxD,QAAQ,CAAC,MAAM,GAAG,CAAC;QACjB,CAAC,CAAC;YACE,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC;YACnD,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC;YACpE,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;YACtD,SAAS,EAAE,QAAQ,CAAC,MAAM;SAC3B;QACH,CAAC,CAAC;YACE,WAAW,EAAE,6BAAqB,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;YAC1D,gBAAgB,EAAE,6BAAqB,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;YACpE,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,YAAY;SAChC,CAAA;IAEP,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IAEvF,MAAM,MAAM,GAAG;QACb,IAAI,EAAE;YACJ;gBACE,WAAW,EAAE,SAAS;gBACtB,QAAQ;gBAIR,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,gBAAgB,EAAE,OAAO,CAAC,QAAQ;gBAClC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;gBACzC,SAAS,EAAE,8BAAsB,CAAC;oBAChC,iBAAiB,EAAE,OAAO,CAAC,UAAU;oBACrC,iBAAiB,EAAE,OAAO,CAAC,UAAU;oBACrC,EAAE,EAAE,WAAG,CAAC,KAAK,CAAC;oBACd,KAAK;oBAEL,EAAE,EAAE,WAAG,CAAC,YAAY,CAAC;oBACrB,WAAW,EAAE,OAAO,CAAC,QAAQ;oBAC7B,UAAU,EAAE,OAAO,CAAC,OAAO;iBAC5B,CAAC;gBACF,WAAW,EAAE,8BAAsB,CAAC;oBAClC,MAAM;oBACN,gBAAgB;oBAChB,WAAW;oBACX,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,SAAS;oBACT,QAAQ,EAAE,wBAAgB,CAAC,OAAO,CAAC,cAAc,CAAC;oBAClD,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,cAAc,EAAE,OAAO,CAAC,cAAc;oBACtC,KAAK,EAAE,OAAO,CAAC,KAAK;iBACrB,CAAC;gBAEF,aAAa;gBAEb,QAAQ,EAAE,CAAC,yBAAiB,CAAC,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;oBACtE,CAAC,CAAC;wBACE,OAAO,EAAE;4BACP,cAAc;4BACd,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,OAAO,CAAC,UAAU,IAAI,EAAE;4BACxB,OAAO,CAAC,YAAY,IAAI,EAAE;4BAC1B,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;4BACF,EAAE;yBACH;qBACF;oBACH,CAAC,CAAC,SAAS;aACd;SACF;QACD,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvD,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAjGY,QAAA,aAAa,iBAiGzB;AAEM,MAAM,oBAAoB,GAAG,CAAC,QAAkB,EAAE,qBAA6B,EAAU,EAAE;IAChG,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAA;IAC1C,MAAM,SAAS,GAAG,wBAAgB,CAAC,WAAW,CAAC,CAAA;IAC/C,MAAM,WAAW,GAAG,wBAAgB,CAAC,QAAQ,CAAC,CAAA;IAC9C,MAAM,YAAY,GAAG,SAAS,IAAI,WAAW,CAAA;IAE7C,6DAAqD,CAAC,YAAY,EAAE,+BAA+B,CAAC,CAAA;IAEpG,8CAAsC,CACpC,qBAAqB,KAAK,YAAY,IAAI,yBAAiB,CAAC,SAAS,CAAC,EACtE,sFAAsF,CACvF,CAAA;IAED,8CAAsC,CACpC,qBAAqB,KAAK,KAAK,IAAI,yBAAiB,CAAC,WAAW,CAAC,EACjE,gCAAgC,qBAAqB,iCAAiC,CACvF,CAAA;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAnBY,QAAA,oBAAoB,wBAmBhC;AAEM,MAAM,eAAe,GAAG,CAAC,YAAoB,EAAE,SAAiB,EAAE,EAAE,CACzE,8BAA8B,YAAY,wBAAwB,SAAS,EAAE,CAAA;AADlE,QAAA,eAAe,mBACmD;AAExE,MAAM,iBAAiB,GAAG,KAAK,EACpC,OAAsB,EACtB,IAAqC,EACrC,MAAM,GAAG,IAAI,EACuB,EAAE;IACtC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;IAClC,MAAM,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAA;IACzC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAA;IAExC,6DAAqD,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAA;IAE5F,MAAM,GAAG,GAAG,uBAAe,CAAC,4BAAoB,CAAC,QAAQ,EAAE,qBAAqB,CAAC,EAAE,SAAS,CAAC,CAAA;IAC7F,MAAM,IAAI,GAAG,qBAAa,CAAC,uBAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;IAEtE,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,MAAM,EAAE,MAAM;QACd,IAAI;KACL,CAAC,CAAA;AACJ,CAAC,CAAA;AAlBY,QAAA,iBAAiB,qBAkB7B"}

package/dist/destinations/snap-conversions-api/reportConversionEvent/utils.d.ts

@@ -0,0 +1,19 @@
+export declare const isNullOrUndefined: <T>(v: T | null | undefined) => v is null | undefined;
+export declare const hash: (value: string | undefined) => string | undefined;
+export declare const isHashedEmail: (email: string) => boolean;
+export declare const transformProperty: (property: string, items: Array<Record<string, string | number | undefined>>) => string;
+export declare const hashEmailSafe: (email: string | undefined) => string | undefined;
+export declare const emptyToUndefined: (str: string | undefined) => string | undefined;
+export declare const raiseMisconfiguredRequiredFieldErrorIf: (condition: boolean, message: string) => void;
+interface S {
+    raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined<T>(v: T | undefined, message: string): asserts v is T;
+}
+export declare const raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined: S['raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined'];
+export declare const box: <T>(v: T | undefined) => readonly T[];
+export declare const emptyObjectToUndefined: (v: {
+    [x: string]: unknown;
+}) => {
+    [x: string]: unknown;
+} | undefined;
+export declare const splitListValueToArray: (input: string) => readonly string[] | undefined;
+export {};

package/dist/destinations/snap-conversions-api/reportConversionEvent/utils.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitListValueToArray = exports.emptyObjectToUndefined = exports.box = exports.raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined = exports.raiseMisconfiguredRequiredFieldErrorIf = exports.emptyToUndefined = exports.hashEmailSafe = exports.transformProperty = exports.isHashedEmail = exports.hash = exports.isNullOrUndefined = void 0;
+const actions_core_1 = require("@segment/actions-core");
+const crypto_1 = require("crypto");
+const isNullOrUndefined = (v) => v == null;
+exports.isNullOrUndefined = isNullOrUndefined;
+const hash = (value) => {
+    if (value === undefined)
+        return;
+    const hash = crypto_1.createHash('sha256');
+    hash.update(value);
+    return hash.digest('hex');
+};
+exports.hash = hash;
+const isHashedEmail = (email) => new RegExp(/[0-9abcdef]{64}/gi).test(email);
+exports.isHashedEmail = isHashedEmail;
+const transformProperty = (property, items) => items
+    .map((i) => i[property] === undefined || i[property] === null
+    ? ''
+    : typeof i[property] === 'number'
+        ? i[property].toString()
+        : i[property].toString().replace(/;/g, ''))
+    .join(';');
+exports.transformProperty = transformProperty;
+const hashEmailSafe = (email) => exports.isHashedEmail(String(email)) ? email : exports.hash(email);
+exports.hashEmailSafe = hashEmailSafe;
+const emptyToUndefined = (str) => str != null && str === '' ? undefined : str;
+exports.emptyToUndefined = emptyToUndefined;
+const raiseMisconfiguredRequiredFieldErrorIf = (condition, message) => {
+    if (condition) {
+        throw new actions_core_1.IntegrationError(message, 'Misconfigured required field', 400);
+    }
+};
+exports.raiseMisconfiguredRequiredFieldErrorIf = raiseMisconfiguredRequiredFieldErrorIf;
+const raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined = (v, message) => exports.raiseMisconfiguredRequiredFieldErrorIf(exports.isNullOrUndefined(v), message);
+exports.raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined = raiseMisconfiguredRequiredFieldErrorIfNullOrUndefined;
+const box = (v) => (!exports.isNullOrUndefined(v) ? [v] : []);
+exports.box = box;
+const emptyObjectToUndefined = (v) => {
+    const properties = Object.getOwnPropertyNames(v);
+    if (properties.length === 0) {
+        return undefined;
+    }
+    for (const prop of properties) {
+        if (v[prop] !== undefined) {
+            return v;
+        }
+    }
+    return undefined;
+};
+exports.emptyObjectToUndefined = emptyObjectToUndefined;
+const splitListValueToArray = (input) => {
+    const separator = input.includes(';') ? ';' : ',';
+    const result = input
+        .split(separator)
+        .map((x) => x.trim())
+        .filter((x) => x != '');
+    return result.length > 0 ? result : undefined;
+};
+exports.splitListValueToArray = splitListValueToArray;
+//# sourceMappingURL=utils.js.map

package/dist/destinations/snap-conversions-api/reportConversionEvent/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/reportConversionEvent/utils.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,mCAAmC;AAE5B,MAAM,iBAAiB,GAAG,CAAI,CAAuB,EAAyB,EAAE,CAAC,CAAC,IAAI,IAAI,CAAA;AAApF,QAAA,iBAAiB,qBAAmE;AAE1F,MAAM,IAAI,GAAG,CAAC,KAAyB,EAAsB,EAAE;IACpE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAM;IAE/B,MAAM,IAAI,GAAG,mBAAU,CAAC,QAAQ,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC3B,CAAC,CAAA;AANY,QAAA,IAAI,QAMhB;AAEM,MAAM,aAAa,GAAG,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAAvF,QAAA,aAAa,iBAA0E;AAE7F,MAAM,iBAAiB,GAAG,CAC/B,QAAgB,EAChB,KAAyD,EACjD,EAAE,CACV,KAAK;KACF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACT,CAAC,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI;IAC/C,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ;QACjC,CAAC,CAAE,CAAC,CAAC,QAAQ,CAAY,CAAC,QAAQ,EAAE;QACpC,CAAC,CAAE,CAAC,CAAC,QAAQ,CAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CACzD;KACA,IAAI,CAAC,GAAG,CAAC,CAAA;AAZD,QAAA,iBAAiB,qBAYhB;AAEP,MAAM,aAAa,GAAG,CAAC,KAAyB,EAAsB,EAAE,CAC7E,qBAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAI,CAAC,KAAK,CAAC,CAAA;AADvC,QAAA,aAAa,iBAC0B;AAE7C,MAAM,gBAAgB,GAAG,CAAC,GAAuB,EAAsB,EAAE,CAC9E,GAAG,IAAI,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAA;AADhC,QAAA,gBAAgB,oBACgB;AAEtC,MAAM,sCAAsC,GAAG,CAAC,SAAkB,EAAE,OAAe,EAAE,EAAE;IAC5F,IAAI,SAAS,EAAE;QACb,MAAM,IAAI,+BAAgB,CAAC,OAAO,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;KACzE;AACH,CAAC,CAAA;AAJY,QAAA,sCAAsC,0CAIlD;AAOM,MAAM,qDAAqD,GAChE,CAAI,CAAgB,EAAE,OAAe,EAAkB,EAAE,CACvD,8CAAsC,CAAC,yBAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AAF5D,QAAA,qDAAqD,yDAEO;AAElE,MAAM,GAAG,GAAG,CAAI,CAAgB,EAAgB,EAAE,CAAC,CAAC,CAAC,yBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;AAA/E,QAAA,GAAG,OAA4E;AAErF,MAAM,sBAAsB,GAAG,CAAC,CAA8B,EAAE,EAAE;IACvE,MAAM,UAAU,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;IAEhD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,OAAO,SAAS,CAAA;KACjB;IAED,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE;QAC7B,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE;YACzB,OAAO,CAAC,CAAA;SACT;KACF;IAED,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAdY,QAAA,sBAAsB,0BAclC;AAEM,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAiC,EAAE;IAEpF,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAA;IAGjD,MAAM,MAAM,GAAG,KAAK;SACjB,KAAK,CAAC,SAAS,CAAC;SAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAEzB,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;AAC/C,CAAC,CAAA;AAXY,QAAA,qBAAqB,yBAWjC"}

package/dist/destinations/snap-conversions-api/snap-capi-properties.d.ts

@@ -1,6 +1,4 @@
 import { InputField } from '@segment/actions-core/destination-kit/types';
-import { Settings } from '../snap-conversions-api/generated-types';
-import { Payload } from './reportConversionEvent/generated-types';
 export declare const CURRENCY_ISO_4217_CODES: Set<string>;
 export declare const products: InputField;
 export declare const event_type: InputField;
@@ -30,6 +28,3 @@ export declare const sign_up_method: InputField;
 export declare const device_model: InputField;
 export declare const os_version: InputField;
 export declare const click_id: InputField;
-export declare const conversionType: (settings: Settings, event_conversion_type: String) => Settings;
-export declare const hash: (value: string | undefined) => string | undefined;
-export declare const formatPayload: (payload: Payload) => Object;

package/dist/destinations/snap-conversions-api/snap-capi-properties.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPayload = exports.hash = exports.conversionType = exports.click_id = exports.os_version = exports.device_model = exports.sign_up_method = exports.page_url = exports.search_string = exports.client_dedup_id = exports.level = exports.transaction_id = exports.currency = exports.price = exports.number_items = exports.description = exports.item_ids = exports.brands = exports.item_category = exports.ip_address = exports.user_agent = exports.phone_number = exports.idfv = exports.uuid_c1 = exports.mobile_ad_id = exports.email = exports.timestamp = exports.event_tag = exports.event_conversion_type = exports.event_type = exports.products = exports.CURRENCY_ISO_4217_CODES = void 0;
-const actions_core_1 = require("@segment/actions-core");
-const crypto_1 = require("crypto");
+exports.click_id = exports.os_version = exports.device_model = exports.sign_up_method = exports.page_url = exports.search_string = exports.client_dedup_id = exports.level = exports.transaction_id = exports.currency = exports.price = exports.number_items = exports.description = exports.item_ids = exports.brands = exports.item_category = exports.ip_address = exports.user_agent = exports.phone_number = exports.idfv = exports.uuid_c1 = exports.mobile_ad_id = exports.email = exports.timestamp = exports.event_tag = exports.event_conversion_type = exports.event_type = exports.products = exports.CURRENCY_ISO_4217_CODES = void 0;
 exports.CURRENCY_ISO_4217_CODES = new Set([
     'USD',
     'AED',
@@ -315,87 +313,4 @@ exports.click_id = {
         '@path': '$.integrations.Snap Conversions Api.click_id'
     }
 };
-const conversionType = (settings, event_conversion_type) => {
-    if (event_conversion_type === 'MOBILE_APP') {
-        if (!settings?.snap_app_id || !settings?.app_id) {
-            throw new actions_core_1.IntegrationError('If event conversion type is "MOBILE_APP" then Snap App ID and App ID must be defined', 'Misconfigured required field', 400);
-        }
-        delete settings?.pixel_id;
-    }
-    else {
-        if (!settings?.pixel_id) {
-            throw new actions_core_1.IntegrationError(`If event conversion type is "${event_conversion_type}" then Pixel ID must be defined`, 'Misconfigured required field', 400);
-        }
-        delete settings?.snap_app_id;
-        delete settings?.app_id;
-    }
-    return settings;
-};
-exports.conversionType = conversionType;
-const hash = (value) => {
-    if (value === undefined)
-        return;
-    const hash = crypto_1.createHash('sha256');
-    hash.update(value);
-    return hash.digest('hex');
-};
-exports.hash = hash;
-const isHashedEmail = (email) => new RegExp(/[0-9abcdef]{64}/gi).test(email);
-const transformProperty = (property, items) => items
-    .map((i) => i[property] === undefined || i[property] === null
-    ? ''
-    : typeof i[property] === 'number'
-        ? i[property].toString()
-        : i[property].toString().replace(/;/g, ''))
-    .join(';');
-const formatPayload = (payload) => {
-    if (payload.email) {
-        payload.email = payload.email.replace(/\s/g, '').toLowerCase();
-    }
-    if (payload.phone_number) {
-        payload.phone_number = payload.phone_number.replace(/\D|^0+/g, '');
-    }
-    if (payload.mobile_ad_id) {
-        payload.mobile_ad_id = payload.mobile_ad_id.toLowerCase();
-    }
-    let item_ids = undefined;
-    let item_category = undefined;
-    let brands = undefined;
-    const p = payload?.products;
-    if (p && Array.isArray(p) && p.length > 0) {
-        item_ids = transformProperty('item_id', p);
-        item_category = transformProperty('item_category', p);
-        brands = p.map((product) => product.brand ?? '');
-    }
-    return {
-        event_type: payload?.event_type,
-        event_conversion_type: payload?.event_conversion_type,
-        event_tag: payload?.event_tag,
-        timestamp: Date.parse(payload?.timestamp),
-        hashed_email: isHashedEmail(String(payload?.email)) ? payload?.email : exports.hash(payload?.email),
-        hashed_mobile_ad_id: exports.hash(payload?.mobile_ad_id),
-        uuid_c1: payload?.uuid_c1,
-        hashed_idfv: exports.hash(payload?.idfv),
-        hashed_phone_number: exports.hash(payload?.phone_number),
-        user_agent: payload?.user_agent,
-        hashed_ip_address: exports.hash(payload?.ip_address),
-        item_category: item_category ?? payload?.item_category,
-        brands: brands ?? payload?.brands,
-        item_ids: item_ids ?? payload?.item_ids,
-        description: payload?.description,
-        number_items: payload?.number_items,
-        price: payload?.price,
-        currency: payload?.currency,
-        transaction_id: payload?.transaction_id,
-        level: payload?.level,
-        client_dedup_id: payload?.client_dedup_id,
-        search_string: payload?.search_string,
-        page_url: payload?.page_url,
-        sign_up_method: payload?.sign_up_method,
-        device_model: payload?.device_model,
-        os_version: payload?.os_version,
-        click_id: payload?.click_id
-    };
-};
-exports.formatPayload = formatPayload;
 //# sourceMappingURL=snap-capi-properties.js.map

package/dist/destinations/snap-conversions-api/snap-capi-properties.js.map

@@ -1 +1 @@
-{"version":3,"file":"snap-capi-properties.js","sourceRoot":"","sources":["../../../src/destinations/snap-conversions-api/snap-capi-properties.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AAExD,mCAAmC;AAItB,QAAA,uBAAuB,GAAG,IAAI,GAAG,CAAC;IAC7C,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;CACN,CAAC,CAAA;AAEW,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,2MAA2M;IAC7M,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,OAAO,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,sHAAsH;YACxH,SAAS,EAAE,KAAK;SACjB;QACD,aAAa,EAAE;YACb,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oDAAoD;YACjE,SAAS,EAAE,KAAK;SACjB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8DAA8D;YAC3E,SAAS,EAAE,KAAK;SACjB;KACF;IACD,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,OAAO,EAAE;oBACP,OAAO,EAAE,YAAY;iBACtB;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,UAAU;iBACpB;gBACD,KAAK,EAAE;oBACL,OAAO,EAAE,OAAO;iBACjB;aACF;SACF;KACF;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,8QAA8Q;IAChR,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,qBAAqB,GAAe;IAC/C,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,uEAAuE;IACpF,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;QACtC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;QAC9B,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;KAC7C;CACF,CAAA;AAEY,QAAA,SAAS,GAAe;IACnC,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,qBAAqB;IAClC,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,SAAS,GAAe;IACnC,KAAK,EAAE,iBAAiB;IACxB,WAAW,EACT,8GAA8G;IAChH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,aAAa;KACvB;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EACT,6fAA6f;IAC/f,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACpC;KACF;CACF,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EACT,mhBAAmhB;IACrhB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,gCAAgC;KAC1C;CACF,CAAA;AAEY,QAAA,OAAO,GAAe;IACjC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACT,gHAAgH;IAClH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,6CAA6C;KACvD;CACF,CAAA;AAEY,QAAA,IAAI,GAAe;IAC9B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,mGAAmG;IAChH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,qBAAqB;KAC/B;CACF,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,WAAW,EACT,4fAA4f;IAC9f,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACpC;KACF;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,2ZAA2Z;IAC7Z,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,qBAAqB;KAC/B;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,oeAAoe;IACte,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,cAAc;KACxB;CACF,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,oDAAoD;IACjE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,MAAM,GAAe;IAChC,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,kFAAkF;IAC/F,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,SAAS;IAChB,WAAW,EACT,sHAAsH;IACxH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,yBAAyB;KACnC;CACF,CAAA;AAEY,QAAA,WAAW,GAAe;IACrC,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,2CAA2C;IACxD,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EACT,mIAAmI;IACrI,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;YAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;SACxC;KACF;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,oDAAoD;IACjE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACT,6RAA6R;IAC/R,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,8CAA8C;IAC3D,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,eAAe,GAAe;IACzC,KAAK,EAAE,yBAAyB;IAChC,WAAW,EACT,iYAAiY;IACnY,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,wCAAwC;IACrD,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,qDAAqD;IAClE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,yCAAyC;IACtD,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,0BAA0B;IACvC,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,wBAAwB;IACrC,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,8SAA8S;IAChT,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,8CAA8C;KACxD;CACF,CAAA;AAGM,MAAM,cAAc,GAAG,CAAC,QAAkB,EAAE,qBAA6B,EAAY,EAAE;IAC5F,IAAI,qBAAqB,KAAK,YAAY,EAAE;QAC1C,IAAI,CAAC,QAAQ,EAAE,WAAW,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE;YAC/C,MAAM,IAAI,+BAAgB,CACxB,sFAAsF,EACtF,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QACD,OAAO,QAAQ,EAAE,QAAQ,CAAA;KAC1B;SAAM;QACL,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE;YACvB,MAAM,IAAI,+BAAgB,CACxB,gCAAgC,qBAAqB,iCAAiC,EACtF,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QACD,OAAO,QAAQ,EAAE,WAAW,CAAA;QAC5B,OAAO,QAAQ,EAAE,MAAM,CAAA;KACxB;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAtBY,QAAA,cAAc,kBAsB1B;AAEM,MAAM,IAAI,GAAG,CAAC,KAAyB,EAAsB,EAAE;IACpE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAM;IAE/B,MAAM,IAAI,GAAG,mBAAU,CAAC,QAAQ,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC3B,CAAC,CAAA;AANY,QAAA,IAAI,QAMhB;AAED,MAAM,aAAa,GAAG,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAE7F,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,KAAyD,EAAU,EAAE,CAChH,KAAK;KACF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACT,CAAC,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI;IAC/C,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,QAAQ;QACjC,CAAC,CAAE,CAAC,CAAC,QAAQ,CAAY,CAAC,QAAQ,EAAE;QACpC,CAAC,CAAE,CAAC,CAAC,QAAQ,CAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CACzD;KACA,IAAI,CAAC,GAAG,CAAC,CAAA;AAEP,MAAM,aAAa,GAAG,CAAC,OAAgB,EAAU,EAAE;IAExD,IAAI,OAAO,CAAC,KAAK,EAAE;QAEjB,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;KAC/D;IAED,IAAI,OAAO,CAAC,YAAY,EAAE;QAExB,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;KACnE;IAED,IAAI,OAAO,CAAC,YAAY,EAAE;QAExB,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,WAAW,EAAE,CAAA;KAC1D;IAED,IAAI,QAAQ,GAAuB,SAAS,CAAA;IAC5C,IAAI,aAAa,GAAuB,SAAS,CAAA;IACjD,IAAI,MAAM,GAAyB,SAAS,CAAA;IAG5C,MAAM,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAA;IAC3B,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QACzC,QAAQ,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;QAC1C,aAAa,GAAG,iBAAiB,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;QACrD,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;KACjD;IAED,OAAO;QACL,UAAU,EAAE,OAAO,EAAE,UAAU;QAC/B,qBAAqB,EAAE,OAAO,EAAE,qBAAqB;QACrD,SAAS,EAAE,OAAO,EAAE,SAAS;QAC7B,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC;QACzC,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,YAAI,CAAC,OAAO,EAAE,KAAK,CAAC;QAC3F,mBAAmB,EAAE,YAAI,CAAC,OAAO,EAAE,YAAY,CAAC;QAChD,OAAO,EAAE,OAAO,EAAE,OAAO;QACzB,WAAW,EAAE,YAAI,CAAC,OAAO,EAAE,IAAI,CAAC;QAChC,mBAAmB,EAAE,YAAI,CAAC,OAAO,EAAE,YAAY,CAAC;QAChD,UAAU,EAAE,OAAO,EAAE,UAAU;QAC/B,iBAAiB,EAAE,YAAI,CAAC,OAAO,EAAE,UAAU,CAAC;QAC5C,aAAa,EAAE,aAAa,IAAI,OAAO,EAAE,aAAa;QACtD,MAAM,EAAE,MAAM,IAAI,OAAO,EAAE,MAAM;QACjC,QAAQ,EAAE,QAAQ,IAAI,OAAO,EAAE,QAAQ;QACvC,WAAW,EAAE,OAAO,EAAE,WAAW;QACjC,YAAY,EAAE,OAAO,EAAE,YAAY;QACnC,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,cAAc,EAAE,OAAO,EAAE,cAAc;QACvC,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,eAAe,EAAE,OAAO,EAAE,eAAe;QACzC,aAAa,EAAE,OAAO,EAAE,aAAa;QACrC,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,cAAc,EAAE,OAAO,EAAE,cAAc;QACvC,YAAY,EAAE,OAAO,EAAE,YAAY;QACnC,UAAU,EAAE,OAAO,EAAE,UAAU;QAC/B,QAAQ,EAAE,OAAO,EAAE,QAAQ;KAC5B,CAAA;AACH,CAAC,CAAA;AA1DY,QAAA,aAAa,iBA0DzB"}
+{"version":3,"file":"snap-capi-properties.js","sourceRoot":"","sources":["../../../src/destinations/snap-conversions-api/snap-capi-properties.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAG,IAAI,GAAG,CAAC;IAC7C,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;CACN,CAAC,CAAA;AAEW,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,2MAA2M;IAC7M,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,OAAO,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,sHAAsH;YACxH,SAAS,EAAE,KAAK;SACjB;QACD,aAAa,EAAE;YACb,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oDAAoD;YACjE,SAAS,EAAE,KAAK;SACjB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8DAA8D;YAC3E,SAAS,EAAE,KAAK;SACjB;KACF;IACD,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,OAAO,EAAE;oBACP,OAAO,EAAE,YAAY;iBACtB;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,UAAU;iBACpB;gBACD,KAAK,EAAE;oBACL,OAAO,EAAE,OAAO;iBACjB;aACF;SACF;KACF;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,8QAA8Q;IAChR,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,qBAAqB,GAAe;IAC/C,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,uEAAuE;IACpF,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;QACtC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;QAC9B,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;KAC7C;CACF,CAAA;AAEY,QAAA,SAAS,GAAe;IACnC,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,qBAAqB;IAClC,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,SAAS,GAAe;IACnC,KAAK,EAAE,iBAAiB;IACxB,WAAW,EACT,8GAA8G;IAChH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,aAAa;KACvB;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EACT,6fAA6f;IAC/f,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACpC;KACF;CACF,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EACT,mhBAAmhB;IACrhB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,gCAAgC;KAC1C;CACF,CAAA;AAEY,QAAA,OAAO,GAAe;IACjC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACT,gHAAgH;IAClH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,6CAA6C;KACvD;CACF,CAAA;AAEY,QAAA,IAAI,GAAe;IAC9B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,mGAAmG;IAChH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,qBAAqB;KAC/B;CACF,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,WAAW,EACT,4fAA4f;IAC9f,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;SACpC;KACF;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,2ZAA2Z;IAC7Z,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,qBAAqB;KAC/B;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,oeAAoe;IACte,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,cAAc;KACxB;CACF,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,oDAAoD;IACjE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,MAAM,GAAe;IAChC,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,kFAAkF;IAC/F,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,SAAS;IAChB,WAAW,EACT,sHAAsH;IACxH,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,yBAAyB;KACnC;CACF,CAAA;AAEY,QAAA,WAAW,GAAe;IACrC,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,2CAA2C;IACxD,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,6DAA6D;IAC1E,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EACT,mIAAmI;IACrI,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,KAAK,EAAE;YACL,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;YAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;SACxC;KACF;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,oDAAoD;IACjE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACT,6RAA6R;IAC/R,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,uBAAuB;KACjC;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,8CAA8C;IAC3D,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,eAAe,GAAe;IACzC,KAAK,EAAE,yBAAyB;IAChC,WAAW,EACT,iYAAiY;IACnY,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,aAAa,GAAe;IACvC,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,wCAAwC;IACrD,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,qDAAqD;IAClE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AAEY,QAAA,cAAc,GAAe;IACxC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,yCAAyC;IACtD,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,YAAY,GAAe;IACtC,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,0BAA0B;IACvC,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,wBAAwB;IACrC,IAAI,EAAE,QAAQ;CACf,CAAA;AAEY,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,8SAA8S;IAChT,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP,OAAO,EAAE,8CAA8C;KACxD;CACF,CAAA"}

package/dist/destinations/tiktok-conversions/common_fields.d.ts

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

package/dist/destinations/tiktok-conversions/common_fields.js

@@ -0,0 +1,245 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commonFields = void 0;
+exports.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 [Events API documentation](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106) 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'
+        }
+    },
+    timestamp: {
+        label: 'Event Timestamp',
+        type: 'string',
+        description: 'Timestamp that the event took place, in ISO 8601 format.',
+        default: {
+            '@path': '$.timestamp'
+        }
+    },
+    phone_number: {
+        label: 'Phone Number',
+        description: 'A single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. e.g. +14150000000. Segment will hash this value before sending to TikTok.',
+        type: 'string',
+        multiple: true,
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.phone' },
+                then: { '@path': '$.properties.phone' },
+                else: { '@path': '$.context.traits.phone' }
+            }
+        }
+    },
+    email: {
+        label: 'Email',
+        description: 'A single email address or an array of email addresses. Segment will hash this value before sending to TikTok.',
+        type: 'string',
+        format: 'email',
+        multiple: true,
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.email' },
+                then: { '@path': '$.properties.email' },
+                else: { '@path': '$.context.traits.email' }
+            }
+        }
+    },
+    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. Segment will hash this value before sending to TikTok. TikTok Conversions Destination supports both string and string[] types for sending external ID(s).',
+        type: 'string',
+        multiple: true,
+        default: {
+            '@if': {
+                exists: { '@path': '$.userId' },
+                then: { '@path': '$.userId' },
+                else: { '@path': '$.anonymousId' }
+            }
+        }
+    },
+    ttclid: {
+        label: 'TikTok Click ID',
+        description: 'The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See [Set up ttclid](https://ads.tiktok.com/marketing_api/docs?rid=4eezrhr6lg4&id=1681728034437121) for details.',
+        type: 'string',
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.ttclid' },
+                then: { '@path': '$.properties.ttclid' },
+                else: { '@path': '$.integrations.TikTok Conversions.ttclid' }
+            }
+        }
+    },
+    ttp: {
+        label: 'TikTok Cookie ID',
+        description: 'TikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the `_ttp` cookie. The value of `_ttp` is used to match website visitor events with TikTok ads. You can extract the value of `_ttp` and attach the value here. To learn more about the `ttp` parameter, refer to [Events API 2.0 - Send TikTok Cookie](https://ads.tiktok.com/marketing_api/docs?id=%201771100936446977) (`_ttp`).',
+        type: 'string',
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.ttp' },
+                then: { '@path': '$.properties.ttp' },
+                else: { '@path': '$.integrations.TikTok Conversions.ttp' }
+            }
+        }
+    },
+    lead_id: {
+        label: 'TikTok Lead ID',
+        description: 'ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability',
+        type: 'string',
+        default: { '@path': '$.properties.lead_id' }
+    },
+    locale: {
+        label: 'Locale',
+        description: 'The BCP 47 language identifier. For reference, refer to the [IETF BCP 47 standardized code](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).',
+        type: 'string',
+        default: {
+            '@path': '$.context.locale'
+        }
+    },
+    url: {
+        label: 'Page URL',
+        type: 'string',
+        description: 'The page URL where the conversion event took place.',
+        default: {
+            '@path': '$.context.page.url'
+        }
+    },
+    referrer: {
+        label: 'Page Referrer',
+        type: 'string',
+        description: 'The page referrer.',
+        default: {
+            '@path': '$.context.page.referrer'
+        }
+    },
+    ip: {
+        label: 'IP Address',
+        type: 'string',
+        description: 'IP address of the browser.',
+        default: {
+            '@path': '$.context.ip'
+        }
+    },
+    user_agent: {
+        label: 'User Agent',
+        type: 'string',
+        description: 'User agent from the user’s device.',
+        default: {
+            '@path': '$.context.userAgent'
+        }
+    },
+    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: ['product', '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'
+        }
+    },
+    limited_data_use: {
+        label: 'Limited Data Use',
+        type: 'boolean',
+        description: 'Use this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to [Events API 2.0 - Limited Data Use](https://ads.tiktok.com/marketing_api/docs?id=1771101204435970).',
+        default: {
+            '@path': '$.properties.limited_data_use'
+        }
+    },
+    test_event_code: {
+        label: 'Test Event Code',
+        type: 'string',
+        description: 'Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the "Test Event" tab. You\'ll want to remove your Test Event Code when sending real traffic through this integration.'
+    }
+};
+//# sourceMappingURL=common_fields.js.map

package/dist/destinations/tiktok-conversions/common_fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common_fields.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions/common_fields.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAA+B;IACtD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,8MAA8M;KACjN;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wDAAwD;QACrE,OAAO,EAAE;YACP,OAAO,EAAE,aAAa;SACvB;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,0DAA0D;QACvE,OAAO,EAAE;YACP,OAAO,EAAE,aAAa;SACvB;KACF;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,4MAA4M;QAC9M,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,EACT,+GAA+G;QACjH,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,OAAO;QACf,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,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE;YACP,OAAO,EAAE,uBAAuB;SACjC;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE;YACP,OAAO,EAAE,sBAAsB;SAChC;KACF;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,4NAA4N;QAC9N,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;IACD,MAAM,EAAE;QACN,KAAK,EAAE,iBAAiB;QACxB,WAAW,EACT,+NAA+N;QACjO,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;gBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;gBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,0CAA0C,EAAE;aAC9D;SACF;KACF;IACD,GAAG,EAAE;QACH,KAAK,EAAE,kBAAkB;QACzB,WAAW,EACT,+bAA+b;QACjc,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,uCAAuC,EAAE;aAC3D;SACF;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,gBAAgB;QACvB,WAAW,EACT,0LAA0L;QAC5L,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;KAC7C;IACD,MAAM,EAAE;QACN,KAAK,EAAE,QAAQ;QACf,WAAW,EACT,4IAA4I;QAC9I,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,kBAAkB;SAC5B;KACF;IACD,GAAG,EAAE;QACH,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,qDAAqD;QAClE,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oBAAoB;QACjC,OAAO,EAAE;YACP,OAAO,EAAE,yBAAyB;SACnC;KACF;IACD,EAAE,EAAE;QACF,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE;YACP,OAAO,EAAE,cAAc;SACxB;KACF;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE;YACP,OAAO,EAAE,qBAAqB;SAC/B;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,qCAAqC;QAClD,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,oBAAoB;gBACjC,IAAI,EAAE,QAAQ;aACf;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,QAAQ;aACf;YACD,gBAAgB,EAAE;gBAChB,KAAK,EAAE,kBAAkB;gBACzB,WAAW,EAAE,+BAA+B;gBAC5C,IAAI,EAAE,QAAQ;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,QAAQ;aACf;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,QAAQ;aACf;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,iCAAiC;gBAC9C,IAAI,EAAE,QAAQ;aACf;SACF;KACF;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,uPAAuP;QACzP,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;QACrC,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE;YACP,OAAO,EAAE,uBAAuB;SACjC;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,mCAAmC;QAChD,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,sBAAsB,EAAE;aAC1C;SACF;KACF;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;KACtD;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;QACrD,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,gBAAgB,EAAE;QAChB,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,SAAS;QACf,WAAW,EACT,uZAAuZ;QACzZ,OAAO,EAAE;YACP,OAAO,EAAE,+BAA+B;SACzC;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,qRAAqR;KACxR;CACF,CAAA"}

package/dist/destinations/tiktok-conversions/formatter.d.ts

@@ -0,0 +1,3 @@
+export declare const formatEmails: (email_addresses: string[] | undefined) => string[];
+export declare const formatPhones: (phone_numbers: string[] | undefined) => string[];
+export declare function formatUserIds(userIds: string[] | undefined): string[];