@cosmicdrift/kumiko-renderer-mail-html 0.377.0 → 0.379.0

package/dist/render.js

@@ -22,6 +22,8 @@ import { buildMailBandLinksHtml, buildMailFooterHtml, layoutLinksToPlaceholder,
 import { mailChromeText } from "./mail-strings.js";
 import { MAIL_IMAGE_MAX_WIDTH_PX, renderStructuredLayoutMjml } from "./structured-layout.js";
 const LINE_BREAKS = /[\r\n]+/g;
+const PLAIN_REFERENCE = /\{\{\s*([\w.]+)\s*\}\}/g;
+const FORMATTED_VARIABLE_TYPES = new Set(["money", "date", "percent"]);
 function describe(e) {
     return e instanceof Error ? e.message : String(e);
 }
@@ -211,24 +213,35 @@ async function renderMailBody(tplApi, ctx, template, hbs, context, buttonInlineS
         throw new RendererError(`renderer-mail-html: rendering the body of "${template.slug}" failed — ${describe(e)}`, "other");
     }
 }
-function renderSubjectLine(hbs, source, context) {
-    return compileDocumentSource(hbs, source, { noEscape: true })(context).replace(LINE_BREAKS, "");
+// Meta lines only hold plain {{name}} references (checked on save); typed values
+// need the same format helpers the body compiler adds, or money renders as "[object Object]".
+function withFormatHelpers(source, variables) {
+    return source.replace(PLAIN_REFERENCE, (reference, name) => {
+        const type = variables[name]?.type;
+        return type !== undefined && FORMATTED_VARIABLE_TYPES.has(type)
+            ? `{{${type} ${name}}}`
+            : reference;
+    });
+}
+function renderSubjectLine(hbs, source, context, variables) {
+    return compileDocumentSource(hbs, withFormatHelpers(source, variables), { noEscape: true })(context).replace(LINE_BREAKS, "");
 }
 function renderFileNamePattern(hbs, pattern, slug, context) {
     try {
-        return renderSubjectLine(hbs, pattern, context);
+        // File names keep raw values: a formatted date or amount would put spaces into the name.
+        return renderSubjectLine(hbs, pattern, context, {});
     }
     catch (e) {
         throw new RendererError(`renderer-mail-html: rendering the attachment file name "${pattern}" of "${slug}" failed — ${describe(e)}`, "other");
     }
 }
-function renderSubjectLines(hbs, meta, slug, context) {
+function renderSubjectLines(hbs, meta, slug, context, variables) {
     try {
         return {
-            subject: renderSubjectLine(hbs, meta.subject, context),
+            subject: renderSubjectLine(hbs, meta.subject, context, variables),
             previewText: meta.previewText === undefined
                 ? undefined
-                : renderSubjectLine(hbs, meta.previewText, context),
+                : renderSubjectLine(hbs, meta.previewText, context, variables),
         };
     }
     catch (e) {
@@ -236,8 +249,8 @@ function renderSubjectLines(hbs, meta, slug, context) {
     }
 }
 // Chip and tone are author-chosen per mail; a chip without a known tone takes the accent tone.
-function renderMailChrome(hbs, meta, slug, context, brandColor) {
-    const render = (source) => source === undefined ? "" : renderSubjectLine(hbs, source, context).trim();
+function renderMailChrome(hbs, meta, slug, context, variables, brandColor) {
+    const render = (source) => source === undefined ? "" : renderSubjectLine(hbs, source, context, variables).trim();
     try {
         const headerChip = render(meta.headerChip);
         const tone = readMailTone(render(meta.tone));
@@ -464,7 +477,7 @@ export async function mailHtmlRender(req, ctx, options = {}) {
         throw new RendererError(`renderer-mail-html supports only kind="mail", got "${req.kind}"`, "invalid_payload");
     }
     const { slug, locale, variables, unsubscribeUrl, draft } = req.payload;
-    const tplApi = createTemplateResolverApi(ctx.db);
+    const tplApi = createTemplateResolverApi(ctx.db, ctx.registry);
     const { template, meta } = await resolveMailTemplate(tplApi, ctx, slug, locale, draft);
     const [format, tenantName, footer, siteUrl, brandSuffix, brandingLogoUrl] = await Promise.all([
         readDocumentFormat(ctx, locale),
@@ -483,8 +496,9 @@ export async function mailHtmlRender(req, ctx, options = {}) {
         unsubscribeUrl: unsubscribeUrl ?? "",
     };
     const context = { ...variables, ...systemPlaceholders };
+    const variableDefs = resolveTemplateVariables(ctx.registry, template.slug, template.variableSchema);
     const { appearance, accentColor, brandColor } = await resolveMailBranding(ctx, layout);
-    const chrome = renderMailChrome(hbs, meta, slug, context, brandColor);
+    const chrome = renderMailChrome(hbs, meta, slug, context, variableDefs, brandColor);
     const body = await renderMailBody(tplApi, ctx, template, hbs, context, appearance?.buttonStyle, chrome.tone?.bar ?? brandColor ?? DEFAULT_ACCENT_COLOR, brandingLogoUrl);
     const { contentHtml } = body;
     const layoutFileRefs = await resolveLayoutFileRefs(tplApi, ctx, layout);
@@ -498,7 +512,7 @@ export async function mailHtmlRender(req, ctx, options = {}) {
         locale,
         renderFileName: (pattern) => renderFileNamePattern(hbs, pattern, slug, context),
     });
-    const { subject, previewText } = renderSubjectLines(hbs, meta, slug, context);
+    const { subject, previewText } = renderSubjectLines(hbs, meta, slug, context, variableDefs);
     const mjmlSource = compileLayoutMjml({
         layout,
         hbs,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-renderer-mail-html",
-  "version": "0.377.0",
+  "version": "0.379.0",
   "description": "Renderer-Foundation plugin for branded HTML emails: mail-kind templates (document HTML + subject meta) rendered with isolated Handlebars into an MJML layout, plus plain text via html-to-text. Templates resolved from template-resolver.",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",
@@ -19,17 +19,17 @@
     }
   },
   "dependencies": {
-    "@cosmicdrift/kumiko-bundled-features": "0.377.0",
-    "@cosmicdrift/kumiko-framework": "0.377.0",
-    "@cosmicdrift/kumiko-renderer": "0.377.0",
-    "@cosmicdrift/kumiko-types": "0.377.0",
+    "@cosmicdrift/kumiko-bundled-features": "0.379.0",
+    "@cosmicdrift/kumiko-framework": "0.379.0",
+    "@cosmicdrift/kumiko-renderer": "0.379.0",
+    "@cosmicdrift/kumiko-types": "0.379.0",
     "handlebars": "^4.7.8",
     "html-to-text": "^9.0.5",
     "mjml": "^5.2.2"
   },
   "devDependencies": {
-    "@cosmicdrift/kumiko-locale-de": "0.377.0",
-    "@cosmicdrift/kumiko-testing": "0.377.0",
+    "@cosmicdrift/kumiko-locale-de": "0.379.0",
+    "@cosmicdrift/kumiko-testing": "0.379.0",
     "@types/html-to-text": "^9.0.4",
     "@types/mjml": "^5.0.0"
   },

package/src/changes.json

@@ -1,4 +1,10 @@
 [
+  {
+    "version": "0.378.0",
+    "type": "fix",
+    "title": "Typed placeholders in mail subject lines are formatted",
+    "detail": "A money placeholder in the subject or preview text rendered as \"[object Object]\" and a date as its raw ISO string, because only the body compiler added the format helpers. Subject, preview text, header chip, tone and footer note now use the same money, date and percent formatting as the body. Attachment file names keep the raw values."
+  },
   {
     "version": "0.377.0",
     "type": "improvement",