@barekey/cli 0.1.4 → 0.2.0

package/AGENTS.md

@@ -7,3 +7,8 @@
 - Use `bun run <script>` for project scripts.
 - Use `bun test` for tests.
 - Do not use `npm` or commit `package-lock.json`.
+
+## Releases
+
+- If work includes merging changes to `/home/sander/barekey/sdk` on `master`, make sure the SDK `package.json` version is bumped before or with that merge whenever the SDK surface, generated types, runtime behavior, or published artifacts changed.
+- Use semantic versioning for SDK version bumps: `patch` for backward-compatible fixes, `minor` for backward-compatible features, `major` for breaking changes.

package/bun.lock

@@ -5,7 +5,7 @@
     "": {
       "name": "@barekey/cli",
       "dependencies": {
-        "@barekey/sdk": "^0.1.3",
+        "@barekey/sdk": "^0.2.0",
         "@clack/prompts": "^0.11.0",
         "commander": "^14.0.1",
         "open": "^10.2.0",
@@ -18,7 +18,7 @@
     },
   },
   "packages": {
-    "@barekey/sdk": ["@barekey/sdk@0.1.3", "", {}, "sha512-Y5defUYsa6r6GnfR7i0zNnKVI6gXp/GJihVO7+kpijCA61Hnf5hheBTZQyEUma+G1U7MxLcQM/g+FNSHSOXeYQ=="],
+    "@barekey/sdk": ["@barekey/sdk@0.2.0", "", {}, "sha512-vSbxzJ6ZqR8ThBqe6DIweoQliF6nCfuDvUnuKHFFqBVagkcT26goZekD9NXfJBb/Obip9rdJvKG9zfFTV1UBgQ=="],
 
     "@clack/core": ["@clack/core@0.5.0", "", { "dependencies": { "picocolors": "^1.0.0", "sisteransi": "^1.0.5" } }, "sha512-p3y0FIOwaYRUPRcMO7+dlmLh8PSRcrjuTndsiA0WAFbWES0mLZlrjVoBRZ9DzkPFJZG6KGkJmoEAY0ZcVWTkow=="],
 

package/dist/commands/typegen.d.ts

@@ -1,2 +1,4 @@
+import type { BarekeyTypegenResult } from "@barekey/sdk/server";
 import { Command } from "commander";
+export declare function formatTypegenResultMessage(result: BarekeyTypegenResult): string;
 export declare function registerTypegenCommand(program: Command): void;

package/dist/commands/typegen.js

@@ -1,5 +1,20 @@
 import { BarekeyClient } from "@barekey/sdk/server";
+import pc from "picocolors";
 import { addTargetOptions, requireLocalSession, resolveTarget, } from "../command-utils.js";
+export function formatTypegenResultMessage(result) {
+    const title = result.written
+        ? pc.green(pc.bold("Typegen complete"))
+        : pc.cyan(pc.bold("Typegen already up to date"));
+    const detail = result.written
+        ? "Fresh SDK types are ready in your installed @barekey/sdk package."
+        : "Your installed @barekey/sdk package already has the latest generated types.";
+    return [
+        title,
+        detail,
+        `${pc.bold("Server types")}: ${result.serverPath}`,
+        `${pc.bold("Public types")}: ${result.publicPath}`,
+    ].join("\n");
+}
 async function runTypegen(options) {
     const local = await requireLocalSession();
     const target = await resolveTarget(options, local);
@@ -14,7 +29,7 @@ async function runTypegen(options) {
         typegen: false,
     });
     const result = await client.typegen();
-    console.log(`${result.written ? "Updated" : "Unchanged"} ${result.path}`);
+    console.log(formatTypegenResultMessage(result));
 }
 export function registerTypegenCommand(program) {
     addTargetOptions(program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barekey/cli",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Barekey command line interface",
   "type": "module",
   "bin": {
@@ -15,7 +15,7 @@
   "packageManager": "bun@1.2.22",
   "dependencies": {
     "@clack/prompts": "^0.11.0",
-    "@barekey/sdk": "^0.1.3",
+    "@barekey/sdk": "^0.2.0",
     "commander": "^14.0.1",
     "open": "^10.2.0",
     "picocolors": "^1.1.1"

package/src/commands/typegen.ts

@@ -1,5 +1,7 @@
 import { BarekeyClient } from "@barekey/sdk/server";
+import type { BarekeyTypegenResult } from "@barekey/sdk/server";
 import { Command } from "commander";
+import pc from "picocolors";
 
 import {
   addTargetOptions,
@@ -8,6 +10,22 @@ import {
   type EnvTargetOptions,
 } from "../command-utils.js";
 
+export function formatTypegenResultMessage(result: BarekeyTypegenResult): string {
+  const title = result.written
+    ? pc.green(pc.bold("Typegen complete"))
+    : pc.cyan(pc.bold("Typegen already up to date"));
+  const detail = result.written
+    ? "Fresh SDK types are ready in your installed @barekey/sdk package."
+    : "Your installed @barekey/sdk package already has the latest generated types.";
+
+  return [
+    title,
+    detail,
+    `${pc.bold("Server types")}: ${result.serverPath}`,
+    `${pc.bold("Public types")}: ${result.publicPath}`,
+  ].join("\n");
+}
+
 async function runTypegen(options: EnvTargetOptions): Promise<void> {
   const local = await requireLocalSession();
   const target = await resolveTarget(options, local);
@@ -24,7 +42,7 @@ async function runTypegen(options: EnvTargetOptions): Promise<void> {
   });
   const result = await client.typegen();
 
-  console.log(`${result.written ? "Updated" : "Unchanged"} ${result.path}`);
+  console.log(formatTypegenResultMessage(result));
 }
 
 export function registerTypegenCommand(program: Command): void {

package/test/typegen.test.ts

@@ -0,0 +1,37 @@
+import { describe, expect, test } from "bun:test";
+
+import { formatTypegenResultMessage } from "../src/commands/typegen";
+
+describe("formatTypegenResultMessage", () => {
+  test("renders a helpful success message when files were updated", () => {
+    const message = formatTypegenResultMessage({
+      written: true,
+      path: "/tmp/generated.server.d.ts",
+      serverPath: "/tmp/generated.server.d.ts",
+      publicPath: "/tmp/generated.public.d.ts",
+      manifestVersion: "manifest-1",
+    });
+
+    expect(message).toContain("Typegen complete");
+    expect(message).toContain("Fresh SDK types are ready");
+    expect(message).toContain("Server types");
+    expect(message).toContain("/tmp/generated.server.d.ts");
+    expect(message).toContain("Public types");
+    expect(message).toContain("/tmp/generated.public.d.ts");
+  });
+
+  test("renders a calm message when nothing changed", () => {
+    const message = formatTypegenResultMessage({
+      written: false,
+      path: "/tmp/generated.server.d.ts",
+      serverPath: "/tmp/generated.server.d.ts",
+      publicPath: "/tmp/generated.public.d.ts",
+      manifestVersion: "manifest-1",
+    });
+
+    expect(message).toContain("Typegen already up to date");
+    expect(message).toContain("already has the latest generated types");
+    expect(message).toContain("/tmp/generated.server.d.ts");
+    expect(message).toContain("/tmp/generated.public.d.ts");
+  });
+});