@cueloop/client 0.1.0-alpha.4 → 0.1.0-alpha.41

package/src/editor.ts

@@ -1,7 +1,11 @@
 /**
- * File-level edit mode = the $EDITOR hand-off (#22, #11): write the working
- * copy to a temp file, run the user's editor on it, read the result back.
- * Tests point CUELOOP_EDITOR at a non-interactive command.
+ * File-level edit mode = the editor hand-off: write the working copy to a temp
+ * file, run the reviewer's editor on it, read the result back. Editing must
+ * work with zero configuration, so the resolution chain ends in a terminal
+ * fallback that is always present. A GUI editor launched without a wait flag
+ * forks and returns instantly, losing the edit silently; known GUI editors get
+ * their wait flag applied, and any editor that still returns right away with an
+ * untouched file drops to a confirm gate rather than discarding the work.
  */
 
 import { mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
@@ -13,20 +17,130 @@ export interface EditResult {
   changed: boolean;
 }
 
-export function editInEditor(content: string, filename = "plan.md"): EditResult {
-  const editor = process.env.CUELOOP_EDITOR ?? process.env.VISUAL ?? process.env.EDITOR;
-  if (!editor) throw new Error("no editor: set $EDITOR (or $CUELOOP_EDITOR)");
+/** Present on every POSIX system, so a clean shell can still edit. */
+const DEFAULT_EDITOR = "nano";
+
+/** GUI editors fork and return immediately unless given their wait flag. */
+const GUI_WAIT_FLAGS: Record<string, string[]> = {
+  code: ["--wait"],
+  "code-insiders": ["--wait"],
+  codium: ["--wait"],
+  cursor: ["--wait"],
+  windsurf: ["--wait"],
+  subl: ["--new-window", "--wait"],
+  sublime_text: ["--new-window", "--wait"],
+  zed: ["--wait"],
+  bbedit: ["--wait"],
+  mate: ["--wait"],
+  gedit: ["--wait"],
+  kate: ["--block"],
+  idea: ["--wait"],
+  webstorm: ["--wait"],
+};
+
+/** Editors that hold the terminal themselves - never GUI, never a wait gate. */
+const TERMINAL_EDITORS = new Set([
+  "vi",
+  "vim",
+  "nvim",
+  "nano",
+  "pico",
+  "emacs",
+  "emacsclient",
+  "micro",
+  "hx",
+  "helix",
+  "kak",
+  "ed",
+  "joe",
+  "mcedit",
+]);
+
+export interface ResolvedEditor {
+  argv: string[];
+  /** True when this editor blocks the hand-off until the file is closed - a
+   * terminal editor, or a known GUI editor with its wait flag applied. */
+  waits: boolean;
+}
+
+/** The editor to run: [ui] editor, then the environment chain, then nano. */
+export function resolveEditor(
+  configuredEditor: string | undefined,
+  env: Record<string, string | undefined> = process.env,
+): string {
+  const candidates = [configuredEditor, env.CUELOOP_EDITOR, env.VISUAL, env.EDITOR];
+  return candidates.find((candidate) => candidate && candidate.trim())?.trim() ?? DEFAULT_EDITOR;
+}
+
+function editorBaseName(command: string): string {
+  return (command.split(/[\\/]/).pop() ?? command).toLowerCase();
+}
+
+/** Split the editor string and apply a GUI wait flag when we know one. */
+export function resolveEditorCommand(rawEditor: string): ResolvedEditor {
+  const parts = rawEditor.trim().split(/\s+/);
+  const base = editorBaseName(parts[0] ?? "");
+  if (TERMINAL_EDITORS.has(base)) return { argv: parts, waits: true };
+  const waitFlags = GUI_WAIT_FLAGS[base];
+  if (waitFlags) {
+    const alreadyWaits = parts.some(
+      (part) => part === "--wait" || part === "-w" || part === "--block",
+    );
+    return { argv: alreadyWaits ? parts : [...parts, ...waitFlags], waits: true };
+  }
+  return { argv: parts, waits: false };
+}
+
+/** A fast return with an untouched file means the editor probably did not wait. */
+const NO_WAIT_THRESHOLD_MS = 1000;
+
+function suspectsNoWait(resolved: ResolvedEditor, elapsedMs: number, unchanged: boolean): boolean {
+  if (resolved.waits) return false; // holds the terminal or has a wait flag - trust the exit
+  if (!unchanged) return false; // edits landed, so it waited after all
+  return elapsedMs < NO_WAIT_THRESHOLD_MS;
+}
+
+export interface EditHandOff {
+  /** Editor from [ui] editor config; overrides the environment. */
+  editor?: string;
+  env?: Record<string, string | undefined>;
+  /** Confirm gate for a suspected no-wait return; true re-reads the file. */
+  confirmSaved?: (editorLabel: string, path: string) => boolean;
+  now?: () => number;
+}
+
+/** Prompt on the released terminal during the suspend window. */
+function promptSaved(editorLabel: string, path: string): boolean {
+  const answer = prompt(
+    `${editorLabel} returned immediately and the plan is unchanged - a GUI editor needs its wait flag. Save and close ${path}, then press Enter to load your edits (or type n to skip):`,
+  );
+  return answer !== null && answer.trim().toLowerCase() !== "n";
+}
+
+export function editInEditor(
+  content: string,
+  filename = "plan.md",
+  handOff: EditHandOff = {},
+): EditResult {
+  const env = handOff.env ?? process.env;
+  const now = handOff.now ?? Date.now;
+  const resolved = resolveEditorCommand(resolveEditor(handOff.editor, env));
   const dir = mkdtempSync(join(tmpdir(), "cueloop-edit-"));
   const path = join(dir, filename);
   writeFileSync(path, content);
   try {
-    const proc = Bun.spawnSync([...editor.split(" "), path], {
+    const startedAt = now();
+    const editorProcess = Bun.spawnSync([...resolved.argv, path], {
       stdin: "inherit",
       stdout: "inherit",
       stderr: "inherit",
     });
-    if (proc.exitCode !== 0) throw new Error(`editor exited ${proc.exitCode}`);
-    const next = readFileSync(path, "utf8");
+    if (editorProcess.exitCode !== 0) throw new Error(`editor exited ${editorProcess.exitCode}`);
+    let next = readFileSync(path, "utf8");
+    if (suspectsNoWait(resolved, now() - startedAt, next === content)) {
+      const confirm = handOff.confirmSaved ?? promptSaved;
+      if (confirm(resolved.argv[0] ?? "the editor", path)) next = readFileSync(path, "utf8");
+    }
     return { content: next, changed: next !== content };
   } finally {
     rmSync(dir, { recursive: true, force: true });

package/src/ghostty-terminal.test.ts

@@ -0,0 +1,45 @@
+/** The libghostty-vt FFI wrapper round-trips VT: fed bytes come back as decoded cells with colors and attributes. Skipped where no prebuilt dylib ships for the platform. */
+
+import { describe, expect, test } from "bun:test";
+import { loadGhosttyTerminals } from "./ghostty-terminal";
+
+const factory = loadGhosttyTerminals();
+
+describe("ghostty-terminal FFI", () => {
+  test("reports platform support without throwing", () => {
+    // Assert - null on unsupported platforms, a factory where a dylib ships
+    expect(factory === null || typeof factory.create === "function").toBe(true);
+  });
+
+  test.skipIf(!factory)("writes VT bytes and reads back decoded cells", () => {
+    // Arrange
+    const term = factory!.create(80, 24)!;
+    expect(term).not.toBeNull();
+
+    // Act - plain text then bold + palette-green "GO"
+    term.write(new TextEncoder().encode("hi\x1b[1;32mGO\x1b[0m"));
+    const cells = [0, 1, 2, 3].map((x) => term.readCell(x, 0));
+
+    // Assert - glyphs decode, and the green run is bold on ANSI palette index 2
+    expect(
+      cells.map((c) => (c?.codepoint ? String.fromCodePoint(c.codepoint) : " ")).join(""),
+    ).toBe("hiGO");
+    expect(cells[2]!.bold).toBe(true);
+    expect(cells[2]!.fg).toEqual({ kind: "palette", index: 2 });
+    term.free();
+  });
+
+  test.skipIf(!factory)("tracks the cursor position as text is written", () => {
+    // Arrange
+    const term = factory!.create(80, 24)!;
+
+    // Act
+    term.write(new TextEncoder().encode("abc"));
+
+    // Assert - cursor advanced past the three glyphs on row 0
+    const cursor = term.readCursor();
+    expect(cursor.y).toBe(0);
+    expect(cursor.x).toBe(3);
+    term.free();
+  });
+});

package/src/ghostty-terminal.ts

@@ -0,0 +1,168 @@
+/**
+ * A live in-process terminal emulator backed by Ghostty's VT core (libghostty-vt)
+ * through a flat FFI shim (native/src/shim.c). Feed it a child process's PTY
+ * output with `write`, then read the rendered screen cell-by-cell with `readCell`
+ * to paint it anywhere - this is what lets a real `cc`/shell render inside an
+ * OpenTUI box. Load with `loadGhosttyTerminals`, which returns null when no
+ * prebuilt dylib exists for this platform (callers fall back to a herdr split).
+ */
+
+import { dlopen, FFIType, ptr } from "bun:ffi";
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+
+/** How a cell's color arrived from Ghostty: the terminal default, an ANSI palette index, or true RGB. */
+export type GhosttyColor =
+  | { kind: "default" }
+  | { kind: "palette"; index: number }
+  | { kind: "rgb"; r: number; g: number; b: number };
+
+/** The cursor's viewport position and whether it should be drawn. */
+export interface GhosttyCursor {
+  x: number;
+  y: number;
+  visible: boolean;
+}
+
+/** One decoded screen cell: its glyph, colors, cell width, and text decorations. */
+export interface GhosttyCell {
+  /** Unicode code point; 0 = blank. */
+  codepoint: number;
+  fg: GhosttyColor;
+  bg: GhosttyColor;
+  /** 0 = wide-char trailing cell (skip it), 1 = normal, 2 = double-width lead. */
+  width: number;
+  bold: boolean;
+  italic: boolean;
+  underline: boolean;
+  inverse: boolean;
+  faint: boolean;
+  strikethrough: boolean;
+}
+
+const CVT_SYMBOLS = {
+  cvt_new: { args: [FFIType.u16, FFIType.u16], returns: FFIType.ptr },
+  cvt_free: { args: [FFIType.ptr], returns: FFIType.void },
+  cvt_write: { args: [FFIType.ptr, FFIType.ptr, FFIType.u64], returns: FFIType.void },
+  cvt_resize: { args: [FFIType.ptr, FFIType.u16, FFIType.u16], returns: FFIType.void },
+  cvt_cell: { args: [FFIType.ptr, FFIType.u16, FFIType.u32, FFIType.ptr], returns: FFIType.i32 },
+  cvt_cursor: { args: [FFIType.ptr, FFIType.ptr], returns: FFIType.void },
+} as const;
+
+type CvtLib = ReturnType<typeof dlopen<typeof CVT_SYMBOLS>>["symbols"];
+
+/** The prebuilt shim dylib for this platform, or null when none ships for it. */
+function nativeLibraryPath(): string | null {
+  const suffix = process.platform === "darwin" ? "dylib" : "so";
+  const dir = `${process.platform}-${process.arch}`;
+  const path = join(import.meta.dir, "..", "native", dir, `libcueloopvt.${suffix}`);
+  return existsSync(path) ? path : null;
+}
+
+/**
+ * Open the Ghostty VT library for this platform, or return null when the prebuilt
+ * dylib is missing (the caller degrades to a herdr split instead of embedding).
+ */
+export function loadGhosttyTerminals(): GhosttyTerminalFactory | null {
+  const path = nativeLibraryPath();
+  if (!path) return null;
+  try {
+    const lib = dlopen(path, CVT_SYMBOLS);
+    return new GhosttyTerminalFactory(lib.symbols);
+  } catch (error) {
+    // The file exists but failed to load (bad arch, missing symbol) - a real
+    // fault, not the expected no-prebuilt case; surface it, then degrade.
+    console.error(`cueloop: failed to load ${path}:`, error);
+    return null;
+  }
+}
+
+/** Creates `GhosttyTerminal`s that share one loaded copy of the VT library. */
+export class GhosttyTerminalFactory {
+  constructor(private readonly lib: CvtLib) {}
+  /** A fresh terminal sized to cols x rows, or null if allocation failed. */
+  create(cols: number, rows: number): GhosttyTerminal | null {
+    const handle = this.lib.cvt_new(cols, rows);
+    return handle ? new GhosttyTerminal(this.lib, handle) : null;
+  }
+}
+
+// The flat CvtCell struct the shim writes: u32 codepoint, fg rgba-ish (4 bytes),
+// bg (4 bytes), u8 width, u8 flags, u16 pad = 16 bytes.
+const CELL_STRUCT_BYTES = 16;
+const FLAG_BOLD = 1;
+const FLAG_ITALIC = 2;
+const FLAG_UNDERLINE = 4;
+const FLAG_INVERSE = 8;
+const FLAG_FAINT = 16;
+const FLAG_STRIKETHROUGH = 32;
+
+/** A live Ghostty terminal: feed PTY bytes, read the screen, resize, free. */
+export class GhosttyTerminal {
+  private readonly out = new Uint8Array(CELL_STRUCT_BYTES);
+  private readonly outView = new DataView(this.out.buffer);
+  private readonly cursorOut = new Uint8Array(8);
+  private freed = false;
+
+  constructor(
+    private readonly lib: CvtLib,
+    private readonly handle: NonNullable<ReturnType<CvtLib["cvt_new"]>>,
+  ) {}
+
+  /** Process a chunk of the child's PTY output into the screen state. */
+  write(bytes: Uint8Array): void {
+    if (this.freed || bytes.length === 0) return;
+    this.lib.cvt_write(this.handle, ptr(bytes), BigInt(bytes.length));
+  }
+
+  /** Resize the screen (and the child's tty, via the caller) to cols x rows. */
+  resize(cols: number, rows: number): void {
+    if (this.freed) return;
+    this.lib.cvt_resize(this.handle, cols, rows);
+  }
+
+  /** The rendered cell at viewport (x, y), or null when out of range. */
+  readCell(x: number, y: number): GhosttyCell | null {
+    if (this.freed) return null;
+    if (this.lib.cvt_cell(this.handle, x, y, ptr(this.out)) !== 0) return null;
+    const flags = this.out[13]!;
+    return {
+      codepoint: this.outView.getUint32(0, true),
+      fg: decodeColor(this.out[7]!, this.out[4]!, this.out[5]!, this.out[6]!),
+      bg: decodeColor(this.out[11]!, this.out[8]!, this.out[9]!, this.out[10]!),
+      width: this.out[12]!,
+      bold: (flags & FLAG_BOLD) !== 0,
+      italic: (flags & FLAG_ITALIC) !== 0,
+      underline: (flags & FLAG_UNDERLINE) !== 0,
+      inverse: (flags & FLAG_INVERSE) !== 0,
+      faint: (flags & FLAG_FAINT) !== 0,
+      strikethrough: (flags & FLAG_STRIKETHROUGH) !== 0,
+    };
+  }
+
+  /** The cursor's current viewport position and visibility. */
+  readCursor(): GhosttyCursor {
+    if (this.freed) return { x: 0, y: 0, visible: false };
+    this.lib.cvt_cursor(this.handle, ptr(this.cursorOut));
+    const view = new DataView(this.cursorOut.buffer);
+    return {
+      x: view.getUint16(0, true),
+      y: view.getUint16(2, true),
+      visible: this.cursorOut[4] === 1,
+    };
+  }
+
+  /** Release the terminal; further calls are no-ops. Call once on teardown. */
+  free(): void {
+    if (this.freed) return;
+    this.freed = true;
+    this.lib.cvt_free(this.handle);
+  }
+}
+
+/** Decode the shim's (kind, r, g, b) color triple; palette carries its index in r. */
+function decodeColor(kind: number, r: number, g: number, b: number): GhosttyColor {
+  if (kind === 2) return { kind: "rgb", r, g, b };
+  if (kind === 1) return { kind: "palette", index: r };
+  return { kind: "default" };
+}

package/src/herdr.test.ts

@@ -0,0 +1,41 @@
+import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { focusHerdrPane } from "./herdr";
+
+let dir: string;
+
+beforeEach(() => {
+  dir = mkdtempSync(join(tmpdir(), "cueloop-herdr-"));
+});
+afterEach(() => {
+  rmSync(dir, { recursive: true, force: true });
+});
+
+describe("focusHerdrPane", () => {
+  test("resolves the pane's tab and focuses it", () => {
+    // Arrange
+    const log = join(dir, "calls.log");
+    const stub = join(dir, "herdr");
+    writeFileSync(
+      stub,
+      `#!/bin/sh
+echo "$@" >> "${log}"
+if [ "$1" = "pane" ]; then echo '{"result":{"pane":{"tab_id":"w1:t3"}}}'; fi
+`,
+    );
+    Bun.spawnSync(["chmod", "+x", stub]);
+
+    // Assert
+    expect(focusHerdrPane(stub, "w1:p1")).toBe(true);
+    const calls = readFileSync(log, "utf8").trim().split("\n");
+    expect(calls[0]).toBe("pane get w1:p1");
+    expect(calls[1]).toBe("tab focus w1:t3");
+  });
+
+  test("a missing binary never throws", () => {
+    // Assert
+    expect(focusHerdrPane(join(dir, "nope"), "w1:p1")).toBe(false);
+  });
+});

package/src/herdr.ts

@@ -0,0 +1,27 @@
+/**
+ * First-class herdr return: a review opened beside an agent hands focus back
+ * to the agent's pane when it closes, not leaving the reviewer on a dead tab.
+ * The env contract and the return-target rule live in @cueloop/schema; this
+ * module owns the one reviewer-side action that spawns the herdr CLI. Focus
+ * is best-effort - a failure never blocks closing the review.
+ */
+
+/** Focus the tab holding the target pane. Synchronous: runs just before exit. */
+export function focusHerdrPane(binPath: string, paneId: string): boolean {
+  try {
+    const got = Bun.spawnSync([binPath, "pane", "get", paneId], {
+      stdout: "pipe",
+      stderr: "ignore",
+    });
+    if (got.exitCode !== 0) return false;
+    const parsed = JSON.parse(got.stdout.toString()) as { result?: { pane?: { tab_id?: string } } };
+    const tab = parsed.result?.pane?.tab_id;
+    if (!tab) return false;
+    return (
+      Bun.spawnSync([binPath, "tab", "focus", tab], { stdout: "ignore", stderr: "ignore" })
+        .exitCode === 0
+    );
+  } catch {
+    return false;
+  }
+}

package/src/index.ts

@@ -1,2 +1,12 @@
 export { runClient, type RunClientOptions } from "./run";
 export { serveClient, type ServeHandle, type ServeOptions } from "./serve";
+export { App, type AppProps } from "./App";
+export {
+  collaboratorAnnotations,
+  publishShare,
+  pullShare,
+  pushShare,
+  shareIdFromLine,
+  type ShareResult,
+  type ShareTarget,
+} from "./share";

package/src/integrations.test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, test } from "bun:test";
+import { OBSIDIAN_DEFAULTS } from "@cueloop/integration-obsidian";
+import { loadBundledExporters } from "./integrations";
+import type { IntegrationsConfig } from "./config";
+
+function integrations(overrides: Partial<typeof OBSIDIAN_DEFAULTS> = {}): IntegrationsConfig {
+  return { obsidian: { ...OBSIDIAN_DEFAULTS, ...overrides } };
+}
+
+describe("loadBundledExporters", () => {
+  test("composes the obsidian integration into one named exporter", async () => {
+    // Act
+    const exporters = await loadBundledExporters(integrations());
+
+    // Assert
+    expect(exporters.map((exporter) => exporter.name)).toEqual(["obsidian"]);
+  });
+
+  test("runsOn mirrors the configured export policy", async () => {
+    // Arrange
+    const onApprove = (await loadBundledExporters(integrations({ exportOn: "approve" })))[0]!;
+
+    // Assert
+    expect(onApprove.runsOn("approve")).toBeTrue();
+    expect(onApprove.runsOn("request_changes")).toBeFalse();
+
+    // Arrange
+    const onResolve = (await loadBundledExporters(integrations({ exportOn: "resolve" })))[0]!;
+
+    // Assert
+    expect(onResolve.runsOn("approve")).toBeTrue();
+    expect(onResolve.runsOn("request_changes")).toBeTrue();
+
+    // Arrange
+    const manual = (await loadBundledExporters(integrations({ exportOn: "manual" })))[0]!;
+
+    // Assert
+    expect(manual.runsOn("approve")).toBeFalse();
+    expect(manual.runsOn("request_changes")).toBeFalse();
+  });
+});

package/src/integrations.ts

@@ -0,0 +1,30 @@
+/**
+ * Bundled integration wiring: composes the configured integrations into
+ * generic exporters plus their run policy, so the session controller depends
+ * only on the extension seam, never on an integration's own config type. This
+ * and config.ts are the only client modules that name a concrete integration.
+ */
+
+import { Registry, type Exporter } from "@cueloop/extension-api";
+import { createObsidianExtension, shouldExport } from "@cueloop/integration-obsidian";
+import type { VerdictKind } from "@cueloop/schema";
+import type { IntegrationsConfig } from "./config";
+
+/** An exporter plus the policy deciding which verdicts trigger it. */
+export interface BundledExporter {
+  name: string;
+  run: Exporter;
+  runsOn(verdict: VerdictKind): boolean;
+}
+
+/** Load the bundled integrations from config as generic exporters. */
+export async function loadBundledExporters(
+  integrations: IntegrationsConfig,
+): Promise<BundledExporter[]> {
+  const registry = new Registry();
+  const obsidian = integrations.obsidian;
+  const record = await registry.load("obsidian", createObsidianExtension(obsidian));
+  const run = record.exporters.get("obsidian");
+  if (!run) return [];
+  return [{ name: "obsidian", run, runsOn: (verdict) => shouldExport(obsidian.exportOn, verdict) }];
+}