gentle-shell-bridge 0.3.0 → 0.3.1

package/test/sidebar-sections.test.ts

@@ -1,245 +0,0 @@
-/**
- * The sidebar section surface, proven against the fake host in `test/fake-sidebar.ts`.
- *
- * T1 (S9, S4): the fake host models the host's process-global rail state, its `parts` map and the
- * card frame the layout draws from a rail's `cardGroups`. T2 (S1, S2): the section registry on the
- * same process-global bus as the providers — one ordered snapshot, `id` replacement, a disposer
- * that removes exactly one section.
- *
- * The first two tests are the scaffold's own: the fake is not the host, so it must be shown to
- * behave like it (state slot, later registration, framed output) before any section test leans on
- * it.
- */
-
-import assert from "node:assert/strict";
-import test from "node:test";
-
-import {
-  registerRows,
-  registerSection,
-  resetBusForTests,
-  resetSectionsForTests,
-  snapshotProviders,
-  snapshotSections,
-} from "../src/bus.ts";
-import type { RowProvider, SidebarSection } from "../src/types.ts";
-import {
-  SIDEBAR_STATE_KEY,
-  cardTitles,
-  fakeState,
-  registerNativeFooter,
-  renderSidebar,
-  resetSidebar,
-} from "./fake-sidebar.ts";
-
-const section = (id: string, extra: Partial<SidebarSection> = {}): SidebarSection => ({
-  id,
-  title: id.toUpperCase(),
-  lines: () => [`body ${id}`],
-  ...extra,
-});
-
-const provider = (id: string): RowProvider => ({ id, category: "Layout", rows: () => [] });
-
-const ids = (): string[] => snapshotSections().map((entry) => entry.id);
-
-test.beforeEach(() => {
-  resetBusForTests();
-  resetSectionsForTests();
-  resetSidebar();
-});
-
-test("the fake host carries the rail map on the host's process-global state symbol", () => {
-  assert.equal(SIDEBAR_STATE_KEY, Symbol.for("gentle-pi.experimental-sidebar.state"));
-  assert.equal(renderSidebar(40).join("\n"), "", "an empty host paints nothing");
-
-  registerNativeFooter();
-  const footer = fakeState().parts.get("footer");
-  assert.ok(footer !== undefined, "the native footer sits in the host's rail map");
-  assert.deepEqual(cardTitles(), ["FOOTER"], "the host draws the rail as one framed card");
-});
-
-test("the host can register its footer rail after the first frame was painted", () => {
-  assert.deepEqual(cardTitles(), []);
-  registerNativeFooter();
-  assert.deepEqual(cardTitles(), ["FOOTER"]);
-});
-
-test("registerSection returns a disposer that removes exactly that section", () => {
-  registerSection(section("a"));
-  const disposeB = registerSection(section("b"));
-  registerSection(section("c"));
-
-  assert.deepEqual(ids(), ["a", "b", "c"]);
-
-  disposeB();
-
-  assert.deepEqual(ids(), ["a", "c"], "the other sections keep their relative order");
-});
-
-test("registerSection stores the caller's object unchanged", () => {
-  const registered = section("a", {
-    title: "MUSIC",
-    meta: () => "1 playing",
-    lines: () => ["track  -", "album  -"],
-    defaultVisible: false,
-    order: 3,
-  });
-
-  registerSection(registered);
-
-  assert.equal(snapshotSections()[0], registered, "the snapshot hands back the registered object");
-  assert.equal(snapshotSections()[0].title, "MUSIC");
-  assert.equal(snapshotSections()[0].defaultVisible, false);
-  assert.equal(snapshotSections()[0].order, 3);
-});
-
-test("a second registration with the same id replaces in place, keeping its position", () => {
-  registerSection(section("a"));
-  registerSection(section("b"));
-  registerSection(section("c"));
-
-  const replacement = section("b", { title: "REPLACED" });
-  registerSection(replacement);
-
-  assert.deepEqual(ids(), ["a", "b", "c"], "one entry, original position");
-  assert.equal(snapshotSections().length, 3);
-  assert.equal(snapshotSections()[1], replacement, "the new registration is the live one");
-  assert.equal(snapshotSections()[1].title, "REPLACED");
-});
-
-test("the replaced section's disposer does not remove its replacement", () => {
-  const disposeFirst = registerSection(section("a"));
-  const replacement = section("a", { title: "REPLACED" });
-  registerSection(replacement);
-
-  disposeFirst();
-
-  assert.deepEqual(ids(), ["a"], "the stale disposer is a no-op, not a removal of the replacement");
-  assert.equal(snapshotSections()[0], replacement);
-});
-
-test("a disposer called twice is a no-op the second time", () => {
-  registerSection(section("a"));
-  const disposeB = registerSection(section("b"));
-  registerSection(section("c"));
-
-  disposeB();
-  disposeB();
-
-  assert.deepEqual(ids(), ["a", "c"]);
-});
-
-test("sections with an order come first, ascending and ties by registration order", () => {
-  registerSection(section("un-ordered-first"));
-  registerSection(section("ten", { order: 10 }));
-  registerSection(section("one", { order: 1 }));
-  registerSection(section("tie-a", { order: 5 }));
-  registerSection(section("tie-b", { order: 5 }));
-  registerSection(section("un-ordered-second"));
-
-  assert.deepEqual(
-    ids(),
-    ["one", "tie-a", "tie-b", "ten", "un-ordered-first", "un-ordered-second"],
-    "ordered sections sort ascending ahead of the unordered ones, which keep registration order",
-  );
-});
-
-test("a replacement may move a section by changing its order", () => {
-  registerSection(section("a", { order: 2 }));
-  registerSection(section("b", { order: 1 }));
-
-  registerSection(section("a", { order: 0 }));
-
-  assert.deepEqual(ids(), ["a", "b"]);
-});
-
-test("only numbered orders sort; a section without one goes to the tail", () => {
-  registerSection(section("zero", { order: 0 }));
-  registerSection(section("unordered", { order: undefined }));
-  registerSection(section("negative", { order: -3 }));
-  registerSection(section("not-a-number", { order: Number.NaN }));
-
-  assert.deepEqual(ids(), ["negative", "zero", "unordered", "not-a-number"]);
-});
-
-test("a section snapshot is a stable copy taken at call time", () => {
-  registerSection(section("a"));
-
-  const during = snapshotSections();
-  const seen: string[] = [];
-  for (const entry of during) {
-    seen.push(entry.id);
-    registerSection(section("late"));
-  }
-
-  assert.deepEqual(seen, ["a"]);
-  assert.deepEqual(during.map((entry) => entry.id), ["a"]);
-  assert.deepEqual(ids(), ["a", "late"]);
-});
-
-test("two independent module copies in one process share one section registry", async () => {
-  // A query string yields a second module instance with its own module scope — the closest local
-  // model of jiti's `moduleCache: false` loading two package copies.
-  const secondCopySpecifier = "../src/bus.ts?copy=2";
-  const copyTwo: typeof import("../src/bus.ts") = await import(secondCopySpecifier);
-
-  registerSection(section("from-copy-one"));
-  copyTwo.registerSection(section("from-copy-two"));
-
-  assert.deepEqual(ids(), ["from-copy-one", "from-copy-two"]);
-  assert.deepEqual(
-    copyTwo.snapshotSections().map((entry) => entry.id),
-    ["from-copy-one", "from-copy-two"],
-  );
-
-  const dispose = copyTwo.registerSection(section("shared"));
-  assert.deepEqual(ids(), ["from-copy-one", "from-copy-two", "shared"]);
-  dispose();
-  assert.deepEqual(ids(), ["from-copy-one", "from-copy-two"], "the global registry, not a local one");
-});
-
-test("the section list is reachable behind the same bus slot as the providers", () => {
-  registerSection(section("a"));
-  const slot = (globalThis as unknown as Record<symbol, unknown>)[
-    Symbol.for("gentle-shell-bridge.providers")
-  ];
-  assert.ok(slot !== undefined, "the bus is the provider bus, not a second registry");
-});
-
-test("a bus slot created before sections existed keeps its providers and grows a section list", () => {
-  // A copy of this package that predates sections writes `{ entries }` only. Reading that slot
-  // must not throw away the providers already registered in it.
-  const earlierProvider = provider("earlier");
-  const slot = globalThis as unknown as Record<symbol, unknown>;
-  slot[Symbol.for("gentle-shell-bridge.providers")] = { entries: [{ provider: earlierProvider }] };
-
-  registerSection(section("a"));
-
-  assert.deepEqual(ids(), ["a"], "the section list was added in place");
-  assert.deepEqual(
-    snapshotProviders().map((entry) => entry.id),
-    ["earlier"],
-    "the providers the earlier copy registered are still there",
-  );
-});
-
-test("resetSectionsForTests clears sections and leaves providers registered", () => {
-  registerRows(provider("p"));
-  registerSection(section("a"));
-
-  resetSectionsForTests();
-
-  assert.deepEqual(ids(), []);
-  assert.deepEqual(
-    snapshotProviders().map((entry) => entry.id),
-    ["p"],
-    "provider state is not the section state",
-  );
-});
-
-test("the internal section seams are not on the public entry", async () => {
-  const entry = await import("../src/index.ts");
-  assert.equal("resetSectionsForTests" in entry, false);
-  assert.equal("snapshotSections" in entry, false);
-});

