@segment/action-destinations 3.287.0-staging-899be5944 → 3.287.0

package/dist/destinations/{mappings-two-test/index.d.ts → engage/sendgrid/destinationDefinition.d.ts}

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

package/dist/destinations/engage/sendgrid/destinationDefinition.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destinationDefinition = void 0;
+const sendEmail_1 = require("./sendEmail");
+const previewApiLookup_1 = require("./previewApiLookup");
+exports.destinationDefinition = {
+    name: 'Engage Messaging SendGrid',
+    slug: 'actions-personas-messaging-sendgrid',
+    mode: 'cloud',
+    description: 'This is an Engage specific action to send an email',
+    authentication: {
+        scheme: 'custom',
+        fields: {
+            unlayerApiKey: {
+                label: 'Unlayer API Key',
+                type: 'password',
+                description: 'The API key for your Unlayer account'
+            },
+            sendGridApiKey: {
+                label: 'API Key',
+                type: 'password',
+                description: 'The Api Key for your SendGrid account',
+                required: true
+            },
+            profileApiEnvironment: {
+                label: 'Profile API Environment',
+                description: 'Profile API Environment',
+                type: 'string',
+                required: true
+            },
+            profileApiAccessToken: {
+                label: 'Profile API Access Token',
+                description: 'Profile API Access Token',
+                type: 'password',
+                required: true
+            },
+            spaceId: {
+                label: 'Space ID',
+                description: 'Space ID',
+                type: 'string',
+                required: true
+            },
+            sourceId: {
+                label: 'Source ID',
+                description: 'Source ID',
+                type: 'string',
+                required: true
+            },
+            region: {
+                label: 'Region',
+                description: 'The region where the email is originating from',
+                type: 'string',
+                choices: [
+                    { value: 'us-west-2', label: 'US West 2' },
+                    { value: 'eu-west-1', label: 'EU West 1' }
+                ],
+                default: 'us-west-2',
+                required: false
+            }
+        },
+        testAuthentication: (request) => {
+            return request('https://api.sendgrid.com/v3/mail_settings');
+        }
+    },
+    actions: {
+        sendEmail: sendEmail_1.actionDefinition,
+        previewApiLookup: previewApiLookup_1.actionDefinition
+    }
+};
+//# sourceMappingURL=destinationDefinition.js.map

package/dist/destinations/engage/sendgrid/destinationDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destinationDefinition.js","sourceRoot":"","sources":["../../../../src/destinations/engage/sendgrid/destinationDefinition.ts"],"names":[],"mappings":";;;AAEA,2CAA2D;AAC3D,yDAAyE;AAE5D,QAAA,qBAAqB,GAAoC;IACpE,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE,qCAAqC;IAC3C,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,oDAAoD;IACjE,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,aAAa,EAAE;gBACb,KAAK,EAAE,iBAAiB;gBACxB,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,sCAAsC;aACpD;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,uCAAuC;gBACpD,QAAQ,EAAE,IAAI;aACf;YACD,qBAAqB,EAAE;gBACrB,KAAK,EAAE,yBAAyB;gBAChC,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,qBAAqB,EAAE;gBACrB,KAAK,EAAE,0BAA0B;gBACjC,WAAW,EAAE,0BAA0B;gBACvC,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,IAAI;aACf;YACD,OAAO,EAAE;gBACP,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,WAAW;gBAClB,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,QAAQ;gBACf,WAAW,EAAE,gDAAgD;gBAC7D,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE;oBACP,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;oBAC1C,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;iBAC3C;gBACD,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE;YAC9B,OAAO,OAAO,CAAC,2CAA2C,CAAC,CAAA;QAC7D,CAAC;KACF;IACD,OAAO,EAAE;QACP,SAAS,EAAT,4BAAS;QACT,gBAAgB,EAAhB,mCAAgB;KACjB;CACF,CAAA"}

package/dist/destinations/engage/sendgrid/generated-types.d.ts

@@ -0,0 +1 @@
+export * from '../../engage-messaging-sendgrid/generated-types';

package/dist/destinations/engage/sendgrid/generated-types.js

@@ -0,0 +1,14 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../../engage-messaging-sendgrid/generated-types"), exports);
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/engage/sendgrid/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../src/destinations/engage/sendgrid/generated-types.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kFAA+D"}

package/dist/destinations/engage/sendgrid/index.d.ts

@@ -0,0 +1,2 @@
+import { destinationDefinition } from './destinationDefinition';
+export default destinationDefinition;

package/dist/destinations/engage/sendgrid/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const destinationDefinition_1 = require("./destinationDefinition");
+exports.default = destinationDefinition_1.destinationDefinition;
+//# sourceMappingURL=index.js.map

package/dist/destinations/engage/sendgrid/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/engage/sendgrid/index.ts"],"names":[],"mappings":";;AAAA,mEAA+D;AAC/D,kBAAe,6CAAqB,CAAA"}

package/dist/destinations/engage/sendgrid/previewApiLookup/actionDefinition.d.ts

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

