@segment/action-destinations 3.480.0 → 3.481.0

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

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
-const fields_1 = require("../fields");
-const functions_1 = require("../functions");
 const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const fb_capi_properties_1 = require("../fb-capi-properties");
+const fb_capi_user_data_1 = require("../fb-capi-user-data");
+const fb_capi_app_data_1 = require("../fb-capi-app-data");
 const action = {
     title: 'Search V2',
     description: 'Send event when a user searches content or products',
@@ -14,10 +16,97 @@ const action = {
         default: 'add',
         choices: [{ label: 'Insert Records', value: 'add' }]
     },
-    fields: fields_1.searchFields,
+    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',
+                    {
+                        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,
+        search_string: {
+            label: 'Search String',
+            description: 'A search query made by a user. This must be a string.',
+            type: 'string',
+            default: {
+                '@path': '$.properties.query'
+            }
+        },
+        value: fb_capi_properties_1.value,
+        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.Search, 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: 'Search',
+                            event_time: payload.event_time,
+                            action_source: payload.action_source,
+                            event_id: payload.event_id,
+                            event_source_url: payload.event_source_url,
+                            user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
+                            custom_data: {
+                                ...payload.custom_data,
+                                currency: payload.currency,
+                                content_ids: payload.content_ids,
+                                contents: payload.contents,
+                                content_category: payload.content_category,
+                                value: payload.value,
+                                search_string: payload.search_string
+                            },
+                            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/search2/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/search2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,sCAAwC;AACxC,4CAAmC;AACnC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,qDAAqD;IAClE,mBAAmB,EAAE,gDAAgD;IACrE,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,qBAAY;IACpB,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,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;QACnF,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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/search2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAiD;AACjD,oCAA0C;AAC1C,8DAiB8B;AAC9B,4DAAsE;AACtE,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,qDAAqD;IAClE,mBAAmB,EAAE,gDAAgD;IACrE,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;YACR,GAAG,6BAAQ;YACX,OAAO,EAAE;gBAEP,YAAY,EAAE;oBACZ,cAAc;oBACd;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,aAAa,EAAE;YACb,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,uDAAuD;YACpE,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,KAAK,EAAE,0BAAK;QACZ,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,QAAQ;4BACpB,UAAU,EAAE,OAAO,CAAC,UAAU;4BAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;4BACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;4BAC1C,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,WAAW,EAAE,OAAO,CAAC,WAAW;gCAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;gCAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;gCAC1C,KAAK,EAAE,OAAO,CAAC,KAAK;gCACpB,aAAa,EAAE,OAAO,CAAC,aAAa;6BACrC;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/utils.d.ts

@@ -0,0 +1,3 @@
+import { StatsContext } from '@segment/actions-core/destination-kit';
+import { Features } from '@segment/actions-core/mapping-kit';
+export declare const get_api_version: (features: Features | undefined, statsContext: StatsContext | undefined) => string;

package/dist/destinations/facebook-conversions-api/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get_api_version = void 0;
+const constants_1 = require("./constants");
+const FLAGON_NAME = 'facebook-capi-actions-canary-version';
+const get_api_version = (features, statsContext) => {
+    const statsClient = statsContext?.statsClient;
+    const tags = statsContext?.tags;
+    if (features && features[FLAGON_NAME]) {
+        tags?.push(`version:${constants_1.CANARY_API_VERSION}`);
+        statsClient?.incr(`fb_api_version`, 1, tags);
+        return constants_1.CANARY_API_VERSION;
+    }
+    tags?.push(`version:${constants_1.API_VERSION}`);
+    statsClient?.incr(`fb_api_version`, 1, tags);
+    return constants_1.API_VERSION;
+};
+exports.get_api_version = get_api_version;
+//# sourceMappingURL=utils.js.map

package/dist/destinations/facebook-conversions-api/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/destinations/facebook-conversions-api/utils.ts"],"names":[],"mappings":";;;AAEA,2CAA6D;AAE7D,MAAM,WAAW,GAAG,sCAAsC,CAAA;AAEnD,MAAM,eAAe,GAAG,CAAC,QAA8B,EAAE,YAAsC,EAAU,EAAE;IAChH,MAAM,WAAW,GAAG,YAAY,EAAE,WAAW,CAAA;IAC7C,MAAM,IAAI,GAAG,YAAY,EAAE,IAAI,CAAA;IAE/B,IAAI,QAAQ,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACtC,IAAI,EAAE,IAAI,CAAC,WAAW,8BAAkB,EAAE,CAAC,CAAA;QAC3C,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;QAC5C,OAAO,8BAAkB,CAAA;IAC3B,CAAC;IAED,IAAI,EAAE,IAAI,CAAC,WAAW,uBAAW,EAAE,CAAC,CAAA;IACpC,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,EAAE,IAAI,CAAC,CAAA;IAC5C,OAAO,uBAAW,CAAA;AACpB,CAAC,CAAA;AAbY,QAAA,eAAe,mBAa3B"}

package/dist/destinations/facebook-conversions-api/viewContent/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/viewContent/index.js

@@ -1,15 +1,100 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const fields_1 = require("../fields");
-const functions_1 = require("../functions");
+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 constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const fb_capi_app_data_1 = require("../fb-capi-app-data");
 const action = {
     title: 'View Content',
     description: 'Send event when a user views content or a product',
     defaultSubscription: 'type = "track" and event = "Product Viewed"',
-    fields: fields_1.viewContentFields,
+    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, default: { '@path': '$.properties.product_id' } },
+        content_name: fb_capi_properties_1.content_name,
+        content_type: fb_capi_properties_1.content_type,
+        contents: {
+            ...fb_capi_properties_1.contents,
+            default: {
+                '@arrayPath': [
+                    '$.properties',
+                    {
+                        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,
+        value: { ...fb_capi_properties_1.value, default: { '@path': '$.properties.price' } },
+        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.ViewContent, 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: 'ViewContent',
+                        event_time: payload.event_time,
+                        action_source: payload.action_source,
+                        event_id: payload.event_id,
+                        event_source_url: payload.event_source_url,
+                        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,
+                            content_name: payload.content_name,
+                            content_type: payload.content_type,
+                            contents: payload.contents,
+                            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/viewContent/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/viewContent/index.ts"],"names":[],"mappings":";;AAGA,sCAA6C;AAC7C,4CAAmC;AACnC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,mDAAmD;IAChE,mBAAmB,EAAE,6CAA6C;IAClE,MAAM,EAAE,0BAAiB;IACzB,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,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IACxF,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/viewContent/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,8DAmB8B;AAC9B,4DAAsE;AAGtE,4CAAiD;AACjD,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,mDAAmD;IAChE,mBAAmB,EAAE,6CAA6C;IAClE,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,EAAE,GAAG,gCAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE,EAAE;QAChF,YAAY,EAAE,iCAAY;QAC1B,YAAY,EAAE,iCAAY;QAC1B,QAAQ,EAAE;YACR,GAAG,6BAAQ;YACX,OAAO,EAAE;gBAEP,YAAY,EAAE;oBACZ,cAAc;oBACd;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,KAAK,EAAE,EAAE,GAAG,0BAAK,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,EAAE;QAC/D,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,aAAa;wBACzB,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;wBAC1C,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,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,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/viewContent2/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/viewContent2/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
-const fields_1 = require("../fields");
-const functions_1 = require("../functions");
+const fb_capi_properties_1 = require("../fb-capi-properties");
+const fb_capi_user_data_1 = require("../fb-capi-user-data");
 const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const fb_capi_app_data_1 = require("../fb-capi-app-data");
 const action = {
     title: 'View Content V2',
     description: 'Send event when a user views content or a product',
@@ -14,10 +16,92 @@ const action = {
         default: 'add',
         choices: [{ label: 'Insert Records', value: 'add' }]
     },
-    fields: fields_1.viewContentFields,
+    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, default: { '@path': '$.properties.product_id' } },
+        content_name: fb_capi_properties_1.content_name,
+        content_type: fb_capi_properties_1.content_type,
+        contents: {
+            ...fb_capi_properties_1.contents,
+            default: {
+                '@arrayPath': [
+                    '$.properties',
+                    {
+                        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,
+        value: { ...fb_capi_properties_1.value, default: { '@path': '$.properties.price' } },
+        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.ViewContent, 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: 'ViewContent',
+                            event_time: payload.event_time,
+                            action_source: payload.action_source,
+                            event_id: payload.event_id,
+                            event_source_url: payload.event_source_url,
+                            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,
+                                content_name: payload.content_name,
+                                content_type: payload.content_type,
+                                contents: payload.contents,
+                                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/viewContent2/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/viewContent2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,sCAA6C;AAC7C,4CAAmC;AACnC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,mDAAmD;IAChE,mBAAmB,EAAE,6CAA6C;IAClE,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,0BAAiB;IACzB,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,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;QACxF,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/viewContent2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,8DAmB8B;AAC9B,4DAAsE;AAGtE,4CAAiD;AACjD,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,iBAAiB;IACxB,WAAW,EAAE,mDAAmD;IAChE,mBAAmB,EAAE,6CAA6C;IAClE,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,EAAE,GAAG,gCAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE,EAAE;QAChF,YAAY,EAAE,iCAAY;QAC1B,YAAY,EAAE,iCAAY;QAC1B,QAAQ,EAAE;YACR,GAAG,6BAAQ;YACX,OAAO,EAAE;gBAEP,YAAY,EAAE;oBACZ,cAAc;oBACd;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,KAAK,EAAE,EAAE,GAAG,0BAAK,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,EAAE;QAC/D,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,aAAa;4BACzB,UAAU,EAAE,OAAO,CAAC,UAAU;4BAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;4BACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;4BAC1C,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,YAAY,EAAE,OAAO,CAAC,YAAY;gCAClC,YAAY,EAAE,OAAO,CAAC,YAAY;gCAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;gCAC1B,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.480.0",
+  "version": "3.481.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -92,5 +92,5 @@
       "__tests__/__helpers__/"
     ]
   },
-  "gitHead": "029337b07a81f7a6884710f0ab6ac1074624c0ae"
+  "gitHead": "155ff1e86e31b6d3e805807c82da15ba8845b68c"
 }