@cosmicdrift/kumiko-bundled-features 0.362.0 → 0.364.0

package/dist/renderer-simple/simple-renderer.js

@@ -1,200 +0,0 @@
-import { escapeHtml, escapeHtmlAttr } from "@cosmicdrift/kumiko-headless";
-import { renderSafeMarkdown } from "../page-render/index.js";
-import { badgeText, chipsText, parseBadge, renderBadge, renderChips, renderStages, stagesText, } from "./mail-blocks.js";
-const DEFAULT_PRIMARY_COLOR = "#2563eb";
-const HEX_COLOR_PATTERN = /^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/;
-function isHttpUrl(value) {
-    try {
-        const { protocol } = new URL(value);
-        return protocol === "http:" || protocol === "https:";
-    }
-    catch {
-        return false;
-    }
-}
-function languagePart(locale) {
-    return locale.split("-")[0] ?? locale;
-}
-function pickByLocale(entries, locale) {
-    // Own keys only: a locale like "constructor" must not hit Object.prototype.
-    const ownEntry = (key) => Object.hasOwn(entries, key) ? entries[key] : undefined;
-    return ownEntry(locale) ?? ownEntry(languagePart(locale));
-}
-function resolveLocalized(value, locale, defaultLocale) {
-    if (value === undefined || typeof value === "string")
-        return value;
-    return ((locale !== undefined ? pickByLocale(value, locale) : undefined) ??
-        (defaultLocale !== undefined ? pickByLocale(value, defaultLocale) : undefined) ??
-        Object.values(value)[0]);
-}
-function assertLocalizedUrlsAreHttp(branding) {
-    for (const link of branding.footerLinks ?? []) {
-        if (typeof link.url === "string")
-            continue;
-        for (const [locale, url] of Object.entries(link.url)) {
-            if (!isHttpUrl(url)) {
-                throw new Error(`createSimpleRenderer: footerLinks url for locale "${locale}" must be an absolute http(s) URL`);
-            }
-        }
-    }
-}
-function resolveLogoUrl(branding) {
-    if (!branding)
-        return undefined;
-    const { logoUrl, logoPath, baseUrl } = branding;
-    if (logoPath === undefined) {
-        return logoUrl && isHttpUrl(logoUrl) ? logoUrl : undefined;
-    }
-    if (logoUrl !== undefined) {
-        throw new Error("createSimpleRenderer: logoPath and logoUrl are mutually exclusive");
-    }
-    if (baseUrl === undefined || !isHttpUrl(baseUrl)) {
-        throw new Error("createSimpleRenderer: logoPath requires an absolute http(s) baseUrl");
-    }
-    if (!/^\/(?![/\\])/.test(logoPath) || logoPath.includes("\\")) {
-        throw new Error('createSimpleRenderer: logoPath must start with a single "/"');
-    }
-    const resolved = new URL(logoPath, baseUrl);
-    if (resolved.origin !== new URL(baseUrl).origin) {
-        throw new Error("createSimpleRenderer: logoPath must stay on the baseUrl origin");
-    }
-    return resolved.href;
-}
-function resolvePrimaryColor(branding) {
-    const color = branding?.primaryColor;
-    return color && HEX_COLOR_PATTERN.test(color) ? color : DEFAULT_PRIMARY_COLOR;
-}
-function renderBrandingHeader(branding, primaryColor, logoUrl) {
-    if (!branding)
-        return "";
-    if (!logoUrl && !branding.productName)
-        return "";
-    const logo = logoUrl
-        ? `<img src="${escapeHtmlAttr(logoUrl)}" alt="${escapeHtmlAttr(branding.productName ?? "")}" style="display:block;max-height:40px;max-width:200px;border:0" />`
-        : `<span style="font-size:18px;font-weight:700;color:${escapeHtmlAttr(primaryColor)}">${escapeHtml(branding.productName ?? "")}</span>`;
-    return `<div style="margin:0 0 24px;padding:0 0 16px;border-bottom:3px solid ${escapeHtmlAttr(primaryColor)}">${logo}</div>`;
-}
-function resolveBrandingFooter(branding, locale) {
-    const pick = (value) => resolveLocalized(value, locale, branding.defaultLocale);
-    const links = (branding.footerLinks ?? []).flatMap((link) => {
-        const url = pick(link.url);
-        if (url === undefined || !isHttpUrl(url))
-            return [];
-        return [{ label: pick(link.label) ?? "", url }];
-    });
-    return { footerText: pick(branding.footerText), links };
-}
-function renderBrandingFooter(branding, locale) {
-    if (!branding)
-        return "";
-    const { footerText, links: resolvedLinks } = resolveBrandingFooter(branding, locale);
-    const links = resolvedLinks.map((link) => `<a href="${escapeHtmlAttr(link.url)}" style="color:#999">${escapeHtml(link.label)}</a>`);
-    const footerPartsHtml = [footerText ? escapeHtml(footerText) : "", links.join(" · ")].filter((part) => part !== "");
-    if (footerPartsHtml.length === 0)
-        return "";
-    const footerHtml = footerPartsHtml.join("<br />");
-    return `<p style="margin:16px 0 0;color:#999;font-size:12px">${footerHtml}</p>`;
-}
-function brandingFooterLines(branding, locale) {
-    if (!branding)
-        return [];
-    const { footerText, links } = resolveBrandingFooter(branding, locale);
-    return [
-        ...(footerText ? [footerText] : []),
-        ...links.map((link) => (link.label ? `${link.label}: ${link.url}` : link.url)),
-    ];
-}
-function templateContent(variables) {
-    const data = variables; // @cast-boundary render-helper
-    // Without structured fields, title + body become the header and a single text section.
-    return {
-        badge: parseBadge(data.badge),
-        header: data.header ?? data.title,
-        sections: data.sections ?? (data.body ? [{ text: data.body }] : undefined),
-        footer: data.footer,
-    };
-}
-// Markdown stays as written: its source is already readable plain text.
-function sectionText(section) {
-    if ("text" in section)
-        return section.text;
-    if ("heading" in section)
-        return section.heading;
-    if ("markdown" in section)
-        return section.markdown;
-    if ("button" in section)
-        return `${section.button.label}: ${section.button.url}`;
-    if ("stages" in section)
-        return stagesText(section.stages);
-    if ("chips" in section)
-        return chipsText(section.chips);
-    return "";
-}
-function renderSection(section, primaryColor) {
-    if ("text" in section) {
-        return `<p style="margin:0 0 16px;color:#333;font-size:14px;line-height:1.5">${escapeHtml(section.text)}</p>`;
-    }
-    if ("heading" in section) {
-        return `<h2 style="margin:24px 0 12px;color:#111;font-size:16px;font-weight:600">${escapeHtml(section.heading)}</h2>`;
-    }
-    if ("markdown" in section) {
-        const markdownHtml = renderSafeMarkdown(section.markdown);
-        return `<div style="color:#333;font-size:14px;line-height:1.5">${markdownHtml}</div>`;
-    }
-    if ("button" in section) {
-        return `<p style="margin:0 0 16px"><a href="${escapeHtml(section.button.url)}" style="display:inline-block;padding:10px 24px;background:${escapeHtmlAttr(primaryColor)};color:#fff;text-decoration:none;border-radius:4px;font-size:14px">${escapeHtml(section.button.label)}</a></p>`;
-    }
-    if ("stages" in section)
-        return renderStages(section.stages, primaryColor);
-    if ("chips" in section)
-        return renderChips(section.chips);
-    return "";
-}
-// Simple Renderer: turns structured email template data into HTML with inline CSS.
-// No external dependencies, no template engine — just string concatenation.
-export function createSimpleRenderer(branding) {
-    const primaryColor = resolvePrimaryColor(branding);
-    const logoUrl = resolveLogoUrl(branding);
-    if (branding)
-        assertLocalizedUrlsAreHttp(branding);
-    return {
-        name: "simple",
-        async render(input) {
-            const { badge, header, sections, footer } = templateContent(input.variables);
-            const parts = [];
-            parts.push('<!DOCTYPE html><html><body style="margin:0;padding:0;font-family:sans-serif">');
-            parts.push('<div style="max-width:600px;margin:0 auto;padding:24px">');
-            parts.push(renderBrandingHeader(branding, primaryColor, logoUrl));
-            if (badge)
-                parts.push(renderBadge(badge));
-            if (header) {
-                parts.push(`<h1 style="margin:0 0 24px;color:#111;font-size:20px;font-weight:600">${escapeHtml(header)}</h1>`);
-            }
-            if (sections) {
-                for (const section of sections) {
-                    parts.push(renderSection(section, primaryColor));
-                }
-            }
-            if (footer) {
-                parts.push(`<p style="margin:24px 0 0;color:#999;font-size:12px;border-top:1px solid #eee;padding-top:16px">${escapeHtml(footer)}</p>`);
-            }
-            parts.push(renderBrandingFooter(branding, input.locale));
-            parts.push("</div></body></html>");
-            return parts.join("");
-        },
-        async renderText(input) {
-            const { badge, header, sections, footer } = templateContent(input.variables);
-            const brandingFooter = brandingFooterLines(branding, input.locale).join("\n");
-            return [
-                badge ? badgeText(badge) : undefined,
-                header,
-                ...(sections ?? []).map(sectionText),
-                footer,
-                brandingFooter,
-            ]
-                .filter((block) => block !== undefined && block !== "")
-                .join("\n\n");
-        },
-    };
-}
-export const simpleRenderer = createSimpleRenderer();

