@terreno/comms 57.1.0 → 57.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/README.md +58 -0
  2. package/dist/adapters/expoPush.d.ts +54 -0
  3. package/dist/adapters/expoPush.js +400 -0
  4. package/dist/adapters/sendgrid.d.ts +3 -0
  5. package/dist/adapters/sendgrid.js +7 -1
  6. package/dist/adapters/twilioSms.d.ts +36 -0
  7. package/dist/adapters/twilioSms.js +232 -0
  8. package/dist/adapters/twilioVerify.d.ts +44 -0
  9. package/dist/adapters/twilioVerify.js +212 -0
  10. package/dist/commsApp.d.ts +4 -1
  11. package/dist/commsApp.js +28 -2
  12. package/dist/commsQuery.d.ts +30 -0
  13. package/dist/commsQuery.js +134 -0
  14. package/dist/commsRetry.d.ts +16 -0
  15. package/dist/commsRetry.js +79 -0
  16. package/dist/commsService.d.ts +11 -4
  17. package/dist/commsService.js +217 -47
  18. package/dist/index.d.ts +3 -3
  19. package/dist/index.js +3 -1
  20. package/dist/routes/commsDashboard.d.ts +11 -0
  21. package/dist/routes/commsDashboard.js +414 -0
  22. package/dist/templates.d.ts +9 -0
  23. package/dist/templates.js +34 -1
  24. package/dist/types.d.ts +11 -0
  25. package/dist/webhooks/sendgridWebhooks.d.ts +16 -0
  26. package/dist/webhooks/sendgridWebhooks.js +251 -0
  27. package/dist/webhooks/twilioWebhooks.d.ts +18 -0
  28. package/dist/webhooks/twilioWebhooks.js +175 -0
  29. package/package.json +27 -6
  30. package/src/adapters/expoPush.test.ts +585 -0
  31. package/src/adapters/expoPush.ts +304 -0
  32. package/src/adapters/sendgrid.ts +8 -0
  33. package/src/adapters/twilioSms.test.ts +374 -0
  34. package/src/adapters/twilioSms.ts +237 -0
  35. package/src/adapters/twilioVerify.test.ts +207 -0
  36. package/src/adapters/twilioVerify.ts +227 -0
  37. package/src/commsApp.test.ts +13 -0
  38. package/src/commsApp.ts +38 -3
  39. package/src/commsQuery.test.ts +165 -0
  40. package/src/commsQuery.ts +162 -0
  41. package/src/commsRetry.ts +87 -0
  42. package/src/commsService.test.ts +68 -0
  43. package/src/commsService.ts +177 -20
  44. package/src/index.ts +9 -2
  45. package/src/routes/commsDashboard.test.ts +310 -0
  46. package/src/routes/commsDashboard.ts +327 -0
  47. package/src/templates.test.ts +63 -1
  48. package/src/templates.ts +47 -0
  49. package/src/tests/bunSetup.ts +8 -0
  50. package/src/types.ts +13 -0
  51. package/src/webhooks/sendgridWebhooks.test.ts +520 -0
  52. package/src/webhooks/sendgridWebhooks.ts +166 -0
  53. package/src/webhooks/twilioWebhooks.test.ts +352 -0
  54. package/src/webhooks/twilioWebhooks.ts +154 -0
  55. package/dist/routes/commsExplorer.d.ts +0 -7
  56. package/dist/routes/commsExplorer.js +0 -147
  57. package/src/routes/commsExplorer.ts +0 -114
