@antelopejs/dms-mailing 0.3.3 → 0.4.0

package/README.md

@@ -7,25 +7,60 @@
 </div>
 
 Mailing module for the AntelopeJS DMS: a template library with a block-based
-e-mail editor, a send log, an overview dashboard and
-settings. It owns the data (tenant-scoped Mongo tables), renders e-mails
-through the DMS html-render chain and sends them through
+e-mail editor, drafts and published versions, a send log, an overview
+dashboard and settings. It owns the data (tenant-scoped Mongo tables), renders
+e-mails through the DMS html-render chain and sends them through
 `@antelopejs/interface-email`.
 
+The module targets `@antelopejs/dms` 0.7 (0.7.21 or later) and `@antelopejs/dms-frontend` 0.5 (0.5.5 or later).
+Like every DMS module, its pages live in the module's own sidebar (Mailing:
+Overview, Templates, Sends; Configure: Settings, Suppression list) and are
+reserved to the platform owner. The design decisions behind the v2 screens are recorded in
+[`docs/design-v2-grill-me.md`](../../docs/design-v2-grill-me.md).
+
+## Breaking changes since 0.3
+
+The v2 redesign neither reads what 0.3.x wrote nor takes its calls:
+
+- **Webhook URL.** `POST /api/mailing/events/<provider>`, with the tenant in
+  the body, is gone. Copy the URL **Settings › Provider & webhook** shows
+  (`/api/mailing/events/<provider>/<tenantId>`) into the provider again.
+- **Settings writes.** `POST /api/mailing/settings` is gone: send the changed
+  fields with `PUT /api/mailing/settings`. A write carrying a read-only field
+  (`webhookUrl`, `provider`) is refused.
+- **Categories.** The settings take `categories` as an array only, no longer
+  as its JSON text, and always with the `marketing` category (it can be
+  renamed, not removed: campaign rules depend on it).
+- **Interface.** The module implements `@antelopejs/interface-dms-mailing`
+  0.7, whose `SendStatus` adds `suppressed`.
+- **Data.** A 0.3.x database is not read any more (settings rows without the
+  tenant key, templates without version numbers, sends without a stage):
+  start the module on an empty database.
+
+## Drafts and versions
+
+The editor never changes what customers receive. It saves a draft next to the
+published content; **Publish** turns the draft into the next version, keeps
+it in `mailing_template_versions` and makes it what `SendTemplate` sends.
+**Discard** drops the draft. Test sends use the draft (their subject starts
+with `[TEST]`), real sends always use the published version, and every send
+records the version it used and the locale the caller asked for, so the log
+can render exactly what went out and show `DE → EN` fallbacks.
+
 ## Layout
 
 | Path | What it holds |
 | --- | --- |
-| `src/index.ts` | Module lifecycle (`construct`/`start`/`stop`/`destroy`); registers the Vue frontend module, the automation nodes, the tenant-export contributor, the realtime topics and the retention cron. |
-| `src/pages/` | The DMS pages: `overview`, `templates`, `editor`, `sends` and the settings form. |
+| `src/index.ts` | Module lifecycle (`construct`/`start`/`stop`/`destroy`); registers the Vue frontend module, the automation nodes, the tenant-export contributor, the realtime topics and the crons. |
+| `src/pages/` | The DMS pages: `overview`, `templates`, the editor (`templates/:id`), `sends`, `settings` and `suppressions`, all inside the module sidebar. Every custom block carries a `.meta()` with i18n keys. |
 | `src/data/` | The `TableView` data controllers behind `/api/mailing/tables/*`. |
-| `src/routes/` | The HTTP API under `/api/mailing` (templates, sends, events, metrics, settings, provider). |
+| `src/routes/` | The HTTP API under `/api/mailing` (templates, sends, events, metrics, settings, provider, suppressions). |
 | `src/engine/` | The pure-TS rendering engine: block tree + variables → resolved e-mail. |
 | `../interface-dms-mailing/` | The separately published public AntelopeJS interface (see below). |
 | `src/automation/` | The `dms-automation` action and trigger. |
-| `src/crons/` | The daily, replay-safe send-log retention job. |
+| `src/crons/` | The daily, replay-safe send-log retention job and the hourly refresh of the templates needing attention. |
 | `src/hooks/` | The tenant data export contributor. |
-| `frontend-vue/` | Vue Inertia module: gallery display, detail drawers, block editor, `dms.email.ts` server template entry and the `mailing-*.json` i18n catalogs. |
+| `frontend-vue/` | Vue module registered under the `Mailing` component prefix: gallery display, template and send drawers, test / real send dialogs, the three-pane block editor, the overview and settings blocks, `dms.email.ts` server template entry and the `mailing-*.json` i18n catalogs. Its own composables and utils are imported by path, not auto-imported. |
 | `playground/` | Standalone AntelopeJS project wiring this module to the DMS, Mongo, the API server and the mailer, for local development. |
 
 ## Public interface
@@ -62,25 +97,199 @@ once and issues a single `SendBatch`; otherwise it loops `Send`. Either way one
 row per recipient lands in the send log, and the returned
 `SendTemplateResult` describes the first one.
 
