@antelopejs/dms-mailing 0.2.2

package/dist/services/events.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyEvent = applyEvent;
+exports.recordEmailEvent = recordEmailEvent;
+exports.webhookSecretMatches = webhookSecretMatches;
+const node_crypto_1 = require("node:crypto");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const email_event_trigger_1 = require("../automation/email-event-trigger");
+const db_1 = require("../db");
+const realtime_1 = require("../realtime");
+const notify_1 = require("./notify");
+const RANK = {
+    queued: 0,
+    sent: 1,
+    delivered: 2,
+    opened: 3,
+    clicked: 4,
+    unsubscribed: 5,
+    spam: 6,
+    bounced: 7,
+    failed: 7,
+};
+const COUNTERS = {
+    opened: "opens",
+    clicked: "clicks",
+};
+const MAX_ACTIVITY_ATTEMPTS = 5;
+function applyEvent(current, type) {
+    const counter = COUNTERS[type];
+    const next = { ...current };
+    if (counter)
+        next[counter] = current[counter] + 1;
+    if (RANK[type] > RANK[current.status])
+        next.status = type;
+    return next;
+}
+async function publishEmailEvent(payload) {
+    (0, email_event_trigger_1.emitEmailEvent)(payload);
+    (0, realtime_1.publishSendUpdated)(payload.sendId);
+    await (0, notify_1.notifyBounce)(payload.tenantId, payload);
+}
+async function acceptEmailActivity(tenantId, event) {
+    const sends = (0, interface_database_decorators_1.GetModel)(db_1.SendModel, tenantId);
+    for (let attempt = 0; attempt < MAX_ACTIVITY_ATTEMPTS; attempt++) {
+        const send = await sends.getByProviderMessageId(event.messageId);
+        if (!send || send.isRetiring)
+            return undefined;
+        const accepted = await sends.recordActivity(send, {
+            ...applyEvent({ status: send.status, opens: send.opens, clicks: send.clicks }, event.type),
+            lastEventAt: event.at ?? new Date(),
+            provider: event.provider,
+        });
+        if (accepted)
+            return send;
+    }
+    throw new Error("Mailing activity conflicted repeatedly; retry the webhook");
+}
+async function recordEmailEvent(tenantId, event) {
+    const send = await acceptEmailActivity(tenantId, event);
+    if (!send)
+        return false;
+    const at = event.at ?? new Date();
+    const recorded = await (0, interface_database_decorators_1.GetModel)(db_1.SendEventModel, tenantId).insertForActiveSend({
+        sendId: send._id,
+        type: event.type,
+        at,
+        json_details: JSON.stringify(event.details ?? {}),
+    });
+    if (!recorded)
+        return false;
+    await publishEmailEvent({
+        tenantId,
+        sendId: send._id,
+        templateSlug: send.templateSlug,
+        type: event.type,
+        recipientEmail: send.recipientEmail,
+    });
+    return true;
+}
+function webhookSecretMatches(provided, stored) {
+    if (!stored || !provided)
+        return false;
+    const left = Buffer.from(provided);
+    const right = Buffer.from(stored);
+    if (left.length !== right.length)
+        return false;
+    return (0, node_crypto_1.timingSafeEqual)(left, right);
+}
+//# sourceMappingURL=events.js.map

