@terreno/comms 57.2.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.
- package/README.md +58 -0
- package/dist/adapters/expoPush.d.ts +54 -0
- package/dist/adapters/expoPush.js +400 -0
- package/dist/adapters/sendgrid.d.ts +3 -0
- package/dist/adapters/sendgrid.js +7 -1
- package/dist/adapters/twilioSms.d.ts +36 -0
- package/dist/adapters/twilioSms.js +232 -0
- package/dist/adapters/twilioVerify.d.ts +44 -0
- package/dist/adapters/twilioVerify.js +212 -0
- package/dist/commsApp.d.ts +4 -1
- package/dist/commsApp.js +28 -2
- package/dist/commsQuery.d.ts +30 -0
- package/dist/commsQuery.js +134 -0
- package/dist/commsRetry.d.ts +16 -0
- package/dist/commsRetry.js +79 -0
- package/dist/commsService.d.ts +11 -4
- package/dist/commsService.js +217 -47
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -1
- package/dist/routes/commsDashboard.d.ts +11 -0
- package/dist/routes/commsDashboard.js +414 -0
- package/dist/templates.d.ts +9 -0
- package/dist/templates.js +34 -1
- package/dist/types.d.ts +11 -0
- package/dist/webhooks/sendgridWebhooks.d.ts +16 -0
- package/dist/webhooks/sendgridWebhooks.js +251 -0
- package/dist/webhooks/twilioWebhooks.d.ts +18 -0
- package/dist/webhooks/twilioWebhooks.js +175 -0
- package/package.json +26 -5
- package/src/adapters/expoPush.test.ts +585 -0
- package/src/adapters/expoPush.ts +304 -0
- package/src/adapters/sendgrid.ts +8 -0
- package/src/adapters/twilioSms.test.ts +374 -0
- package/src/adapters/twilioSms.ts +237 -0
- package/src/adapters/twilioVerify.test.ts +207 -0
- package/src/adapters/twilioVerify.ts +227 -0
- package/src/commsApp.test.ts +13 -0
- package/src/commsApp.ts +38 -3
- package/src/commsQuery.test.ts +165 -0
- package/src/commsQuery.ts +162 -0
- package/src/commsRetry.ts +87 -0
- package/src/commsService.test.ts +68 -0
- package/src/commsService.ts +177 -20
- package/src/index.ts +9 -2
- package/src/routes/commsDashboard.test.ts +310 -0
- package/src/routes/commsDashboard.ts +327 -0
- package/src/templates.test.ts +63 -1
- package/src/templates.ts +47 -0
- package/src/tests/bunSetup.ts +8 -0
- package/src/types.ts +13 -0
- package/src/webhooks/sendgridWebhooks.test.ts +520 -0
- package/src/webhooks/sendgridWebhooks.ts +166 -0
- package/src/webhooks/twilioWebhooks.test.ts +352 -0
- package/src/webhooks/twilioWebhooks.ts +154 -0
- package/dist/routes/commsExplorer.d.ts +0 -7
- package/dist/routes/commsExplorer.js +0 -147
- package/src/routes/commsExplorer.ts +0 -114
package/dist/commsService.js
CHANGED
|
@@ -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
|
-
|
|
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
|
|
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
|
-
|
|
206
|
-
message = "[comms] ".concat(label, " hook failed: ").concat(String(
|
|
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,
|
|
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
|
-
|
|
280
|
+
error_4 = _b.sent();
|
|
249
281
|
this.appendHookError(hookErrors, "beforeSend", HOOK_THREW);
|
|
250
|
-
api_1.logger.error("[comms] beforeSend hook failed: ".concat(String(
|
|
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
|
|
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
|
-
|
|
541
|
-
return [2 /*return*/, providerThrowResult(
|
|
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
|
|
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
|
-
|
|
558
|
-
return [2 /*return*/, providerThrowResult(
|
|
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
|
|
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
|
-
|
|
575
|
-
return [2 /*return*/, message.tokens.map(function () { return providerThrowResult(
|
|
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
|
|
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
|
-
|
|
592
|
-
return [2 /*return*/, providerThrowResult(
|
|
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.
|
|
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,7 +716,7 @@ var CommsService = /** @class */ (function () {
|
|
|
651
716
|
context = {
|
|
652
717
|
attempt: 1,
|
|
653
718
|
channel: "mail",
|
|
654
|
-
isRetry:
|
|
719
|
+
isRetry: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.isRetry) === true,
|
|
655
720
|
message: this.applyMailDefaults(message),
|
|
656
721
|
provider: provider.id,
|
|
657
722
|
};
|
|
@@ -667,16 +732,18 @@ var CommsService = /** @class */ (function () {
|
|
|
667
732
|
channel: "mail",
|
|
668
733
|
context: context,
|
|
669
734
|
hookErrors: hookErrors,
|
|
735
|
+
metadata: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata,
|
|
670
736
|
provider: provider.id,
|
|
671
737
|
result: result,
|
|
738
|
+
retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
|
|
672
739
|
status: "cancelled",
|
|
673
740
|
subject: activeMessage.subject,
|
|
674
741
|
templateId: activeMessage.templateId,
|
|
675
742
|
to: activeMessage.to,
|
|
676
743
|
})];
|
|
677
744
|
case 2:
|
|
678
|
-
_a.sent();
|
|
679
|
-
return [2 /*return*/, result];
|
|
745
|
+
logged = _a.sent();
|
|
746
|
+
return [2 /*return*/, this.withLoggedId(result, logged)];
|
|
680
747
|
case 3: return [4 /*yield*/, this.sendMailOnce(provider, activeMessage)];
|
|
681
748
|
case 4:
|
|
682
749
|
first = _a.sent();
|
|
@@ -686,7 +753,8 @@ var CommsService = /** @class */ (function () {
|
|
|
686
753
|
hookErrors: hookErrors,
|
|
687
754
|
logFields: {
|
|
688
755
|
channel: "mail",
|
|
689
|
-
metadata: first
|
|
756
|
+
metadata: this.mergeSendMetadata(first, sendOptions),
|
|
757
|
+
retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
|
|
690
758
|
subject: activeMessage.subject,
|
|
691
759
|
templateId: activeMessage.templateId,
|
|
692
760
|
to: activeMessage.to,
|
|
@@ -698,9 +766,9 @@ var CommsService = /** @class */ (function () {
|
|
|
698
766
|
});
|
|
699
767
|
});
|
|
700
768
|
};
|
|
701
|
-
CommsService.prototype.sendSms = function (message) {
|
|
769
|
+
CommsService.prototype.sendSms = function (message, sendOptions) {
|
|
702
770
|
return __awaiter(this, void 0, void 0, function () {
|
|
703
|
-
var provider, hookErrors, context, before, activeMessage, result, first;
|
|
771
|
+
var provider, hookErrors, context, before, activeMessage, result, logged, first;
|
|
704
772
|
var _this = this;
|
|
705
773
|
return __generator(this, function (_a) {
|
|
706
774
|
switch (_a.label) {
|
|
@@ -710,7 +778,7 @@ var CommsService = /** @class */ (function () {
|
|
|
710
778
|
context = {
|
|
711
779
|
attempt: 1,
|
|
712
780
|
channel: "sms",
|
|
713
|
-
isRetry:
|
|
781
|
+
isRetry: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.isRetry) === true,
|
|
714
782
|
message: message,
|
|
715
783
|
provider: provider.id,
|
|
716
784
|
};
|
|
@@ -726,14 +794,16 @@ var CommsService = /** @class */ (function () {
|
|
|
726
794
|
channel: "sms",
|
|
727
795
|
context: context,
|
|
728
796
|
hookErrors: hookErrors,
|
|
797
|
+
metadata: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata,
|
|
729
798
|
provider: provider.id,
|
|
730
799
|
result: result,
|
|
800
|
+
retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
|
|
731
801
|
status: "cancelled",
|
|
732
802
|
to: activeMessage.to,
|
|
733
803
|
})];
|
|
734
804
|
case 2:
|
|
735
|
-
_a.sent();
|
|
736
|
-
return [2 /*return*/, result];
|
|
805
|
+
logged = _a.sent();
|
|
806
|
+
return [2 /*return*/, this.withLoggedId(result, logged)];
|
|
737
807
|
case 3: return [4 /*yield*/, this.sendSmsOnce(provider, activeMessage)];
|
|
738
808
|
case 4:
|
|
739
809
|
first = _a.sent();
|
|
@@ -743,6 +813,8 @@ var CommsService = /** @class */ (function () {
|
|
|
743
813
|
hookErrors: hookErrors,
|
|
744
814
|
logFields: {
|
|
745
815
|
channel: "sms",
|
|
816
|
+
metadata: this.mergeSendMetadata(first, sendOptions),
|
|
817
|
+
retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
|
|
746
818
|
to: activeMessage.to,
|
|
747
819
|
},
|
|
748
820
|
provider: provider.id,
|
|
@@ -752,9 +824,9 @@ var CommsService = /** @class */ (function () {
|
|
|
752
824
|
});
|
|
753
825
|
});
|
|
754
826
|
};
|
|
755
|
-
CommsService.prototype.sendPushToUser = function (message) {
|
|
827
|
+
CommsService.prototype.sendPushToUser = function (message, sendOptions) {
|
|
756
828
|
return __awaiter(this, void 0, void 0, function () {
|
|
757
|
-
var provider, hookErrors, tokens,
|
|
829
|
+
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
830
|
var _this = this;
|
|
759
831
|
return __generator(this, function (_g) {
|
|
760
832
|
switch (_g.label) {
|
|
@@ -767,7 +839,6 @@ var CommsService = /** @class */ (function () {
|
|
|
767
839
|
if (tokens.length === 0) {
|
|
768
840
|
return [2 /*return*/, []];
|
|
769
841
|
}
|
|
770
|
-
tokenDocs = new Map(tokens.map(function (token) { return [token.token, token]; }));
|
|
771
842
|
providerMessage = {
|
|
772
843
|
badge: message.badge,
|
|
773
844
|
body: message.body,
|
|
@@ -779,7 +850,7 @@ var CommsService = /** @class */ (function () {
|
|
|
779
850
|
context = {
|
|
780
851
|
attempt: 1,
|
|
781
852
|
channel: "push",
|
|
782
|
-
isRetry:
|
|
853
|
+
isRetry: (sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.isRetry) === true,
|
|
783
854
|
message: providerMessage,
|
|
784
855
|
provider: provider.id,
|
|
785
856
|
userId: String(message.userId),
|
|
@@ -797,16 +868,18 @@ var CommsService = /** @class */ (function () {
|
|
|
797
868
|
channel: "push",
|
|
798
869
|
context: _this.cloneContext(context),
|
|
799
870
|
hookErrors: hookErrors,
|
|
871
|
+
metadata: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.extraMetadata,
|
|
800
872
|
provider: provider.id,
|
|
801
873
|
result: result_1,
|
|
874
|
+
retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
|
|
802
875
|
status: "cancelled",
|
|
803
876
|
to: token.token,
|
|
804
877
|
userId: String(message.userId),
|
|
805
878
|
});
|
|
806
879
|
}))];
|
|
807
880
|
case 3:
|
|
808
|
-
_g.sent();
|
|
809
|
-
return [2 /*return*/, tokens.map(function () { return result_1; })];
|
|
881
|
+
loggedRows_1 = _g.sent();
|
|
882
|
+
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
883
|
case 4:
|
|
811
884
|
sendTokens = activeMessage.tokens;
|
|
812
885
|
if (sendTokens.length === 0) {
|
|
@@ -830,8 +903,10 @@ var CommsService = /** @class */ (function () {
|
|
|
830
903
|
channel: "push",
|
|
831
904
|
context: tokenContext,
|
|
832
905
|
hookErrors: hookErrors,
|
|
906
|
+
metadata: this.mergeSendMetadata(result, sendOptions),
|
|
833
907
|
provider: provider.id,
|
|
834
908
|
result: result,
|
|
909
|
+
retriedFromId: sendOptions === null || sendOptions === void 0 ? void 0 : sendOptions.retriedFromId,
|
|
835
910
|
status: result.accepted ? "sent" : "failed",
|
|
836
911
|
to: tokenValue,
|
|
837
912
|
userId: String(message.userId),
|
|
@@ -895,7 +970,7 @@ var CommsService = /** @class */ (function () {
|
|
|
895
970
|
_g.sent();
|
|
896
971
|
_g.label = 10;
|
|
897
972
|
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
|
|
973
|
+
var result, tokenHookErrors, logged, didRetry;
|
|
899
974
|
var _a;
|
|
900
975
|
return __generator(this, function (_b) {
|
|
901
976
|
switch (_b.label) {
|
|
@@ -917,10 +992,8 @@ var CommsService = /** @class */ (function () {
|
|
|
917
992
|
return [4 /*yield*/, this.patchHookErrors(logged, tokenHookErrors)];
|
|
918
993
|
case 2:
|
|
919
994
|
_b.sent();
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
tokenDoc.active = false;
|
|
923
|
-
return [4 /*yield*/, tokenDoc.save()];
|
|
995
|
+
if (!(!result.accepted && isPermanentPushFailure(result))) return [3 /*break*/, 4];
|
|
996
|
+
return [4 /*yield*/, this.deactivatePushToken(tokenValue)];
|
|
924
997
|
case 3:
|
|
925
998
|
_b.sent();
|
|
926
999
|
_b.label = 4;
|
|
@@ -930,7 +1003,10 @@ var CommsService = /** @class */ (function () {
|
|
|
930
1003
|
}); }))];
|
|
931
1004
|
case 11:
|
|
932
1005
|
_g.sent();
|
|
933
|
-
return [2 /*return*/, sendTokens.map(function (tokenValue) {
|
|
1006
|
+
return [2 /*return*/, sendTokens.map(function (tokenValue) {
|
|
1007
|
+
var _a;
|
|
1008
|
+
return _this.withLoggedId(finalByToken.get(tokenValue), (_a = loggedByToken.get(tokenValue)) !== null && _a !== void 0 ? _a : null);
|
|
1009
|
+
})];
|
|
934
1010
|
}
|
|
935
1011
|
});
|
|
936
1012
|
});
|
|
@@ -993,7 +1069,7 @@ var CommsService = /** @class */ (function () {
|
|
|
993
1069
|
};
|
|
994
1070
|
CommsService.prototype.checkVerification = function (options) {
|
|
995
1071
|
return __awaiter(this, void 0, void 0, function () {
|
|
996
|
-
var provider, hookErrors, context, result, loggedResult, logged,
|
|
1072
|
+
var provider, hookErrors, context, result, loggedResult, logged, error_9, loggedResult, logged;
|
|
997
1073
|
var _a;
|
|
998
1074
|
return __generator(this, function (_b) {
|
|
999
1075
|
switch (_b.label) {
|
|
@@ -1035,8 +1111,8 @@ var CommsService = /** @class */ (function () {
|
|
|
1035
1111
|
_b.sent();
|
|
1036
1112
|
return [2 /*return*/, result];
|
|
1037
1113
|
case 6:
|
|
1038
|
-
|
|
1039
|
-
loggedResult = providerThrowResult(
|
|
1114
|
+
error_9 = _b.sent();
|
|
1115
|
+
loggedResult = providerThrowResult(error_9);
|
|
1040
1116
|
return [4 /*yield*/, this.logResult({
|
|
1041
1117
|
attempts: [this.attemptFromResult(provider.id, loggedResult)],
|
|
1042
1118
|
channel: "verification",
|
|
@@ -1062,6 +1138,100 @@ var CommsService = /** @class */ (function () {
|
|
|
1062
1138
|
});
|
|
1063
1139
|
});
|
|
1064
1140
|
};
|
|
1141
|
+
CommsService.prototype.retryMessage = function (options) {
|
|
1142
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1143
|
+
var original, block, sendOptions, payload, sendResult, loggedId, retried;
|
|
1144
|
+
var _this = this;
|
|
1145
|
+
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
1146
|
+
return __generator(this, function (_j) {
|
|
1147
|
+
switch (_j.label) {
|
|
1148
|
+
case 0:
|
|
1149
|
+
if (!mongoose_1.default.isValidObjectId(options.messageId)) {
|
|
1150
|
+
throw new api_1.APIError({ status: 404, title: "Comms message not found" });
|
|
1151
|
+
}
|
|
1152
|
+
return [4 /*yield*/, commsMessage_1.CommsMessage.findOneOrNone({ _id: options.messageId })];
|
|
1153
|
+
case 1:
|
|
1154
|
+
original = _j.sent();
|
|
1155
|
+
if (!original) {
|
|
1156
|
+
throw new api_1.APIError({ status: 404, title: "Comms message not found" });
|
|
1157
|
+
}
|
|
1158
|
+
block = (0, commsRetry_1.evaluateRetryBlock)({
|
|
1159
|
+
isChannelConfigured: function (channel) { return _this.isChannelConfigured(channel); },
|
|
1160
|
+
message: original,
|
|
1161
|
+
});
|
|
1162
|
+
if (block) {
|
|
1163
|
+
(0, commsRetry_1.throwRetryBlock)(block);
|
|
1164
|
+
}
|
|
1165
|
+
sendOptions = {
|
|
1166
|
+
extraMetadata: options.retriedByUserId
|
|
1167
|
+
? { retriedByUserId: options.retriedByUserId }
|
|
1168
|
+
: undefined,
|
|
1169
|
+
isRetry: true,
|
|
1170
|
+
retriedFromId: String(original._id),
|
|
1171
|
+
};
|
|
1172
|
+
payload = original.payload;
|
|
1173
|
+
if (!(original.channel === "mail")) return [3 /*break*/, 3];
|
|
1174
|
+
return [4 /*yield*/, this.sendMail({
|
|
1175
|
+
dynamicTemplateData: payload.dynamicTemplateData,
|
|
1176
|
+
from: payload.from,
|
|
1177
|
+
html: payload.html,
|
|
1178
|
+
replyTo: payload.replyTo,
|
|
1179
|
+
subject: String((_b = (_a = payload.subject) !== null && _a !== void 0 ? _a : original.subject) !== null && _b !== void 0 ? _b : ""),
|
|
1180
|
+
templateId: (_c = payload.templateId) !== null && _c !== void 0 ? _c : original.templateId,
|
|
1181
|
+
text: payload.text,
|
|
1182
|
+
to: (_d = payload.to) !== null && _d !== void 0 ? _d : original.to,
|
|
1183
|
+
}, sendOptions)];
|
|
1184
|
+
case 2:
|
|
1185
|
+
sendResult = _j.sent();
|
|
1186
|
+
return [3 /*break*/, 8];
|
|
1187
|
+
case 3:
|
|
1188
|
+
if (!(original.channel === "sms")) return [3 /*break*/, 5];
|
|
1189
|
+
return [4 /*yield*/, this.sendSms({
|
|
1190
|
+
body: String((_e = payload.body) !== null && _e !== void 0 ? _e : ""),
|
|
1191
|
+
to: String((_f = payload.to) !== null && _f !== void 0 ? _f : original.to),
|
|
1192
|
+
}, sendOptions)];
|
|
1193
|
+
case 4:
|
|
1194
|
+
sendResult = _j.sent();
|
|
1195
|
+
return [3 /*break*/, 8];
|
|
1196
|
+
case 5:
|
|
1197
|
+
if (!original.userId) return [3 /*break*/, 7];
|
|
1198
|
+
return [4 /*yield*/, this.sendPushToUser({
|
|
1199
|
+
badge: payload.badge,
|
|
1200
|
+
body: String((_g = payload.body) !== null && _g !== void 0 ? _g : ""),
|
|
1201
|
+
data: payload.data,
|
|
1202
|
+
sound: payload.sound,
|
|
1203
|
+
title: String((_h = payload.title) !== null && _h !== void 0 ? _h : ""),
|
|
1204
|
+
userId: original.userId,
|
|
1205
|
+
}, sendOptions)];
|
|
1206
|
+
case 6:
|
|
1207
|
+
sendResult = _j.sent();
|
|
1208
|
+
return [3 /*break*/, 8];
|
|
1209
|
+
case 7:
|
|
1210
|
+
(0, commsRetry_1.throwRetryBlock)({
|
|
1211
|
+
code: "comms-retry-not-retryable",
|
|
1212
|
+
title: "Push retries require a linked user",
|
|
1213
|
+
});
|
|
1214
|
+
_j.label = 8;
|
|
1215
|
+
case 8:
|
|
1216
|
+
loggedId = this.loggedIdFromSend(sendResult !== null && sendResult !== void 0 ? sendResult : []);
|
|
1217
|
+
if (!loggedId) {
|
|
1218
|
+
throw new api_1.APIError({ status: 500, title: "Retry did not create a communication log" });
|
|
1219
|
+
}
|
|
1220
|
+
return [4 /*yield*/, commsMessage_1.CommsMessage.findOneOrNone({ _id: loggedId })];
|
|
1221
|
+
case 9:
|
|
1222
|
+
retried = _j.sent();
|
|
1223
|
+
if (!retried) {
|
|
1224
|
+
throw new api_1.APIError({ status: 500, title: "Retry did not create a communication log" });
|
|
1225
|
+
}
|
|
1226
|
+
original.retriedById = retried._id;
|
|
1227
|
+
return [4 /*yield*/, original.save()];
|
|
1228
|
+
case 10:
|
|
1229
|
+
_j.sent();
|
|
1230
|
+
return [2 /*return*/, retried];
|
|
1231
|
+
}
|
|
1232
|
+
});
|
|
1233
|
+
});
|
|
1234
|
+
};
|
|
1065
1235
|
return CommsService;
|
|
1066
1236
|
}());
|
|
1067
1237
|
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,11 @@
|
|
|
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
|
+
/** @deprecated Use {@link addCommsDashboardRoutes}. */
|
|
10
|
+
export declare const addCommsExplorerRoute: (app: express.Application, options: CommsDashboardRouteOptions) => void;
|
|
11
|
+
export {};
|