+A recipient on the [suppression list](#suppression-list) gets nothing: its
+row in the log and its entry in `results` have the status `suppressed`, and
+`error` names the reason as an i18n key
+(`$dms_mailing.errors.suppressed.hard_bounce`, `….complaint`,
+`….unsubscribe`, `….manual`). Do not retry such a send.
+
+## What a recipient receives
+
+Every e-mail goes out as HTML and as a plain-text part generated from the
+same blocks (`multipart/alternative`), with a `viewport` meta. The header logo
+is the DMS branding's light logo (`branding.logo.default.light`) at an
+absolute public URL (the DMS `clientBaseUrl`): on a `localhost`, private-IP or
+`.local` address, or for an SVG (refused by Gmail and Outlook), it is left out
+rather than shown broken. The editor canvas draws the same header and footer.
+
+**Footer links are system variables.** A footer whose unsubscribe or
+preferences label is filled (or a `{{unsubscribeUrl}}` / `{{preferencesUrl}}`
+token anywhere) declares `unsubscribeUrl` / `preferencesUrl` as variables of
+type `url`, required when the template is in the `marketing` category. The
+editor shows them in the Variables tab, the template drawer in its contract and
+its "Call it from code" snippet; pass them in `variables` at send time:
+
+```ts
+await SendTemplate("newsletter-october", {
+  tenantId,
+  to: "ana@example.com",
+  variables: {
+    unsubscribeUrl: `https://app.example.com/unsubscribe/${token}`,
+    preferencesUrl: "https://app.example.com/preferences",
+  },
+});
+```
+
+A link whose URL is missing is dropped from the e-mail, and an empty label
+removes the link. For a marketing template, a missing required URL refuses a
+manual real send, and every send when "Missing variables" is set to refuse;
+a test send never waits for it. The starters and the templates of the other
+categories get a footer with a legal line and no unsubscribe link.
+
+## Suppression list
+
+An address goes on the workspace's suppression list (`mailing_suppressions`)
+when the provider reports a permanent bounce (a `bounced` event that is not
+temporary: no `4xx` / `4.x.x` answer, no `soft` bounce type), a spam
+complaint (`spam`) or an unsubscription (`unsubscribed`), or when someone adds
+it by hand. A test send only adds its address on a permanent bounce: a spam
+report or an unsubscription on a test is the editor's own gesture.
+
+Every send path checks the list: `SendTemplate`, the automation action, the
+real send dialog, "Send again" and "Send to another address". A suppressed
+recipient is logged with the status `suppressed` (the Sends page has a tab for
+them, and the figures leave them out) and nothing is handed to the provider.
+A test send to the editor's own address still goes out, and the dialog warns
+that the address is suppressed; a test to any other suppressed address does
+not.
+
+**Configure › Suppression list** lists the addresses with their reason and
+the send that caused it, searchable and filtered by reason. **Add an
+address** puts one on the list by hand (with an optional note); **Reactivate**
+lifts it, and the next send reaches it again. The same operations are
+`POST /api/mailing/suppressions` (`{ "email", "note"? }`, `409` when the
+address is already on the list) and `DELETE /api/mailing/suppressions/:id`.
+The tenant data export carries the list as `suppressions.json`.
+
+## Configuration
+
+The module takes one option, in the `config` of its entry in the project's
+`antelope.config.ts`:
+
+```ts
+config: {
+  // false renders with the module's own fallback HTML, not the DMS chain.
+  useHtmlRender: true,
+},
+```
+
+The webhook URL of **Settings › Provider & webhook** starts with the DMS
+`clientBaseUrl`, the dashboard's public origin (read through
+`GetClientBaseUrl`): set it in the `dms` module's config as soon as a real
+provider has to reach the webhook. The module declares the route a public
+endpoint of the dashboard, so the frontend server's proxy lets a provider's
+`POST` through without an `Origin`, never sends it a session and relays the
+`x-mailing-webhook-secret` header. The URL never follows the headers of the
+request that reads it. A provider already posting to the API origin
+(`apiBaseUrl`) keeps working: the path and the header are the same.
+
 ## Webhook contract
 
-Provider events are posted to `POST /api/mailing/events/:provider`, guarded by
-the `x-mailing-webhook-secret` header (the secret lives in the mailing
-settings, per tenant). The endpoint never creates those settings: until a
-tenant's settings exist (any mailing page or send creates them), its events are
-refused with `403`.
+The module has one generic event format. Provider events are posted to
+
+```
+POST <clientBaseUrl>/api/mailing/events/<provider>/<tenantId>
+```
+
+the URL **Settings › Provider & webhook** shows, ready to copy. `<provider>`
+is a free label recorded with the event (the settings use the configured
+e-mail provider's name); `<tenantId>` names the workspace.
+
+Every request carries the workspace's secret in the `x-mailing-webhook-secret`
+header (Settings › Provider & webhook; rotating it invalidates the old one at
+once). The body is JSON:
 
 ```sh
-curl -X POST http://localhost:5010/api/mailing/events/brevo \
+curl -X POST https://dms.example.com/api/mailing/events/postmark/<tenantId> \
   -H "Content-Type: application/json" \