package/dist/services/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/services/events.ts"],"names":[],"mappings":";;AAuCA,gCASC;AA6BD,4CAwBC;AAUD,oDASC;AAxHD,6CAA8C;AAC9C,6FAAqE;AACrE,2EAG2C;AAC3C,8BAAoE;AAEpE,0CAAiD;AAEjD,qCAAwC;AAUxC,MAAM,IAAI,GAA+B;IACvC,MAAM,EAAE,CAAC;IACT,IAAI,EAAE,CAAC;IACP,SAAS,EAAE,CAAC;IACZ,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IACV,YAAY,EAAE,CAAC;IACf,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;CACV,CAAC;AAEF,MAAM,QAAQ,GAA+C;IAC3D,MAAM,EAAE,OAAO;IACf,OAAO,EAAE,QAAQ;CAClB,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAEhC,SAAgB,UAAU,CACxB,OAAqB,EACrB,IAAmB;IAEnB,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAiB,EAAE,GAAG,OAAO,EAAE,CAAC;IAC1C,IAAI,OAAO;QAAE,IAAI,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAC1D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,OAA0B;IACzD,IAAA,oCAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,6BAAkB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,IAAA,qBAAY,EAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED,KAAK,UAAU,mBAAmB,CAChC,QAAgB,EAChB,KAAiB;IAEjB,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,cAAS,EAAE,QAAQ,CAAC,CAAC;IAC5C,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,qBAAqB,EAAE,OAAO,EAAE,EAAE,CAAC;QACjE,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE;YAChD,GAAG,UAAU,CACX,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAC/D,KAAK,CAAC,IAAI,CACX;YACD,WAAW,EAAE,KAAK,CAAC,EAAE,IAAI,IAAI,IAAI,EAAE;YACnC,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAC;QACH,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC;IAC5B,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;AAC/E,CAAC;AAEM,KAAK,UAAU,gBAAgB,CACpC,QAAgB,EAChB,KAAiB;IAEjB,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACxD,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IAClC,MAAM,QAAQ,GAAG,MAAM,IAAA,wCAAQ,EAAC,mBAAc,EAAE,QAAQ,CAAC,CAAC,mBAAmB,CAC3E;QACE,MAAM,EAAE,IAAI,CAAC,GAAG;QAChB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,EAAE;QACF,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;KAClD,CACF,CAAC;IACF,IAAI,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5B,MAAM,iBAAiB,CAAC;QACtB,QAAQ;QACR,MAAM,EAAE,IAAI,CAAC,GAAG;QAChB,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,cAAc,EAAE,IAAI,CAAC,cAAc;KACpC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAUD,SAAgB,oBAAoB,CAClC,QAA4B,EAC5B,MAAc;IAEd,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC/C,OAAO,IAAA,6BAAe,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC"}

package/dist/services/metrics.d.ts

@@ -0,0 +1,34 @@
+import type { MailingSend } from "../db";
+import { type SendAudience } from "../types";
+export declare function readAudience(raw: string | null | undefined): SendAudience;
+export declare function forAudience(sends: MailingSend[], audience: SendAudience): MailingSend[];
+export interface Totals {
+    sends: number;
+    queued: number;
+    sent: number;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    bounced: number;
+    failed: number;
+    spam: number;
+    unsubscribed: number;
+    deliverability: number;
+    openRate: number;
+    clickRate: number;
+    latencyMedian: number;
+}
+export interface SeriesPoint {
+    x: string;
+    y: number;
+}
+export interface DateRange {
+    from: Date;
+    to: Date;
+}
+export declare const ratio: (part: number, whole: number) => number;
+export declare function aggregate(sends: MailingSend[]): Totals;
+export declare function deltaPercent(current: number, previous: number): number;
+export declare function dailySeries(sends: MailingSend[], from: Date, to: Date): SeriesPoint[];
+export declare function domainOf(email: string): string;
+export declare function groupBy<T>(items: T[], key: (item: T) => string): Map<string, T[]>;

