@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
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.buildCommsMessageMatch = exports.defaultStatsRange = exports.parseRetryManyLimit = exports.parseCommsListPagination = exports.parseCommsListFilters = void 0;
|
|
7
|
+
var api_1 = require("@terreno/api");
|
|
8
|
+
var luxon_1 = require("luxon");
|
|
9
|
+
var mongoose_1 = __importDefault(require("mongoose"));
|
|
10
|
+
var DEFAULT_LIMIT = 20;
|
|
11
|
+
var MAX_LIMIT = 100;
|
|
12
|
+
var DEFAULT_STATS_DAYS = 7;
|
|
13
|
+
var escapeRegex = function (value) { return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); };
|
|
14
|
+
var queryString = function (value) {
|
|
15
|
+
if (typeof value !== "string") {
|
|
16
|
+
return undefined;
|
|
17
|
+
}
|
|
18
|
+
var trimmed = value.trim();
|
|
19
|
+
return trimmed.length > 0 ? trimmed : undefined;
|
|
20
|
+
};
|
|
21
|
+
var parseCommsListFilters = function (source) { return ({
|
|
22
|
+
channel: queryString(source.channel),
|
|
23
|
+
endDate: queryString(source.endDate),
|
|
24
|
+
errorClass: queryString(source.errorClass),
|
|
25
|
+
errorCode: queryString(source.errorCode),
|
|
26
|
+
provider: queryString(source.provider),
|
|
27
|
+
q: queryString(source.q),
|
|
28
|
+
retriedFromId: queryString(source.retriedFromId),
|
|
29
|
+
startDate: queryString(source.startDate),
|
|
30
|
+
status: queryString(source.status),
|
|
31
|
+
templateId: queryString(source.templateId),
|
|
32
|
+
to: queryString(source.to),
|
|
33
|
+
userId: queryString(source.userId),
|
|
34
|
+
}); };
|
|
35
|
+
exports.parseCommsListFilters = parseCommsListFilters;
|
|
36
|
+
var parseCommsListPagination = function (source) {
|
|
37
|
+
var _a, _b;
|
|
38
|
+
var page = Math.max(1, Number.parseInt(String((_a = source.page) !== null && _a !== void 0 ? _a : ""), 10) || 1);
|
|
39
|
+
var limit = Math.min(MAX_LIMIT, Math.max(1, Number.parseInt(String((_b = source.limit) !== null && _b !== void 0 ? _b : ""), 10) || DEFAULT_LIMIT));
|
|
40
|
+
return { limit: limit, page: page, skip: (page - 1) * limit };
|
|
41
|
+
};
|
|
42
|
+
exports.parseCommsListPagination = parseCommsListPagination;
|
|
43
|
+
var parseRetryManyLimit = function (value) {
|
|
44
|
+
var parsed = Number.parseInt(String(value !== null && value !== void 0 ? value : ""), 10);
|
|
45
|
+
if (Number.isNaN(parsed)) {
|
|
46
|
+
return MAX_LIMIT;
|
|
47
|
+
}
|
|
48
|
+
return Math.min(MAX_LIMIT, Math.max(1, parsed));
|
|
49
|
+
};
|
|
50
|
+
exports.parseRetryManyLimit = parseRetryManyLimit;
|
|
51
|
+
var parseIsoDate = function (value, field) {
|
|
52
|
+
var parsed = luxon_1.DateTime.fromISO(value, { zone: "utc" });
|
|
53
|
+
if (!parsed.isValid) {
|
|
54
|
+
throw new api_1.APIError({ status: 400, title: "Invalid ".concat(field, " format") });
|
|
55
|
+
}
|
|
56
|
+
return parsed;
|
|
57
|
+
};
|
|
58
|
+
var defaultStatsRange = function () {
|
|
59
|
+
var endDate = luxon_1.DateTime.utc();
|
|
60
|
+
return { endDate: endDate, startDate: endDate.minus({ days: DEFAULT_STATS_DAYS }) };
|
|
61
|
+
};
|
|
62
|
+
exports.defaultStatsRange = defaultStatsRange;
|
|
63
|
+
var buildCommsMessageMatch = function (filters, options) {
|
|
64
|
+
var match = {
|
|
65
|
+
deleted: { $ne: true },
|
|
66
|
+
};
|
|
67
|
+
if (filters.channel) {
|
|
68
|
+
match.channel = filters.channel;
|
|
69
|
+
}
|
|
70
|
+
if (filters.provider) {
|
|
71
|
+
match.provider = filters.provider;
|
|
72
|
+
}
|
|
73
|
+
if (filters.status) {
|
|
74
|
+
match.status = filters.status;
|
|
75
|
+
}
|
|
76
|
+
if (filters.errorClass) {
|
|
77
|
+
match.errorClass = filters.errorClass;
|
|
78
|
+
}
|
|
79
|
+
if (filters.errorCode) {
|
|
80
|
+
match.errorCode = filters.errorCode;
|
|
81
|
+
}
|
|
82
|
+
if (filters.templateId) {
|
|
83
|
+
match.templateId = filters.templateId;
|
|
84
|
+
}
|
|
85
|
+
if (filters.to) {
|
|
86
|
+
match.to = filters.to;
|
|
87
|
+
}
|
|
88
|
+
if (filters.userId) {
|
|
89
|
+
if (!mongoose_1.default.isValidObjectId(filters.userId)) {
|
|
90
|
+
throw new api_1.APIError({ status: 400, title: "Invalid userId" });
|
|
91
|
+
}
|
|
92
|
+
match.userId = new mongoose_1.default.Types.ObjectId(filters.userId);
|
|
93
|
+
}
|
|
94
|
+
if (filters.retriedFromId) {
|
|
95
|
+
if (!mongoose_1.default.isValidObjectId(filters.retriedFromId)) {
|
|
96
|
+
throw new api_1.APIError({ status: 400, title: "Invalid retriedFromId" });
|
|
97
|
+
}
|
|
98
|
+
match.retriedFromId = new mongoose_1.default.Types.ObjectId(filters.retriedFromId);
|
|
99
|
+
}
|
|
100
|
+
var start = filters.startDate ? parseIsoDate(filters.startDate, "startDate") : undefined;
|
|
101
|
+
var end = filters.endDate ? parseIsoDate(filters.endDate, "endDate") : undefined;
|
|
102
|
+
if ((options === null || options === void 0 ? void 0 : options.applyDefaultStatsRange) && !start && !end) {
|
|
103
|
+
var range = (0, exports.defaultStatsRange)();
|
|
104
|
+
start = range.startDate;
|
|
105
|
+
end = range.endDate;
|
|
106
|
+
}
|
|
107
|
+
if (start || end) {
|
|
108
|
+
match.created = {};
|
|
109
|
+
if (start) {
|
|
110
|
+
match.created.$gte = start.toJSDate();
|
|
111
|
+
}
|
|
112
|
+
if (end) {
|
|
113
|
+
match.created.$lte = end.toJSDate();
|
|
114
|
+
}
|
|
115
|
+
if (start && end && start.toMillis() > end.toMillis()) {
|
|
116
|
+
throw new api_1.APIError({ status: 400, title: "startDate must not be after endDate" });
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
if (filters.q) {
|
|
120
|
+
var escaped = escapeRegex(filters.q);
|
|
121
|
+
var clauses = [
|
|
122
|
+
{ subject: { $options: "i", $regex: escaped } },
|
|
123
|
+
{ error: { $options: "i", $regex: escaped } },
|
|
124
|
+
{ to: { $options: "i", $regex: escaped } },
|
|
125
|
+
];
|
|
126
|
+
var last4 = filters.q.replace(/\s/g, "");
|
|
127
|
+
if (/^[A-Za-z0-9]{4}$/.test(last4)) {
|
|
128
|
+
clauses.push({ to: { $options: "i", $regex: "".concat(escapeRegex(last4), "$") } });
|
|
129
|
+
}
|
|
130
|
+
match.$or = clauses;
|
|
131
|
+
}
|
|
132
|
+
return match;
|
|
133
|
+
};
|
|
134
|
+
exports.buildCommsMessageMatch = buildCommsMessageMatch;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { CommsMessageDocument } from "./modelTypes";
|
|
2
|
+
import type { CommsChannel } from "./types";
|
|
3
|
+
export declare const COMMS_RETRY_NOT_RETRYABLE = "comms-retry-not-retryable";
|
|
4
|
+
export declare const COMMS_RETRY_PAYLOAD_EXPIRED = "comms-retry-payload-expired";
|
|
5
|
+
export declare const COMMS_RETRY_CHANNEL_UNCONFIGURED = "comms-retry-channel-unconfigured";
|
|
6
|
+
export interface CommsRetryBlock {
|
|
7
|
+
code: string;
|
|
8
|
+
title: string;
|
|
9
|
+
}
|
|
10
|
+
export declare const isPayloadPresent: (message: CommsMessageDocument) => boolean;
|
|
11
|
+
export declare const evaluateRetryBlock: ({ isChannelConfigured, message, }: {
|
|
12
|
+
isChannelConfigured: (channel: CommsChannel) => boolean;
|
|
13
|
+
message: CommsMessageDocument;
|
|
14
|
+
}) => CommsRetryBlock | undefined;
|
|
15
|
+
export declare const throwRetryBlock: (block: CommsRetryBlock) => never;
|
|
16
|
+
export declare const serializeCommsMessage: (message: CommsMessageDocument, isChannelConfigured: (channel: CommsChannel) => boolean) => Record<string, unknown>;
|
|
@@ -0,0 +1,79 @@
|
|
|
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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.serializeCommsMessage = exports.throwRetryBlock = exports.evaluateRetryBlock = exports.isPayloadPresent = exports.COMMS_RETRY_CHANNEL_UNCONFIGURED = exports.COMMS_RETRY_PAYLOAD_EXPIRED = exports.COMMS_RETRY_NOT_RETRYABLE = void 0;
|
|
15
|
+
var api_1 = require("@terreno/api");
|
|
16
|
+
var luxon_1 = require("luxon");
|
|
17
|
+
exports.COMMS_RETRY_NOT_RETRYABLE = "comms-retry-not-retryable";
|
|
18
|
+
exports.COMMS_RETRY_PAYLOAD_EXPIRED = "comms-retry-payload-expired";
|
|
19
|
+
exports.COMMS_RETRY_CHANNEL_UNCONFIGURED = "comms-retry-channel-unconfigured";
|
|
20
|
+
var RETRYABLE_STATUSES = new Set(["bounced", "failed"]);
|
|
21
|
+
var isPayloadPresent = function (message) {
|
|
22
|
+
if (message.payload === undefined || message.payload === null) {
|
|
23
|
+
return false;
|
|
24
|
+
}
|
|
25
|
+
if (message.payloadExpiresAt && luxon_1.DateTime.fromJSDate(message.payloadExpiresAt) <= luxon_1.DateTime.utc()) {
|
|
26
|
+
return false;
|
|
27
|
+
}
|
|
28
|
+
return true;
|
|
29
|
+
};
|
|
30
|
+
exports.isPayloadPresent = isPayloadPresent;
|
|
31
|
+
var evaluateRetryBlock = function (_a) {
|
|
32
|
+
var isChannelConfigured = _a.isChannelConfigured, message = _a.message;
|
|
33
|
+
if (message.channel === "verification") {
|
|
34
|
+
return {
|
|
35
|
+
code: exports.COMMS_RETRY_NOT_RETRYABLE,
|
|
36
|
+
title: "Verification messages are not retryable",
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
if (!RETRYABLE_STATUSES.has(message.status)) {
|
|
40
|
+
return {
|
|
41
|
+
code: exports.COMMS_RETRY_NOT_RETRYABLE,
|
|
42
|
+
title: "Only failed or bounced messages can be retried",
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
if (message.errorClass === "permanent") {
|
|
46
|
+
return {
|
|
47
|
+
code: exports.COMMS_RETRY_NOT_RETRYABLE,
|
|
48
|
+
title: "Permanent failures cannot be retried",
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
if (!(0, exports.isPayloadPresent)(message)) {
|
|
52
|
+
return {
|
|
53
|
+
code: exports.COMMS_RETRY_PAYLOAD_EXPIRED,
|
|
54
|
+
title: "Retained payload is missing or expired",
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
if (!isChannelConfigured(message.channel)) {
|
|
58
|
+
return {
|
|
59
|
+
code: exports.COMMS_RETRY_CHANNEL_UNCONFIGURED,
|
|
60
|
+
title: "Comms channel is not configured",
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
return undefined;
|
|
64
|
+
};
|
|
65
|
+
exports.evaluateRetryBlock = evaluateRetryBlock;
|
|
66
|
+
var throwRetryBlock = function (block) {
|
|
67
|
+
throw new api_1.APIError({
|
|
68
|
+
code: block.code,
|
|
69
|
+
status: 400,
|
|
70
|
+
title: block.title,
|
|
71
|
+
});
|
|
72
|
+
};
|
|
73
|
+
exports.throwRetryBlock = throwRetryBlock;
|
|
74
|
+
var serializeCommsMessage = function (message, isChannelConfigured) {
|
|
75
|
+
var json = message.toJSON();
|
|
76
|
+
var block = (0, exports.evaluateRetryBlock)({ isChannelConfigured: isChannelConfigured, message: message });
|
|
77
|
+
return __assign(__assign({}, json), { retryable: !block, retryDisabledReason: block === null || block === void 0 ? void 0 : block.title });
|
|
78
|
+
};
|
|
79
|
+
exports.serializeCommsMessage = serializeCommsMessage;
|
package/dist/commsService.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CommsMessageDocument } from "./modelTypes";
|
|
2
|
+
import type { CheckVerificationOptions, CommsChannel, CommsOptions, CommsSendOptions, DeliveryEvent, MailMessage, OptOutEvent, RetryMessageOptions, SendPushToUserMessage, SendResult, SmsMessage, StartVerificationOptions, VerificationResult } from "./types";
|
|
2
3
|
export declare class CommsService {
|
|
3
4
|
private readonly options;
|
|
4
5
|
private readonly consoleMail;
|
|
@@ -8,6 +9,7 @@ export declare class CommsService {
|
|
|
8
9
|
constructor(options?: CommsOptions);
|
|
9
10
|
recordDeliveryEvent(event: DeliveryEvent): Promise<void>;
|
|
10
11
|
recordOptOut(event: OptOutEvent): Promise<void>;
|
|
12
|
+
deactivatePushToken(token: string): Promise<void>;
|
|
11
13
|
clearExpiredPayloads(): Promise<number>;
|
|
12
14
|
private recipientForLog;
|
|
13
15
|
private retainPayloadDays;
|
|
@@ -27,19 +29,24 @@ export declare class CommsService {
|
|
|
27
29
|
private retryOnce;
|
|
28
30
|
private persistRetry;
|
|
29
31
|
private finalizeWithRetry;
|
|
32
|
+
private withLoggedId;
|
|
33
|
+
private loggedIdFromSend;
|
|
30
34
|
private cancelledResult;
|
|
31
35
|
private sendMailOnce;
|
|
32
36
|
private sendSmsOnce;
|
|
33
37
|
private sendPushOnce;
|
|
34
38
|
private startVerificationOnce;
|
|
39
|
+
private mergeSendMetadata;
|
|
35
40
|
private mailProvider;
|
|
36
41
|
private smsProvider;
|
|
37
42
|
private pushProvider;
|
|
38
43
|
private verificationProvider;
|
|
39
44
|
private applyMailDefaults;
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
45
|
+
isChannelConfigured(channel: CommsChannel): boolean;
|
|
46
|
+
sendMail(message: MailMessage, sendOptions?: CommsSendOptions): Promise<SendResult>;
|
|
47
|
+
sendSms(message: SmsMessage, sendOptions?: CommsSendOptions): Promise<SendResult>;
|
|
48
|
+
sendPushToUser(message: SendPushToUserMessage, sendOptions?: CommsSendOptions): Promise<SendResult[]>;
|
|
43
49
|
startVerification(options: StartVerificationOptions): Promise<SendResult>;
|
|
44
50
|
checkVerification(options: CheckVerificationOptions): Promise<VerificationResult>;
|
|
51
|
+
retryMessage(options: RetryMessageOptions): Promise<CommsMessageDocument>;
|
|
45
52
|
}
|