@@ -0,0 +1,414 @@
1
+ "use strict";
2
+ var __assign = (this && this.__assign) || function () {
3
+ __assign = Object.assign || function(t) {
4
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
5
+ s = arguments[i];
6
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
+ t[p] = s[p];
8
+ }
9
+ return t;
10
+ };
11
+ return __assign.apply(this, arguments);
12
+ };
13
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
+ return new (P || (P = Promise))(function (resolve, reject) {
16
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
20
+ });
21
+ };
22
+ var __generator = (this && this.__generator) || function (thisArg, body) {
23
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
24
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
+ function verb(n) { return function (v) { return step([n, v]); }; }
26
+ function step(op) {
27
+ if (f) throw new TypeError("Generator is already executing.");
28
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
29
+ 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;
30
+ if (y = 0, t) op = [op[0] & 2, t.value];
31
+ switch (op[0]) {
32
+ case 0: case 1: t = op; break;
33
+ case 4: _.label++; return { value: op[1], done: false };
34
+ case 5: _.label++; y = op[1]; op = [0]; continue;
35
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
+ default:
37
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
+ if (t[2]) _.ops.pop();
42
+ _.trys.pop(); continue;
43
+ }
44
+ op = body.call(thisArg, _);
45
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
+ }
48
+ };
49
+ var __read = (this && this.__read) || function (o, n) {
50
+ var m = typeof Symbol === "function" && o[Symbol.iterator];
51
+ if (!m) return o;
52
+ var i = m.call(o), r, ar = [], e;
53
+ try {
54
+ while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
55
+ }
56
+ catch (error) { e = { error: error }; }
57
+ finally {
58
+ try {
59
+ if (r && !r.done && (m = i["return"])) m.call(i);
60
+ }
61
+ finally { if (e) throw e.error; }
62
+ }
63
+ return ar;
64
+ };
65
+ var __values = (this && this.__values) || function(o) {
66
+ var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
67
+ if (m) return m.call(o);
68
+ if (o && typeof o.length === "number") return {
69
+ next: function () {
70
+ if (o && i >= o.length) o = void 0;
71
+ return { value: o && o[i++], done: !o };
72
+ }
73
+ };
74
+ throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
75
+ };
76
+ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
77
+ if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
78
+ if (ar || !(i in from)) {
79
+ if (!ar) ar = Array.prototype.slice.call(from, 0, i);
80
+ ar[i] = from[i];
81
+ }
82
+ }
83
+ return to.concat(ar || Array.prototype.slice.call(from));
84
+ };
85
+ var __importDefault = (this && this.__importDefault) || function (mod) {
86
+ return (mod && mod.__esModule) ? mod : { "default": mod };
87
+ };
88
+ Object.defineProperty(exports, "__esModule", { value: true });
89
+ exports.addCommsExplorerRoute = exports.addCommsDashboardRoutes = void 0;
90
+ var api_1 = require("@terreno/api");
91
+ var mongoose_1 = __importDefault(require("mongoose"));
92
+ var commsQuery_1 = require("../commsQuery");
93
+ var commsRetry_1 = require("../commsRetry");
94
+ var commsMessage_1 = require("../models/commsMessage");
95
+ var requireAdmin = function (req) {
96
+ var _a, _b;
97
+ var user = req.user;
98
+ if (!(user === null || user === void 0 ? void 0 : user.admin)) {
99
+ throw new api_1.APIError({ status: 403, title: "Admin access required" });
100
+ }
101
+ return { id: (_a = user.id) !== null && _a !== void 0 ? _a : (_b = user._id) === null || _b === void 0 ? void 0 : _b.toString() };
102
+ };
103
+ var listQueryParameters = function (builder) {
104
+ return builder
105
+ .withQueryParameter("page", { type: "number" }, { required: false })
106
+ .withQueryParameter("limit", { type: "number" }, { required: false })
107
+ .withQueryParameter("channel", { type: "string" }, { required: false })
108
+ .withQueryParameter("provider", { type: "string" }, { required: false })
109
+ .withQueryParameter("status", { type: "string" }, { required: false })
110
+ .withQueryParameter("errorClass", { type: "string" }, { required: false })
111
+ .withQueryParameter("errorCode", { type: "string" }, { required: false })
112
+ .withQueryParameter("userId", { type: "string" }, { required: false })
113
+ .withQueryParameter("to", { type: "string" }, { required: false })
114
+ .withQueryParameter("templateId", { type: "string" }, { required: false })
115
+ .withQueryParameter("retriedFromId", { type: "string" }, { required: false })
116
+ .withQueryParameter("startDate", { type: "string" }, { required: false })
117
+ .withQueryParameter("endDate", { type: "string" }, { required: false })
118
+ .withQueryParameter("q", { type: "string" }, { required: false });
119
+ };
120
+ var filterBodyFields = {
121
+ channel: { type: "string" },
122
+ endDate: { type: "string" },
123
+ errorClass: { type: "string" },
124
+ errorCode: { type: "string" },
125
+ limit: { type: "number" },
126
+ provider: { type: "string" },
127
+ q: { type: "string" },
128
+ retriedFromId: { type: "string" },
129
+ startDate: { type: "string" },
130
+ status: { type: "string" },
131
+ templateId: { type: "string" },
132
+ to: { type: "string" },
133
+ userId: { type: "string" },
134
+ };
135
+ var pathId = function (value) {
136
+ if (Array.isArray(value)) {
137
+ return value[0];
138
+ }
139
+ return value;
140
+ };
141
+ var failureRate = function (failed, total) {
142
+ if (total === 0) {
143
+ return 0;
144
+ }
145
+ return failed / total;
146
+ };
147
+ var addCommsDashboardRoutes = function (app, options) {
148
+ var _a;
149
+ var basePath = (_a = options.basePath) !== null && _a !== void 0 ? _a : "/comms";
150
+ var routeOpenApi = options.openApi ? { openApi: options.openApi } : {};
151
+ var service = options.service;
152
+ var isConfigured = function (channel) { return service.isChannelConfigured(channel); };
153
+ app.get("".concat(basePath, "/messages"), [
154
+ (0, api_1.authenticateMiddleware)(),
155
+ listQueryParameters((0, api_1.createOpenApiBuilder)(routeOpenApi)
156
+ .withTags(["admin", "comms"])
157
+ .withSummary("List communication delivery attempts"))
158
+ .withResponse(200, {
159
+ data: { items: { type: "object" }, type: "array" },
160
+ limit: { type: "number" },
161
+ more: { type: "boolean" },
162
+ page: { type: "number" },
163
+ total: { type: "number" },
164
+ })
165
+ .build(),
166
+ ], (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
167
+ var filters, _a, limit, page, skip, match, _b, messages, total;
168
+ return __generator(this, function (_c) {
169
+ switch (_c.label) {
170
+ case 0:
171
+ requireAdmin(req);
172
+ filters = (0, commsQuery_1.parseCommsListFilters)(req.query);
173
+ _a = (0, commsQuery_1.parseCommsListPagination)(req.query), limit = _a.limit, page = _a.page, skip = _a.skip;
174
+ match = (0, commsQuery_1.buildCommsMessageMatch)(filters);
175
+ return [4 /*yield*/, Promise.all([
176
+ commsMessage_1.CommsMessage.find(match).sort("-created").skip(skip).limit(limit),
177
+ commsMessage_1.CommsMessage.countDocuments(match),
178
+ ])];
179
+ case 1:
180
+ _b = __read.apply(void 0, [_c.sent(), 2]), messages = _b[0], total = _b[1];
181
+ return [2 /*return*/, res.json({
182
+ data: messages.map(function (message) { return (0, commsRetry_1.serializeCommsMessage)(message, isConfigured); }),
183
+ limit: limit,
184
+ more: skip + limit < total,
185
+ page: page,
186
+ total: total,
187
+ })];
188
+ }
189
+ });
190
+ }); }));
191
+ app.post("".concat(basePath, "/messages/retryMany"), [
192
+ (0, api_1.authenticateMiddleware)(),
193
+ (0, api_1.createOpenApiBuilder)(routeOpenApi)
194
+ .withTags(["admin", "comms"])
195
+ .withSummary("Retry matching failed communication messages")
196
+ .withRequestBody(filterBodyFields)
197
+ .withResponse(200, {
198
+ retried: { items: { type: "object" }, type: "array" },
199
+ skipped: { items: { type: "object" }, type: "array" },
200
+ })
201
+ .build(),
202
+ ], (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
203
+ var admin, body, limit, match, candidates, retried, skipped, candidates_1, candidates_1_1, candidate, created, error_1, title, e_1_1;
204
+ var e_1, _a;
205
+ var _b;
206
+ return __generator(this, function (_c) {
207
+ switch (_c.label) {
208
+ case 0:
209
+ admin = requireAdmin(req);
210
+ body = ((_b = req.body) !== null && _b !== void 0 ? _b : {});
211
+ limit = (0, commsQuery_1.parseRetryManyLimit)(body.limit);
212
+ match = (0, commsQuery_1.buildCommsMessageMatch)((0, commsQuery_1.parseCommsListFilters)(body));
213
+ return [4 /*yield*/, commsMessage_1.CommsMessage.find(match).sort("-created").limit(limit)];
214
+ case 1:
215
+ candidates = _c.sent();
216
+ retried = [];
217
+ skipped = [];
218
+ _c.label = 2;
219
+ case 2:
220
+ _c.trys.push([2, 9, 10, 11]);
221
+ candidates_1 = __values(candidates), candidates_1_1 = candidates_1.next();
222
+ _c.label = 3;
223
+ case 3:
224
+ if (!!candidates_1_1.done) return [3 /*break*/, 8];
225
+ candidate = candidates_1_1.value;
226
+ _c.label = 4;
227
+ case 4:
228
+ _c.trys.push([4, 6, , 7]);
229
+ return [4 /*yield*/, service.retryMessage({
230
+ messageId: String(candidate._id),
231
+ retriedByUserId: admin.id,
232
+ })];
233
+ case 5:
234
+ created = _c.sent();
235
+ retried.push((0, commsRetry_1.serializeCommsMessage)(created, isConfigured));
236
+ return [3 /*break*/, 7];
237
+ case 6:
238
+ error_1 = _c.sent();
239
+ title = (0, api_1.isAPIError)(error_1) ? error_1.title : "Message could not be retried";
240
+ skipped.push({ id: String(candidate._id), reason: title });
241
+ return [3 /*break*/, 7];
242
+ case 7:
243
+ candidates_1_1 = candidates_1.next();
244
+ return [3 /*break*/, 3];
245
+ case 8: return [3 /*break*/, 11];
246
+ case 9:
247
+ e_1_1 = _c.sent();
248
+ e_1 = { error: e_1_1 };
249
+ return [3 /*break*/, 11];
250
+ case 10:
251
+ try {
252
+ if (candidates_1_1 && !candidates_1_1.done && (_a = candidates_1.return)) _a.call(candidates_1);
253
+ }
254
+ finally { if (e_1) throw e_1.error; }
255
+ return [7 /*endfinally*/];
256
+ case 11: return [2 /*return*/, res.json({ retried: retried, skipped: skipped })];
257
+ }
258
+ });
259
+ }); }));
260
+ app.get("".concat(basePath, "/messages/:id"), [
261
+ (0, api_1.authenticateMiddleware)(),
262
+ (0, api_1.createOpenApiBuilder)(routeOpenApi)
263
+ .withTags(["admin", "comms"])
264
+ .withSummary("Read one communication delivery attempt")
265
+ .withPathParameter("id", { type: "string" })
266
+ .withResponse(200, { data: { type: "object" } })
267
+ .build(),
268
+ ], (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
269
+ var id, message, retries;
270
+ return __generator(this, function (_a) {
271
+ switch (_a.label) {
272
+ case 0:
273
+ requireAdmin(req);
274
+ id = pathId(req.params.id);
275
+ if (!id || !mongoose_1.default.isValidObjectId(id)) {
276
+ throw new api_1.APIError({ status: 404, title: "Comms message not found" });
277
+ }
278
+ return [4 /*yield*/, commsMessage_1.CommsMessage.findOneOrNone({ _id: id })];
279
+ case 1:
280
+ message = _a.sent();
281
+ if (!message) {
282
+ throw new api_1.APIError({ status: 404, title: "Comms message not found" });
283
+ }
284
+ return [4 /*yield*/, commsMessage_1.CommsMessage.find({ retriedFromId: message._id }).sort("-created")];
285
+ case 2:
286
+ retries = _a.sent();
287
+ return [2 /*return*/, res.json({
288
+ data: __assign(__assign({}, (0, commsRetry_1.serializeCommsMessage)(message, isConfigured)), { retries: retries.map(function (row) { return (0, commsRetry_1.serializeCommsMessage)(row, isConfigured); }) }),
289
+ })];
290
+ }
291
+ });
292
+ }); }));
293
+ app.post("".concat(basePath, "/messages/:id/retry"), [
294
+ (0, api_1.authenticateMiddleware)(),
295
+ (0, api_1.createOpenApiBuilder)(routeOpenApi)
296
+ .withTags(["admin", "comms"])
297
+ .withSummary("Retry a failed communication message")
298
+ .withPathParameter("id", { type: "string" })
299
+ .withResponse(200, { data: { type: "object" } })
300
+ .build(),
301
+ ], (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
302
+ var admin, id, created;
303
+ return __generator(this, function (_a) {
304
+ switch (_a.label) {
305
+ case 0:
306
+ admin = requireAdmin(req);
307
+ id = pathId(req.params.id);
308
+ if (!id || !mongoose_1.default.isValidObjectId(id)) {
309
+ throw new api_1.APIError({ status: 404, title: "Comms message not found" });
310
+ }
311
+ return [4 /*yield*/, service.retryMessage({
312
+ messageId: id,
313
+ retriedByUserId: admin.id,
314
+ })];
315
+ case 1:
316
+ created = _a.sent();
317
+ return [2 /*return*/, res.json({
318
+ data: (0, commsRetry_1.serializeCommsMessage)(created, isConfigured),
319
+ })];
320
+ }
321
+ });
322
+ }); }));
323
+ app.get("".concat(basePath, "/stats"), [
324
+ (0, api_1.authenticateMiddleware)(),
325
+ listQueryParameters((0, api_1.createOpenApiBuilder)(routeOpenApi)
326
+ .withTags(["admin", "comms"])
327
+ .withSummary("Aggregate communication delivery stats"))
328
+ .withResponse(200, {
329
+ buckets: { items: { type: "object" }, type: "array" },
330
+ byProvider: { items: { type: "object" }, type: "array" },
331
+ totals: { type: "object" },
332
+ })
333
+ .build(),
334
+ ], (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
335
+ var filters, match, grouped, totals, providerTotals, buckets, failedTotal;
336
+ var _a, _b;
337
+ return __generator(this, function (_c) {
338
+ switch (_c.label) {
339
+ case 0:
340
+ requireAdmin(req);
341
+ filters = (0, commsQuery_1.parseCommsListFilters)(req.query);
342
+ match = (0, commsQuery_1.buildCommsMessageMatch)(filters, { applyDefaultStatsRange: true });
343
+ return [4 /*yield*/, commsMessage_1.CommsMessage.aggregate([
344
+ { $match: match },
345
+ {
346
+ $group: {
347
+ _id: {
348
+ channel: "$channel",
349
+ day: { $dateToString: { date: "$created", format: "%Y-%m-%d" } },
350
+ provider: "$provider",
351
+ status: "$status",
352
+ },
353
+ count: { $sum: 1 },
354
+ },
355
+ },
356
+ ])];
357
+ case 1:
358
+ grouped = _c.sent();
359
+ totals = {
360
+ bounced: 0,
361
+ cancelled: 0,
362
+ delivered: 0,
363
+ failed: 0,
364
+ sent: 0,
365
+ total: 0,
366
+ };
367
+ providerTotals = new Map();
368
+ buckets = grouped.map(function (row) {
369
+ var _a, _b;
370
+ var status = row._id.status;
371
+ var provider = row._id.provider;
372
+ totals.total += row.count;
373
+ if (status in totals) {
374
+ totals[status] = ((_a = totals[status]) !== null && _a !== void 0 ? _a : 0) + row.count;
375
+ }
376
+ var existing = (_b = providerTotals.get(provider)) !== null && _b !== void 0 ? _b : {
377
+ bounced: 0,
378
+ delivered: 0,
379
+ failed: 0,
380
+ sent: 0,
381
+ total: 0,
382
+ };
383
+ existing.total += row.count;
384
+ if (status === "bounced" ||
385
+ status === "delivered" ||
386
+ status === "failed" ||
387
+ status === "sent") {
388
+ existing[status] += row.count;
389
+ }
390
+ providerTotals.set(provider, existing);
391
+ return {
392
+ channel: row._id.channel,
393
+ count: row.count,
394
+ day: row._id.day,
395
+ provider: provider,
396
+ status: status,
397
+ };
398
+ });
399
+ failedTotal = ((_a = totals.failed) !== null && _a !== void 0 ? _a : 0) + ((_b = totals.bounced) !== null && _b !== void 0 ? _b : 0);
400
+ return [2 /*return*/, res.json({
401
+ buckets: buckets.sort(function (left, right) { return left.day.localeCompare(right.day); }),
402
+ byProvider: __spreadArray([], __read(providerTotals.entries()), false).map(function (_a) {
403
+ var _b = __read(_a, 2), provider = _b[0], counts = _b[1];
404
+ return (__assign(__assign({}, counts), { failureRate: failureRate(counts.failed + counts.bounced, counts.total), provider: provider }));
405
+ }),
406
+ totals: __assign(__assign({}, totals), { failureRate: failureRate(failedTotal, totals.total) }),
407
+ })];
408
+ }
409
+ });
410
+ }); }));
411
+ };
412
+ exports.addCommsDashboardRoutes = addCommsDashboardRoutes;
413
+ /** @deprecated Use {@link addCommsDashboardRoutes}. */
414
+ exports.addCommsExplorerRoute = exports.addCommsDashboardRoutes;
@@ -7,4 +7,13 @@ export interface RenderTemplateOptions {
7
7
  data: Record<string, unknown>;
8
8
  template: MessageTemplate;
9
9
  }