package/dist/services/metrics.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ratio = void 0;
+exports.readAudience = readAudience;
+exports.forAudience = forAudience;
+exports.aggregate = aggregate;
+exports.deltaPercent = deltaPercent;
+exports.dailySeries = dailySeries;
+exports.domainOf = domainOf;
+exports.groupBy = groupBy;
+const types_1 = require("../types");
+const AUDIENCE_KEEPS = {
+    [types_1.BUSINESS_AUDIENCE]: (send) => !send.isTest,
+    [types_1.OPERATIONAL_AUDIENCE]: () => true,
+};
+const AUDIENCE_BY_NAME = {
+    [types_1.BUSINESS_AUDIENCE]: types_1.BUSINESS_AUDIENCE,
+    [types_1.OPERATIONAL_AUDIENCE]: types_1.OPERATIONAL_AUDIENCE,
+};
+function readAudience(raw) {
+    return AUDIENCE_BY_NAME[raw ?? ""] ?? types_1.BUSINESS_AUDIENCE;
+}
+function forAudience(sends, audience) {
+    return sends.filter(AUDIENCE_KEEPS[audience]);
+}
+const PERCENT = 100;
+const DAY_MS = 86_400_000;
+const DAY_KEY_LENGTH = 10;
+const DELTA_PRECISION = 1;
+const DELIVERED_LIKE = [
+    "delivered",
+    "opened",
+    "clicked",
+    "unsubscribed",
+    "spam",
+];
+const OPENED_LIKE = ["opened", "clicked"];
+const ratio = (part, whole) => whole ? (part / whole) * PERCENT : 0;
+exports.ratio = ratio;
+const countIf = (sends, predicate) => sends.filter(predicate).length;
+const byStatus = (status) => (send) => send.status === status;
+function median(values) {
+    if (!values.length)
+        return 0;
+    const sorted = [...values].sort((left, right) => left - right);
+    return sorted[Math.floor(sorted.length / 2)];
+}
+function aggregate(sends) {
+    const delivered = countIf(sends, (send) => DELIVERED_LIKE.includes(send.status));
+    const opened = countIf(sends, (send) => OPENED_LIKE.includes(send.status));
+    const clicked = countIf(sends, byStatus("clicked"));
+    return {
+        sends: sends.length,
+        queued: countIf(sends, byStatus("queued")),
+        sent: countIf(sends, byStatus("sent")),
+        delivered,
+        opened,
+        clicked,
+        bounced: countIf(sends, byStatus("bounced")),
+        failed: countIf(sends, byStatus("failed")),
+        spam: countIf(sends, byStatus("spam")),
+        unsubscribed: countIf(sends, byStatus("unsubscribed")),
+        deliverability: (0, exports.ratio)(delivered, sends.length),
+        openRate: (0, exports.ratio)(opened, delivered),
+        clickRate: (0, exports.ratio)(clicked, delivered),
+        latencyMedian: median(sends.map((send) => send.latencyMs)),
+    };
+}
+function deltaPercent(current, previous) {
+    if (!previous)
+        return 0;
+    return Number((((current - previous) / previous) * PERCENT).toFixed(DELTA_PRECISION));
+}
+const dayKey = (date) => date.toISOString().slice(0, DAY_KEY_LENGTH);
+function dailySeries(sends, from, to) {
+    const start = from.getTime();
+    const span = to.getTime() - start;
+    const dayCount = Math.max(1, Math.ceil(span / DAY_MS));
+    const counts = Array.from({ length: dayCount }, () => 0);
+    for (const send of sends) {
+        const offset = new Date(send.createdAt).getTime() - start;
+        if (offset < 0 || offset >= dayCount * DAY_MS)
+            continue;
+        const index = Math.floor(offset / DAY_MS);
+        counts[index] = (counts[index] ?? 0) + 1;
+    }
+    return counts.map((y, index) => ({
+        x: dayKey(new Date(start + index * DAY_MS + DAY_MS / 2)),
+        y,
+    }));
+}
+function domainOf(email) {
+    return email.slice(email.lastIndexOf("@") + 1).toLowerCase();
+}
+function groupBy(items, key) {
+    const groups = new Map();
+    for (const item of items) {
+        const id = key(item);
+        groups.set(id, [...(groups.get(id) ?? []), item]);
+    }
+    return groups;
+}
+//# sourceMappingURL=metrics.js.map

