@segment/action-destinations 3.339.0-staging-b4a3920c → 3.339.0

package/dist/destinations/singlestore/types.js.map

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

package/dist/destinations/singlestore/util.d.ts

@@ -0,0 +1,10 @@
+import { Settings } from './generated-types';
+import { KafkaConfig, ProducerRecord } from 'kafkajs';
+export declare const checkChamber: () => void;
+export declare const encryptText: (inputData: string) => string;
+export declare const destinationId: (settings: Settings) => string;
+export declare const getKafkaConfiguration: (settings: Settings) => {
+    kafkaConfig: KafkaConfig;
+    kafkaTopic: string;
+};
+export declare const getProducerRecord: (kafkaTopic: string, message: unknown) => ProducerRecord;

package/dist/destinations/singlestore/util.js

@@ -0,0 +1,84 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProducerRecord = exports.getKafkaConfiguration = exports.destinationId = exports.encryptText = exports.checkChamber = void 0;
+const crypto = __importStar(require("crypto"));
+const const_1 = require("./const");
+const actions_core_1 = require("@segment/actions-core");
+const crypto_1 = require("crypto");
+const checkChamber = () => {
+    if (!process.env.ACTIONS_SINGLE_STORE_ENCRYPTION_KEY) {
+        throw new actions_core_1.IntegrationError('Missing SingleStore ENCRYPTION_KEY', 'MISSING_REQUIRED_FIELD', 400);
+    }
+    if (!process.env.ACTIONS_SINGLE_STORE_X_SECURITY_KEY) {
+        throw new actions_core_1.IntegrationError('Missing SingleStore X_SECURITY_KEY', 'MISSING_REQUIRED_FIELD', 400);
+    }
+    if (!process.env.ACTIONS_SINGLE_STORE_IV) {
+        throw new actions_core_1.IntegrationError('Missing SingleStore IV', 'MISSING_REQUIRED_FIELD', 400);
+    }
+};
+exports.checkChamber = checkChamber;
+const encryptText = (inputData) => {
+    const keyBuffer = Buffer.from(process.env.ACTIONS_SINGLE_STORE_ENCRYPTION_KEY, 'hex');
+    const ivBuffer = Buffer.from(process.env.ACTIONS_SINGLE_STORE_IV, 'hex');
+    const cipher = crypto.createCipheriv('aes-256-cbc', keyBuffer, ivBuffer);
+    let encryptedData = cipher.update(inputData, 'utf8', 'hex');
+    encryptedData += cipher.final('hex');
+    return encryptedData;
+};
+exports.encryptText = encryptText;
+const databaseUri = (settings) => {
+    return `${settings.username}@${settings.host}:${settings.port}/${settings.dbName}`;
+};
+const destinationId = (settings) => {
+    return crypto_1.createHash('sha256').update(databaseUri(settings)).digest('hex');
+};
+exports.destinationId = destinationId;
+const getKafkaConfiguration = (settings) => {
+    const destination_id = exports.destinationId(settings);
+    const kafkaTopic = crypto_1.createHash('sha256').update(destination_id).digest('hex');
+    const kafkaUsername = crypto_1.createHash('sha256').update(`${destination_id}_user`).digest('hex');
+    const kafkaPassword = exports.encryptText(kafkaUsername);
+    const kafkaConfig = {
+        clientId: const_1.CLIENT_ID,
+        brokers: settings.environment === 'Prod' ? const_1.PROD_BROKERS : const_1.STAGE_BROKERS,
+        sasl: {
+            username: kafkaUsername,
+            password: kafkaPassword,
+            mechanism: 'scram-sha-512'
+        },
+        ssl: true
+    };
+    return { kafkaConfig, kafkaTopic };
+};
+exports.getKafkaConfiguration = getKafkaConfiguration;
+const getProducerRecord = (kafkaTopic, message) => {
+    return {
+        topic: kafkaTopic,
+        messages: [
+            {
+                value: JSON.stringify(message)
+            }
+        ]
+    };
+};
+exports.getProducerRecord = getProducerRecord;
+//# sourceMappingURL=util.js.map

