@segment/action-destinations 3.480.0 → 3.481.0

package/dist/destinations/facebook-conversions-api/fb-capi-user-data.js

@@ -0,0 +1,272 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hash_user_data = exports.normalize_user_data = exports.user_data_field = void 0;
+const constants_1 = require("./constants");
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const hashing_utils_1 = require("../../lib/hashing-utils");
+exports.user_data_field = {
+    label: 'User Data',
+    description: 'These parameters are a set of identifiers Facebook can use for targeted attribution. You must provide at least one of the following parameters in your request. More information on recommended User Data parameters in Facebook’s [Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366).',
+    type: 'object',
+    required: true,
+    properties: {
+        externalId: {
+            label: 'External ID',
+            description: 'Any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. You can send one or more external IDs for a given event.',
+            type: 'string',
+            multiple: true,
+            category: 'hashedPII'
+        },
+        email: {
+            label: 'Email',
+            description: 'An email address in lowercase.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        phone: {
+            label: 'Phone',
+            description: 'A phone number. Include only digits with country code, area code, and number. Remove symbols, letters, and any leading zeros. In addition, always include the country code, even if all of the data is from the same country, as the country code is used for matching.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        gender: {
+            label: 'Gender',
+            description: 'Gender in lowercase. Either f or m.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        dateOfBirth: {
+            label: 'Date of Birth',
+            description: 'A date of birth given as year, month, and day. Example: 19971226 for December 26, 1997.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        lastName: {
+            label: 'Last Name',
+            description: 'A last name in lowercase.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        firstName: {
+            label: 'First Name',
+            description: 'A first name in lowercase.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        city: {
+            label: 'City',
+            description: 'A city in lowercase without spaces or punctuation. Example: menlopark.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        state: {
+            label: 'State',
+            description: 'A two-letter state code in lowercase. Example: ca.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        zip: {
+            label: 'Zip Code',
+            description: 'A five-digit zip code for United States. For other locations, follow each country`s standards.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        country: {
+            label: 'Country',
+            description: 'A two-letter country code in lowercase.',
+            type: 'string',
+            category: 'hashedPII'
+        },
+        client_ip_address: {
+            label: 'Client IP Address',
+            description: 'The IP address of the browser corresponding to the event.',
+            type: 'string'
+        },
+        client_user_agent: {
+            label: 'Client User Agent',
+            description: 'The user agent for the browser corresponding to the event. This is required if action source is “website”.',
+            type: 'string'
+        },
+        fbc: {
+            label: 'Click ID',
+            description: 'The Facebook click ID value stored in the _fbc browser cookie under your domain.',
+            type: 'string'
+        },
+        fbp: {
+            label: 'Browser ID',
+            description: 'The Facebook browser ID value stored in the _fbp browser cookie under your domain.',
+            type: 'string'
+        },
+        subscriptionID: {
+            label: 'Subscription ID',
+            description: 'The subscription ID for the user in this transaction.',
+            type: 'string'
+        },
+        leadID: {
+            label: 'Lead ID',
+            description: 'The ID associated with a lead generated by Facebook`s Lead Ads.',
+            type: 'integer'
+        },
+        fbLoginID: {
+            label: 'Facebook Login ID',
+            description: 'The ID issued by Facebook when a person first logs into an instance of an app.',
+            type: 'integer'
+        },
+        anonId: {
+            label: 'Install ID (anon_id)',
+            description: 'This field represents unique application installation instances. Note: This parameter is for app events only.',
+            type: 'string'
+        },
+        madId: {
+            label: 'Advertiser ID (madid)',
+            description: 'Your mobile advertiser ID, the advertising ID from an Android device or the Advertising Identifier (IDFA) from an Apple device.',
+            type: 'string'
+        },
+        partner_id: {
+            label: 'Partner ID',
+            description: 'The ID issued by Facebook identity partner.',
+            type: 'string'
+        },
+        partner_name: {
+            label: 'Partner Name',
+            description: 'The name of the Facebook identity partner.',
+            type: 'string'
+        }
+    },
+    default: {
+        externalId: {
+            '@if': {
+                exists: { '@path': '$.userId' },
+                then: { '@path': '$.userId' },
+                else: { '@path': '$.anonymousId' }
+            }
+        },
+        email: {
+            '@path': '$.context.traits.email'
+        },
+        phone: {
+            '@path': '$.context.traits.phone'
+        },
+        dateOfBirth: {
+            '@path': '$.context.traits.birthday'
+        },
+        lastName: {
+            '@path': '$.context.traits.lastName'
+        },
+        firstName: {
+            '@path': '$.context.traits.firstName'
+        },
+        city: {
+            '@path': '$.context.traits.address.city'
+        },
+        state: {
+            '@path': '$.context.traits.address.state'
+        },
+        zip: {
+            '@path': '$.context.traits.address.postalCode'
+        },
+        client_ip_address: {
+            '@path': '$.context.ip'
+        },
+        client_user_agent: {
+            '@path': '$.context.userAgent'
+        },
+        fbc: {
+            '@path': '$.properties.fbc'
+        },
+        fbp: {
+            '@path': '$.properties.fbp'
+        }
+    }
+};
+const isHashedInformation = (information) => new RegExp(/[0-9abcdef]{64}/gi).test(information);
+const hash = (value) => {
+    if (value === undefined || !value.length)
+        return;
+    if (typeof value == 'string') {
+        return (0, hashing_utils_1.processHashing)(value, 'sha256', 'hex');
+    }
+    return value.map((el) => (0, hashing_utils_1.processHashing)(el, 'sha256', 'hex'));
+};
+const normalize_user_data = (payload) => {
+    if (payload.user_data.email) {
+        payload.user_data.email = payload.user_data.email.replace(/\s/g, '').toLowerCase();
+    }
+    if (payload.user_data.phone && !isHashedInformation(payload.user_data.phone)) {
+        payload.user_data.phone = payload.user_data.phone.replace(/\D/g, '');
+    }
+    if (payload.user_data.gender) {
+        payload.user_data.gender = payload.user_data.gender.replace(/\s/g, '').toLowerCase();
+        switch (payload.user_data.gender) {
+            case 'male':
+                payload.user_data.gender = 'm';
+                break;
+            case 'female':
+                payload.user_data.gender = 'f';
+                break;
+        }
+    }
+    if (payload.user_data.lastName) {
+        payload.user_data.lastName = payload.user_data.lastName.replace(/\s/g, '').toLowerCase();
+    }
+    if (payload.user_data.firstName) {
+        payload.user_data.firstName = payload.user_data.firstName.replace(/\s/g, '').toLowerCase();
+    }
+    if (payload.user_data.city) {
+        payload.user_data.city = payload.user_data.city.replace(/\s/g, '').toLowerCase();
+    }
+    if (payload.user_data.state) {
+        payload.user_data.state = payload.user_data.state.replace(/\s/g, '').toLowerCase();
+        if (constants_1.US_STATE_CODES.has(payload.user_data.state)) {
+            payload.user_data.state = constants_1.US_STATE_CODES.get(payload.user_data.state);
+        }
+    }
+    if (payload.user_data.zip) {
+        payload.user_data.zip = payload.user_data.zip.replace(/\s/g, '').toLowerCase();
+    }
+    if (payload.user_data.country) {
+        payload.user_data.country = payload.user_data.country.replace(/\s/g, '').toLowerCase();
+        if (constants_1.COUNTRY_CODES.has(payload.user_data.country)) {
+            payload.user_data.country = constants_1.COUNTRY_CODES.get(payload.user_data.country);
+        }
+    }
+    if (!(0, isEmpty_1.default)(payload.user_data?.externalId)) {
+        if (typeof payload.user_data?.externalId === 'string') {
+            payload.user_data.externalId = [payload.user_data?.externalId];
+        }
+        payload.user_data.externalId = payload.user_data.externalId?.map((el) => el.replace(/\s/g, '').toLowerCase());
+    }
+};
+exports.normalize_user_data = normalize_user_data;
+const hash_user_data = (payload) => {
+    (0, exports.normalize_user_data)(payload);
+    return {
+        em: hash(payload.user_data?.email),
+        ph: hash(payload.user_data?.phone),
+        ge: hash(payload.user_data?.gender),
+        db: hash(payload.user_data?.dateOfBirth),
+        ln: hash(payload.user_data?.lastName),
+        fn: hash(payload.user_data?.firstName),
+        ct: hash(payload.user_data?.city),
+        st: hash(payload.user_data?.state),
+        zp: hash(payload.user_data?.zip),
+        country: hash(payload.user_data?.country),
+        external_id: hash(payload.user_data?.externalId),
+        client_ip_address: payload.user_data?.client_ip_address,
+        client_user_agent: payload.user_data?.client_user_agent,
+        fbc: payload.user_data?.fbc,
+        fbp: payload.user_data?.fbp,
+        subscription_id: payload.user_data?.subscriptionID,
+        lead_id: payload.user_data?.leadID,
+        anon_id: payload.user_data?.anonId,
+        madid: payload.user_data?.madId,
+        fb_login_id: payload.user_data?.fbLoginID,
+        partner_id: payload.user_data?.partner_id,
+        partner_name: payload.user_data?.partner_name
+    };
+};
+exports.hash_user_data = hash_user_data;
+//# sourceMappingURL=fb-capi-user-data.js.map