package/dist/services/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/services/metrics.ts"],"names":[],"mappings":";;;AAmBA,oCAEC;AAED,kCAKC;AA6DD,8BAsBC;AAED,oCAKC;AAqBD,kCAmBC;AAED,4BAEC;AAED,0BAUC;AA7KD,oCAKkB;AAElB,MAAM,cAAc,GAAyD;IAC3E,CAAC,yBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM;IAC3C,CAAC,4BAAoB,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI;CACnC,CAAC;AAEF,MAAM,gBAAgB,GAAiC;IACrD,CAAC,yBAAiB,CAAC,EAAE,yBAAiB;IACtC,CAAC,4BAAoB,CAAC,EAAE,4BAAoB;CAC7C,CAAC;AAGF,SAAgB,YAAY,CAAC,GAA8B;IACzD,OAAO,gBAAgB,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,yBAAiB,CAAC;AAC1D,CAAC;AAED,SAAgB,WAAW,CACzB,KAAoB,EACpB,QAAsB;IAEtB,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;AAChD,CAAC;AA6BD,MAAM,OAAO,GAAG,GAAG,CAAC;AACpB,MAAM,MAAM,GAAG,UAAU,CAAC;AAC1B,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,MAAM,cAAc,GAAiB;IACnC,WAAW;IACX,QAAQ;IACR,SAAS;IACT,cAAc;IACd,MAAM;CACP,CAAC;AACF,MAAM,WAAW,GAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAEjD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE,CAC3D,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAD1B,QAAA,KAAK,SACqB;AAEvC,MAAM,OAAO,GAAG,CACd,KAAoB,EACpB,SAAyC,EACjC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;AAE5C,MAAM,QAAQ,GACZ,CAAC,MAAkB,EAAE,EAAE,CACvB,CAAC,IAAiB,EAAW,EAAE,CAC7B,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC;AAE3B,SAAS,MAAM,CAAC,MAAgB;IAC9B,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAW,CAAC;AACzD,CAAC;AAED,SAAgB,SAAS,CAAC,KAAoB;IAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CACxC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CACrC,CAAC;IACF,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3E,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACpD,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,MAAM;QACnB,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtC,SAAS;QACT,MAAM;QACN,OAAO;QACP,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC5C,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtC,YAAY,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QACtD,cAAc,EAAE,IAAA,aAAK,EAAC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;QAC9C,QAAQ,EAAE,IAAA,aAAK,EAAC,MAAM,EAAE,SAAS,CAAC;QAClC,SAAS,EAAE,IAAA,aAAK,EAAC,OAAO,EAAE,SAAS,CAAC;QACpC,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KAC3D,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,OAAe,EAAE,QAAgB;IAC5D,IAAI,CAAC,QAAQ;QAAE,OAAO,CAAC,CAAC;IACxB,OAAO,MAAM,CACX,CAAC,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CACvE,CAAC;AACJ,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,IAAU,EAAU,EAAE,CACpC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AAkB9C,SAAgB,WAAW,CACzB,KAAoB,EACpB,IAAU,EACV,EAAQ;IAER,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAAa,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACnE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC;QAC1D,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,IAAI,QAAQ,GAAG,MAAM;YAAE,SAAS;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;KACF,CAAC,CAAC,CAAC;AACN,CAAC;AAED,SAAgB,QAAQ,CAAC,KAAa;IACpC,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/D,CAAC;AAED,SAAgB,OAAO,CACrB,KAAU,EACV,GAAwB;IAExB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAe,CAAC;IACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;QACrB,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/services/notify.d.ts

@@ -0,0 +1,20 @@
+import type { NotificationData } from "@antelopejs/interface-dms/notifications/types";
+import { type SendEventType } from "../types";
+export interface BounceNotificationInput {
+    sendId: string;
+    templateSlug: string;
+    recipientEmail: string;
+    type: SendEventType;
+}
+export interface IdempotentNotificationTarget {
+    toUsersIdempotently(userIds: string[], idempotencyKey: string): Promise<void>;
+}
+export interface BounceNotificationData extends NotificationData {
+    linkTo: string;
+    params: Record<string, string | number>;
+}
+export declare function shouldNotify(type: SendEventType): boolean;
+export declare function bounceNotification(input: BounceNotificationInput): BounceNotificationData;
+export declare function bounceIdempotencyKey(input: BounceNotificationInput): string;
+export declare function deliverBounceNotification(target: IdempotentNotificationTarget, userIds: string[], input: BounceNotificationInput): Promise<void>;
+export declare function notifyBounce(tenantId: string, input: BounceNotificationInput): Promise<void>;