-  -H "x-mailing-webhook-secret: <settings.webhookSecret>" \
-  -d '{"messageId":"<provider message id>","type":"bounced","at":"2026-09-09T10:00:00.000Z","details":{"reason":"mailbox full"}}'
+  -H "x-mailing-webhook-secret: <secret>" \
+  -d '{"messageId":"<provider message id>","type":"bounced","at":"2026-09-09T10:00:00.000Z","details":{"reason":"550 5.1.1 No such user","bounceType":"hard","eventId":"<provider event id>"}}'
+```
+
+| Field | Meaning |
+| --- | --- |
+| `messageId` | The id the provider returned when the e-mail was sent (the send's `providerMessageId`). Required. |
+| `type` | `queued`, `sent`, `delivered`, `opened`, `clicked`, `bounced`, `spam`, `failed` or `unsubscribed`. Required. |
+| `at` | When it happened (ISO date); now by default. |
+| `details.reason` | The provider's words (`550 5.1.1 …`), shown in the log. |
+| `details.bounceType` | `soft`/`transient`/`temporary` or `hard`/`permanent`; without it the SMTP class of `reason` decides. A permanent bounce suppresses the address. |
+| `details.eventId` | The provider's event id: a retried webhook with the same id is ignored. |
+| `details.url`, `details.userAgent` | Shown on the click and open steps. |
+
+The answer is `200 {"recorded": true}`, or `{"recorded": false}` when no send
+carries the message id (or the event was already recorded). The event is
+appended to the send's timeline, the status only ever moves forward (a
+delivery after a provider failure wins over it), a hard bounce, a spam report
+or an unsubscription puts the address on the suppression list, and repeated
+problems on a template notify the tenant owners in the DMS bell.
+
+A refused call gets a readable JSON body, for the relay's logs:
+
+| Status | `reason` | Why |
+| --- | --- | --- |
+| `403` | `missing_secret` | No `x-mailing-webhook-secret` header. |
+| `403` | `bad_secret` | The header does not match the workspace's secret, or the workspace has no mailing settings yet (any mailing page or send creates them). |
+| `400` | `invalid_event` | The secret is right but the body is not an event. |
+
+```json
+{ "error": "webhook_refused", "reason": "bad_secret", "message": "The x-mailing-webhook-secret header does not match …" }
+```
+
+The secret is checked before the body, so a caller without it learns nothing
+of the format. **Settings › Provider & webhook › Webhook status** shows the
+last event received (when, its type, the provider label, whether it matched a
+send) and the last call refused (when, and why). **Send a test event** posts a
+test event to the URL shown, with the stored secret, from the backend: it
+proves the URL is reachable from the server, the secret and the format, and
+touches no send (its message id is `dms-mailing-webhook-test`).
+
+### Relaying a provider
+
+Providers post their own format (Postmark, SES through SNS, Mailgun,
+SendGrid, Resend…) and most cannot add a custom header. Put a small relay
+between them and the module: it checks the provider's own signature,
+translates each event and forwards it with the secret. A sketch for Postmark:
+
+```ts
+const TYPES: Record<string, string> = {
+  Delivery: "delivered",
+  Open: "opened",
+  Click: "clicked",
+  Bounce: "bounced",
+  SpamComplaint: "spam",
+  SubscriptionChange: "unsubscribed",
+};
+
+export async function relayPostmark(event: PostmarkEvent): Promise<void> {
+  const type = TYPES[event.RecordType];
+  if (!type) return;
+  await fetch(MAILING_WEBHOOK_URL, {
+    method: "POST",
+    headers: {
+      "content-type": "application/json",
+      "x-mailing-webhook-secret": MAILING_WEBHOOK_SECRET,
+    },
+    body: JSON.stringify({
+      messageId: event.MessageID,
+      type,
+      at: event.ReceivedAt ?? event.DeliveredAt ?? event.BouncedAt,
+      details: {
+        reason: event.Details ?? event.Description,
+        bounceType: event.Type === "SoftBounce" ? "soft" : "hard",
+        eventId: String(event.ID ?? ""),
+        url: event.OriginalLink,
+        userAgent: event.UserAgent,
+      },
+    }),
+  });
+}
 ```
 
-`type` is one of `queued`, `sent`, `delivered`, `opened`, `clicked`,
-`bounced`, `spam`, `failed`, `unsubscribed`. The event is appended to the
-send's timeline, the send status only ever moves forward, and a `bounced`,
-`spam` or `failed` event notifies the tenant owners in the DMS bell.
+A module of the same project can skip HTTP altogether and call
+`RecordEmailEvent(tenantId, event)` from the public interface. A provider or
+a relay posts through the dashboard's URL, as a public endpoint the module
+declares (`AddFrontendModule({ publicEndpoints })`), or straight to the API on
+`apiBaseUrl` when it is reachable: the path and the header are the same.
 
 ## Retention
 
@@ -133,7 +342,8 @@ pnpm frontend:dev   # the DMS front-end, in another terminal
 
 The backend listens on `http://localhost:5010` and needs a MongoDB on
 `mongodb://localhost:27017` (database `playground_dms_mailing`); set
-`MONGO_URL` to point the playground at another instance.
+`MONGO_URL` to point the playground at another instance. E-mails go to an
+Ethereal account, or to a local SMTP server when `SMTP_PORT` is set.
 
 Both packages are public on npm, published under the `@antelopejs` scope with
 npm trusted publishing and provenance. The interface package must be released