package/dist/destinations/facebook-conversions-api/fb-capi-user-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fb-capi-user-data.js","sourceRoot":"","sources":["../../../src/destinations/facebook-conversions-api/fb-capi-user-data.ts"],"names":[],"mappings":";;;;;;AACA,2CAA2D;AAE3D,6DAAoC;AACpC,2DAAwD;AAI3C,QAAA,eAAe,GAAe;IACzC,KAAK,EAAE,WAAW;IAClB,WAAW,EACT,kUAAkU;IACpU,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE;QACV,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,gKAAgK;YAClK,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,gCAAgC;YAC7C,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EACT,yQAAyQ;YAC3Q,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,WAAW,EAAE;YACX,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,yFAAyF;YACtG,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,2BAA2B;YACxC,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,4BAA4B;YACzC,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,MAAM;YACb,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,GAAG,EAAE;YACH,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,gGAAgG;YAC7G,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,OAAO,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,WAAW;SACtB;QACD,iBAAiB,EAAE;YACjB,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,2DAA2D;YACxE,IAAI,EAAE,QAAQ;SACf;QACD,iBAAiB,EAAE;YACjB,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EACT,4GAA4G;YAC9G,IAAI,EAAE,QAAQ;SACf;QACD,GAAG,EAAE;YACH,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,kFAAkF;YAC/F,IAAI,EAAE,QAAQ;SACf;QACD,GAAG,EAAE;YACH,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,oFAAoF;YACjG,IAAI,EAAE,QAAQ;SACf;QACD,cAAc,EAAE;YACd,KAAK,EAAE,iBAAiB;YACxB,WAAW,EAAE,uDAAuD;YACpE,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,SAAS;SAChB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,gFAAgF;YAC7F,IAAI,EAAE,SAAS;SAChB;QACD,MAAM,EAAE;YACN,KAAK,EAAE,sBAAsB;YAC7B,WAAW,EACT,+GAA+G;YACjH,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,KAAK,EAAE,uBAAuB;YAC9B,WAAW,EACT,iIAAiI;YACnI,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,6CAA6C;YAC1D,IAAI,EAAE,QAAQ;SACf;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,QAAQ;SACf;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,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;QACD,KAAK,EAAE;YACL,OAAO,EAAE,wBAAwB;SAClC;QACD,KAAK,EAAE;YACL,OAAO,EAAE,wBAAwB;SAClC;QACD,WAAW,EAAE;YACX,OAAO,EAAE,2BAA2B;SACrC;QACD,QAAQ,EAAE;YACR,OAAO,EAAE,2BAA2B;SACrC;QACD,SAAS,EAAE;YACT,OAAO,EAAE,4BAA4B;SACtC;QACD,IAAI,EAAE;YACJ,OAAO,EAAE,+BAA+B;SACzC;QACD,KAAK,EAAE;YACL,OAAO,EAAE,gCAAgC;SAC1C;QACD,GAAG,EAAE;YACH,OAAO,EAAE,qCAAqC;SAC/C;QACD,iBAAiB,EAAE;YACjB,OAAO,EAAE,cAAc;SACxB;QACD,iBAAiB,EAAE;YACjB,OAAO,EAAE,qBAAqB;SAC/B;QACD,GAAG,EAAE;YACH,OAAO,EAAE,kBAAkB;SAC5B;QACD,GAAG,EAAE;YACH,OAAO,EAAE,kBAAkB;SAC5B;KACF;CACF,CAAA;AAID,MAAM,mBAAmB,GAAG,CAAC,WAAmB,EAAW,EAAE,CAAC,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;AAE/G,MAAM,IAAI,GAAG,CAAC,KAAoC,EAAiC,EAAE;IACnF,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAM;IAEhD,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAA,8BAAc,EAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,EAAU,EAAE,EAAE,CAAC,IAAA,8BAAc,EAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAA;AACvE,CAAC,CAAA;AAOM,MAAM,mBAAmB,GAAG,CAAC,OAAiB,EAAE,EAAE;IACvD,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAE5B,OAAO,CAAC,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IACpF,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QAE7E,OAAO,CAAC,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACtE,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;QACpF,QAAQ,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACjC,KAAK,MAAM;gBACT,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG,CAAA;gBAC9B,MAAK;YACP,KAAK,QAAQ;gBACX,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,GAAG,CAAA;gBAC9B,MAAK;QACT,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAC1F,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QAChC,OAAO,CAAC,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAC5F,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAC3B,OAAO,CAAC,SAAS,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAClF,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAC5B,OAAO,CAAC,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;QAElF,IAAI,0BAAc,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO,CAAC,SAAS,CAAC,KAAK,GAAG,0BAAc,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QACvE,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QAC1B,OAAO,CAAC,SAAS,CAAC,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAChF,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;QAEtF,IAAI,yBAAa,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,OAAO,CAAC,SAAS,CAAC,OAAO,GAAG,yBAAa,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QAC1E,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAA,iBAAO,EAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,CAAC;QAE5C,IAAI,OAAO,OAAO,CAAC,SAAS,EAAE,UAAU,KAAK,QAAQ,EAAE,CAAC;YACtD,OAAO,CAAC,SAAS,CAAC,UAAU,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;QAChE,CAAC;QACD,OAAO,CAAC,SAAS,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,EAAU,EAAE,EAAE,CAC9E,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CACpC,CAAA;IACH,CAAC;AACH,CAAC,CAAA;AAhEY,QAAA,mBAAmB,uBAgE/B;AAEM,MAAM,cAAc,GAAG,CAAC,OAAiB,EAAU,EAAE;IAC1D,IAAA,2BAAmB,EAAC,OAAO,CAAC,CAAA;IAE5B,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC;QACnC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC;QACxC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC;QACrC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC;QACtC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC;QACjC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;QAClC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;QAChC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC;QACzC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC;QAChD,iBAAiB,EAAE,OAAO,CAAC,SAAS,EAAE,iBAAiB;QACvD,iBAAiB,EAAE,OAAO,CAAC,SAAS,EAAE,iBAAiB;QACvD,GAAG,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG;QAC3B,GAAG,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG;QAC3B,eAAe,EAAE,OAAO,CAAC,SAAS,EAAE,cAAc;QAClD,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM;QAClC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM;QAClC,KAAK,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK;QAC/B,WAAW,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS;QACzC,UAAU,EAAE,OAAO,CAAC,SAAS,EAAE,UAAU;QACzC,YAAY,EAAE,OAAO,CAAC,SAAS,EAAE,YAAY;KAC9C,CAAA;AACH,CAAC,CAAA;AA3BY,QAAA,cAAc,kBA2B1B"}