package/dist/services/notify.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldNotify = shouldNotify;
+exports.bounceNotification = bounceNotification;
+exports.bounceIdempotencyKey = bounceIdempotencyKey;
+exports.deliverBounceNotification = deliverBounceNotification;
+exports.notifyBounce = notifyBounce;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const db_1 = require("@antelopejs/interface-dms/db");
+const notifications_1 = require("@antelopejs/interface-dms/notifications");
+const types_1 = require("../types");
+const SENDS_PROBLEMS_LINK = "/modules/mailing/sends?tab=problems";
+const IDEMPOTENCY_KEY_SEPARATOR = ":";
+const BOUNCE_ICON = "i-ph-warning";
+const BOUNCE_TITLE = "$dms_mailing.notifications.bounce_title";
+const BOUNCE_DESCRIPTION = "$dms_mailing.notifications.bounce_description";
+function shouldNotify(type) {
+    return types_1.PROBLEM_STATUSES.includes(type);
+}
+function bounceNotification(input) {
+    return {
+        icon: BOUNCE_ICON,
+        title: BOUNCE_TITLE,
+        description: BOUNCE_DESCRIPTION,
+        subject: notifications_1.GeneralSubject,
+        linkTo: SENDS_PROBLEMS_LINK,
+        params: { slug: input.templateSlug, email: input.recipientEmail },
+    };
+}
+function bounceIdempotencyKey(input) {
+    return `${input.sendId}${IDEMPOTENCY_KEY_SEPARATOR}${input.type}`;
+}
+function deliverBounceNotification(target, userIds, input) {
+    return target.toUsersIdempotently(userIds, bounceIdempotencyKey(input));
+}
+async function tenantOwnerIds(tenantId) {
+    const owners = await (0, interface_database_decorators_1.GetModel)(db_1.TenantMemberModel, tenantId).listOwners();
+    return owners.map((owner) => owner.userId);
+}
+async function notifyBounce(tenantId, input) {
+    if (!shouldNotify(input.type))
+        return;
+    try {
+        const userIds = await tenantOwnerIds(tenantId);
+        if (userIds.length === 0)
+            return;
+        const data = bounceNotification(input);
+        const notification = (0, notifications_1.Notification)()
+            .icon(data.icon)
+            .title(data.title)
+            .description(data.description)
+            .subject(data.subject)
+            .linkTo(data.linkTo)
+            .params(data.params)
+            .build();
+        await deliverBounceNotification(notification, userIds, input);
+    }
+    catch (error) {
+        logging_1.Logging.Error(`[dms-mailing] Failed to notify the bounce of "${input.recipientEmail}": ${String(error)}`);
+    }
+}
+//# sourceMappingURL=notify.js.map

package/dist/services/notify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notify.js","sourceRoot":"","sources":["../../src/services/notify.ts"],"names":[],"mappings":";;AAgCA,oCAEC;AAED,gDAWC;AAED,oDAEC;AAED,8DAMC;AAOD,oCAuBC;AAzFD,gEAA6D;AAC7D,6FAAqE;AACrE,qDAAiE;AACjE,2EAGiD;AAEjD,oCAAgE;AAkBhE,MAAM,mBAAmB,GAAG,qCAAqC,CAAC;AAClE,MAAM,yBAAyB,GAAG,GAAG,CAAC;AACtC,MAAM,WAAW,GAAG,cAAc,CAAC;AACnC,MAAM,YAAY,GAAG,yCAAyC,CAAC;AAC/D,MAAM,kBAAkB,GAAG,+CAA+C,CAAC;AAE3E,SAAgB,YAAY,CAAC,IAAmB;IAC9C,OAAO,wBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAED,SAAgB,kBAAkB,CAChC,KAA8B;IAE9B,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,kBAAkB;QAC/B,OAAO,EAAE,8BAAc;QACvB,MAAM,EAAE,mBAAmB;QAC3B,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,cAAc,EAAE;KAClE,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAA8B;IACjE,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,yBAAyB,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;AACpE,CAAC;AAED,SAAgB,yBAAyB,CACvC,MAAoC,EACpC,OAAiB,EACjB,KAA8B;IAE9B,OAAO,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,QAAgB;IAC5C,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAQ,EAAC,sBAAiB,EAAE,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAC;IACxE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,KAA8B;IAE9B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO;IACtC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACjC,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,IAAA,4BAAY,GAAE;aAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;aACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;aACjB,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC;aAC7B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;aACrB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aACnB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aACnB,KAAK,EAAE,CAAC;QACX,MAAM,yBAAyB,CAAC,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CACX,iDAAiD,KAAK,CAAC,cAAc,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAC3F,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/services/permissions.d.ts

@@ -0,0 +1,2 @@
+import type { User } from "@antelopejs/interface-dms/auth/db";
+export declare function assertSendPermission(user: User, tenantId: string): Promise<void>;

