@freecodecamp/universe-cli 0.4.0 → 0.5.0

package/dist/index.js

@@ -16,10 +16,7 @@ var EXIT_STORAGE = 13;
 var EXIT_GIT = 15;
 var EXIT_CONFIRM = 18;
 var EXIT_PARTIAL = 19;
-function exitWithCode(code, message) {
-  if (message !== void 0) {
-    process.stderr.write(message + "\n");
-  }
+function exitWithCode(code) {
   process.exit(code);
 }
 
@@ -384,6 +381,53 @@ See docs/platform-yaml.md.`
   return { ok: true, value: result.data };
 }
 
+// src/lib/similarity.ts
+function editDistance(a, b) {
+  const m = a.length;
+  const n = b.length;
+  if (m === 0) return n;
+  if (n === 0) return m;
+  const d = Array.from(
+    { length: m + 1 },
+    () => new Array(n + 1).fill(0)
+  );
+  for (let i = 0; i <= m; i++) d[i][0] = i;
+  for (let j = 0; j <= n; j++) d[0][j] = j;
+  for (let i = 1; i <= m; i++) {
+    for (let j = 1; j <= n; j++) {
+      const cost = a[i - 1] === b[j - 1] ? 0 : 1;
+      d[i][j] = Math.min(
+        d[i - 1][j] + 1,
+        d[i][j - 1] + 1,
+        d[i - 1][j - 1] + cost
+      );
+      if (i > 1 && j > 1 && a[i - 1] === b[j - 2] && a[i - 2] === b[j - 1]) {
+        d[i][j] = Math.min(d[i][j], d[i - 2][j - 2] + 1);
+      }
+    }
+  }
+  return d[m][n];
+}
+function suggest(target, candidates, threshold = 2) {
+  if (candidates.length === 0) return null;
+  const lc = target.toLowerCase();
+  const sub = candidates.find((c) => {
+    const clc = c.toLowerCase();
+    return clc.includes(lc) || lc.includes(clc);
+  });
+  if (sub) return sub;
+  let best = null;
+  let bestD = threshold + 1;
+  for (const c of candidates) {
+    const d = editDistance(lc, c.toLowerCase());
+    if (d < bestD) {
+      bestD = d;
+      best = c;
+    }
+  }
+  return bestD <= threshold ? best : null;
+}
+
 // src/lib/proxy-client.ts
 var ProxyError = class extends CliError {
   exitCode;
@@ -546,6 +590,52 @@ function createProxyClient(cfg) {
         },
         body: JSON.stringify({ to: req.to })
       });
+    },
+    async registerSite(req) {
+      const body = { slug: req.slug };
+      if (req.teams && req.teams.length > 0) {
+        body.teams = req.teams;
+      }
+      return call(`${base}/api/site/register`, {
+        method: "POST",
+        headers: {
+          Authorization: await userBearer(),
+          Accept: "application/json",
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(body)
+      });
+    },
+    async listSites() {
+      return call(`${base}/api/sites`, {
+        method: "GET",
+        headers: {
+          Authorization: await userBearer(),
+          Accept: "application/json"
+        }
+      });
+    },
+    async updateSite(req) {
+      const url = `${base}/api/site/${encodeURIComponent(req.slug)}`;
+      return call(url, {
+        method: "PATCH",
+        headers: {
+          Authorization: await userBearer(),
+          Accept: "application/json",
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({ teams: req.teams })
+      });
+    },
+    async deleteSite(req) {
+      const url = `${base}/api/site/${encodeURIComponent(req.slug)}`;
+      return call(url, {
+        method: "DELETE",
+        headers: {
+          Authorization: await userBearer(),
+          Accept: "application/json"
+        }
+      });
     }
   };
 }
@@ -740,6 +830,52 @@ function rethrowProxy(prefix, err) {
   if (err instanceof Error) throw new StorageError(`${prefix}: ${err.message}`);
   throw new StorageError(`${prefix}: ${String(err)}`);
 }
+var PREFLIGHT_INLINE_LIST_CAP = 10;
+function formatUnauthorizedSiteError(a) {
+  const lines = [
+    `Site '${a.attempted}' is not registered for your GitHub identity.`,
+    ``,
+    `  You are:  ${a.login}`,
+    ``
+  ];
+  if (a.authorized.length === 0) {
+    lines.push(
+      `  Your identity is authorized for no sites yet.`,
+      ``,
+      `  Likely causes:`,
+      `    1. The '${a.attempted}' slug is not registered.`,
+      `       Admin (staff): universe sites register ${a.attempted} --team <team>`,
+      `    2. You are not in any team listed on any registered site.`,
+      `       Admin (staff): universe sites update <slug> --team +<your-team>`
+    );
+    return lines.join("\n");
+  }
+  const hint = suggest(a.attempted, a.authorized);
+  if (hint) {
+    lines.push(`  Did you mean: ${hint}?`, ``);
+  }
+  lines.push(
+    `  Likely causes (most common first):`,
+    `    1. Typo in platform.yaml \`site:\` \u2014 check the spelling above.`,
+    `    2. The '${a.attempted}' slug is not registered yet.`,
+    `       Admin (staff): universe sites register ${a.attempted} --team <team>`,
+    `    3. You are not in any team authorized for '${a.attempted}'.`,
+    `       Admin (staff): universe sites update ${a.attempted} --team +<your-team>`,
+    ``
+  );
+  if (a.authorized.length <= PREFLIGHT_INLINE_LIST_CAP) {
+    lines.push(
+      `  Your authorized sites (${a.authorized.length}):`,
+      ...[...a.authorized].sort().map((s) => `    - ${s}`)
+    );
+  } else {
+    lines.push(
+      `  You have ${a.authorized.length} authorized sites \u2014 too many to inline.`,
+      `  Run \`universe sites ls --mine\` to inspect the full list.`
+    );
+  }
+  return lines.join("\n");
+}
 async function deploy(options, deps = {}) {
   const cwd = deps.cwd ?? process.cwd();
   const env = deps.env ?? process.env;
@@ -775,22 +911,12 @@ async function deploy(options, deps = {}) {
       rethrowProxy("whoami preflight failed", err);
     }
     if (!me.authorizedSites.includes(config.site)) {
-      const sitesLine = me.authorizedSites.length > 0 ? me.authorizedSites.join(", ") : "(no sites authorized)";
       throw new CredentialError(
-        [
-          `Site '${config.site}' is not registered for your GitHub identity.`,
-          ``,
-          `  You are:           ${me.login}`,
-          `  Authorized sites:  ${sitesLine}`,
-          ``,
-          `Likely causes (most common first):`,
-          `  1. Platform admin has not added '${config.site}' to artemis`,
-          `     'config/sites.yaml' yet (one-time, per site).`,
-          `  2. You are not in any GitHub team listed for '${config.site}'.`,
-          ``,
-          `Runbook:`,
-          `  https://github.com/freeCodeCamp/infra/blob/main/docs/runbooks/01-deploy-new-constellation-site.md`
-        ].join("\n")
+        formatUnauthorizedSiteError({
+          attempted: config.site,
+          login: me.login,
+          authorized: me.authorizedSites
+        })
       );
     }
     const git = gitState();
@@ -901,7 +1027,7 @@ async function deploy(options, deps = {}) {
     } else {
       error(message);
     }
-    exit(code, message);
+    exit(code);
   }
 }
 
