@kvbox/cli 0.5.6 → 0.5.8

package/dist/kvbox.js

@@ -147,7 +147,7 @@ async function spin(message, work, opts = {}) {
 }
 
 // src/program.ts
-import { Command as Command38 } from "commander";
+import { Command as Command39 } from "commander";
 
 // ../shared/src/version.ts
 import { createRequire } from "module";
@@ -162,7 +162,7 @@ function versionOf(srcFileUrl, injected) {
 }
 
 // src/version.ts
-var VERSION = versionOf(import.meta.url, true ? "0.5.6" : void 0);
+var VERSION = versionOf(import.meta.url, true ? "0.5.8" : void 0);
 
 // src/commands/vm/index.ts
 import { Command as Command15 } from "commander";
@@ -550,6 +550,8 @@ var ApiErrorSchema = z2.object({
   error: z2.string()
 });
 var DEFAULT_CLOUD_URL = "https://api.kvbox.sh";
+var ACTIVATED_BY = ["card", "admin"];
+var ActivatedBySchema = z2.enum(ACTIVATED_BY);
 var CloudUserSchema = z2.object({
   /** The handle: what hosts file boxes under (`<username>@<control plane>`). Lowercase, no `@` or `/`. */
   username: z2.string(),
@@ -558,7 +560,14 @@ var CloudUserSchema = z2.object({
   /** Login identity, unique. */
   email: z2.string(),
   role: z2.enum(["admin", "user"]),
-  createdAt: z2.string()
+  createdAt: z2.string(),
+  /**
+   * False until a card is on file or an admin activates the account (#74): then only `/me` and
+   * `/logout` answer. Admins are never gated. A control plane older than #74 does not send these and
+   * gates nobody, hence the defaults: a newer CLI must still parse its answers.
+   */
+  active: z2.boolean().default(true),
+  activatedBy: ActivatedBySchema.nullable().default(null)
 });
 var ORG_ROLES = ["owner", "admin", "member"];
 var OrgRoleSchema = z2.enum(ORG_ROLES);
@@ -566,7 +575,10 @@ var CloudOrgSchema = z2.object({
   slug: z2.string(),
   /** Display name; the slug never changes, this may. */
   name: z2.string(),
-  createdAt: z2.string()
+  createdAt: z2.string(),
+  /** An org pays for itself (#74): off until it has a card or an admin activates it; its boxes are 402. Defaults as on CloudUser. */
+  active: z2.boolean().default(true),
+  activatedBy: ActivatedBySchema.nullable().default(null)
 });
 var OrgMembershipSchema = CloudOrgSchema.extend({ role: OrgRoleSchema });
 var OrgMemberSchema = z2.object({
@@ -587,6 +599,32 @@ var AddMemberRequestSchema = z2.object({
 });
 var SetRoleRequestSchema = z2.object({ role: OrgRoleSchema });
 var MeResponseSchema = CloudUserSchema.extend({ orgs: z2.array(OrgMembershipSchema) });
+var BalanceSchema = z2.object({
+  slug: z2.string(),
+  balance: z2.number(),
+  currency: z2.string(),
+  topUps: z2.number(),
+  spent: z2.number(),
+  /** The first moment usage counts from: the slug's first top-up; null when it has none. */
+  since: z2.string().nullable(),
+  /** When the slug ran out and its boxes were hibernated (the `sweep-credit` job); null in good standing. Absent from a control plane older than this field. */
+  suspendedAt: z2.string().nullable().default(null)
+});
+var TopUpRequestSchema = z2.object({
+  slug: z2.string().min(1),
+  /** In the control plane's currency; negative corrects a mistake. */
+  amount: z2.number().finite(),
+  note: z2.string().max(200).optional()
+});
+var TopUpSchema = z2.object({
+  id: z2.string(),
+  slug: z2.string(),
+  amount: z2.number(),
+  currency: z2.string(),
+  source: z2.enum(["admin", "card", "trial"]),
+  note: z2.string().nullable(),
+  at: z2.string()
+});
 var LoginRequestSchema = z2.object({
   email: z2.string().min(1),
   password: z2.string().min(1),
@@ -735,11 +773,11 @@ var ServerClient = class {
   base;
   autoStart;
   startedOnce = false;
-  async call(method, path, schema, body) {
+  async call(method, path, schema, body, org = this.target.kind === "cloud" ? this.target.org : void 0) {
     const headers = {};
     if (body !== void 0) headers["content-type"] = "application/json";
     if (this.target.kind === "cloud" && this.target.token !== "") headers["authorization"] = `Bearer ${this.target.token}`;
-    if (this.target.kind === "cloud" && this.target.org !== void 0) headers["x-kvbox-org"] = this.target.org;
+    if (this.target.kind === "cloud" && org !== void 0) headers["x-kvbox-org"] = org;
     let res;
     try {
       res = await request(this.base + path, {
@@ -828,6 +866,10 @@ var ServerClient = class {
     const query = q.size === 0 ? "" : `?${q.toString()}`;
     return this.call("GET", `/usage${query}`, UsageReportSchema);
   }
+  /** The prepaid balance of the caller's slug, or of `org` (default: `--org`'s) (#76); a control plane only. */
+  balance(org) {
+    return this.call("GET", "/billing/balance", BalanceSchema, void 0, org);
+  }
   deleteMachine(name) {
     return this.call("DELETE", `/machines/${encodeURIComponent(name)}`, z3.undefined());
   }
@@ -1387,9 +1429,10 @@ var usageCommand = new Command13("usage").description("how long a box ran, slept
 var day = (iso) => iso.slice(0, 10);
 var SYMBOLS = { EUR: "\u20AC", USD: "$", GBP: "\xA3" };
 function money(amount, currency) {
-  const n = amount.toFixed(2);
+  const sign = amount < 0 ? "-" : "";
+  const n = Math.abs(amount).toFixed(2);
   const sym = SYMBOLS[currency.toUpperCase()];
-  return sym === void 0 ? `${n} ${currency}` : `${sym}${n}`;
+  return sym === void 0 ? `${sign}${n} ${currency}` : `${sign}${sym}${n}`;
 }
 function block(u) {
   const estimated = u.estimatedStops === 0 ? "" : color.dim(` (${u.estimatedStops} stop time${u.estimatedStops === 1 ? "" : "s"} estimated)`);
@@ -1988,16 +2031,30 @@ var usageCommand2 = new Command37("usage").description("what your boxes used thi
     }
     const cloud = client.target.kind === "cloud" ? { me: client.target.user } : void 0;
     info(`${day2(report.window.from)} to ${day2(report.window.to)}`);
-    if (report.boxes.length === 0) {
-      info("no usage in this window");
-      return;
+    if (report.boxes.length === 0) info("no usage in this window");
+    else table(usageRows(report, cloud));
+    if (cloud) {
+      const line = await creditLine(client, cloud.me);
+      if (line !== void 0) info(line);
     }
-    table(usageRows(report, cloud));
   } finally {
     await client.close();
   }
 });
 var day2 = (iso) => iso.slice(0, 10);
+async function creditLine(client, me2) {
+  let b;
+  try {
+    b = await client.balance();
+  } catch (err) {
+    if (err instanceof KvboxError) return void 0;
+    throw err;
+  }
+  const whose = b.slug === me2 ? "private" : b.slug;
+  const left = money(b.balance, b.currency);
+  const line = `credit: ${b.balance > 0 ? left : color.red(left)} left ${color.dim(`(${whose})`)}`;
+  return b.suspendedAt ? `${line} ${color.red("out of credit: boxes hibernated until you top up")}` : line;
+}
 function ownerCell2(b, me2) {
   const slug = slugOf(b.owner);
   if (slug === me2) return "private";
@@ -2029,9 +2086,38 @@ function usageRows(report, cloud) {
   return rows;
 }
 
+// src/commands/credit.ts
+import { Command as Command38 } from "commander";
+var creditCommand = new Command38("credit").description("the prepaid credit left on your account and on each of your orgs").option("--org <slug>", "one org only").option("--json", "print as JSON").action(async (opts, cmd) => {
+  const client = await clientFor(cmd.optsWithGlobals(), { autoStart: false });
+  try {
+    if (client.target.kind === "local") throw new KvboxError("credit lives on the control plane: kvbox login first");
+    const me2 = client.target.user;
+    const balances = client.target.org !== void 0 ? [await client.balance()] : await Promise.all([void 0, ...(await client.listOrgs()).map((o) => o.slug)].map((org) => client.balance(org)));
+    if (opts.json) {
+      json(balances);
+      return;
+    }
+    table(balances.map((b) => creditRow(b, me2)));
+  } finally {
+    await client.close();
+  }
+});
+function creditRow(b, me2) {
+  const left = money(b.balance, b.currency);
+  return {
+    owner: b.slug === me2 ? "private" : boxName(b.slug),
+    credit: b.balance > 0 ? left : color.red(left),
+    "topped up": money(b.topUps, b.currency),
+    spent: money(b.spent, b.currency),
+    // Suspended (#76): the sweep hibernated the boxes at zero; a top-up brings them back.
+    state: b.suspendedAt ? color.red("suspended") : b.since === null ? color.dim("never topped up") : "ok"
+  };
+}
+
 // src/program.ts
 function buildProgram() {
-  const program = new Command38("kvbox").description("self-hosted Firecracker microVMs with Docker-like ergonomics").version(VERSION, "-v, --version").option("--local", "use this machine's kvbox-server over its socket, ignoring kvbox login").option("--org <slug>", "the org: where kvbox new creates, and which box a name means when it is not one of yours; before the command here, or after it").showHelpAfterError().enablePositionalOptions();
+  const program = new Command39("kvbox").description("self-hosted Firecracker microVMs with Docker-like ergonomics").version(VERSION, "-v, --version").option("--local", "use this machine's kvbox-server over its socket, ignoring kvbox login").option("--org <slug>", "the org: where kvbox new creates, and which box a name means when it is not one of yours; before the command here, or after it").showHelpAfterError().enablePositionalOptions();
   program.addCommand(vmCommand);
   program.addCommand(snapshotsCommand);
   program.addCommand(serverCommand);
@@ -2040,6 +2126,7 @@ function buildProgram() {
   program.addCommand(whoamiCommand);
   program.addCommand(orgCommand);
   program.addCommand(usageCommand2);
+  program.addCommand(creditCommand);
   for (const cmd of vmAliases) program.addCommand(cmd);
   return program;
 }