package/dist/services/permissions.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertSendPermission = assertSendPermission;
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const db_1 = require("@antelopejs/interface-dms/db");
+const permissions_1 = require("@antelopejs/interface-dms/permissions");
+const constants_1 = require("../constants");
+const MISSING_SEND_PERMISSION = "$dms_mailing.errors.missing_send_permission";
+async function assertSendPermission(user, tenantId) {
+    const member = await (0, interface_database_decorators_1.GetModel)(db_1.TenantMemberModel, tenantId).getByUser(user._id);
+    const permissions = await (0, permissions_1.GetEffectiveUserPermissions)(user, tenantId, member?.roleIds ?? [], (0, interface_database_decorators_1.GetModel)(db_1.RoleModel, tenantId));
+    (0, interface_api_util_1.assert)(await (0, permissions_1.HasPermission)(permissions, constants_1.MAILING_SEND_PERMISSION), constants_1.HTTP_FORBIDDEN, MISSING_SEND_PERMISSION);
+}
+//# sourceMappingURL=permissions.js.map

package/dist/services/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../src/services/permissions.ts"],"names":[],"mappings":";;AAuBA,oDAkBC;AAzCD,uEAAwD;AACxD,6FAAqE;AACrE,qDAA4E;AAC5E,uEAG+C;AAE/C,4CAAuE;AAEvE,MAAM,uBAAuB,GAAG,6CAA6C,CAAC;AAavE,KAAK,UAAU,oBAAoB,CACxC,IAAU,EACV,QAAgB;IAEhB,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAQ,EAAC,sBAAiB,EAAE,QAAQ,CAAC,CAAC,SAAS,CAClE,IAAI,CAAC,GAAG,CACT,CAAC;IACF,MAAM,WAAW,GAAG,MAAM,IAAA,yCAA2B,EACnD,IAAI,EACJ,QAAQ,EACR,MAAM,EAAE,OAAO,IAAI,EAAE,EACrB,IAAA,wCAAQ,EAAC,cAAS,EAAE,QAAQ,CAAC,CAC9B,CAAC;IACF,IAAA,2BAAM,EACJ,MAAM,IAAA,2BAAa,EAAC,WAAW,EAAE,mCAAuB,CAAC,EACzD,0BAAc,EACd,uBAAuB,CACxB,CAAC;AACJ,CAAC"}

package/dist/services/provider.d.ts

@@ -0,0 +1,6 @@
+import { type ProviderCapabilities } from "@antelopejs/interface-email";
+export declare const CAPABILITIES_TTL_MS = 60000;
+type CapabilityLoader = () => Promise<ProviderCapabilities>;
+export declare function resetCapabilitiesCache(): void;
+export declare function readCapabilities(load?: CapabilityLoader, now?: number): Promise<ProviderCapabilities | null>;
+export {};

package/dist/services/provider.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CAPABILITIES_TTL_MS = void 0;
+exports.resetCapabilitiesCache = resetCapabilitiesCache;
+exports.readCapabilities = readCapabilities;
+const interface_email_1 = require("@antelopejs/interface-email");
+exports.CAPABILITIES_TTL_MS = 60_000;
+let entry;
+function resetCapabilitiesCache() {
+    entry = undefined;
+}
+async function readCapabilities(load = interface_email_1.GetCapabilities, now = Date.now()) {
+    if (entry && now - entry.at < exports.CAPABILITIES_TTL_MS)
+        return entry.value;
+    try {
+        const value = await load();
+        entry = { at: now, value };
+        return value;
+    }
+    catch {
+        entry = { at: now, value: null };
+        return null;
+    }
+}
+//# sourceMappingURL=provider.js.map

package/dist/services/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/services/provider.ts"],"names":[],"mappings":";;;AAuBA,wDAEC;AAOD,4CAaC;AA7CD,iEAGqC;AAQxB,QAAA,mBAAmB,GAAG,MAAM,CAAC;AAS1C,IAAI,KAA6B,CAAC;AAGlC,SAAgB,sBAAsB;IACpC,KAAK,GAAG,SAAS,CAAC;AACpB,CAAC;AAOM,KAAK,UAAU,gBAAgB,CACpC,OAAyB,iCAAe,EACxC,MAAc,IAAI,CAAC,GAAG,EAAE;IAExB,IAAI,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,EAAE,GAAG,2BAAmB;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC;IACtE,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3B,KAAK,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACP,KAAK,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/services/render.d.ts

@@ -0,0 +1,6 @@
+import type { ResolvedEmail } from "../types";
+export interface MailingEmailProps {
+    locale: string;
+    email: ResolvedEmail;
+}
+export declare function renderEmailHtml(email: ResolvedEmail, locale: string): Promise<string>;