@@ -1012,7 +1138,7 @@ async function login(options, deps = {}) {
       } else {
         error(msg);
       }
-      exit(EXIT_CONFIRM, msg);
+      exit(EXIT_CONFIRM);
       return;
     }
   }
@@ -1055,7 +1181,7 @@ async function login(options, deps = {}) {
     } else {
       error(message);
     }
-    exit(EXIT_CREDENTIALS, message);
+    exit(EXIT_CREDENTIALS);
     return;
   }
   await save(token);
@@ -1191,7 +1317,7 @@ async function ls(options, deps = {}) {
     } else {
       error(message);
     }
-    exit(code, message);
+    exit(code);
   }
 }
 
@@ -1279,7 +1405,7 @@ async function promote(options, deps = {}) {
     } else {
       error(message);
     }
-    exit(code, message);
+    exit(code);
   }
 }
 
@@ -1367,7 +1493,7 @@ async function rollback(options, deps = {}) {
     } else {
       error(message);
     }
-    exit(code, message);
+    exit(code);
   }
 }
 
@@ -1392,7 +1518,7 @@ async function whoami(options, deps = {}) {
     } else {
       error(msg);
     }
-    exit(EXIT_CREDENTIALS, msg);
+    exit(EXIT_CREDENTIALS);
     return;
   }
   const baseUrl = env["UNIVERSE_PROXY_URL"] ?? DEFAULT_PROXY_URL2;