10
+ export type AuthMailTemplateId = "resetPassword" | "verifyEmail";
11
+ export interface RenderAuthMailOptions {
12
+ publicAppUrl: string;
13
+ templateId: AuthMailTemplateId;
14
+ token: string;
15
+ templates?: Partial<Record<AuthMailTemplateId, MessageTemplate>>;
16
+ }
17
+ export declare const DEFAULT_AUTH_MAIL_TEMPLATES: Record<AuthMailTemplateId, MessageTemplate>;
10
18
  export declare const renderTemplate: ({ data, template }: RenderTemplateOptions) => MessageTemplate;
19
+ export declare const renderAuthMail: ({ publicAppUrl, templateId, token, templates, }: RenderAuthMailOptions) => MessageTemplate;
package/dist/templates.js CHANGED
@@ -11,7 +11,19 @@ var __assign = (this && this.__assign) || function () {
11
11
  return __assign.apply(this, arguments);
12
12
  };
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
- exports.renderTemplate = void 0;
14
+ exports.renderAuthMail = exports.renderTemplate = exports.DEFAULT_AUTH_MAIL_TEMPLATES = void 0;
15
+ exports.DEFAULT_AUTH_MAIL_TEMPLATES = {
16
+ resetPassword: {
17
+ html: '<p><a href="{{resetUrl}}">Reset your password</a></p>',
18
+ subject: "Reset your password",
19
+ text: "Reset your password using this link: {{resetUrl}}",
20
+ },
21
+ verifyEmail: {
22
+ html: '<p><a href="{{verifyUrl}}">Verify your email</a></p>',
23
+ subject: "Verify your email",
24
+ text: "Verify your email using this link: {{verifyUrl}}",
25
+ },
26
+ };
15
27
  var TEMPLATE_VARIABLE_PATTERN = /{{\s*([A-Za-z0-9_]+)\s*}}/g;