package/dist/destinations/singlestore/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/destinations/singlestore/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAChC,mCAAgE;AAChE,wDAAwD;AAExD,mCAAmC;AAG5B,MAAM,YAAY,GAAG,GAAS,EAAE;IACrC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE;QACpD,MAAM,IAAI,+BAAgB,CAAC,oCAAoC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;KAChG;IAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE;QACpD,MAAM,IAAI,+BAAgB,CAAC,oCAAoC,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;KAChG;IAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE;QACxC,MAAM,IAAI,+BAAgB,CAAC,wBAAwB,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;KACpF;AACH,CAAC,CAAA;AAZY,QAAA,YAAY,gBAYxB;AAEM,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE;IACvD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAA6C,EAAE,KAAK,CAAC,CAAA;IAC/F,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAiC,EAAE,KAAK,CAAC,CAAA;IAClF,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IACxE,IAAI,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAC3D,aAAa,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpC,OAAO,aAAa,CAAA;AACtB,CAAC,CAAA;AAPY,QAAA,WAAW,eAOvB;AAED,MAAM,WAAW,GAAG,CAAC,QAAkB,EAAU,EAAE;IACjD,OAAO,GAAG,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAA;AACpF,CAAC,CAAA;AAEM,MAAM,aAAa,GAAG,CAAC,QAAkB,EAAU,EAAE;IAC1D,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACzE,CAAC,CAAA;AAFY,QAAA,aAAa,iBAEzB;AAEM,MAAM,qBAAqB,GAAG,CAAC,QAAkB,EAAoD,EAAE;IAC5G,MAAM,cAAc,GAAG,qBAAa,CAAC,QAAQ,CAAC,CAAA;IAC9C,MAAM,UAAU,GAAG,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC5E,MAAM,aAAa,GAAG,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,cAAc,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACzF,MAAM,aAAa,GAAG,mBAAW,CAAC,aAAa,CAAC,CAAA;IAChD,MAAM,WAAW,GAAgB;QAC/B,QAAQ,EAAE,iBAAS;QACnB,OAAO,EAAE,QAAQ,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,oBAAY,CAAC,CAAC,CAAC,qBAAa;QACvE,IAAI,EAAE;YACJ,QAAQ,EAAE,aAAa;YACvB,QAAQ,EAAE,aAAa;YACvB,SAAS,EAAE,eAAe;SAC3B;QACD,GAAG,EAAE,IAAI;KACV,CAAA;IACD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,CAAA;AACpC,CAAC,CAAA;AAhBY,QAAA,qBAAqB,yBAgBjC;AAEM,MAAM,iBAAiB,GAAG,CAAC,UAAkB,EAAE,OAAgB,EAAkB,EAAE;IACxF,OAAO;QACL,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;aAC/B;SACF;KACF,CAAA;AACH,CAAC,CAAA;AATY,QAAA,iBAAiB,qBAS7B"}

package/dist/destinations/snap-audiences/generated-types.d.ts

@@ -0,0 +1,8 @@
+export interface Settings {
+    ad_account_id: string;
+}
+export interface AudienceSettings {
+    customAudienceName?: string;
+    description?: string;
+    retention_in_days?: number;
+}

package/dist/destinations/snap-audiences/generated-types.js

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

package/dist/destinations/snap-audiences/generated-types.js.map

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

package/dist/destinations/snap-audiences/index.d.ts

@@ -0,0 +1,4 @@
+import { AudienceDestinationDefinition } from '@segment/actions-core';
+import type { Settings, AudienceSettings } from './generated-types';
+declare const destination: AudienceDestinationDefinition<Settings, AudienceSettings>;
+export default destination;

package/dist/destinations/snap-audiences/index.js

