@segment/action-destinations 3.74.4-alpha.7 → 3.75.0

package/dist/destinations/snap-conversions-api/_tests_/index.test.js

@@ -1,2 +1,204 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nock_1 = __importDefault(require("nock"));
+const actions_core_1 = require("@segment/actions-core");
+const index_1 = __importDefault(require("../index"));
+const testDestination = actions_core_1.createTestIntegration(index_1.default);
+const timestamp = '2022-05-12T15:21:15.449Z';
+const settings = {
+    snap_app_id: 'test123',
+    pixel_id: 'test123',
+    app_id: 'test123'
+};
+const accessToken = 'test123';
+const refreshToken = 'test123';
+const testEvent = actions_core_1.createTestEvent({
+    timestamp: timestamp,
+    messageId: 'test-message-rv4t40s898k',
+    event: 'PURCHASE',
+    type: 'track',
+    properties: {
+        email: 'test123@gmail.com',
+        phone: '+44 844 412 4653',
+        event_tag: 'back-to-school',
+        number_items: 10,
+        price: '15',
+        currency: 'USD',
+        level: 3
+    }
+});
+const conversionEventUrl = 'https://tr.snapchat.com/v2/conversion';
+describe('Snap Conversions API ', () => {
+    describe('ReportConversionEvent', () => {
+        it('should handle a basic event', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(200, {});
+            const event = actions_core_1.createTestEvent(testEvent);
+            const responses = await testDestination.testAction('reportConversionEvent', {
+                event,
+                settings,
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'PURCHASE',
+                    event_conversion_type: 'WEB'
+                }
+            });
+            expect(responses).not.toBeNull();
+            expect(responses[0].status).toBe(200);
+            expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"pixel_id\\":\\"test123\\"}"`);
+        });
+        it('should fail web event without pixel_id', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(400, {});
+            const event = actions_core_1.createTestEvent(testEvent);
+            await expect(testDestination.testAction('reportConversionEvent', {
+                event,
+                settings: {
+                    app_id: 'test123'
+                },
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'PURCHASE',
+                    event_conversion_type: 'WEB'
+                }
+            })).rejects.toThrowError('If event conversion type is "WEB" then pixel_id must be defined');
+        });
+        it('should fail web event without snap_app_id', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(400, {});
+            const event = actions_core_1.createTestEvent(testEvent);
+            await expect(testDestination.testAction('reportConversionEvent', {
+                event,
+                settings: {
+                    pixel_id: 'test123',
+                    app_id: 'test123'
+                },
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'PURCHASE',
+                    event_conversion_type: 'MOBILE_APP'
+                }
+            })).rejects.toThrowError('If event conversion type is "MOBILE_APP" then snap_app_id and app_id must be defined');
+        });
+        it('should handle an offline event conversion type', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(200, {});
+            const event = actions_core_1.createTestEvent(testEvent);
+            const responses = await testDestination.testAction('reportConversionEvent', {
+                event,
+                settings,
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'SAVE',
+                    event_conversion_type: 'OFFLINE'
+                }
+            });
+            expect(responses).not.toBeNull();
+            expect(responses[0].status).toBe(200);
+            expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"event_type\\":\\"SAVE\\",\\"event_conversion_type\\":\\"OFFLINE\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"pixel_id\\":\\"test123\\"}"`);
+        });
+        it('should handle a mobile app event conversion type', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(200, {});
+            const event = actions_core_1.createTestEvent(testEvent);
+            const responses = await testDestination.testAction('reportConversionEvent', {
+                event,
+                settings: {
+                    snap_app_id: '123',
+                    app_id: '123'
+                },
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'SAVE',
+                    event_conversion_type: 'MOBILE_APP'
+                }
+            });
+            expect(responses).not.toBeNull();
+            expect(responses[0].status).toBe(200);
+            expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"event_type\\":\\"SAVE\\",\\"event_conversion_type\\":\\"MOBILE_APP\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"snap_app_id\\":\\"123\\",\\"app_id\\":\\"123\\"}"`);
+        });
+        it('should fail invalid currency', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(400, {});
+            const event = actions_core_1.createTestEvent({
+                ...testEvent,
+                properties: {
+                    currency: 'Galleon'
+                }
+            });
+            await expect(testDestination.testAction('reportConversionEvent', {
+                event,
+                settings,
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'PURCHASE',
+                    event_conversion_type: 'WEB'
+                }
+            })).rejects.toThrowError('Galleon is not a valid currency code.');
+        });
+        it('should fail missing event conversion type', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(400, {});
+            const event = actions_core_1.createTestEvent(testEvent);
+            await expect(testDestination.testAction('reportConversionEvent', {
+                event,
+                settings,
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: 'PURCHASE'
+                }
+            })).rejects.toThrowError("The root value is missing the required field 'event_conversion_type'.");
+        });
+        it('should handle a custom event', async () => {
+            nock_1.default(conversionEventUrl).post('').reply(200, {});
+            const event = actions_core_1.createTestEvent({
+                ...testEvent,
+                event: 'CUSTOM_EVENT_5'
+            });
+            const responses = await testDestination.testAction('reportConversionEvent', {
+                event,
+                settings: {
+                    snap_app_id: '123',
+                    app_id: '123'
+                },
+                useDefaultMappings: true,
+                auth: {
+                    accessToken,
+                    refreshToken
+                },
+                mapping: {
+                    event_type: { '@path': '$.event' },
+                    event_conversion_type: 'MOBILE_APP'
+                }
+            });
+            expect(responses).not.toBeNull();
+            expect(responses[0].status).toBe(200);
+            expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"event_type\\":\\"CUSTOM_EVENT_5\\",\\"event_conversion_type\\":\\"MOBILE_APP\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"snap_app_id\\":\\"123\\",\\"app_id\\":\\"123\\"}"`);
+        });
+    });
+});
 //# sourceMappingURL=index.test.js.map

package/dist/destinations/snap-conversions-api/_tests_/index.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/_tests_/index.test.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/_tests_/index.test.ts"],"names":[],"mappings":";;;;;AAAA,gDAAuB;AACvB,wDAA8E;AAC9E,qDAAiC;AAGjC,MAAM,eAAe,GAAG,oCAAqB,CAAC,eAAU,CAAC,CAAA;AACzD,MAAM,SAAS,GAAG,0BAA0B,CAAA;AAC5C,MAAM,QAAQ,GAAa;IACzB,WAAW,EAAE,SAAS;IACtB,QAAQ,EAAE,SAAS;IACnB,MAAM,EAAE,SAAS;CAClB,CAAA;AACD,MAAM,WAAW,GAAG,SAAS,CAAA;AAC7B,MAAM,YAAY,GAAG,SAAS,CAAA;AAE9B,MAAM,SAAS,GAAG,8BAAe,CAAC;IAChC,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,0BAA0B;IACrC,KAAK,EAAE,UAAU;IACjB,IAAI,EAAE,OAAO;IACb,UAAU,EAAE;QACV,KAAK,EAAE,mBAAmB;QAC1B,KAAK,EAAE,kBAAkB;QACzB,SAAS,EAAE,gBAAgB;QAC3B,YAAY,EAAE,EAAE;QAChB,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,CAAC;KACT;CACF,CAAC,CAAA;AAEF,MAAM,kBAAkB,GAAG,uCAAuC,CAAA;AAElE,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC3C,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC,SAAS,CAAC,CAAA;YAExC,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAC1E,KAAK;gBACL,QAAQ;gBACR,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,UAAU;oBACtB,qBAAqB,EAAE,KAAK;iBAC7B;aACF,CAAC,CAAA;YAEF,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAA;YAChC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAErC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACrD,upBAAupB,CACxpB,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC,SAAS,CAAC,CAAA;YAExC,MAAM,MAAM,CACV,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAClD,KAAK;gBACL,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;iBAClB;gBACD,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,UAAU;oBACtB,qBAAqB,EAAE,KAAK;iBAC7B;aACF,CAAC,CACH,CAAC,OAAO,CAAC,YAAY,CAAC,iEAAiE,CAAC,CAAA;QAC3F,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC,SAAS,CAAC,CAAA;YAExC,MAAM,MAAM,CACV,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAClD,KAAK;gBACL,QAAQ,EAAE;oBACR,QAAQ,EAAE,SAAS;oBACnB,MAAM,EAAE,SAAS;iBAClB;gBACD,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,UAAU;oBACtB,qBAAqB,EAAE,YAAY;iBACpC;aACF,CAAC,CACH,CAAC,OAAO,CAAC,YAAY,CAAC,sFAAsF,CAAC,CAAA;QAChH,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC9D,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC,SAAS,CAAC,CAAA;YAExC,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAC1E,KAAK;gBACL,QAAQ;gBACR,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,MAAM;oBAClB,qBAAqB,EAAE,SAAS;iBACjC;aACF,CAAC,CAAA;YAEF,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAA;YAChC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAErC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACrD,upBAAupB,CACxpB,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;YAChE,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC,SAAS,CAAC,CAAA;YAExC,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAC1E,KAAK;gBACL,QAAQ,EAAE;oBACR,WAAW,EAAE,KAAK;oBAClB,MAAM,EAAE,KAAK;iBACd;gBACD,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,MAAM;oBAClB,qBAAqB,EAAE,YAAY;iBACpC;aACF,CAAC,CAAA;YAEF,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAA;YAChC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAErC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACrD,grBAAgrB,CACjrB,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC;gBAC5B,GAAG,SAAS;gBACZ,UAAU,EAAE;oBACV,QAAQ,EAAE,SAAS;iBACpB;aACF,CAAC,CAAA;YAEF,MAAM,MAAM,CACV,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAClD,KAAK;gBACL,QAAQ;gBACR,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,UAAU;oBACtB,qBAAqB,EAAE,KAAK;iBAC7B;aACF,CAAC,CACH,CAAC,OAAO,CAAC,YAAY,CAAC,uCAAuC,CAAC,CAAA;QACjE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC,SAAS,CAAC,CAAA;YAExC,MAAM,MAAM,CACV,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAClD,KAAK;gBACL,QAAQ;gBACR,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,UAAU;iBACvB;aACF,CAAC,CACH,CAAC,OAAO,CAAC,YAAY,CAAC,uEAAuE,CAAC,CAAA;QACjG,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,cAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;YAEhD,MAAM,KAAK,GAAG,8BAAe,CAAC;gBAC5B,GAAG,SAAS;gBACZ,KAAK,EAAE,gBAAgB;aACxB,CAAC,CAAA;YAEF,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAC1E,KAAK;gBACL,QAAQ,EAAE;oBACR,WAAW,EAAE,KAAK;oBAClB,MAAM,EAAE,KAAK;iBACd;gBACD,kBAAkB,EAAE,IAAI;gBACxB,IAAI,EAAE;oBACJ,WAAW;oBACX,YAAY;iBACb;gBACD,OAAO,EAAE;oBACP,UAAU,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;oBAClC,qBAAqB,EAAE,YAAY;iBACpC;aACF,CAAC,CAAA;YAEF,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAA;YAChC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAErC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACrD,0rBAA0rB,CAC3rB,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/destinations/snap-conversions-api/index.js

@@ -3,8 +3,154 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
 const reportConversionEvent_1 = __importDefault(require("./reportConversionEvent"));
+const DEFAULT_VALS = {
+    ...actions_core_1.defaultValues(reportConversionEvent_1.default.fields)
+};
 const ACCESS_TOKEN_URL = 'https://accounts.snapchat.com/login/oauth2/access_token';
+const presets = [
+    {
+        name: 'Add Billing',
+        subscribe: 'event = "Payment Info Entered"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'ADD_BILLING',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Add to Cart',
+        subscribe: 'event = "Product Added"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'ADD_CART',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Add to Wishlist',
+        subscribe: 'event = "Product Added to Wishlist"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'ADD_TO_WISHLIST',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'App Install',
+        subscribe: 'event = "Application Installed"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'APP_INSTALL',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'List View',
+        subscribe: 'event = "Product List Viewed"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'LIST_VIEW',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'App Open',
+        subscribe: 'event = "Application Opened"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'APP_OPEN',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Login',
+        subscribe: 'event = "Signed In"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'LOGIN',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Page View',
+        subscribe: 'type = "page"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'PAGE_VIEW',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Purchase',
+        subscribe: 'event = "Order Completed"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'PURCHASE',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Search',
+        subscribe: 'event = "Products Searched"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'SEARCH',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Share',
+        subscribe: 'event = "Product Shared"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'SHARE',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Sign Up',
+        subscribe: 'event = "Signed Up"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'SIGN_UP',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'Start Checkout',
+        subscribe: 'event = "Checkout Started"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'START_CHECKOUT',
+            event_conversion_type: 'WEB'
+        }
+    },
+    {
+        name: 'View Content',
+        subscribe: 'event = "Product Viewed"',
+        partnerAction: 'reportConversionEvent',
+        mapping: {
+            ...DEFAULT_VALS,
+            event_type: 'VIEW_CONTENT',
+            event_conversion_type: 'WEB'
+        }
+    }
+];
 const destination = {
     name: 'Snap Conversions Api',
     slug: 'actions-snap-conversions',
@@ -48,6 +194,7 @@ const destination = {
             }
         };
     },
+    presets,
     actions: {
         reportConversionEvent: reportConversionEvent_1.default
     }

package/dist/destinations/snap-conversions-api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/snap-conversions-api/index.ts"],"names":[],"mappings":";;;;;AAIA,oFAA2D;AAM3D,MAAM,gBAAgB,GAAG,yDAAyD,CAAA;AAuIlF,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,QAAQ,EAAE;gBACR,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,iFAAiF;gBAC9F,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE;gBACX,KAAK,EAAE,aAAa;gBACpB,WAAW,EACT,gKAAgK;gBAClK,IAAI,EAAE,QAAQ;aACf;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,QAAQ;gBACf,WAAW,EACT,wJAAwJ;gBAC1J,IAAI,EAAE,QAAQ;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAE9C,MAAM,GAAG,GAAG,MAAM,OAAO,CAAuB,gBAAgB,EAAE;gBAChE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,eAAe,CAAC;oBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;oBAChC,SAAS,EAAE,IAAI,CAAC,QAAQ;oBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;oBAChC,UAAU,EAAE,eAAe;iBAC5B,CAAC;aACH,CAAC,CAAA;YAEF,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAA;QAC/C,CAAC;KACF;IACD,aAAa,CAAC,EAAE,IAAI,EAAE;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;aAC7C;SACF,CAAA;IACH,CAAC;IACD,OAAO,EAAE;QACP,qBAAqB,EAArB,+BAAqB;KACtB;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/snap-conversions-api/index.ts"],"names":[],"mappings":";;;;;AAAA,wDAA4E;AAG5E,oFAA2D;AAE3D,MAAM,YAAY,GAAG;IACnB,GAAG,4BAAa,CAAC,+BAAqB,CAAC,MAAM,CAAC;CAC/C,CAAA;AAED,MAAM,gBAAgB,GAAG,yDAAyD,CAAA;AAMlF,MAAM,OAAO,GAAqC;IAChD;QACE,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,gCAAgC;QAC3C,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,aAAa;YACzB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,yBAAyB;QACpC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,UAAU;YACtB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,SAAS,EAAE,qCAAqC;QAChD,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,iBAAiB;YAC7B,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,iCAAiC;QAC5C,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,aAAa;YACzB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,+BAA+B;QAC1C,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,WAAW;YACvB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,8BAA8B;QACzC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,UAAU;YACtB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,qBAAqB;QAChC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,OAAO;YACnB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,eAAe;QAC1B,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,WAAW;YACvB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,2BAA2B;QACtC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,UAAU;YACtB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,6BAA6B;QACxC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,QAAQ;YACpB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,0BAA0B;QACrC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,OAAO;YACnB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,qBAAqB;QAChC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,SAAS;YACrB,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE,4BAA4B;QACvC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,gBAAgB;YAC5B,qBAAqB,EAAE,KAAK;SAC7B;KACF;IACD;QACE,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE,0BAA0B;QACrC,aAAa,EAAE,uBAAuB;QACtC,OAAO,EAAE;YACP,GAAG,YAAY;YACf,UAAU,EAAE,cAAc;YAC1B,qBAAqB,EAAE,KAAK;SAC7B;KACF;CACF,CAAA;AAED,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,QAAQ,EAAE;gBACR,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,iFAAiF;gBAC9F,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EAAE;gBACX,KAAK,EAAE,aAAa;gBACpB,WAAW,EACT,gKAAgK;gBAClK,IAAI,EAAE,QAAQ;aACf;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,QAAQ;gBACf,WAAW,EACT,wJAAwJ;gBAC1J,IAAI,EAAE,QAAQ;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAE9C,MAAM,GAAG,GAAG,MAAM,OAAO,CAAuB,gBAAgB,EAAE;gBAChE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,eAAe,CAAC;oBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;oBAChC,SAAS,EAAE,IAAI,CAAC,QAAQ;oBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;oBAChC,UAAU,EAAE,eAAe;iBAC5B,CAAC;aACH,CAAC,CAAA;YAEF,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAA;QAC/C,CAAC;KACF;IACD,aAAa,CAAC,EAAE,IAAI,EAAE;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;aAC7C;SACF,CAAA;IACH,CAAC;IACD,OAAO;IACP,OAAO,EAAE;QACP,qBAAqB,EAArB,+BAAqB;KACtB;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/snap-conversions-api/reportConversionEvent/generated-types.d.ts

@@ -1,2 +1,25 @@
 export interface Payload {
+    event_type: string;
+    event_conversion_type: string;
+    event_tag?: string;
+    timestamp: string;
+    email?: string;
+    mobile_ad_id?: string;
+    uuid_c1?: string;
+    idfv?: string;
+    phone_number?: string;
+    user_agent?: string;
+    ip_address?: string;
+    item_category?: string;
+    item_ids?: string;
+    description?: string;
+    number_items?: string;
+    price?: number;
+    currency?: string;
+    transaction_id?: string;
+    level?: string;
+    client_dedup_id?: string;
+    search_string?: string;
+    page_url?: string;
+    sign_up_method?: string;
 }

package/dist/destinations/snap-conversions-api/reportConversionEvent/index.js

@@ -1,11 +1,49 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const snap_capi_properties_1 = require("../snap-capi-properties");
+const CONVERSION_EVENT_URL = 'https://tr.snapchat.com/v2/conversion';
 const action = {
     title: 'Report Conversion Event',
     description: 'Report events directly to Snapchat. Data shared can power Snap solutions such as custom audience targeting, campaign optimization, Dynamic Ads, and more.',
-    fields: {},
-    perform: () => {
-        return;
+    fields: {
+        event_type: { ...snap_capi_properties_1.event_type, required: true },
+        event_conversion_type: { ...snap_capi_properties_1.event_conversion_type, required: true },
+        event_tag: snap_capi_properties_1.event_tag,
+        timestamp: { ...snap_capi_properties_1.timestamp, required: true },
+        email: snap_capi_properties_1.email,
+        mobile_ad_id: snap_capi_properties_1.mobile_ad_id,
+        uuid_c1: snap_capi_properties_1.uuid_c1,
+        idfv: snap_capi_properties_1.idfv,
+        phone_number: snap_capi_properties_1.phone_number,
+        user_agent: snap_capi_properties_1.user_agent,
+        ip_address: snap_capi_properties_1.ip_address,
+        item_category: snap_capi_properties_1.item_category,
+        item_ids: snap_capi_properties_1.item_ids,
+        description: snap_capi_properties_1.description,
+        number_items: snap_capi_properties_1.number_items,
+        price: snap_capi_properties_1.price,
+        currency: snap_capi_properties_1.currency,
+        transaction_id: snap_capi_properties_1.transaction_id,
+        level: snap_capi_properties_1.level,
+        client_dedup_id: snap_capi_properties_1.client_dedup_id,
+        search_string: snap_capi_properties_1.search_string,
+        page_url: snap_capi_properties_1.page_url,
+        sign_up_method: snap_capi_properties_1.sign_up_method
+    },
+    perform: (request, data) => {
+        const payload = snap_capi_properties_1.formatPayload(data.payload);
+        const settings = snap_capi_properties_1.conversionType(data.settings, data.payload.event_conversion_type);
+        if (data.payload.currency && !snap_capi_properties_1.CURRENCY_ISO_4217_CODES.has(data.payload.currency)) {
+            throw new actions_core_1.IntegrationError(`${data.payload.currency} is not a valid currency code.`, 'Misconfigured required field', 400);
+        }
+        return request(CONVERSION_EVENT_URL, {
+            method: 'post',
+            json: {
+                ...payload,
+                ...settings
+            }
+        });
     }
 };
 exports.default = action;

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/reportConversionEvent/index.ts"],"names":[],"mappings":";;AAqFA,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,yBAAyB;IAChC,WAAW,EACT,2JAA2J;IAC7J,MAAM,EAAE,EAAE;IAEV,OAAO,EAAE,GAAG,EAAE;QACZ,OAAM;IACR,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/snap-conversions-api/reportConversionEvent/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,kEA2BgC;AAEhC,MAAM,oBAAoB,GAAG,uCAAuC,CAAA;AAEpE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,yBAAyB;IAChC,WAAW,EACT,2JAA2J;IAC7J,MAAM,EAAE;QACN,UAAU,EAAE,EAAE,GAAG,iCAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,qBAAqB,EAAE,EAAE,GAAG,4CAAqB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnE,SAAS,EAAE,gCAAS;QACpB,SAAS,EAAE,EAAE,GAAG,gCAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3C,KAAK,EAAE,4BAAK;QACZ,YAAY,EAAE,mCAAY;QAC1B,OAAO,EAAE,8BAAO;QAChB,IAAI,EAAE,2BAAI;QACV,YAAY,EAAE,mCAAY;QAC1B,UAAU,EAAE,iCAAU;QACtB,UAAU,EAAE,iCAAU;QACtB,aAAa,EAAE,oCAAa;QAC5B,QAAQ,EAAE,+BAAQ;QAClB,WAAW,EAAE,kCAAW;QACxB,YAAY,EAAE,mCAAY;QAC1B,KAAK,EAAE,4BAAK;QACZ,QAAQ,EAAE,+BAAQ;QAClB,cAAc,EAAE,qCAAc;QAC9B,KAAK,EAAE,4BAAK;QACZ,eAAe,EAAE,sCAAe;QAChC,aAAa,EAAE,oCAAa;QAC5B,QAAQ,EAAE,+BAAQ;QAClB,cAAc,EAAE,qCAAc;KAC/B;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;QACzB,MAAM,OAAO,GAAW,oCAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACnD,MAAM,QAAQ,GAAa,qCAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;QAE5F,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,8CAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAChF,MAAM,IAAI,+BAAgB,CACxB,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,gCAAgC,EACxD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;SACF;QAGD,OAAO,OAAO,CAAC,oBAAoB,EAAE;YACnC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,GAAG,OAAO;gBACV,GAAG,QAAQ;aACZ;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/snap-conversions-api/snap-capi-properties.d.ts

@@ -0,0 +1,30 @@
+import { InputField } from '@segment/actions-core/src/destination-kit/types';
+import { Settings } from '../snap-conversions-api/generated-types';
+import { Payload } from './reportConversionEvent/generated-types';
+export declare const CURRENCY_ISO_4217_CODES: Set<string>;
+export declare const event_type: InputField;
+export declare const event_conversion_type: InputField;
+export declare const event_tag: InputField;
+export declare const timestamp: InputField;
+export declare const email: InputField;
+export declare const mobile_ad_id: InputField;
+export declare const uuid_c1: InputField;
+export declare const idfv: InputField;
+export declare const phone_number: InputField;
+export declare const user_agent: InputField;
+export declare const ip_address: InputField;
+export declare const item_category: InputField;
+export declare const item_ids: InputField;
+export declare const description: InputField;
+export declare const number_items: InputField;
+export declare const price: InputField;
+export declare const currency: InputField;
+export declare const transaction_id: InputField;
+export declare const level: InputField;
+export declare const client_dedup_id: InputField;
+export declare const search_string: InputField;
+export declare const page_url: InputField;
+export declare const sign_up_method: InputField;
+export declare const conversionType: (settings: Settings, event_conversion_type: String) => Settings;
+export declare const hash: (value: string | undefined) => string | undefined;
+export declare const formatPayload: (payload: Payload) => Object;