16
28
  var interpolate = function (value, data) {
17
29
  return value.replace(TEMPLATE_VARIABLE_PATTERN, function (_match, key) {
@@ -30,3 +42,24 @@ var renderTemplate = function (_a) {
30
42
  return (__assign(__assign(__assign({}, (template.html === undefined ? {} : { html: interpolate(template.html, data) })), { subject: interpolate(template.subject, data) }), (template.text === undefined ? {} : { text: interpolate(template.text, data) })));
31
43
  };
32
44
  exports.renderTemplate = renderTemplate;
45
+ var authMailUrl = function (publicAppUrl, path, token) {
46
+ var base = publicAppUrl.replace(/\/$/, "");
47
+ return "".concat(base).concat(path, "?token=").concat(encodeURIComponent(token));
48
+ };
49
+ var renderAuthMail = function (_a) {
50
+ var _b;
51
+ var publicAppUrl = _a.publicAppUrl, templateId = _a.templateId, token = _a.token, templates = _a.templates;
52
+ var template = (_b = templates === null || templates === void 0 ? void 0 : templates[templateId]) !== null && _b !== void 0 ? _b : exports.DEFAULT_AUTH_MAIL_TEMPLATES[templateId];
53
+ var resetUrl = authMailUrl(publicAppUrl, "/resetPassword", token);
54
+ var verifyUrl = authMailUrl(publicAppUrl, "/verifyEmail", token);
55
+ return (0, exports.renderTemplate)({
56
+ data: {
57
+ publicAppUrl: publicAppUrl.replace(/\/$/, ""),
58
+ resetUrl: resetUrl,
59
+ token: token,
60
+ verifyUrl: verifyUrl,
61
+ },
62
+ template: template,
63
+ });
64
+ };
65
+ exports.renderAuthMail = renderAuthMail;
package/dist/types.d.ts CHANGED
@@ -6,6 +6,8 @@ export interface SendResult {
6
6
  errorClass?: CommsErrorClass;
7
7
  errorCode?: string;
8
8
  isPermanentFailure?: boolean;
9
+ /** Id of the CommsMessage row written for this send, when logging is on. */
10
+ loggedMessageId?: string;
9
11
  metadata?: Record<string, unknown>;
10
12
  providerMessageId?: string;
11
13
  }
@@ -109,6 +111,15 @@ export interface CommsOptions {
109
111
  sms?: SmsProvider;
110
112
  verification?: VerificationProvider;
111
113
  }
114
+ export interface CommsSendOptions {
115
+ extraMetadata?: Record<string, unknown>;
116
+ isRetry?: boolean;
117
+ retriedFromId?: string;
118
+ }
119
+ export interface RetryMessageOptions {
120
+ messageId: string;
121
+ retriedByUserId?: string;
122
+ }
112
123
  export interface SendPushToUserMessage extends Omit<PushMessage, "tokens"> {
113
124
  userId: mongoose.Types.ObjectId | string;
114
125
  }
@@ -0,0 +1,16 @@
1
+ import { type WebhooksApp } from "@terreno/api";
2
+ import type { CommsService } from "../commsService";
3
+ export declare const registerSendGridCommsWebhooks: ({ basePath, publicKey, service, webhooks, }: {
4
+ basePath: string;
5
+ publicKey: string;
6
+ service: CommsService;
7
+ webhooks: WebhooksApp;
8
+ }) => void;
9
+ export declare const maybeRegisterSendGridCommsWebhooks: ({ basePath, mail, service, webhooks, }: {
10
+ basePath: string;
11
+ mail?: {
12
+ id: string;
13
+ };
14
+ service: CommsService;
15
+ webhooks?: WebhooksApp;
16
+ }) => void;