@@ -0,0 +1,133 @@
+"use strict";
+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 syncAudience_1 = __importDefault(require("./syncAudience"));
+const ACCESS_TOKEN_URL = 'https://accounts.snapchat.com/login/oauth2/access_token';
+const destination = {
+    name: 'Snap Audiences (Actions)',
+    slug: 'actions-snap-audiences',
+    mode: 'cloud',
+    authentication: {
+        scheme: 'oauth2',
+        fields: {
+            ad_account_id: {
+                label: 'Ad Account ID',
+                description: 'The ID of the Snap Ad Account',
+                required: true,
+                type: 'string'
+            }
+        },
+        refreshAccessToken: async (request, { auth }) => {
+            const res = await request(ACCESS_TOKEN_URL, {
+                method: 'POST',
+                body: new URLSearchParams({
+                    refresh_token: auth.refreshToken,
+                    client_id: auth.clientId,
+                    client_secret: auth.clientSecret,
+                    grant_type: 'refresh_token'
+                })
+            });
+            return { accessToken: res.data.access_token };
+        }
+    },
+    extendRequest({ auth }) {
+        return {
+            headers: {
+                authorization: `Bearer ${auth?.accessToken}`
+            }
+        };
+    },
+    presets: [
+        {
+            name: 'Sync Audience with Email',
+            subscribe: 'type = "track" and context.traits.email exists',
+            partnerAction: 'syncAudience',
+            mapping: { ...actions_core_1.defaultValues(syncAudience_1.default.fields), schema_type: 'EMAIL_SHA256' },
+            type: 'automatic'
+        },
+        {
+            name: 'Sync Audience with Phone',
+            subscribe: 'type = "track" and properties.phone exists',
+            partnerAction: 'syncAudience',
+            mapping: { ...actions_core_1.defaultValues(syncAudience_1.default.fields), schema_type: 'PHONE_SHA256' },
+            type: 'automatic'
+        },
+        {
+            name: 'Sync Audience with Mobile AD ID',
+            subscribe: 'type = "track" and context.device.advertisingId exists',
+            partnerAction: 'syncAudience',
+            mapping: { ...actions_core_1.defaultValues(syncAudience_1.default.fields), schema_type: 'MOBILE_AD_ID_SHA256' },
+            type: 'automatic'
+        }
+    ],
+    audienceFields: {
+        customAudienceName: {
+            type: 'string',
+            label: 'Audience Name',
+            description: 'Name for the audience that will be created in Snap. Defaults to the snake_cased Segment audience name if left blank.',
+            default: '',
+            required: false
+        },
+        description: {
+            type: 'string',
+            label: 'Audience Description',
+            description: 'Description of for the audience that will be created in Snap.',
+            default: '',
+            required: false
+        },
+        retention_in_days: {
+            type: 'number',
+            label: 'Retention in days',
+            description: '# of days to retain audience members. (Default retention is lifetime represented as 9999)',
+            default: 9999,
+            required: false
+        }
+    },
+    audienceConfig: {
+        mode: {
+            type: 'synced',
+            full_audience_sync: false
+        },
+        async createAudience(request, createAudienceInput) {
+            const audienceName = createAudienceInput.audienceName;
+            const ad_account_id = createAudienceInput.settings.ad_account_id;
+            const { customAudienceName, description, retention_in_days } = createAudienceInput.audienceSettings || {};
+            if (!audienceName) {
+                throw new actions_core_1.IntegrationError('Missing audience name value', 'MISSING_REQUIRED_FIELD', 400);
+            }
+            const response = await request(`https://adsapi.snapchat.com/v1/adaccounts/${ad_account_id}/segments`, {
+                method: 'POST',
+                json: {
+                    segments: [
+                        {
+                            name: customAudienceName !== '' ? customAudienceName : audienceName,
+                            source_type: 'FIRST_PARTY',
+                            ad_account_id,
+                            description,
+                            retention_in_days
+                        }
+                    ]
+                }
+            });
+            const data = await response.json();
+            const snapAudienceId = data.segments[0].segment.id;
+            return { externalId: snapAudienceId };
+        },
+        getAudience: async (request, { externalId }) => {
+            const response = await request(`https://adsapi.snapchat.com/v1/segments/${externalId}`, {
+                method: 'GET'
+            });
+            const data = await response.json();
+            const snapAudienceId = data.segments[0].segment.id;
+            return { externalId: snapAudienceId };
+        }
+    },
+    actions: {
+        syncAudience: syncAudience_1.default
+    }
+};
+exports.default = destination;
+//# sourceMappingURL=index.js.map

