@segment/action-destinations 3.29.1 → 3.30.2-alpha.2

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

@@ -0,0 +1,92 @@
+"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 action = {
+    title: 'Initiate Checkout',
+    description: 'Send event when a user enters the checkout flow',
+    defaultSubscription: 'type = "track" and event = "Checkout Started"',
+    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,
+        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' }
+        }
+    },
+    perform: (request, { payload, settings }) => {
+        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);
+        }
+        const valid_delivery_categories = ['in_store', 'curbside', 'home_delivery'];
+        if (payload.contents) {
+            payload.contents.forEach((obj, index) => {
+                if (!obj.id) {
+                    throw new actions_core_1.IntegrationError("Contents objects must include an 'id' parameter.", 'Misconfigured required field', 400);
+                }
+                if (obj.delivery_category && !valid_delivery_categories.includes(obj.delivery_category)) {
+                    throw new actions_core_1.IntegrationError(`contents[${index}].delivery_category must be one of {in_store, home_delivery, curbside}.`, 'Misconfigured field', 400);
+                }
+            });
+        }
+        return request(`https://graph.facebook.com/v${constants_1.API_VERSION}/${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: {
+                            currency: payload.currency,
+                            value: payload.value,
+                            content_ids: payload.content_ids,
+                            contents: payload.contents,
+                            num_items: payload.num_items,
+                            content_category: payload.content_category
+                        }
+                    }
+                ]
+            }
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/initiateCheckout/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAA8D;AAC9D,8DAW8B;AAC9B,4DAAsE;AAEtE,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,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;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACjE,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YACtB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;SAChH;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;YAC5F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAED,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;QAC3E,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACtC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;oBACX,MAAM,IAAI,+BAAgB,CACxB,kDAAkD,EAClD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;iBACF;gBAED,IAAI,GAAG,CAAC,iBAAiB,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;oBACvF,MAAM,IAAI,+BAAgB,CACxB,YAAY,KAAK,yEAAyE,EAC1F,qBAAqB,EACrB,GAAG,CACJ,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,+BAA+B,uBAAW,IAAI,QAAQ,CAAC,OAAO,SAAS,EAAE;YACtF,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,kCAAc,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,WAAW,EAAE;4BACX,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;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,26 @@
+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;
+    };
+    event_id?: string;
+    event_source_url?: string;
+}

package/dist/destinations/facebook-conversions-api/pageView/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/pageView/generated-types.js.map

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

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

@@ -0,0 +1,43 @@
+"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 constants_1 = require("../constants");
+const action = {
+    title: 'Page View',
+    description: 'Send a page view event when a user lands on a page',
+    defaultSubscription: 'type = "page"',
+    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,
+        event_id: fb_capi_properties_1.event_id,
+        event_source_url: fb_capi_properties_1.event_source_url
+    },
+    perform: (request, { payload, settings }) => {
+        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);
+        }
+        return request(`https://graph.facebook.com/v${constants_1.API_VERSION}/${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 })
+                    }
+                ]
+            }
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/pageView/index.ts"],"names":[],"mappings":";;AAAA,wDAA2E;AAC3E,8DAA6F;AAC7F,4DAAsE;AAGtE,4CAA0C;AAC1C,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,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;KACnC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YACtB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;SAChH;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;YAC5F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QACD,OAAO,OAAO,CAAC,+BAA+B,uBAAW,IAAI,QAAQ,CAAC,OAAO,SAAS,EAAE;YACtF,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,kCAAc,CAAC,EAAC,SAAS,EAAE,OAAO,CAAC,SAAS,EAAC,CAAC;qBAC1D;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,38 @@
+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;
+    };
+    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;
+}

package/dist/destinations/facebook-conversions-api/purchase/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/purchase/generated-types.js.map

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

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

