@terreno/comms 57.2.0 → 57.4.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 +31 -0
  13. package/dist/commsQuery.js +135 -0
  14. package/dist/commsRetry.d.ts +12 -0
  15. package/dist/commsRetry.js +78 -0
  16. package/dist/commsService.d.ts +11 -4
  17. package/dist/commsService.js +224 -47
  18. package/dist/index.d.ts +3 -3
  19. package/dist/index.js +3 -1
  20. package/dist/routes/commsDashboard.d.ts +9 -0
  21. package/dist/routes/commsDashboard.js +412 -0
  22. package/dist/templates.d.ts +9 -0
  23. package/dist/templates.js +34 -1
  24. package/dist/types.d.ts +12 -0
  25. package/dist/webhooks/sendgridWebhooks.d.ts +10 -0
  26. package/dist/webhooks/sendgridWebhooks.js +250 -0
  27. package/dist/webhooks/twilioWebhooks.d.ts +11 -0
  28. package/dist/webhooks/twilioWebhooks.js +174 -0
  29. package/package.json +30 -9
  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 +163 -0
  41. package/src/commsRetry.ts +87 -0
  42. package/src/commsService.test.ts +128 -0
  43. package/src/commsService.ts +184 -20
  44. package/src/index.ts +9 -2
  45. package/src/routes/commsDashboard.test.ts +310 -0
  46. package/src/routes/commsDashboard.ts +324 -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 +14 -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
@@ -71,11 +71,16 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
71
71
  }
72
72
  return to.concat(ar || Array.prototype.slice.call(from));
73
73
  };
74
+ var __importDefault = (this && this.__importDefault) || function (mod) {
75
+ return (mod && mod.__esModule) ? mod : { "default": mod };
76
+ };
74
77
  Object.defineProperty(exports, "__esModule", { value: true });
75
78
  exports.CommsService = void 0;
76
79
  var api_1 = require("@terreno/api");
77
80
  var luxon_1 = require("luxon");
81
+ var mongoose_1 = __importDefault(require("mongoose"));
78
82
  var console_1 = require("./adapters/console");
83
+ var commsRetry_1 = require("./commsRetry");
79
84
  var commsMessage_1 = require("./models/commsMessage");
80
85
  var pushToken_1 = require("./models/pushToken");
81
86
  var CHANNEL_NOT_CONFIGURED_TITLE = "Comms channel not configured";
@@ -147,7 +152,7 @@ var CommsService = /** @class */ (function () {
147
152
  case 5:
148
153
  error_1 = _a.sent();
149
154
  api_1.logger.warn("[comms] Failed to apply delivery event: ".concat(String(error_1)));
150
- return [3 /*break*/, 6];
155
+ throw error_1;
151
156
  case 6: return [2 /*return*/];
152
157
  }
153
158
  });
@@ -168,6 +173,33 @@ var CommsService = /** @class */ (function () {
168
173
  });
169
174
  });
170
175
  };