package/dist/destinations/snap-audiences/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/snap-audiences/index.ts"],"names":[],"mappings":";;;;;AAAA,wDAAsG;AAEtG,kEAAyC;AACzC,MAAM,gBAAgB,GAAG,yDAAyD,CAAA;AAsBlF,MAAM,WAAW,GAA8D;IAC7E,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,aAAa,EAAE;gBACb,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,+BAA+B;gBAC5C,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,QAAQ;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9C,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;YACE,IAAI,EAAE,0BAA0B;YAChC,SAAS,EAAE,gDAAgD;YAC3D,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE,EAAE,GAAG,4BAAa,CAAC,sBAAY,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE;YAC/E,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,0BAA0B;YAChC,SAAS,EAAE,4CAA4C;YACvD,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE,EAAE,GAAG,4BAAa,CAAC,sBAAY,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE;YAC/E,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,iCAAiC;YACvC,SAAS,EAAE,wDAAwD;YACnE,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE,EAAE,GAAG,4BAAa,CAAC,sBAAY,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,qBAAqB,EAAE;YACtF,IAAI,EAAE,WAAW;SAClB;KACF;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE;YAClB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,eAAe;YACtB,WAAW,EACT,sHAAsH;YACxH,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,KAAK;SAChB;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,sBAAsB;YAC7B,WAAW,EAAE,+DAA+D;YAC5E,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,KAAK;SAChB;QACD,iBAAiB,EAAE;YACjB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,2FAA2F;YACxG,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,KAAK;SAChB;KACF;IACD,cAAc,EAAE;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,kBAAkB,EAAE,KAAK;SAC1B;QACD,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,mBAAmB;YAC/C,MAAM,YAAY,GAAG,mBAAmB,CAAC,YAAY,CAAA;YACrD,MAAM,aAAa,GAAG,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAA;YAChE,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,mBAAmB,CAAC,gBAAgB,IAAI,EAAE,CAAA;YAEzG,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,+BAAgB,CAAC,6BAA6B,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;aACzF;YAED,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,6CAA6C,aAAa,WAAW,EAAE;gBACpG,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,QAAQ,EAAE;wBACR;4BACE,IAAI,EAAE,kBAAkB,KAAK,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY;4BACnE,WAAW,EAAE,aAAa;4BAC1B,aAAa;4BACb,WAAW;4BACX,iBAAiB;yBAClB;qBACF;iBACmB;aACvB,CAAC,CAAA;YAEF,MAAM,IAAI,GAAyB,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YACxD,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAA;YAElD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAA;QACvC,CAAC;QAED,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;YAC7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,2CAA2C,UAAU,EAAE,EAAE;gBACtF,MAAM,EAAE,KAAK;aACd,CAAC,CAAA;YAEF,MAAM,IAAI,GAAyB,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YACxD,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAA;YAElD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAA;QACvC,CAAC;KACF;IACD,OAAO,EAAE;QACP,YAAY,EAAZ,sBAAY;KACb;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/snap-audiences/syncAudience/generated-types.d.ts

@@ -0,0 +1,12 @@
+export interface Payload {
+    external_audience_id: string;
+    audienceKey: string;
+    props: {
+        [k: string]: unknown;
+    };
+    schema_type: string;
+    phone?: string;
+    email?: string;
+    advertising_id?: string;
+    enable_batching: boolean;
+}