package/dist/destinations/facebook-conversions-api/initiateCheckout/generated-types.d.ts

@@ -24,7 +24,6 @@ export interface Payload {
         madId?: string;
         partner_id?: string;
         partner_name?: string;
-        ctwa_clid?: string;
     };
     app_data_field?: {
         use_app_data?: boolean;

package/dist/destinations/facebook-conversions-api/initiateCheckout/index.js

@@ -1,15 +1,101 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const functions_1 = require("../functions");
-const fields_1 = require("../fields");
+const actions_core_1 = require("@segment/actions-core");
 const constants_1 = require("../constants");
+const fb_capi_properties_1 = require("../fb-capi-properties");
+const fb_capi_user_data_1 = require("../fb-capi-user-data");
+const utils_1 = require("../utils");
+const fb_capi_app_data_1 = require("../fb-capi-app-data");
 const action = {
     title: 'Initiate Checkout',
     description: 'Send event when a user enters the checkout flow',
     defaultSubscription: 'type = "track" and event = "Checkout Started"',
-    fields: fields_1.initiateCheckoutFields,
+    fields: {
+        action_source: { ...fb_capi_properties_1.action_source, required: true },
+        event_time: { ...fb_capi_properties_1.event_time, required: true },
+        user_data: fb_capi_user_data_1.user_data_field,
+        app_data_field: fb_capi_app_data_1.app_data_field,
+        content_category: fb_capi_properties_1.content_category,
+        content_ids: fb_capi_properties_1.content_ids,
+        contents: {
+            ...fb_capi_properties_1.contents,
+            default: {
+                '@arrayPath': [
+                    '$.properties.products',
+                    {
+                        id: {
+                            '@path': '$.product_id'
+                        },
+                        quantity: {
+                            '@path': '$.quantity'
+                        },
+                        item_price: {
+                            '@path': '$.price'
+                        }
+                    }
+                ]
+            }
+        },
+        currency: fb_capi_properties_1.currency,
+        event_id: fb_capi_properties_1.event_id,
+        event_source_url: fb_capi_properties_1.event_source_url,
+        num_items: fb_capi_properties_1.num_items,
+        value: {
+            ...fb_capi_properties_1.value,
+            default: { '@path': '$.properties.revenue' }
+        },
+        custom_data: fb_capi_properties_1.custom_data,
+        data_processing_options: fb_capi_properties_1.data_processing_options,
+        data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
+        data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
+        test_event_code: fb_capi_properties_1.test_event_code
+    },
     perform: (request, { payload, settings, features, statsContext }) => {
-        return (0, functions_1.send)(request, payload, settings, constants_1.EventType.InitiateCheckout, features, statsContext);
+        if (payload.currency && !constants_1.CURRENCY_ISO_CODES.has(payload.currency)) {
+            throw new actions_core_1.IntegrationError(`${payload.currency} is not a valid currency code.`, 'Misconfigured required field', 400);
+        }
+        if (!payload.user_data) {
+            throw new actions_core_1.IntegrationError('Must include at least one user data property', 'Misconfigured required field', 400);
+        }
+        if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
+            throw new actions_core_1.IntegrationError('If action source is "Website" then client_user_agent must be defined', 'Misconfigured required field', 400);
+        }
+        if (payload.contents) {
+            const err = (0, fb_capi_properties_1.validateContents)(payload.contents);
+            if (err)
+                throw err;
+        }
+        const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
+        const testEventCode = payload.test_event_code || settings.testEventCode;
+        return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
+            method: 'POST',
+            json: {
+                data: [
+                    {
+                        event_name: 'InitiateCheckout',
+                        event_time: payload.event_time,
+                        action_source: payload.action_source,
+                        event_source_url: payload.event_source_url,
+                        event_id: payload.event_id,
+                        user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
+                        custom_data: {
+                            ...payload.custom_data,
+                            currency: payload.currency,
+                            value: payload.value,
+                            content_ids: payload.content_ids,
+                            contents: payload.contents,
+                            num_items: payload.num_items,
+                            content_category: payload.content_category
+                        },
+                        app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
+                        data_processing_options: data_options,
+                        data_processing_options_country: country_code,
+                        data_processing_options_state: state_code
+                    }
+                ],
+                ...(testEventCode && { test_event_code: testEventCode })
+            }
+        });
     }
 };
 exports.default = action;

