@antelopejs/dms-mailing 0.3.4 → 0.4.1

package/dist/services/settings.d.ts

@@ -1,5 +1,10 @@
 import { type MailingSettingsValues, type TemplateCategory } from "../types";
+export declare const WEBHOOK_SECRET_BYTES = 24;
 export declare function findSettings(tenantId: string): Promise<MailingSettingsValues | undefined>;
 export declare function getSettings(tenantId: string): Promise<MailingSettingsValues>;
 export declare function saveSettings(tenantId: string, values: MailingSettingsValues): Promise<MailingSettingsValues>;
 export declare function findCategory(categories: TemplateCategory[], id: string): TemplateCategory | undefined;
+export type MissingVariablesPolicy = "refuse" | "send";
+export declare function missingVariablesPolicy(values: MailingSettingsValues): MissingVariablesPolicy;
+export declare function clearedToEmpty(patch: Record<string, unknown>): Record<string, unknown>;
+export declare function mergeSettingsPatch(current: MailingSettingsValues, patch: Record<string, unknown>): MailingSettingsValues;

package/dist/services/settings.js

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOK_SECRET_BYTES = void 0;
 exports.findSettings = findSettings;
 exports.getSettings = getSettings;
 exports.saveSettings = saveSettings;
 exports.findCategory = findCategory;
+exports.missingVariablesPolicy = missingVariablesPolicy;
+exports.clearedToEmpty = clearedToEmpty;
+exports.mergeSettingsPatch = mergeSettingsPatch;
 const node_crypto_1 = require("node:crypto");
 const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
 const constants_1 = require("../constants");
 const db_1 = require("../db");
 const types_1 = require("../types");
