groundmail-cli 0.33.1 → 0.35.0

package/README.md

@@ -75,6 +75,7 @@ groundmail domains list
 groundmail domains verify example.com
 groundmail webhooks list
 groundmail emails list
+groundmail brand set --logo-url https://cdn.acme.com/logo.png --color '#2f6feb' --company "Acme Inc"   # logo, color and footer every template follows
 groundmail senders list                                  # saved senders; send with --sender billing instead of --from
 SENDGRID_API_KEY=… groundmail migrate sendgrid --dry-run   # import from SendGrid, Postmark, Mailgun, Resend or Amazon SES (beta)
 ```

package/dist/cli.js

@@ -2055,7 +2055,7 @@ function trimUrl(value) {
 }
 
 // package.json
-var version = "0.33.1";
+var version = "0.35.0";
 
 // src/user-agent.ts
 function buildUserAgent(own) {
@@ -3283,8 +3283,8 @@ function extensionOf(filePath) {
   return match ? match[0].toLowerCase() : "";
 }
 async function defaultReadFile(filePath) {
-  const { readFile: readFile3 } = await import("fs/promises");
-  return readFile3(filePath, "utf8");
+  const { readFile: readFile4 } = await import("fs/promises");
+  return readFile4(filePath, "utf8");
 }
 async function defaultImportModule(filePath) {
   const { pathToFileURL } = await import("url");
@@ -3335,14 +3335,14 @@ async function toElement(mod, props) {
   return exported;
 }
 async function loadTemplateSource(filePath, options = {}, deps = {}) {
-  const readFile3 = deps.readFile ?? defaultReadFile;
+  const readFile4 = deps.readFile ?? defaultReadFile;
   const importModule = deps.importModule ?? defaultImportModule;
   const extension = extensionOf(filePath);
   if (HTML_EXTENSIONS.includes(extension)) {
-    return { html: await readFile3(filePath) };
+    return { html: await readFile4(filePath) };
   }
   if (TEXT_EXTENSIONS.includes(extension)) {
-    return { text: await readFile3(filePath) };
+    return { text: await readFile4(filePath) };
   }
   if (!MODULE_EXTENSIONS.includes(extension)) {
     throw new Error(
@@ -4064,6 +4064,95 @@ async function runDeleteCommand6(args, env = process.env) {
   return withClient2(args, env, (client2) => client2.senders.remove(sender));
 }
 
+// src/commands/brand/commands.ts
+import { readFile as readFile3 } from "fs/promises";
+async function createBrandClient(apiKey, baseUrl) {
+  const { Groundmail } = await import("groundmail");
+  return new Groundmail(apiKey, baseUrl ? { baseUrl } : void 0);
+}
+var HEX = /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/i;
+function readableText(hex) {
+  const full = hex.length === 4 ? `#${hex[1]}${hex[1]}${hex[2]}${hex[2]}${hex[3]}${hex[3]}` : hex;
+  const lin = (i) => {
+    const c = parseInt(full.slice(i, i + 2), 16) / 255;
+    return c <= 0.03928 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4;
+  };
+  const luminance = 0.2126 * lin(1) + 0.7152 * lin(3) + 0.0722 * lin(5);
+  return 1.05 / (luminance + 0.05) >= (luminance + 0.05) / (0.0103 + 0.05) ? "#ffffff" : "#1c1917";
+}
+async function withClient3(args, env, run) {
+  const options = parseSendersCommonArgs(args);
+  const apiKey = resolveApiKey10(options, env);
+  if (!apiKey) return { exitCode: 1, error: MISSING_KEY2 };
+  try {
+    const client2 = await createBrandClient(apiKey, options.baseUrl);
+    console.log(JSON.stringify(await run(client2)));
+    return { exitCode: 0 };
+  } catch (error) {
+    return failure2(error);
+  }
+}
+async function runGetCommand9(args, env = process.env) {
+  return withClient3(args, env, (client2) => client2.brand.get());
+}
+function clearable(value) {
+  if (value === void 0) return void 0;
+  return value === "none" || value === "" ? null : value;
+}
+async function runSetCommand(args, env = process.env) {
+  const logoUrl = clearable(readFlag22(args, "--logo-url"));
+  const logoAlign = readFlag22(args, "--logo-align");
+  const logoWidth = readFlag22(args, "--logo-width");
+  const color = readFlag22(args, "--color");
+  const settingsFile = readFlag22(args, "--settings-file");
+  if (logoAlign !== void 0 && logoAlign !== "left" && logoAlign !== "center") {
+    return { exitCode: 1, error: "--logo-align must be left or center" };
+  }
+  if ((logoAlign !== void 0 || logoWidth !== void 0) && !logoUrl) {
+    return { exitCode: 1, error: "--logo-align and --logo-width go with --logo-url" };
+  }
+  if (logoWidth !== void 0 && !/^\d+$/.test(logoWidth)) return { exitCode: 1, error: "--logo-width must be a whole number of px" };
+  if (color !== void 0 && !HEX.test(color)) return { exitCode: 1, error: "--color must be a hex colour such as #2f6feb" };
+  let settingsFromFile;
+  if (settingsFile) {
+    try {
+      settingsFromFile = JSON.parse(await readFile3(settingsFile, "utf8"));
+    } catch {
+      return { exitCode: 1, error: `Could not read JSON from ${settingsFile}` };
+    }
+  }
+  const params = {};
+  if (logoUrl !== void 0) {
+    params.logo = logoUrl === null ? null : { url: logoUrl, align: logoAlign ?? "left", ...logoWidth ? { width: Number(logoWidth) } : {} };
+  }
+  const company = clearable(readFlag22(args, "--company"));
+  const address = clearable(readFlag22(args, "--address"));
+  const website = clearable(readFlag22(args, "--website"));
+  if (company !== void 0) params.company_name = company;
+  if (address !== void 0) params.address = address;
+  if (website !== void 0) params.website = website;
+  if (settingsFromFile) params.settings = settingsFromFile;
+  if (!Object.keys(params).length && !color) {
+    return {
+      exitCode: 1,
+      error: "Nothing to set. Usage: groundmail brand set [--logo-url \u2026] [--color #2f6feb] [--company \u2026] [--address \u2026] [--website \u2026] [--settings-file brand.json]"
+    };
+  }
+  return withClient3(args, env, async (client2) => {
+    if (color) {
+      const base = params.settings ?? (await client2.brand.get()).brand.settings ?? {};
+      const theme = base.theme ?? {};
+      params.accent_color = color;
+      params.settings = {
+        ...base,
+        linkColor: color,
+        theme: { ...theme, buttonBackground: color, buttonTextColor: readableText(color) }
+      };
+    }
+    return client2.brand.update(params);
+  });
+}
+
 // src/commands/auth.ts
 async function runAuthCommand(subcommand, argv, deps = {}) {
   const env = deps.env ?? process.env;
@@ -4651,7 +4740,7 @@ var USAGE_LINES = [
   `  groundmail events send --name user.created --email user@example.com --data '{"name":"Ada"}'`,
   "  groundmail automations list",
   "  groundmail automations create --file ./welcome.json",
-  `  groundmail automations create --name Welcome --trigger user.created --steps '[{"type":"send_email","email":{...}}]'`,
+  `  groundmail automations create --name Welcome --trigger user.created --steps '[{"type":"send_email","email":{"from":"you@yourdomain.com","to":"{{event.email}}","template":{"id":"welcome","variables":{"name":"{{event.data.name}}"}}}}]'   each email step sends a published template`,
   "  groundmail automations create --file ./otp-sms.json",
   "  groundmail automations get --id <automation-id>",
   "  groundmail automations update --id <automation-id> --file ./welcome.json",
@@ -4682,7 +4771,7 @@ var USAGE_LINES = [
   "  groundmail templates restore --id tpl_\u2026 --version 2",
   "  groundmail templates test-send --id tpl_\u2026 --to you@domain.com [--from you@domain.com | --sender billing]   neither: the template's sender, else your default sender",
   '  groundmail templates duplicate --id tpl_\u2026 [--name "Copy"]',
-  "  groundmail templates delete --id tpl_\u2026",
+  "  groundmail templates delete --id tpl_\u2026   refused while an automation step sends it (the error names them)",
   "  groundmail tenants list [--status active|paused] [--limit 25] [--cursor \u2026]   your customers, each with its own domains, suppressions and limits",
   `  groundmail tenants create <external-id> [--name \u2026] [--default-from-domain \u2026] [--stream-policy all|transactional_only] [--daily-limit N] [--metadata '{"plan":"pro"}']`,
   "  groundmail tenants get <tenant>",
@@ -4694,6 +4783,8 @@ var USAGE_LINES = [
   "  groundmail tenants domains list <tenant>",
   "  groundmail tenants domains add <tenant> example.com   only this tenant can then send from it",
   "  groundmail tenants domains remove <tenant> example.com   gives the domain back to the account",
+  "  groundmail brand get   your logo, colors and footer, which templates follow",
+  '  groundmail brand set [--logo-url <https url>|none] [--logo-align left|center] [--logo-width 120] [--color #2f6feb] [--company "Acme Inc"|none] [--address "\u2026"|none] [--website acme.com|none] [--settings-file brand.json]   --color: buttons, links and the line across the top',
   "  groundmail senders list   the names and addresses your email goes out as",
   '  groundmail senders create --name "Acme Billing" --address billing@mail.acme.com [--reply-to billing@acme.com] [--handle billing] [--default]   address on a verified domain',
   "  groundmail senders get <id|handle>",
@@ -4742,7 +4833,8 @@ var ALIASES = {
   suppressions: { create: "add", delete: "remove" },
   templates: { add: "create", remove: "delete" },
   tenants: { add: "create", remove: "delete" },
-  senders: { add: "create", remove: "delete" }
+  senders: { add: "create", remove: "delete" },
+  brand: { update: "set" }
 };
 function words(line) {
   return line.trim().split(/\s+/);
@@ -5080,6 +5172,10 @@ async function main() {
     if (subcommand === "stats") await finish(await runStatsCommand(rest));
     if (subcommand === "domains") await finish(await runDomainsCommand(rest));
   }
+  if (command === "brand") {
+    if (subcommand === "get") await finish(await runGetCommand9(rest));
+    if (subcommand === "set" || subcommand === "update") await finish(await runSetCommand(rest));
+  }
   if (command === "senders") {
     if (subcommand === "list") await finish(await runListCommand9(rest));
     if (subcommand === "create" || subcommand === "add") await finish(await runCreateCommand5(rest));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail-cli",
-  "version": "0.33.1",
+  "version": "0.35.0",
   "description": "Groundmail CLI — send transactional email from the terminal",
   "license": "MIT",
   "type": "module",
@@ -38,7 +38,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "groundmail": "0.35.0"
+    "groundmail": "0.37.0"
   },
   "devDependencies": {
     "tsup": "^8.5.0",