@antelopejs/dms-mailing 0.2.2

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2025-present - AntelopeJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,162 @@
+# @antelopejs/dms-mailing
+
+<div align="center">
+<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue?style=for-the-badge&labelColor=000000"></a>
+<a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
+<a href="https://antelopejs.com"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
+</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
+`@antelopejs/interface-email`.
+
+## 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/data/` | The `TableView` data controllers behind `/api/mailing/tables/*`. |
+| `src/routes/` | The HTTP API under `/api/mailing` (templates, sends, events, metrics, settings, provider). |
+| `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/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. |
+| `playground/` | Standalone AntelopeJS project wiring this module to the DMS, Mongo, the API server and the mailer, for local development. |
+
+## Public interface
+
+Published as `@antelopejs/interface-dms-mailing`.
+
+```ts
+import {
+  RecordEmailEvent,
+  SendTemplate,
+} from "@antelopejs/interface-dms-mailing";
+
+// Render a live template and send it.
+const result = await SendTemplate("order-confirmation", {
+  tenantId,
+  to: [{ email: "sofie@example.com", name: "Sofie" }],
+  locale: "fr",
+  variables: { order: { total: "48.00" } },
+  source: "checkout",
+});
+
+// Report a provider event against the send it belongs to.
+await RecordEmailEvent(tenantId, {
+  provider: "brevo",
+  messageId,
+  type: "bounced",
+  details: { reason: "mailbox full" },
+});
+```
+
+`SendTemplate` accepts one address or an array. With more than one recipient
+and a provider that advertises `features.batch`, the module renders the e-mail
+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.
+
+## 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).
+
+```sh
+curl -X POST http://localhost:5010/api/mailing/events/brevo \
+  -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"}}'
+```
+
+`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.
+
+## Retention
+
+The daily sweep retires sends only when their creation time, latest event time
+and latest ingested activity all precede the tenant's retention cutoff. Queued
+sends remain active. Retirement irreversibly closes a send to provider events;
+the sweep then removes its events and finally the send. A failed cleanup leaves
+the retirement marker available for another sweep to resume.
+
+Concurrent sweeps require no shared cron lock. Send mutations use the database
+interface's `Table.atomicMutation` revision contract. Retirement rechecks the
+send's age and activity before comparing its revision; concurrent webhook
+activity advances that revision and invalidates the stale candidate. Known
+webhook conflicts reread and recompute counters, with a bounded retry limit.
+An unknown write outcome fails without retrying or reporting a deletion.
+
+This requires the atomic-mutation interface and adapter implementations; generic
+filtered updates and deletes are not an alternative. The dependency releases
+are prerequisites for rollout. Every send is inserted with a unique identity and
+revision, stored in the declared `revision` column.
+
+Each sweep inspects at most 20,000 send candidates per tenant and reports only
+actual send deletions. It also reconciles orphan events left by writers that
+crashed after inserting an event for an already-deleted send. That reconciliation
+scans the event table in keyset pages of 500 rows, with a parent lookup per
+distinct send in each page; its total work is not capped by the send limit.
+Event writes create the parent first and never reuse deleted send IDs. Neither
+retention path deletes templates or files. Disabled retention skips both passes.
+
+## Automation nodes
+
+Registered against the optional `@antelopejs/interface-dms-automation`.
+They are inert no-ops when no module implements it.
+
+| Node | Id | Purpose |
+| --- | --- | --- |
+| Action | `mailing.send-template` | Renders a live template and sends it. Inputs `tenantId`, `slug`, `to` (required), `locale`, `variables`, `source`. |
+| Trigger | `mailing.email-event` | Fires on provider events. Config `types` filters the event types; empty fires on every one. |
+
+## Development
+
+```sh
+pnpm install
+pnpm --dir frontend-vue install
+pnpm --dir playground install
+
+pnpm dev            # backend + module, watching src/
+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`).
+
+Both packages are public on npm, published under the `@antelopejs` scope with
+npm trusted publishing and provenance. The interface package must be released
+before `@antelopejs/dms-mailing`. Each package has its own manual workflow:
+`Release DMS mailing interface` publishes `../interface-dms-mailing`, `Release
+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`.
+
+## Conventions
+
+Every backend-declared text uses the `$key` convention: a string starting with
+`$` is resolved against the i18n catalogs by the front-end. Add keys to
+`frontend-vue/i18n/locales/mailing-en-GB.json` and its French counterpart.
+
+## Checks
+
+```sh
+pnpm lint        # oxlint + oxfmt + the layer's eslint
+pnpm typecheck   # tsconfig.json (the one editors and the type-aware lint read)
+pnpm knip        # unused dependencies
+pnpm build       # tsconfig.build.json -> dist/
+pnpm test        # backend (mocha through `ajs module test`) + layer (vitest)
+pnpm test:frontend # generated client/SSR/email builds and Vue typecheck
+```
+
+The frontend check uses the published DMS and frontend adapter packages. It
+renders English/French email fixtures locally and does not send email.

