@trycourier/courier 3.3.0 → 3.4.0

package/CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v3.4.0] - 2022-01-25
+
+- adds support for the send message object in the request body of a `/send` call
+
 ## [v3.3.0] - 2022-01-25
 
 - adds support for bulk processing endpoints
@@ -193,7 +197,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## v1.0.1 - 2019-07-12
 
-[unreleased]: https://github.com/trycourier/courier-node/compare/v3.3.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-node/compare/v3.4.0...HEAD
+[v3.4.0]: https://github.com/trycourier/courier-node/compare/v3.3.0...v3.4.0
 [v3.3.0]: https://github.com/trycourier/courier-node/compare/v3.2.1...v3.3.0
 [v3.2.1]: https://github.com/trycourier/courier-node/compare/v3.2.0...v3.2.1
 [v3.2.0]: https://github.com/trycourier/courier-node/compare/v3.1.0...v3.2.0

package/lib/client.js

@@ -44,38 +44,7 @@ var lists_1 = require("./lists");
 var notifications_1 = require("./notifications");
 var preferences_1 = require("./preferences");
 var profile_1 = require("./profile");
-var send = function (options) {
-    return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/send", {
-                            brand: params.brand,
-                            data: params.data,
-                            event: params.eventId,
-                            override: params.override,
-                            preferences: params.preferences,
-                            profile: params.profile,
-                            recipient: params.recipientId
-                        }, axiosConfig)];
-                case 1:
-                    res = _a.sent();
-                    return [2 /*return*/, res.data];
-            }
-        });
-    }); };
-};
+var send_1 = require("./send");
 var getMessage = function (options) {
     return function (messageId) { return __awaiter(void 0, void 0, void 0, function () {
         var res;
@@ -161,6 +130,6 @@ exports.client = function (options) {
         removeRecipientFromAllLists: profile_1.removeRecipientFromAllLists(options),
         replaceBrand: brands_1.replaceBrand(options),
         replaceProfile: profile_1.replaceProfile(options),
-        send: send(options)
+        send: send_1.send(options)
     };
 };

package/lib/send/index.d.ts

@@ -0,0 +1,2 @@
+import { ICourierClientConfiguration, ICourierSendConfig, ICourierSendMessageParameters, ICourierSendParameters, SendResponse } from "../types";
+export declare const send: (options: ICourierClientConfiguration) => <T extends ICourierSendParameters | ICourierSendMessageParameters>(params: T, config?: ICourierSendConfig | undefined) => Promise<SendResponse<T>>;

package/lib/send/index.js

@@ -0,0 +1,100 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.send = void 0;
+var sendCall = function (options, config, params) { return __awaiter(void 0, void 0, void 0, function () {
+    var res;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, options.httpClient.post("/send", {
+                    brand: params.brand,
+                    data: params.data,
+                    event: params.eventId,
+                    override: params.override,
+                    preferences: params.preferences,
+                    profile: params.profile,
+                    recipient: params.recipientId
+                }, config)];
+            case 1:
+                res = _a.sent();
+                return [2 /*return*/, res.data];
+        }
+    });
+}); };
+var sendMessageCall = function (options, config, params) { return __awaiter(void 0, void 0, void 0, function () {
+    var res;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, options.httpClient.post("/send", {
+                    message: params.message
+                }, config)];
+            case 1:
+                res = _a.sent();
+                return [2 /*return*/, res.data];
+        }
+    });
+}); };
+exports.send = function (options) {
+    return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
+        var axiosConfig, v2Response, v1Response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    axiosConfig = {
+                        headers: {}
+                    };
+                    if (config && config.idempotencyKey) {
+                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
+                    }
+                    if (config && config.idempotencyExpiry) {
+                        axiosConfig.headers["x-idempotency-expiration"] =
+                            config.idempotencyExpiry;
+                    }
+                    if (!params.message) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sendMessageCall(options, axiosConfig, params)];
+                case 1:
+                    v2Response = _a.sent();
+                    return [2 /*return*/, v2Response];
+                case 2: return [4 /*yield*/, sendCall(options, axiosConfig, params)];
+                case 3:
+                    v1Response = _a.sent();
+                    return [2 /*return*/, v1Response];
+            }
+        });
+    }); };
+};

package/lib/send/types.d.ts