@@ -0,0 +1,95 @@
+"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 action = {
+    title: 'Purchase',
+    description: 'Send event when a user completes a purchase',
+    defaultSubscription: 'type = "track" and event = "Order Completed"',
+    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,
+        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
+    },
+    perform: (request, { payload, settings }) => {
+        if (!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);
+        }
+        const valid_delivery_categories = ['in_store', 'curbside', 'home_delivery'];
+        if (payload.contents) {
+            payload.contents.forEach((obj, index) => {
+                if (!obj.id) {
+                    throw new actions_core_1.IntegrationError("Contents objects must include an 'id' parameter.", 'Misconfigured required field', 400);
+                }
+                if (obj.delivery_category && !valid_delivery_categories.includes(obj.delivery_category)) {
+                    throw new actions_core_1.IntegrationError(`contents[${index}].delivery_category must be one of {in_store, home_delivery, curbside}.`, 'Misconfigured field', 400);
+                }
+            });
+        }
+        return request(`https://graph.facebook.com/v${constants_1.API_VERSION}/${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: {
+                            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
+                        }
+                    }
+                ]
+            }
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAA8D;AAC9D,8DAY8B;AAC9B,4DAAsE;AAEtE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,6CAA6C;IAC1D,mBAAmB,EAAE,8CAA8C;IACnE,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,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;KACrB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC7C,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YACtB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;SAChH;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;YAC5F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAED,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;QAC3E,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACtC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;oBACX,MAAM,IAAI,+BAAgB,CACxB,kDAAkD,EAClD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;iBACF;gBAED,IAAI,GAAG,CAAC,iBAAiB,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;oBACvF,MAAM,IAAI,+BAAgB,CACxB,YAAY,KAAK,yEAAyE,EAC1F,qBAAqB,EACrB,GAAG,CACJ,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,+BAA+B,uBAAW,IAAI,QAAQ,CAAC,OAAO,SAAS,EAAE;YACtF,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,kCAAc,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,WAAW,EAAE;4BACX,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,SAAS,EAAE,OAAO,CAAC,SAAS;yBAC7B;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,37 @@
+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;
+    };
+    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;
+}

package/dist/destinations/facebook-conversions-api/search/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/search/generated-types.js.map

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

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

@@ -0,0 +1,91 @@
+"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 action = {
+    title: 'Search',
+    description: 'Send event when a user searches content or products',
+    defaultSubscription: 'type = "track" and event = "Products Searched"',
+    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,
+        content_category: fb_capi_properties_1.content_category,
+        content_ids: fb_capi_properties_1.content_ids,
+        contents: {
+            ...fb_capi_properties_1.contents,
+            default: {
+                id: {
+                    '@path': '$.properties.product_id'
+                },
+                quantity: {
+                    '@path': '$.properties.quantity'
+                },
+                item_price: {
+                    '@path': '$.properties.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
+    },
+    perform: (request, { payload, settings }) => {
+        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);
+        }
+        const valid_delivery_categories = ['in_store', 'curbside', 'home_delivery'];
+        if (payload.contents) {
+            payload.contents.forEach((obj, index) => {
+                if (!obj.id) {
+                    throw new actions_core_1.IntegrationError("Contents objects must include an 'id' parameter.", 'Misconfigured required field', 400);
+                }
+                if (obj.delivery_category && !valid_delivery_categories.includes(obj.delivery_category)) {
+                    throw new actions_core_1.IntegrationError(`contents[${index}].delivery_category must be one of {in_store, home_delivery, curbside}.`, 'Misconfigured field', 400);
+                }
+            });
+        }
+        return request(`https://graph.facebook.com/v${constants_1.API_VERSION}/${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: fb_capi_user_data_1.hash_user_data({ user_data: payload.user_data }),
+                        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
+                        }
+                    }
+                ]
+            }
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/search/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAA8D;AAC9D,8DAU8B;AAC9B,4DAAsE;AAEtE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,qDAAqD;IAClE,mBAAmB,EAAE,gDAAgD;IACrE,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,gBAAgB,EAAE,qCAAgB;QAClC,WAAW,EAAE,gCAAW;QACxB,QAAQ,EAAE;YACR,GAAG,6BAAQ;YACX,OAAO,EAAE;gBAEP,EAAE,EAAE;oBACF,OAAO,EAAE,yBAAyB;iBACnC;gBACD,QAAQ,EAAE;oBACR,OAAO,EAAE,uBAAuB;iBACjC;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE,oBAAoB;iBAC9B;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;KACb;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACjE,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YACtB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;SAChH;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE;YAC5F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAED,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,CAAC,CAAA;QAC3E,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBACtC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;oBACX,MAAM,IAAI,+BAAgB,CACxB,kDAAkD,EAClD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;iBACF;gBAED,IAAI,GAAG,CAAC,iBAAiB,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;oBACvF,MAAM,IAAI,+BAAgB,CACxB,YAAY,KAAK,yEAAyE,EAC1F,qBAAqB,EACrB,GAAG,CACJ,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;SACH;QAED,OAAO,OAAO,CAAC,+BAA+B,uBAAW,IAAI,QAAQ,CAAC,OAAO,SAAS,EAAE;YACtF,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ;wBACE,UAAU,EAAE,QAAQ;wBACpB,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,kCAAc,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,WAAW,EAAE;4BACX,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;4BAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;4BAC1C,KAAK,EAAE,OAAO,CAAC,KAAK;4BACpB,aAAa,EAAE,OAAO,CAAC,aAAa;yBACrC;qBACF;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