@@ -1402,21 +1528,22 @@ async function whoami(options, deps = {}) {
   });
   try {
     const result = await client.whoami();
+    const count = result.authorizedSites.length;
     if (options.json) {
       emitJson7(
         buildEnvelope("whoami", true, {
           login: result.login,
-          authorizedSites: result.authorizedSites,
-          identitySource: identity.source
+          identitySource: identity.source,
+          authorizedSitesCount: count
         })
       );
     } else {
-      const sites = result.authorizedSites.length > 0 ? result.authorizedSites.join(", ") : "(no sites authorized)";
+      const sitesLine = count === 0 ? "Authorized for 0 sites." : `Authorized for ${count} site${count === 1 ? "" : "s"} \u2014 run \`universe sites ls --mine\``;
       success(
         [
           `Logged in as: ${result.login}`,
-          `Authorized sites: ${sites}`,
-          `Identity source: ${identity.source}`
+          `Identity source: ${identity.source}`,
+          sitesLine
         ].join("\n")
       );
     }
@@ -1428,13 +1555,238 @@ async function whoami(options, deps = {}) {
     } else {
       error(message);
     }
-    exit(exitCode, message);
+    exit(exitCode);
   }
 }
 
-// src/output/format.ts
+// src/commands/sites/ls.ts
 import { log as log8 } from "@clack/prompts";
 