package/dist/destinations/snap-audiences/syncAudience/generated-types.js

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

package/dist/destinations/snap-audiences/syncAudience/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../src/destinations/snap-audiences/syncAudience/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/snap-audiences/syncAudience/index.d.ts

@@ -0,0 +1,5 @@
+import type { 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/snap-audiences/syncAudience/index.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const utils_1 = require("./utils");
+const action = {
+    title: 'Sync Audience',
+    description: 'Sync Segment Engage Audiences to Snap',
+    defaultSubscription: 'type = "track"',
+    fields: {
+        external_audience_id: {
+            type: 'string',
+            label: 'External Audience ID',
+            description: 'Unique Audience Identifier returned by the createAudience() function call.',
+            required: true,
+            unsafe_hidden: true,
+            default: {
+                '@path': '$.context.personas.external_audience_id'
+            }
+        },
+        audienceKey: {
+            type: 'string',
+            label: 'Audience Key',
+            description: 'Audience key.',
+            required: true,
+            unsafe_hidden: true,
+            default: {
+                '@path': '$.context.personas.computation_key'
+            }
+        },
+        props: {
+            label: 'Properties object',
+            description: 'A computed object for track events.',
+            type: 'object',
+            required: true,
+            unsafe_hidden: true,
+            default: { '@path': '$.properties' }
+        },
+        schema_type: {
+            type: 'string',
+            choices: [
+                { value: 'MOBILE_AD_ID_SHA256', label: 'Mobile ID' },
+                { value: 'PHONE_SHA256', label: 'Phone' },
+                { value: 'EMAIL_SHA256', label: 'Email' }
+            ],
+            label: 'External ID Type',
+            required: true,
+            description: 'Choose the type of identifier to use when adding users to Snap.',
+            default: 'EMAIL_SHA256',
+            disabledInputMethods: ['literal', 'variable', 'function', 'freeform', 'enrichment']
+        },
+        phone: {
+            label: 'Phone',
+            description: "If using phone as the identifier, an additional setup step is required when connecting the Destination to the Audience. Please ensure that 'phone' is configured as an additional identifier in the Audience settings tab.",
+            type: 'string',
+            required: false,
+            default: { '@path': '$.properties.phone' },
+            depends_on: {
+                match: 'all',
+                conditions: [
+                    {
+                        fieldKey: 'schema_type',
+                        operator: 'is',
+                        value: 'PHONE_SHA256'
+                    }
+                ]
+            }
+        },
+        email: {
+            label: 'Email',
+            description: "The user's email address.",
+            type: 'string',
+            format: 'email',
+            required: false,
+            default: { '@path': '$.context.traits.email' },
+            depends_on: {
+                match: 'all',
+                conditions: [
+                    {
+                        fieldKey: 'schema_type',
+                        operator: 'is',
+                        value: 'EMAIL_SHA256'
+                    }
+                ]
+            }
+        },
+        advertising_id: {
+            label: 'Mobile Advertising ID',
+            description: "If using Mobile Ad ID as the identifier, an additional setup step is required when connecting the Destination to the Audience. Please ensure that 'ios.idfa' and 'android.idfa' are configured as an additional identifier in the Audience settings tab.",
+            type: 'string',
+            required: false,
+            default: {
+                '@path': '$.context.device.advertisingId'
+            },
+            depends_on: {
+                match: 'all',
+                conditions: [
+                    {
+                        fieldKey: 'schema_type',
+                        operator: 'is',
+                        value: 'MOBILE_AD_ID_SHA256'
+                    }
+                ]
+            }
+        },
+        enable_batching: {
+            label: 'Enable Batching',
+            description: 'When enabled, events will be batched before being sent to Snap.',
+            type: 'boolean',
+            required: true,
+            default: true
+        }
+    },
+    perform: async (request, { payload }) => {
+        return processPayload(request, [payload]);
+    },
+    performBatch: async (request, { payload }) => {
+        return processPayload(request, payload);
+    }
+};
+exports.default = action;
+const processPayload = async (request, payload) => {
+    const { external_audience_id, schema_type } = payload[0];
+    const { enteredAudience, exitedAudience } = utils_1.sortPayload(payload);
+    if (enteredAudience.length === 0 && exitedAudience.length === 0) {
+        throw new actions_core_1.PayloadValidationError(`No ${utils_1.validationError(schema_type)} identifier present in payload(s)`);
+    }
+    const requests = [];
+    if (enteredAudience.length > 0) {
+        requests.push(request(`https://adsapi.snapchat.com/v1/segments/${external_audience_id}/users`, {
+            method: 'post',
+            json: {
+                users: [
+                    {
+                        schema: [`${schema_type}`],
+                        data: enteredAudience
+                    }
+                ]
+            }
+        }));
+    }
+    if (exitedAudience.length > 0) {
+        requests.push(request(`https://adsapi.snapchat.com/v1/segments/${external_audience_id}/users`, {
+            method: 'delete',
+            json: {
+                users: [
+                    {
+                        schema: [`${schema_type}`],
+                        data: exitedAudience
+                    }
+                ]
+            }
+        }));
+    }
+    return await Promise.all(requests);
+};
+//# sourceMappingURL=index.js.map

package/dist/destinations/snap-audiences/syncAudience/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/snap-audiences/syncAudience/index.ts"],"names":[],"mappings":";;AACA,wDAA8D;AAG9D,mCAAsD;AAEtD,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,uCAAuC;IACpD,mBAAmB,EAAE,gBAAgB;IACrC,MAAM,EAAE;QACN,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,sBAAsB;YAC7B,WAAW,EAAE,4EAA4E;YACzF,QAAQ,EAAE,IAAI;YACd,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE;gBACP,OAAO,EAAE,yCAAyC;aACnD;SACF;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,eAAe;YAC5B,QAAQ,EAAE,IAAI;YACd,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE;gBACP,OAAO,EAAE,oCAAoC;aAC9C;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE;SACrC;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,WAAW,EAAE;gBACpD,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE;gBACzC,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE;aAC1C;YACD,KAAK,EAAE,kBAAkB;YACzB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,iEAAiE;YAC9E,OAAO,EAAE,cAAc;YACvB,oBAAoB,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC;SACpF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EACT,4NAA4N;YAC9N,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;YAC1C,UAAU,EAAE;gBACV,KAAK,EAAE,KAAK;gBACZ,UAAU,EAAE;oBACV;wBACE,QAAQ,EAAE,aAAa;wBACvB,QAAQ,EAAE,IAAI;wBACd,KAAK,EAAE,cAAc;qBACtB;iBACF;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,2BAA2B;YACxC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;YAC9C,UAAU,EAAE;gBACV,KAAK,EAAE,KAAK;gBACZ,UAAU,EAAE;oBACV;wBACE,QAAQ,EAAE,aAAa;wBACvB,QAAQ,EAAE,IAAI;wBACd,KAAK,EAAE,cAAc;qBACtB;iBACF;aACF;SACF;QACD,cAAc,EAAE;YACd,KAAK,EAAE,uBAAuB;YAC9B,WAAW,EACT,0PAA0P;YAC5P,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,gCAAgC;aAC1C;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,KAAK;gBACZ,UAAU,EAAE;oBACV;wBACE,QAAQ,EAAE,aAAa;wBACvB,QAAQ,EAAE,IAAI;wBACd,KAAK,EAAE,qBAAqB;qBAC7B;iBACF;aACF;SACF;QACD,eAAe,EAAE;YACf,KAAK,EAAE,iBAAiB;YACxB,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;SACd;KACF;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACtC,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3C,CAAC;IACD,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAC3C,OAAO,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACzC,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA;AAErB,MAAM,cAAc,GAAG,KAAK,EAAE,OAAsB,EAAE,OAAkB,EAAE,EAAE;IAC1E,MAAM,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACxD,MAAM,EAAE,eAAe,EAAE,cAAc,EAAE,GAAG,mBAAW,CAAC,OAAO,CAAC,CAAA;IAEhE,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/D,MAAM,IAAI,qCAAsB,CAAC,MAAM,uBAAe,CAAC,WAAW,CAAC,mCAAmC,CAAC,CAAA;KACxG;IAED,MAAM,QAAQ,GAAG,EAAE,CAAA;IAEnB,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;QAC9B,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,2CAA2C,oBAAoB,QAAQ,EAAE;YAC/E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL;wBACE,MAAM,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC;wBAC1B,IAAI,EAAE,eAAe;qBACtB;iBACF;aACF;SACF,CAAC,CACH,CAAA;KACF;IAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7B,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,2CAA2C,oBAAoB,QAAQ,EAAE;YAC/E,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL;wBACE,MAAM,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC;wBAC1B,IAAI,EAAE,cAAc;qBACrB;iBACF;aACF;SACF,CAAC,CACH,CAAA;KACF;IAED,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;AACpC,CAAC,CAAA"}

package/dist/destinations/snap-audiences/syncAudience/utils.d.ts

@@ -0,0 +1,8 @@
+import type { Payload } from './generated-types';
+export declare const sortPayload: (payload: Payload[]) => {
+    enteredAudience: string[][];
+    exitedAudience: string[][];
+};
+export declare const validationError: (schema_type: string) => string;
+export declare const normalizeAndHash: (identifier: string) => string;
+export declare const normalizeAndHashPhone: (phone: string) => string;

package/dist/destinations/snap-audiences/syncAudience/utils.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeAndHashPhone = exports.normalizeAndHash = exports.validationError = exports.sortPayload = void 0;
+const crypto_1 = require("crypto");
+const sortPayload = (payload) => {
+    return payload.reduce((acc, payloadItem) => {
+        const audienceEntered = payloadItem.props[payloadItem.audienceKey];
+        const externalId = validateAndExtractIdentifier(payloadItem.schema_type, payloadItem.email, payloadItem.phone, payloadItem.advertising_id);
+        if (externalId) {
+            if (audienceEntered) {
+                acc.enteredAudience.push([externalId]);
+            }
+            else {
+                acc.exitedAudience.push([externalId]);
+            }
+        }
+        return acc;
+    }, { enteredAudience: [], exitedAudience: [] });
+};
+exports.sortPayload = sortPayload;
+const validationError = (schema_type) => {
+    switch (schema_type) {
+        case 'MOBILE_AD_ID_SHA256':
+            return 'Mobile Advertising ID';
+        case 'EMAIL_SHA256':
+            return 'Email';
+        case 'PHONE_SHA256':
+            return 'Phone number';
+        default:
+            return 'Identifier';
+    }
+};
+exports.validationError = validationError;
+const validateAndExtractIdentifier = (schemaType, email, phone, mobileAdId) => {
+    if (schemaType === 'EMAIL_SHA256' && email) {
+        return exports.normalizeAndHash(email);
+    }
+    if (schemaType === 'MOBILE_AD_ID_SHA256' && mobileAdId) {
+        return exports.normalizeAndHash(mobileAdId);
+    }
+    if (schemaType === 'PHONE_SHA256' && phone) {
+        return exports.normalizeAndHashPhone(phone);
+    }
+    return null;
+};
+const hash = (value) => {
+    const hash = crypto_1.createHash('sha256');
+    hash.update(value);
+    return hash.digest('hex');
+};
+const isHashed = (identifier) => new RegExp(/[0-9abcdef]{64}/gi).test(identifier);
+const normalizeAndHash = (identifier) => {
+    if (isHashed(identifier))
+        return identifier;
+    const hashedIdentifier = hash(identifier.trim().toLowerCase());
+    return hashedIdentifier;
+};
+exports.normalizeAndHash = normalizeAndHash;
+const normalizeAndHashPhone = (phone) => {
+    if (isHashed(phone))
+        return phone;
+    let normalizedPhone = phone.replace(/[\s()+-]/g, '');
+    if (normalizedPhone.startsWith('00')) {
+        normalizedPhone = normalizedPhone.substring(2);
+    }
+    if (normalizedPhone.startsWith('0')) {
+        normalizedPhone = normalizedPhone.substring(1);
+    }
+    const hashedPhone = hash(normalizedPhone);
+    return hashedPhone;
+};
+exports.normalizeAndHashPhone = normalizeAndHashPhone;
+//# sourceMappingURL=utils.js.map

package/dist/destinations/snap-audiences/syncAudience/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/destinations/snap-audiences/syncAudience/utils.ts"],"names":[],"mappings":";;;AACA,mCAAmC;AAG5B,MAAM,WAAW,GAAG,CAAC,OAAkB,EAAE,EAAE;IAChD,OAAO,OAAO,CAAC,MAAM,CAInB,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE;QACnB,MAAM,eAAe,GAAG,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;QAClE,MAAM,UAAU,GAAG,4BAA4B,CAC7C,WAAW,CAAC,WAAW,EACvB,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,cAAc,CAC3B,CAAA;QAED,IAAI,UAAU,EAAE;YACd,IAAI,eAAe,EAAE;gBACnB,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;aACvC;iBAAM;gBACL,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;aACtC;SACF;QAED,OAAO,GAAG,CAAA;IACZ,CAAC,EACD,EAAE,eAAe,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAC5C,CAAA;AACH,CAAC,CAAA;AA1BY,QAAA,WAAW,eA0BvB;AACM,MAAM,eAAe,GAAG,CAAC,WAAmB,EAAU,EAAE;IAC7D,QAAQ,WAAW,EAAE;QACnB,KAAK,qBAAqB;YACxB,OAAO,uBAAuB,CAAA;QAChC,KAAK,cAAc;YACjB,OAAO,OAAO,CAAA;QAChB,KAAK,cAAc;YACjB,OAAO,cAAc,CAAA;QACvB;YACE,OAAO,YAAY,CAAA;KACtB;AACH,CAAC,CAAA;AAXY,QAAA,eAAe,mBAW3B;AAGD,MAAM,4BAA4B,GAAG,CACnC,UAAkB,EAClB,KAAyB,EACzB,KAAyB,EACzB,UAA8B,EACf,EAAE;IACjB,IAAI,UAAU,KAAK,cAAc,IAAI,KAAK,EAAE;QAC1C,OAAO,wBAAgB,CAAC,KAAK,CAAC,CAAA;KAC/B;IACD,IAAI,UAAU,KAAK,qBAAqB,IAAI,UAAU,EAAE;QACtD,OAAO,wBAAgB,CAAC,UAAU,CAAC,CAAA;KACpC;IACD,IAAI,UAAU,KAAK,cAAc,IAAI,KAAK,EAAE;QAC1C,OAAO,6BAAqB,CAAC,KAAK,CAAC,CAAA;KACpC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,KAAa,EAAU,EAAE;IACrC,MAAM,IAAI,GAAG,mBAAU,CAAC,QAAQ,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,UAAkB,EAAW,EAAE,CAAC,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;AAE3F,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAU,EAAE;IAC7D,IAAI,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,UAAU,CAAA;IAC3C,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;IAC9D,OAAO,gBAAgB,CAAA;AACzB,CAAC,CAAA;AAJY,QAAA,gBAAgB,oBAI5B;AAQM,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAU,EAAE;IAC7D,IAAI,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAGjC,IAAI,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;IAGpD,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACpC,eAAe,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;KAC/C;IAGD,IAAI,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACnC,eAAe,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;KAC/C;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,CAAA;IACzC,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA;AAlBY,QAAA,qBAAqB,yBAkBjC"}