package/dist/destinations/facebook-conversions-api/initiateCheckout/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/initiateCheckout/index.ts"],"names":[],"mappings":";;AAGA,4CAAmC;AACnC,sCAAkD;AAClD,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,iDAAiD;IAC9D,mBAAmB,EAAE,+CAA+C;IACpE,MAAM,EAAE,+BAAsB;IAC9B,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,gBAAgB,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IAC7F,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/initiateCheckout/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAiD;AACjD,8DAkB8B;AAC9B,4DAAsE;AACtE,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,iDAAiD;IAC9D,mBAAmB,EAAE,+CAA+C;IACpE,MAAM,EAAE;QACN,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,gBAAgB,EAAE,qCAAgB;QAClC,WAAW,EAAE,gCAAW;QACxB,QAAQ,EAAE;YAER,GAAG,6BAAQ;YACX,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,uBAAuB;oBACvB;wBACE,EAAE,EAAE;4BACF,OAAO,EAAE,cAAc;yBACxB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,YAAY;yBACtB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,SAAS;yBACnB;qBACF;iBACF;aACF;SACF;QACD,QAAQ,EAAE,6BAAQ;QAClB,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;QAClC,SAAS,EAAE,8BAAS;QACpB,KAAK,EAAE;YACL,GAAG,0BAAK;YACR,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;SAC7C;QACD,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;QAC5D,eAAe,EAAE,oCAAe;KACjC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;QACH,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;QACjH,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC7F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;QACH,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,IAAA,qCAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC9C,IAAI,GAAG;gBAAE,MAAM,GAAG,CAAA;QACpB,CAAC;QAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;QAEvE,OAAO,OAAO,CACZ,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ;wBACE,UAAU,EAAE,kBAAkB;wBAC9B,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;wBAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,WAAW,EAAE;4BACX,GAAG,OAAO,CAAC,WAAW;4BACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;4BACpB,WAAW,EAAE,OAAO,CAAC,WAAW;4BAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;4BAC5B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;yBAC3C;wBACD,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;wBACnD,uBAAuB,EAAE,YAAY;wBACrC,+BAA+B,EAAE,YAAY;wBAC7C,6BAA6B,EAAE,UAAU;qBAC1C;iBACF;gBACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;aACzD;SACF,CACF,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/facebook-conversions-api/initiateCheckout2/generated-types.d.ts