+// src/commands/sites/_shared.ts
+function emitJson8(envelope) {
+  process.stdout.write(JSON.stringify(envelope) + "\n");
+}
+function parseTeamsFlag(raw) {
+  if (raw === void 0 || raw === null) return [];
+  const tokens = Array.isArray(raw) ? raw : [raw];
+  return tokens.flatMap((s) => s.split(",")).map((s) => s.trim()).filter((s) => s.length > 0);
+}
+async function setupClient(deps) {
+  const env = deps.env ?? process.env;
+  const resolveId = deps.resolveIdentity ?? resolveIdentity;
+  const mkClient = deps.createProxyClient ?? createProxyClient;
+  const identity = await resolveId({ env });
+  if (!identity) {
+    throw new CredentialError(
+      "No GitHub identity available. Run `universe login`, set $GITHUB_TOKEN, or install the gh CLI."
+    );
+  }
+  const baseUrl = env["UNIVERSE_PROXY_URL"] ?? DEFAULT_PROXY_URL;
+  const client = mkClient({
+    baseUrl,
+    getAuthToken: () => identity.token
+  });
+  return { client, identitySource: identity.source };
+}
+
+// src/commands/sites/ls.ts
+function formatTable2(rows) {
+  if (rows.length === 0) return "No registered sites.";
+  const headers = ["SLUG", "TEAMS", "CREATED BY", "CREATED AT"];
+  const cells = rows.map((r) => [
+    r.slug,
+    r.teams.join(","),
+    r.createdBy,
+    r.createdAt
+  ]);
+  const widths = headers.map(
+    (h, i) => Math.max(h.length, ...cells.map((row) => row[i]?.length ?? 0))
+  );
+  const fmt = (row) => row.map((c, i) => c.padEnd(widths[i] ?? 0)).join("  ");
+  return [fmt(headers), ...cells.map(fmt)].join("\n");
+}
+async function ls2(options, deps = {}) {
+  const command = "sites ls";
+  const success = deps.logSuccess ?? ((s) => log8.message(s));
+  const error = deps.logError ?? ((s) => log8.error(s));
+  const exit = deps.exit ?? exitWithCode;
+  try {
+    const { client } = await setupClient(deps);
+    let rows = await client.listSites();
+    let scope = "all";
+    if (options.mine) {
+      const me = await client.whoami();
+      const allowed = new Set(me.authorizedSites);
+      rows = rows.filter((r) => allowed.has(r.slug));
+      scope = "mine";
+    }
+    if (options.json) {
+      emitJson8(
+        buildEnvelope(command, true, {
+          count: rows.length,
+          scope,
+          sites: rows
+        })
+      );
+    } else {
+      success(formatTable2(rows));
+    }
+  } catch (err) {
+    const { code, message } = wrapProxyError(command, err);
+    if (options.json) {
+      emitJson8(buildErrorEnvelope(command, code, message));
+    } else {
+      error(message);
+    }
+    exit(code);
+  }
+}
+
+// src/commands/sites/register.ts
+import { log as log9 } from "@clack/prompts";
+async function register(options, deps = {}) {
+  const command = "sites register";
+  const success = deps.logSuccess ?? ((s) => log9.success(s));
+  const error = deps.logError ?? ((s) => log9.error(s));
+  const exit = deps.exit ?? exitWithCode;
+  try {
+    if (!options.slug || options.slug.trim().length === 0) {
+      throw new UsageError("slug is required (positional argument)");
+    }
+    const teams = parseTeamsFlag(options.team);
+    const { client } = await setupClient(deps);
+    const row = await client.registerSite({
+      slug: options.slug,
+      teams: teams.length > 0 ? teams : void 0
+    });
+    if (options.json) {
+      emitJson8(
+        buildEnvelope(command, true, {
+          slug: row.slug,
+          teams: row.teams,
+          createdAt: row.createdAt,
+          createdBy: row.createdBy
+        })
+      );
+    } else {
+      success(
+        [
+          `Registered ${row.slug}`,
+          ``,
+          `  Slug:        ${row.slug}`,
+          `  Teams:       ${row.teams.join(", ")}`,
+          `  Created by:  ${row.createdBy}`,
+          `  Created at:  ${row.createdAt}`
+        ].join("\n")
+      );
+    }
+  } catch (err) {
+    const { code, message } = wrapProxyError(command, err);
+    if (options.json) {
+      emitJson8(buildErrorEnvelope(command, code, message));
+    } else {
+      error(message);
+    }
+    exit(code);
+  }
+}
+
+// src/commands/sites/rm.ts
+import { log as log10 } from "@clack/prompts";
+async function rm2(options, deps = {}) {
+  const command = "sites rm";
+  const success = deps.logSuccess ?? ((s) => log10.success(s));
+  const error = deps.logError ?? ((s) => log10.error(s));
+  const exit = deps.exit ?? exitWithCode;
+  try {
+    if (!options.slug || options.slug.trim().length === 0) {
+      throw new UsageError("slug is required (positional argument)");
+    }
+    const { client } = await setupClient(deps);
+    await client.deleteSite({ slug: options.slug });
+    if (options.json) {
+      emitJson8(
+        buildEnvelope(command, true, {
+          slug: options.slug,
+          deleted: true
+        })
+      );
+    } else {
+      success(
+        [
+          `Deleted ${options.slug}`,
+          ``,
+          `  Note: R2 deploy bytes are NOT removed; they age out via the`,
+          `        post-GA cleanup cron.`
+        ].join("\n")
+      );
+    }
+  } catch (err) {
+    const { code, message } = wrapProxyError(command, err);
+    if (options.json) {
+      emitJson8(buildErrorEnvelope(command, code, message));
+    } else {
+      error(message);
+    }
+    exit(code);
+  }
+}
+
+// src/commands/sites/update.ts
+import { log as log11 } from "@clack/prompts";
+async function update(options, deps = {}) {
+  const command = "sites update";
+  const success = deps.logSuccess ?? ((s) => log11.success(s));
+  const error = deps.logError ?? ((s) => log11.error(s));
+  const exit = deps.exit ?? exitWithCode;
+  try {
+    if (!options.slug || options.slug.trim().length === 0) {
+      throw new UsageError("slug is required (positional argument)");
+    }
+    const teams = parseTeamsFlag(options.team);
+    if (teams.length === 0) {
+      throw new UsageError(
+        "--team is required with at least one slug; use `sites rm` to remove a site"
+      );
+    }
+    const { client } = await setupClient(deps);
+    const row = await client.updateSite({
+      slug: options.slug,
+      teams
+    });
+    if (options.json) {
+      emitJson8(
+        buildEnvelope(command, true, {
+          slug: row.slug,
+          teams: row.teams,
+          updatedAt: row.updatedAt
+        })
+      );
+    } else {
+      success(
+        [
+          `Updated ${row.slug}`,
+          ``,
+          `  Slug:        ${row.slug}`,
+          `  Teams:       ${row.teams.join(", ")}`,
+          `  Updated at:  ${row.updatedAt}`
+        ].join("\n")
+      );
+    }
+  } catch (err) {
+    const { code, message } = wrapProxyError(command, err);
+    if (options.json) {
+      emitJson8(buildErrorEnvelope(command, code, message));
+    } else {
+      error(message);
+    }
+    exit(code);
+  }
+}
+
+// src/output/format.ts
+import { log as log12 } from "@clack/prompts";
+
 // src/output/redact.ts
 var AWS_KEY_PREFIX_PATTERN = /(?:AKIA|ASIA|AROA|AIDA|ACCA|ANPA|ABIA|AGPA)[A-Z0-9]{12,}/g;
 var URL_CREDS_PATTERN = /https?:\/\/[^@\s]+@/g;