package/dist/antelope-modules.d.ts

@@ -0,0 +1,32 @@
+export declare const SHARED_MODULE_SOURCES: {
+    readonly dms: {
+        readonly type: "package";
+        readonly package: "@antelopejs/dms";
+        readonly version: ">=0.0.1 <1.0.0";
+    };
+    readonly mongodb: {
+        readonly type: "package";
+        readonly package: "@antelopejs/mongodb";
+        readonly version: "^1.3.0";
+    };
+    readonly "auth-jwt": {
+        readonly type: "package";
+        readonly package: "@antelopejs/auth-jwt";
+        readonly version: "^1.0.3";
+    };
+    readonly api: {
+        readonly type: "package";
+        readonly package: "@antelopejs/api";
+        readonly version: "1.2.5";
+    };
+    readonly "file-storage-local": {
+        readonly type: "package";
+        readonly package: "@antelopejs/file-storage-local";
+        readonly version: "^0.1.4";
+    };
+    readonly nodemailer: {
+        readonly type: "package";
+        readonly package: "@antelopejs/nodemailer";
+        readonly version: "^0.0.4";
+    };
+};

package/dist/antelope-modules.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SHARED_MODULE_SOURCES = void 0;
+exports.SHARED_MODULE_SOURCES = {
+    dms: {
+        type: "package",
+        package: "@antelopejs/dms",
+        version: ">=0.0.1 <1.0.0",
+    },
+    mongodb: {
+        type: "package",
+        package: "@antelopejs/mongodb",
+        version: "^1.3.0",
+    },
+    "auth-jwt": {
+        type: "package",
+        package: "@antelopejs/auth-jwt",
+        version: "^1.0.3",
+    },
+    api: {
+        type: "package",
+        package: "@antelopejs/api",
+        version: "1.2.5",
+    },
+    "file-storage-local": {
+        type: "package",
+        package: "@antelopejs/file-storage-local",
+        version: "^0.1.4",
+    },
+    nodemailer: {
+        type: "package",
+        package: "@antelopejs/nodemailer",
+        version: "^0.0.4",
+    },
+};
+//# sourceMappingURL=antelope-modules.js.map

package/dist/antelope-modules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"antelope-modules.js","sourceRoot":"","sources":["../src/antelope-modules.ts"],"names":[],"mappings":";;;AAgBa,QAAA,qBAAqB,GAAG;IACnC,GAAG,EAAE;QACH,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,iBAAiB;QAC1B,OAAO,EAAE,gBAAgB;KAC1B;IACD,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,qBAAqB;QAC9B,OAAO,EAAE,QAAQ;KAClB;IACD,UAAU,EAAE;QACV,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,sBAAsB;QAC/B,OAAO,EAAE,QAAQ;KAClB;IACD,GAAG,EAAE;QACH,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,iBAAiB;QAC1B,OAAO,EAAE,OAAO;KACjB;IACD,oBAAoB,EAAE;QACpB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,gCAAgC;QACzC,OAAO,EAAE,QAAQ;KAClB;IACD,UAAU,EAAE;QACV,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,wBAAwB;QACjC,OAAO,EAAE,QAAQ;KAClB;CACO,CAAC"}

package/dist/automation/email-event-trigger.d.ts