@@ -143,7 +353,7 @@ DMS mailing module` publishes this package and refuses to run until the
 interface version its dependency range is floored at resolves on npm. Inside
 the workspace that same range resolves to the sibling package, through
 `link-workspace-packages`. The module implements the interface, so that range
-is capped below the next minor (`>=0.5.0 <0.6.0`): a breaking interface minor
+is capped below the next minor (`>=0.7.0 <0.8.0`): a breaking interface minor
 never reaches a module that does not implement it, and the release workflow
 refuses any other shape.
 

package/dist/automation/email-event-trigger.js

@@ -11,7 +11,7 @@ const CONFIG_SCHEMA = {
     properties: {
         types: {
             type: "array",
-            items: { type: "string", enum: types_1.SEND_STATUSES },
+            items: { type: "string", enum: types_1.SEND_EVENT_TYPES },
             description: "Event types the trigger fires on. Leave empty to fire on every event.",
         },
     },
@@ -22,7 +22,7 @@ const OUTPUT_SCHEMA = {
         tenantId: { type: "string" },
         sendId: { type: "string" },
         templateSlug: { type: "string" },
-        type: { type: "string", enum: types_1.SEND_STATUSES },
+        type: { type: "string", enum: types_1.SEND_EVENT_TYPES },
         recipientEmail: { type: "string" },
     },
 };

package/dist/automation/email-event-trigger.js.map

@@ -1 +1 @@
-{"version":3,"file":"email-event-trigger.js","sourceRoot":"","sources":["../../src/automation/email-event-trigger.ts"],"names":[],"mappings":";;;AA8EA,wCAIC;AAGD,oEAEC;AAvFD,gEAA6D;AAK7D,oCAA6D;AAmBhD,QAAA,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,MAAM,aAAa,GAAe;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAa,EAAE;YAC9C,WAAW,EACT,uEAAuE;SAC1E;KACF;CACF,CAAC;AAEF,MAAM,aAAa,GAAe;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAChC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAa,EAAE;QAC7C,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KACnC;CACF,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAEnC,MAAM,2BAA2B,GAAG,yCAAyC,CAAC;AAE9E,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkC,CAAC;AAEhE,IAAI,qBAAqB,GAAG,wBAAwB,CAAC;AAErD,MAAM,OAAO,GAAG,CACd,YAAoC,EACpC,OAA0B,EACjB,EAAE,CACX,YAAY,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE/E,SAAS,OAAO,CACd,MAAc,EACd,YAAoC,EACpC,OAA0B;IAE1B,IAAI,CAAC;QACH,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,IAAI,CACV,GAAG,2BAA2B,KAAK,MAAM,kBAAkB,OAAO,CAAC,IAAI,UAAU,EACjF,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,OAA0B;IACvD,KAAK,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,aAAa,EAAE,CAAC;QACnD,IAAI,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC;YAAE,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAGD,SAAgB,4BAA4B;IAC1C,aAAa,CAAC,KAAK,EAAE,CAAC;AACxB,CAAC;AAEY,QAAA,iBAAiB,GAG1B;IACF,EAAE,EAAE,8BAAsB;IAC1B,IAAI,EAAE,cAAc;IACpB,WAAW,EACT,kEAAkE;IACpE,IAAI,EAAE,mBAAmB;IACzB,OAAO,EAAE,YAAY;IACrB,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,QAAQ,CAAC,MAAM,EAAE,IAAI;QACnB,MAAM,MAAM,GAAG,GAAG,8BAAsB,IAAI,qBAAqB,EAAE,CAAC;QACpE,qBAAqB,IAAI,CAAC,CAAC;QAC3B,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,UAAU,CAAC,MAAM;QACf,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACrC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF,CAAC"}
+{"version":3,"file":"email-event-trigger.js","sourceRoot":"","sources":["../../src/automation/email-event-trigger.ts"],"names":[],"mappings":";;;AA8EA,wCAIC;AAGD,oEAEC;AAvFD,gEAA6D;AAK7D,oCAAgE;AAmBnD,QAAA,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,MAAM,aAAa,GAAe;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,wBAAgB,EAAE;YACjD,WAAW,EACT,uEAAuE;SAC1E;KACF;CACF,CAAC;AAEF,MAAM,aAAa,GAAe;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAChC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,wBAAgB,EAAE;QAChD,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KACnC;CACF,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAEnC,MAAM,2BAA2B,GAAG,yCAAyC,CAAC;AAE9E,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkC,CAAC;AAEhE,IAAI,qBAAqB,GAAG,wBAAwB,CAAC;AAErD,MAAM,OAAO,GAAG,CACd,YAAoC,EACpC,OAA0B,EACjB,EAAE,CACX,YAAY,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAE/E,SAAS,OAAO,CACd,MAAc,EACd,YAAoC,EACpC,OAA0B;IAE1B,IAAI,CAAC;QACH,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,IAAI,CACV,GAAG,2BAA2B,KAAK,MAAM,kBAAkB,OAAO,CAAC,IAAI,UAAU,EACjF,KAAK,CACN,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,OAA0B;IACvD,KAAK,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,aAAa,EAAE,CAAC;QACnD,IAAI,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC;YAAE,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAGD,SAAgB,4BAA4B;IAC1C,aAAa,CAAC,KAAK,EAAE,CAAC;AACxB,CAAC;AAEY,QAAA,iBAAiB,GAG1B;IACF,EAAE,EAAE,8BAAsB;IAC1B,IAAI,EAAE,cAAc;IACpB,WAAW,EACT,kEAAkE;IACpE,IAAI,EAAE,mBAAmB;IACzB,OAAO,EAAE,YAAY;IACrB,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,aAAa;IAC3B,QAAQ,CAAC,MAAM,EAAE,IAAI;QACnB,MAAM,MAAM,GAAG,GAAG,8BAAsB,IAAI,qBAAqB,EAAE,CAAC;QACpE,qBAAqB,IAAI,CAAC,CAAC;QAC3B,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,UAAU,CAAC,MAAM;QACf,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACrC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF,CAAC"}

package/dist/automation/send-template-action.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sendTemplateAction = exports.SEND_TEMPLATE_ACTION_ID = void 0;
-const send_1 = require("../services/send");
+const checked_send_1 = require("../services/checked-send");
 const types_1 = require("../types");
 exports.SEND_TEMPLATE_ACTION_ID = "mailing.send-template";
 const AUTOMATION_SOURCE_PREFIX = "automation:";
@@ -49,7 +49,7 @@ exports.sendTemplateAction = {
     async execute(input, ctx) {
         const source = input.source ?? `${AUTOMATION_SOURCE_PREFIX}${ctx.procedureId}`;
         try {
-            const result = await (0, send_1.sendTemplate)(input.slug, {
+            const result = await (0, checked_send_1.sendUnlessSuppressed)(input.slug, {
                 tenantId: input.tenantId,
                 to: input.to,
                 locale: input.locale,

package/dist/automation/send-template-action.js.map

@@ -1 +1 @@
-{"version":3,"file":"send-template-action.js","sourceRoot":"","sources":["../../src/automation/send-template-action.ts"],"names":[],"mappings":";;;AAMA,2CAAgD;AAChD,oCAAyC;AAW5B,QAAA,uBAAuB,GAAG,uBAAuB,CAAC;AAE/D,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAE/C,MAAM,YAAY,GAAe;IAC/B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mCAAmC,EAAE;QAI1E,EAAE,EAAE;YACF,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;YACzB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,WAAW,EAAE,wDAAwD;SACtE;QACD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC3B;IACD,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC;CACrC,CAAC;AAEF,MAAM,iBAAiB,GAAe;IACpC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAa,EAAE;IAC/C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC7B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;CAC1B,CAAC;AAEF,MAAM,aAAa,GAAe;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,GAAG,iBAAiB;QACpB,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,yBAAyB;YACtC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,iBAAiB,EAAE;SACzD;KACF;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAA0B,EAAwB,EAAE,CAC5E,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC;AAE/D,QAAA,kBAAkB,GAG3B;IACF,EAAE,EAAE,+BAAuB;IAC3B,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE,2DAA2D;IACxE,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE,YAAY;IACzB,YAAY,EAAE,aAAa;IAC3B,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG;QACtB,MAAM,MAAM,GACV,KAAK,CAAC,MAAM,IAAI,GAAG,wBAAwB,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAClE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAA,mBAAY,EAAC,KAAK,CAAC,IAAI,EAAE;gBAC5C,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,MAAM;aACP,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,GAAG,CAAC,GAAG,CACL,OAAO,EACP,aAAa,KAAK,CAAC,IAAI,sBAAsB,QAAQ,CAAC,MAAM,eAAe,EAC3E,QAAQ,CACT,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,CAAC,IAAI,qBAAqB,EAAE,KAAK,CAAC,CAAC;YACtE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"send-template-action.js","sourceRoot":"","sources":["../../src/automation/send-template-action.ts"],"names":[],"mappings":";;;AAMA,2DAAgE;AAChE,oCAAyC;AAW5B,QAAA,uBAAuB,GAAG,uBAAuB,CAAC;AAE/D,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAE/C,MAAM,YAAY,GAAe;IAC/B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mCAAmC,EAAE;QAM1E,EAAE,EAAE;YACF,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;YACzB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,WAAW,EAAE,wDAAwD;SACtE;QACD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC3B;IACD,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC;CACrC,CAAC;AAEF,MAAM,iBAAiB,GAAe;IACpC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAa,EAAE;IAC/C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC7B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;CAC1B,CAAC;AAEF,MAAM,aAAa,GAAe;IAChC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,GAAG,iBAAiB;QACpB,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,yBAAyB;YACtC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,iBAAiB,EAAE;SACzD;KACF;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAA0B,EAAwB,EAAE,CAC5E,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC;AAE/D,QAAA,kBAAkB,GAG3B;IACF,EAAE,EAAE,+BAAuB;IAC3B,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE,2DAA2D;IACxE,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE,YAAY;IACzB,YAAY,EAAE,aAAa;IAC3B,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG;QACtB,MAAM,MAAM,GACV,KAAK,CAAC,MAAM,IAAI,GAAG,wBAAwB,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAClE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAoB,EAAC,KAAK,CAAC,IAAI,EAAE;gBACpD,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,EAAE,EAAE,KAAK,CAAC,EAAE;gBACZ,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,MAAM;aACP,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,GAAG,CAAC,GAAG,CACL,OAAO,EACP,aAAa,KAAK,CAAC,IAAI,sBAAsB,QAAQ,CAAC,MAAM,eAAe,EAC3E,QAAQ,CACT,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,CAAC,IAAI,qBAAqB,EAAE,KAAK,CAAC,CAAC;YACtE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF,CAAC"}

package/dist/config.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setConfig = setConfig;
 exports.getConfig = getConfig;
-const DEFAULTS = { useHtmlRender: true };
+const DEFAULTS = {
+    useHtmlRender: true,
+};
 let current = DEFAULTS;
 function setConfig(config) {
     current = { ...DEFAULTS, ...config };

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAQA,8BAEC;AAED,8BAEC;AAVD,MAAM,QAAQ,GAA+B,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;AAErE,IAAI,OAAO,GAA+B,QAAQ,CAAC;AAEnD,SAAgB,SAAS,CAAC,MAAwB;IAChD,OAAO,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;AACvC,CAAC;AAED,SAAgB,SAAS;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAUA,8BAEC;AAED,8BAEC;AAZD,MAAM,QAAQ,GAA+B;IAC3C,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF,IAAI,OAAO,GAA+B,QAAQ,CAAC;AAEnD,SAAgB,SAAS,CAAC,MAAwB;IAChD,OAAO,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;AACvC,CAAC;AAED,SAAgB,SAAS;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/constants.d.ts

@@ -1,13 +1,19 @@
 export declare const MODULE_ID = "mailing";
 export declare const API_BASE_PATH = "/api/mailing";
 export declare const TABLES_BASE_PATH = "/api/mailing/tables";
+export declare const MODULE_BASE_PATH = "/modules/mailing";
+export declare const TEMPLATES_PATH = "/modules/mailing/templates";
+export declare const SENDS_PATH = "/modules/mailing/sends";
+export declare const SETTINGS_PATH = "/modules/mailing/settings";
+export declare const NEW_TEMPLATE_BUTTON_ID = "create";
+export declare const NEW_TEMPLATE_ACTION_ID = "mailing.new-template";
 export declare const FRONTEND_MODULE_NAME = "@antelopejs/dms-mailing-frontend-vue";
 export declare const EMAIL_TEMPLATE_NAME = "EmailMailingTemplate";
 export declare const MAILING_SEND_PERMISSION = "mailing.send";
 export declare const OVERVIEW_PERIOD_SCOPE = "mailing-overview";
 export declare const SENDS_PERIOD_SCOPE = "mailing-sends";
 export declare const MAILING_SENDS_TOPIC = "mailing:sends";
-export declare const GALLERY_DISPLAY_ID = "gallery";
+export declare const GALLERY_DISPLAY_ID = "mailing:gallery";
 export declare const TEMPLATE_CATEGORIES_TYPE_ID = "mailing_template_categories";
 export declare const TEMPLATE_CATEGORY_TYPE_ID = "mailing_template_category";
 export declare const DEFAULT_FALLBACK_LOCALE = "en";
@@ -21,5 +27,8 @@ export declare const HTTP_NOT_FOUND = 404;
 export declare const HTTP_CONFLICT = 409;
 export declare const HTTP_UNPROCESSABLE = 422;
 export declare const LOCALE_LIST_SEPARATOR = ",";
+export declare const ARCHIVED_STATUS = "archived";
+export declare const UNSUBSCRIBE_URL_PATH = "unsubscribeUrl";
+export declare const PREFERENCES_URL_PATH = "preferencesUrl";
 export declare const SYSTEM_VARIABLE_PATHS: string[];
 export declare const MAX_WINDOW_DAYS = 400;

package/dist/constants.js

@@ -1,16 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_WINDOW_DAYS = exports.SYSTEM_VARIABLE_PATHS = exports.LOCALE_LIST_SEPARATOR = exports.HTTP_UNPROCESSABLE = exports.HTTP_CONFLICT = exports.HTTP_NOT_FOUND = exports.HTTP_FORBIDDEN = exports.HTTP_BAD_REQUEST = exports.SLUG_PATTERN = exports.MAX_NAME_LENGTH = exports.MAX_SLUG_LENGTH = exports.DEFAULT_LOG_RETENTION_DAYS = exports.DEFAULT_FALLBACK_LOCALE = exports.TEMPLATE_CATEGORY_TYPE_ID = exports.TEMPLATE_CATEGORIES_TYPE_ID = exports.GALLERY_DISPLAY_ID = exports.MAILING_SENDS_TOPIC = exports.SENDS_PERIOD_SCOPE = exports.OVERVIEW_PERIOD_SCOPE = exports.MAILING_SEND_PERMISSION = exports.EMAIL_TEMPLATE_NAME = exports.FRONTEND_MODULE_NAME = exports.TABLES_BASE_PATH = exports.API_BASE_PATH = exports.MODULE_ID = void 0;
+exports.MAX_WINDOW_DAYS = exports.SYSTEM_VARIABLE_PATHS = exports.PREFERENCES_URL_PATH = exports.UNSUBSCRIBE_URL_PATH = exports.ARCHIVED_STATUS = exports.LOCALE_LIST_SEPARATOR = exports.HTTP_UNPROCESSABLE = exports.HTTP_CONFLICT = exports.HTTP_NOT_FOUND = exports.HTTP_FORBIDDEN = exports.HTTP_BAD_REQUEST = exports.SLUG_PATTERN = exports.MAX_NAME_LENGTH = exports.MAX_SLUG_LENGTH = exports.DEFAULT_LOG_RETENTION_DAYS = exports.DEFAULT_FALLBACK_LOCALE = exports.TEMPLATE_CATEGORY_TYPE_ID = exports.TEMPLATE_CATEGORIES_TYPE_ID = exports.GALLERY_DISPLAY_ID = exports.MAILING_SENDS_TOPIC = exports.SENDS_PERIOD_SCOPE = exports.OVERVIEW_PERIOD_SCOPE = exports.MAILING_SEND_PERMISSION = exports.EMAIL_TEMPLATE_NAME = exports.FRONTEND_MODULE_NAME = exports.NEW_TEMPLATE_ACTION_ID = exports.NEW_TEMPLATE_BUTTON_ID = exports.SETTINGS_PATH = exports.SENDS_PATH = exports.TEMPLATES_PATH = exports.MODULE_BASE_PATH = exports.TABLES_BASE_PATH = exports.API_BASE_PATH = exports.MODULE_ID = void 0;
 exports.MODULE_ID = "mailing";
 exports.API_BASE_PATH = "/api/mailing";
 exports.TABLES_BASE_PATH = `${exports.API_BASE_PATH}/tables`;
+exports.MODULE_BASE_PATH = `/modules/${exports.MODULE_ID}`;
+exports.TEMPLATES_PATH = `${exports.MODULE_BASE_PATH}/templates`;
+exports.SENDS_PATH = `${exports.MODULE_BASE_PATH}/sends`;
+exports.SETTINGS_PATH = `${exports.MODULE_BASE_PATH}/settings`;
+exports.NEW_TEMPLATE_BUTTON_ID = "create";
+exports.NEW_TEMPLATE_ACTION_ID = "mailing.new-template";
 exports.FRONTEND_MODULE_NAME = "@antelopejs/dms-mailing-frontend-vue";
 exports.EMAIL_TEMPLATE_NAME = "EmailMailingTemplate";
 exports.MAILING_SEND_PERMISSION = "mailing.send";
 exports.OVERVIEW_PERIOD_SCOPE = "mailing-overview";
 exports.SENDS_PERIOD_SCOPE = "mailing-sends";
 exports.MAILING_SENDS_TOPIC = "mailing:sends";
-exports.GALLERY_DISPLAY_ID = "gallery";
+exports.GALLERY_DISPLAY_ID = `${exports.MODULE_ID}:gallery`;
 exports.TEMPLATE_CATEGORIES_TYPE_ID = "mailing_template_categories";
 exports.TEMPLATE_CATEGORY_TYPE_ID = "mailing_template_category";
 exports.DEFAULT_FALLBACK_LOCALE = "en";
@@ -24,6 +30,12 @@ exports.HTTP_NOT_FOUND = 404;
 exports.HTTP_CONFLICT = 409;
 exports.HTTP_UNPROCESSABLE = 422;
 exports.LOCALE_LIST_SEPARATOR = ",";
-exports.SYSTEM_VARIABLE_PATHS = ["unsubscribeUrl", "preferencesUrl"];
+exports.ARCHIVED_STATUS = "archived";
+exports.UNSUBSCRIBE_URL_PATH = "unsubscribeUrl";
+exports.PREFERENCES_URL_PATH = "preferencesUrl";
+exports.SYSTEM_VARIABLE_PATHS = [
+    exports.UNSUBSCRIBE_URL_PATH,
+    exports.PREFERENCES_URL_PATH,
+];
 exports.MAX_WINDOW_DAYS = 400;
 //# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG,SAAS,CAAC;AACtB,QAAA,aAAa,GAAG,cAAc,CAAC;AAC/B,QAAA,gBAAgB,GAAG,GAAG,qBAAa,SAAS,CAAC;AAC7C,QAAA,oBAAoB,GAAG,sCAAsC,CAAC;AAC9D,QAAA,mBAAmB,GAAG,sBAAsB,CAAC;AAE7C,QAAA,uBAAuB,GAAG,cAAc,CAAC;AAEzC,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AAC3C,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAErC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEtC,QAAA,kBAAkB,GAAG,SAAS,CAAC;AAC/B,QAAA,2BAA2B,GAAG,6BAA6B,CAAC;AAC5D,QAAA,yBAAyB,GAAG,2BAA2B,CAAC;AAExD,QAAA,uBAAuB,GAAG,IAAI,CAAC;AAC/B,QAAA,0BAA0B,GAAG,EAAE,CAAC;AAChC,QAAA,eAAe,GAAG,EAAE,CAAC;AACrB,QAAA,eAAe,GAAG,GAAG,CAAC;AACtB,QAAA,YAAY,GAAG,sBAAsB,CAAC;AAEtC,QAAA,gBAAgB,GAAG,GAAG,CAAC;AACvB,QAAA,cAAc,GAAG,GAAG,CAAC;AACrB,QAAA,cAAc,GAAG,GAAG,CAAC;AACrB,QAAA,aAAa,GAAG,GAAG,CAAC;AACpB,QAAA,kBAAkB,GAAG,GAAG,CAAC;AAEzB,QAAA,qBAAqB,GAAG,GAAG,CAAC;AAE5B,QAAA,qBAAqB,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AAO7D,QAAA,eAAe,GAAG,GAAG,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG,SAAS,CAAC;AACtB,QAAA,aAAa,GAAG,cAAc,CAAC;AAC/B,QAAA,gBAAgB,GAAG,GAAG,qBAAa,SAAS,CAAC;AAC7C,QAAA,gBAAgB,GAAG,YAAY,iBAAS,EAAE,CAAC;AAC3C,QAAA,cAAc,GAAG,GAAG,wBAAgB,YAAY,CAAC;AACjD,QAAA,UAAU,GAAG,GAAG,wBAAgB,QAAQ,CAAC;AACzC,QAAA,aAAa,GAAG,GAAG,wBAAgB,WAAW,CAAC;AAC/C,QAAA,sBAAsB,GAAG,QAAQ,CAAC;AAClC,QAAA,sBAAsB,GAAG,sBAAsB,CAAC;AAChD,QAAA,oBAAoB,GAAG,sCAAsC,CAAC;AAC9D,QAAA,mBAAmB,GAAG,sBAAsB,CAAC;AAE7C,QAAA,uBAAuB,GAAG,cAAc,CAAC;AAEzC,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AAC3C,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAErC,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEtC,QAAA,kBAAkB,GAAG,GAAG,iBAAS,UAAU,CAAC;AAC5C,QAAA,2BAA2B,GAAG,6BAA6B,CAAC;AAC5D,QAAA,yBAAyB,GAAG,2BAA2B,CAAC;AAExD,QAAA,uBAAuB,GAAG,IAAI,CAAC;AAC/B,QAAA,0BAA0B,GAAG,EAAE,CAAC;AAChC,QAAA,eAAe,GAAG,EAAE,CAAC;AACrB,QAAA,eAAe,GAAG,GAAG,CAAC;AACtB,QAAA,YAAY,GAAG,sBAAsB,CAAC;AAEtC,QAAA,gBAAgB,GAAG,GAAG,CAAC;AACvB,QAAA,cAAc,GAAG,GAAG,CAAC;AACrB,QAAA,cAAc,GAAG,GAAG,CAAC;AACrB,QAAA,aAAa,GAAG,GAAG,CAAC;AACpB,QAAA,kBAAkB,GAAG,GAAG,CAAC;AAEzB,QAAA,qBAAqB,GAAG,GAAG,CAAC;AAG5B,QAAA,eAAe,GAAG,UAAU,CAAC;AAE7B,QAAA,oBAAoB,GAAG,gBAAgB,CAAC;AACxC,QAAA,oBAAoB,GAAG,gBAAgB,CAAC;AAGxC,QAAA,qBAAqB,GAAG;IACnC,4BAAoB;IACpB,4BAAoB;CACrB,CAAC;AAOW,QAAA,eAAe,GAAG,GAAG,CAAC"}

package/dist/crons/attention.d.ts

@@ -0,0 +1,3 @@
+import type { CronJob } from "./jobs";
+export declare function runAttentionRefresh(): Promise<void>;
+export declare const ATTENTION_JOB: CronJob;

package/dist/crons/attention.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ATTENTION_JOB = void 0;
+exports.runAttentionRefresh = runAttentionRefresh;
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const db_1 = require("@antelopejs/interface-dms/db");
+const template_attention_1 = require("../services/template-attention");
+const ATTENTION_SCHEDULE = "5 * * * *";
+async function runAttentionRefresh() {
+    const tenants = await (0, interface_database_decorators_1.GetModel)(db_1.TenantModel).getAll();
+    for (const tenant of tenants)
+        await (0, template_attention_1.refreshTemplateAttention)(tenant._id);
+}
+exports.ATTENTION_JOB = {
+    name: "mailing-attention",
+    schedule: ATTENTION_SCHEDULE,
+    run: runAttentionRefresh,
+};
+//# sourceMappingURL=attention.js.map

package/dist/crons/attention.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attention.js","sourceRoot":"","sources":["../../src/crons/attention.ts"],"names":[],"mappings":";;;AAWA,kDAGC;AAdD,6FAAqE;AACrE,qDAA2D;AAC3D,uEAA0E;AAO1E,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAEhC,KAAK,UAAU,mBAAmB;IACvC,MAAM,OAAO,GAAG,MAAM,IAAA,wCAAQ,EAAC,gBAAW,CAAC,CAAC,MAAM,EAAE,CAAC;IACrD,KAAK,MAAM,MAAM,IAAI,OAAO;QAAE,MAAM,IAAA,6CAAwB,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC3E,CAAC;AAEY,QAAA,aAAa,GAAY;IACpC,IAAI,EAAE,mBAAmB;IACzB,QAAQ,EAAE,kBAAkB;IAC5B,GAAG,EAAE,mBAAmB;CACzB,CAAC"}

package/dist/crons/index.d.ts

@@ -1 +1,3 @@
+export * from "./attention";
+export * from "./jobs";
 export * from "./retention";

package/dist/crons/index.js

@@ -14,5 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./attention"), exports);
+__exportStar(require("./jobs"), exports);
 __exportStar(require("./retention"), exports);
 //# sourceMappingURL=index.js.map

package/dist/crons/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/crons/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/crons/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yCAAuB;AACvB,8CAA4B"}

package/dist/crons/jobs.d.ts

@@ -0,0 +1,12 @@
+import { type ScheduledTask } from "node-cron";
+export interface CronJob {
+    name: string;
+    schedule: string;
+    run: () => Promise<unknown>;
+}
+export interface ScheduledJob {
+    name: string;
+    task: ScheduledTask;
+}
+export declare function scheduleJob(job: CronJob): ScheduledJob;
+export declare function stopJob(job: ScheduledJob): Promise<void>;

package/dist/crons/jobs.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scheduleJob = scheduleJob;
+exports.stopJob = stopJob;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const node_cron_1 = __importDefault(require("node-cron"));
+function scheduleJob(job) {
+    const task = node_cron_1.default.schedule(job.schedule, () => {
+        void job.run().catch((error) => {
+            logging_1.Logging.Error(`Cron '${job.name}' failed:`, error);
+        });
+    });
+    return { name: job.name, task };
+}
+async function stopJob(job) {
+    try {
+        await job.task.stop();
+        await job.task.destroy();
+    }
+    catch (error) {
+        logging_1.Logging.Error(`Cron '${job.name}' failed to stop:`, error);
+    }
+}
+//# sourceMappingURL=jobs.js.map

package/dist/crons/jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../src/crons/jobs.ts"],"names":[],"mappings":";;;;;AAiBA,kCAOC;AAGD,0BAOC;AAlCD,gEAA6D;AAC7D,0DAAqD;AAgBrD,SAAgB,WAAW,CAAC,GAAY;IACtC,MAAM,IAAI,GAAG,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE;QAC5C,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACtC,iBAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,IAAI,WAAW,EAAE,KAAK,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;AAClC,CAAC;AAGM,KAAK,UAAU,OAAO,CAAC,GAAiB;IAC7C,IAAI,CAAC;QACH,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACtB,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iBAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,IAAI,mBAAmB,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC"}

package/dist/crons/retention.d.ts

@@ -1,5 +1,4 @@
-import { type ScheduledTask } from "node-cron";
-export declare const RETENTION_CRON_NAME = "mailing-retention";
+import type { CronJob } from "./jobs";
 export interface RetentionLimits {
     pageSize: number;
     maxRows: number;
@@ -14,5 +13,4 @@ export declare function purgeInPages(pass: RetentionPass, limits?: RetentionLimi
 export declare function purgeSend(tenantId: string, sendId: string, limit: Date): Promise<number>;
 export declare function purgeOrphanEvents(tenantId: string, pageSize?: number): Promise<void>;
 export declare function runRetention(now?: Date): Promise<number>;
-export declare function stopRetention(task: ScheduledTask | undefined): Promise<void>;
-export declare function scheduleRetention(): ScheduledTask;
+export declare const RETENTION_JOB: CronJob;

package/dist/crons/retention.js

@@ -1,22 +1,15 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RETENTION_LIMITS = exports.RETENTION_CRON_NAME = void 0;
+exports.RETENTION_JOB = exports.RETENTION_LIMITS = void 0;
 exports.retentionLimit = retentionLimit;
 exports.purgeInPages = purgeInPages;
 exports.purgeSend = purgeSend;
 exports.purgeOrphanEvents = purgeOrphanEvents;
 exports.runRetention = runRetention;
-exports.stopRetention = stopRetention;
-exports.scheduleRetention = scheduleRetention;
 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 node_cron_1 = __importDefault(require("node-cron"));
 const db_2 = require("../db");
-exports.RETENTION_CRON_NAME = "mailing-retention";
 exports.RETENTION_LIMITS = {
     pageSize: 500,
     maxRows: 20_000,
@@ -75,7 +68,7 @@ async function purgeOrphanEvents(tenantId, pageSize = exports.RETENTION_LIMITS.p
     }
 }
 async function purgeTenant(tenantId, now) {
-    const settings = await (0, interface_database_decorators_1.GetModel)(db_2.SettingsModel, tenantId).getSingleton(tenantId);
+    const settings = await (0, interface_database_decorators_1.GetModel)(db_2.SettingsModel, tenantId).get(tenantId);
     if (!settings || settings.logRetentionDays < MIN_RETENTION_DAYS)
         return 0;
     const limit = retentionLimit(settings.logRetentionDays, now);
@@ -91,17 +84,9 @@ async function runRetention(now = new Date()) {
     logging_1.Logging.Info(`[dms-mailing] Retention purged ${purged} sends`);
     return purged;
 }
-async function stopRetention(task) {
-    if (!task)
-        return;
-    await task.stop();
-    await task.destroy();
-}
-function scheduleRetention() {
-    return node_cron_1.default.schedule(RETENTION_SCHEDULE, () => {
-        void runRetention().catch((error) => {
-            logging_1.Logging.Error(`Cron '${exports.RETENTION_CRON_NAME}' failed:`, error);
-        });
-    });
-}
+exports.RETENTION_JOB = {
+    name: "mailing-retention",
+    schedule: RETENTION_SCHEDULE,
+    run: runRetention,
+};
 //# sourceMappingURL=retention.js.map