@linxiraos/pi-agent-core 1.1.9 → 1.1.10

package/dist/types/types.d.ts

@@ -0,0 +1,815 @@
+import type { ApiKey, AssistantMessage, AssistantMessageEvent, AssistantMessageEventStream, Context, Effort, ImageContent, Message, Model, ServiceTier, SimpleStreamOptions, Static, streamSimple, TextContent, Tool, ToolCallProviderMetadata, ToolChoice, ToolResultMessage, ToolResultProviderMetadata, TSchema } from "@linxiraos/pi-ai";
+import type { Dialect } from "@linxiraos/pi-ai/dialect";
+import type { HarmonyAuditEvent } from "@linxiraos/pi-ai/utils/harmony-leak";
+import type { AppendOnlyContextManager } from "./append-only-context.js";
+import type { AgentRunCoverage, AgentRunSummary } from "./run-collector.js";
+import type { AgentTelemetryConfig } from "./telemetry.js";
+/** Stream function - can return sync or Promise for async config lookup */
+export type StreamFn = (...args: Parameters<typeof streamSimple>) => AssistantMessageEventStream | Promise<AssistantMessageEventStream>;
+/** Called once an aside has been inserted into the agent's live context. */
+export declare const ASIDE_MESSAGE_COMMIT: unique symbol;
+/** Called when an aside was drained but the agent loop ended before inserting it. */
+export declare const ASIDE_MESSAGE_DISCARD: unique symbol;
+export type CommittableAsideMessage = AgentMessage & {
+    [ASIDE_MESSAGE_COMMIT]?: () => void;
+    [ASIDE_MESSAGE_DISCARD]?: (error: Error) => void;
+};
+/**
+ * An aside entry: a ready {@link AgentMessage}, or a sync thunk evaluated at
+ * injection time that returns the message to inject or `null` to skip it. Thunks
+ * let the producer make the final inject-or-drop decision against current state
+ * (e.g. dropping late diagnostics a newer edit superseded).
+ */
+export type AsideMessage = CommittableAsideMessage | (() => CommittableAsideMessage | null);
+export interface AgentTurnEndContext {
+    /** Assistant/user message that just completed this turn boundary. */
+    message: AgentMessage;
+    /** Tool results produced by this turn, already paired with `message` in the live context. */
+    toolResults: ToolResultMessage[];
+    /** True when the current tool-loop batch is continuing without yielding to post-turn steering. */
+    willContinue: boolean;
+}
+export interface AgentPreModelCallStop {
+    /** Stop the agent loop before sending the next provider request. */
+    stop: true;
+    /** Optional owner-facing reason, logged by the loop when it stops. */
+    reason?: string;
+}
+export type AgentPreModelCallResult = AgentPreModelCallStop | undefined;
+/**
+ * A pre-model-call gate. Return {@link AgentPreModelCallStop} to refuse the
+ * request, or nothing to proceed; the signal aborts with the run.
+ */
+export type AgentBeforeModelCall = (context: Context, signal?: AbortSignal) => AgentPreModelCallResult | void | Promise<AgentPreModelCallResult | void>;
+/**
+ * A soft tool requirement: the host wants `toolName` called before the loop
+ * runs other tools or yields, but WITHOUT paying the forced-`toolChoice` cost
+ * up front (changing `tool_choice` invalidates the provider message cache).
+ * Returned from {@link AgentLoopConfig.getToolChoice} in place of a hard
+ * {@link ToolChoice}: the loop injects `reminder` once when a new `id` becomes
+ * active, runs with `toolChoice` unchanged, and escalates to a one-turn forced
+ * choice only if the model fails to call `toolName`. Auto-clears when the host
+ * stops returning it or `toolName` is no longer an active tool.
+ */
+export interface SoftToolRequirement {
+    /** Discriminates a soft requirement from a hard {@link ToolChoice}. */
+    soft: true;
+    /**
+     * Stable id of the *current* requirement. The loop injects `reminder` when
+     * this id first becomes active and again whenever it changes (e.g. one
+     * stacked preview resolves and the next becomes the head), but never
+     * re-injects for an unchanged id across turns.
+     */
+    id: string;
+    /** Tool that must be called before the loop runs other tools or yields. */
+    toolName: string;
+    /**
+     * Per-call compliance check: a turn satisfies the requirement only when every
+     * tool call passes. Defaults to `name === toolName`. Lets a host demand a
+     * specific invocation shape (e.g. `write` targeting a virtual device path)
+     * instead of any call to `toolName`. Escalation still forces `toolName`.
+     */
+    satisfies?(toolCall: {
+        name: string;
+        arguments?: Record<string, unknown>;
+    }): boolean;
+    /** Host-owned reminder messages, injected once per `id` activation. */
+    reminder: AgentMessage[];
+}
+/**
+ * A per-turn tool-choice directive: either a hard provider {@link ToolChoice}
+ * (applied verbatim) or a {@link SoftToolRequirement} (remind-then-escalate).
+ */
+export type ToolChoiceDirective = ToolChoice | SoftToolRequirement;
+/** Mutable soft-requirement lifecycle retained across stopped agent runs. */
+export interface SoftToolRequirementState {
+    id?: string;
+    forcedToolChoice?: ToolChoice;
+    escalations: number;
+}
+/** True when a {@link ToolChoiceDirective} is a soft requirement, not a hard choice. */
+export declare function isSoftToolRequirement(directive: ToolChoiceDirective | undefined): directive is SoftToolRequirement;
+/**
+ * Source category for a queued steering interrupt observed without consuming the queue.
+ * Distinguishes real-user, agent-authored, system/advisor, and unknown steering.
+ */
+export type SteeringInterruptSource = "user" | "agent" | "system" | "unknown";
+/** Non-consuming summary of whether queued steering should interrupt a tool batch. */
+export interface SteeringQueueState {
+    /** True when at least one steering message is queued. */
+    queued: boolean;
+    /** Best-effort origin used only to word synthetic skipped-tool results. */
+    source?: SteeringInterruptSource;
+}
+/**
+ * Configuration for the agent loop.
+ */
+export interface AgentLoopConfig extends SimpleStreamOptions {
+    model: Model;
+    /**
+     * When to interrupt tool execution for steering messages.
+     * - "immediate" = check after each tool call (default)
+     * - "wait" = defer steering until the current turn completes
+     */
+    interruptMode?: "immediate" | "wait";
+    /**
+     * Optional session identifier forwarded to LLM providers.
+     * Used by providers that support session-based caching (e.g., OpenAI Codex).
+     */
+    sessionId?: string;
+    /** Absolute wall-clock deadline in Unix epoch milliseconds. */
+    deadline?: number;
+    /**
+     * Optional resolver called per LLM request to produce request metadata.
+     * When set, the agent loop evaluates it **after** `getApiKey` resolves the
+     * session-sticky credential, ensuring the metadata's `account_uuid` reflects
+     * the credential actually used for the request (not the credential that was
+     * current when `AgentLoopConfig` was first constructed). Overrides the static
+     * `metadata` field when present.
+     */
+    metadataResolver?: (provider: string) => Record<string, unknown> | undefined;
+    /**
+     * Converts AgentMessage[] to LLM-compatible Message[] before each LLM call.
+     *
+     * Each AgentMessage must be converted to a UserMessage, AssistantMessage, or ToolResultMessage
+     * that the LLM can understand. AgentMessages that cannot be converted (e.g., UI-only notifications,
+     * status messages) should be filtered out.
+     *
+     * @example
+     * ```typescript
+     * convertToLlm: (messages) => messages.flatMap(m => {
+     *   if (m.role === "custom") {
+     *     // Convert custom message to user message
+     *     return [{ role: "user", content: m.content, timestamp: m.timestamp }];
+     *   }
+     *   if (m.role === "notification") {
+     *     // Filter out UI-only messages
+     *     return [];
+     *   }
+     *   // Pass through standard LLM messages
+     *   return [m];
+     * })
+     * ```
+     */
+    convertToLlm: (messages: AgentMessage[]) => Message[] | Promise<Message[]>;
+    /**
+     * Optional transform applied to the context before `convertToLlm`.
+     *
+     * Use this for operations that work at the AgentMessage level:
+     * - Context window management (pruning old messages)
+     * - Injecting context from external sources
+     *
+     * @example
+     * ```typescript
+     * transformContext: async (messages) => {
+     *   if (agent.tokenizer.countMessages(messages) > MAX_TOKENS) {
+     *     return pruneOldMessages(messages);
+     *   }
+     *   return messages;
+     * }
+     * ```
+     */
+    transformContext?: (messages: AgentMessage[], signal?: AbortSignal) => Promise<AgentMessage[]>;
+    /**
+     * Optional transform applied to the final provider context after conversion,
+     * normalization, and append-only context handling, but before telemetry capture
+     * and provider send.
+     */
+    transformProviderContext?: (context: Context, model: Model) => Context | Promise<Context>;
+    /**
+     * Resolves the API key or resolver for the current model before each LLM call.
+     *
+     * Returning an ApiKeyResolver lets the stream retry policy refresh or rotate
+     * the model-scoped credential after auth/usage-limit errors.
+     */
+    getApiKey?: (model: Model) => Promise<ApiKey | undefined> | ApiKey | undefined;
+    /**
+     * Returns steering messages to inject into the conversation mid-run.
+     *
+     * Called at injection boundaries only (loop start and after a tool batch
+     * fully settles), so dequeued messages are immediately injected. The
+     * mid-batch interrupt poll uses {@link hasSteeringMessages} instead and
+     * never consumes the queue.
+     */
+    getSteeringMessages?: (signal?: AbortSignal) => Promise<AgentMessage[]>;
+    /**
+     * Peeks whether steering messages are queued, without consuming them.
+     *
+     * Polled while a tool batch runs (unless interruptMode is "wait") to decide
+     * whether to abort in-flight and skip not-yet-started *interruptible* waits;
+     * every other already-emitted call still executes and the message injects
+     * at the batch boundary. The queue keeps
+     * owning its messages until the loop reaches the next injection boundary and
+     * dequeues via {@link getSteeringMessages} — so callers can still cancel or
+     * restore queued messages while in-flight tools settle, and an external
+     * abort in that window leaves the queue intact for a post-abort continue.
+     *
+     * Returning `true` is treated as user-originated steering for compatibility.
+     * Return a {@link SteeringQueueState} when the queue can distinguish system
+     * advisories from real user messages.
+     *
+     * When omitted, steering never interrupts a running tool batch; queued
+     * messages are still delivered at the next injection boundary.
+     */
+    hasSteeringMessages?: () => boolean | SteeringQueueState | Promise<boolean | SteeringQueueState>;
+    /**
+     * Wakes the in-flight tool interrupt watcher when a steering message is queued.
+     * The callback must not consume the queue; the loop still calls
+     * {@link hasSteeringMessages} before aborting and injects through
+     * {@link getSteeringMessages}.
+     */
+    waitForSteeringMessages?: (signal?: AbortSignal) => Promise<void>;
+    /**
+     * Peeks whether IRC messages should interrupt an interruptible waiting tool.
+     *
+     * Uses the same delivery rules as steering: the poll is non-consuming, only
+     * runs for interruptible tools, and is ignored when interruptMode is "wait".
+     * The host owns message injection at the next boundary.
+     */
+    hasIrcInterrupts?: () => boolean | Promise<boolean>;
+    /**
+     * Returns follow-up messages to process after the agent would otherwise stop.
+     *
+     * Called when the agent has no more tool calls and no steering messages.
+     * If messages are returned, they're added to the context and the agent
+     * continues with another turn.
+     */
+    getFollowUpMessages?: (signal?: AbortSignal) => Promise<AgentMessage[]>;
+    /**
+     * Returns non-interrupting "aside" messages to inject at a step boundary.
+     *
+     * Polled after each tool batch (before the next LLM call) AND at the yield
+     * check. Unlike steering, these NEVER abort in-flight tools — they are passive
+     * notifications (e.g. background-job completions, late LSP diagnostics) that
+     * should reach the model between requests without waiting for the agent to
+     * fully stop. Returned messages are appended to the context with normal
+     * message events and keep the loop running so the model can react.
+     */
+    getAsideMessages?: () => Promise<AsideMessage[]>;
+    /**
+     * Hook fired right before the loop would exit.
+     *
+     * Called when the agent has no more tool calls and no steering messages,
+     * immediately before polling follow-up messages.
+     */
+    onBeforeYield?: () => Promise<void> | void;
+    /**
+     * Provides tool execution context, resolved per tool call.
+     * Use for late-bound UI or session state access.
+     */
+    getToolContext?: (toolCall?: ToolCallContext) => AgentToolContext | undefined;
+    /**
+     * Refreshes prompt/tool context from live session state before each model call.
+     * Use this when tool availability or the system prompt can change mid-turn.
+     *
+     * Runs after pending messages are folded in and before provider conversion.
+     * Mutate the agent context here; use `beforeModelCall` to inspect the
+     * provider-bound context.
+     */
+    syncContextBeforeModelCall?: (context: AgentContext, signal?: AbortSignal) => void | Promise<void>;
+    /**
+     * Asked after the complete provider context has been built, including
+     * message conversion, provider transforms, normalized tools, and owned
+     * dialect prompt injection. Returning {@link AgentPreModelCallStop} ends
+     * the stream without emitting `turn_start`, so no turn is left open and no
+     * request is billed. Return nothing to proceed. The signal aborts when
+     * the run is canceled or its deadline expires.
+     */
+    beforeModelCall?: AgentBeforeModelCall;
+    /**
+     * Optional transform applied to tool call arguments before execution.
+     * Use for deobfuscating secrets or rewriting arguments.
+     */
+    transformToolCallArguments?: (args: Record<string, unknown>, toolName: string) => Record<string, unknown>;
+    /**
+     * Resolve a tool call whose name matched no advertised tool (including
+     * `customWireName` aliases). Lets hosts route calls to tools they expose
+     * through side transports (e.g. `xd://` device mounts) instead of failing
+     * with "Tool not found". Returning `undefined` keeps the failure.
+     */
+    resolveFallbackTool?: (name: string) => AgentTool<any> | undefined;
+    /**
+     * Enable intent tracing for tool calls.
+     * When enabled, the harness injects a `string` field into tool schemas sent to the model,
+     * then strips from arguments before executing tools.
+     */
+    intentTracing?: boolean;
+    /**
+     * Strip tool descriptions (top-level + nested schema annotations) from the
+     * provider-bound tool specs. Use when the full catalog is rendered into the
+     * system prompt instead, so descriptions are not duplicated on the wire.
+     */
+    pruneToolDescriptions?: boolean;
+    /**
+     * Owned tool calling dialect.
+     *
+     * Undefined keeps provider-native tool calling. A dialect value sends no
+     * native `tools`, forces `toolChoice` off, appends that dialect's tool catalog
+     * instructions, re-encodes prior tool calls/results as text, and parses the
+     * model's text output back into canonical `toolCall` blocks.
+     */
+    dialect?: Dialect;
+    /**
+     * When owned (in-band) tool calling is active and the model starts
+     * fabricating a tool result inside its own turn, control how the loop reacts:
+     * - `true` (default): abort the provider request immediately so it stops
+     *   generating the hallucinated continuation (cheaper, lower latency).
+     * - `false`: let the request finish and silently discard everything past the
+     *   fabrication boundary (keeps the connection alive but pays for the tokens
+     *   the model spends on the discarded tail).
+     * Only meaningful when {@link dialect} (or `PI_DIALECT`) selects an
+     * owned dialect; native tool calling never fabricates results in text.
+     */
+    abortOnFabricatedToolResult?: boolean;
+    /**
+     * Append-only context mode — stabilizes system prompt + tool spec bytes
+     * across turns so provider prefix caches hit at maximum rate.
+     *
+     * When set, the loop reads messages from the append-only log (stable
+     * byte prefix) and caches system prompt + tools. Tools exclude per-turn
+     * `i` intent fields.
+     */
+    appendOnlyContext?: AppendOnlyContextManager;
+    /**
+     * Inspect assistant streaming events before they are published to the outer agent event stream.
+     * Callers may abort synchronously to stop consuming buffered provider events.
+     */
+    onAssistantMessageEvent?: (message: AssistantMessage, event: AssistantMessageEvent) => void;
+    /**
+     * Called when GPT-5 Harmony protocol leakage is detected and mitigated.
+     */
+    onHarmonyLeak?: (event: HarmonyAuditEvent) => void | Promise<void>;
+    /**
+     * Dynamic tool-choice directive, resolved once per turn. Returns a hard
+     * {@link ToolChoice} (applied verbatim, overriding the static `toolChoice`),
+     * a {@link SoftToolRequirement} (the loop reminds-then-escalates instead of
+     * forcing `tool_choice` immediately, so a model that complies with the
+     * reminder pays no message-cache invalidation), or `undefined` to fall back
+     * to the static `toolChoice`.
+     */
+    getToolChoice?: () => ToolChoiceDirective | undefined;
+    /**
+     * Soft-requirement lifecycle retained by the host when a pre-model-call
+     * gate stops a run before its pending reminder or escalation is served.
+     */
+    softToolRequirementState?: SoftToolRequirementState;
+    /**
+     * Notifies the host that the pre-model-call gate stopped the run after a
+     * hard tool choice was obtained from {@link getToolChoice} but before it
+     * was served, so the host can retain it for the next admitted request.
+     */
+    onToolChoiceRejected?: () => void;
+    /**
+     * Dynamic reasoning effort override, resolved per LLM call.
+     * When set and returns a value, overrides the static `reasoning` captured
+     * at run-loop start. Use this so mid-run thinking-level changes apply on
+     * the next model call instead of waiting for the next prompt.
+     */
+    getReasoning?: () => Effort | undefined;
+    /**
+     * Dynamic model override, resolved once per LLM call. When set, each
+     * provider call re-reads the model (like {@link getReasoning}) so mid-run
+     * model switches — context promotion, retry fallback — apply on the next
+     * call instead of the run finishing on the stale model captured at
+     * run-loop start. Falls back to the static {@link model} when unset.
+     */
+    getModel?: () => Model;
+    /**
+     * Dynamic reasoning-disable override, resolved per LLM call. When set,
+     * its return value overrides the static `disableReasoning` from
+     * `SimpleStreamOptions` for that request. Pair with `getReasoning` so
+     * mid-run transitions into and out of the explicit `off` state propagate
+     * to the next provider call.
+     */
+    getDisableReasoning?: () => boolean | undefined;
+    /**
+     * Per-call effective service-tier resolver. Unlike {@link getReasoning},
+     * this is *authoritative*: when set, its return value (including
+     * `undefined`) fully replaces the static `serviceTier` for the request and
+     * its telemetry. The resolver receives the model being requested so the
+     * caller can scope the tier per provider/model without mutating the shared
+     * session `serviceTier` (e.g. opting a Fireworks model into the Priority
+     * serving path while leaving the OpenAI/Anthropic tier untouched).
+     */
+    getServiceTier?: (model: Model) => ServiceTier | undefined;
+    /**
+     * Per-call working-directory resolver, read once per LLM call. When set, its
+     * return value overrides the static {@link SimpleStreamOptions.cwd} for the
+     * request (falling back to that static `cwd` when it returns `undefined`).
+     * Lets the host reflect a session move (`/move`, which updates the working
+     * directory without reconstructing the loop config) into provider options —
+     * e.g. GitLab Duo Agent namespace/project discovery keys off this cwd's git
+     * remote, so a stale value would strand discovery on the original repo.
+     */
+    getCwd?: () => string | undefined;
+    /**
+     * Called once per tool call after argument validation, in call order, before
+     * the call is scheduled — ahead of concurrency resolution,
+     * `tool_execution_start`, and `tool.execute`. On the streamed path it runs
+     * before the assistant message's `message_start`/`message_end` are emitted.
+     *
+     * Return `{ block: true }` to prevent execution. The loop emits an error tool
+     * result instead (using `reason` as the error text, or a default if omitted).
+     *
+     * Return `{ args }` to replace the arguments the call runs with. The
+     * replacement is revalidated against the tool schema and written back to the
+     * tool-call block, making it the single source of truth: history, execution
+     * events, persistence, provider replay, concurrency scheduling, and
+     * `tool.execute` all see the revised arguments. Mutating `context.args` in
+     * place also survives into execution, but a returned `args` object wins.
+     *
+     * The hook receives the run's request abort signal and is responsible for
+     * honoring it. Throwing surfaces as a tool-error result and does not abort the
+     * rest of the batch.
+     */
+    beforeToolCall?: (context: BeforeToolCallContext, signal?: AbortSignal) => Promise<BeforeToolCallResult | undefined> | BeforeToolCallResult | undefined;
+    /**
+     * Called after a turn ends and before the loop polls steering/asides for the
+     * next iteration. `context` carries the just-finished turn; `context.willContinue`
+     * is true when the current tool-loop batch is continuing without yielding to
+     * post-turn steering.
+     */
+    onTurnEnd?: (messages: AgentMessage[], signal?: AbortSignal, context?: AgentTurnEndContext) => Promise<void> | void;
+    /**
+     * Called once an assistant message is finalized from the model stream, before
+     * it is appended to the context, emitted as `message_end`, or its tool calls
+     * are validated and dispatched. The hook may mutate the message in place —
+     * both its text content and its tool-call arguments — and those edits are seen
+     * by the transcript, the UI, and tool execution alike (single source of truth).
+     *
+     * Used for inline macro expansion: rewriting `@[[runtime.name(args)]]` tokens
+     * to host-computed values before anything downstream consumes the message.
+     * Runs at most once per assistant message; must not throw (a throw would abort
+     * the turn).
+     */
+    transformAssistantMessage?: (message: AssistantMessage, signal?: AbortSignal) => Promise<void> | void;
+    /**
+     * Called after a tool finishes executing, before `tool_execution_end` and the
+     * tool-result message are emitted.
+     *
+     * Return an `AfterToolCallResult` to override individual fields of the executed
+     * tool result. Omitted fields keep their original values; there is no deep merge.
+     *
+     * Throwing surfaces as a tool-error result and does not abort the rest of the batch.
+     */
+    afterToolCall?: (context: AfterToolCallContext, signal?: AbortSignal) => Promise<AfterToolCallResult | undefined> | AfterToolCallResult | undefined;
+    /**
+     * Opt-in OpenTelemetry instrumentation. Passing `{}` enables the loop's
+     * GenAI-semantic-convention spans (`invoke_agent`, `chat`, `execute_tool`)
+     * using the global tracer provider. Leaving this field undefined disables
+     * the instrumentation entirely — the loop performs zero tracer lookups.
+     *
+     * See {@link AgentTelemetryConfig} for the full surface (hooks, content
+     * capture, cost estimator, agent identity).
+     */
+    telemetry?: AgentTelemetryConfig;
+}
+/**
+ * Batch/sequencing metadata for the tool call currently being processed.
+ */
+export interface ToolCallContext {
+    batchId: string;
+    index: number;
+    total: number;
+    toolCalls: Array<{
+        id: string;
+        name: string;
+    }>;
+    /** Provider-native metadata for the current call, when present. */
+    providerMetadata?: ToolCallProviderMetadata;
+    /**
+     * Cooperative steering signal: aborted when a queued user/steering message
+     * (or an interrupting peer IRC) is detected while this tool batch runs.
+     * Unlike the hard abort signal it NEVER kills the tool — long-running
+     * tools MAY observe it (via `ctx.toolCall.steeringSignal`) to finish early
+     * or background themselves so the message injects promptly; ignoring it is
+     * always safe (the message injects at the next batch boundary).
+     */
+    steeringSignal?: AbortSignal;
+}
+/** A single tool-call content block emitted by an assistant message. */
+export type AgentToolCall = Extract<AssistantMessage["content"][number], {
+    type: "toolCall";
+}>;
+/**
+ * Result returned from `beforeToolCall`.
+ *
+ * Set `block: true` to prevent the tool from executing. The loop emits an error tool
+ * result instead, using `reason` as the error text (or a default if omitted).
+ *
+ * Set `args` to replace the tool-call arguments. The replacement is revalidated
+ * against the tool schema (a failure surfaces as a validation-error tool result),
+ * written back to the tool-call block on the assistant message, and seen by
+ * history, scheduling, execution events, and `tool.execute` alike. It is
+ * ignored when `block` is true.
+ */
+export interface BeforeToolCallResult {
+    block?: boolean;
+    reason?: string;
+    args?: Record<string, unknown>;
+}
+/**
+ * Partial override returned from `afterToolCall`.
+ *
+ * Merge semantics are field-by-field; omitted fields keep the executed values.
+ * No deep merge is performed.
+ */
+export interface AfterToolCallResult {
+    /** If provided, replaces the tool result content array in full. */
+    content?: (TextContent | ImageContent)[];
+    /** If provided, replaces the tool result details payload in full. */
+    details?: unknown;
+    /** If provided, replaces the provider-native result metadata in full. */
+    providerMetadata?: ToolResultProviderMetadata;
+    /** If provided, replaces the error flag carried with the tool result. */
+    isError?: boolean;
+    /** If provided, replaces the contextually-useless flag carried with the tool result. */
+    useless?: boolean;
+}
+/** Context passed to `beforeToolCall`. */
+export interface BeforeToolCallContext {
+    /** The assistant message that requested the tool call. */
+    assistantMessage: AssistantMessage;
+    /** The raw tool call block from `assistantMessage.content`. */
+    toolCall: AgentToolCall;
+    /** The resolved tool the call dispatches to. */
+    tool: AgentTool<any>;
+    /**
+     * Validated tool arguments. The same reference is forwarded to `tool.execute`
+     * (after any `transformToolCallArguments` pass), so in-place mutations stick;
+     * a returned `BeforeToolCallResult.args` replaces them entirely.
+     */
+    args: Record<string, unknown>;
+    /** Current agent context at the time the tool call is prepared. */
+    context: AgentContext;
+}
+/** Context passed to `afterToolCall`. */
+export interface AfterToolCallContext {
+    /** The assistant message that requested the tool call. */
+    assistantMessage: AssistantMessage;
+    /** The raw tool call block from `assistantMessage.content`. */
+    toolCall: AgentToolCall;
+    /** Validated tool arguments used for execution (post `beforeToolCall` mutations). */
+    args: Record<string, unknown>;
+    /** The executed tool result before any `afterToolCall` overrides are applied. */
+    result: AgentToolResult<any>;
+    /** Whether the executed tool result is currently treated as an error. */
+    isError: boolean;
+    /** Current agent context at the time the tool call is finalized. */
+    context: AgentContext;
+}
+/**
+ * Extensible interface for custom app messages.
+ * Apps can extend via declaration merging:
+ *
+ * @example
+ * ```typescript
+ * declare module "@linxiraos/pi-agent-core" {
+ *   interface CustomAgentMessages {
+ *     artifact: ArtifactMessage;
+ *     notification: NotificationMessage;
+ *   }
+ * }
+ * ```
+ */
+export interface CustomAgentMessages {
+}
+/**
+ * AgentMessage: Union of LLM messages + custom messages.
+ * This abstraction allows apps to add custom message types while maintaining
+ * type safety and compatibility with the base LLM messages.
+ */
+export type AgentMessage = Message | CustomAgentMessages[keyof CustomAgentMessages];
+/**
+ * Agent state containing all configuration and conversation data.
+ */
+export interface AgentState {
+    systemPrompt: string[];
+    model: Model;
+    thinkingLevel?: Effort;
+    disableReasoning?: boolean;
+    tools: AgentTool<any>[];
+    messages: AgentMessage[];
+    isStreaming: boolean;
+    streamMessage: AgentMessage | null;
+    pendingToolCalls: Set<string>;
+    error?: string;
+}
+export interface AgentToolResult<T = any, _TInput = unknown> {
+    content: (TextContent | ImageContent)[];
+    details?: T;
+    isError?: boolean;
+    /** Provider-native metadata that must survive into history replay unchanged. */
+    providerMetadata?: ToolResultProviderMetadata;
+    /** Marks the result as contextually useless: safe for compaction to elide once consumed (e.g. zero matches, wait timeout). Ignored when isError is set. */
+    useless?: boolean;
+}
+export type AgentToolUpdateCallback<T = any, TInput = unknown> = (partialResult: AgentToolResult<T, TInput>) => void;
+/** Options passed to renderResult */
+export interface RenderResultOptions {
+    /** Whether the result view is expanded */
+    expanded: boolean;
+    /** Whether this is a partial/streaming result */
+    isPartial: boolean;
+    /** Current spinner frame index for animated elements (optional) */
+    spinnerFrame?: number;
+}
+/** Capability tier a tool exercises. Determines which approval modes auto-approve it. */
+export type ToolTier = "read" | "write" | "exec";
+/**
+ * How an enabled tool is presented to the model. `"essential"` tools are exposed
+ * as normal top-level tools. `"discoverable"` tools are removed from the top-level
+ * schema and either mounted under `xd://` device URLs (when that transport is
+ * active) or surfaced through BM25 tool search — keeping their schemas off every
+ * request. Selection (settings, `hidden`, `defaultInactive`, explicit `--tools`,
+ * provider availability) decides whether a tool is enabled; `loadMode` only
+ * decides how an enabled tool is presented.
+ */
+export type ToolLoadMode = "essential" | "discoverable";
+/**
+ * Per-tool approval declaration.
+ * - bare tier ("read" / "write" / "exec") — static classification.
+ * - object form — adds a `reason` (shown in the prompt) and/or `override: true`
+ *   (force-prompt even in modes that would otherwise auto-approve this tier).
+ *   `policy: "deny"` blocks the call at the approval gate.
+ * - function — dynamic, given parsed args. Returns either form above.
+ *
+ * Omitted approvals are treated as "exec" by callers that enforce approvals.
+ */
+export type ToolApprovalDecision = ToolTier | {
+    tier: ToolTier;
+    reason?: string;
+    override?: boolean;
+    policy?: "allow" | "deny" | "prompt";
+    /** User-policy key for this decision. When set, `tools.approval.<policyKey>`
+     *  is consulted instead of `tools.approval.<tool.name>`. Lets a dispatcher
+     *  tool (e.g. `write` for an `xd://` device call) scope user allow/deny/
+     *  prompt policies to the tool it dispatches into. */
+    policyKey?: string;
+};
+export type ToolApproval = ToolApprovalDecision | ((args: unknown) => ToolApprovalDecision);
+/**
+ * Context passed to tool execution.
+ * Apps can extend via declaration merging.
+ */
+export interface AgentToolContext {
+}
+export type AgentToolExecFn<TParameters extends TSchema = TSchema, TDetails = any, TTheme = unknown> = (this: AgentTool<TParameters, TDetails, TTheme>, toolCallId: string, params: Static<TParameters>, signal?: AbortSignal, onUpdate?: AgentToolUpdateCallback<TDetails, TParameters>, context?: AgentToolContext) => Promise<AgentToolResult<TDetails, TParameters>>;
+/** Live receiver for a tool call's streamed arguments (see AgentTool.openArgStream). */
+export interface AgentToolArgStream {
+    /** Raw wire fragment of the arguments (JSON text, or verbatim payload for custom-format tools). */
+    push(delta: string): void;
+    /** Arguments are complete; `args` is the final parsed object the loop will pass to `execute`. */
+    end(args: unknown): void;
+    /** The call will never execute (stream error, abort, blocked). Release resources. */
+    cancel(): void;
+}
+export interface AgentToolArgStreamInit {
+    toolCallId: string;
+    toolName: string;
+    /** Wire-level name for custom-format tools; undefined for JSON function tools. */
+    customWireName?: string;
+    /** Push a serializable projection of the in-flight call (e.g. diff previews); surfaces as `tool_stream_update`. */
+    emit(update: unknown): void;
+}
+export interface AgentTool<TParameters extends TSchema = TSchema, TDetails = any, TTheme = unknown> extends Tool<TParameters> {
+    label: string;
+    /**
+     * Called at `toolcall_start`, before any argument delta. Return `undefined` to opt out.
+     */
+    openArgStream?: (init: AgentToolArgStreamInit) => AgentToolArgStream | undefined;
+    /** If true, tool is excluded unless explicitly listed in --tools or agent's tools field */
+    hidden?: boolean;
+    /** If true, tool can stage a pending action that requires explicit resolution via the resolve tool. */
+    deferrable?: boolean;
+    /** How an enabled tool is presented. See {@link ToolLoadMode}. Omitted is treated as `"essential"` for built-ins; custom-tool adapters normalize omission to `"discoverable"`. */
+    loadMode?: ToolLoadMode;
+    /** Short one-line summary used for tool discovery indexes. */
+    summary?: string;
+    /**
+     * Concurrency mode for tool scheduling when multiple calls are in one turn.
+     * - "shared": can run alongside other shared tools (default)
+     * - "exclusive": runs alone; other tools wait until it finishes
+     * - function: resolved per call from the (raw, pre-validation) arguments
+     */
+    concurrency?: "shared" | "exclusive" | ((args: Partial<Static<TParameters>>) => "shared" | "exclusive");
+    /** If true, argument validation errors are non-fatal: raw args are passed to execute() instead of returning an error to the LLM. */
+    lenientArgValidation?: boolean;
+    /**
+     * Whether the agent loop may abort this tool mid-execution — or skip it
+     * before it starts — to deliver a queued steering message. A function
+     * resolves this per call from the raw, pre-validation arguments.
+     *
+     * Enable only for calls that purely *wait* and observe their abort signal
+     * cleanly (e.g. `job` poll), so the abort surfaces the tool's current
+     * snapshot rather than corrupting a side effect. Every other call runs to
+     * completion even when steering is queued; the message lands at the next
+     * batch boundary. Honored only when `interruptMode` is "immediate".
+     */
+    interruptible?: boolean | ((args: Partial<Static<TParameters>>) => boolean);
+    /**
+     * Controls how the INTENT_FIELD (`i`) is handled for this tool.
+     * - `"require"` (default): `i` is injected and required in the parameter schema.
+     * - `"optional"`: `i` is injected as an optional/nullable field.
+     * - `"omit"`: `i` is NOT injected. Use for tools where intent is obvious (yield, resolve, todo, …).
+     * - function: `i` is NOT injected; intent is derived dynamically from (potentially partial / streaming) args.
+     */
+    intent?: "omit" | "optional" | "require" | ((args: Partial<Static<TParameters>>) => string | undefined);
+    /**
+     * Normalize (potentially partial) streamed arguments into the plain text that
+     * stream-content matchers (e.g. TTSR rules) should inspect — the real content
+     * the call introduces, without wire grammar such as patch prefixes or JSON
+     * string escaping. Return `undefined` to fall back to raw argument-delta
+     * matching.
+     */
+    matcherDigest?: (args: unknown) => string | undefined;
+    /**
+     * Surface the target file paths a (potentially partial) streamed call would
+     * touch, so path-scoped stream matchers (e.g. TTSR `tool:edit(*.ts)` globs)
+     * can match without a top-level `path`/`paths` argument. Used for tools whose
+     * wire grammar embeds paths inside the streamed payload (hashline section
+     * headers, apply_patch envelope markers). Return `undefined` (or an empty
+     * array) to fall back to the caller's top-level argument scan.
+     */
+    matcherPaths?: (args: unknown) => readonly string[] | undefined;
+    /**
+     * Per-file projection of a (potentially partial) streamed call, pairing each
+     * touched file path with the digest of only the lines added to that file.
+     * Path-scoped stream matchers (TTSR) evaluate each entry in isolation, so a
+     * scoped rule like `tool:edit(*.ts)` never fires on text that actually
+     * belongs to a sibling Markdown hunk in a multi-file payload. Takes
+     * precedence over {@link matcherDigest} + {@link matcherPaths} when present;
+     * returns `undefined` (or empty) to fall back to the combined hooks.
+     */
+    matcherEntries?: (args: unknown) => readonly {
+        path: string;
+        digest: string;
+    }[] | undefined;
+    /** Capability tier declaration used by approval gates. Omitted means "exec". */
+    approval?: ToolApproval;
+    /** Lines appended after the standard approval prompt header. */
+    formatApprovalDetails?: (args: unknown) => string | string[] | undefined;
+    /** The main execution callback for this tool. */
+    execute: AgentToolExecFn<TParameters, TDetails, TTheme>;
+    /** Optional custom rendering for tool call display (returns UI component) */
+    renderCall?: (args: Static<TParameters>, options: RenderResultOptions, theme: TTheme) => unknown;
+    /** Optional custom rendering for tool result display (returns UI component) */
+    renderResult?: (result: AgentToolResult<TDetails, TParameters>, options: RenderResultOptions, theme: TTheme) => unknown;
+}
+export interface AgentContext {
+    systemPrompt: string[];
+    messages: AgentMessage[];
+    tools?: AgentTool<any>[];
+}
+/**
+ * Events emitted by the Agent for UI updates.
+ * These events provide fine-grained lifecycle information for messages, turns, and tool executions.
+ */
+export type AgentEvent = {
+    type: "agent_start";
+} | {
+    type: "agent_end";
+    messages: AgentMessage[];
+    /** Present iff `AgentTelemetryConfig` was supplied on this run. */
+    telemetry?: AgentRunSummary;
+    coverage?: AgentRunCoverage;
+} | {
+    type: "turn_start";
+} | {
+    type: "turn_end";
+    message: AgentMessage;
+    toolResults: ToolResultMessage[];
+} | {
+    type: "message_start";
+    message: AgentMessage;
+} | {
+    type: "message_update";
+    message: AgentMessage;
+    assistantMessageEvent: AssistantMessageEvent;
+} | {
+    type: "message_end";
+    message: AgentMessage;
+} | {
+    type: "tool_execution_start";
+    toolCallId: string;
+    toolName: string;
+    args: any;
+    intent?: string;
+} | {
+    type: "tool_execution_update";
+    toolCallId: string;
+    toolName: string;
+    args: any;
+    partialResult: any;
+} | {
+    type: "tool_stream_update";
+    toolCallId: string;
+    toolName: string;
+    update: unknown;
+} | {
+    type: "tool_execution_end";
+    toolCallId: string;
+    toolName: string;
+    result: any;
+    isError?: boolean;
+};