@@ -0,0 +1,308 @@
+export interface IBrandSnippet {
+    format: "handlebars";
+    name: string;
+    value: string;
+}
+export interface IBrandSnippets {
+    items: IBrandSnippet[];
+}
+export interface IBrandColors {
+    primary?: string;
+    secondary?: string;
+    tertiary?: string;
+}
+interface IBrandTemplate {
+    backgroundColor?: string;
+    blocksBackgroundColor?: string;
+    enabled: boolean;
+    footer?: string;
+    head?: string;
+    header?: string;
+    width?: string;
+}
+export interface IBrandTemplateOverride extends IBrandTemplate {
+    mjml?: IBrandTemplate;
+    footerBackgroundColor?: string;
+    footerFullWidth?: boolean;
+}
+export interface IBrandSettingsSocialPresence {
+    inheritDefault?: boolean;
+    facebook?: {
+        url: string;
+    };
+    instagram?: {
+        url: string;
+    };
+    linkedin?: {
+        url: string;
+    };
+    medium?: {
+        url: string;
+    };
+    twitter?: {
+        url: string;
+    };
+}
+export interface IBrandSettingsEmail {
+    templateOverride?: IBrandTemplateOverride;
+    head?: {
+        inheritDefault: boolean;
+        content?: string;
+    };
+    footer?: {
+        content?: object;
+        inheritDefault?: boolean;
+        markdown?: string;
+        social?: IBrandSettingsSocialPresence;
+    };
+    header?: {
+        inheritDefault?: boolean;
+        barColor?: string;
+        logo?: {
+            href?: string;
+            image?: string;
+        };
+    };
+}
+export interface IBrandSettingsInApp {
+    borderRadius?: string;
+    disableMessageIcon?: boolean;
+    fontFamily?: string;
+    placement?: "top" | "bottom" | "left" | "right";
+    widgetBackground?: {
+        topColor?: string;
+        bottomColor?: string;
+    };
+    colors?: {
+        invertHeader?: boolean;
+        invertButtons?: boolean;
+    };
+    icons?: {
+        bell?: string;
+        message?: string;
+    };
+    preferences?: {
+        templateIds: string[];
+    };
+}
+export declare type IActionButtonStyle = "button" | "link";
+export declare type IAlignment = "center" | "left" | "right" | "full";
+export interface ElementalContent {
+    version: "2022-01-01";
+    brand?: any;
+    elements: ElementalNode[];
+}
+export declare type ElementalNode = ElementalTextNode | ElementalMetaNode | ElementalChannelNode | ElementalImageNode | ElementalActionNode | ElementalDividerNode | ElementalGroupNode | ElementalQuoteNode;
+export interface ElementalTextNode extends ElementalBaseNode {
+    type: "text";
+    content: string;
+    format?: "markdown";
+    locales?: {
+        [locale: string]: {
+            content: string;
+        };
+    };
+}
+export interface ElementalMetaNode extends ElementalBaseNode {
+    type: "meta";
+    title?: string;
+}
+export interface ElementalChannelNode extends ElementalBaseNode {
+    type: "channel";
+    channel: string;
+    elements?: ElementalNode[];
+    raw?: {
+        [templateName: string]: any;
+    };
+}
+export interface ElementalImageNode extends ElementalBaseNode {
+    type: "image";
+    src: string;
+    href?: string;
+    align?: IAlignment;
+    altText?: string;
+    width?: string;
+}
+export interface ElementalActionNode extends ElementalBaseNode {
+    type: "action";
+    content: string;
+    href: string;
+    actionId?: string;
+    style?: IActionButtonStyle;
+    align?: IAlignment;
+    backgroundColor?: string;
+    locales?: {
+        [locale: string]: {
+            content: string;
+        };
+    };
+}
+export interface ElementalDividerNode extends ElementalBaseNode {
+    type: "divider";
+    color?: string;
+}
+export interface ElementalGroupNode extends ElementalBaseNode {
+    type: "group";
+    elements: ElementalNode[];
+}
+export interface ElementalQuoteNode extends ElementalBaseNode {
+    type: "quote";
+    content: string;
+    align?: IAlignment;
+    borderColor?: string;
+    textStyle?: "text" | "h1" | "h2" | "subtext";
+    locales?: {
+        [locale: string]: {
+            content: string;
+        };
+    };
+}
+interface ElementalBaseNode {
+    type: string;
+    channels?: string[];
+    ref?: string;
+    if?: string;
+    loop?: string;
+}
+export interface MessageData extends Record<string, any> {
+}
+interface ListRecipient {
+    list_id: string;
+    pattern?: string;
+}
+export declare type RuleType = "snooze" | "channel_preferences" | "status";
+export interface IRule<T extends RuleType> {
+    type: T;
+}
+export interface ISnoozeRule extends IRule<"snooze"> {
+    start?: string;
+    until: string;
+}
+export declare type Rule = ISnoozeRule;
+export declare type PreferenceStatus = "OPTED_IN" | "OPTED_OUT" | "REQUIRED";
+export declare type ChannelClassification = "direct_message" | "email" | "push";
+export interface IPreference {
+    status: PreferenceStatus;
+    rules?: Rule[];
+    channel_preferences?: Array<{
+        channel: ChannelClassification;
+    }>;
+    source?: "subscription" | "list" | "recipient";
+}
+export interface IPreferences {
+    [id: string]: IPreference;
+}
+export interface IProfilePreferences {
+    categories?: IPreferences;
+    notifications: IPreferences;
+    templateId?: string;
+}
+export interface UserRecipient extends Record<string, any> {
+    data?: MessageData;
+    email?: string;
+    locale?: string;
+    user_id?: string;
+    phone_number?: string;
+    preferences?: IProfilePreferences;
+}
+export declare type MessageRecipient = ListRecipient | UserRecipient;
+export interface ElementalContentSugar {
+    body?: string;
+    title?: string;
+}
+export declare type Content = ElementalContentSugar | ElementalContent;
+export interface BaseMessage {
+    to: MessageRecipient | MessageRecipient[];
+    data?: MessageData;
+    channels?: MessageChannels;
+    providers?: MessageProviders;
+    routing?: Routing;
+}
+interface TrackingOverride {
+    open: boolean;
+}
+export interface MessageProviders {
+    [key: string]: {
+        override?: Record<string, any>;
+        if?: string;
+        timeouts?: number;
+    };
+}
+export interface MessageChannelEmailOverride {
+    attachments?: Record<string, any>[];
+    bcc?: string;
+    brand?: {
+        snippets?: IBrandSnippets;
+        settings?: {
+            colors?: IBrandColors;
+            email?: IBrandSettingsEmail;
+        };
+    };
+    cc?: string;
+    from?: string;
+    html?: string;
+    reply_to?: string;
+    subject?: string;
+    text?: string;
+    tracking?: TrackingOverride;
+}
+export interface MessageChannelPushOverride {
+    body?: string;
+    brand?: {
+        snippets?: IBrandSnippets;
+        settings?: {
+            colors?: IBrandColors;
+            inapp?: IBrandSettingsInApp;
+        };
+    };
+    click_action?: string;
+    data?: Record<string, any>;
+    icon?: string;
+    title?: string;
+}
+export interface MessageChannels {
+    [key: string]: {
+        brand_id?: string;
+        providers?: string[];
+        routing_method?: "all" | "single";
+        if?: string;
+        timeouts?: {
+            provider?: number;
+            channel?: number;
+        };
+        override?: MessageChannelEmailOverride | MessageChannelPushOverride;
+    };
+}
+export interface Routing {
+    method: "all" | "single";
+    channels: RoutingChannel[];
+}
+export declare type RoutingChannel = RoutingStrategyChannel | RoutingStrategyProvider | string;
+export interface RoutingStrategyChannel<T = Record<string, any>> {
+    channel: string;
+    config?: T;
+    method?: "all" | "single";
+    providers?: (RoutingStrategyProvider | string)[];
+    if?: string;
+}
+export interface RoutingStrategyProvider<T = Record<string, any>> {
+    name: string;
+    config?: T;
+    if?: string;
+}
+export interface ContentMessageMetadata {
+    event?: string;
+}
+export interface ContentMessage extends BaseMessage {
+    content: Content;
+    metadata?: ContentMessageMetadata;
+}
+export interface TemplateMessage extends BaseMessage {
+    brand?: string;
+    template: string;
+}
+export declare type Message = ContentMessage | TemplateMessage;
+export interface RequestV2 {
+    message: Message;
+}
+export {};