package/test/status-card-styles.test.ts

@@ -1,201 +0,0 @@
-/**
- * `/bridge-status` for the card-styles surface (S7, S12): the line mode, the registered styles in
- * order, the live selection (including a stale one), what the last frame did, the per-style failures,
- * and the one warning the bridge owes the user — a later post-processor can override this frame.
- *
- * The guard that matters most: a session with no card style registered and no card state prints the
- * pre-feature report byte for byte, because every block below is emitted only when it has something
- * to say.
- */
-
-import assert from "node:assert/strict";
-import { mkdtempSync, rmSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import test from "node:test";
-
-import { armBridge } from "../src/arm.ts";
-import { registerCardStyle, resetBusForTests, resetCardStylesForTests } from "../src/bus.ts";
-import { installCardStyleRows, resetCardStyleRowStateForTests } from "../src/card-style-rows.ts";
-import { getCardStyleTransformFailures } from "../src/card-style-transform.ts";
-import {
-  disableCardStyleTransform,
-  installCardStyleTransform,
-  resetCardStyleWiringForTests,
-} from "../src/card-style-wiring.ts";
-import { resetCardStyleTransformForTests } from "../src/card-style-transform.ts";
-import { setCardStyleSelection } from "../src/card-styles.ts";
-import { disableCaptureBackend, resetCaptureStateForTests } from "../src/capture.ts";
-import { resetHookStateForTests } from "../src/hook.ts";
-import { resetNoticesForTests } from "../src/notices.ts";
-import { resetRowBuildStateForTests } from "../src/rows.ts";
-import { disableSidebarBackend, resetSidebarStateForTests } from "../src/sidebar.ts";
-import { resetSectionFailuresForTests } from "../src/sidebar-render.ts";
-import { resetSectionsForTests } from "../src/bus.ts";
-import { collectStatus, formatStatus } from "../src/status.ts";
-import { resetStoreStateForTests } from "../src/store.ts";
-import type { CardStyleRegistration } from "../src/types.ts";
-import { createFakeHost } from "./fake-host.ts";
-import { READ_CARD, createFakeTranscriptTui } from "./fake-transcript.ts";
-
-let configHome: string;
-let previousConfigHome: string | undefined;
-
-test.before(() => {
-  configHome = mkdtempSync(join(tmpdir(), "gsb-status-cards-"));
-  previousConfigHome = process.env.GENTLE_PI_CONFIG_HOME;
-  process.env.GENTLE_PI_CONFIG_HOME = configHome;
-});
-
-test.after(() => {
-  if (previousConfigHome === undefined) delete process.env.GENTLE_PI_CONFIG_HOME;
-  else process.env.GENTLE_PI_CONFIG_HOME = previousConfigHome;
-  rmSync(configHome, { recursive: true, force: true });
-});
-
-test.beforeEach(() => {
-  rmSync(join(configHome, "gentle-shell-bridge"), { recursive: true, force: true });
-  resetBusForTests();
-  resetSectionsForTests();
-  resetCardStylesForTests();
-  resetCardStyleRowStateForTests();
-  resetCardStyleTransformForTests();
-  resetCardStyleWiringForTests();
-  resetCaptureStateForTests();
-  resetHookStateForTests();
-  resetRowBuildStateForTests();
-  resetSidebarStateForTests();
-  resetSectionFailuresForTests();
-  resetNoticesForTests();
-  resetStoreStateForTests();
-  disableCaptureBackend();
-  disableSidebarBackend();
-  disableCardStyleTransform();
-});
-
-const style = (id: string, label: string, order?: number): CardStyleRegistration => ({
-  id,
-  label,
-  ...(order === undefined ? {} : { order }),
-  frame: { top: () => "+", line: (ctx) => `> ${ctx.text}`, bottom: () => "-" },
-});
-
-const statusLines = (): string[] => formatStatus(collectStatus());
-
-const cardBlock = (lines: readonly string[]): string[] => {
-  const start = lines.findIndex((line) => line.startsWith("card styles: "));
-  if (start === -1) return [];
-  const rest = lines.slice(start);
-  const end = rest.findIndex((line) => line.startsWith("card style note: "));
-  return end === -1 ? rest : rest.slice(0, end + 1);
-};
-
-test("a session with no style and no card state keeps the historical output byte for byte", () => {
-  assert.deepEqual(statusLines(), [
-    "gentle-shell-bridge status",
-    "providers: none",
-    "backend: none",
-    "last capture: none",
-    "last failures: none",
-    "store problems: none",
-    "duplicate settings: no build yet",
-  ]);
-  assert.equal(collectStatus().cardStyles, undefined);
-});
-
-test("the block reports mode, styles in order, selection, last frame and the downstream warning", () => {
-  const tui = createFakeTranscriptTui({ lines: [...READ_CARD] });
-  installCardStyleTransform(tui);
-  registerCardStyle(style("loon.cute", "cute", 10));
-  registerCardStyle(style("pix.mono", "mono"));
-  registerCardStyle({
-    id: "loon.broken",
-    label: "broken",
-    frame: {
-      top: () => {
-        throw new Error("top exploded");
-      },
-      line: (ctx) => ctx.text,
-      bottom: () => "-",
-    },
-  });
-
-  setCardStyleSelection("loon.broken");
-  tui.chat.render(40);
-  setCardStyleSelection("loon.cute");
-  tui.chat.render(40);
-
-  assert.deepEqual(
-    getCardStyleTransformFailures(),
-    [{ styleId: "loon.broken", message: "top exploded" }],
-    "the failing style is remembered",
-  );
-  assert.deepEqual(cardBlock(statusLines()), [
-    "card styles: separate, 3 registered",
-    '  - loon.cute "cute" (order 10)',
-    '  - pix.mono "mono" (registration order)',
-    '  - loon.broken "broken" (registration order)',
-    'card style selection: loon.cute "cute"',
-    "card style frame: transformed 1 card",
-    "card style surface conversation: reached (chat wrapped), last frame transformed 1 card",
-    "card style surface rail: not reached (not attempted), last frame none",
-    "card style wiring: chat wrapped",
-    "card style failures: 1",
-    "  - loon.broken: top exploded",
-    "card style note: a downstream post-processor can strip or override this frame; " +
-      "the bridge cannot prevent it.",
-  ]);
-});
-
-test("a stale selection is reported as missing, never rendered (S12)", () => {
-  const tui = createFakeTranscriptTui({ lines: [...READ_CARD] });
-  installCardStyleTransform(tui);
-  const dispose = registerCardStyle(style("loon.cute", "cute"));
-  setCardStyleSelection("loon.cute");
-  tui.chat.render(40);
-  dispose();
-
-  tui.chat.render(40);
-
-  assert.deepEqual(cardBlock(statusLines()), [
-    "card styles: separate, 0 registered",
-    "card style selection: loon.cute (missing: not registered)",
-    "card style frame: pass-through (missing: a disposed style)",
-    "card style surface conversation: reached (chat wrapped), last frame pass-through (missing: a disposed style)",
-    "card style surface rail: not reached (not attempted), last frame none",
-    "card style wiring: chat wrapped",
-    "card style note: a downstream post-processor can strip or override this frame; " +
-      "the bridge cannot prevent it.",
-  ]);
-});
-
-test("an unarmed transform reports why, so a missing repaint has an answer", () => {
-  registerCardStyle(style("loon.cute", "cute"));
-  installCardStyleTransform({ terminal: {}, children: [] });
-
-  const lines = statusLines();
-
-  assert.ok(lines.includes("card style wiring: not wrapped (no-children)"));
-  assert.ok(lines.includes("card style frame: none"));
-});
-
-test("the extended mode is reported once the host's own line was found", () => {
-  const host = createFakeHost({
-    rows: [
-      { category: "Cards", label: "Card bash: builtin", action: () => {} },
-      {
-        category: "Cards",
-        label: () => "Card style: float",
-        action: () => {},
-        choice: { setting: "Card style", value: "float", current: () => true },
-      },
-      { category: "Layout", label: "Layout: builtin", action: () => {} },
-    ],
-  });
-  armBridge(host.ui);
-  installCardStyleRows();
-  registerCardStyle(style("loon.cute", "cute"));
-  host.buildMenu();
-
-  assert.ok(statusLines().includes("card styles: extended, 1 registered"));
-});

package/test/status-section-frame.test.ts

@@ -1,181 +0,0 @@
-/**
- * `/bridge-status` for the section frame (N11, N15): which drawing the header and rows use, whether
- * the theme was captured, how the pointer reaches them, and — when the host's own builders cannot be
- * reached — the gap, named.
- *
- * Every fact asserted here is a measurement of the run: the source comes from looking for the host's
- * builders on the objects the bridge is handed, so the "host" case is proved by publishing them on a
- * fake rail and watching the drawing change.
- */
-
-import assert from "node:assert/strict";
-import { mkdtempSync, rmSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import test from "node:test";
-
-import { registerSection, resetBusForTests, resetSectionsForTests } from "../src/bus.ts";
-import { setRepaintHost, resetRepaintForTests } from "../src/repaint.ts";
-import { resetSectionPanelForTests, setSectionTheme } from "../src/section-panel.ts";
-import { resetSectionPointerForTests } from "../src/section-pointer.ts";
-import {
-  SIDEBAR_RAIL_KEY,
-  disableSidebarBackend,
-  installSidebarBackend,
-  resetSidebarStateForTests,
-} from "../src/sidebar.ts";
-import {
-  installSectionRail,
-  resetSectionFailuresForTests,
-} from "../src/sidebar-render.ts";
-import { collectStatus, formatStatus } from "../src/status.ts";
-import { resetStoreStateForTests } from "../src/store.ts";
-import type { SidebarSection } from "../src/types.ts";
-import { setSectionCollapsed } from "../src/visibility.ts";
-import {
-  fakeState,
-  fakeTerminal,
-  fakeTui,
-  registerNativeFooter,
-  renderSidebar,
-  resetSidebar,
-} from "./fake-sidebar.ts";
-
-let configHome: string;
-let previousConfigHome: string | undefined;
-
-test.before(() => {
-  configHome = mkdtempSync(join(tmpdir(), "gsb-frame-status-"));
-  previousConfigHome = process.env.GENTLE_PI_CONFIG_HOME;
-  process.env.GENTLE_PI_CONFIG_HOME = configHome;
-});
-
-test.after(() => {
-  if (previousConfigHome === undefined) delete process.env.GENTLE_PI_CONFIG_HOME;
-  else process.env.GENTLE_PI_CONFIG_HOME = previousConfigHome;
-  rmSync(configHome, { recursive: true, force: true });
-});
-
-test.beforeEach(() => {
-  rmSync(join(configHome, "gentle-shell-bridge"), { recursive: true, force: true });
-  resetBusForTests();
-  resetSectionsForTests();
-  resetSidebar();
-  resetSidebarStateForTests();
-  resetSectionFailuresForTests();
-  resetSectionPanelForTests();
-  resetSectionPointerForTests();
-  resetRepaintForTests();
-  resetStoreStateForTests();
-  disableSidebarBackend();
-});
-
-const section = (id: string, extra: Partial<SidebarSection> = {}): SidebarSection => ({
-  id,
-  title: id.toUpperCase(),
-  lines: () => [`body ${id}`],
-  ...extra,
-});
-
-function arm(): void {
-  setRepaintHost({ terminal: fakeTerminal(), requestRender: () => {} });
-  registerNativeFooter();
-  installSidebarBackend(() => fakeTui());
-  installSectionRail();
-}
-
-const frameLines = (): string[] => formatStatus(collectStatus()).filter((line) => line.startsWith("section "));
-
-/** A theme shaped like Pi's, so the drawing has something to paint with. */
-const theme = { fg: (role: string, text: string) => `<${role}>${text}`, bold: (text: string) => text };
-
-test("with no section there is no frame block: a row-only session keeps its output", () => {
-  assert.deepEqual(frameLines(), []);
-  assert.equal(collectStatus().sectionFrame, undefined);
-});
-
-test("the fallback reports what it looked for and found, and names the gap", () => {
-  registerSection(section("music"));
-  arm();
-
-  assert.deepEqual(frameLines(), [
-    "section frame: fallback (looked for renderPanelHeader/renderPanelRow on: the terminal sidebar state, the rail part; found none; no theme captured yet, rows drawn uncoloured)",
-    "section interaction: rail handleMouse (the host's own dispatch), hover not used yet",
-    "section frame gap: gentle-shell's lib/shell-panel.ts cannot be imported (Pi loads each extension in its own module graph) and publishes no builder on the rail part, the Pi theme or the terminal's sidebar state, so the header and rows are drawn by a byte-identical port",
-  ]);
-  const frame = collectStatus().sectionFrame;
-  assert.equal(frame?.source, "fallback");
-  assert.deepEqual(frame?.lookedAt, ["the terminal sidebar state", "the rail part"]);
-  assert.equal(frame?.theme, "missing");
-});
-
-test("a host that publishes its own builders is used, and reported as the source", () => {
-  setSectionTheme(theme);
-  registerSection(section("music"));
-  const rail = registerNativeFooter();
-  const host = rail as unknown as Record<string, unknown>;
-  host.renderPanelHeader = (_theme: unknown, _width: number, header: { title: string }) =>
-    `HOST HEADER ${header.title.toUpperCase()}`;
-  host.renderPanelRow = (_width: number, left: string) => `HOST ROW ${left}`;
-  installSidebarBackend(() => fakeTui());
-  installSectionRail();
-
-  assert.deepEqual(frameLines(), [
-    "section frame: host (the host's own renderPanelHeader/renderPanelRow, found on: the Pi theme, the terminal sidebar state, the rail part; theme captured, rows painted in the host's roles)",
-    "section interaction: rail handleMouse (the host's own dispatch), hover not used yet",
-  ]);
-  assert.deepEqual(collectStatus().sectionFrame?.missing, []);
-  assert.deepEqual((fakeState().parts.get(SIDEBAR_RAIL_KEY)?.render(20) ?? []).slice(3), [
-    "HOST HEADER MUSIC",
-    // A plain string row stays the bytes the author wrote, even when the host draws structured rows.
-    "body music",
-  ]);
-});
-
-test("the theme is reported captured once Pi hands it over", () => {
-  setSectionTheme(theme);
-  registerSection(section("music"));
-  arm();
-
-  assert.ok(
-    frameLines()[0].includes("theme captured, rows painted in the host's roles"),
-    frameLines()[0],
-  );
-  assert.equal(collectStatus().sectionFrame?.theme, "captured");
-});
-
-test("a collapsed section says so in the sections table", () => {
-  registerSection(section("music", { title: "MUSIC" }));
-  arm();
-  setSectionCollapsed("music", true);
-
-  assert.deepEqual(
-    formatStatus(collectStatus()).filter((line) => line.includes('"MUSIC"')),
-    ['  - music "MUSIC": visible, collapsed, registration order, row "music"'],
-  );
-  assert.equal(collectStatus().sections?.[0].collapsed, true);
-});
-
-test("the pointer's mechanism is reported once it has been used", () => {
-  setSectionTheme(theme);
-  registerSection(
-    section("music", { lines: () => [{ label: "play", onClick: () => {} }] }),
-  );
-  arm();
-  renderSidebar();
-
-  fakeState().parts.get(SIDEBAR_RAIL_KEY)?.handleMouse?.({
-    type: "move",
-    button: "none",
-    x: 4,
-    y: 4,
-    width: 40,
-    height: 20,
-  });
-
-  assert.equal(collectStatus().sectionFrame?.hover, "host-state");
-  assert.ok(
-    frameLines()[1].includes("hover owner claimed on the host's sidebar state"),
-    frameLines()[1],
-  );
-});