@segment/action-destinations 3.131.1-ga4-cloud.12 → 3.131.1-stageTesting-tiktok-ga4.49

package/dist/destinations/twilio-studio/triggerStudioFlow/index.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const utils_1 = require("../utils");
+const action = {
+    title: 'Trigger Studio Flow',
+    description: 'Trigger a Flow in Twilio Studio to initiate an outbound call or message. The Flow will execute via the REST API trigger.',
+    fields: {
+        flowSid: {
+            label: 'Flow SID',
+            description: 'The Flow SID, starting with FW, for the Studio Flow to trigger.',
+            type: 'string',
+            required: true
+        },
+        from: {
+            label: 'From Phone Number',
+            description: 'The Twilio phone number to initiate calls or messages from during the Flow Execution. Use [E.164](https://www.twilio.com/docs/glossary/what-e164) format (+1xxxxxxxxxx).',
+            type: 'string',
+            required: true
+        },
+        coolingOffPeriod: {
+            label: 'Cooling-off Period (in seconds)',
+            description: 'The amount of time during which the Flow can only be triggered once per Flow SID - User ID combination. Default is 60 seconds.',
+            type: 'number',
+            default: 60
+        },
+        userId: {
+            label: 'User ID',
+            description: 'A Distinct User ID',
+            type: 'hidden',
+            default: { '@path': '$.userId' }
+        },
+        anonymousId: {
+            label: 'Anonymous ID',
+            description: 'A Distinct External ID',
+            type: 'hidden',
+            default: { '@path': '$.anonymousId' }
+        },
+        eventType: {
+            label: 'Event type',
+            type: 'hidden',
+            description: 'The type of the event being performed.',
+            required: true,
+            default: {
+                '@path': '$.type'
+            }
+        }
+    },
+    perform: async (request, { settings, payload, stateContext }) => {
+        if (payload.eventType !== 'identify') {
+            throw new actions_core_1.IntegrationError('Unable to trigger Studio Flow. Only Identify Events are allowed!', `Incompatible Event Type: ${payload.eventType}`, 400);
+        }
+        if (!payload.userId && !payload.anonymousId) {
+            throw new actions_core_1.IntegrationError('Unable to trigger Studio Flow. No User identifier found for this Segment profile!', `No userId found in the Segment Event`, 400);
+        }
+        if (stateContext &&
+            !utils_1.shouldSendToStudio(`${payload.flowSid}_${payload.userId || payload.anonymousId}`, stateContext, payload.coolingOffPeriod)) {
+            throw new actions_core_1.IntegrationError(`Unable to trigger Studio Flow. Only 1 request allowed per Flow SID - User ID combination in ${payload.coolingOffPeriod || utils_1.DEFAULT_COOLING_OFF_PERIOD} seconds`, 'Cooling off Period', 400);
+        }
+        const toAddress = await utils_1.getToAddressField(request, settings, payload);
+        if (!toAddress) {
+            throw new actions_core_1.IntegrationError('Unable to trigger Studio Flow. No Contact Address Found!', 'Trigger Studio Flow no contact address found failure', 400);
+        }
+        const url = `${utils_1.STUDIO_BASE_URL}/v2/Flows/${payload.flowSid}/Executions`;
+        const parametersMap = JSON.stringify({ source: 'studio_segment_destination' });
+        try {
+            await request(url, {
+                method: 'post',
+                body: new URLSearchParams({
+                    From: payload.from,
+                    To: toAddress,
+                    Parameters: parametersMap
+                })
+            });
+        }
+        catch (err) {
+            const error = err;
+            const errData = error.response.data;
+            throw new actions_core_1.IntegrationError(`Unable to trigger Studio Flow. ${errData?.message}`, `Twilio Error Code: ${errData?.code}`, errData?.status);
+        }
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/twilio-studio/triggerStudioFlow/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/twilio-studio/triggerStudioFlow/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,oCAMiB;AAEjB,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,qBAAqB;IAC5B,WAAW,EACT,0HAA0H;IAC5H,MAAM,EAAE;QACN,OAAO,EAAE;YACP,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EACT,0KAA0K;YAC5K,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,iCAAiC;YACxC,WAAW,EACT,gIAAgI;YAClI,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;SACZ;QACD,MAAM,EAAE;YACN,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;QACD,WAAW,EAAE;YACX,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,wBAAwB;YACrC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;SACtC;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,QAAQ;aAClB;SACF;KACF;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE;QAC9D,IAAI,OAAO,CAAC,SAAS,KAAK,UAAU,EAAE;YACpC,MAAM,IAAI,+BAAgB,CACxB,kEAAkE,EAClE,4BAA4B,OAAO,CAAC,SAAS,EAAE,EAC/C,GAAG,CACJ,CAAA;SACF;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YAC3C,MAAM,IAAI,+BAAgB,CACxB,mFAAmF,EACnF,sCAAsC,EACtC,GAAG,CACJ,CAAA;SACF;QACD,IACE,YAAY;YACZ,CAAC,0BAAkB,CACjB,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,WAAW,EAAE,EAC7D,YAAY,EACZ,OAAO,CAAC,gBAAiB,CAC1B,EACD;YACA,MAAM,IAAI,+BAAgB,CACxB,+FACE,OAAO,CAAC,gBAAgB,IAAI,kCAC9B,UAAU,EACV,oBAAoB,EACpB,GAAG,CACJ,CAAA;SACF;QACD,MAAM,SAAS,GAAG,MAAM,yBAAiB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QACrE,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,+BAAgB,CACxB,0DAA0D,EAC1D,sDAAsD,EACtD,GAAG,CACJ,CAAA;SACF;QACD,MAAM,GAAG,GAAG,GAAG,uBAAe,aAAa,OAAO,CAAC,OAAO,aAAa,CAAA;QACvE,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,4BAA4B,EAAE,CAAC,CAAA;QAC9E,IAAI;YACF,MAAM,OAAO,CAAC,GAAG,EAAE;gBACjB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,eAAe,CAAC;oBACxB,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,EAAE,EAAE,SAAS;oBACb,UAAU,EAAE,aAAa;iBAC1B,CAAC;aACH,CAAC,CAAA;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,KAAK,GAAG,GAAkB,CAAA;YAChC,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAA;YACnC,MAAM,IAAI,+BAAgB,CACxB,kCAAkC,OAAO,EAAE,OAAO,EAAE,EACpD,sBAAsB,OAAO,EAAE,IAAI,EAAE,EACrC,OAAO,EAAE,MAAM,CAChB,CAAA;SACF;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/twilio-studio/utils.d.ts

@@ -0,0 +1,29 @@
+import { RequestOptions, HTTPError } from '@segment/actions-core';
+import { StateContext } from '@segment/actions-core/src/destination-kit';
+import type { Settings } from './generated-types';
+import type { Payload } from './triggerStudioFlow/generated-types';
+interface ExternalId {
+    id: string;
+    type: string;
+    source_id: string;
+    collection: string;
+    created_at: string;
+    encoding: string;
+}
+declare type RequestFn = (url: string, options?: RequestOptions) => Promise<Response>;
+export interface TwilioError extends HTTPError {
+    response: Response & {
+        data: {
+            status: number;
+            message: string;
+            code: string;
+        };
+    };
+}
+export declare const STUDIO_BASE_URL = "https://studio.twilio.com";
+export declare const PROFILE_API_BASE_URL = "https://profiles.segment.com";
+export declare const DEFAULT_COOLING_OFF_PERIOD = 60;
+export declare const getToAddressField: (request: RequestFn, settings: Settings, payload: Payload) => Promise<string | false>;
+export declare const fetchProfileExternalIds: (request: RequestFn, settings: Settings, userId: string, anonymousId: string) => Promise<ExternalId[]>;
+export declare const shouldSendToStudio: (cacheKey: string, stateContext: StateContext, coolingOffPeriod: number) => boolean;
+export {};

package/dist/destinations/twilio-studio/utils.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldSendToStudio = exports.fetchProfileExternalIds = exports.getToAddressField = exports.DEFAULT_COOLING_OFF_PERIOD = exports.PROFILE_API_BASE_URL = exports.STUDIO_BASE_URL = void 0;
+const actions_core_1 = require("@segment/actions-core");
+exports.STUDIO_BASE_URL = 'https://studio.twilio.com';
+exports.PROFILE_API_BASE_URL = 'https://profiles.segment.com';
+exports.DEFAULT_COOLING_OFF_PERIOD = 60;
+const getToAddressField = async (request, settings, payload) => {
+    const externalIds = await exports.fetchProfileExternalIds(request, settings, payload.userId, payload.anonymousId);
+    if (externalIds.length <= 0) {
+        return false;
+    }
+    const latestId = externalIds.reduce((acc, current) => {
+        return new Date(acc.created_at) > new Date(current.created_at) ? acc : current;
+    });
+    return latestId?.id;
+};
+exports.getToAddressField = getToAddressField;
+const fetchProfileExternalIds = async (request, settings, userId, anonymousId) => {
+    try {
+        const identifier = userId ? `user_id:${userId}` : `anonymous_id:${anonymousId}`;
+        const response = await request(`${exports.PROFILE_API_BASE_URL}/v1/spaces/${settings.spaceId}/collections/users/profiles/${identifier}/external_ids?include=phone`, {
+            headers: {
+                authorization: `Basic ${Buffer.from(settings.profileApiAccessToken + ':').toString('base64')}`,
+                'content-type': 'application/json'
+            }
+        });
+        const body = await response.json();
+        return body.data;
+    }
+    catch (error) {
+        throw new actions_core_1.IntegrationError('Unable to trigger Studio Flow. Fetching phone external Id failed.', 'Profile fetch API failure', 500);
+    }
+};
+exports.fetchProfileExternalIds = fetchProfileExternalIds;
+const shouldSendToStudio = (cacheKey, stateContext, coolingOffPeriod) => {
+    if (stateContext?.getRequestContext?.(cacheKey))
+        return false;
+    stateContext?.setResponseContext?.(cacheKey, cacheKey, { second: coolingOffPeriod || exports.DEFAULT_COOLING_OFF_PERIOD });
+    return true;
+};
+exports.shouldSendToStudio = shouldSendToStudio;
+//# sourceMappingURL=utils.js.map

package/dist/destinations/twilio-studio/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/destinations/twilio-studio/utils.ts"],"names":[],"mappings":";;;AAAA,wDAAmF;AAwBtE,QAAA,eAAe,GAAG,2BAA2B,CAAA;AAC7C,QAAA,oBAAoB,GAAG,8BAA8B,CAAA;AAGrD,QAAA,0BAA0B,GAAG,EAAE,CAAA;AAGrC,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAAkB,EAAE,QAAkB,EAAE,OAAgB,EAAE,EAAE;IAClG,MAAM,WAAW,GAAG,MAAM,+BAAuB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAO,EAAE,OAAO,CAAC,WAAY,CAAC,CAAA;IAC3G,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE;QAC3B,OAAO,KAAK,CAAA;KACb;IACD,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;QACnD,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAA;IAChF,CAAC,CAAC,CAAA;IACF,OAAO,QAAQ,EAAE,EAAE,CAAA;AACrB,CAAC,CAAA;AATY,QAAA,iBAAiB,qBAS7B;AAGM,MAAM,uBAAuB,GAAG,KAAK,EAC1C,OAAkB,EAClB,QAAkB,EAClB,MAAc,EACd,WAAmB,EACI,EAAE;IACzB,IAAI;QAKF,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC,CAAC,gBAAgB,WAAW,EAAE,CAAA;QAC/E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC5B,GAAG,4BAAoB,cAAc,QAAQ,CAAC,OAAO,+BAA+B,UAAU,6BAA6B,EAC3H;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC9F,cAAc,EAAE,kBAAkB;aACnC;SACF,CACF,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,OAAO,IAAI,CAAC,IAAI,CAAA;KACjB;IAAC,OAAO,KAAc,EAAE;QACvB,MAAM,IAAI,+BAAgB,CACxB,mEAAmE,EACnE,2BAA2B,EAC3B,GAAG,CACJ,CAAA;KACF;AACH,CAAC,CAAA;AA9BY,QAAA,uBAAuB,2BA8BnC;AAGM,MAAM,kBAAkB,GAAG,CAAC,QAAgB,EAAE,YAA0B,EAAE,gBAAwB,EAAW,EAAE;IACpH,IAAI,YAAY,EAAE,iBAAiB,EAAE,CAAC,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAA;IAC7D,YAAY,EAAE,kBAAkB,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,gBAAgB,IAAI,kCAA0B,EAAE,CAAC,CAAA;IAClH,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAJY,QAAA,kBAAkB,sBAI9B"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.131.1-ga4-cloud.12+24db59d0",
+  "version": "3.131.1-stageTesting-tiktok-ga4.49+067a92822",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -39,8 +39,8 @@
   "dependencies": {
     "@amplitude/ua-parser-js": "^0.7.25",
     "@segment/a1-notation": "^2.1.4",
-    "@segment/actions-core": "^3.51.1-ga4-cloud.12+24db59d0",
-    "@segment/actions-shared": "^1.33.1-ga4-cloud.12+24db59d0",
+    "@segment/actions-core": "^3.51.0",
+    "@segment/actions-shared": "^1.33.0",
     "@types/node": "^18.11.15",
     "cheerio": "^1.0.0-rc.10",
     "dayjs": "^1.10.7",
@@ -68,5 +68,5 @@
       "lcov"
     ]
   },
-  "gitHead": "24db59d03642c872e7124e32828dcf450108f5b8"
+  "gitHead": "067a928229a74a124e039a348abc4320baca4112"
 }