@trycourier/courier 3.12.0 → 3.14.1

package/CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [3.14.0]
+
+- adds support for token management
+
+## [3.13.1] - 2022-06-03
+
+- adds provider and channel timeout
+
 ## [3.12.0] - 2022-03-31
 
 - adds support for message trace id (`message.metadata.trace_id`)
@@ -13,11 +21,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - adds support for `audiences`
 
-
 ## [3.10.1] - 2022-03-20
+
 - adds support for messages timeout (`message.timeout`)
 
 ## [3.10.0] - 2020-03-24
+
 - adds support for messages brand_id (`message.brand_id`)
 
 ## [3.9.0] - 2022-03-17

package/README.md

@@ -240,6 +240,70 @@ async function run() {
   });
   console.log(requestId);
 
+  // Example: send message with utm metadata
+  const { requestId } = await courier.send({
+    message: {
+      template: "<TEMPLATE_OR_EVENT_ID>",
+      to: {...},
+      routing: {
+        method: "single",
+        channels: ["email"],
+      },
+      channels: {
+        email: {
+          routing_method: "all",
+          providers: ["sendgrid", "sns"],
+          metadata: {
+            utm: {
+              medium: "f",
+              campaign: "g",
+            },
+          },
+        },
+      },
+      providers: {
+        sns: {
+          metadata: {
+            utm: {
+              medium: "h",
+            },
+          },
+        },
+      }, // optional
+      metadata: {
+        utm: {
+          source: "a",
+          medium: "b",
+          campaign: "c",
+        },
+      },
+      timeout: {
+        message: 300000,
+        channel: {
+          email: 1000 // 1 second
+        }
+      }
+    },
+  });
+
+/**
+ * If the template or content contains any action blocks, the hyperlinks will be augmented with utm compliant query parameters.
+ *
+ * The resulting link of an action block sent through sendgrid would be:
+ * www.example.com?utm_source=a&utm_medium=f&utm_campaign=g
+ *
+ * While the resulting link of an action block sent through sns would be:
+ * www.example.com?utm_source=a&utm_medium=h&utm_campaign=g
+ *
+ * Notice that provider metadata supersedes channel metadata and channel metadata supersedes message metadata
+ *
+ **/
+
+/**
+ * If the message includes a timeout property we will start timing out messages after the first attempt.
+ * We are able to timeout complete channels or specific providers.
+ **/
+
   // Example: get a message status
   const messageStatus = await courier.getMessage(requestId);
   console.log(messageStatus);
@@ -651,9 +715,9 @@ Audiences APIs are used to create, get, update, and delete audiences. A Courier
 const { audienceId } = await courier.audiences.put({
   id: "<AUDIENCE_ID>",
   filter: {
-    "operator": "EQ",
-    "path": "title",
-    "value": "Software Engineer",
+    operator: "EQ",
+    path: "title",
+    value: "Software Engineer",
   },
 });
 

package/lib/audiences/index.js

@@ -104,5 +104,5 @@ exports.audiences = function (options) { return ({
     get: getAudience(options),
     listAudiences: listAudiences(options),
     listMembers: listMembers(options),
-    put: putAudience(options),
+    put: putAudience(options)
 }); };

package/lib/automations/types.d.ts