package/src/renderer-simple/changes.json

@@ -1,27 +0,0 @@
-[
-  {
-    "version": "0.352.0",
-    "type": "improvement",
-    "title": "Badge, stages track and chips for the simple mail renderer",
-    "detail": "Use badge, { stages } and { chips } in the template variables; the notification RenderResponse carries the matching plain text in text."
-  },
-  {
-    "version": "0.344.0",
-    "type": "improvement",
-    "title": "Heading and Markdown sections in the simple mail renderer",
-    "detail": "`createSimpleRenderer` accepts two more section kinds: `{ heading: string }` (rendered as an escaped `<h2>`) and `{ markdown: string }` (rendered with the hardened Markdown renderer; raw HTML is escaped and unsafe link targets are replaced by `#`). Existing section kinds render as before."
-  },
-  {
-    "version": "0.341.0",
-    "type": "improvement",
-    "title": "Localized mail branding, locale through delivery, logoPath",
-    "detail": "`ctx.notify` accepts `locale`, and the locale now travels through the delivery jobs (`delivery.render`, `delivery.send`) to `NotificationRenderer.render`, where `RendererInput.locale` is available. Jobs queued before this release have no locale and keep working. The email channel and `renderer-simple` pass it on; the auth mails and the consumer-protection mails set it to the language they already translate their content into. This lands in the same release as the `NotifyOptions` change from #3508.\n`MailBranding` for `renderer-simple` can now be localized: `footerText`, `footerLinks[].label` and `footerLinks[].url` take a plain string or a map of locale to string. The renderer picks the exact locale, then the language part (`de-AT` falls back to `de`), then the new optional `MailBranding.defaultLocale`, then the first entry. Every URL in a map must be an absolute http(s) URL, otherwise `createSimpleRenderer` throws at boot. Without a locale and with plain strings the HTML is unchanged.\n`MailBranding` also gets `logoPath` and `baseUrl`, so an app can point at a raster logo on its own origin (`logoPath: \"/logo.png\"`, `baseUrl` the same base as `auth.mail.baseUrl`). `logoPath` and `logoUrl` exclude each other, `logoPath` needs a valid `baseUrl`, must start with a single `/` and must stay on the base origin; violations throw at boot. Use PNG or JPEG, because mail clients block SVG."
-  },
-  {
-    "version": "0.339.0",
-    "type": "improvement",
-    "title": "createRendererSimpleFeature({ mailBranding }) brands every notification mail, including the auth mails, with product name or logo, primary color and footer text and links",
-    "detail": "renderer-simple accepts mailBranding for all framework notification mails",
-    "migration": "No code change needed."
-  }
-]