@fungi.computer/parakeet 0.0.0-stage → 0.1.0

package/dist/core/tool-view.d.ts

@@ -0,0 +1,182 @@
+import type { ToolItem } from "../store/types.js";
+/** Shared tool status meaning, used by the browser and native presentations. */
+export declare function toolStatusTone(status: ToolItem["status"]): "error" | "success" | "info" | "neutral";
+/**
+ * Closed presentation vocabulary for one tool call. It is chosen from the typed
+ * tool name, never inferred from arguments or result text.
+ */
+export type ToolKind = "code" | "command" | "edit" | "other" | "read" | "search";
+/** Shared artwork identity for browser and native tool rows. */
+export declare const toolKindSigils: {
+    /** Artwork for code execution. */
+    readonly code: "computer";
+    /** Artwork for shell commands. */
+    readonly command: "run";
+    /** Artwork for file edits. */
+    readonly edit: "write";
+    /** Artwork for other tool calls. */
+    readonly other: "working";
+    /** Artwork for file reads. */
+    readonly read: "read";
+    /** Artwork for search results. */
+    readonly search: "search";
+};
+/** One changed or context line of a diff hunk. */
+export type ToolDiffLine = Readonly<{
+    /** Line role. */
+    kind: "add" | "context" | "remove";
+    /** Line text without its diff marker. */
+    text: string;
+}>;
+/** One hunk: a jsdiff hunk, or one `@@` block of a Codex patch. */
+export type ToolDiffHunk = Readonly<{
+    /** `-a,b +c,d` for computed hunks; the `@@` context for patch hunks. */
+    header?: string | undefined;
+    /** Hunk lines in order. */
+    lines: readonly ToolDiffLine[];
+}>;
+/** The hunks for one file. */
+export type ToolDiffFile = Readonly<{
+    /** File operation. */
+    operation: "add" | "delete" | "update";
+    /** File path, when known. */
+    path?: string | undefined;
+    /** Destination of a move. */
+    moveTo?: string | undefined;
+    /** Hunks in file order. */
+    hunks: readonly ToolDiffHunk[];
+    /**
+     * The same hunks as one unified patch, formatted by jsdiff, for renderers
+     * that draw unified diffs (OpenTUI's diff view).
+     */
+    unified: string;
+    /**
+     * Whether hunk line numbers are real. Codex patch hunks carry no numbers,
+     * so their unified form numbers each hunk from 1 and renderers hide them.
+     */
+    lineNumbers: boolean;
+}>;
+/**
+ * One display row of a diff, flattened once here so every renderer draws the
+ * same rows. File rows appear only when a call touches several files.
+ */
+export type ToolDiffRow = Readonly<{
+    /** Row role. */
+    kind: "add" | "context" | "file" | "hunk" | "remove";
+    /** Row text without a marker. */
+    text: string;
+}>;
+/** One file excerpt line; the number is present only when it is known. */
+export type ToolExcerptLine = Readonly<{
+    /** One-based line number in the file. */
+    number?: number | undefined;
+    /** Line text. */
+    text: string;
+}>;
+/** One search hit. */
+export type ToolMatch = Readonly<{
+    /** `path:line` of the hit. */
+    location: string;
+    /** Matched line text. */
+    text: string;
+}>;
+/** One line of command output, marked by the stream that produced it. */
+export type ToolOutputLine = Readonly<{
+    /** Producing stream. */
+    stream: "stderr" | "stdout";
+    /** Line text without ANSI sequences. */
+    text: string;
+}>;
+/**
+ * One typed section of an expanded call body. Sections hold complete bounded
+ * content; renderers show `preview` items and offer the rest.
+ */
+export type ToolCallSection = Readonly<{
+    /** File excerpt. */
+    kind: "excerpt";
+    /** Excerpt lines, in file order. */
+    lines: readonly ToolExcerptLine[];
+    /** Items shown before "more". */
+    preview: number;
+} | {
+    /** Search hits. */
+    kind: "matches";
+    /** Hits, in result order. */
+    matches: readonly ToolMatch[];
+    /** Items shown before "more". */
+    preview: number;
+} | {
+    /** Edit diff: structured files and their flattened display rows. */
+    kind: "diff";
+    /** Structured hunks per file. */
+    files: readonly ToolDiffFile[];
+    /** Flattened display rows for every file. */
+    lines: readonly ToolDiffRow[];
+    /** Items shown before "more". */
+    preview: number;
+} | {
+    /** The command line, drawn as `$ <command>`. */
+    kind: "command";
+    /** Text lines. */
+    lines: readonly string[];
+    /** Items shown before "more". */
+    preview: number;
+} | {
+    /** Script source. */
+    kind: "script";
+    /** Text lines. */
+    lines: readonly string[];
+    /** Items shown before "more". */
+    preview: number;
+} | {
+    /** Command output with stderr lines marked. */
+    kind: "output";
+    /** Output lines, stdout before stderr. */
+    lines: readonly ToolOutputLine[];
+    /** Items shown before "more". */
+    preview: number;
+} | {
+    /** Plain or JSON text with a human label, e.g. `Arguments`. */
+    kind: "text";
+    /** Human label, e.g. `Arguments`. */
+    label?: string | undefined;
+    /** Highlighting hint. */
+    language?: "json" | undefined;
+    /** Text lines. */
+    lines: readonly string[];
+    /** Items shown before "more". */
+    preview: number;
+}>;
+/** Renderer-neutral presentation of one tool call and its joined result. */
+export type ToolCallView = Readonly<{
+    /** Tool-call identity. */
+    id: string;
+    /** Typed tool kind. */
+    kind: ToolKind;
+    /** Pi tool name. */
+    name: string;
+    /** Past-tense verb for the finished call, e.g. `Read`. */
+    verb: string;
+    /** Present-tense verb for the running call, e.g. `Reading`. */
+    activeVerb: string;
+    /** Short one-line target: a path, command, pattern, or first code line. */
+    label: string;
+    /** Distinct file paths this call reads or edits, when known. */
+    paths: readonly string[];
+    /** Call activity. */
+    status: ToolItem["status"];
+    /** Milliseconds from the call to its result, when both are known. */
+    durationMs?: number | undefined;
+    /** A non-zero process exit code, for a header chip. */
+    exitCode?: number | undefined;
+    /** The failure message, shown before the body, for failed calls. */
+    error?: string | undefined;
+    /** Expanded body sections, in display order. */
+    sections: readonly ToolCallSection[];
+}>;
+/** Items shown before "more" for excerpts, matches, and output. */
+export declare const toolPreviewLineLimit = 12;
+/** Build the renderer-neutral view of one call. */
+export declare function toolCallView(item: ToolItem): ToolCallView;
+/** Compact duration: `340ms`, `1.2s`, `2m 5s`. */
+export declare function formatToolDuration(milliseconds: number): string;