@segment/action-destinations 3.312.0 → 3.312.1-staging-1989539c2

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

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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"',
+    syncMode: {
+        description: 'Define how the records from your destination will be synced.',
+        label: 'How to sync records',
+        default: 'add',
+        choices: [{ label: 'Insert Records', value: 'add' }]
+    },
+    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
+    },
+    perform: (request, { payload, settings, features, statsContext, syncMode }) => {
+        if (syncMode === 'add') {
+            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 = fb_capi_properties_1.validateContents(payload.contents);
+                if (err)
+                    throw err;
+            }
+            const [data_options, country_code, state_code] = fb_capi_properties_1.dataProcessingOptions(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
+            return request(`https://graph.facebook.com/v${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: 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: 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
+                        }
+                    ],
+                    ...(settings.testEventCode && { test_event_code: settings.testEventCode })
+                }
+            });
+        }
+        else {
+            throw new actions_core_1.IntegrationError(`Sync mode ${syncMode} is not supported`, 'Misconfigured sync mode', 400);
+        }
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/initiateCheckout2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAiD;AACjD,8DAiB8B;AAC9B,4DAAsE;AACtE,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,mBAAmB;IAC1B,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;KAC7D;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;YACtB,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACjE,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;aACF;YAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;gBACtB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;aAChH;YAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;gBAC5F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;aACF;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,MAAM,GAAG,GAAG,qCAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;gBAC9C,IAAI,GAAG;oBAAE,MAAM,GAAG,CAAA;aACnB;YAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,0CAAqB,CACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;YAED,OAAO,OAAO,CACZ,+BAA+B,uBAAe,CAAC,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,kCAAc,CAAC,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,oCAAiB,CAAC,OAAO,CAAC,cAAc,CAAC;4BACnD,uBAAuB,EAAE,YAAY;4BACrC,+BAA+B,EAAE,YAAY;4BAC7C,6BAA6B,EAAE,UAAU;yBAC1C;qBACF;oBACD,GAAG,CAAC,QAAQ,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;iBAC3E;aACF,CACF,CAAA;SACF;aAAM;YACL,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;SACrG;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,56 @@
+export interface Payload {
+    action_source: string;
+    event_time: string;
+    user_data: {
+        externalId?: string[];
+        email?: string;
+        phone?: string;
+        gender?: string;
+        dateOfBirth?: string;
+        lastName?: string;
+        firstName?: string;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country?: string;
+        client_ip_address?: string;
+        client_user_agent?: string;
+        fbc?: string;
+        fbp?: string;
+        subscriptionID?: string;
+        leadID?: number;
+        fbLoginID?: number;
+        anonId?: string;
+        partner_id?: string;
+        partner_name?: string;
+    };
+    app_data_field?: {
+        use_app_data?: boolean;
+        advertiser_tracking_enabled?: boolean;
+        application_tracking_enabled?: boolean;
+        version?: string;
+        packageName?: string;
+        shortVersion?: string;
+        longVersion?: string;
+        osVersion?: string;
+        deviceName?: string;
+        locale?: string;
+        timezone?: string;
+        carrier?: string;
+        width?: string;
+        height?: string;
+        density?: string;
+        cpuCores?: string;
+        storageSize?: string;
+        freeStorage?: string;
+        deviceTimezone?: string;
+    };
+    event_id?: string;
+    event_source_url?: string;
+    custom_data?: {
+        [k: string]: unknown;
+    };
+    data_processing_options?: boolean;
+    data_processing_options_country?: number;
+    data_processing_options_state?: number;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/facebook-conversions-api/pageView2/generated-types.js.map

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

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

@@ -0,0 +1,5 @@
+import { ActionDefinition } from '@segment/actions-core';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: ActionDefinition<Settings, Payload>;
+export default action;

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

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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"',
+    syncMode: {
+        description: 'Define how the records from your destination will be synced.',
+        label: 'How to sync records',
+        default: 'add',
+        choices: [{ label: 'Insert Records', value: 'add' }]
+    },
+    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
+    },
+    perform: (request, { payload, settings, features, statsContext, syncMode }) => {
+        if (syncMode === 'add') {
+            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] = fb_capi_properties_1.dataProcessingOptions(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
+            return request(`https://graph.facebook.com/v${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: fb_capi_user_data_1.hash_user_data({ user_data: payload.user_data }),
+                            app_data: 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
+                        }
+                    ],
+                    ...(settings.testEventCode && { test_event_code: settings.testEventCode })
+                }
+            });
+        }
+        else {
+            throw new actions_core_1.IntegrationError(`Sync mode ${syncMode} is not supported`, 'Misconfigured sync mode', 400);
+        }
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/pageView2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,8DAU8B;AAC9B,4DAAsE;AAGtE,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,oDAAoD;IACjE,mBAAmB,EAAE,eAAe;IACpC,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,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;KAC7D;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;YACtB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;gBACtB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;aAChH;YAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;gBAC5F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;aACF;YAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,0CAAqB,CACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;YAED,OAAO,OAAO,CACZ,+BAA+B,uBAAe,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,IAAI,EAAE;wBACJ;4BACE,UAAU,EAAE,UAAU;4BACtB,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,kCAAc,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;4BAC3D,QAAQ,EAAE,oCAAiB,CAAC,OAAO,CAAC,cAAc,CAAC;4BACnD,uBAAuB,EAAE,YAAY;4BACrC,+BAA+B,EAAE,YAAY;4BAC7C,6BAA6B,EAAE,UAAU;yBAC1C;qBACF;oBACD,GAAG,CAAC,QAAQ,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;iBAC3E;aACF,CACF,CAAA;SACF;aAAM;YACL,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;SACrG;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,68 @@
+export interface Payload {
+    action_source: string;
+    currency: string;
+    event_time: string;
+    user_data: {
+        externalId?: string[];
+        email?: string;
+        phone?: string;
+        gender?: string;
+        dateOfBirth?: string;
+        lastName?: string;
+        firstName?: string;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country?: string;
+        client_ip_address?: string;
+        client_user_agent?: string;
+        fbc?: string;
+        fbp?: string;
+        subscriptionID?: string;
+        leadID?: number;
+        fbLoginID?: number;
+        anonId?: string;
+        partner_id?: string;
+        partner_name?: string;
+    };
+    app_data_field?: {
+        use_app_data?: boolean;
+        advertiser_tracking_enabled?: boolean;
+        application_tracking_enabled?: boolean;
+        version?: string;
+        packageName?: string;
+        shortVersion?: string;
+        longVersion?: string;
+        osVersion?: string;
+        deviceName?: string;
+        locale?: string;
+        timezone?: string;
+        carrier?: string;
+        width?: string;
+        height?: string;
+        density?: string;
+        cpuCores?: string;
+        storageSize?: string;
+        freeStorage?: string;
+        deviceTimezone?: string;
+    };
+    value: number;
+    content_ids?: string[];
+    content_name?: string;
+    content_type?: string;
+    contents?: {
+        id?: string;
+        quantity?: number;
+        item_price?: number;
+        delivery_category?: string;
+    }[];
+    event_id?: string;
+    event_source_url?: string;
+    num_items?: number;
+    custom_data?: {
+        [k: string]: unknown;
+    };
+    data_processing_options?: boolean;
+    data_processing_options_country?: number;
+    data_processing_options_state?: number;
+}