@@ -1,3 +1,4 @@
+import { Message } from "../send/types";
 export declare type AutomationStepAction = "cancel" | "delay" | "send" | "send-list" | "update-profile";
 export declare type MergeAlgorithm = "replace" | "none" | "overwrite" | "soft-merge";
 export interface IAutomationStep {
@@ -23,6 +24,10 @@ export interface IAutomationSendStep extends IAutomationStep {
     recipient?: string;
     template?: string;
 }
+export interface IAutomationV2SendStep extends IAutomationStep {
+    action: "send";
+    message: Message;
+}
 export interface IAutomationSendListStep extends IAutomationStep {
     action: "send-list";
     brand?: string;
@@ -37,7 +42,7 @@ export interface IAutomationUpdateProfileStep extends IAutomationStep {
     profile: object;
     merge: MergeAlgorithm;
 }
-export declare type AutomationStep = IAutomationCancelStep | IAutomationDelayStep | IAutomationSendStep | IAutomationSendListStep | IAutomationUpdateProfileStep;
+export declare type AutomationStep = IAutomationCancelStep | IAutomationDelayStep | IAutomationSendStep | IAutomationV2SendStep | IAutomationSendListStep | IAutomationUpdateProfileStep;
 export interface IAutomation {
     cancelation_token?: string;
     steps: AutomationStep[];

package/lib/client.js

@@ -46,6 +46,7 @@ var notifications_1 = require("./notifications");
 var preferences_1 = require("./preferences");
 var profile_1 = require("./profile");
 var send_1 = require("./send");
+var token_management_1 = require("./token-management");
 var getMessage = function (options) {
     return function (messageId) { return __awaiter(void 0, void 0, void 0, function () {
         var res;
@@ -99,8 +100,8 @@ var getMessages = function (options) {
                             notification: params === null || params === void 0 ? void 0 : params.notificationId,
                             recipient: params === null || params === void 0 ? void 0 : params.recipientId,
                             status: params === null || params === void 0 ? void 0 : params.status,
-                            tags: params === null || params === void 0 ? void 0 : params.tags,
-                        },
+                            tags: params === null || params === void 0 ? void 0 : params.tags
+                        }
                     })];
                 case 1:
                     res = _a.sent();
@@ -134,5 +135,6 @@ exports.client = function (options) {
         replaceBrand: brands_1.replaceBrand(options),
         replaceProfile: profile_1.replaceProfile(options),
         send: send_1.send(options),
+        tokenManagement: token_management_1.tokenManagement(options)
     };
 };

package/lib/send/types.d.ts

@@ -241,8 +241,12 @@ export interface ElementalContentSugar {
     title?: string;
 }
 export interface Timeout {
-    provider?: number;
-    channel?: number;
+    provider?: {
+        [provider: string]: number;
+    };
+    channel?: {
+        [channel: string]: number;
+    };
     message?: number;
     escalation?: number;
     criteria?: "no-escalation" | "delivered" | "viewed" | "engaged";
@@ -311,6 +315,9 @@ export interface MessageChannels {
             channel?: number;
         };
         override?: MessageChannelEmailOverride | MessageChannelPushOverride;
+        metadata?: {
+            utm?: UTM;
+        };
     };
 }
 export interface Routing {
@@ -329,17 +336,21 @@ export interface RoutingStrategyProvider<T = Record<string, any>> {
     name: string;
     config?: T;
     if?: string;
+    metadata?: {
+        utm?: UTM;
+    };
+}
+export interface UTM {
+    source?: string;
+    medium?: string;
+    campaign?: string;
+    term?: string;
+    content?: string;
 }
 export interface MessageMetadata {
     event?: string;
     tags?: string[];
-    utm?: {
-        source?: string;
-        medium?: string;
-        campaign?: string;
-        term?: string;
-        content?: string;
-    };
+    utm?: UTM;
     trace_id?: string;
 }
 export interface ContentMessage extends BaseMessage {

package/lib/token-management/index.d.ts

@@ -0,0 +1,12 @@
+import { ICourierClientConfiguration } from "../types";
+import { IDeleteUserTokenOpts, IGetUserTokenOpts, IGetUserTokenResponse, IGetUserTokensOpts, IPatchUserTokenOpts, IPutUserTokenOpts, IPutUserTokensOpts } from "./types";
+export declare const tokenManagement: (options: ICourierClientConfiguration) => {
+    deleteUserToken: (opts: IDeleteUserTokenOpts) => Promise<void>;
+    getUserToken: (opts: IGetUserTokenOpts) => Promise<IGetUserTokenResponse>;
+    getUserTokens: (opts: IGetUserTokensOpts) => Promise<{
+        tokens: IGetUserTokenResponse[];
+    }>;
+    patchUserToken: (opts: IPatchUserTokenOpts) => Promise<void>;
+    putUserToken: (opts: IPutUserTokenOpts) => Promise<void>;
+    putUserTokens: (opts: IPutUserTokensOpts) => Promise<void>;
+};

package/lib/token-management/index.js

@@ -0,0 +1,127 @@
+"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.tokenManagement = void 0;
+/** Associate a group of tokens with the supplied :user_id. Will overwrite any existing tokens associated with that user. */
+var putUserTokens = function (options) {
+    return function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + opts.user_id + "/tokens", {
+                        tokens: opts.tokens
+                    })];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+/** Associate a token with the supplied :user_id. If token exists it's value will be replaced with the passed body, otherwise the token will be created. */
+var putUserToken = function (options) {
+    return function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + opts.user_id + "/tokens/" + opts.token.token, opts.token)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var patchUserToken = function (options) {
+    return function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.patch("/users/" + opts.user_id + "/tokens/" + opts.token, { patch: opts.patch })];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var getUserToken = function (options) {
+    return function (opts) { 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.get("/users/" + opts.user_id + "/tokens/" + opts.token)];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var getUserTokens = function (options) {
+    return function (opts) { 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.get("/users/" + opts.user_id + "/tokens")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var deleteUserToken = function (options) {
+    return function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.delete("/users/" + opts.user_id + "/tokens/" + opts.token)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+exports.tokenManagement = function (options) {
+    return {
+        deleteUserToken: deleteUserToken(options),
+        getUserToken: getUserToken(options),
+        getUserTokens: getUserTokens(options),
+        patchUserToken: patchUserToken(options),
+        putUserToken: putUserToken(options),
+        putUserTokens: putUserTokens(options)
+    };
+};

package/lib/token-management/types.d.ts

@@ -0,0 +1,56 @@
+export interface IUserToken {
+    token: string;
+    provider_key: "firebase-fcm" | "apn" | "expo" | "onesignal";
+    /** ISO 8601 Date. Set to false to disable expiration */
+    expiry_date?: string | false;
+    /** Additional properties to be passed to provider or to be generically associated with the token */
+    properties?: {
+        [key: string]: any;
+    };
+    device?: {
+        app_id?: string;
+        ad_id?: string;
+        device_id?: string;
+        platform?: string;
+        manufacturer?: string;
+        model?: string;
+    };
+    tracking?: {
+        os_version?: string;
+        ip?: string;
+        lat?: string;
+        long?: string;
+    };
+}
+export interface IGetUserTokenResponse extends IUserToken {
+    status: "active" | "unknown" | "failed" | "revoked";
+    status_reason?: string;
+}
+export interface IPutUserTokensOpts {
+    user_id: string;
+    tokens: IUserToken[];
+}
+export interface IPutUserTokenOpts {
+    user_id: string;
+    token: IUserToken;
+}
+export interface IPatchUserTokenOpts {
+    user_id: string;
+    token: string;
+    patch: Array<{
+        op: "replace" | "add" | "remove" | "copy" | "move" | "test";
+        path: string;
+        value?: string;
+    }>;
+}
+export interface IGetUserTokenOpts {
+    user_id: string;
+    token: string;
+}
+export interface IGetUserTokensOpts {
+    user_id: string;
+}
+export interface IDeleteUserTokenOpts {
+    user_id: string;
+    token: string;
+}

package/lib/token-management/types.js

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

package/lib/types.d.ts

@@ -6,6 +6,7 @@ import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsRespon
 import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
 import { Message } from "./send/types";
+import { tokenManagement } from "./token-management";
 export declare type HttpMethodClient = <T>(url: string, body?: object, config?: AxiosRequestConfig) => Promise<{
     data: T;
 }>;
@@ -311,5 +312,6 @@ export interface ICourierClient {
     replaceBrand: (params: ICourierBrandPutParameters) => Promise<ICourierBrand>;
     replaceProfile: (params: ICourierProfilePutParameters) => Promise<ICourierProfilePutResponse>;
     send: <T extends ICourierSendParameters | ICourierSendMessageParameters>(params: T, config?: ICourierSendConfig) => Promise<SendResponse<T>>;
+    tokenManagement: ReturnType<typeof tokenManagement>;
 }
 export {};

package/package.json

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