groundmail-cli 0.16.3 → 0.17.0

package/README.md

@@ -58,6 +58,7 @@ groundmail domains list
 groundmail domains verify example.com
 groundmail webhooks list
 groundmail emails list
+SENDGRID_API_KEY=… groundmail migrate sendgrid --dry-run   # import from SendGrid, Postmark or Mailgun (beta)
 ```
 
 Run `groundmail --help` or `groundmail <command> --help` for flags.

package/dist/cli.js

@@ -1288,7 +1288,7 @@ function trimUrl(value) {
 }
 
 // package.json
-var version = "0.16.3";
+var version = "0.17.0";
 
 // src/user-agent.ts
 function buildUserAgent(own) {
@@ -3111,6 +3111,124 @@ async function switchWorkspace(argv, deps) {
   return { exitCode: EXIT_OK };
 }
 
+// src/commands/migrate.ts
+var PROVIDERS = ["sendgrid", "postmark", "mailgun"];
+var RESOURCES = ["domains", "webhooks", "templates", "suppressions"];
+var KEY_ENV = {
+  sendgrid: "SENDGRID_API_KEY",
+  postmark: "POSTMARK_SERVER_TOKEN",
+  mailgun: "MAILGUN_API_KEY"
+};
+var LABELS = { sendgrid: "SendGrid", postmark: "Postmark", mailgun: "Mailgun" };
+function readFlag21(args, flag) {
+  const index = args.indexOf(flag);
+  if (index === -1) return void 0;
+  return args[index + 1];
+}
+function n(value) {
+  return (value ?? 0).toLocaleString("en-US");
+}
+function formatMigrationSummary(m) {
+  const label = LABELS[m.provider];
+  const lines = [
+    m.dry_run ? `Preview of your ${label} import (nothing written):` : `Imported from ${label} (${m.status}):`
+  ];
+  if (m.domains) {
+    lines.push(`  Domains        ${n(m.domains.totals.imported)} of ${n(m.domains.totals.found)}`);
+  }
+  if (m.webhooks) {
+    lines.push(`  Webhooks       ${n(m.webhooks.totals.imported)} of ${n(m.webhooks.totals.found)} (created disabled)`);
+  }
+  if (m.templates) {
+    const t = m.templates.totals;
+    lines.push(`  Templates      ${n(t.imported)} ready, ${n(t.needs_attention)} to review, of ${n(t.found)}`);
+  }
+  if (m.suppressions) {
+    const s = m.suppressions.totals;
+    lines.push(
+      m.dry_run ? `  Suppressions   ${n(s.found)}${m.suppressions.estimated ? "+ (first page of each list)" : ""}` : `  Suppressions   ${n(s.imported)} added, ${n(s.already_suppressed)} already suppressed`
+    );
+  }
+  if (m.errors.length) {
+    lines.push("", "Could not read:");
+    for (const e of m.errors) lines.push(`  ${e.resource}: ${e.message}`);
+  }
+  const failed = [
+    ...(m.domains?.items ?? []).filter((i) => i.status === "failed").map((i) => `domain ${i.name}: ${i.message ?? "failed"}`),
+    ...(m.webhooks?.items ?? []).filter((i) => i.status === "failed").map((i) => `webhook ${i.url}: ${i.message ?? "failed"}`),
+    ...(m.templates?.items ?? []).filter((i) => i.status === "failed").map((i) => `template ${i.name}: ${i.message ?? "failed"}`)
+  ];
+  if (failed.length) {
+    lines.push("", "Not imported:");
+    for (const line of failed.slice(0, 20)) lines.push(`  ${line}`);
+    if (failed.length > 20) lines.push(`  \u2026and ${failed.length - 20} more (see the JSON report)`);
+  }
+  if (m.attention.length) {
+    lines.push("", "Next:");
+    for (const line of m.attention) lines.push(`  - ${line}`);
+  }
+  const node = m.code_changes?.find((c) => c.stack === "node");
+  if (node) lines.push("", "Code change (Node.js):", node.diff);
+  if (m.agent_prompt) lines.push("", "Prompt for your coding agent is in the JSON report (`agent_prompt`).");
+  return lines.join("\n");
+}
+async function runMigrateCommand(provider, args, env = process.env) {
+  if (!provider || !PROVIDERS.includes(provider)) {
+    return { exitCode: 1, error: "Usage: groundmail migrate <sendgrid|postmark|mailgun> [--dry-run] [--only templates,suppressions]" };
+  }
+  const id = provider;
+  const apiKey = readFlag21(args, "--api-key") || env.GROUNDMAIL_API_KEY;
+  if (!apiKey) {
+    return { exitCode: 1, error: "Not signed in. Run `groundmail login`, or set GROUNDMAIL_API_KEY." };
+  }
+  const providerKey = readFlag21(args, "--key") || env[KEY_ENV[id]];
+  if (!providerKey) {
+    return {
+      exitCode: 1,
+      error: `Missing ${LABELS[id]} key. Set ${KEY_ENV[id]} (or pass --key). It is used for this import only and never stored.`
+    };
+  }
+  const params = { provider: id, api_key: providerKey };
+  if (id === "postmark") {
+    const accountToken = readFlag21(args, "--account-token") || env.POSTMARK_ACCOUNT_TOKEN;
+    if (accountToken) params.account_api_key = accountToken;
+  } else {
+    const region = readFlag21(args, "--region");
+    if (region === "us" || region === "eu") params.region = region;
+    else if (region) return { exitCode: 1, error: "--region must be us or eu" };
+  }
+  const only = readFlag21(args, "--only");
+  if (only) {
+    const list = only.split(",").map((s) => s.trim()).filter(Boolean);
+    const bad = list.filter((r) => !RESOURCES.includes(r));
+    if (bad.length || !list.length) {
+      return { exitCode: 1, error: `--only takes a comma-separated list of: ${RESOURCES.join(", ")}` };
+    }
+    params.resources = list;
+  }
+  if (args.includes("--dry-run")) params.dry_run = true;
+  try {
+    const { Groundmail } = await import("groundmail");
+    const baseUrl = readFlag21(args, "--base-url");
+    const client = new Groundmail(apiKey, baseUrl ? { baseUrl } : void 0);
+    console.error(`${params.dry_run ? "Previewing" : "Importing"} from ${LABELS[id]} (Beta)\u2026`);
+    const report = await client.migrations.run(params, {
+      onProgress: (m) => {
+        if (m.has_more) {
+          const s = m.suppressions?.totals;
+          console.error(`  \u2026still working${s ? ` (${n(s.found)} suppressions read)` : ""}`);
+        }
+      }
+    });
+    console.log(JSON.stringify(report));
+    console.error("");
+    console.error(formatMigrationSummary(report));
+    return { exitCode: report.status === "failed" ? 1 : 0 };
+  } catch (error) {
+    return { exitCode: 1, error: error instanceof Error ? error.message : String(error) };
+  }
+}
+
 // src/help.ts
 var USAGE_LINES = [
   "  groundmail login [--scope <scopes>] [--workspace <name>]   sign in through the browser (OAuth; no key to copy)",
@@ -3171,6 +3289,9 @@ var USAGE_LINES = [
   "  groundmail keys list",
   "  groundmail keys create [--name Default] [--scopes emails:send,domains:read] [--allowed-domains example.com]",
   "  groundmail keys delete --id <api-key-id>",
+  "  groundmail migrate sendgrid [--dry-run] [--only templates,suppressions,domains,webhooks] [--region eu]   import from SendGrid (Beta)",
+  "  groundmail migrate postmark [--dry-run] [--only \u2026]   import from Postmark (Beta)",
+  "  groundmail migrate mailgun [--dry-run] [--only \u2026] [--region eu]   import from Mailgun (Beta)",
   "  groundmail integrations twilio status",
   "  groundmail integrations twilio connect --account-sid AC\u2026 --auth-token \u2026 --from +15551234567",
   "  groundmail integrations twilio disconnect"
@@ -3183,6 +3304,7 @@ var FOOTER_LINES = [
   "  CLOUDFLARE_API_TOKEN=\u2026            (optional local apply; else uses dashboard Integrations)",
   "  VERCEL_API_TOKEN=\u2026 VERCEL_TEAM_ID=\u2026  (optional local apply; else uses dashboard Integrations)",
   "  GODADDY_API_KEY=\u2026 GODADDY_API_SECRET=\u2026  (domains apply --provider godaddy)",
+  "  SENDGRID_API_KEY / POSTMARK_SERVER_TOKEN (+ POSTMARK_ACCOUNT_TOKEN) / MAILGUN_API_KEY  (migrate; used once, never stored)",
   "",
   "Scopes: full, emails:send, emails:read, domains:read, domains:write, webhooks:write, templates:write,",
   "        suppressions:write, account:read",
@@ -3258,6 +3380,7 @@ async function main() {
   const session = await applySavedSession(process.argv.slice(4));
   if (session.notice) console.error(session.notice);
   const rest = session.argv;
+  if (command === "migrate") await finish(await runMigrateCommand(subcommand, rest));
   if (command === "domains") {
     if (subcommand === "add" || subcommand === "create") {
       const result = await runAddCommand(rest);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail-cli",
-  "version": "0.16.3",
+  "version": "0.17.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.14.4"
+    "groundmail": "0.14.6"
   },
   "devDependencies": {
     "tsup": "^8.5.0",