@@ -0,0 +1,16 @@
+import type { TriggerType } from "@antelopejs/interface-dms-automation";
+import { type SendEventType } from "../types";
+export interface EmailEventPayload {
+    tenantId: string;
+    sendId: string;
+    templateSlug: string;
+    type: SendEventType;
+    recipientEmail: string;
+}
+export interface EmailEventTriggerConfig {
+    types?: SendEventType[];
+}
+export declare const EMAIL_EVENT_TRIGGER_ID = "mailing.email-event";
+export declare function emitEmailEvent(payload: EmailEventPayload): void;
+export declare function clearEmailEventSubscriptions(): void;
+export declare const emailEventTrigger: TriggerType<EmailEventTriggerConfig, EmailEventPayload>;

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

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emailEventTrigger = exports.EMAIL_EVENT_TRIGGER_ID = void 0;
+exports.emitEmailEvent = emitEmailEvent;
+exports.clearEmailEventSubscriptions = clearEmailEventSubscriptions;
+const logging_1 = require("@antelopejs/interface-core/logging");
+const types_1 = require("../types");
+exports.EMAIL_EVENT_TRIGGER_ID = "mailing.email-event";
+const CONFIG_SCHEMA = {
+    type: "object",
+    properties: {
+        types: {
+            type: "array",
+            items: { type: "string", enum: types_1.SEND_STATUSES },
+            description: "Event types the trigger fires on. Leave empty to fire on every event.",
+        },
+    },
+};
+const OUTPUT_SCHEMA = {
+    type: "object",
+    properties: {
+        tenantId: { type: "string" },
+        sendId: { type: "string" },
+        templateSlug: { type: "string" },
+        type: { type: "string", enum: types_1.SEND_STATUSES },
+        recipientEmail: { type: "string" },
+    },
+};
+const FIRST_SUBSCRIPTION_INDEX = 1;
+const SUBSCRIPTION_FAILURE_PREFIX = "[dms-mailing] E-mail event subscription";
+const subscriptions = new Map();
+let nextSubscriptionIndex = FIRST_SUBSCRIPTION_INDEX;
+const accepts = (subscription, payload) => subscription.types.length === 0 || subscription.types.includes(payload.type);
+function deliver(handle, subscription, payload) {
+    try {
+        subscription.emit(payload);
+    }
+    catch (error) {
+        logging_1.Logging.Warn(`${SUBSCRIPTION_FAILURE_PREFIX} "${handle}" failed on a "${payload.type}" event:`, error);
+    }
+}
+function emitEmailEvent(payload) {
+    for (const [handle, subscription] of subscriptions) {
+        if (accepts(subscription, payload))
+            deliver(handle, subscription, payload);
+    }
+}
+function clearEmailEventSubscriptions() {
+    subscriptions.clear();
+}
+exports.emailEventTrigger = {
+    id: exports.EMAIL_EVENT_TRIGGER_ID,
+    name: "E-mail event",
+    description: "Fires when a provider reports a delivery event on a mailing send",
+    icon: "i-ph-bell-ringing",
+    cluster: "replicated",
+    configSchema: CONFIG_SCHEMA,
+    outputSchema: OUTPUT_SCHEMA,
+    activate(config, emit) {
+        const handle = `${exports.EMAIL_EVENT_TRIGGER_ID}:${nextSubscriptionIndex}`;
+        nextSubscriptionIndex += 1;
+        subscriptions.set(handle, { types: config?.types ?? [], emit });
+        return Promise.resolve(handle);
+    },
+    deactivate(handle) {
+        subscriptions.delete(String(handle));
+        return Promise.resolve();
+    },
+};
+//# sourceMappingURL=email-event-trigger.js.map

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

@@ -0,0 +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"}

package/dist/automation/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./email-event-trigger";
+export * from "./send-template-action";
+export declare function registerAutomationNodes(): void;
+export declare function unregisterAutomationNodes(): void;

package/dist/automation/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+exports.registerAutomationNodes = registerAutomationNodes;
+exports.unregisterAutomationNodes = unregisterAutomationNodes;
+const interface_dms_automation_1 = require("@antelopejs/interface-dms-automation");
+const email_event_trigger_1 = require("./email-event-trigger");
+const send_template_action_1 = require("./send-template-action");
+__exportStar(require("./email-event-trigger"), exports);
+__exportStar(require("./send-template-action"), exports);
+const TRIGGERS = [email_event_trigger_1.emailEventTrigger];
+const ACTIONS = [send_template_action_1.sendTemplateAction];
+function registerAutomationNodes() {
+    for (const trigger of TRIGGERS)
+        (0, interface_dms_automation_1.RegisterTriggerType)(trigger);
+    for (const action of ACTIONS)
+        (0, interface_dms_automation_1.RegisterActionType)(action);
+}
+function unregisterAutomationNodes() {
+    for (const trigger of TRIGGERS)
+        (0, interface_dms_automation_1.UnregisterTriggerType)(trigger.id);
+    for (const action of ACTIONS)
+        (0, interface_dms_automation_1.UnregisterActionType)(action.id);
+    (0, email_event_trigger_1.clearEmailEventSubscriptions)();
+}
+//# sourceMappingURL=index.js.map

