@segment/action-destinations 3.259.0 → 3.260.0-staging.0

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

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.performSnapCAPIv2 = void 0;
+const actions_core_1 = require("@segment/actions-core");
+const snap_capi_properties_1 = require("../snap-capi-properties");
+const utils_1 = require("./utils");
+const conversionType = (oldSettings, event_conversion_type) => {
+    const settings = { ...oldSettings };
+    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;
+};
+const formatPayload = (oldPayload) => {
+    const payload = { ...oldPayload };
+    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 = utils_1.transformProperty('item_id', p);
+        item_category = utils_1.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: utils_1.isHashedEmail(String(payload?.email)) ? payload?.email : utils_1.hash(payload?.email),
+        hashed_mobile_ad_id: utils_1.hash(payload?.mobile_ad_id),
+        uuid_c1: payload?.uuid_c1,
+        hashed_idfv: utils_1.hash(payload?.idfv),
+        hashed_phone_number: utils_1.hash(payload?.phone_number),
+        user_agent: payload?.user_agent,
+        hashed_ip_address: utils_1.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
+    };
+};
+const CONVERSION_EVENT_URL = 'https://tr.snapchat.com/v2/conversion';
+const performSnapCAPIv2 = (request, data) => {
+    if (data.payload.currency && !snap_capi_properties_1.CURRENCY_ISO_4217_CODES.has(data.payload.currency.toUpperCase())) {
+        throw new actions_core_1.IntegrationError(`${data.payload.currency} is not a valid currency code.`, 'Misconfigured required field', 400);
+    }
+    if (!data.payload.email &&
+        !data.payload.phone_number &&
+        !data.payload.mobile_ad_id &&
+        (!data.payload.ip_address || !data.payload.user_agent)) {
+        throw new actions_core_1.IntegrationError(`Payload must contain values for Email or Phone Number or Mobile Ad Identifier or both IP Address and User Agent fields`, 'Misconfigured required field', 400);
+    }
+    const payload = formatPayload(data.payload);
+    const settings = conversionType(data.settings, data.payload.event_conversion_type);
+    return request(CONVERSION_EVENT_URL, {
+        method: 'post',
+        json: {
+            integration: 'segment',
+            ...payload,
+            ...settings
+        }
+    });
+};
+exports.performSnapCAPIv2 = performSnapCAPIv2;
+//# sourceMappingURL=snap-capi-v2.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snap-capi-v2.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v2.ts"],"names":[],"mappings":";;;AAAA,wDAAuG;AAGvG,kEAAiE;AACjE,mCAAgE;AAGhE,MAAM,cAAc,GAAG,CAAC,WAAqB,EAAE,qBAA6B,EAAY,EAAE;IAExF,MAAM,QAAQ,GAAG,EAAE,GAAG,WAAW,EAAE,CAAA;IAEnC,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;AAED,MAAM,aAAa,GAAG,CAAC,UAAmB,EAAU,EAAE;IAEpD,MAAM,OAAO,GAAG,EAAE,GAAG,UAAU,EAAE,CAAA;IAGjC,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,yBAAiB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;QAC1C,aAAa,GAAG,yBAAiB,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,qBAAa,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;AAED,MAAM,oBAAoB,GAAG,uCAAuC,CAAA;AAE7D,MAAM,iBAAiB,GAAG,CAC/B,OAAsB,EACtB,IAAqC,EACD,EAAE;IACtC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,8CAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE;QAC9F,MAAM,IAAI,+BAAgB,CACxB,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,gCAAgC,EACxD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;KACF;IAED,IACE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK;QACnB,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY;QAC1B,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY;QAC1B,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EACtD;QACA,MAAM,IAAI,+BAAgB,CACxB,wHAAwH,EACxH,8BAA8B,EAC9B,GAAG,CACJ,CAAA;KACF;IAED,MAAM,OAAO,GAAW,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACnD,MAAM,QAAQ,GAAa,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAG5F,OAAO,OAAO,CAAC,oBAAoB,EAAE;QACnC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACJ,WAAW,EAAE,SAAS;YACtB,GAAG,OAAO;YACV,GAAG,QAAQ;SACZ;KACF,CAAC,CAAA;AACJ,CAAC,CAAA;AArCY,QAAA,iBAAiB,qBAqC7B"}

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

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

package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/formatter.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPhones = exports.formatUserIds = exports.formatEmails = void 0;
+const crypto_1 = require("crypto");
+const formatEmails = (email_addresses) => {
+    const result = [];
+    if (email_addresses) {
+        email_addresses.forEach((email) => {
+            result.push(hashAndEncode(email.toLowerCase()));
+        });
+    }
+    return result;
+};
+exports.formatEmails = formatEmails;
+function formatUserIds(userIds) {
+    const result = [];
+    if (userIds) {
+        userIds.forEach((userId) => {
+            result.push(hashAndEncode(userId.toLowerCase()));
+        });
+    }
+    return result;
+}
+exports.formatUserIds = formatUserIds;
+const formatPhones = (phone_numbers) => {
+    const result = [];
+    if (!phone_numbers)
+        return result;
+    phone_numbers.forEach((phone) => {
+        const validatedPhone = phone.match(/[0-9]{0,14}/g);
+        if (validatedPhone === null) {
+            throw new Error(`${phone} is not a valid E.164 phone number.`);
+        }
+        const formattedPhone = `+${phone.replace(/[^0-9]/g, '')}`;
+        result.push(hashAndEncode(formattedPhone.substring(0, 15)));
+    });
+    return result;
+};
+exports.formatPhones = formatPhones;
+function hashAndEncode(property) {
+    return crypto_1.createHash('sha256').update(property).digest('hex');
+}
+//# sourceMappingURL=formatter.js.map

package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/reportOfflineEvent/formatter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAK5B,MAAM,YAAY,GAAG,CAAC,eAAqC,EAAY,EAAE;IAC9E,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,eAAe,EAAE;QACnB,eAAe,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AARY,QAAA,YAAY,gBAQxB;AAOD,SAAgB,aAAa,CAAC,OAA6B;IACzD,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACjC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AARD,sCAQC;AAOM,MAAM,YAAY,GAAG,CAAC,aAAmC,EAAY,EAAE;IAC5E,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,CAAC,aAAa;QAAE,OAAO,MAAM,CAAA;IAEjC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;QACtC,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QAClD,IAAI,cAAc,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;SAC/D;QAED,MAAM,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IAC7D,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAhBY,QAAA,YAAY,gBAgBxB;AAED,SAAS,aAAa,CAAC,QAAgB;IACrC,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC5D,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.259.0",
+  "version": "3.260.0-staging.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -43,8 +43,8 @@
     "@bufbuild/protobuf": "^1.4.2",
     "@bufbuild/protoc-gen-es": "^1.4.2",
     "@segment/a1-notation": "^2.1.4",
-    "@segment/actions-core": "^3.106.0",
-    "@segment/actions-shared": "^1.87.0",
+    "@segment/actions-core": "3.105.0-staging-3d1490e68",
+    "@segment/actions-shared": "^1.86.0",
     "@types/node": "^18.11.15",
     "ajv-formats": "^2.1.1",
     "aws4": "^1.12.0",
@@ -86,5 +86,5 @@
       "__tests__/__helpers__/"
     ]
   },
-  "gitHead": "d16ddd5bb5007e50a36d821e022aa1e67596b651"
+  "gitHead": "9c04e12c4a0e81f6b68dca0a297fb2c0209d2431"
 }