@agentclientprotocol/claude-agent-acp 0.81.3-preview.1 → 0.81.3-preview.2

package/dist/tool-calls/renderer.d.ts

@@ -0,0 +1,216 @@
+import type { ClientCapabilities as AcpClientCapabilities, RequestPermissionRequest, SessionNotification, ToolCallContent, ToolCallLocation } from "@agentclientprotocol/sdk";
+import { ClientCapabilities } from "./client-capabilities.js";
+import type { ToolResultContext, ToolResultFacts, ToolUse, ToolUseFacts } from "./facts.js";
+export type ToolCallUpdate = SessionNotification["update"];
+/** The `_meta` of a tool call report. */
+export type ToolUpdateMeta = {
+    claudeCode?: {
+        toolName?: string;
+        toolResponse?: unknown;
+        parentToolUseId?: string;
+        nonExecutionKind?: string;
+        userFeedback?: string;
+        mcpServer?: {
+            name: string;
+            source: string;
+        };
+    };
+    jetbrains?: {
+        air?: {
+            version?: number;
+            commandTitle?: string;
+            subagent?: true;
+            skill?: {
+                name: string;
+                path?: string;
+            };
+            [key: string]: unknown;
+        };
+    };
+    is_mcp_tool_call?: true;
+    terminal_info?: {
+        terminal_id: string;
+    };
+    terminal_output?: {
+        terminal_id: string;
+        data: string;
+    };
+    terminal_output_delta?: {
+        terminal_id: string;
+        data: string;
+    };
+    terminal_exit?: {
+        terminal_id: string;
+        exit_code: number;
+        signal: string | null;
+    };
+};
+/** The result fields of a tool call report, before the status and the tool name. */
+export interface RenderedResult {
+    title?: string;
+    content?: ToolCallContent[];
+    locations?: ToolCallLocation[];
+    /** Present when the reporter decided the raw output. */
+    rawOutput?: unknown;
+    /** The plan file that `rawInput` names. See {@link ToolResultFacts.planFilePath}. */
+    planFilePath?: string;
+    /** See {@link ToolResultFacts.planFileReleased}. */
+    planFileReleased?: boolean;
+    _meta?: Pick<ToolUpdateMeta, "terminal_info" | "terminal_output" | "terminal_output_delta" | "terminal_exit">;
+}
+/** The SDK tool_result block that a result report reads. */
+type ResultBlock = ToolResultContext["result"];
+/**
+ * Turns tool facts into the fields of the standard ACP tool call report, as
+ * `docs/air-extensions.md#tool-call-contract` defines: each fact goes in one field.
+ *
+ * The {@link ToolReporter} of the tool reads the SDK data. The renderer
+ * decides the fields from the facts and the {@link ClientCapabilities}. The
+ * {@link ToolCallFieldTracker} runs after it and drops the fields that an
+ * earlier report of the same tool call already sent.
+ */
+export declare class AcpToolCallRenderer {
+    readonly capabilities: ClientCapabilities;
+    /** True when the renderer reports the history of a loaded session. */
+    readonly replay: boolean;
+    constructor(capabilities?: ClientCapabilities, 
+    /** True when the renderer reports the history of a loaded session. */
+    replay?: boolean);
+    static for(capabilities: AcpClientCapabilities | null | undefined, replay?: boolean): AcpToolCallRenderer;
+    /** The facts of a tool use. */
+    facts(toolUse: Pick<ToolUse, "name" | "input">, cwd?: string): ToolUseFacts;
+    /** The standard fields of a tool use: the title, the kind, the content, and the locations. */
+    toolInfo(toolUse: ToolUse, cwd?: string): {
+        title: string;
+        kind: ToolUseFacts["kind"];
+        content: ToolCallContent[];
+        locations?: ToolCallLocation[];
+    };
+    /**
+     * The first report of a tool call. `rawInput` is left out while the input
+     * still streams: the consolidated message sends it once it is complete.
+     */
+    toolCall(toolUse: ToolUse, options?: {
+        cwd?: string;
+        inputComplete?: boolean;
+        previewContent?: ToolCallContent[];
+    }): ToolCallUpdate;
+    /** The report of a tool call whose input is complete now. */
+    refinement(toolUse: ToolUse, cwd?: string): ToolCallUpdate;
+    /**
+     * The report of a tool call from the complete top-level fields of its still
+     * streaming input. It carries no content: content built from partial input
+     * is misleading (an Edit without its `new_string` renders as a deletion) or
+     * invalid. AIR gets no `rawInput`, which goes out once it is complete. Every
+     * other client gets the partial input as `rawInput`.
+     */
+    partialRefinement(toolUse: Pick<ToolUse, "id" | "name">, input: unknown, cwd?: string): {
+        locations?: ToolCallLocation[] | undefined;
+        title: string;
+        kind: import("@agentclientprotocol/sdk").ToolKind;
+        rawInput?: unknown;
+        _meta: ToolUpdateMeta;
+        toolCallId: string;
+        sessionUpdate: "tool_call_update";
+    };
+    /**
+     * The tool call of a permission request: `toolCallId`, `title`, and
+     * `rawInput`. The client already holds the rest. The request adds only what
+     * it shows new: an exact preview patch, and a location that the tool call
+     * does not have.
+     */
+    permissionToolCall(toolUse: ToolUse, options?: {
+        cwd?: string;
+        title?: string;
+        previewContent?: ToolCallContent[];
+        extraLocations?: ToolCallLocation[];
+        meta?: ToolUpdateMeta;
+        /** The content of a client that is not AIR, when the tool call has none. */
+        fallbackContent?: ToolCallContent[];
+    }): RequestPermissionRequest["toolCall"];
+    /** The facts of a tool result. */
+    resultFacts(toolUse: ToolUse, result: ResultBlock, structured?: unknown): ToolResultFacts;
+    /** The result fields of a tool result, before the status and the tool name. */
+    resultFields(toolUse: ToolUse, result: ResultBlock, structured?: unknown): RenderedResult;
+    /**
+     * The reports of a tool result. A command sends its output as a separate
+     * report first, like codex-acp: the output, then the exit and the status.
+     * The output travels once: the raw tool_result goes to `rawOutput` only
+     * when no other field carries the result.
+     */
+    result(toolUse: ToolUse, result: ResultBlock, options?: {
+        structured?: unknown;
+        nonExecution?: Record<string, unknown>;
+    }): ToolCallUpdate[];
+    /**
+     * Whether AIR shows [toolUse] as the list of viewed files: a read or a
+     * search with a path in its locations or in the `path` of its input.
+     */
+    private namesViewedFile;
+    /**
+     * The report of a PostToolUse hook: the final change of an edit tool, and
+     * the `status` and `isAsync` markers of the `tool_response`. The rest of the
+     * `tool_response` repeats output that the content already carries.
+     */
+    hookResult(toolUse: Pick<ToolUse, "id" | "name">, toolResponse: unknown, cwd?: string): Promise<ToolCallUpdate | undefined>;
+    /**
+     * The report of a memory recall: a completed read tool call. A synthesis
+     * shows the recalled text, a plain recall shows the memory files.
+     */
+    memoryRecall(recall: {
+        uuid: string;
+        mode: string;
+        memories: {
+            path: string;
+            content?: string;
+        }[];
+    }): ToolCallUpdate;
+    /**
+     * The report of a tool call that a rule, the classifier, or a mode denied
+     * before it ran. The reason is the result to show, so `toolResponse` keeps
+     * only the reason type, and the SDK message when it differs from the reason.
+     */
+    permissionDenied(denial: {
+        toolCallId: string;
+        toolName: string;
+        parentToolUseId?: string;
+        decisionReasonType?: string;
+        decisionReason?: string;
+        message?: string;
+    }): ToolCallUpdate;
+    /**
+     * The report of a tool progress beat. The field tracker sends the
+     * `in_progress` status once, so a later beat carries only the progress.
+     */
+    progress(beat: {
+        toolCallId: string;
+        toolName?: string;
+        parentToolUseId?: string;
+        elapsedTimeSeconds: number;
+        subagentType?: string;
+        subagentRetry?: unknown;
+    }): ToolCallUpdate;
+    /**
+     * `rawInput`. For AIR, without the file text that a diff holds, and with
+     * the path of the plan file in place of the plan text.
+     */
+    rawInput(facts: ToolUseFacts, rawInput: unknown): unknown;
+    /**
+     * The content of a tool use. A command shows the terminal marker. An edit
+     * shows its change. A display copy of the input goes only to a client that
+     * does not render `rawInput` itself, and never next to a terminal.
+     */
+    toolUseContent(toolCallId: string, facts: ToolUseFacts): ToolCallContent[];
+    /**
+     * The `_meta` of a tool use report: the tool name, and for AIR the tool
+     * flags under `_meta.jetbrains.air`. A shell description stays out of the
+     * standard `title`, which clients use as the command preview. Every other
+     * client gets only the upstream tool name.
+     */
+    toolUseMeta(toolUse: {
+        name: string;
+        input?: unknown;
+    }, cwd?: string): ToolUpdateMeta;
+}
+export {};
+//# sourceMappingURL=renderer.d.ts.map