@@ -1492,18 +1844,18 @@ function outputError(ctx, code, message, issues) {
     );
     process.stdout.write(JSON.stringify(envelope) + "\n");
   } else {
-    log8.error(redactedMessage);
+    log12.error(redactedMessage);
   }
 }
 
 // src/cli.ts
-var version = true ? "0.4.0" : "0.0.0";
+var version = true ? "0.5.0" : "0.0.0";
 function handleActionError(command, json, err) {
   const ctx = { json, command };
   const message = err instanceof Error ? err.message : "unknown error";
   const code = err instanceof CliError ? err.exitCode : EXIT_USAGE;
   outputError(ctx, code, message);
-  exitWithCode(code, message);
+  exitWithCode(code);
 }
 function findFirstPositional(args) {
   for (let i = 0; i < args.length; i += 1) {
@@ -1515,7 +1867,75 @@ function findFirstPositional(args) {
 function run(argv = process.argv) {
   const args = argv.slice(2);
   const firstPosIdx = findFirstPositional(args);
-  const isStatic = firstPosIdx >= 0 && args[firstPosIdx] === "static";
+  const namespace = firstPosIdx >= 0 ? args[firstPosIdx] : void 0;
+  const isStatic = namespace === "static";
+  const isSites = namespace === "sites";
+  if (isSites) {
+    const sitesArgs = [
+      ...args.slice(0, firstPosIdx),
+      ...args.slice(firstPosIdx + 1)
+    ];
+    const sitesCli = cac("universe sites");
+    sitesCli.command("register <slug>", "Register a new static site (staff only)").option("--json", "Output as JSON").option(
+      "--team <name>",
+      "GitHub team slug (repeatable, or comma-separated). Defaults to staff."
+    ).action(
+      async (slug, flags) => {
+        try {
+          await register({
+            json: flags.json ?? false,
+            slug,
+            team: flags.team
+          });
+        } catch (err) {
+          handleActionError("sites register", flags.json ?? false, err);
+        }
+      }
+    );
+    sitesCli.command("ls", "List sites in the registry").option("--json", "Output as JSON").option(
+      "--mine",
+      "Filter to sites your GitHub identity is authorized for"
+    ).action(async (flags) => {
+      try {
+        await ls2({
+          json: flags.json ?? false,
+          mine: flags.mine ?? false
+        });
+      } catch (err) {
+        handleActionError("sites ls", flags.json ?? false, err);
+      }
+    });
+    sitesCli.command(
+      "update <slug>",
+      "Replace the teams list for an existing site (staff only)"
+    ).option("--json", "Output as JSON").option(
+      "--team <name>",
+      "GitHub team slug (repeatable, or comma-separated). Required."
+    ).action(
+      async (slug, flags) => {
+        try {
+          await update({
+            json: flags.json ?? false,
+            slug,
+            team: flags.team
+          });
+        } catch (err) {
+          handleActionError("sites update", flags.json ?? false, err);
+        }
+      }
+    );
+    sitesCli.command("rm <slug>", "Remove a site from the registry (staff only)").option("--json", "Output as JSON").action(async (slug, flags) => {
+      try {
+        await rm2({ json: flags.json ?? false, slug });
+      } catch (err) {
+        handleActionError("sites rm", flags.json ?? false, err);
+      }
+    });
+    sitesCli.help();
+    sitesCli.version(version);
+    sitesCli.parse(["node", "universe-sites", ...sitesArgs]);
+    return;
+  }
   if (isStatic) {
     const staticArgs = [
       ...args.slice(0, firstPosIdx),
@@ -1598,6 +2018,7 @@ function run(argv = process.argv) {
       }
     });
     cli.command("static <subcommand>", "Static site deployment commands");
+    cli.command("sites <subcommand>", "Static site registry commands");
     cli.help();
     cli.version(version);
     cli.parse(argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freecodecamp/universe-cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "dist/index.js",
   "scripts": {
     "test": "vitest run",
@@ -44,7 +44,7 @@
   },
   "packageManager": "pnpm@10.33.0",
   "engines": {
-    "node": ">=22.11.0"
+    "node": ">=24.0.0"
   },
   "description": "Static site deployment CLI for the freeCodeCamp Universe platform",
   "homepage": "https://github.com/freeCodeCamp-Universe/universe-cli#readme",