package/dist/destinations/facebook-conversions-api/purchase2/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/facebook-conversions-api/purchase2/generated-types.js.map

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

package/dist/destinations/facebook-conversions-api/purchase2/index.d.ts

@@ -0,0 +1,5 @@
+import { ActionDefinition } from '@segment/actions-core';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: ActionDefinition<Settings, Payload>;
+export default action;

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

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+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: 'Purchase',
+    description: 'Send event when a user completes a purchase',
+    defaultSubscription: 'type = "track" and event = "Order Completed"',
+    syncMode: {
+        description: 'Define how the records from your destination will be synced.',
+        label: 'How to sync records',
+        default: 'add',
+        choices: [{ label: 'Insert Records', value: 'add' }]
+    },
+    fields: {
+        action_source: { ...fb_capi_properties_1.action_source, required: true },
+        currency: { ...fb_capi_properties_1.currency, 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,
+        value: {
+            ...fb_capi_properties_1.value,
+            required: true,
+            default: { '@path': '$.properties.revenue' }
+        },
+        content_ids: fb_capi_properties_1.content_ids,
+        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.products',
+                    {
+                        id: {
+                            '@path': '$.product_id'
+                        },
+                        quantity: {
+                            '@path': '$.quantity'
+                        },
+                        item_price: {
+                            '@path': '$.price'
+                        }
+                    }
+                ]
+            }
+        },
+        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,
+        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
+    },
+    perform: (request, { payload, settings, features, statsContext, syncMode }) => {
+        if (syncMode === 'add') {
+            if (!constants_1.CURRENCY_ISO_CODES.has(payload.currency)) {
+                throw new actions_core_1.IntegrationError(`${payload.currency} is not a valid currency code.`, actions_core_1.ErrorCodes.INVALID_CURRENCY_CODE, 400);
+            }
+            if (!payload.user_data) {
+                throw new actions_core_1.PayloadValidationError('Must include at least one user data property');
+            }
+            if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
+                throw new actions_core_1.PayloadValidationError('If action source is "Website" then client_user_agent must be defined');
+            }
+            if (payload.contents) {
+                const err = fb_capi_properties_1.validateContents(payload.contents);
+                if (err)
+                    throw err;
+            }
+            const [data_options, country_code, state_code] = fb_capi_properties_1.dataProcessingOptions(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
+            return request(`https://graph.facebook.com/v${utils_1.get_api_version(features, statsContext)}/${settings.pixelId}/events`, {
+                method: 'POST',
+                json: {
+                    data: [
+                        {
+                            event_name: 'Purchase',
+                            event_time: payload.event_time,
+                            action_source: payload.action_source,
+                            event_source_url: payload.event_source_url,
+                            event_id: payload.event_id,
+                            user_data: 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,
+                                num_items: payload.num_items
+                            },
+                            app_data: 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
+                        }
+                    ],
+                    ...(settings.testEventCode && { test_event_code: settings.testEventCode })
+                }
+            });
+        }
+        else {
+            throw new actions_core_1.IntegrationError(`Sync mode ${syncMode} is not supported`, 'Misconfigured sync mode', 400);
+        }
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase2/index.ts"],"names":[],"mappings":";;AAAA,wDAA8G;AAG9G,4CAAiD;AACjD,oCAA0C;AAC1C,8DAkB8B;AAC9B,4DAAsE;AACtE,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,6CAA6C;IAC1D,mBAAmB,EAAE,8CAA8C;IACnE,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,QAAQ,EAAE,EAAE,GAAG,6BAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACzC,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,KAAK,EAAE;YACL,GAAG,0BAAK;YACR,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;SAC7C;QACD,WAAW,EAAE,gCAAW;QACxB,YAAY,EAAE,iCAAY;QAC1B,YAAY,EAAE,iCAAY;QAC1B,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,gBAAgB,EAAE,qCAAgB;QAClC,SAAS,EAAE,8BAAS;QACpB,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;KAC7D;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;YACtB,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAC7C,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,yBAAU,CAAC,qBAAqB,EAChC,GAAG,CACJ,CAAA;aACF;YAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;gBACtB,MAAM,IAAI,qCAAsB,CAAC,8CAA8C,CAAC,CAAA;aACjF;YAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;gBAC5F,MAAM,IAAI,qCAAsB,CAAC,sEAAsE,CAAC,CAAA;aACzG;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,MAAM,GAAG,GAAG,qCAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;gBAC9C,IAAI,GAAG;oBAAE,MAAM,GAAG,CAAA;aACnB;YAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,0CAAqB,CACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;YAED,OAAO,OAAO,CACZ,+BAA+B,uBAAe,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,IAAI,EAAE;wBACJ;4BACE,UAAU,EAAE,UAAU;4BACtB,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,kCAAc,CAAC,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,SAAS,EAAE,OAAO,CAAC,SAAS;6BAC7B;4BACD,QAAQ,EAAE,oCAAiB,CAAC,OAAO,CAAC,cAAc,CAAC;4BACnD,uBAAuB,EAAE,YAAY;4BACrC,+BAA+B,EAAE,YAAY;4BAC7C,6BAA6B,EAAE,UAAU;yBAC1C;qBACF;oBACD,GAAG,CAAC,QAAQ,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;iBAC3E;aACF,CACF,CAAA;SACF;aAAM;YACL,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;SACrG;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,67 @@
+export interface Payload {
+    action_source: string;
+    event_time: string;
+    user_data: {
+        externalId?: string[];
+        email?: string;
+        phone?: string;
+        gender?: string;
+        dateOfBirth?: string;
+        lastName?: string;
+        firstName?: string;
+        city?: string;
+        state?: string;
+        zip?: string;
+        country?: string;
+        client_ip_address?: string;
+        client_user_agent?: string;
+        fbc?: string;
+        fbp?: string;
+        subscriptionID?: string;
+        leadID?: number;
+        fbLoginID?: number;
+        anonId?: string;
+        partner_id?: string;
+        partner_name?: string;
+    };
+    app_data_field?: {
+        use_app_data?: boolean;
+        advertiser_tracking_enabled?: boolean;
+        application_tracking_enabled?: boolean;
+        version?: string;
+        packageName?: string;
+        shortVersion?: string;
+        longVersion?: string;
+        osVersion?: string;
+        deviceName?: string;
+        locale?: string;
+        timezone?: string;
+        carrier?: string;
+        width?: string;
+        height?: string;
+        density?: string;
+        cpuCores?: string;
+        storageSize?: string;
+        freeStorage?: string;
+        deviceTimezone?: string;
+    };
+    content_category?: string;
+    content_ids?: string[];
+    contents?: {
+        id?: string;
+        quantity?: number;
+        item_price?: number;
+        delivery_category?: string;
+    }[];
+    currency?: string;
+    event_id?: string;
+    event_source_url?: string;
+    search_string?: string;
+    value?: number;
+    custom_data?: {
+        [k: string]: unknown;
+    };
+    data_processing_options?: boolean;
+    data_processing_options_country?: number;
+    data_processing_options_state?: number;
+}

package/dist/destinations/facebook-conversions-api/search2/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/facebook-conversions-api/search2/generated-types.js.map

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

package/dist/destinations/facebook-conversions-api/search2/index.d.ts

@@ -0,0 +1,5 @@
+import { ActionDefinition } from '@segment/actions-core';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: ActionDefinition<Settings, Payload>;
+export default action;