package/lib/send/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types.d.ts

@@ -4,6 +4,7 @@ import { ICourierClientBulk } from "./bulk/types";
 import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
 import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
+import { Message } from "./send/types";
 export declare type HttpMethodClient = <T>(url: string, body?: object, config?: AxiosRequestConfig) => Promise<{
     data: T;
 }>;
@@ -30,6 +31,9 @@ export interface ICourierSendParameters {
     profile?: object;
     override?: object;
 }
+export interface ICourierSendMessageParameters {
+    message: Message;
+}
 export interface ICourierSendConfig {
     idempotencyKey?: string;
     idempotencyExpiry?: number;
@@ -37,6 +41,9 @@ export interface ICourierSendConfig {
 export interface ICourierSendResponse {
     messageId: string;
 }
+export interface ICourierSendMessageResponse {
+    requestId: string;
+}
 export interface ICourierSendParams {
     event: string;
     data?: object;
@@ -271,6 +278,7 @@ export interface ICourierBrandGetAllResponse {
     paging: ICourierPaging;
     results: ICourierBrand[];
 }
+export declare type SendResponse<T extends ICourierSendParameters | ICourierSendMessageParameters> = T extends ICourierSendParameters ? ICourierSendResponse : ICourierSendMessageResponse;
 export interface ICourierClient {
     addRecipientToLists: (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
     automations: ICourierClientAutomations;
@@ -295,6 +303,6 @@ export interface ICourierClient {
     removeRecipientFromAllLists: (params: ICourierProfileGetParameters) => Promise<ICourierProfilePostResponse>;
     replaceBrand: (params: ICourierBrandPutParameters) => Promise<ICourierBrand>;
     replaceProfile: (params: ICourierProfilePutParameters) => Promise<ICourierProfilePutResponse>;
-    send: (params: ICourierSendParameters, config?: ICourierSendConfig) => Promise<ICourierSendResponse>;
+    send: <T extends ICourierSendParameters | ICourierSendMessageParameters>(params: T, config?: ICourierSendConfig) => Promise<SendResponse<T>>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",