@@ -24,7 +24,6 @@ export interface Payload {
         madId?: string;
         partner_id?: string;
         partner_name?: string;
-        ctwa_clid?: string;
     };
     app_data_field?: {
         use_app_data?: boolean;

package/dist/destinations/facebook-conversions-api/initiateCheckout2/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
-const functions_1 = require("../functions");
-const fields_1 = require("../fields");
 const constants_1 = require("../constants");
+const fb_capi_properties_1 = require("../fb-capi-properties");
+const fb_capi_user_data_1 = require("../fb-capi-user-data");
+const utils_1 = require("../utils");
+const fb_capi_app_data_1 = require("../fb-capi-app-data");
 const action = {
     title: 'Initiate Checkout V2',
     description: 'Send event when a user enters the checkout flow',
@@ -14,10 +16,93 @@ const action = {
         default: 'add',
         choices: [{ label: 'Insert Records', value: 'add' }]
     },
-    fields: fields_1.initiateCheckoutFields,
+    fields: {
+        action_source: { ...fb_capi_properties_1.action_source, required: true },
+        event_time: { ...fb_capi_properties_1.event_time, required: true },
+        user_data: fb_capi_user_data_1.user_data_field,
+        app_data_field: fb_capi_app_data_1.app_data_field,
+        content_category: fb_capi_properties_1.content_category,
+        content_ids: fb_capi_properties_1.content_ids,
+        contents: {
+            ...fb_capi_properties_1.contents,
+            default: {
+                '@arrayPath': [
+                    '$.properties.products',
+                    {
+                        id: {
+                            '@path': '$.product_id'
+                        },
+                        quantity: {
+                            '@path': '$.quantity'
+                        },
+                        item_price: {
+                            '@path': '$.price'
+                        }
+                    }
+                ]
+            }
+        },
+        currency: fb_capi_properties_1.currency,
+        event_id: fb_capi_properties_1.event_id,
+        event_source_url: fb_capi_properties_1.event_source_url,
+        num_items: fb_capi_properties_1.num_items,
+        value: {
+            ...fb_capi_properties_1.value,
+            default: { '@path': '$.properties.revenue' }
+        },
+        custom_data: fb_capi_properties_1.custom_data,
+        data_processing_options: fb_capi_properties_1.data_processing_options,
+        data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
+        data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
+        test_event_code: fb_capi_properties_1.test_event_code
+    },
     perform: (request, { payload, settings, features, statsContext, syncMode }) => {
         if (syncMode === 'add') {
-            return (0, functions_1.send)(request, payload, settings, constants_1.EventType.InitiateCheckout, features, statsContext);
+            if (payload.currency && !constants_1.CURRENCY_ISO_CODES.has(payload.currency)) {
+                throw new actions_core_1.IntegrationError(`${payload.currency} is not a valid currency code.`, 'Misconfigured required field', 400);
+            }
+            if (!payload.user_data) {
+                throw new actions_core_1.IntegrationError('Must include at least one user data property', 'Misconfigured required field', 400);
+            }
+            if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
+                throw new actions_core_1.IntegrationError('If action source is "Website" then client_user_agent must be defined', 'Misconfigured required field', 400);
+            }
+            if (payload.contents) {
+                const err = (0, fb_capi_properties_1.validateContents)(payload.contents);
+                if (err)
+                    throw err;
+            }
+            const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
+            const testEventCode = payload.test_event_code || settings.testEventCode;
+            return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
+                method: 'POST',
+                json: {
+                    data: [
+                        {
+                            event_name: 'InitiateCheckout',
+                            event_time: payload.event_time,
+                            action_source: payload.action_source,
+                            event_source_url: payload.event_source_url,
+                            event_id: payload.event_id,
+                            user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
+                            custom_data: {
+                                ...payload.custom_data,
+                                currency: payload.currency,
+                                value: payload.value,
+                                content_ids: payload.content_ids,
+                                contents: payload.contents,
+                                num_items: payload.num_items,
+                                content_category: payload.content_category
+                            },
+                            app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
+                            data_processing_options: data_options,
+                            data_processing_options_country: country_code,
+                            data_processing_options_state: state_code
+                        }
+                    ],
+                    ...(testEventCode && { test_event_code: testEventCode })
+                }
+            });
         }
         else {
             throw new actions_core_1.IntegrationError(`Sync mode ${syncMode} is not supported`, 'Misconfigured sync mode', 400);

package/dist/destinations/facebook-conversions-api/initiateCheckout2/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/initiateCheckout2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAmC;AACnC,sCAAkD;AAClD,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EAAE,iDAAiD;IAC9D,mBAAmB,EAAE,+CAA+C;IACpE,QAAQ,EAAE;QACR,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACrD;IACD,MAAM,EAAE,+BAAsB;IAC9B,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,gBAAgB,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;QAC7F,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/initiateCheckout2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAiD;AACjD,8DAkB8B;AAC9B,4DAAsE;AACtE,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EAAE,iDAAiD;IAC9D,mBAAmB,EAAE,+CAA+C;IACpE,QAAQ,EAAE;QACR,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACrD;IACD,MAAM,EAAE;QACN,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,gBAAgB,EAAE,qCAAgB;QAClC,WAAW,EAAE,gCAAW;QACxB,QAAQ,EAAE;YAER,GAAG,6BAAQ;YACX,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,uBAAuB;oBACvB;wBACE,EAAE,EAAE;4BACF,OAAO,EAAE,cAAc;yBACxB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,YAAY;yBACtB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,SAAS;yBACnB;qBACF;iBACF;aACF;SACF;QACD,QAAQ,EAAE,6BAAQ;QAClB,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;QAClC,SAAS,EAAE,8BAAS;QACpB,KAAK,EAAE;YACL,GAAG,0BAAK;YACR,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;SAC7C;QACD,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;QAC5D,eAAe,EAAE,oCAAe;KACjC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;YACH,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;gBACvB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;YACjH,CAAC;YAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAC7F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;YACH,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,MAAM,GAAG,GAAG,IAAA,qCAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;gBAC9C,IAAI,GAAG;oBAAE,MAAM,GAAG,CAAA;YACpB,CAAC;YAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;YAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;YAEvE,OAAO,OAAO,CACZ,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,IAAI,EAAE;wBACJ;4BACE,UAAU,EAAE,kBAAkB;4BAC9B,UAAU,EAAE,OAAO,CAAC,UAAU;4BAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;4BACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;4BAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;4BAC3D,WAAW,EAAE;gCACX,GAAG,OAAO,CAAC,WAAW;gCACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;gCAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;gCACpB,WAAW,EAAE,OAAO,CAAC,WAAW;gCAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;gCAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;gCAC5B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;6BAC3C;4BACD,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;4BACnD,uBAAuB,EAAE,YAAY;4BACrC,+BAA+B,EAAE,YAAY;4BAC7C,6BAA6B,EAAE,UAAU;yBAC1C;qBACF;oBACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;iBACzD;aACF,CACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/facebook-conversions-api/pageView/generated-types.d.ts

@@ -24,7 +24,6 @@ export interface Payload {
         madId?: string;
         partner_id?: string;
         partner_name?: string;
-        ctwa_clid?: string;
     };
     app_data_field?: {
         use_app_data?: boolean;

package/dist/destinations/facebook-conversions-api/pageView/index.js

@@ -1,15 +1,56 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const functions_1 = require("../functions");
-const fields_1 = require("../fields");
-const constants_1 = require("../constants");
+const actions_core_1 = require("@segment/actions-core");
+const fb_capi_properties_1 = require("../fb-capi-properties");
+const fb_capi_user_data_1 = require("../fb-capi-user-data");
+const utils_1 = require("../utils");
+const fb_capi_app_data_1 = require("../fb-capi-app-data");
 const action = {
     title: 'Page View',
     description: 'Send a page view event when a user lands on a page',
     defaultSubscription: 'type = "page"',
-    fields: fields_1.pageFields,
+    fields: {
+        action_source: { ...fb_capi_properties_1.action_source, required: true },
+        event_time: { ...fb_capi_properties_1.event_time, required: true },
+        user_data: fb_capi_user_data_1.user_data_field,
+        app_data_field: fb_capi_app_data_1.app_data_field,
+        event_id: fb_capi_properties_1.event_id,
+        event_source_url: fb_capi_properties_1.event_source_url,
+        custom_data: fb_capi_properties_1.custom_data,
+        data_processing_options: fb_capi_properties_1.data_processing_options,
+        data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
+        data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
+        test_event_code: fb_capi_properties_1.test_event_code
+    },
     perform: (request, { payload, settings, features, statsContext }) => {
-        return (0, functions_1.send)(request, payload, settings, constants_1.EventType.PageView, features, statsContext);
+        if (!payload.user_data) {
+            throw new actions_core_1.IntegrationError('Must include at least one user data property', 'Misconfigured required field', 400);
+        }
+        if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
+            throw new actions_core_1.IntegrationError('If action source is "Website" then client_user_agent must be defined', 'Misconfigured required field', 400);
+        }
+        const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
+        const testEventCode = payload.test_event_code || settings.testEventCode;
+        return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
+            method: 'POST',
+            json: {
+                data: [
+                    {
+                        event_name: 'PageView',
+                        event_time: payload.event_time,
+                        action_source: payload.action_source,
+                        event_source_url: payload.event_source_url,
+                        event_id: payload.event_id,
+                        user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
+                        app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
+                        data_processing_options: data_options,
+                        data_processing_options_country: country_code,
+                        data_processing_options_state: state_code
+                    }
+                ],
+                ...(testEventCode && { test_event_code: testEventCode })
+            }
+        });
     }
 };
 exports.default = action;

