Files
PaperClipAI/packages/paperclip-runner/src/react/runner-console-app.tsx
Dotta 560e7e48b5 feat(runner): add SDK and developer tooling (#12608)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - The runner package already provides the production protocol and
execution spine.
> - Contributors still need stable SDK surfaces, deterministic test
tools, and local inspection tools.
> - Those surfaces share generated contracts and must change as one
package boundary.
> - This pull request adds the package-local SDK, labs, examples, and
drift checks.
> - The benefit is a reviewable developer platform that does not change
application execution selection.

## Linked Issues or Issue Description

**Subsystem affected**

`packages/paperclip-runner` — runner SDK, conformance tools, and
developer tooling.

**Problem or motivation**

The production runner spine is present, but package consumers cannot
build deterministic integrations, inspect sessions, or verify
provider-neutral behavior through supported surfaces.

**Proposed solution**

Add browser, React, standalone, live-session, scenario, conformance, and
evaluation surfaces. Add generated contract inventories and
package-local verification scripts. Keep production application routing
unchanged.

**Alternatives considered**

We considered splitting each generated catalog, SDK surface, and demo
into separate pull requests. Those changes share exports, fixtures, and
drift gates. Splitting them would create intermediate package states
that do not build.

**Roadmap alignment**

No overlapping item appears in `ROADMAP.md`. This work extends the
runner package that is already on `master`.

## What Changed

- Add browser, React, standalone, live-session, and issue-thread SDK
surfaces.
- Add deterministic mock control-plane, scenario, conformance, replay,
and evaluation tools.
- Add bounded Codex, OpenCode, and ACPX development transports and
fixtures.
- Keep deferred managed-provider execution fail-closed. Persisted
compatibility data remains readable.
- Add generated capability inventories with their source files and drift
checks.
- Add examples, package documentation, browser checks, and
clean-consumer checks.
- Preserve the reviewed protocol bounds, replay compatibility aliases,
process environment isolation, and semantic redaction limits.
- Update the ACPX package patch that the existing workspace patch
registry already tracks.
- Do not change `pnpm-lock.yaml`, repository workflows, server runtime
selection, or the application UI.

## Verification

GitHub Actions is the verification authority for this pull request. The
repository CI, package TypeScript and Rust checks, package tests,
generated-output drift checks, browser checks, security scans, and
Greptile review must pass on the exact head.

Local test suites were not run because this series uses parallel GitHub
Actions for verification.

## Risks

This is a large greenfield package change. The main risks are public
export drift, generated-output drift, and optional React consumer
compatibility. Package boundary checks, clean-consumer checks, and
browser tests cover those risks. Production adapter selection and server
execution are outside this pull request.

## Stack

1. **This PR:** runner SDK and developer tooling.
2. [Codex production server
integration](https://github.com/paperclipai/paperclip/pull/12616).
3. [Provider-neutral task-thread
UI](https://github.com/paperclipai/paperclip/pull/12617).

## Model Used

OpenAI Codex, GPT-5, high-reasoning mode, with tool use and code
execution.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have described the issue in-PR following the feature request
template
- [x] I have not referenced internal/instance-local Paperclip issues or
links
- [x] My branch name describes the change and contains no internal
Paperclip ticket id
- [ ] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-08-31 21:33:11 -05:00

263 lines
13 KiB
TypeScript

import * as React from "react";
import type { RunnerClientOptions } from "../browser/client.js";
import type { SessionItemSnapshot } from "../reducer/session-reducer.js";
import type { TranscriptRequestEntry } from "../browser/transcript-model.js";
import { Badge } from "./components/badge.js";
import { Banner, BannerActions, BannerText } from "./components/banner.js";
import { Button } from "./components/button.js";
import { Composer } from "./components/composer.js";
import { Conversation } from "./components/conversation.js";
import { Dialog } from "./components/dialog.js";
import { Menu } from "./components/menu.js";
import { ConnectionBanner } from "./connection-banner.js";
import { Inspector } from "./inspector.js";
import { ReplayControls } from "./replay-controls.js";
import { ConnectionBlock, GoalBlock, LineageTree, ManifestList } from "./session-timeline.js";
import { useRunnerConsole } from "./use-runner-console.js";
const COMPACT_QUERY = "(max-width: 56.25rem)";
const CONSOLE_VERSION = "0.1.2";
const CONSOLE_VERSION_EMOJI = "🖇️";
function useCompactLayout(): boolean {
const [compact, setCompact] = React.useState(
() => typeof window !== "undefined" && window.matchMedia?.(COMPACT_QUERY).matches === true,
);
React.useEffect(() => {
const query = window.matchMedia?.(COMPACT_QUERY);
if (query === undefined) return undefined;
const onChange = () => setCompact(query.matches);
onChange();
query.addEventListener("change", onChange);
return () => query.removeEventListener("change", onChange);
}, []);
return compact;
}
export interface RunnerConsoleAppProps extends RunnerClientOptions {
renderItemBody?: (item: SessionItemSnapshot) => React.ReactNode;
renderRequestDetail?: (request: TranscriptRequestEntry) => React.ReactNode;
}
export function RunnerConsoleApp({
baseUrl,
fetchImpl,
eventSourceFactory,
renderItemBody,
renderRequestDetail,
}: RunnerConsoleAppProps = {}) {
const console_ = useRunnerConsole({ baseUrl, fetchImpl, eventSourceFactory });
const [draft, setDraft] = React.useState("");
const [inspectorOpen, setInspectorOpen] = React.useState(false);
const [mobilePanel, setMobilePanel] = React.useState<"session" | "inspector" | null>(null);
const [resetOpen, setResetOpen] = React.useState(false);
const [highlightItemId, setHighlightItemId] = React.useState<string | null>(null);
const [outcomes, setOutcomes] = React.useState<Record<string, string>>({});
const compact = useCompactLayout();
const manifestId = console_.state?.manifest ?? console_.selectedManifestId;
const activeManifest = console_.manifests.find((entry) => entry.id === manifestId);
const pendingRequests = console_.transcript.filter(
(entry): entry is TranscriptRequestEntry => entry.kind === "request" && entry.status === "pending",
);
const viewingChild = console_.selectedThreadId !== null;
React.useEffect(() => {
const stored = window.localStorage.getItem("paperclip-runner.sdk.v1.inspector");
if (stored === "open") setInspectorOpen(true);
}, []);
React.useEffect(() => {
window.localStorage.setItem(
"paperclip-runner.sdk.v1.inspector",
inspectorOpen ? "open" : "closed",
);
}, [inspectorOpen]);
React.useEffect(() => {
if (!compact) setMobilePanel(null);
}, [compact]);
React.useEffect(() => {
const snapshot = console_.snapshot;
if (snapshot === null || console_.state === null) return;
if (!["completed", "failed", "interrupted", "cancelled"].includes(snapshot.turnState)) return;
setOutcomes((current) => ({
...current,
[console_.state!.manifest ?? "unknown"]: snapshot.turnState === "completed" ? "passed observations" : snapshot.turnState,
}));
}, [console_.snapshot, console_.state]);
function submit() {
const text = draft.trim();
if (text.length === 0) return;
setDraft("");
if (console_.state === null) {
void console_.start({ manifestId: "chat", message: text });
} else if (console_.composer === "active-turn") void console_.steer(text);
else void console_.send(text);
}
function runManifest(id: string) {
const manifest = console_.manifests.find((entry) => entry.id === id);
void console_.start({ manifestId: id, message: manifest?.prompt ?? "Run the demo." });
}
const transcript = (
<>
<Conversation
entries={console_.transcript}
highlightItemId={highlightItemId}
onResolveRequest={(request, resolution) => void console_.resolve(request.requestId, request.turnId ?? "", resolution)}
{...(renderItemBody === undefined ? {} : { renderItemBody })}
{...(renderRequestDetail === undefined ? {} : { renderRequestDetail })}
/>
<ul className="pcr-steering-list" aria-label="Steering messages">
{console_.steeringChips.map((chip) => (
<li key={chip.id} className="pcr-steering-chip" data-status={chip.status} data-testid="steering-chip">
<Badge tone={chip.status === "acknowledged" ? "success" : chip.status === "pending" ? "accent" : "danger"}>{chip.status}</Badge>
<span>{chip.text}</span>
{chip.status === "rejected" || chip.status === "failed" ? (
<Button
type="button"
variant="ghost"
data-testid="steer-as-new-message"
onClick={() => {
console_.dismissSteeringChip(chip.id);
void console_.send(chip.text);
}}
>
Send as new message
</Button>
) : null}
</li>
))}
</ul>
</>
);
const composer = (
<div className="pcr-composer-region">
<ConnectionBanner connection={console_.connection} reconnectAttempt={console_.reconnectAttempt} onRetry={console_.retryNow} />
{pendingRequests.length > 0 ? (
<Banner tone="accent" assertive data-testid="pending-request-banner">
<BannerText>{pendingRequests.length} request waiting — Review</BannerText>
<BannerActions><Button type="button" onClick={() => document.querySelector<HTMLElement>('[data-slot="request-card"]')?.focus()}>Review</Button></BannerActions>
</Banner>
) : null}
<Composer
state={console_.composer}
value={draft}
onValueChange={setDraft}
onSubmit={submit}
onStop={() => void console_.interrupt()}
disabledReason={viewingChild
? "Direct steering of child threads is not supported by this app-server."
: null}
/>
</div>
);
const sessionRail = (
<>
<ManifestList manifests={console_.manifests} selectedId={console_.selectedManifestId} onSelect={console_.selectManifest} onRun={runManifest} lastOutcome={outcomes} disabled={console_.busy} />
<ConnectionBlock connection={console_.connection} reconnectAttempt={console_.reconnectAttempt} state={console_.state} pendingRequestCount={pendingRequests.length} onDrop={console_.dropConnection} onRetry={console_.retryNow} onScrollToOldestRequest={() => document.querySelector<HTMLElement>('[data-slot="request-card"]')?.focus()} />
<GoalBlock state={console_.state} onGoal={(operation, body) => void console_.goal(operation, body)} />
<LineageTree lineage={console_.state?.lineage ?? []} selectedThreadId={console_.selectedThreadId} onSelect={console_.selectThread} />
<section data-slot="observation-checklist" className="pcr-panel">
<h2 className="pcr-panel-title">Demo state</h2>
<Button type="button" variant="ghost" onClick={() => setResetOpen(true)}>Reset demo state</Button>
{activeManifest === undefined ? null : (
<ol className="pcr-observation-list" data-testid="observation-checklist">
{activeManifest.expectedObservations.map((observation) => (
<li key={observation}>
<label><input type="checkbox" /> {observation}</label>
</li>
))}
</ol>
)}
</section>
</>
);
const inspector = (
<Inspector events={console_.events} snapshot={console_.snapshot} state={console_.state} connection={console_.connection} reconnectAttempt={console_.reconnectAttempt} replayParity={console_.replayParity} highlightItemId={highlightItemId} onHighlightItem={setHighlightItemId} />
);
const mobileMenuItems = [
{ id: "session", label: "Session controls", enabled: true, reason: null },
{ id: "inspector", label: "Protocol inspector", enabled: true, reason: null },
{
id: "replay",
label: console_.replay.active ? "Exit replay" : "Enter replay",
enabled: console_.events.length > 0,
reason: console_.events.length > 0 ? null : "Replay is available after the session receives events.",
},
] as const;
return (
<div className="pcr-root pcr-console" data-slot="runner-console-app" data-inspector={inspectorOpen} data-mode={manifestId === "chat" ? "chat" : "fixture"}>
<header className="pcr-console-header">
<div className="pcr-console-title">
<span className="pcr-console-version" data-testid="console-version">{CONSOLE_VERSION_EMOJI} v{CONSOLE_VERSION}</span>
{console_.replay.active ? <Badge tone="warning" data-testid="replay-badge">REPLAY</Badge> : null}
<h1>{manifestId === "chat" ? "Codex protocol chat" : activeManifest?.name ?? "Runner reference console"}</h1>
{viewingChild ? (
<p className="pcr-breadcrumb" data-testid="breadcrumb">
root ▸ {console_.selectedThreadId}
</p>
) : null}
</div>
<div className="pcr-console-header-actions">
{compact ? (
<Menu
label="Menu"
triggerId="mobile-console-menu"
items={mobileMenuItems}
onSelect={(id) => {
if (id === "replay") {
if (console_.replay.active) console_.replay.exit();
else console_.replay.enter();
return;
}
if (id === "session" || id === "inspector") setMobilePanel(id);
}}
/>
) : (
<>
<Button type="button" variant="ghost" data-testid="toggle-inspector" aria-pressed={inspectorOpen} onClick={() => setInspectorOpen((current) => !current)}>Protocol inspector</Button>
<Button type="button" variant="ghost" data-testid="toggle-replay" aria-pressed={console_.replay.active} disabled={console_.events.length === 0} onClick={() => console_.replay.active ? console_.replay.exit() : console_.replay.enter()}>{console_.replay.active ? "Exit replay" : "Replay"}</Button>
</>
)}
</div>
</header>
<p className="pcr-visually-hidden" aria-live="polite" data-testid="runner-announcement">{console_.announcement}</p>
{console_.error === null ? null : <Banner tone="danger" assertive><BannerText>{console_.error}</BannerText></Banner>}
{console_.replay.active ? <ReplayControls replay={console_.replay} /> : null}
{compact ? (
<div className="pcr-console-mobile">
<main className="pcr-console-center">{transcript}{composer}</main>
</div>
) : (
<div className="pcr-console-desktop">
<aside className="pcr-console-rail">{sessionRail}</aside>
<main className="pcr-console-center">{transcript}{composer}</main>
{inspectorOpen ? <aside className="pcr-console-inspector" aria-label="Protocol inspector">{inspector}</aside> : null}
</div>
)}
<Dialog
open={compact && mobilePanel !== null}
onClose={() => setMobilePanel(null)}
title={mobilePanel === "inspector" ? "Protocol inspector" : "Session controls"}
description={mobilePanel === "inspector"
? "Inspect protocol state without replacing the primary chat surface."
: "Run manifests and manage the current session. Close this panel to return to chat."}
footer={<Button type="button" onClick={() => setMobilePanel(null)}>Back to chat</Button>}
>
{compact && mobilePanel !== null ? (
<div className="pcr-mobile-panel-content">
{mobilePanel === "inspector" ? inspector : sessionRail}
</div>
) : null}
</Dialog>
<Dialog open={resetOpen} onClose={() => setResetOpen(false)} title="Reset demo state" description="Discards the current live session transcript. Recorded evidence files are not touched." footer={<><Button type="button" variant="ghost" onClick={() => setResetOpen(false)}>Keep the session</Button><Button type="button" variant="danger" data-testid="reset-confirm" onClick={() => { setResetOpen(false); setDraft(""); void console_.reset(); }}>Reset demo state</Button></>} />
</div>
);
}