groundmail-cli 0.37.2 → 0.38.0

package/dist/cli.js

@@ -2106,7 +2106,7 @@ function trimUrl(value) {
 }
 
 // package.json
-var version = "0.37.2";
+var version = "0.38.0";
 
 // src/user-agent.ts
 function buildUserAgent(own) {
@@ -4605,6 +4605,101 @@ async function runMigrateCommand(provider, args, env = process.env) {
   }
 }
 
+// src/commands/burrowguard.ts
+var MISSING_KEY4 = "Missing API key. Set GROUNDMAIL_API_KEY, pass --api-key, or run `groundmail login`.";
+var USAGE = [
+  "Usage: groundmail burrowguard sites [list]",
+  '       groundmail burrowguard sites create --name "Sign-up form" --hostname app.example.com [--hostname localhost] [--block-free-webmail] [--allow-data-center-ips]',
+  '       groundmail burrowguard sites create --name "Contact form" --email-checks-only',
+  "       groundmail burrowguard sites delete <id> --yes",
+  "       groundmail burrowguard sites roll-secret <id> --yes",
+  "       groundmail burrowguard checks [--site <id>] [--result passed|blocked|no_token] [--range 24h|7d|30d] [--limit 25]"
+].join("\n");
+function readAll(args, flag) {
+  return args.flatMap((arg, index) => arg === flag && args[index + 1] ? [args[index + 1]] : []);
+}
+async function withClient4(args, env, run) {
+  const options = parseSuppressionsCommonArgs(args);
+  const apiKey = resolveApiKey7(options, env);
+  if (!apiKey) return { exitCode: 1, error: MISSING_KEY4 };
+  try {
+    const client2 = await createSuppressionsClient(apiKey, options.baseUrl);
+    const output = await run(client2);
+    if (output !== void 0) console.log(JSON.stringify(output));
+    return { exitCode: 0 };
+  } catch (error) {
+    return { exitCode: 1, error: error instanceof Error ? error.message : String(error) };
+  }
+}
+async function runSites(action, rest, env) {
+  if (!action || action === "list" || action.startsWith("--")) {
+    return withClient4(action ? [action, ...rest] : rest, env, (client2) => client2.burrowguard.sites.list());
+  }
+  if (action === "create") {
+    const name = readFlag19(rest, "--name");
+    const hostnames = readAll(rest, "--hostname");
+    const emailOnly = rest.includes("--email-checks-only");
+    if (!name || hostnames.length === 0 && !emailOnly) return { exitCode: 1, error: `Required: --name and --hostname.
+${USAGE}` };
+    return withClient4(
+      rest,
+      env,
+      (client2) => client2.burrowguard.sites.create({
+        name,
+        ...hostnames.length > 0 ? { allowed_hostnames: hostnames } : {},
+        ...emailOnly ? { email_checks_only: true } : {},
+        ...rest.includes("--block-free-webmail") ? { block_free_webmail: true } : {},
+        ...rest.includes("--allow-data-center-ips") ? { allow_data_center_ips: true } : {}
+      })
+    );
+  }
+  if (action === "delete" || action === "roll-secret") {
+    const id = rest[0] && !rest[0].startsWith("--") ? rest[0] : void 0;
+    if (!id) return { exitCode: 1, error: `Missing site id.
+${USAGE}` };
+    if (!rest.includes("--yes")) {
+      const effect = action === "delete" ? "deletes the site and its checks" : "stops the current secret working at once";
+      return { exitCode: 1, error: `This ${effect}. Pass --yes to go ahead.` };
+    }
+    return withClient4(rest, env, async (client2) => {
+      if (action === "delete") {
+        await client2.burrowguard.sites.remove(id);
+        return { deleted: true, id };
+      }
+      return client2.burrowguard.sites.rollSecret(id);
+    });
+  }
+  return { exitCode: 1, error: `Unknown command: burrowguard sites ${action}
+${USAGE}` };
+}
+function runChecks(args, env) {
+  const result = readFlag19(args, "--result");
+  if (result && !["passed", "blocked", "no_token"].includes(result)) {
+    return Promise.resolve({ exitCode: 1, error: "--result must be passed, blocked or no_token" });
+  }
+  const range = readFlag19(args, "--range");
+  if (range && !["24h", "7d", "30d"].includes(range)) {
+    return Promise.resolve({ exitCode: 1, error: "--range must be 24h, 7d or 30d" });
+  }
+  const limit = readFlag19(args, "--limit");
+  return withClient4(
+    args,
+    env,
+    (client2) => client2.burrowguard.checks.list({
+      ...readFlag19(args, "--site") ? { site: readFlag19(args, "--site") } : {},
+      ...result ? { result } : {},
+      ...range ? { range } : {},
+      ...limit ? { limit: Number(limit) } : {},
+      ...readFlag19(args, "--cursor") ? { cursor: readFlag19(args, "--cursor") } : {}
+    })
+  );
+}
+async function runBurrowGuardCommand(subcommand, args, env = process.env) {
+  if (subcommand === "sites") return runSites(args[0], args.slice(1), env);
+  if (subcommand === "checks") return runChecks(args, env);
+  return { exitCode: 1, error: USAGE };
+}
+
 // src/commands/validate.ts
 async function runValidateCommand(args, env = process.env) {
   const options = parseSuppressionsCommonArgs(args);
@@ -4757,9 +4852,9 @@ function formatTestEmail(email) {
   lines.push(`Id:      ${email.id}`);
   return lines.join("\n");
 }
-var USAGE = "Usage: groundmail test-inbox address [--prefix signup] | wait --to <address> [--timeout 30] [--since <iso>] [--json] | list [--to <address>] [--json]";
+var USAGE2 = "Usage: groundmail test-inbox address [--prefix signup] | wait --to <address> [--timeout 30] [--since <iso>] [--json] | list [--to <address>] [--json]";
 async function runTestInboxCommand(subcommand, args, env = process.env) {
-  if (!subcommand || !["address", "wait", "list"].includes(subcommand)) return { exitCode: 1, error: USAGE };
+  if (!subcommand || !["address", "wait", "list"].includes(subcommand)) return { exitCode: 1, error: USAGE2 };
   const apiKey = readFlag26(args, "--api-key") || env.GROUNDMAIL_API_KEY;
   if (!apiKey) return { exitCode: 1, error: "Missing API key. Run groundmail login, set GROUNDMAIL_API_KEY or pass --api-key." };
   const json = args.includes("--json");
@@ -4861,6 +4956,11 @@ var USAGE_LINES = [
   "  groundmail webhooks deliveries get --webhook <webhook-id> --id <delivery-id>",
   "  groundmail webhooks deliveries resend --webhook <webhook-id> --id <delivery-id>",
   "  groundmail validate user@example.com   Groundmail validation: verdict, reasons, typo suggestion (exit 2 when invalid)",
+  "  groundmail burrowguard sites   the forms BurrowGuard protects",
+  '  groundmail burrowguard sites create --name "Sign-up form" --hostname app.example.com [--hostname localhost] [--block-free-webmail] [--allow-data-center-ips] [--email-checks-only]   prints the secret once',
+  "  groundmail burrowguard sites roll-secret <id> --yes   the old secret stops working at once",
+  "  groundmail burrowguard sites delete <id> --yes",
+  "  groundmail burrowguard checks [--site <id>] [--result passed|blocked|no_token] [--range 24h|7d|30d] [--limit 25]",
   "  groundmail suppressions list [--tenant <tenant>]",
   "  groundmail suppressions add --email user@example.com [--reason \u2026] [--tenant <tenant>]",
   "  groundmail suppressions remove --id <id> | --email user@example.com [--tenant <tenant>]",
@@ -5005,6 +5105,7 @@ async function main() {
   const rest = session.argv;
   if (command === "migrate") await finish(await runMigrateCommand(subcommand, rest));
   if (command === "validate") await finish(await runValidateCommand([...subcommand ? [subcommand] : [], ...rest]));
+  if (command === "burrowguard") await finish(await runBurrowGuardCommand(subcommand, rest));
   if (command === "dmarc") await finish(await runDmarcCommand(subcommand, rest));
   if (command === "test-inbox") await finish(await runTestInboxCommand(subcommand, rest));
   if (command === "domains") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail-cli",
-  "version": "0.37.2",
+  "version": "0.38.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.40.0"
+    "groundmail": "0.41.0"
   },
   "devDependencies": {
     "tsup": "^8.5.0",