package/dist/tool-calls/renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/tool-calls/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,IAAI,qBAAqB,EAC3C,wBAAwB,EACxB,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EACjB,MAAM,0BAA0B,CAAC;AAQlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI5F,MAAM,MAAM,cAAc,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAK3D,yCAAyC;AACzC,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE;QAIX,QAAQ,CAAC,EAAE,MAAM,CAAC;QAIlB,YAAY,CAAC,EAAE,OAAO,CAAC;QAIvB,eAAe,CAAC,EAAE,MAAM,CAAC;QAMzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAG1B,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,SAAS,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;KAC9C,CAAC;IAEF,SAAS,CAAC,EAAE;QACV,GAAG,CAAC,EAAE;YACJ,OAAO,CAAC,EAAE,MAAM,CAAC;YAGjB,YAAY,CAAC,EAAE,MAAM,CAAC;YAGtB,QAAQ,CAAC,EAAE,IAAI,CAAC;YAGhB,KAAK,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,IAAI,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;YACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;KACH,CAAC;IAEF,gBAAgB,CAAC,EAAE,IAAI,CAAC;IAExB,aAAa,CAAC,EAAE;QACd,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,eAAe,CAAC,EAAE;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,qBAAqB,CAAC,EAAE;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,aAAa,CAAC,EAAE;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB,CAAC;CACH,CAAC;AAEF,oFAAoF;AACpF,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B,wDAAwD;IACxD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,qFAAqF;IACrF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,KAAK,CAAC,EAAE,IAAI,CACV,cAAc,EACd,eAAe,GAAG,iBAAiB,GAAG,uBAAuB,GAAG,eAAe,CAChF,CAAC;CACH;AAED,4DAA4D;AAC5D,KAAK,WAAW,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAE/C;;;;;;;;GAQG;AACH,qBAAa,mBAAmB;IAE5B,QAAQ,CAAC,YAAY,EAAE,kBAAkB;IACzC,sEAAsE;IACtE,QAAQ,CAAC,MAAM;gBAFN,YAAY,GAAE,kBAA6C;IACpE,sEAAsE;IAC7D,MAAM,UAAQ;IAGzB,MAAM,CAAC,GAAG,CACR,YAAY,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,EACtD,MAAM,UAAQ,GACb,mBAAmB;IAItB,+BAA+B;IAC/B,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,YAAY;IAQ3E,8FAA8F;IAC9F,QAAQ,CACN,OAAO,EAAE,OAAO,EAChB,GAAG,CAAC,EAAE,MAAM,GACX;QACD,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,EAAE,eAAe,EAAE,CAAC;QAC3B,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;KAChC;IAUD;;;OAGG;IACH,QAAQ,CACN,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,eAAe,EAAE,CAAA;KAAO,GAC1F,cAAc;IA4BjB,6DAA6D;IAC7D,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,cAAc;IAc1D;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM;;;;;;;;;IAarF;;;;;OAKG;IACH,kBAAkB,CAChB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE;QACP,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,cAAc,CAAC,EAAE,eAAe,EAAE,CAAC;QACnC,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;QACpC,IAAI,CAAC,EAAE,cAAc,CAAC;QACtB,4EAA4E;QAC5E,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;KAChC,GACL,wBAAwB,CAAC,UAAU,CAAC;IA+BvC,kCAAkC;IAClC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,eAAe;IAqBzF,+EAA+E;IAC/E,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,cAAc;IA6CzF;;;;;OAKG;IACH,MAAM,CACJ,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAO,GAC7E,cAAc,EAAE;IAuEnB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAQvB;;;;OAIG;IACG,UAAU,CACd,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,CAAC,EACrC,YAAY,EAAE,OAAO,EACrB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IA4BtC;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;KAChD,GAAG,cAAc;IAyBlB;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,EAAE;QACvB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,cAAc;IA0BlB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,GAAG,cAAc;IAsBlB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO;IAgBzD;;;;OAIG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,eAAe,EAAE;IAS1E;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,cAAc;CA0BtF"}