package/dist/automation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/automation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAuBA,0DAGC;AAED,8DAIC;AAhCD,mFAK8C;AAC9C,+DAG+B;AAC/B,iEAA4D;AAE5D,wDAAsC;AACtC,yDAAuC;AAEvC,MAAM,QAAQ,GAAG,CAAC,uCAAiB,CAAC,CAAC;AACrC,MAAM,OAAO,GAAG,CAAC,yCAAkB,CAAC,CAAC;AAOrC,SAAgB,uBAAuB;IACrC,KAAK,MAAM,OAAO,IAAI,QAAQ;QAAE,IAAA,8CAAmB,EAAC,OAAO,CAAC,CAAC;IAC7D,KAAK,MAAM,MAAM,IAAI,OAAO;QAAE,IAAA,6CAAkB,EAAC,MAAM,CAAC,CAAC;AAC3D,CAAC;AAED,SAAgB,yBAAyB;IACvC,KAAK,MAAM,OAAO,IAAI,QAAQ;QAAE,IAAA,gDAAqB,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAClE,KAAK,MAAM,MAAM,IAAI,OAAO;QAAE,IAAA,+CAAoB,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC9D,IAAA,kDAA4B,GAAE,CAAC;AACjC,CAAC"}

package/dist/automation/send-template-action.d.ts

@@ -0,0 +1,13 @@
+import type { ActionType } from "@antelopejs/interface-dms-automation";
+import type { EmailAddress } from "@antelopejs/interface-email";
+import type { SendTemplateResult } from "@antelopejs/interface-dms-mailing";
+export interface SendTemplateActionInput {
+    tenantId: string;
+    slug: string;
+    to: EmailAddress | EmailAddress[];
+    locale?: string;
+    variables?: Record<string, unknown>;
+    source?: string;
+}
+export declare const SEND_TEMPLATE_ACTION_ID = "mailing.send-template";
+export declare const sendTemplateAction: ActionType<SendTemplateActionInput, SendTemplateResult>;

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

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendTemplateAction = exports.SEND_TEMPLATE_ACTION_ID = void 0;
+const send_1 = require("../services/send");
+const types_1 = require("../types");
+exports.SEND_TEMPLATE_ACTION_ID = "mailing.send-template";
+const AUTOMATION_SOURCE_PREFIX = "automation:";
+const INPUT_SCHEMA = {
+    type: "object",
+    properties: {
+        tenantId: { type: "string" },
+        slug: { type: "string", description: "Slug of the live mailing template" },
+        to: {
+            type: ["string", "array"],
+            items: { type: "string" },
+            description: "Recipient address, or the list of addresses to send to",
+        },
+        locale: { type: "string" },
+        variables: { type: "object" },
+        source: { type: "string" },
+    },
+    required: ["tenantId", "slug", "to"],
+};
+const RESULT_PROPERTIES = {
+    sendId: { type: "string" },
+    status: { type: "string", enum: types_1.SEND_STATUSES },
+    messageId: { type: "string" },
+    error: { type: "string" },
+};
+const OUTPUT_SCHEMA = {
+    type: "object",
+    properties: {
+        ...RESULT_PROPERTIES,
+        results: {
+            type: "array",
+            description: "One entry per recipient",
+            items: { type: "object", properties: RESULT_PROPERTIES },
+        },
+    },
+};
+const failedRecipients = (result) => (result.results ?? [result]).filter((entry) => entry.status === "failed");
+exports.sendTemplateAction = {
+    id: exports.SEND_TEMPLATE_ACTION_ID,
+    name: "Send e-mail template",
+    description: "Render a live mailing template and send it to a recipient",
+    icon: "i-ph-envelope-simple",
+    inputSchema: INPUT_SCHEMA,
+    outputSchema: OUTPUT_SCHEMA,
+    async execute(input, ctx) {
+        const source = input.source ?? `${AUTOMATION_SOURCE_PREFIX}${ctx.procedureId}`;
+        try {
+            const result = await (0, send_1.sendTemplate)(input.slug, {
+                tenantId: input.tenantId,
+                to: input.to,
+                locale: input.locale,
+                variables: input.variables,
+                source,
+            });
+            const failures = failedRecipients(result);
+            if (failures.length > 0) {
+                ctx.log("error", `Template "${input.slug}" was rejected for ${failures.length} recipient(s)`, failures);
+            }
+            return result;
+        }
+        catch (error) {
+            ctx.log("error", `Template "${input.slug}" could not be sent`, error);
+            throw error;
+        }
+    },
+};
+//# sourceMappingURL=send-template-action.js.map

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

@@ -0,0 +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"}