greybull 0.2.0 → 0.2.2

package/dist/index.js

@@ -94,7 +94,7 @@ var ApiError = class extends Error {
     this.status = status;
   }
 };
-var VERSION = "0.2.0";
+var VERSION = "0.2.2";
 function buildRequest(opts) {
   const url = new URL(opts.apiUrl.replace(/\/+$/, "") + opts.path);
   if (opts.query) {
@@ -311,8 +311,35 @@ function page(title, body) {
 import fs2 from "fs";
 import os3 from "os";
 import path2 from "path";
+import readline2 from "readline/promises";
 import { spawnSync } from "child_process";
-var RECORD_TYPES = ["A", "AAAA", "CNAME", "MX", "TXT", "NS", "SRV"];
+var RECORD_TYPES = [
+  "A",
+  "AAAA",
+  "ALIAS",
+  "CAA",
+  "CERT",
+  "CNAME",
+  "DNSKEY",
+  "DS",
+  "HINFO",
+  "HTTPS",
+  "LOC",
+  "MX",
+  "NAPTR",
+  "NS",
+  "OPENPGPKEY",
+  "PTR",
+  "RP",
+  "SMIMEA",
+  "SPF",
+  "SRV",
+  "SSHFP",
+  "SVCB",
+  "TLSA",
+  "TXT",
+  "URI"
+];
 function buildListRecords(apiUrl, zone, opts) {
   return buildRequest({
     apiUrl,
@@ -436,7 +463,6 @@ async function deleteCmd(ctx2, zone, type, name, content, opts) {
 function runSpec(spec, ctx2) {
   return performRequest(spec, ctx2.apiKey).catch((err) => fail(err, ctx2));
 }
-var ERR_PREFIX = "; !! ";
 function renderZoneFile(zone, records) {
   const rows = records.map((r) => {
     const content = r.type === "MX" && r.priority !== void 0 ? `${r.priority} ${r.content}` : r.content;
@@ -446,6 +472,10 @@ function renderZoneFile(zone, records) {
   const ttlW = Math.max(3, ...rows.map((r) => r.ttl.length));
   const typeW = Math.max(4, ...rows.map((r) => r.type.length));
   const header = [
+    // Editor mode hints (comments, so the parser ignores them): Emacs dns-mode
+    // on line 1, Vim bindzone via the modeline at the end. Together with the
+    // .zone temp-file extension these give BIND zone syntax highlighting.
+    "; -*- mode: dns -*-",
     `; Zone: ${zone}`,
     "; Edit records below, then save and close your editor to apply.",
     "; Format:  NAME  TTL  TYPE  CONTENT   (use @ for the zone apex)",
@@ -456,7 +486,7 @@ function renderZoneFile(zone, records) {
   const body = rows.map(
     (r) => `${r.name.padEnd(nameW)}  ${r.ttl.padEnd(ttlW)}  ${r.type.padEnd(typeW)}  ${r.content}`
   );
-  return [...header, ...body].join("\n") + "\n";
+  return [...header, ...body, "; vim: set ft=bindzone:", ""].join("\n");
 }
 function parseZoneFile(text) {
   const recs = [];
@@ -464,23 +494,45 @@ function parseZoneFile(text) {
   for (let i = 0; i < lines.length; i++) {
     const trimmed = lines[i].trim();
     if (!trimmed || trimmed.startsWith(";")) continue;
-    const m = trimmed.match(/^(\S+)\s+(\d+)\s+(?:IN\s+)?([A-Za-z]+)\s+(.+)$/i);
+    const m = trimmed.match(/^(\S+)\s+(\d+)\s+(?:IN\s+)?([A-Za-z][A-Za-z0-9]*)\s+(.+)$/i);
     if (!m) {
       throw new Error(`line ${i + 1}: could not parse "${trimmed}" (expected: NAME TTL TYPE CONTENT)`);
     }
     const [, name, ttlStr, typeRaw, content] = m;
-    const type = typeRaw.toUpperCase();
-    if (type === "SOA") throw new Error(`line ${i + 1}: SOA is managed automatically \u2014 remove it`);
-    if (!RECORD_TYPES.includes(type)) throw new Error(`line ${i + 1}: unknown record type "${typeRaw}"`);
-    recs.push({ name, type, content: content.trim(), ttl: parseInt(ttlStr) });
+    recs.push({ name, type: typeRaw.toUpperCase(), content: content.trim(), ttl: parseInt(ttlStr) });
   }
   return recs;
 }
-function normalizeBody(text) {
-  return text.split("\n").map((l) => l.trim()).filter((l) => l && !l.startsWith(";")).map((l) => l.replace(/\s+/g, " ")).sort().join("\n");
+function zoneDiff(before, after) {
+  const norm = (t) => t.split("\n").map((l) => l.trim()).filter((l) => l && !l.startsWith(";")).map((l) => l.replace(/\s+/g, " "));
+  const a = new Set(norm(before));
+  const b = new Set(norm(after));
+  return {
+    removed: [...a].filter((l) => !b.has(l)).sort(),
+    added: [...b].filter((l) => !a.has(l)).sort()
+  };
 }
-function stripErrorLines(text) {
-  return text.split("\n").filter((l) => !l.startsWith(ERR_PREFIX)).join("\n");
+async function prompt(question, valid, def, nonTtyDefault = def) {
+  if (!process.stdin.isTTY) return nonTtyDefault;
+  const rl = readline2.createInterface({ input: process.stdin, output: process.stdout });
+  try {
+    for (; ; ) {
+      const ans = (await rl.question(question)).trim().toLowerCase();
+      if (!ans) return def;
+      if (valid.includes(ans[0])) return ans[0];
+      process.stdout.write(`Please choose one of: ${valid.join(", ")}
+`);
+    }
+  } finally {
+    rl.close();
+  }
+}
+function editorArgv(cmd, args, file) {
+  const base = path2.basename(cmd).replace(/\.exe$/i, "").toLowerCase();
+  if (["vim", "nvim", "gvim", "mvim"].includes(base)) {
+    return [...args, "-c", "syntax enable", "-c", "set ft=bindzone", file];
+  }
+  return [...args, file];
 }
 function openInEditor(zone, content) {
   const file = path2.join(os3.tmpdir(), `greybull-${zone}-${process.pid}.zone`);
@@ -488,7 +540,7 @@ function openInEditor(zone, content) {
   const editor = process.env.VISUAL || process.env.EDITOR || (process.platform === "win32" ? "notepad" : "vi");
   const [cmd, ...args] = editor.split(" ");
   try {
-    const r = spawnSync(cmd, [...args, file], { stdio: "inherit" });
+    const r = spawnSync(cmd, editorArgv(cmd, args, file), { stdio: "inherit" });
     if (r.error) return null;
     return fs2.readFileSync(file, "utf8");
   } finally {
@@ -498,6 +550,7 @@ function openInEditor(zone, content) {
     }
   }
 }
+var ABORTED = "Aborted. No changes made.\n";
 async function editCmd(ctx2, zone) {
   const res = await apiRequest({
     apiUrl: ctx2.apiUrl,
@@ -505,27 +558,50 @@ async function editCmd(ctx2, zone) {
     method: "GET",
     path: `/api/v1/dns/zones/${encodeURIComponent(zone)}/records`
   }).catch((err) => fail(err, ctx2));
-  const original = renderZoneFile(zone, res.data);
-  let buffer = original;
-  let banner = "";
-  let lastTried = null;
+  const originalText = renderZoneFile(zone, res.data);
+  let buffer = originalText;
   for (; ; ) {
-    const edited = openInEditor(zone, banner + buffer);
+    const edited = openInEditor(zone, buffer);
     if (edited === null) fail(new Error("Could not launch editor. Set $EDITOR or $VISUAL."), ctx2);
-    buffer = stripErrorLines(edited);
-    if (normalizeBody(buffer) === normalizeBody(original)) {
-      process.stdout.write("No changes.\n");
-      return;
-    }
-    if (lastTried !== null && normalizeBody(buffer) === normalizeBody(lastTried)) {
-      fail(new Error("Aborted \u2014 the reported problem was not fixed."), ctx2);
-    }
     let records;
     try {
-      records = parseZoneFile(buffer);
+      records = parseZoneFile(edited);
     } catch (err) {
-      banner = errorBanner(err.message);
-      lastTried = buffer;
+      process.stdout.write(`
+Error parsing the zone: ${err.message}
+`);
+      const c2 = await prompt(
+        "Options are: (e)dit your changes, (r)etry with original zone, (a)bort? [e] ",
+        ["e", "r", "a"],
+        "e",
+        "a"
+      );
+      if (c2 === "a") return void process.stdout.write(ABORTED);
+      buffer = c2 === "r" ? originalText : edited;
+      continue;
+    }
+    const { added, removed } = zoneDiff(originalText, edited);
+    if (added.length === 0 && removed.length === 0) {
+      return void process.stdout.write("No changes.\n");
+    }
+    process.stdout.write("\nChanges to apply:\n");
+    removed.forEach((l) => process.stdout.write(`  - ${l}
+`));
+    added.forEach((l) => process.stdout.write(`  + ${l}
+`));
+    process.stdout.write("\n");
+    const c = await prompt(
+      "(a)pply these changes, (e)dit again, (r)etry with original zone, (q)uit? [a] ",
+      ["a", "e", "r", "q"],
+      "a"
+    );
+    if (c === "q") return void process.stdout.write(ABORTED);
+    if (c === "e") {
+      buffer = edited;
+      continue;
+    }
+    if (c === "r") {
+      buffer = originalText;
       continue;
     }
     try {
@@ -536,25 +612,28 @@ async function editCmd(ctx2, zone) {
         path: `/api/v1/dns/zones/${encodeURIComponent(zone)}`,
         body: { records }
       });
-      process.stdout.write(`Applied ${put.data.applied} record(s) to ${zone}.
+      process.stdout.write(`Applied. ${zone} now has ${put.data.applied} record(s).
 `);
       return;
     } catch (err) {
       if (err instanceof ApiError && (err.status === 422 || err.status === 400)) {
-        banner = errorBanner(err.message);
-        lastTried = buffer;
+        process.stdout.write(`
+The DNS server rejected the zone: ${err.message}
+`);
+        const c2 = await prompt(
+          "Options are: (e)dit your changes, (r)etry with original zone, (a)bort? [e] ",
+          ["e", "r", "a"],
+          "e",
+          "a"
+        );
+        if (c2 === "a") return void process.stdout.write(ABORTED);
+        buffer = c2 === "r" ? originalText : edited;
         continue;
       }
       fail(err, ctx2);
     }
   }
 }
-function errorBanner(message) {
-  return `${ERR_PREFIX}${message}
-${ERR_PREFIX}Fix and save again, or exit without changes to abort.
-;
-`;
-}
 
 // src/commands/domains.ts
 async function domainsListCmd(ctx2) {
@@ -595,7 +674,7 @@ async function domainsCheckCmd(ctx2, query, opts) {
 
 // src/index.ts
 var program = new Command();
-program.name("greybull").description("Manage Greybull DNS records and domains from the command line").version("0.2.0").option("--json", "output raw JSON", false).option("--api-url <url>", "portal base URL (or set GREYBULL_API_URL)");
+program.name("greybull").description("Manage Greybull DNS records and domains from the command line").version("0.2.2").option("--json", "output raw JSON", false).option("--api-url <url>", "portal base URL (or set GREYBULL_API_URL)");
 function ctx(requireAuth = true) {
   const opts = program.opts();
   const apiUrl = resolveApiUrl(opts.apiUrl);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "greybull",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Command-line tool for the Greybull portal — manage DNS records and domains",
   "type": "module",
   "bin": {