-const SECRET_BYTES = 24;
+exports.WEBHOOK_SECRET_BYTES = 24;
 function defaults() {
     return {
         fallbackLocale: constants_1.DEFAULT_FALLBACK_LOCALE,
@@ -18,7 +22,7 @@ function defaults() {
         senderName: "",
         senderEmail: "",
         replyTo: "",
-        webhookSecret: (0, node_crypto_1.randomBytes)(SECRET_BYTES).toString("hex"),
+        webhookSecret: (0, node_crypto_1.randomBytes)(exports.WEBHOOK_SECRET_BYTES).toString("hex"),
         categories: types_1.DEFAULT_CATEGORIES,
     };
 }
@@ -39,7 +43,7 @@ function toRow(values) {
     return { ...rest, json_categories: JSON.stringify(categories) };
 }
 async function findSettings(tenantId) {
-    const existing = await (0, interface_database_decorators_1.GetModel)(db_1.SettingsModel, tenantId).getSingleton(tenantId);
+    const existing = await (0, interface_database_decorators_1.GetModel)(db_1.SettingsModel, tenantId).get(tenantId);
     return existing ? toValues(existing) : undefined;
 }
 async function insertKeyedSettings(tenantId, values) {
@@ -65,14 +69,31 @@ async function getSettings(tenantId) {
 }
 async function saveSettings(tenantId, values) {
     const model = (0, interface_database_decorators_1.GetModel)(db_1.SettingsModel, tenantId);
-    const existing = await model.getSingleton(tenantId);
-    if (existing)
-        await model.update(existing._id, toRow(values));
-    else if (!(await insertKeyedSettings(tenantId, values)))
+    const isStored = Boolean(await model.get(tenantId));
+    if (isStored || !(await insertKeyedSettings(tenantId, values)))
         await model.update(tenantId, toRow(values));
     return values;
 }
 function findCategory(categories, id) {
     return categories.find((category) => category.id === id);
 }
+const REFUSE_POLICY = "refuse";
+const SEND_POLICY = "send";
+function missingVariablesPolicy(values) {
+    return values.blockOnMissingVariables ? REFUSE_POLICY : SEND_POLICY;
+}
+const MISSING_VARIABLES_KEY = "missingVariables";
+const CLEARED_VALUE = "";
+function clearedToEmpty(patch) {
+    return Object.fromEntries(Object.entries(patch).map(([key, value]) => [key, value ?? CLEARED_VALUE]));
+}
+function mergeSettingsPatch(current, patch) {
+    const written = Object.fromEntries(Object.entries(clearedToEmpty(patch)).filter(([key]) => key !== MISSING_VARIABLES_KEY));
+    const policy = patch.missingVariables;
+    const isChoice = policy === REFUSE_POLICY || policy === SEND_POLICY;
+    const guard = isChoice && !("blockOnMissingVariables" in patch)
+        ? { blockOnMissingVariables: policy === REFUSE_POLICY }
+        : {};
+    return { ...current, ...written, ...guard };
+}
 //# sourceMappingURL=settings.js.map

package/dist/services/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/services/settings.ts"],"names":[],"mappings":";;AA+CA,oCAOC;AAqBD,kCAQC;AAED,oCAUC;AAED,oCAKC;AAtGD,6CAA0C;AAC1C,6FAAqE;AACrE,4CAGsB;AACtB,8BAA4D;AAC5D,oCAIkB;AAElB,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB,SAAS,QAAQ;IACf,OAAO;QACL,cAAc,EAAE,mCAAuB;QACvC,gBAAgB,EAAE,sCAA0B;QAC5C,uBAAuB,EAAE,KAAK;QAC9B,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,IAAA,yBAAW,EAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QACxD,UAAU,EAAE,0BAAkB;KAC/B,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,GAAoB;IACpC,OAAO;QACL,cAAc,EAAE,GAAG,CAAC,cAAc;QAClC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;QACtC,uBAAuB,EAAE,GAAG,CAAC,uBAAuB;QACpD,UAAU,EAAE,GAAG,CAAC,UAAU;QAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAuB;KAClE,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CAAC,MAA6B;IAC1C,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACvC,OAAO,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;AAClE,CAAC;AAGM,KAAK,UAAU,YAAY,CAChC,QAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC,YAAY,CACnE,QAAQ,CACT,CAAC;IACF,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnD,CAAC;AAOD,KAAK,UAAU,mBAAmB,CAChC,QAAgB,EAChB,MAA6B;IAE7B,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC;IAChD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,QAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,MAAM,OAAO,GAAG,QAAQ,EAAE,CAAC;IAC3B,IAAI,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IACjE,OAAO,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,CAA0B,CAAC;AACjE,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,MAA6B;IAE7B,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACpD,IAAI,QAAQ;QAAE,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;SACzD,IAAI,CAAC,CAAC,MAAM,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,YAAY,CAC1B,UAA8B,EAC9B,EAAU;IAEV,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3D,CAAC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/services/settings.ts"],"names":[],"mappings":";;;AA+CA,oCAKC;AAqBD,kCAQC;AAED,oCASC;AAED,oCAKC;AAQD,wDAIC;AAMD,wCAMC;AAOD,gDAgBC;AAlJD,6CAA0C;AAC1C,6FAAqE;AACrE,4CAGsB;AACtB,8BAA4D;AAC5D,oCAIkB;AAEL,QAAA,oBAAoB,GAAG,EAAE,CAAC;AAEvC,SAAS,QAAQ;IACf,OAAO;QACL,cAAc,EAAE,mCAAuB;QACvC,gBAAgB,EAAE,sCAA0B;QAC5C,uBAAuB,EAAE,KAAK;QAC9B,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,IAAA,yBAAW,EAAC,4BAAoB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChE,UAAU,EAAE,0BAAkB;KAC/B,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,GAAoB;IACpC,OAAO;QACL,cAAc,EAAE,GAAG,CAAC,cAAc;QAClC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;QACtC,uBAAuB,EAAE,GAAG,CAAC,uBAAuB;QACpD,UAAU,EAAE,GAAG,CAAC,UAAU;QAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAuB;KAClE,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CAAC,MAA6B;IAC1C,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACvC,OAAO,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;AAClE,CAAC;AAGM,KAAK,UAAU,YAAY,CAChC,QAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvE,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnD,CAAC;AAOD,KAAK,UAAU,mBAAmB,CAChC,QAAgB,EAChB,MAA6B;IAE7B,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC;IAChD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,QAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,MAAM,OAAO,GAAG,QAAQ,EAAE,CAAC;IAC3B,IAAI,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IACjE,OAAO,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,CAA0B,CAAC;AACjE,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,MAA6B;IAE7B,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpD,IAAI,QAAQ,IAAI,CAAC,CAAC,MAAM,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,YAAY,CAC1B,UAA8B,EAC9B,EAAU;IAEV,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3D,CAAC;AAKD,MAAM,aAAa,GAA2B,QAAQ,CAAC;AACvD,MAAM,WAAW,GAA2B,MAAM,CAAC;AAEnD,SAAgB,sBAAsB,CACpC,MAA6B;IAE7B,OAAO,MAAM,CAAC,uBAAuB,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC;AACtE,CAAC;AAGD,MAAM,qBAAqB,GAAG,kBAAkB,CAAC;AACjD,MAAM,aAAa,GAAG,EAAE,CAAC;AAEzB,SAAgB,cAAc,CAC5B,KAA8B;IAE9B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,IAAI,aAAa,CAAC,CAAC,CAC3E,CAAC;AACJ,CAAC;AAOD,SAAgB,kBAAkB,CAChC,OAA8B,EAC9B,KAA8B;IAE9B,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAC1C,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,qBAAqB,CACzC,CACF,CAAC;IACF,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAAC;IACtC,MAAM,QAAQ,GAAG,MAAM,KAAK,aAAa,IAAI,MAAM,KAAK,WAAW,CAAC;IACpE,MAAM,KAAK,GACT,QAAQ,IAAI,CAAC,CAAC,yBAAyB,IAAI,KAAK,CAAC;QAC/C,CAAC,CAAC,EAAE,uBAAuB,EAAE,MAAM,KAAK,aAAa,EAAE;QACvD,CAAC,CAAC,EAAE,CAAC;IACT,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,EAA2B,CAAC;AACvE,CAAC"}

package/dist/services/starters.d.ts

@@ -0,0 +1,15 @@
+import type { MailingTemplate } from "../db";
+import type { TemplateContent, VariableDefinition } from "../types";
+export interface StarterTemplate {
+    id: string;
+    name: string;
+    slug: string;
+    category: string;
+    content: TemplateContent;
+    variables: VariableDefinition[];
+    testData: Record<string, unknown>;
+    testDataFor: (locale: string) => Record<string, unknown>;
+}
+export declare const STARTER_TEMPLATES: StarterTemplate[];
+export declare function findStarter(id: string): StarterTemplate | undefined;
+export declare function starterFields(starter: StarterTemplate, locale?: string): Partial<MailingTemplate>;

package/dist/services/starters.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STARTER_TEMPLATES = void 0;
+exports.findStarter = findStarter;
+exports.starterFields = starterFields;
+const engine_1 = require("../engine");
+const templates_1 = require("./templates");
+const DEFAULT_TEST_DATA_LOCALE = "en";
+const STARTER_CURRENCY = "EUR";
+function formattingLocale(locale) {
+    try {
+        return (Intl.NumberFormat.supportedLocalesOf(locale)[0] ??
+            DEFAULT_TEST_DATA_LOCALE);
+    }
+    catch {
+        return DEFAULT_TEST_DATA_LOCALE;
+    }
+}
+const ORDER_LINE_NAMES = {
+    en: "Ergo chair · Graphite × 4",
+    fr: "Fauteuil ergonomique · Graphite × 4",
+};
+const LOCALE_PARTS = /[-_]/;
+function inLanguageOf(texts, locale) {
+    const language = locale.toLowerCase().split(LOCALE_PARTS)[0] ?? "";
+    return texts[language] ?? texts[DEFAULT_TEST_DATA_LOCALE];
+}
+function money(amount, locale) {
+    return new Intl.NumberFormat(formattingLocale(locale), {
+        style: "currency",
+        currency: STARTER_CURRENCY,
+    }).format(amount);
+}
+const HEADING_SIZE = 26;
+function localeContent(locale, copy, extra, buttonHref) {
+    const button = copy.button
+        ? [
+            {
+                id: "cta",
+                type: "button",
+                text: copy.button,
+                href: buttonHref,
+                align: "left",
+                visibleIf: null,
+            },
+        ]
+        : [];
+    return {
+        subject: copy.subject,
+        preheader: copy.preheader,
+        blocks: [
+            {
+                id: "heading",
+                type: "heading",
+                text: copy.heading,
+                align: "left",
+                size: HEADING_SIZE,
+                visibleIf: null,
+            },
+            {
+                id: "intro",
+                type: "paragraph",
+                text: copy.body,
+                align: "left",
+                visibleIf: null,
+            },
+            ...extra,
+            ...button,
+            (0, templates_1.footerBlock)(locale, copy.footer),
+        ],
+    };
+}
+const orderLines = [
+    {
+        id: "lines",
+        type: "list",
+        source: "order.lines",
+        labelPath: "name",
+        valuePath: "total",
+        visibleIf: null,
+    },
+    {
+        id: "total",
+        type: "total",
+        label: "Total",
+        value: "{{order.total}}",
+        visibleIf: null,
+    },
+];
+const v = (path, type, required = true) => ({ path, type, required });
+const ORDER_TOTAL = 1556;
+const INVOICE_AMOUNT = 318.9;
+const STARTER_SOURCES = [
+    {
+        id: "order-confirmed",
+        name: "Order confirmation",
+        slug: "order-confirmed",
+        category: "orders",
+        variables: [
+            v("customer.firstName", "string"),
+            v("order.number", "string"),
+            v("order.total", "money"),
+            v("order.lines", "array"),
+            v("order.url", "url"),
+        ],
+        testDataFor: (locale) => ({
+            customer: { firstName: "Julie" },
+            order: {
+                number: "#10482",
+                total: money(ORDER_TOTAL, locale),
+                url: "https://example.com/orders/10482",
+                lines: [
+                    {
+                        name: inLanguageOf(ORDER_LINE_NAMES, locale),
+                        total: money(ORDER_TOTAL, locale),
+                    },
+                ],
+            },
+        }),
+        content: {
+            locales: {
+                en: localeContent("en", {
+                    subject: "Thanks for your order {{order.number}}",
+                    preheader: "We're getting it ready. Here's your summary.",
+                    heading: "Thanks for your order, {{customer.firstName}}!",
+                    body: "We've received order {{order.number}} and we're getting it ready.",
+                    button: "Track your order",
+                    footer: "You are receiving this e-mail because you placed an order with us.",
+                }, orderLines, "{{order.url}}"),
+                fr: localeContent("fr", {
+                    subject: "Merci pour votre commande {{order.number}}",
+                    preheader: "Nous la préparons. Voici votre récapitulatif.",
+                    heading: "Merci pour votre commande, {{customer.firstName}} !",
+                    body: "Nous avons bien reçu la commande {{order.number}} et nous la préparons.",
+                    button: "Suivre ma commande",
+                    footer: "Vous recevez cet e-mail suite à votre commande.",
+                }, orderLines, "{{order.url}}"),
+            },
+        },
+    },
+    {
+        id: "order-shipped",
+        name: "Shipping update",
+        slug: "order-shipped",
+        category: "orders",
+        variables: [
+            v("customer.firstName", "string"),
+            v("order.number", "string"),
+            v("shipment.trackingUrl", "url"),
+        ],
+        testDataFor: () => ({
+            customer: { firstName: "Julie" },
+            order: { number: "#10482" },
+            shipment: { trackingUrl: "https://example.com/track/10482" },
+        }),
+        content: {
+            locales: {
+                en: localeContent("en", {
+                    subject: "Your order {{order.number}} has shipped",
+                    preheader: "It's on its way.",
+                    heading: "Your order {{order.number}} has shipped",
+                    body: "Good news {{customer.firstName}}, your parcel is on its way.",
+                    button: "Track the parcel",
+                    footer: "You are receiving this e-mail because you placed an order with us.",
+                }, [], "{{shipment.trackingUrl}}"),
+                fr: localeContent("fr", {
+                    subject: "Votre commande {{order.number}} est expédiée",
+                    preheader: "Elle est en route.",
+                    heading: "Votre commande {{order.number}} est expédiée",
+                    body: "Bonne nouvelle {{customer.firstName}}, votre colis est en route.",
+                    button: "Suivre le colis",
+                    footer: "Vous recevez cet e-mail suite à votre commande.",
+                }, [], "{{shipment.trackingUrl}}"),
+            },
+        },
+    },
+    {
+        id: "password-reset",
+        name: "Password reset",
+        slug: "password-reset",
+        category: "account",
+        variables: [v("user.firstName", "string"), v("reset.url", "url")],
+        testDataFor: () => ({
+            user: { firstName: "Julie" },
+            reset: { url: "https://example.com/reset/abc123" },
+        }),
+        content: {
+            locales: {
+                en: localeContent("en", {
+                    subject: "Reset your password",
+                    preheader: "The link works for one hour.",
+                    heading: "Reset your password",
+                    body: "Hi {{user.firstName}}, click the button below to choose a new password. If you didn't ask for it, ignore this e-mail.",
+                    button: "Choose a new password",
+                    footer: "You are receiving this e-mail because a password reset was requested for your account.",
+                }, [], "{{reset.url}}"),
+                fr: localeContent("fr", {
+                    subject: "Réinitialisez votre mot de passe",
+                    preheader: "Le lien est valable une heure.",
+                    heading: "Réinitialisez votre mot de passe",
+                    body: "Bonjour {{user.firstName}}, cliquez sur le bouton ci-dessous pour choisir un nouveau mot de passe. Si vous ne l'avez pas demandé, ignorez cet e-mail.",
+                    button: "Choisir un nouveau mot de passe",
+                    footer: "Vous recevez cet e-mail car une réinitialisation du mot de passe a été demandée pour votre compte.",
+                }, [], "{{reset.url}}"),
+            },
+        },
+    },
+    {
+        id: "invoice-ready",
+        name: "Invoice available",
+        slug: "invoice-ready",
+        category: "billing",
+        variables: [
+            v("customer.firstName", "string"),
+            v("invoice.number", "string"),
+            v("invoice.amount", "money"),
+            v("invoice.url", "url"),
+        ],
+        testDataFor: (locale) => ({
+            customer: { firstName: "Julie" },
+            invoice: {
+                number: "INV-2026-0918",
+                amount: money(INVOICE_AMOUNT, locale),
+                url: "https://example.com/invoices/0918",
+            },
+        }),
+        content: {
+            locales: {
+                en: localeContent("en", {
+                    subject: "Invoice {{invoice.number}} is available",
+                    preheader: "Amount due: {{invoice.amount}}.",
+                    heading: "Invoice {{invoice.number}} is available",
+                    body: "Hi {{customer.firstName}}, your invoice of {{invoice.amount}} is ready.",
+                    button: "Download the invoice",
+                    footer: "You are receiving this e-mail because an invoice was issued for your account.",
+                }, [], "{{invoice.url}}"),
+                fr: localeContent("fr", {
+                    subject: "La facture {{invoice.number}} est disponible",
+                    preheader: "Montant dû : {{invoice.amount}}.",
+                    heading: "La facture {{invoice.number}} est disponible",
+                    body: "Bonjour {{customer.firstName}}, votre facture de {{invoice.amount}} est prête.",
+                    button: "Télécharger la facture",
+                    footer: "Vous recevez cet e-mail car une facture a été émise pour votre compte.",
+                }, [], "{{invoice.url}}"),
+            },
+        },
+    },
+];
+exports.STARTER_TEMPLATES = STARTER_SOURCES.map((starter) => ({
+    ...starter,
+    testData: starter.testDataFor(DEFAULT_TEST_DATA_LOCALE),
+    content: (0, engine_1.footerForCategory)(starter.content, starter.category),
+}));
+function findStarter(id) {
+    return exports.STARTER_TEMPLATES.find((starter) => starter.id === id);
+}
+function starterFields(starter, locale = DEFAULT_TEST_DATA_LOCALE) {
+    return {
+        ...(0, templates_1.blankFields)(starter.content),
+        json_variables: JSON.stringify(starter.variables),
+        json_test_data: JSON.stringify(starter.testDataFor(locale)),
+    };
+}
+//# sourceMappingURL=starters.js.map

package/dist/services/starters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"starters.js","sourceRoot":"","sources":["../../src/services/starters.ts"],"names":[],"mappings":";;;AA6WA,kCAEC;AAMD,sCASC;AAvXD,sCAA8C;AAC9C,2CAAuD;AAsBvD,MAAM,wBAAwB,GAAG,IAAI,CAAC;AACtC,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAG/B,SAAS,gBAAgB,CAAC,MAAc;IACtC,IAAI,CAAC;QACH,OAAO,CACL,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC/C,wBAAwB,CACzB,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,wBAAwB,CAAC;IAClC,CAAC;AACH,CAAC;AAGD,MAAM,gBAAgB,GAA2B;IAC/C,EAAE,EAAE,2BAA2B;IAC/B,EAAE,EAAE,qCAAqC;CAC1C,CAAC;AACF,MAAM,YAAY,GAAG,MAAM,CAAC;AAG5B,SAAS,YAAY,CAAC,KAA6B,EAAE,MAAc;IACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACnE,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAK,KAAK,CAAC,wBAAwB,CAAY,CAAC;AACxE,CAAC;AAGD,SAAS,KAAK,CAAC,MAAc,EAAE,MAAc;IAC3C,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QACrD,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,gBAAgB;KAC3B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACpB,CAAC;AAYD,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB,SAAS,aAAa,CACpB,MAAc,EACd,IAAiB,EACjB,KAAc,EACd,UAAkB;IAElB,MAAM,MAAM,GAAY,IAAI,CAAC,MAAM;QACjC,CAAC,CAAC;YACE;gBACE,EAAE,EAAE,KAAK;gBACT,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE,MAAM;gBACb,SAAS,EAAE,IAAI;aAChB;SACF;QACH,CAAC,CAAC,EAAE,CAAC;IACP,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,MAAM,EAAE;YACN;gBACE,EAAE,EAAE,SAAS;gBACb,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,IAAI,CAAC,OAAO;gBAClB,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE,IAAI;aAChB;YACD;gBACE,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,MAAM;gBACb,SAAS,EAAE,IAAI;aAChB;YACD,GAAG,KAAK;YACR,GAAG,MAAM;YACT,IAAA,uBAAW,EAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;SACjC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAY;IAC1B;QACE,EAAE,EAAE,OAAO;QACX,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,MAAM;QACjB,SAAS,EAAE,OAAO;QAClB,SAAS,EAAE,IAAI;KAChB;IACD;QACE,EAAE,EAAE,OAAO;QACX,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,iBAAiB;QACxB,SAAS,EAAE,IAAI;KAChB;CACF,CAAC;AAEF,MAAM,CAAC,GAAG,CACR,IAAY,EACZ,IAAgC,EAChC,QAAQ,GAAG,IAAI,EACK,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEpD,MAAM,WAAW,GAAG,IAAI,CAAC;AACzB,MAAM,cAAc,GAAG,KAAK,CAAC;AAE7B,MAAM,eAAe,GAAoB;IACvC;QACE,EAAE,EAAE,iBAAiB;QACrB,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE,QAAQ;QAClB,SAAS,EAAE;YACT,CAAC,CAAC,oBAAoB,EAAE,QAAQ,CAAC;YACjC,CAAC,CAAC,cAAc,EAAE,QAAQ,CAAC;YAC3B,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC;YACzB,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC;YACzB,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC;SACtB;QACD,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACxB,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE;YAChC,KAAK,EAAE;gBACL,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC;gBACjC,GAAG,EAAE,kCAAkC;gBACvC,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,MAAM,CAAC;wBAC5C,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC;qBAClC;iBACF;aACF;SACF,CAAC;QACF,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,wCAAwC;oBACjD,SAAS,EAAE,8CAA8C;oBACzD,OAAO,EAAE,gDAAgD;oBACzD,IAAI,EAAE,mEAAmE;oBACzE,MAAM,EAAE,kBAAkB;oBAC1B,MAAM,EACJ,oEAAoE;iBACvE,EACD,UAAU,EACV,eAAe,CAChB;gBACD,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,4CAA4C;oBACrD,SAAS,EAAE,+CAA+C;oBAC1D,OAAO,EAAE,qDAAqD;oBAC9D,IAAI,EAAE,yEAAyE;oBAC/E,MAAM,EAAE,oBAAoB;oBAC5B,MAAM,EAAE,iDAAiD;iBAC1D,EACD,UAAU,EACV,eAAe,CAChB;aACF;SACF;KACF;IACD;QACE,EAAE,EAAE,eAAe;QACnB,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,QAAQ;QAClB,SAAS,EAAE;YACT,CAAC,CAAC,oBAAoB,EAAE,QAAQ,CAAC;YACjC,CAAC,CAAC,cAAc,EAAE,QAAQ,CAAC;YAC3B,CAAC,CAAC,sBAAsB,EAAE,KAAK,CAAC;SACjC;QACD,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;YAClB,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE;YAChC,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YAC3B,QAAQ,EAAE,EAAE,WAAW,EAAE,iCAAiC,EAAE;SAC7D,CAAC;QACF,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,yCAAyC;oBAClD,SAAS,EAAE,kBAAkB;oBAC7B,OAAO,EAAE,yCAAyC;oBAClD,IAAI,EAAE,8DAA8D;oBACpE,MAAM,EAAE,kBAAkB;oBAC1B,MAAM,EACJ,oEAAoE;iBACvE,EACD,EAAE,EACF,0BAA0B,CAC3B;gBACD,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,8CAA8C;oBACvD,SAAS,EAAE,oBAAoB;oBAC/B,OAAO,EAAE,8CAA8C;oBACvD,IAAI,EAAE,kEAAkE;oBACxE,MAAM,EAAE,iBAAiB;oBACzB,MAAM,EAAE,iDAAiD;iBAC1D,EACD,EAAE,EACF,0BAA0B,CAC3B;aACF;SACF;KACF;IACD;QACE,EAAE,EAAE,gBAAgB;QACpB,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,gBAAgB;QACtB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,CAAC,CAAC,CAAC,gBAAgB,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QACjE,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;YAClB,IAAI,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE;YAC5B,KAAK,EAAE,EAAE,GAAG,EAAE,kCAAkC,EAAE;SACnD,CAAC;QACF,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,qBAAqB;oBAC9B,SAAS,EAAE,8BAA8B;oBACzC,OAAO,EAAE,qBAAqB;oBAC9B,IAAI,EAAE,uHAAuH;oBAC7H,MAAM,EAAE,uBAAuB;oBAC/B,MAAM,EACJ,wFAAwF;iBAC3F,EACD,EAAE,EACF,eAAe,CAChB;gBACD,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,kCAAkC;oBAC3C,SAAS,EAAE,gCAAgC;oBAC3C,OAAO,EAAE,kCAAkC;oBAC3C,IAAI,EAAE,uJAAuJ;oBAC7J,MAAM,EAAE,iCAAiC;oBACzC,MAAM,EACJ,oGAAoG;iBACvG,EACD,EAAE,EACF,eAAe,CAChB;aACF;SACF;KACF;IACD;QACE,EAAE,EAAE,eAAe;QACnB,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE;YACT,CAAC,CAAC,oBAAoB,EAAE,QAAQ,CAAC;YACjC,CAAC,CAAC,gBAAgB,EAAE,QAAQ,CAAC;YAC7B,CAAC,CAAC,gBAAgB,EAAE,OAAO,CAAC;YAC5B,CAAC,CAAC,aAAa,EAAE,KAAK,CAAC;SACxB;QACD,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACxB,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE;YAChC,OAAO,EAAE;gBACP,MAAM,EAAE,eAAe;gBACvB,MAAM,EAAE,KAAK,CAAC,cAAc,EAAE,MAAM,CAAC;gBACrC,GAAG,EAAE,mCAAmC;aACzC;SACF,CAAC;QACF,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,yCAAyC;oBAClD,SAAS,EAAE,iCAAiC;oBAC5C,OAAO,EAAE,yCAAyC;oBAClD,IAAI,EAAE,yEAAyE;oBAC/E,MAAM,EAAE,sBAAsB;oBAC9B,MAAM,EACJ,+EAA+E;iBAClF,EACD,EAAE,EACF,iBAAiB,CAClB;gBACD,EAAE,EAAE,aAAa,CACf,IAAI,EACJ;oBACE,OAAO,EAAE,8CAA8C;oBACvD,SAAS,EAAE,kCAAkC;oBAC7C,OAAO,EAAE,8CAA8C;oBACvD,IAAI,EAAE,gFAAgF;oBACtF,MAAM,EAAE,wBAAwB;oBAChC,MAAM,EACJ,wEAAwE;iBAC3E,EACD,EAAE,EACF,iBAAiB,CAClB;aACF;SACF;KACF;CACF,CAAC;AAOW,QAAA,iBAAiB,GAAsB,eAAe,CAAC,GAAG,CACrE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACZ,GAAG,OAAO;IACV,QAAQ,EAAE,OAAO,CAAC,WAAW,CAAC,wBAAwB,CAAC;IACvD,OAAO,EAAE,IAAA,0BAAiB,EAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC;CAC9D,CAAC,CACH,CAAC;AAEF,SAAgB,WAAW,CAAC,EAAU;IACpC,OAAO,yBAAiB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAChE,CAAC;AAMD,SAAgB,aAAa,CAC3B,OAAwB,EACxB,SAAiB,wBAAwB;IAEzC,OAAO;QACL,GAAG,IAAA,uBAAW,EAAC,OAAO,CAAC,OAAO,CAAC;QAC/B,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;QACjD,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;KAC5D,CAAC;AACJ,CAAC"}

package/dist/services/suppressions.d.ts

@@ -0,0 +1,20 @@
+import { type MailingSuppression, type SendSummary } from "../db";
+import type { SendEventType, SuppressionReason, SuppressionSummary } from "../types";
+export interface SuppressingEvent {
+    type: SendEventType;
+    isTest: boolean;
+    isSoftBounce: boolean;
+}
+export interface SuppressionEntry {
+    email: string;
+    reason: SuppressionReason;
+    sendId?: string;
+    detail?: string;
+    createdBy?: string;
+}
+export declare function suppressionReasonOf(event: SuppressingEvent): SuppressionReason | null;
+export declare function summarizeSuppression(row: MailingSuppression): SuppressionSummary;
+export declare function suppressAddress(tenantId: string, entry: SuppressionEntry): Promise<boolean>;
+export declare function suppressionsOf(tenantId: string, emails: string[]): Promise<Map<string, MailingSuppression>>;
+export declare function suppressedSendIds(tenantId: string, sends: Pick<SendSummary, "_id" | "recipientEmail">[]): Promise<Set<string>>;
+export declare function findSuppression(tenantId: string, email: string): Promise<SuppressionSummary | null>;

package/dist/services/suppressions.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.suppressionReasonOf = suppressionReasonOf;
+exports.summarizeSuppression = summarizeSuppression;
+exports.suppressAddress = suppressAddress;
+exports.suppressionsOf = suppressionsOf;
+exports.suppressedSendIds = suppressedSendIds;
+exports.findSuppression = findSuppression;
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const db_1 = require("../db");
+const REASON_BY_EVENT = {
+    bounced: "hard_bounce",
+    spam: "complaint",
+    unsubscribed: "unsubscribe",
+};
+const REASONS_FROM_TESTS = new Set(["hard_bounce"]);
+function suppressionReasonOf(event) {
+    const reason = REASON_BY_EVENT[event.type];
+    if (!reason)
+        return null;
+    if (event.type === "bounced" && event.isSoftBounce)
+        return null;
+    if (event.isTest && !REASONS_FROM_TESTS.has(reason))
+        return null;
+    return reason;
+}
+function summarizeSuppression(row) {
+    return {
+        id: row._id,
+        email: row.email,
+        reason: row.reason,
+        createdAt: row.createdAt,
+        sendId: row.sendId || undefined,
+    };
+}
+function suppressAddress(tenantId, entry) {
+    return (0, interface_database_decorators_1.GetModel)(db_1.SuppressionModel, tenantId).add(entry);
+}
+async function suppressionsOf(tenantId, emails) {
+    const rows = await (0, interface_database_decorators_1.GetModel)(db_1.SuppressionModel, tenantId).listByEmails(emails);
+    return new Map(rows.map((row) => [(0, db_1.normalizeAddress)(row.email), row]));
+}
+async function suppressedSendIds(tenantId, sends) {
+    const entries = await suppressionsOf(tenantId, sends.map((send) => send.recipientEmail));
+    return new Set(sends
+        .filter((send) => entries.has((0, db_1.normalizeAddress)(send.recipientEmail)))
+        .map((send) => send._id));
+}
+async function findSuppression(tenantId, email) {
+    const row = await (0, interface_database_decorators_1.GetModel)(db_1.SuppressionModel, tenantId).findByEmail(email);
+    return row ? summarizeSuppression(row) : null;
+}
+//# sourceMappingURL=suppressions.js.map

package/dist/services/suppressions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressions.js","sourceRoot":"","sources":["../../src/services/suppressions.ts"],"names":[],"mappings":";;AA8CA,kDAQC;AAED,oDAUC;AAOD,0CAKC;AAGD,wCAMC;AAMD,8CAaC;AAGD,0CAMC;AAnHD,6FAAqE;AACrE,8BAKe;AAuBf,MAAM,eAAe,GAAsD;IACzE,OAAO,EAAE,aAAa;IACtB,IAAI,EAAE,WAAW;IACjB,YAAY,EAAE,aAAa;CAC5B,CAAC;AAOF,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;AAMvE,SAAgB,mBAAmB,CACjC,KAAuB;IAEvB,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACzB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,YAAY;QAAE,OAAO,IAAI,CAAC;IAChE,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IACjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,oBAAoB,CAClC,GAAuB;IAEvB,OAAO;QACL,EAAE,EAAE,GAAG,CAAC,GAAG;QACX,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,SAAS;KAChC,CAAC;AACJ,CAAC;AAOD,SAAgB,eAAe,CAC7B,QAAgB,EAChB,KAAuB;IAEvB,OAAO,IAAA,wCAAQ,EAAC,qBAAgB,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACzD,CAAC;AAGM,KAAK,UAAU,cAAc,CAClC,QAAgB,EAChB,MAAgB;IAEhB,MAAM,IAAI,GAAG,MAAM,IAAA,wCAAQ,EAAC,qBAAgB,EAAE,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC7E,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAA,qBAAgB,EAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC;AAMM,KAAK,UAAU,iBAAiB,CACrC,QAAgB,EAChB,KAAoD;IAEpD,MAAM,OAAO,GAAG,MAAM,cAAc,CAClC,QAAQ,EACR,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CACzC,CAAC;IACF,OAAO,IAAI,GAAG,CACZ,KAAK;SACF,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,qBAAgB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;SACpE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3B,CAAC;AACJ,CAAC;AAGM,KAAK,UAAU,eAAe,CACnC,QAAgB,EAChB,KAAa;IAEb,MAAM,GAAG,GAAG,MAAM,IAAA,wCAAQ,EAAC,qBAAgB,EAAE,QAAQ,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC1E,OAAO,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC"}

package/dist/services/template-attention.d.ts

@@ -0,0 +1,4 @@
+import { type MailingTemplate } from "../db";
+import { type TemplateAttentionReason } from "../types";
+export declare function refreshTemplateAttention(tenantId: string): Promise<void>;
+export declare function refreshAttentionIfFlagged(tenantId: string, template: Pick<MailingTemplate, "attention">, reason: TemplateAttentionReason): Promise<void>;

package/dist/services/template-attention.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refreshTemplateAttention = refreshTemplateAttention;
+exports.refreshAttentionIfFlagged = refreshAttentionIfFlagged;
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const db_1 = require("../db");
+const types_1 = require("../types");
+const attention_1 = require("./attention");
+const metrics_1 = require("./metrics");
+const REASON_SEPARATOR = ",";
+function attentionFields(reasons) {
+    return {
+        attention: reasons.join(REASON_SEPARATOR),
+        needsAttention: reasons.length > 0,
+    };
+}
+async function attentionContext(tenantId, templates) {
+    const now = Date.now();
+    const sends = await (0, interface_database_decorators_1.GetModel)(db_1.SendModel, tenantId).listBetween((0, metrics_1.statsWindowStart)(now), new Date(now));
+    const real = (0, metrics_1.forAudience)(sends, types_1.BUSINESS_AUDIENCE);
+    return {
+        now,
+        sentSlugs: new Set(real.map((send) => send.templateSlug)),
+        knownLocales: (0, attention_1.knownLocalesOf)(templates),
+    };
+}
+async function refreshTemplateAttention(tenantId) {
+    const model = (0, interface_database_decorators_1.GetModel)(db_1.TemplateModel, tenantId);
+    const templates = await model.getAll();
+    const context = await attentionContext(tenantId, templates);
+    const changed = templates
+        .map((template) => ({
+        template,
+        fields: attentionFields((0, attention_1.templateAttentionReasons)(template, context)),
+    }))
+        .filter(({ template, fields }) => template.attention !== fields.attention);
+    await Promise.all(changed.map(({ template, fields }) => model.writeAttention(template._id, fields)));
+}
+async function refreshAttentionIfFlagged(tenantId, template, reason) {
+    if (template.attention.split(REASON_SEPARATOR).includes(reason))
+        await refreshTemplateAttention(tenantId);
+}
+//# sourceMappingURL=template-attention.js.map

package/dist/services/template-attention.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-attention.js","sourceRoot":"","sources":["../../src/services/template-attention.ts"],"names":[],"mappings":";;AAkDA,4DAiBC;AAOD,8DAOC;AAjFD,6FAAqE;AACrE,8BAKe;AACf,oCAA2E;AAC3E,2CAIqB;AACrB,uCAA0D;AAG1D,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAG7B,SAAS,eAAe,CACtB,OAAkC;IAElC,OAAO;QACL,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACzC,cAAc,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,QAAgB,EAChB,SAA4B;IAE5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,MAAM,IAAA,wCAAQ,EAAC,cAAS,EAAE,QAAQ,CAAC,CAAC,WAAW,CAC3D,IAAA,0BAAgB,EAAC,GAAG,CAAC,EACrB,IAAI,IAAI,CAAC,GAAG,CAAC,CACd,CAAC;IACF,MAAM,IAAI,GAAG,IAAA,qBAAW,EAAC,KAAK,EAAE,yBAAiB,CAAC,CAAC;IACnD,OAAO;QACL,GAAG;QACH,SAAS,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzD,YAAY,EAAE,IAAA,0BAAc,EAAC,SAAS,CAAC;KACxC,CAAC;AACJ,CAAC;AAOM,KAAK,UAAU,wBAAwB,CAC5C,QAAgB;IAEhB,MAAM,KAAK,GAAG,IAAA,wCAAQ,EAAC,kBAAa,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;IACvC,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,SAAS;SACtB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAClB,QAAQ;QACR,MAAM,EAAE,eAAe,CAAC,IAAA,oCAAwB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KACrE,CAAC,CAAC;SACF,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7E,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CACnC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAC3C,CACF,CAAC;AACJ,CAAC;AAOM,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAA4C,EAC5C,MAA+B;IAE/B,IAAI,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7D,MAAM,wBAAwB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC"}

package/dist/services/template-stats.d.ts

@@ -0,0 +1,27 @@
+import type { SendSummary } from "../db";
+export interface TemplateStats {
+    id: string;
+    slug: string;
+    sends: number;
+    openRate: number;
+    problems: number;
+    lastSentAt: string | null;
+}
+export interface SourceCount {
+    source: string;
+    count: number;
+}
+export interface FallbackCount {
+    requested: string;
+    used: string;
+    count: number;
+}
+export interface TemplatePerformance extends TemplateStats {
+    sources: SourceCount[];
+    fallbacks: FallbackCount[];
+}
+export declare function statsOf(id: string, slug: string, sends: SendSummary[]): TemplateStats;
+export declare function sourcesOf(sends: SendSummary[]): SourceCount[];
+export declare function isFallback(send: SendSummary): boolean;
+export declare function fallbacksOf(sends: SendSummary[]): FallbackCount[];
+export declare function performanceOf(id: string, slug: string, sends: SendSummary[]): TemplatePerformance;

package/dist/services/template-stats.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.statsOf = statsOf;
+exports.sourcesOf = sourcesOf;
+exports.isFallback = isFallback;
+exports.fallbacksOf = fallbacksOf;
+exports.performanceOf = performanceOf;
+const metrics_1 = require("./metrics");
+const types_1 = require("../types");
+const UNKNOWN_SOURCE = "";
+const MAX_SOURCES = 5;
+const isProblem = (send) => types_1.PROBLEM_STATUSES.includes(send.status);
+function lastSentAt(sends) {
+    const latest = sends.reduce((current, send) => {
+        const at = new Date(send.createdAt);
+        return !current || at > current ? at : current;
+    }, null);
+    return latest ? latest.toISOString() : null;
+}
+function statsOf(id, slug, sends) {
+    return {
+        id,
+        slug,
+        sends: sends.length,
+        openRate: (0, metrics_1.aggregate)(sends).openRate ?? 0,
+        problems: sends.filter(isProblem).length,
+        lastSentAt: lastSentAt(sends),
+    };
+}
+function sourcesOf(sends) {
+    return [...(0, metrics_1.groupBy)(sends, (send) => send.source ?? UNKNOWN_SOURCE)]
+        .map(([source, rows]) => ({ source, count: rows.length }))
+        .sort((left, right) => right.count - left.count)
+        .slice(0, MAX_SOURCES);
+}
+function isFallback(send) {
+    return Boolean(send.requestedLocale && send.requestedLocale !== send.locale);
+}
+function fallbacksOf(sends) {
+    const fallbacks = sends.filter(isFallback);
+    return [
+        ...(0, metrics_1.groupBy)(fallbacks, (send) => `${send.requestedLocale}>${send.locale}`),
+    ].map(([, rows]) => {
+        const first = rows[0];
+        return {
+            requested: first.requestedLocale,
+            used: first.locale,
+            count: rows.length,
+        };
+    });
+}
+function performanceOf(id, slug, sends) {
+    return {
+        ...statsOf(id, slug, sends),
+        sources: sourcesOf(sends),
+        fallbacks: fallbacksOf(sends),
+    };
+}
+//# sourceMappingURL=template-stats.js.map

package/dist/services/template-stats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-stats.js","sourceRoot":"","sources":["../../src/services/template-stats.ts"],"names":[],"mappings":";;AA6CA,0BAaC;AAGD,8BAKC;AAED,gCAEC;AAED,kCAYC;AAED,sCAUC;AA/FD,uCAA+C;AAC/C,oCAA4C;AA6B5C,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,WAAW,GAAG,CAAC,CAAC;AAEtB,MAAM,SAAS,GAAG,CAAC,IAAiB,EAAW,EAAE,CAC/C,wBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAEzC,SAAS,UAAU,CAAC,KAAoB;IACtC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAc,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;QACzD,MAAM,EAAE,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,OAAO,CAAC,OAAO,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IACjD,CAAC,EAAE,IAAI,CAAC,CAAC;IACT,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9C,CAAC;AAED,SAAgB,OAAO,CACrB,EAAU,EACV,IAAY,EACZ,KAAoB;IAEpB,OAAO;QACL,EAAE;QACF,IAAI;QACJ,KAAK,EAAE,KAAK,CAAC,MAAM;QACnB,QAAQ,EAAE,IAAA,mBAAS,EAAC,KAAK,CAAC,CAAC,QAAQ,IAAI,CAAC;QACxC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM;QACxC,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC;KAC9B,CAAC;AACJ,CAAC;AAGD,SAAgB,SAAS,CAAC,KAAoB;IAC5C,OAAO,CAAC,GAAG,IAAA,iBAAO,EAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,cAAc,CAAC,CAAC;SAChE,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SACzD,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SAC/C,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,SAAgB,UAAU,CAAC,IAAiB;IAC1C,OAAO,OAAO,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC;AAC/E,CAAC;AAED,SAAgB,WAAW,CAAC,KAAoB;IAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC3C,OAAO;QACL,GAAG,IAAA,iBAAO,EAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;KAC1E,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE;QACjB,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAgB,CAAC;QACrC,OAAO;YACL,SAAS,EAAE,KAAK,CAAC,eAAyB;YAC1C,IAAI,EAAE,KAAK,CAAC,MAAM;YAClB,KAAK,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,EAAU,EACV,IAAY,EACZ,KAAoB;IAEpB,OAAO;QACL,GAAG,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC;QAC3B,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC;QACzB,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC;KAC9B,CAAC;AACJ,CAAC"}