package/dist/destinations/engage/sendgrid/previewApiLookup/actionDefinition.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.actionDefinition = void 0;
+const apiLookups_1 = require("../../utils/apiLookups");
+exports.actionDefinition = {
+    title: 'Perform a single API lookup',
+    description: 'Perform a single API lookup and return the response',
+    fields: {
+        ...apiLookups_1.apiLookupActionFields,
+        traits: {
+            label: 'Traits',
+            description: "A user profile's traits",
+            type: 'object',
+            required: false
+        }
+    },
+    perform: async (request, { settings, payload, statsContext, logger }) => {
+        const statsClient = statsContext?.statsClient;
+        const tags = statsContext?.tags ?? [];
+        const { traits = {}, ...apiLookupConfig } = payload;
+        const profile = { traits: traits };
+        const data = await apiLookups_1.performApiLookup(request, apiLookupConfig, profile, statsClient, tags, settings, logger);
+        return {
+            data
+        };
+    }
+};
+//# sourceMappingURL=actionDefinition.js.map

package/dist/destinations/engage/sendgrid/previewApiLookup/actionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionDefinition.js","sourceRoot":"","sources":["../../../../../src/destinations/engage/sendgrid/previewApiLookup/actionDefinition.ts"],"names":[],"mappings":";;;AAGA,uDAAgF;AAGnE,QAAA,gBAAgB,GAAwC;IACnE,KAAK,EAAE,6BAA6B;IACpC,WAAW,EAAE,qDAAqD;IAClE,MAAM,EAAE;QACN,GAAG,kCAAqB;QACxB,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,yBAAyB;YACtC,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;SAChB;KACF;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE;QACtE,MAAM,WAAW,GAAG,YAAY,EAAE,WAAW,CAAA;QAC7C,MAAM,IAAI,GAAG,YAAY,EAAE,IAAI,IAAI,EAAE,CAAA;QACrC,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAA;QACnD,MAAM,OAAO,GAAY,EAAE,MAAM,EAAE,MAAgC,EAAE,CAAA;QACrE,MAAM,IAAI,GAAG,MAAM,6BAAgB,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC3G,OAAO;YACL,IAAI;SACL,CAAA;IACH,CAAC;CACF,CAAA"}

package/dist/destinations/engage/sendgrid/previewApiLookup/generated-types.d.ts

@@ -0,0 +1 @@
+export * from '../../../engage-messaging-sendgrid/previewApiLookup.types';

package/dist/destinations/engage/sendgrid/previewApiLookup/generated-types.js

@@ -0,0 +1,14 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../../../engage-messaging-sendgrid/previewApiLookup.types"), exports);
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/engage/sendgrid/previewApiLookup/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../../src/destinations/engage/sendgrid/previewApiLookup/generated-types.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4FAAyE"}

package/dist/destinations/engage/sendgrid/previewApiLookup/index.d.ts

@@ -0,0 +1 @@
+export * from './actionDefinition';

package/dist/destinations/engage/sendgrid/previewApiLookup/index.js

@@ -0,0 +1,14 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./actionDefinition"), exports);
+//# sourceMappingURL=index.js.map

package/dist/destinations/engage/sendgrid/previewApiLookup/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/destinations/engage/sendgrid/previewApiLookup/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAkC"}

package/dist/destinations/engage/sendgrid/sendEmail/SendEmailPerformer.d.ts

@@ -0,0 +1,44 @@
+import { ExtId, MessageSendPerformer, OperationContext, ResponseError } from '../../utils';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+import { Profile } from '../../utils/Profile';
+import { Liquid as LiquidJs } from 'liquidjs';
+import { ApiLookupConfig, apiLookupLiquidKey } from '../../utils/apiLookups';
+export declare const EXTERNAL_ID_KEY = "email";
+export declare const Liquid: LiquidJs;
+export declare class SendEmailPerformer extends MessageSendPerformer<Settings, Payload> {
+    getIntegrationStatsName(): string;
+    getChannelType(): string;
+    getDefaultSettingsRegion(): string;
+    isSupportedExternalId(externalId: ExtId<Payload>): boolean;
+    isExternalIdSubscribed(extId: ExtId<Payload>): boolean | undefined;
+    getRecepients(): ExtId<Payload>[];
+    parseTemplating(content: string, liquidData: {
+        profile: Profile;
+        [apiLookupLiquidKey]?: Record<string, unknown>;
+    }, contentType: string): Promise<any>;
+    sendToRecepient(emailProfile: ExtId<Payload>): Promise<import("@segment/actions-core").ModifiedResponse<unknown> | undefined>;
+    getBodyTemplateFromS3(bodyUrl: string): Promise<string>;
+    getBodyHtml(profile: Profile, apiLookupData: Record<string, unknown>, emailProfile: {
+        id?: string | undefined;
+        type?: string | undefined;
+        subscriptionStatus?: string | undefined;
+        unsubscribeLink?: string | undefined;
+        preferencesLink?: string | undefined;
+        groups?: {
+            id?: string | undefined;
+            isSubscribed?: boolean | undefined;
+            groupUnsubscribeLink?: string | undefined;
+        }[] | undefined;
+    }): Promise<string>;
+    generateEmailHtml(design: string): Promise<string>;
+    performApiLookups(this: SendEmailPerformer, apiLookups: ApiLookupConfig[] | undefined, profile: Profile): Promise<Record<string, unknown>>;
+    validateLinkAndLog(link: string): void;
+    insertUnsubscribeLinks(html: string, emailProfile: EmailProfile): string;
+    onResponse(args: {
+        response?: Response;
+        error?: ResponseError;
+        operation: OperationContext;
+    }): void;
+}
+export declare type EmailProfile = ExtId<Payload>;