@antelopejs/dms-mailing 0.7.1 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms-mailing",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "description": "E-mail templates for the AntelopeJS DMS: a block editor with drafts and versions, a send log, delivery metrics and a suppression list.",
   "keywords": [
     "antelopejs",
@@ -46,21 +46,23 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@antelopejs/interface-api": ">=0.0.15 <1.0.0",
-    "@antelopejs/interface-api-util": ">=0.1.3 <1.0.0",
-    "@antelopejs/interface-core": ">=0.2.4 <1.0.0",
-    "@antelopejs/interface-data-api": ">=0.4.0 <1.0.0",
-    "@antelopejs/interface-database": ">=0.1.11 <1.0.0",
-    "@antelopejs/interface-database-decorators": ">=0.1.10 <1.0.0",
-    "@antelopejs/interface-dms": ">=0.9.0 <1.0.0",
-    "@antelopejs/interface-dms-mailing": ">=0.9.0 <0.10.0",
+    "@antelopejs/interface-api": ">=0.3.0 <1.0.0",
+    "@antelopejs/interface-api-util": ">=0.3.0 <1.0.0",
+    "@antelopejs/interface-core": ">=0.4.0 <1.0.0",
+    "@antelopejs/interface-data-api": ">=0.6.1 <1.0.0",
+    "@antelopejs/interface-database": ">=0.3.0 <1.0.0",
+    "@antelopejs/interface-database-decorators": ">=0.2.0 <1.0.0",
+    "@antelopejs/interface-dms": ">=0.12.0 <1.0.0",
+    "@antelopejs/interface-dms-mailing": ">=0.10.0 <0.11.0",
     "@antelopejs/interface-email": ">=0.0.6 <1.0.0",
     "node-cron": "^4.2.1",
     "zod": "~3.24.2"
   },
   "devDependencies": {
-    "@antelopejs/core": ">=1.17.1 <2",
-    "@antelopejs/tooling-configs": ">=0.0.9 <1.0.0",
+    "@antelopejs/core": "^1.20.0",
+    "@antelopejs/dms": ">=0.16.1 <1.0.0",
+    "@antelopejs/mongodb": "^1.6.2",
+    "@antelopejs/tooling-configs": "^0.2.18",
     "@types/chai": "^4.3.20",
     "@types/mocha": "^10",
     "@types/node": "^24.0.0",
@@ -69,16 +71,13 @@
     "chai": "^4.5.0",
     "knip": "^6.34.0",
     "mongodb-memory-server-core": "^11.0.1",
-    "oxfmt": "^0.66.0",
-    "oxlint": "1.81.0",
-    "oxlint-tsgolint": "^7.0.2001",
     "release-it": "^19.2.4",
     "release-it-changelogen": "^0.1.0",
     "rimraf": "^6.1.3",
     "typescript": "^6.0.3"
   },
   "optionalDependencies": {
-    "@antelopejs/interface-dms-automation": ">=0.2.1 <1.0.0"
+    "@antelopejs/interface-dms-automation": ">=0.6.0 <1.0.0"
   },
   "antelopeJs": {
     "baseUrl": "dist",
@@ -92,17 +91,14 @@
   },
   "dmsFrontend": "dist/frontend-module.js",
   "scripts": {
-    "build": "rimraf dist && tsc",
+    "build": "pnpm --filter @antelopejs/interface-dms-mailing build && rimraf dist && tsc",
     "dev": "ajs project dev -w -p playground",
     "dev:frontend": "cd playground && pnpm frontend:dev",
     "frontend:dev": "cd playground && pnpm frontend:dev",
-    "lint": "oxlint && oxfmt --check . && cd frontend-vue && pnpm lint && antelopejs-check-interface-ranges",
-    "lint:fix": "oxlint --fix --max-warnings=1000000 && oxfmt . && cd frontend-vue && pnpm lint:fix",
-    "format": "oxfmt . && cd frontend-vue && pnpm format",
     "typecheck": "tsc --noEmit",
     "knip": "knip --dependencies",
     "knip:all": "knip",
-    "release": "pnpm --filter @antelopejs/interface-dms-mailing build && pnpm --dir frontend-vue install --frozen-lockfile && release-it",
+    "release": "pnpm --filter @antelopejs/interface-dms-mailing build && pnpm --dir ../.. install --frozen-lockfile && release-it",
     "test": "pnpm run test:backend && pnpm run test:layer",
     "test:backend": "([ -n \"$DMS_PREBUILT\" ] || pnpm run build) && ajs module test .",
     "test:layer": "cd frontend-vue && pnpm test",

package/skills/dms-mailing/SKILL.md

@@ -23,7 +23,7 @@ https://dms.antelopejs.com/docs/modules/mailing (sending from code and the webho
 
 - `ajs project modules add @antelopejs/dms-mailing`, plus a module implementing `@antelopejs/interface-email`
   (`@antelopejs/nodemailer`, `config: { ethereal: true }` in dev).
-- Mailing 0.6 requires `@antelopejs/dms` >=0.9 (interface-dms 0.7, renderer `@antelopejs/dms-frontend` 0.6);
+- The DMS backend and renderer releases the module runs on are in the README compatibility block and in `engines["@antelopejs/dms-frontend"]` of `frontend-vue/package.json`;
   0.4 is the DMS 0.8 line. Mailing 0.6 implements `@antelopejs/interface-dms-mailing` `>=0.8.0 <0.9.0`, adding declaration and import calls;
   interface 0.9 adds `DeclareSender`; `SendTemplate` / `RecordEmailEvent` callers do not change.
 - Module option: `useHtmlRender` (default `true`, DMS html-render chain; `false` = built-in standalone HTML).

package/skills/dms-mailing/cases.json

@@ -0,0 +1,49 @@
+{
+  "version": 1,
+  "cases": [
+    {
+      "id": "mailing-send-template",
+      "area": "modules",
+      "style": "clean",
+      "prompt": "Send the welcome e-mail template when a user signs up.",
+      "expect": {
+        "skills": ["dms-mailing"],
+        "acceptable": ["dms", "dms-auth"],
+        "mustMention": ["SendTemplate"]
+      }
+    },
+    {
+      "id": "mailing-bounces",
+      "area": "modules",
+      "style": "clean",
+      "prompt": "Our e-mail provider reports bounces through a webhook. How do we record them?",
+      "expect": {
+        "skills": ["dms-mailing"],
+        "acceptable": ["dms"],
+        "mustMention": ["RecordEmailEvent"]
+      }
+    },
+    {
+      "id": "mailing-missing-variable-casual",
+      "area": "modules",
+      "style": "casual",
+      "prompt": "mail send says missing variable firstName??",
+      "expect": {
+        "skills": ["dms-mailing"],
+        "acceptable": ["dms"]
+      }
+    },
+    {
+      "id": "dms-mailing-avoid-tracker",
+      "area": "modules",
+      "style": "clean",
+      "prompt": "Put the tracking script on our public website and count how many visitors click the signup button.",
+      "expect": {
+        "skills": ["dms-marketing"],
+        "acceptable": ["dms"],
+        "mustMention": ["data-website-id"],
+        "avoid": ["dms-mailing"]
+      }
+    }
+  ]
+}

package/src/automation/email-event-trigger.ts

@@ -5,13 +5,13 @@ import type {
 } from "@antelopejs/interface-dms-automation";
 import { SEND_EVENT_TYPES, type SendEventType } from "../types";
 
-export interface EmailEventPayload {
+export type EmailEventPayload = {
   tenantId: string;
   sendId: string;
   templateSlug: string;
   type: SendEventType;
   recipientEmail: string;
-}
+};
 
 export interface EmailEventTriggerConfig {
   types?: SendEventType[];

package/src/automation/send-template-action.ts

@@ -3,7 +3,10 @@ import type {
   JsonSchema,
 } from "@antelopejs/interface-dms-automation";
 import type { EmailAddress } from "@antelopejs/interface-email";
-import type { SendTemplateResult } from "@antelopejs/interface-dms-mailing";
+import type {
+  SendTemplateResult,
+  TemplateVariables,
+} from "@antelopejs/interface-dms-mailing";
 import { sendUnlessSuppressed } from "../services/checked-send";
 import { SEND_STATUSES } from "../types";
 
@@ -12,7 +15,7 @@ export interface SendTemplateActionInput {
   slug: string;
   to: EmailAddress | EmailAddress[];
   locale?: string;
-  variables?: Record<string, unknown>;
+  variables?: TemplateVariables;
   source?: string;
 }
 
@@ -42,12 +45,12 @@ const INPUT_SCHEMA: JsonSchema = {
   required: ["tenantId", "slug", "to"],
 };
 
-const RESULT_PROPERTIES: JsonSchema = {
+const RESULT_PROPERTIES = {
   sendId: { type: "string" },
   status: { type: "string", enum: SEND_STATUSES },
   messageId: { type: "string" },
   error: { type: "string" },
-};
+} satisfies { [name: string]: JsonSchema };
 
 const OUTPUT_SCHEMA: JsonSchema = {
   type: "object",
@@ -61,12 +64,21 @@ const OUTPUT_SCHEMA: JsonSchema = {
   },
 };
 
-const failedRecipients = (result: SendTemplateResult): SendTemplateResult[] =>
+/** What the action hands the graph: the send's result, as JSON. */
+type SendTemplateOutput = {
+  sendId: string;
+  status: SendTemplateResult["status"];
+  messageId?: string;
+  error?: string;
+  results?: SendTemplateOutput[];
+};
+
+const failedRecipients = (result: SendTemplateOutput): SendTemplateOutput[] =>
   (result.results ?? [result]).filter((entry) => entry.status === "failed");
 
 export const sendTemplateAction: ActionType<
   SendTemplateActionInput,
-  SendTemplateResult
+  SendTemplateOutput
 > = {
   id: SEND_TEMPLATE_ACTION_ID,
   name: "Send e-mail template",
@@ -78,13 +90,16 @@ export const sendTemplateAction: ActionType<
     const source =
       input.source ?? `${AUTOMATION_SOURCE_PREFIX}${ctx.procedureId}`;
     try {
-      const result = await sendUnlessSuppressed(input.slug, {
-        tenantId: input.tenantId,
-        to: input.to,
-        locale: input.locale,
-        variables: input.variables,
-        source,
-      });
+      const result: SendTemplateOutput = await sendUnlessSuppressed(
+        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(
@@ -95,7 +110,11 @@ export const sendTemplateAction: ActionType<
       }
       return result;
     } catch (error) {
-      ctx.log("error", `Template "${input.slug}" could not be sent`, error);
+      ctx.log(
+        "error",
+        `Template "${input.slug}" could not be sent`,
+        error instanceof Error ? error.message : String(error),
+      );
       throw error;
     }
   },

package/src/crons/jobs.ts

@@ -5,7 +5,7 @@ import cron, { type ScheduledTask } from "node-cron";
 export interface CronJob {
   name: string;
   schedule: string;
-  run: () => Promise<unknown>;
+  run: () => Promise<number | void>;
 }
 
 /** A job as it runs once scheduled. */

package/src/data/body.ts

@@ -1,13 +1,17 @@
 import { HTTPResult } from "@antelopejs/interface-api";
 import { HTTP_BAD_REQUEST } from "../constants";
+import type { JsonValue } from "../types/json";
+import { isText } from "../validation/guards";
+import { parseJson } from "../validation/json";
 
 const INVALID_BODY = "$dms_mailing.errors.invalid_body";
 
-export function parseBody(body: Buffer | string): Record<string, unknown> {
-  const raw = typeof body === "string" ? body : body.toString("utf8");
+/** The JSON a request body carries, `{}` for an empty one; 400 when it is not JSON. */
+export function parseBody(body: Buffer | string): JsonValue {
+  const raw = isText(body) ? body : body.toString("utf8");
   if (!raw) return {};
   try {
-    return JSON.parse(raw) as Record<string, unknown>;
+    return parseJson(raw);
   } catch {
     throw new HTTPResult(HTTP_BAD_REQUEST, INVALID_BODY);
   }

package/src/data/templates-table.ts

@@ -4,13 +4,17 @@ import {
   Parameter,
   type RequestContext,
 } from "@antelopejs/interface-api";
-import { assertValidation } from "@antelopejs/interface-api-util";
+import { assert, assertValidation } from "@antelopejs/interface-api-util";
+import { z } from "zod";
 import {
   DataController,
   type DataControllerCallback,
   RegisterDataController,
 } from "@antelopejs/interface-data-api";
-import type { Validation } from "@antelopejs/interface-data-api/components";
+import type {
+  Parameters,
+  Validation,
+} from "@antelopejs/interface-data-api/components";
 import {
   Access,
   AccessMode,
@@ -79,18 +83,23 @@ import {
   refuseTakenSlug,
 } from "../services/templates";
 import type { TemplateCategory } from "../types";
+import type { JsonObject } from "../types/json";
 
 import {
   createTemplateSchema,
-  templateDetailsSchema,
+  type TemplateDetails,
 } from "../validation/templates.schema";
+import { isObject, isText } from "../validation/guards";
+import { isJsonObject } from "../validation/json";
 import { parseBody } from "./body";
 import { CategoryDisplay, LocaleChipsDisplay } from "./displays";
 
 const SLUG_IMMUTABLE = "$dms_mailing.errors.slug_immutable";
 const SOURCE_NOT_FOUND = "$dms_mailing.errors.template_not_found";
 const STARTER_NOT_FOUND = "$dms_mailing.errors.starter_not_found";
-const INVALID_TEMPLATE = "$dms_mailing.errors.invalid_template";
+export type { TemplateDetails };
+
+export const INVALID_TEMPLATE = "$dms_mailing.errors.invalid_template";
 const UNKNOWN_CATEGORY = "$dms_mailing.errors.unknown_category";
 const TEMPLATE_IN_USE = "$dms_mailing.errors.template_in_use";
 const TEMPLATE_WAS_SENT = "$dms_mailing.errors.template_was_sent";
@@ -146,42 +155,40 @@ async function seedFields(
   return starterFields(starter, fallbackLocale);
 }
 
-const isBlank = (value: unknown) =>
-  value === undefined || value === null || value === "";
-
 /** A category is left empty or picked among the ones the settings declare. */
 function assertKnownCategory(
   categories: TemplateCategory[],
-  category: unknown,
+  category: string | undefined,
 ): void {
-  if (isBlank(category)) return;
-  if (typeof category === "string" && findCategory(categories, category)) {
-    return;
-  }
+  if (!category || findCategory(categories, category)) return;
   throw new HTTPResult(HTTP_UNPROCESSABLE, UNKNOWN_CATEGORY);
 }
 
-/** The row `new` answers since interface-data-api 0.3: its key and fields. */
-interface CreatedRow {
-  _id: string;
-  [field: string]: unknown;
+/** The key of the row `new` answers since interface-data-api 0.3. */
+const createdRowSchema = z.object({ _id: z.string() });
+
+/** The JSON object a creation sends; 400 for any other JSON. */
+function parseCreationBody(body: Buffer): JsonObject {
+  const parsed = parseBody(body);
+  assert(isJsonObject(parsed), HTTP_BAD_REQUEST, INVALID_TEMPLATE);
+  return parsed;
 }
 
 /**
  * The creation's seed, and the body to store: slug trimmed, and the name
  * typed in the reader's language as every language of the localized field,
  * the fallback one included until someone translates it. A body a guard
- * already parsed arrives as an object.
+ * already parsed arrives as an object. The body to store is handed on as an
+ * object: interface-data-api 0.3 refuses a JSON string.
  */
 function parseCreation(body: Validation.WrittenBody, locale: string) {
-  const raw = Buffer.isBuffer(body) ? parseBody(body) : body;
+  const raw = Buffer.isBuffer(body) ? parseCreationBody(body) : body;
   const seed = assertValidation(
     raw,
     (value) => createTemplateSchema.parse(value),
     () => INVALID_TEMPLATE,
     HTTP_BAD_REQUEST,
   );
-  // Handed as an object: interface-data-api 0.3 refuses a JSON string.
   const normalized = {
     ...raw,
     slug: seed.slug,
@@ -190,21 +197,22 @@ function parseCreation(body: Validation.WrittenBody, locale: string) {
   return { seed, normalized };
 }
 
-/** What the data API locks a localized field with: the controller's key. */
-interface LocalizedController {
-  language: string;
-}
-
 /** The key that writes every language of a localized field at once. */
 const ALL_LANGUAGES = "*";
 
+/**
+ * The data API's `new` callback, seeding the template it creates. The
+ * module's creation dialogs send one typed name, and the stored name holds
+ * every language, written at once: the controller's language key is set to
+ * all languages before the creation.
+ */
 function withSeeding(base: DataControllerCallback): DataControllerCallback {
   return {
     ...base,
     func: async function (
-      this: unknown,
+      this: TemplatesTableAPI,
       ctx: RequestContext,
-      params: unknown,
+      params: Parameters.NewParameters,
       body: Validation.WrittenBody,
       ...rest: unknown[]
     ) {
@@ -213,13 +221,11 @@ function withSeeding(base: DataControllerCallback): DataControllerCallback {
       const settings = await getSettings(tenantId);
       assertKnownCategory(settings.categories, seed.category);
       const fields = await seedFields(tenantId, seed, settings.fallbackLocale);
-      // The module's creation dialogs send one typed name; the stored name
-      // holds every language, written at once.
-      (this as LocalizedController).language = ALL_LANGUAGES;
-      const created = (await refuseTakenSlug(
-        base.func.call(this, ctx, params, normalized, ...rest),
-      )) as CreatedRow;
-      const templateId = created._id;
+      this.language = ALL_LANGUAGES;
+      const created: unknown = await refuseTakenSlug(
+        Promise.resolve(base.func.call(this, ctx, params, normalized, ...rest)),
+      );
+      const templateId = createdRowSchema.parse(created)._id;
       const user = await authenticateTenantRequest(ctx);
       await initializeTemplate(tenantId, templateId, displayName(user), fields);
       return created;
@@ -296,10 +302,17 @@ export async function assertEditable(
 ): Promise<void> {
   if (body.slug !== undefined && body.slug !== current.slug)
     throw new HTTPResult(HTTP_CONFLICT, SLUG_IMMUTABLE);
-  if (body.name !== undefined && isBlankName(body.name))
-    throw new HTTPResult(HTTP_BAD_REQUEST, BLANK_NAME);
+  if (body.name !== undefined) {
+    const texts = isObject(body.name) ? Object.values(body.name) : [body.name];
+    if (!texts.some((text) => isText(text) && text.trim()))
+      throw new HTTPResult(HTTP_BAD_REQUEST, BLANK_NAME);
+  }
   const { categories } = await getSettings(tenantId);
-  assertKnownCategory(categories, body.category);
+  const { category } = body;
+  if (category === undefined || category === null || category === "") return;
+  if (!isText(category))
+    throw new HTTPResult(HTTP_UNPROCESSABLE, UNKNOWN_CATEGORY);
+  assertKnownCategory(categories, category);
 }
 
 /**
@@ -309,14 +322,9 @@ export async function assertEditable(
 export async function saveDetails(
   ctx: RequestContext,
   template: MailingTemplate,
-  body: unknown,
+  details: TemplateDetails,
   author: string,
 ): Promise<void> {
-  const details = assertValidation(
-    body,
-    (value) => templateDetailsSchema.parse(value),
-    () => INVALID_TEMPLATE,
-  );
   const tenantId = getRequestTenantId(ctx);
   await assertEditable(tenantId, details, template);
   const names = TemplateModel.namesOf(template);
@@ -329,15 +337,6 @@ export async function saveDetails(
   });
 }
 
-/**
- * Whether an edited name holds no text: the text of the reader's language,
- * or, from a form editing every language, all of them.
- */
-function isBlankName(name: unknown): boolean {
-  const texts = typeof name === "object" && name ? Object.values(name) : [name];
-  return !texts.some((text) => typeof text === "string" && text.trim());
-}
-
 /** The names trimmed, blank ones left out, the fallback language filled. */
 function tidyNames(names: LocalizedText, locale: string): LocalizedText {
   const tidy = Object.fromEntries(
@@ -357,10 +356,8 @@ function tidyNames(names: LocalizedText, locale: string): LocalizedText {
 export function afterEdit(
   model: TemplateModel,
   id: string,
-  name: unknown,
   locale: string,
-): AfterWrite | undefined {
-  if (name === undefined) return undefined;
+): AfterWrite {
   return async () => {
     const template = await model.get(id);
     if (!template) return;
@@ -372,8 +369,10 @@ export function afterEdit(
 }
 
 /** The templates the attention refresh flagged. */
-const isFlagged: FilterFunction<Record<string, unknown>> = (_context, proxy) =>
-  proxy.default(false).eq(true);
+const isFlagged: FilterFunction<TemplatesTableAPI, TemplatesTableAPI> = (
+  _context,
+  proxy,
+) => proxy.default(false).eq(true);
 
 const templateRoutes = {
   ...TableViewRoutes.All,

package/src/data-types/categories-type.ts

@@ -12,8 +12,8 @@ import { categoriesSchema } from "../validation/settings.schema";
  */
 @RegisterDataType(TEMPLATE_CATEGORIES_TYPE_ID)
 export class TemplateCategoriesType extends DataType {
-  constructor(public readonly options: Record<string, unknown> = {}) {
-    super([], undefined, options);
+  constructor() {
+    super([], undefined, {});
   }
 
   protected defaultInputComponent() {

package/src/data-types/category-type.ts

@@ -19,7 +19,7 @@ import { TEMPLATE_CATEGORY_TYPE_ID } from "../constants";
  */
 @RegisterDataType(TEMPLATE_CATEGORY_TYPE_ID)
 export class TemplateCategoryType extends DataType {
-  constructor(public readonly options: Record<string, unknown> = {}) {
+  constructor() {
     super(
       [
         DefaultDataCompareTypes.Is,
@@ -28,7 +28,7 @@ export class TemplateCategoryType extends DataType {
         DefaultDataCompareTypes.IsNotEmpty,
       ],
       DefaultDataCompareTypes.Is,
-      options,
+      {},
     );
   }
 

package/src/db/models/sends.model.ts

@@ -123,7 +123,7 @@ export class SendModel extends BasicDataModel(
       .filter((row) => row.key("createdAt").ge(from))
       .filter((row) => row.key("createdAt").lt(to))
       .without("json_variables")
-      .run() as Promise<SendSummary[]>;
+      .run();
   }
 
   listOlderThan(limit: Date, pageSize: number): Promise<MailingSend[]> {
@@ -260,7 +260,7 @@ export class SendModel extends BasicDataModel(
       .getAll(templateSlug, "templateSlug")
       .filter((row) => row.key("createdAt").ge(from))
       .without("json_variables")
-      .run() as Promise<SendSummary[]>;
+      .run();
   }
 
   /** How many sends the retention would delete with this cutoff. */

package/src/db/models/template-versions.model.ts

@@ -11,6 +11,8 @@ export function committedVersionOf(
   template: Pick<MailingTemplate, "json_published_version">,
 ): MailingTemplateVersion | undefined {
   if (!template.json_published_version) return undefined;
+  // SAFETY: json_published_version is written only by publishSnapshot and publishedAtCreation as the
+  // JSON.stringify of the version row they insert; its publishedAt reads back as a string, and the next line restores the Date.
   const row = JSON.parse(
     template.json_published_version,
   ) as MailingTemplateVersion;
@@ -33,20 +35,24 @@ export class TemplateVersionModel extends BasicDataModel(
       await this.insert(version);
     } catch (error) {
       const stored = await this.get(version._id);
+      if (!stored) throw error;
+      const storedFields = new Map(Object.entries(stored));
       if (
-        !stored ||
         Object.entries(version).some(
           ([key, value]) =>
-            JSON.stringify(stored[key as keyof MailingTemplateVersion]) !==
-            JSON.stringify(value),
+            JSON.stringify(storedFields.get(key)) !== JSON.stringify(value),
         )
       )
         throw error;
     }
   }
 
+  /**
+   * The published versions of a template, newest first. It reads the
+   * template's publication before the version rows: any later publication
+   * must have materialized the version that read names.
+   */
   async listForTemplate(templateId: string): Promise<MailingTemplateVersion[]> {
-    // Read the publication first: any later publication must have materialized it.
     const template = await new TemplateModel(this.database).get(templateId);
     if (!template) return [];
     const rows = await this.getBy("templateId", templateId);

package/src/db/models/templates.model.ts

@@ -5,6 +5,7 @@ import {
 } from "@antelopejs/interface-database-decorators";
 import type { LocalizedText } from "@antelopejs/interface-dms-mailing";
 import { MAILING_TEMPLATES_TABLE_NAME, MailingTemplate } from "../tables";
+import { isText } from "../../validation/guards";
 
 /** The attention fields of a template, as the refresh writes them. */
 export type TemplateAttentionFields = Pick<
@@ -15,7 +16,7 @@ export type TemplateAttentionFields = Pick<
 const isLocalizedText = (value: unknown): value is LocalizedText =>
   typeof value === "object" &&
   value !== null &&
-  Object.values(value).every((text) => typeof text === "string");
+  Object.values(value).every(isText);
 
 /** Where a row keeps its modifier-held fields, the localized name among them. */
 const MODIFIER_CONTAINER = "_internal";
@@ -37,9 +38,11 @@ export class TemplateModel extends BasicDataModel(
     return TemplateModel.fromPlainData(fields).localize("*", ["name"]);
   }
 
-  /** The names of `template`, one per language. */
+  /**
+   * The names of `template`, one per language: unlocked with `"*"`, the
+   * localized field holds the whole per-language record.
+   */
   static namesOf(template: MailingTemplate): LocalizedText {
-    // Unlocked with "*", the localized field holds the whole per-language record.
     const names: unknown = template.localize("*", ["name"]).name;
     return isLocalizedText(names) ? names : {};
   }

package/src/db/tables/templates.table.ts

@@ -156,7 +156,7 @@ export class MailingTemplate extends Table.with(LocalizationModifier) {
 
 /** Covers model updates and generated data-api edits in the same database write. */
 class TemplateRevisionModifier extends Modifier {
-  update(object: Record<string, unknown>, field: string): void {
+  update(object: Pick<MailingTemplate, "revision">, field: "revision"): void {
     object[field] = randomUUID();
   }
 }