176
+ CommsService.prototype.deactivatePushToken = function (token) {
177
+ return __awaiter(this, void 0, void 0, function () {
178
+ var tokenDoc, error_2;
179
+ return __generator(this, function (_a) {
180
+ switch (_a.label) {
181
+ case 0:
182
+ _a.trys.push([0, 3, , 4]);
183
+ return [4 /*yield*/, pushToken_1.PushToken.findOneOrNone({ token: token })];
184
+ case 1:
185
+ tokenDoc = _a.sent();
186
+ if (!tokenDoc || tokenDoc.active === false) {
187
+ return [2 /*return*/];
188
+ }
189
+ tokenDoc.active = false;
190
+ return [4 /*yield*/, tokenDoc.save()];
191
+ case 2:
192
+ _a.sent();
193
+ return [3 /*break*/, 4];
194
+ case 3:
195
+ error_2 = _a.sent();
196
+ api_1.logger.warn("[comms] Failed to deactivate push token: ".concat(String(error_2)));
197
+ return [3 /*break*/, 4];
198
+ case 4: return [2 /*return*/];
199
+ }
200
+ });
201
+ });
202
+ };
171
203
  CommsService.prototype.clearExpiredPayloads = function () {
172
204
  return __awaiter(this, void 0, void 0, function () {
173
205
  return __generator(this, function (_a) {
@@ -187,7 +219,7 @@ var CommsService = /** @class */ (function () {
187
219
  };
188
220
  CommsService.prototype.invokeHook = function (hook, label) {
189
221
  return __awaiter(this, void 0, void 0, function () {
190
- var error_2, message;
222
+ var error_3, message;
191
223
  return __generator(this, function (_a) {
192
224
  switch (_a.label) {
193
225
  case 0:
@@ -202,8 +234,8 @@ var CommsService = /** @class */ (function () {
202
234
  _a.sent();
203
235
  return [2 /*return*/, undefined];
204
236
  case 3:
205
- error_2 = _a.sent();
206
- message = "[comms] ".concat(label, " hook failed: ").concat(String(error_2));
237
+ error_3 = _a.sent();
238
+ message = "[comms] ".concat(label, " hook failed: ").concat(String(error_3));
207
239
  api_1.logger.error(message);
208
240
  return [2 /*return*/, HOOK_THREW];
209
241
  case 4: return [2 /*return*/];
@@ -222,7 +254,7 @@ var CommsService = /** @class */ (function () {
222
254
  };
223
255
  CommsService.prototype.applyBeforeSend = function (context, hookErrors) {
224
256
  return __awaiter(this, void 0, void 0, function () {
225
- var beforeSend, result, error_3;
257
+ var beforeSend, result, error_4;
226
258
  var _a;
227
259
  return __generator(this, function (_b) {
228
260
  switch (_b.label) {
@@ -245,9 +277,9 @@ var CommsService = /** @class */ (function () {
245
277
  message: (_a = result.message) !== null && _a !== void 0 ? _a : context.message,
246
278
  }];
247
279
  case 3:
248
- error_3 = _b.sent();
280
+ error_4 = _b.sent();
249
281
  this.appendHookError(hookErrors, "beforeSend", HOOK_THREW);
250
- api_1.logger.error("[comms] beforeSend hook failed: ".concat(String(error_3)));
282
+ api_1.logger.error("[comms] beforeSend hook failed: ".concat(String(error_4)));
251
283
  return [2 /*return*/, { cancel: false, message: context.message }];
252
284
  case 4: return [2 /*return*/];
253
285
  }
@@ -339,7 +371,7 @@ var CommsService = /** @class */ (function () {
339
371
  CommsService.prototype.logResult = function (_a) {
340
372
  return __awaiter(this, arguments, void 0, function (_b) {
341
373
  var payload, lastAttempt, mergedMetadata, logged;
342
- var attempts = _b.attempts, channel = _b.channel, context = _b.context, hookErrors = _b.hookErrors, metadata = _b.metadata, omitPayload = _b.omitPayload, provider = _b.provider, result = _b.result, status = _b.status, subject = _b.subject, templateId = _b.templateId, to = _b.to, userId = _b.userId;
374
+ var attempts = _b.attempts, channel = _b.channel, context = _b.context, hookErrors = _b.hookErrors, metadata = _b.metadata, omitPayload = _b.omitPayload, provider = _b.provider, result = _b.result, retriedFromId = _b.retriedFromId, status = _b.status, subject = _b.subject, templateId = _b.templateId, to = _b.to, userId = _b.userId;
343
375
  return __generator(this, function (_c) {
344
376
  switch (_c.label) {
345
377
  case 0:
@@ -362,6 +394,7 @@ var CommsService = /** @class */ (function () {
362
394
  payloadExpiresAt: payload === undefined ? undefined : this.payloadExpiresAt(),
363
395
  provider: provider,
364
396
  providerMessageId: result.providerMessageId,
397
+ retriedFromId: retriedFromId,
365
398
  status: status,
366
399
  subject: subject,
367
400
  templateId: templateId,
@@ -490,6 +523,7 @@ var CommsService = /** @class */ (function () {
490
523
  metadata: logFields.metadata,
491
524
  provider: provider,
492
525
  result: first,
526
+ retriedFromId: logFields.retriedFromId,
493
527
  status: first.accepted ? "sent" : "failed",
494
528
  subject: logFields.subject,
495
529
  templateId: logFields.templateId,
@@ -514,11 +548,23 @@ var CommsService = /** @class */ (function () {
514
548
  return [4 /*yield*/, this.patchHookErrors(finalLogged, hookErrors)];
515
549
  case 6:
516
550
  _d.sent();
517
- return [2 /*return*/, retried.result];
551
+ return [2 /*return*/, this.withLoggedId(retried.result, finalLogged)];
518
552
  }
519
553
  });
520
554
  });
521
555
  };
556
+ CommsService.prototype.withLoggedId = function (result, logged) {
557
+ if (!logged) {
558
+ return result;
559
+ }
560
+ return __assign(__assign({}, result), { loggedMessageId: String(logged._id) });
561
+ };
562
+ CommsService.prototype.loggedIdFromSend = function (result) {
563
+ if (Array.isArray(result)) {
564
+ return result.map(function (row) { return row.loggedMessageId; }).find(function (id) { return Boolean(id); });
565
+ }
566
+ return result.loggedMessageId;
567
+ };
522
568
  CommsService.prototype.cancelledResult = function () {
523
569
  return {
524
570
  accepted: false,
@@ -529,7 +575,7 @@ var CommsService = /** @class */ (function () {
529
575
  };
530
576
  CommsService.prototype.sendMailOnce = function (provider, message) {
531
577
  return __awaiter(this, void 0, void 0, function () {
532
- var error_4;
578
+ var error_5;
533
579
  return __generator(this, function (_a) {
534
580
  switch (_a.label) {
535
581
  case 0:
@@ -537,8 +583,8 @@ var CommsService = /** @class */ (function () {
537
583
  return [4 /*yield*/, provider.sendMail(message)];
538
584
  case 1: return [2 /*return*/, _a.sent()];
539
585
  case 2:
540
- error_4 = _a.sent();
541
- return [2 /*return*/, providerThrowResult(error_4)];
586
+ error_5 = _a.sent();
587
+ return [2 /*return*/, providerThrowResult(error_5)];
542
588
  case 3: return [2 /*return*/];
543
589
  }
544
590
  });
@@ -546,7 +592,7 @@ var CommsService = /** @class */ (function () {
546
592
  };
547
593
  CommsService.prototype.sendSmsOnce = function (provider, message) {
548
594
  return __awaiter(this, void 0, void 0, function () {
549
- var error_5;
595
+ var error_6;
550
596
  return __generator(this, function (_a) {
551
597
  switch (_a.label) {
552
598
  case 0:
@@ -554,8 +600,8 @@ var CommsService = /** @class */ (function () {
554
600
  return [4 /*yield*/, provider.sendSms(message)];
555
601
  case 1: return [2 /*return*/, _a.sent()];
556
602
  case 2:
557
- error_5 = _a.sent();
558
- return [2 /*return*/, providerThrowResult(error_5)];
603
+ error_6 = _a.sent();
604
+ return [2 /*return*/, providerThrowResult(error_6)];
559
605
  case 3: return [2 /*return*/];
560
606
  }
561
607
  });
@@ -563,7 +609,7 @@ var CommsService = /** @class */ (function () {
563
609
  };
564
610
  CommsService.prototype.sendPushOnce = function (provider, message) {
565
611
  return __awaiter(this, void 0, void 0, function () {
566
- var error_6;
612
+ var error_7;
567
613
  return __generator(this, function (_a) {
568
614
  switch (_a.label) {
569
615
  case 0:
@@ -571,8 +617,8 @@ var CommsService = /** @class */ (function () {
571
617
  return [4 /*yield*/, provider.sendPush(message)];
572
618
  case 1: return [2 /*return*/, _a.sent()];
573
619
  case 2:
574
- error_6 = _a.sent();
575
- return [2 /*return*/, message.tokens.map(function () { return providerThrowResult(error_6); })];
620
+ error_7 = _a.sent();
621
+ return [2 /*return*/, message.tokens.map(function () { return providerThrowResult(error_7); })];
576
622
  case 3: return [2 /*return*/];
577
623
  }
578
624
  });
@@ -580,7 +626,7 @@ var CommsService = /** @class */ (function () {
580
626
  };
581
627
  CommsService.prototype.startVerificationOnce = function (provider, options) {
582
628
  return __awaiter(this, void 0, void 0, function () {
583
- var error_7;
629
+ var error_8;
584
630
  return __generator(this, function (_a) {
585
631
  switch (_a.label) {
586
632
  case 0:
@@ -588,13 +634,20 @@ var CommsService = /** @class */ (function () {
588
634
  return [4 /*yield*/, provider.startVerification(options)];
589
635
  case 1: return [2 /*return*/, _a.sent()];
590
636
  case 2:
591
- error_7 = _a.sent();
592
- return [2 /*return*/, providerThrowResult(error_7)];
637
+ error_8 = _a.sent();
638
+ return [2 /*return*/, providerThrowResult(error_8)];
593
639
  case 3: return [2 /*return*/];
594
640
  }
595
641
  });
596
642
  });
597
643
  };
644
+ CommsService.prototype.mergeSendMetadata = function (result, sendOptions) {
645
+ var extra = sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata;
646
+ if (!result.metadata && !extra) {
647
+ return result.metadata;
648
+ }
649
+ return __assign(__assign({}, result.metadata), extra);
650
+ };
598
651
  CommsService.prototype.mailProvider = function () {
599
652
  if (this.options.mail) {
600
653
  return this.options.mail;
@@ -639,9 +692,21 @@ var CommsService = /** @class */ (function () {
639
692
  var _a;
640
693
  return __assign(__assign({}, message), { from: (_a = message.from) !== null && _a !== void 0 ? _a : this.options.defaultFrom });
641
694
  };
642
- CommsService.prototype.sendMail = function (message) {
695
+ CommsService.prototype.isChannelConfigured = function (channel) {
696
+ if (channel === "mail") {
697
+ return Boolean(this.options.mail) || !isProduction();
698
+ }
699
+ if (channel === "sms") {
700
+ return Boolean(this.options.sms) || !isProduction();
701
+ }
702
+ if (channel === "push") {
703
+ return Boolean(this.options.push) || !isProduction();
704
+ }
705
+ return Boolean(this.options.verification) || !isProduction();
706
+ };
707
+ CommsService.prototype.sendMail = function (message, sendOptions) {
643
708
  return __awaiter(this, void 0, void 0, function () {
644
- var provider, hookErrors, context, before, activeMessage, result, first;
709
+ var provider, hookErrors, context, before, activeMessage, result, logged, first;
645
710
  var _this = this;
646
711
  return __generator(this, function (_a) {
647
712
  switch (_a.label) {
@@ -651,9 +716,10 @@ var CommsService = /** @class */ (function () {
651
716
  context = {
652
717
  attempt: 1,
653
718
  channel: "mail",
654
- isRetry: false,
719
+ isRetry: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.isRetry) === true,
655
720
  message: this.applyMailDefaults(message),
656
721
  provider: provider.id,
722
+ userId: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.userId) ? String(sendOptions.userId) : undefined,
657
723
  };
658
724
  return [4 /*yield*/, this.applyBeforeSend(context, hookErrors)];
659
725
  case 1:
@@ -667,16 +733,19 @@ var CommsService = /** @class */ (function () {
667
733
  channel: "mail",
668
734
  context: context,
669
735
  hookErrors: hookErrors,
736
+ metadata: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata,
670
737
  provider: provider.id,
671
738
  result: result,
739
+ retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
672
740
  status: "cancelled",
673
741
  subject: activeMessage.subject,
674
742
  templateId: activeMessage.templateId,
675
743
  to: activeMessage.to,
744
+ userId: context.userId,
676
745
  })];
677
746
  case 2:
678
- _a.sent();
679
- return [2 /*return*/, result];
747
+ logged = _a.sent();
748
+ return [2 /*return*/, this.withLoggedId(result, logged)];
680
749
  case 3: return [4 /*yield*/, this.sendMailOnce(provider, activeMessage)];
681
750
  case 4:
682
751
  first = _a.sent();
@@ -686,10 +755,12 @@ var CommsService = /** @class */ (function () {
686
755
  hookErrors: hookErrors,
687
756
  logFields: {
688
757
  channel: "mail",
689
- metadata: first.metadata,
758
+ metadata: this.mergeSendMetadata(first, sendOptions),
759
+ retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
690
760
  subject: activeMessage.subject,
691
761
  templateId: activeMessage.templateId,
692
762
  to: activeMessage.to,
763
+ userId: context.userId,
693
764
  },
694
765
  provider: provider.id,
695
766
  retry: function () { return _this.sendMailOnce(provider, activeMessage); },
@@ -698,9 +769,9 @@ var CommsService = /** @class */ (function () {
698
769
  });
699
770
  });
700
771
  };
701
- CommsService.prototype.sendSms = function (message) {
772
+ CommsService.prototype.sendSms = function (message, sendOptions) {
702
773
  return __awaiter(this, void 0, void 0, function () {
703
- var provider, hookErrors, context, before, activeMessage, result, first;
774
+ var provider, hookErrors, context, before, activeMessage, result, logged, first;
704
775
  var _this = this;
705
776
  return __generator(this, function (_a) {
706
777
  switch (_a.label) {
@@ -710,9 +781,10 @@ var CommsService = /** @class */ (function () {
710
781
  context = {
711
782
  attempt: 1,
712
783
  channel: "sms",
713
- isRetry: false,
784
+ isRetry: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.isRetry) === true,
714
785
  message: message,
715
786
  provider: provider.id,
787
+ userId: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.userId) ? String(sendOptions.userId) : undefined,
716
788
  };
717
789
  return [4 /*yield*/, this.applyBeforeSend(context, hookErrors)];
718
790
  case 1:
@@ -726,14 +798,17 @@ var CommsService = /** @class */ (function () {
726
798
  channel: "sms",
727
799
  context: context,
728
800
  hookErrors: hookErrors,
801
+ metadata: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata,
729
802
  provider: provider.id,
730
803
  result: result,
804
+ retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
731
805
  status: "cancelled",
732
806
  to: activeMessage.to,
807
+ userId: context.userId,
733
808
  })];
734
809
  case 2:
735
- _a.sent();
736
- return [2 /*return*/, result];
810
+ logged = _a.sent();
811
+ return [2 /*return*/, this.withLoggedId(result, logged)];
737
812
  case 3: return [4 /*yield*/, this.sendSmsOnce(provider, activeMessage)];
738
813
  case 4:
739
814
  first = _a.sent();
@@ -743,7 +818,10 @@ var CommsService = /** @class */ (function () {
743
818
  hookErrors: hookErrors,
744
819
  logFields: {
745
820
  channel: "sms",
821
+ metadata: this.mergeSendMetadata(first, sendOptions),
822
+ retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
746
823
  to: activeMessage.to,
824
+ userId: context.userId,
747
825
  },
748
826
  provider: provider.id,
749
827
  retry: function () { return _this.sendSmsOnce(provider, activeMessage); },
@@ -752,9 +830,9 @@ var CommsService = /** @class */ (function () {
752
830
  });
753
831
  });
754
832
  };
755
- CommsService.prototype.sendPushToUser = function (message) {
833
+ CommsService.prototype.sendPushToUser = function (message, sendOptions) {
756
834
  return __awaiter(this, void 0, void 0, function () {
757
- var provider, hookErrors, tokens, tokenDocs, providerMessage, context, before, activeMessage, result_1, sendTokens, firstByToken, _a, _b, loggedByToken, retryTokens, retryTokenSet, beforeRetryHookErrors, finalByToken, retryContext, onRetry_1, firstTransient_1, _c, _d, retryByToken_1, _e, _f;
835
+ var provider, hookErrors, tokens, providerMessage, context, before, activeMessage, result_1, loggedRows_1, sendTokens, firstByToken, _a, _b, loggedByToken, retryTokens, retryTokenSet, beforeRetryHookErrors, finalByToken, retryContext, onRetry_1, firstTransient_1, _c, _d, retryByToken_1, _e, _f;
758
836
  var _this = this;
759
837
  return __generator(this, function (_g) {
760
838
  switch (_g.label) {
@@ -767,7 +845,6 @@ var CommsService = /** @class */ (function () {
767
845
  if (tokens.length === 0) {
768
846
  return [2 /*return*/, []];
769
847
  }
770
- tokenDocs = new Map(tokens.map(function (token) { return [token.token, token]; }));
771
848
  providerMessage = {
772
849
  badge: message.badge,
773
850
  body: message.body,
@@ -779,7 +856,7 @@ var CommsService = /** @class */ (function () {
779
856
  context = {
780
857
  attempt: 1,
781
858
  channel: "push",
782
- isRetry: false,
859
+ isRetry: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.isRetry) === true,
783
860
  message: providerMessage,
784
861
  provider: provider.id,
785
862
  userId: String(message.userId),
@@ -797,16 +874,18 @@ var CommsService = /** @class */ (function () {
797
874
  channel: "push",
798
875
  context: _this.cloneContext(context),
799
876
  hookErrors: hookErrors,
877
+ metadata: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata,
800
878
  provider: provider.id,
801
879
  result: result_1,
880
+ retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
802
881
  status: "cancelled",
803
882
  to: token.token,
804
883
  userId: String(message.userId),
805
884
  });
806
885
  }))];
807
886
  case 3:
808
- _g.sent();
809
- return [2 /*return*/, tokens.map(function () { return result_1; })];
887
+ loggedRows_1 = _g.sent();
888
+ return [2 /*return*/, tokens.map(function (_, index) { var _a; return _this.withLoggedId(result_1, (_a = loggedRows_1[index]) !== null && _a !== void 0 ? _a : null); })];
810
889
  case 4:
811
890
  sendTokens = activeMessage.tokens;
812
891
  if (sendTokens.length === 0) {
@@ -830,8 +909,10 @@ var CommsService = /** @class */ (function () {
830
909
  channel: "push",
831
910
  context: tokenContext,
832
911
  hookErrors: hookErrors,
912
+ metadata: this.mergeSendMetadata(result, sendOptions),
833
913
  provider: provider.id,
834
914
  result: result,
915
+ retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
835
916
  status: result.accepted ? "sent" : "failed",
836
917
  to: tokenValue,
837
918
  userId: String(message.userId),
@@ -895,7 +976,7 @@ var CommsService = /** @class */ (function () {
895
976
  _g.sent();
896
977
  _g.label = 10;
897
978
  case 10: return [4 /*yield*/, Promise.all(sendTokens.map(function (tokenValue) { return __awaiter(_this, void 0, void 0, function () {
898
- var result, tokenHookErrors, logged, didRetry, tokenDoc;
979
+ var result, tokenHookErrors, logged, didRetry;
899
980
  var _a;
900
981
  return __generator(this, function (_b) {
901
982
  switch (_b.label) {
@@ -917,10 +998,8 @@ var CommsService = /** @class */ (function () {
917
998
  return [4 /*yield*/, this.patchHookErrors(logged, tokenHookErrors)];
918
999
  case 2:
919
1000
  _b.sent();
920
- tokenDoc = tokenDocs.get(tokenValue);
921
- if (!(tokenDoc && !result.accepted && isPermanentPushFailure(result))) return [3 /*break*/, 4];
922
- tokenDoc.active = false;
923
- return [4 /*yield*/, tokenDoc.save()];
1001
+ if (!(!result.accepted && isPermanentPushFailure(result))) return [3 /*break*/, 4];
1002
+ return [4 /*yield*/, this.deactivatePushToken(tokenValue)];
924
1003
  case 3:
925
1004
  _b.sent();
926
1005
  _b.label = 4;
@@ -930,7 +1009,10 @@ var CommsService = /** @class */ (function () {
930
1009
  }); }))];
931
1010
  case 11:
932
1011
  _g.sent();
933
- return [2 /*return*/, sendTokens.map(function (tokenValue) { return finalByToken.get(tokenValue); })];
1012
+ return [2 /*return*/, sendTokens.map(function (tokenValue) {
1013
+ var _a;
1014
+ return _this.withLoggedId(finalByToken.get(tokenValue), (_a = loggedByToken.get(tokenValue)) !== null && _a !== void 0 ? _a : null);
1015
+ })];
934
1016
  }
935
1017
  });
936
1018
  });
@@ -993,7 +1075,7 @@ var CommsService = /** @class */ (function () {
993
1075
  };
994
1076
  CommsService.prototype.checkVerification = function (options) {
995
1077
  return __awaiter(this, void 0, void 0, function () {
996
- var provider, hookErrors, context, result, loggedResult, logged, error_8, loggedResult, logged;
1078
+ var provider, hookErrors, context, result, loggedResult, logged, error_9, loggedResult, logged;
997
1079
  var _a;
998
1080
  return __generator(this, function (_b) {
999
1081
  switch (_b.label) {
@@ -1035,8 +1117,8 @@ var CommsService = /** @class */ (function () {
1035
1117
  _b.sent();
1036
1118
  return [2 /*return*/, result];
1037
1119
  case 6:
1038
- error_8 = _b.sent();
1039
- loggedResult = providerThrowResult(error_8);
1120
+ error_9 = _b.sent();
1121
+ loggedResult = providerThrowResult(error_9);
1040
1122
  return [4 /*yield*/, this.logResult({
1041
1123
  attempts: [this.attemptFromResult(provider.id, loggedResult)],
1042
1124
  channel: "verification",
@@ -1062,6 +1144,101 @@ var CommsService = /** @class */ (function () {
1062
1144
  });
1063
1145
  });
1064
1146
  };
1147
+ CommsService.prototype.retryMessage = function (options) {
1148
+ return __awaiter(this, void 0, void 0, function () {
1149
+ var original, block, sendOptions, payload, sendResult, loggedId, retried;
1150
+ var _this = this;
1151
+ var _a, _b, _c, _d, _e, _f, _g, _h;
1152
+ return __generator(this, function (_j) {
1153
+ switch (_j.label) {
1154
+ case 0:
1155
+ if (!mongoose_1.default.isValidObjectId(options.messageId)) {
1156
+ throw new api_1.APIError({ status: 404, title: "Comms message not found" });
1157
+ }
1158
+ return [4 /*yield*/, commsMessage_1.CommsMessage.findOneOrNone({ _id: options.messageId })];
1159
+ case 1:
1160
+ original = _j.sent();
1161
+ if (!original) {
1162
+ throw new api_1.APIError({ status: 404, title: "Comms message not found" });
1163
+ }
1164
+ block = (0, commsRetry_1.evaluateRetryBlock)({
1165
+ isChannelConfigured: function (channel) { return _this.isChannelConfigured(channel); },
1166
+ message: original,
1167
+ });
1168
+ if (block) {
1169
+ (0, commsRetry_1.throwRetryBlock)(block);
1170
+ }
1171
+ sendOptions = {
1172
+ extraMetadata: options.retriedByUserId
1173
+ ? { retriedByUserId: options.retriedByUserId }
1174
+ : undefined,
1175
+ isRetry: true,
1176
+ retriedFromId: String(original._id),
1177
+ userId: original.userId,
1178
+ };
1179
+ payload = original.payload;
1180
+ if (!(original.channel === "mail")) return [3 /*break*/, 3];
1181
+ return [4 /*yield*/, this.sendMail({
1182
+ dynamicTemplateData: payload.dynamicTemplateData,
1183
+ from: payload.from,
1184
+ html: payload.html,
1185
+ replyTo: payload.replyTo,
1186
+ subject: String((_b = (_a = payload.subject) !== null && _a !== void 0 ? _a : original.subject) !== null && _b !== void 0 ? _b : ""),
1187
+ templateId: (_c = payload.templateId) !== null && _c !== void 0 ? _c : original.templateId,
1188
+ text: payload.text,
1189
+ to: (_d = payload.to) !== null && _d !== void 0 ? _d : original.to,
1190
+ }, sendOptions)];
1191
+ case 2:
1192
+ sendResult = _j.sent();
1193
+ return [3 /*break*/, 8];
1194
+ case 3:
1195
+ if (!(original.channel === "sms")) return [3 /*break*/, 5];
1196
+ return [4 /*yield*/, this.sendSms({
1197
+ body: String((_e = payload.body) !== null && _e !== void 0 ? _e : ""),
1198
+ to: String((_f = payload.to) !== null && _f !== void 0 ? _f : original.to),
1199
+ }, sendOptions)];
1200
+ case 4:
1201
+ sendResult = _j.sent();
1202
+ return [3 /*break*/, 8];
1203
+ case 5:
1204
+ if (!original.userId) return [3 /*break*/, 7];
1205
+ return [4 /*yield*/, this.sendPushToUser({
1206
+ badge: payload.badge,
1207
+ body: String((_g = payload.body) !== null && _g !== void 0 ? _g : ""),
1208
+ data: payload.data,
1209
+ sound: payload.sound,
1210
+ title: String((_h = payload.title) !== null && _h !== void 0 ? _h : ""),
1211
+ userId: original.userId,
1212
+ }, sendOptions)];
1213
+ case 6:
1214
+ sendResult = _j.sent();
1215
+ return [3 /*break*/, 8];
1216
+ case 7:
1217
+ (0, commsRetry_1.throwRetryBlock)({
1218
+ code: "comms-retry-not-retryable",
1219
+ title: "Push retries require a linked user",
1220
+ });
1221
+ _j.label = 8;
1222
+ case 8:
1223
+ loggedId = this.loggedIdFromSend(sendResult !== null && sendResult !== void 0 ? sendResult : []);
1224
+ if (!loggedId) {
1225
+ throw new api_1.APIError({ status: 500, title: "Retry did not create a communication log" });
1226
+ }
1227
+ return [4 /*yield*/, commsMessage_1.CommsMessage.findOneOrNone({ _id: loggedId })];
1228
+ case 9:
1229
+ retried = _j.sent();
1230
+ if (!retried) {
1231
+ throw new api_1.APIError({ status: 500, title: "Retry did not create a communication log" });
1232
+ }
1233
+ original.retriedById = retried._id;
1234
+ return [4 /*yield*/, original.save()];
1235
+ case 10:
1236
+ _j.sent();
1237
+ return [2 /*return*/, retried];
1238
+ }
1239
+ });
1240
+ });
1241
+ };
1065
1242
  return CommsService;
1066
1243
  }());
1067
1244
  exports.CommsService = CommsService;
package/dist/index.d.ts CHANGED
@@ -5,6 +5,6 @@ export { CommsService } from "./commsService";
5
5
  export { CommsMessage } from "./models/commsMessage";
6
6
  export { PushToken } from "./models/pushToken";
7
7
  export type { CommsMessageAttempt, CommsMessageDocument, CommsMessageMethods, CommsMessageModel, CommsMessageSchema, CommsMessageStatics, LogSendParams, PushTokenDocument, PushTokenMethods, PushTokenModel, PushTokenPlatform, PushTokenSchema, PushTokenStatics, } from "./modelTypes";
8
- export type { MessageTemplate, RenderTemplateOptions } from "./templates";
9
- export { renderTemplate } from "./templates";
10
- export type { BeforeSendResult, CheckVerificationOptions, CommsChannel, CommsErrorClass, CommsHookContext, CommsHookMessage, CommsMessageStatus, CommsOptions, DeliveryEvent, MailMessage, MailProvider, OptOutEvent, PushMessage, PushProvider, SendPushToUserMessage, SendResult, SmsMessage, SmsProvider, StartVerificationOptions, VerificationProvider, VerificationResult, } from "./types";
8
+ export type { AuthMailTemplateId, MessageTemplate, RenderAuthMailOptions, RenderTemplateOptions, } from "./templates";
9
+ export { DEFAULT_AUTH_MAIL_TEMPLATES, renderAuthMail, renderTemplate } from "./templates";
10
+ export type { BeforeSendResult, CheckVerificationOptions, CommsChannel, CommsErrorClass, CommsHookContext, CommsHookMessage, CommsMessageStatus, CommsOptions, CommsSendOptions, DeliveryEvent, MailMessage, MailProvider, OptOutEvent, PushMessage, PushProvider, RetryMessageOptions, SendPushToUserMessage, SendResult, SmsMessage, SmsProvider, StartVerificationOptions, VerificationProvider, VerificationResult, } from "./types";
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.renderTemplate = exports.PushToken = exports.CommsMessage = exports.CommsService = exports.getCommsService = exports.CommsApp = exports.ConsoleVerificationProvider = exports.ConsoleSmsProvider = exports.ConsolePushProvider = exports.ConsoleMailProvider = void 0;
3
+ exports.renderTemplate = exports.renderAuthMail = exports.DEFAULT_AUTH_MAIL_TEMPLATES = exports.PushToken = exports.CommsMessage = exports.CommsService = exports.getCommsService = exports.CommsApp = exports.ConsoleVerificationProvider = exports.ConsoleSmsProvider = exports.ConsolePushProvider = exports.ConsoleMailProvider = void 0;
4
4
  var console_1 = require("./adapters/console");
5
5
  Object.defineProperty(exports, "ConsoleMailProvider", { enumerable: true, get: function () { return console_1.ConsoleMailProvider; } });
6
6
  Object.defineProperty(exports, "ConsolePushProvider", { enumerable: true, get: function () { return console_1.ConsolePushProvider; } });
@@ -16,4 +16,6 @@ Object.defineProperty(exports, "CommsMessage", { enumerable: true, get: function
16
16
  var pushToken_1 = require("./models/pushToken");
17
17
  Object.defineProperty(exports, "PushToken", { enumerable: true, get: function () { return pushToken_1.PushToken; } });
18
18
  var templates_1 = require("./templates");
19
+ Object.defineProperty(exports, "DEFAULT_AUTH_MAIL_TEMPLATES", { enumerable: true, get: function () { return templates_1.DEFAULT_AUTH_MAIL_TEMPLATES; } });
20
+ Object.defineProperty(exports, "renderAuthMail", { enumerable: true, get: function () { return templates_1.renderAuthMail; } });
19
21
  Object.defineProperty(exports, "renderTemplate", { enumerable: true, get: function () { return templates_1.renderTemplate; } });
@@ -0,0 +1,9 @@
1
+ import type express from "express";
2
+ import type { CommsService } from "../commsService";
3
+ interface CommsDashboardRouteOptions {
4
+ basePath?: string;
5
+ openApi?: unknown;
6
+ service: CommsService;
7
+ }
8
+ export declare const addCommsDashboardRoutes: (app: express.Application, options: CommsDashboardRouteOptions) => void;
9
+ export {};