@dbx-tools/email 0.3.20 → 0.3.22

package/README.md

@@ -144,6 +144,40 @@ const html = emailHtml.renderEmailHtml({
 `markdown.markdownToHtml()` renders Markdown. `emailHtml.renderEmailHtml()` wraps
 the rendered body in the package layout and inlines CSS for mail clients.
 
+## Brand The Email
+
+Branding is optional. Pass a `brand` to the plugin (or to `renderEmailHtml`) to
+color the layout with an accent, font, and header logo; omit it for the neutral
+default palette.
+
+```ts
+import { brand, plugin } from "@dbx-tools/email";
+
+// The dbx-tools brand, ready to use:
+plugin.email({ brand: brand.defaultEmailBrand });
+
+// Or derive from any shared BrandContext:
+import { brand as coreBrand } from "@dbx-tools/shared-core";
+plugin.email({ brand: brand.emailBrandFromContext(coreBrand.defaultBrandContext) });
+
+// Or hand-build the small email-safe slice:
+plugin.email({
+  brand: {
+    accent: "#FF3621",
+    fontFamily: "Inter, ui-sans-serif, system-ui, sans-serif",
+    name: "Acme",
+    logoUrl: "https://acme.example/logo.svg", // http(s): or data: only
+  },
+});
+```
+
+The brand is inlined into every rendered message. The browser UI's `[data-brand]`
+CSS bridge can't reach an inbox (mail clients strip `<style>` and ignore `var()`),
+so email branding uses inline token values instead. A `logoUrl` renders only when
+it is an `http(s):` or `data:` URL - a package-export asset path is dropped rather
+than shown as a broken image, so `defaultEmailBrand` applies the brand color and
+font but no logo.
+
 ## Use The Outbox In Tests
 
 ```ts

package/package.json

@@ -19,15 +19,15 @@
     "juice": "^12.1.1",
     "marked": "^18.0.5",
     "nodemailer": "^7.0.13",
-    "@dbx-tools/shared-core": "0.3.20",
-    "@dbx-tools/shared-email": "0.3.20"
+    "@dbx-tools/shared-core": "0.3.22",
+    "@dbx-tools/shared-email": "0.3.22"
   },
   "main": "index.ts",
   "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.20",
+  "version": "0.3.22",
   "types": "index.ts",
   "type": "module",
   "exports": {

package/src/config.ts

@@ -22,10 +22,10 @@
  *
  * @module
  */
+import { resolve } from "node:path";
 import type { BasePluginConfig } from "@databricks/appkit";
-import type { JSONSchema7 } from "json-schema";
 import { object } from "@dbx-tools/shared-core";
-import { resolve } from "node:path";
+import type { JSONSchema7 } from "json-schema";
 import type { EmailBrand } from "./brand";
 import { parseAllowedSenders } from "./sender";
 
@@ -162,12 +162,12 @@ export const EMAIL_CONFIG_SCHEMA: JSONSchema7 = {
 /** Parse the `SMTP_SECURE` env / config flag, defaulting to `port === 465`. */
 function resolveSecure(flag: boolean | undefined, port: number): boolean {
   if (typeof flag === "boolean") return flag;
-  return object.toBoolean(process.env["SMTP_SECURE"]) ?? port === 465;
+  return object.toBoolean(process.env.SMTP_SECURE) ?? port === 465;
 }
 
 /** Whether `EMAIL_OUTBOX_MODE` explicitly opts into the file/outbox fallback. */
 function isOutboxModeEnabled(): boolean {
-  return object.toBoolean(process.env["EMAIL_OUTBOX_MODE"]) ?? false;
+  return object.toBoolean(process.env.EMAIL_OUTBOX_MODE) ?? false;
 }
 
 const SMTP_REQUIRED_FIELDS = ["SMTP_HOST", "SMTP_USER", "SMTP_PASSWORD"] as const;
@@ -197,13 +197,13 @@ function missingSmtpFields(
  */
 export function resolveEmailConfig(config: EmailPluginConfig = {}): ResolvedEmailConfig {
   const smtp = config.smtp ?? {};
-  const host = smtp.host ?? process.env["SMTP_HOST"];
-  const user = smtp.user ?? process.env["SMTP_USER"];
-  const pass = smtp.password ?? process.env["SMTP_PASSWORD"];
-  const domain = config.domain ?? process.env["EMAIL_DOMAIN"];
-  const from = config.from ?? process.env["EMAIL_FROM"];
+  const host = smtp.host ?? process.env.SMTP_HOST;
+  const user = smtp.user ?? process.env.SMTP_USER;
+  const pass = smtp.password ?? process.env.SMTP_PASSWORD;
+  const domain = config.domain ?? process.env.EMAIL_DOMAIN;
+  const from = config.from ?? process.env.EMAIL_FROM;
   const allowedSenders = parseAllowedSenders(
-    config.allowedSenders ?? process.env["EMAIL_ALLOWED_SENDERS"],
+    config.allowedSenders ?? process.env.EMAIL_ALLOWED_SENDERS,
   );
   const sender: ResolvedSender = {
     ...(domain ? { domain } : {}),
@@ -227,7 +227,7 @@ export function resolveEmailConfig(config: EmailPluginConfig = {}): ResolvedEmai
         "email: SMTP is configured but no sender source - set EMAIL_DOMAIN (to derive <user>@<domain>) or EMAIL_FROM (a fixed address)",
       );
     }
-    const portRaw = smtp.port ?? Number(process.env["SMTP_PORT"]);
+    const portRaw = smtp.port ?? Number(process.env.SMTP_PORT);
     const port = Number.isFinite(portRaw) && portRaw ? Number(portRaw) : 587;
     return {
       mode: "smtp",
@@ -246,7 +246,7 @@ export function resolveEmailConfig(config: EmailPluginConfig = {}): ResolvedEmai
   }
 
   const outDir = resolve(
-    config.outDir ?? process.env["EMAIL_OUTBOX_DIR"] ?? resolve(process.cwd(), "tmp"),
+    config.outDir ?? process.env.EMAIL_OUTBOX_DIR ?? resolve(process.cwd(), "tmp"),
   );
   return { mode: "file", outDir, ...sender };
 }