package/dist/services/render.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderEmailHtml = renderEmailHtml;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const html_render_1 = require("@antelopejs/interface-dms/html-render");
+const config_1 = require("../config");
+const constants_1 = require("../constants");
+const engine_1 = require("../engine");
+const MailingEmailTemplate = (0, html_render_1.RegisterHtmlTemplate)(constants_1.EMAIL_TEMPLATE_NAME);
+async function renderEmailHtml(email, locale) {
+    if (!(0, config_1.getConfig)().useHtmlRender)
+        return (0, engine_1.renderFallbackHtml)(email, locale);
+    try {
+        return await (0, html_render_1.GenerateHtml)(MailingEmailTemplate, { locale, email });
+    }
+    catch (error) {
+        logging_1.Logging.Warn(`[dms-mailing] html-render unavailable, using fallback: ${String(error)}`);
+        return (0, engine_1.renderFallbackHtml)(email, locale);
+    }
+}
+//# sourceMappingURL=render.js.map

package/dist/services/render.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/services/render.ts"],"names":[],"mappings":";;AAmBA,0CAaC;AAhCD,gEAA6D;AAC7D,uEAG+C;AAC/C,sCAAsC;AACtC,4CAAmD;AACnD,sCAA+C;AAS/C,MAAM,oBAAoB,GACxB,IAAA,kCAAoB,EAAoB,+BAAmB,CAAC,CAAC;AAExD,KAAK,UAAU,eAAe,CACnC,KAAoB,EACpB,MAAc;IAEd,IAAI,CAAC,IAAA,kBAAS,GAAE,CAAC,aAAa;QAAE,OAAO,IAAA,2BAAkB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzE,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,0BAAY,EAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,IAAI,CACV,0DAA0D,MAAM,CAAC,KAAK,CAAC,EAAE,CAC1E,CAAC;QACF,OAAO,IAAA,2BAAkB,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC"}

package/dist/services/send.d.ts

@@ -0,0 +1,49 @@
+import { type BatchEmailMessageResponse, type BatchEmailParams, type BatchEmailResponse, type EmailAddress, type EmailParams, type EmailResponse } from "@antelopejs/interface-email";
+import type { SendTemplateParams, SendTemplateResult } from "@antelopejs/interface-dms-mailing";
+import type { MailingSettingsValues, SendStatus, TemplateContent } from "../types";
+export declare class SendError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+export interface PreparedSend {
+    content: TemplateContent;
+    locale: string;
+    templateId: string;
+    slug: string;
+    tenantId: string;
+}
+interface SendOutcome {
+    latencyMs: number;
+    provider?: string;
+    providerMessageId?: string;
+    error?: string;
+}
+export interface SendRecordInput {
+    prepared: PreparedSend;
+    to: EmailAddress;
+    params: SendTemplateParams;
+    status: SendStatus;
+    outcome: SendOutcome;
+}
+export interface DeliveredMessage {
+    to: EmailAddress;
+    status: SendStatus;
+    outcome: SendOutcome;
+}
+export interface DeliveryInput {
+    prepared: PreparedSend;
+    settings: MailingSettingsValues;
+    subject: string;
+    html: string;
+    recipients: EmailAddress[];
+}
+export type EmailSender = (params: EmailParams) => Promise<EmailResponse>;
+export type BatchEmailSender = (params: BatchEmailParams) => Promise<BatchEmailResponse>;
+export type SendRecorder = (tenantId: string, input: SendRecordInput) => Promise<string>;
+export declare function matchBatchResponses(recipients: EmailAddress[], responses: BatchEmailMessageResponse[], batchLatencyMs: number): DeliveredMessage[];
+export declare function deliverEach(input: DeliveryInput, send?: EmailSender): Promise<DeliveredMessage[]>;
+export declare function deliverBatch(input: DeliveryInput, sendBatch?: BatchEmailSender): Promise<DeliveredMessage[]>;
+export declare function recordAll(prepared: PreparedSend, params: SendTemplateParams, delivered: DeliveredMessage[], save?: SendRecorder): Promise<SendTemplateResult[]>;
+export declare function aggregateResults(results: SendTemplateResult[]): SendTemplateResult;
+export declare function sendTemplate(slug: string, params: SendTemplateParams): Promise<SendTemplateResult>;
+export {};