@antelopejs/dms-mailing 0.6.1 → 0.7.1

package/src/routes/templates.ts

@@ -5,6 +5,7 @@ import {
   JSONBody,
   Parameter,
   Post,
+  Put,
   type RequestContext,
 } from "@antelopejs/interface-api";
 import { assert, assertValidation } from "@antelopejs/interface-api-util";
@@ -22,12 +23,21 @@ import {
   collectContentVariablePaths,
   resolveEmail,
   type TemplateChange,
+  valueFormatOf,
 } from "../engine";
-import { type MailingTemplate, SendModel, TemplateModel } from "../db";
+import {
+  type MailingTemplate,
+  SendModel,
+  type TemplateFields,
+  TemplateModel,
+} from "../db";
+import { saveDetails } from "../data/templates-table";
 import { TemplatesPageController } from "../pages/templates";
 import { forAudience, statsWindowStart } from "../services/metrics";
 import { refreshTemplateAttention } from "../services/template-attention";
 import { renderEmailHtml } from "../services/render";
+import { categoriesIn } from "../services/categories";
+import { localeOfRequest, withTextIn } from "../services/localized-text";
 import { getSettings } from "../services/settings";
 import { findStarter, STARTER_TEMPLATES } from "../services/starters";
 import {
@@ -37,9 +47,7 @@ import {
   type TemplateStats,
 } from "../services/template-stats";
 import {
-  assertSlugClaimed,
   contentFieldsOf,
-  contentOfVersion,
   discardDraft,
   displayName,
   hasDraft,
@@ -55,13 +63,18 @@ import {
   publishedVersionOf,
   publishTemplate,
   saveDraft,
+  publishedSnapshot,
+  snapshotOfVersion,
+  type TemplateDraft,
+  workingSnapshot,
   workingContent,
   workingVariables,
+  refuseTakenSlug,
   requireTemplate,
 } from "../services/templates";
 import {
   BUSINESS_AUDIENCE,
-  type MailingSettingsValues,
+  type CategoryInLocale,
   type TemplateContent,
   type TemplateStatus,
   type VariableDefinition,
@@ -76,7 +89,6 @@ import {
 } from "../validation/templates.schema";
 
 const STARTER_NOT_FOUND = "$dms_mailing.errors.starter_not_found";
-const DUPLICATE_SLUG = "$dms_mailing.errors.duplicate_slug";
 const INVALID_CONTENT = "$dms_mailing.errors.invalid_content";
 const INVALID_TRANSITION = "$dms_mailing.errors.invalid_transition";
 const NOTHING_TO_PUBLISH = "$dms_mailing.errors.nothing_to_publish";
@@ -104,14 +116,13 @@ const TARGET_STATUS: Record<
 };
 
 /** What a lifecycle action records besides the new status. */
-const TRANSITION_FIELDS: Partial<
-  Record<TemplateAction, () => Partial<MailingTemplate>>
-> = {
-  unpublish: () => ({ unpublishedAt: new Date() }),
-};
+const TRANSITION_FIELDS: Partial<Record<TemplateAction, () => TemplateFields>> =
+  {
+    unpublish: () => ({ unpublishedAt: new Date() }),
+  };
 
 export interface CategoriesResponse {
-  categories: MailingSettingsValues["categories"];
+  categories: CategoryInLocale[];
 }
 
 export interface TemplateSender {
@@ -121,6 +132,7 @@ export interface TemplateSender {
 }
 
 export interface TemplateContentResponse {
+  /** The template, its name in the reader's language. */
   template: MailingTemplate;
   /** The content the editor works on: the draft, else the published one. */
   content: TemplateContent;
@@ -146,7 +158,7 @@ export interface TemplateContentResponse {
   fallbackLocale: string;
   /** Whether a send missing a variable fails rather than goes out blank. */
   blockOnMissingVariables: boolean;
-  categories: MailingSettingsValues["categories"];
+  categories: CategoryInLocale[];
   sender: TemplateSender;
 }
 
@@ -192,6 +204,11 @@ export class TemplatesController extends Controller(
     return displayName(this.user);
   }
 
+  /** The language the reader reads names and labels in. */
+  private get locale(): string {
+    return localeOfRequest(this.ctx);
+  }
+
   /**
    * The tenant's categories for a category picker. Separate from `/settings`,
    * which is guarded by the settings page permission a template editor need
@@ -200,7 +217,7 @@ export class TemplatesController extends Controller(
   @Get("/categories")
   async categories(): Promise<CategoriesResponse> {
     const settings = await getSettings(this.tenantId);
-    return { categories: settings.categories };
+    return { categories: categoriesIn(settings.categories, this.locale) };
   }
 
   @Get("/starters")
@@ -236,7 +253,12 @@ export class TemplatesController extends Controller(
     );
     const localeContent = localeContentOf(starter.content, locale);
     assert(localeContent, HTTP_UNPROCESSABLE, INVALID_CONTENT);
-    const email = resolveEmail(localeContent, starter.testDataFor(locale));
+    const email = resolveEmail(
+      localeContent,
+      starter.testDataFor(locale),
+      undefined,
+      valueFormatOf(locale, starter.variables),
+    );
     return { html: await renderEmailHtml(email, locale), locale };
   }
 
@@ -289,7 +311,7 @@ export class TemplatesController extends Controller(
       ? parseContent(template)
       : null;
     return {
-      template,
+      template: template.localize(this.locale, ["name"]),
       content,
       publishedContent,
       hasDraft: hasDraft(template),
@@ -305,7 +327,7 @@ export class TemplatesController extends Controller(
       testData: parseTestData(template),
       fallbackLocale: settings.fallbackLocale,
       blockOnMissingVariables: settings.blockOnMissingVariables,
-      categories: settings.categories,
+      categories: categoriesIn(settings.categories, this.locale),
       sender: {
         name: settings.senderName,
         email: settings.senderEmail,
@@ -431,7 +453,7 @@ export class TemplatesController extends Controller(
   ) {
     await this.requireTransition(id, action);
     const status = TARGET_STATUS[action];
-    await this.templates.update(id, {
+    await this.templates.updateFields(id, {
       status,
       updatedBy: this.author,
       ...TRANSITION_FIELDS[action]?.(),
@@ -472,7 +494,9 @@ export class TemplatesController extends Controller(
       testDataSchema.parse(value),
     );
     await requireTemplate(this.templates, id);
-    await this.templates.update(id, { json_test_data: JSON.stringify(data) });
+    await this.templates.updateFields(id, {
+      json_test_data: JSON.stringify(data),
+    });
     return { data };
   }
 
@@ -487,9 +511,12 @@ export class TemplatesController extends Controller(
       () => INVALID_CONTENT,
     );
     const template = await requireTemplate(this.templates, id);
-    const content =
-      (input.content as TemplateContent | undefined) ??
-      (await this.previewContent(template, input.version));
+    const { content, variables } = input.content
+      ? {
+          ...workingSnapshot(template),
+          content: input.content as TemplateContent,
+        }
+      : await this.previewSnapshot(template, input.version);
     const settings = await getSettings(this.tenantId);
     const locale = pickLocale(content, input.locale, settings.fallbackLocale);
     const localeContent = localeContentOf(content, locale);
@@ -497,6 +524,8 @@ export class TemplatesController extends Controller(
     const email = resolveEmail(
       localeContent,
       input.data ?? parseTestData(template),
+      undefined,
+      valueFormatOf(locale, variables),
     );
     const html = await renderEmailHtml(email, locale);
     return {
@@ -508,14 +537,30 @@ export class TemplatesController extends Controller(
     };
   }
 
-  private previewContent(
+  private previewSnapshot(
     template: MailingTemplate,
     version: "draft" | "published" | number | undefined,
-  ): Promise<TemplateContent> | TemplateContent {
-    if (version === "published") return parseContent(template);
+  ): Promise<TemplateDraft> | TemplateDraft {
+    if (version === "published") return publishedSnapshot(template);
     if (typeof version === "number")
-      return contentOfVersion(this.tenantId, template, version);
-    return workingContent(template);
+      return snapshotOfVersion(this.tenantId, template, version);
+    return workingSnapshot(template);
+  }
+
+  /**
+   * Renames a template in the reader's language, its other languages kept,
+   * and sets its category: what the module's drawer and editor save, each
+   * showing one language. The DMS edit form, which shows every language,
+   * writes through the table's edit route.
+   */
+  @Put("/:id/details")
+  async details(
+    @Parameter("id", "param") id: string,
+    @JSONBody() body: unknown,
+  ) {
+    const template = await requireTemplate(this.templates, id);
+    await saveDetails(this.ctx, template, body, this.author);
+    return { id };
   }
 
   @Post("/:id/duplicate")
@@ -527,17 +572,16 @@ export class TemplatesController extends Controller(
       duplicateSchema.parse(value),
     );
     const source = await requireTemplate(this.templates, id);
-    const clash = await this.templates.getBySlug(slug);
-    assert(!clash, HTTP_CONFLICT, DUPLICATE_SLUG);
-    const [copyId] = await this.templates.insert({
-      slug,
-      name,
-      category: source.category,
-      status: "draft",
-      ...contentFieldsOf(source),
-      updatedBy: this.author,
-    });
-    await assertSlugClaimed(this.tenantId, slug, copyId as string);
+    const [copyId] = await refuseTakenSlug(
+      this.templates.insertFields({
+        slug,
+        name: withTextIn(undefined, this.locale, name),
+        category: source.category,
+        status: "draft",
+        ...contentFieldsOf(source),
+        updatedBy: this.author,
+      }),
+    );
     await refreshTemplateAttention(this.tenantId);
     return { id: copyId };
   }

package/src/services/categories.ts

@@ -1,6 +1,19 @@
 import type { MailingTemplate } from "../db";
-import type { TemplateCategory } from "../types";
+import type { CategoryInLocale, TemplateCategory } from "../types";
 import type { CategoryEntry } from "../validation/settings.schema";
+import { textIn } from "./localized-text";
+
+/** The categories as a reader of `locale` sees them. */
+export function categoriesIn(
+  categories: TemplateCategory[],
+  locale: string,
+): CategoryInLocale[] {
+  return categories.map(({ id, label, icon }) => ({
+    id,
+    label: textIn(label, locale),
+    icon,
+  }));
+}
 
 /** The categories a list keeps, without the removed ones it moves away. */
 export function keptCategories(entries: CategoryEntry[]): TemplateCategory[] {