@@ -0,0 +1,38 @@
+export interface Payload {
+    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;
+    };
+    event_time: string;
+    action_source: string;
+    event_id?: string;
+    event_source_url?: string;
+    content_ids?: string[];
+    content_category?: string;
+    content_name?: string;
+    content_type?: string;
+    contents?: {
+        id?: string;
+        quantity?: number;
+        item_price?: number;
+        delivery_category?: string;
+    }[];
+    currency?: string;
+    value?: number;
+}

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

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

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

@@ -0,0 +1,85 @@
+"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 constants_1 = require("../constants");
+const action = {
+    title: 'View Content',
+    description: 'Send event when a user views content or a product',
+    defaultSubscription: 'type = "track" and event = "Product Viewed"',
+    fields: {
+        user_data: fb_capi_user_data_1.user_data_field,
+        event_time: { ...fb_capi_properties_1.event_time, required: true },
+        action_source: { ...fb_capi_properties_1.action_source, required: true },
+        event_id: fb_capi_properties_1.event_id,
+        event_source_url: fb_capi_properties_1.event_source_url,
+        content_ids: { ...fb_capi_properties_1.content_ids, default: { '@path': '$.properties.product_id' } },
+        content_category: fb_capi_properties_1.content_category,
+        content_name: fb_capi_properties_1.content_name,
+        content_type: fb_capi_properties_1.content_type,
+        contents: {
+            ...fb_capi_properties_1.contents,
+            default: {
+                id: {
+                    '@path': '$.properties.product_id'
+                },
+                quantity: {
+                    '@path': '$.properties.quantity'
+                },
+                item_price: {
+                    '@path': '$.properties.price'
+                }
+            }
+        },
+        currency: fb_capi_properties_1.currency,
+        value: { ...fb_capi_properties_1.value, default: { '@path': '$.properties.price' } }
+    },
+    perform: (request, { payload, settings }) => {
+        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);
+        }
+        const valid_delivery_categories = ['in_store', 'curbside', 'home_delivery'];
+        if (payload.contents) {
+            payload.contents.forEach((obj, index) => {
+                if (!obj.id) {
+                    throw new actions_core_1.IntegrationError("Contents objects must include an 'id' parameter.", 'Misconfigured required field', 400);
+                }
+                if (obj.delivery_category && !valid_delivery_categories.includes(obj.delivery_category)) {
+                    throw new actions_core_1.IntegrationError(`contents[${index}].delivery_category must be one of {in_store, home_delivery, curbside}.`, 'Misconfigured field', 400);
+                }
+            });
+        }
+        return request(`https://graph.facebook.com/v${constants_1.API_VERSION}/${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: fb_capi_user_data_1.hash_user_data({ user_data: payload.user_data }),
+                        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
+                        }
+                    }
+                ]
+            }
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map