package/dist/destinations/facebook-conversions-api/pageView/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/pageView/index.ts"],"names":[],"mappings":";;AAGA,4CAAmC;AACnC,sCAAsC;AACtC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,oDAAoD;IACjE,mBAAmB,EAAE,eAAe;IACpC,MAAM,EAAE,mBAAU;IAClB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IACrF,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/pageView/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,8DAW8B;AAC9B,4DAAsE;AAGtE,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,oDAAoD;IACjE,mBAAmB,EAAE,eAAe;IACpC,MAAM,EAAE;QACN,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;QAClC,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;QAC5D,eAAe,EAAE,oCAAe;KACjC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;QACjH,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC7F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;QACH,CAAC;QAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;QAEvE,OAAO,OAAO,CACZ,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ;wBACE,UAAU,EAAE,UAAU;wBACtB,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;wBAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;wBACnD,uBAAuB,EAAE,YAAY;wBACrC,+BAA+B,EAAE,YAAY;wBAC7C,6BAA6B,EAAE,UAAU;qBAC1C;iBACF;gBACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;aACzD;SACF,CACF,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/facebook-conversions-api/pageView2/generated-types.d.ts

@@ -24,7 +24,6 @@ export interface Payload {
         madId?: string;
         partner_id?: string;
         partner_name?: string;
-        ctwa_clid?: string;
     };
     app_data_field?: {
         use_app_data?: boolean;