@dbx-tools/email 0.3.21 → 0.3.23

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.21",
-    "@dbx-tools/shared-email": "0.3.21"
+    "@dbx-tools/shared-email": "0.3.23",
+    "@dbx-tools/shared-core": "0.3.23"
   },
   "main": "index.ts",
   "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.21",
+  "version": "0.3.23",
   "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 };
 }

package/src/outbox.ts

@@ -13,10 +13,10 @@
  * @module
  */
 
-import type { EmailMessage } from "@dbx-tools/shared-email";
-import { string } from "@dbx-tools/shared-core";
 import { mkdir, writeFile } from "node:fs/promises";
 import { join, resolve } from "node:path";
+import { string } from "@dbx-tools/shared-core";
+import type { EmailMessage } from "@dbx-tools/shared-email";
 import type { EmailBrand } from "./brand";
 import { renderEmailHtml } from "./email-html";
 

package/src/plugin.ts

@@ -27,8 +27,8 @@ import {
   type IAppRouter,
   type PluginManifest,
 } from "@databricks/appkit";
-import type { EmailMessage, EmailResult, EmailSenders } from "@dbx-tools/shared-email";
 import { error, log } from "@dbx-tools/shared-core";
+import type { EmailMessage, EmailResult, EmailSenders } from "@dbx-tools/shared-email";
 import type express from "express";
 import { EMAIL_CONFIG_SCHEMA, type EmailPluginConfig } from "./config";
 import { isSenderAllowed, listSenderOptions, resolveSenderAddress } from "./sender";

package/src/tool.ts

@@ -13,8 +13,8 @@
  */
 
 import { getExecutionContext } from "@databricks/appkit";
-import { email, type EmailMessage } from "@dbx-tools/shared-email";
 import { log, string } from "@dbx-tools/shared-core";
+import { email, type EmailMessage } from "@dbx-tools/shared-email";
 import { createTool } from "@mastra/core/tools";
 import { resolveSenderAddress } from "./sender";
 import { getEmailRuntime, sendEmail } from "./transport";

package/test/brand.test.ts

@@ -0,0 +1,46 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import { brand } from "@dbx-tools/shared-core";
+import { defaultEmailBrand, emailBrandFromContext } from "../src/brand";
+import { renderEmailHtml } from "../src/email-html";
+
+describe("email brand", () => {
+  it("derives accent, font, and name from a brand context", () => {
+    const b = emailBrandFromContext(brand.defaultBrandContext);
+    assert.equal(b.accent, brand.defaultBrandContext.colors.primary);
+    assert.equal(b.fontFamily, brand.defaultBrandContext.typography.sans);
+    assert.equal(b.name, brand.defaultBrandContext.name);
+  });
+
+  it("drops a logo that is not a fetchable URL (package-export path)", () => {
+    // The default brand's logo is an `@dbx-tools/ui-branding/...svg` export
+    // path, which can't load in a mail client, so no logoUrl is emitted.
+    assert.equal(defaultEmailBrand.logoUrl, undefined);
+  });
+
+  it("keeps an http(s) or data URL logo", () => {
+    const ctx = brand.parseBrandContext({
+      assets: { logo: { light: "https://ex.com/l.svg", dark: "https://ex.com/d.svg" } },
+    });
+    // Dark logo wins - the header band is dark.
+    assert.equal(emailBrandFromContext(ctx).logoUrl, "https://ex.com/d.svg");
+  });
+});
+
+describe("renderEmailHtml branding", () => {
+  it("inlines the brand accent and font, not the default blue", () => {
+    const html = renderEmailHtml({ subject: "S", body: "b", brand: defaultEmailBrand });
+    assert.ok(html.includes(defaultEmailBrand.accent));
+    assert.ok(html.includes("Inter"));
+    assert.ok(!html.includes("#0b6bcb"));
+  });
+
+  it("renders an <img> when the brand supplies a URL logo", () => {
+    const b = { ...defaultEmailBrand, logoUrl: "https://ex.com/logo.svg" };
+    assert.ok(renderEmailHtml({ subject: "S", body: "b", brand: b }).includes("<img"));
+  });
+
+  it("falls back to the neutral default palette with no brand", () => {
+    assert.ok(renderEmailHtml({ subject: "S", body: "b" }).includes("#0b6bcb"));
+  });
+});

package/test/tsconfig.json

@@ -0,0 +1,14 @@
+// ~~ Generated by projen. To modify, edit .projenrc.js and run "pnpm exec projen".
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "rootDir": ".."
+  },
+  "include": [
+    "**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}