@dyyz1993/pi-coding-agent 0.70.6 → 0.74.5

package/dist/core/extensions/types.d.ts

@@ -1,4 +1,3 @@
-import type { Channel } from "./channel-types.js";
 /**
  * Extension system types.
  *
@@ -29,13 +28,16 @@ import type { BuildSystemPromptOptions } from "../system-prompt.js";
 import type { BashOperations } from "../tools/bash.js";
 import type { EditToolDetails } from "../tools/edit.js";
 import type { BashToolDetails, BashToolInput, EditToolInput, FindToolDetails, FindToolInput, GrepToolDetails, GrepToolInput, LsToolDetails, LsToolInput, ReadToolDetails, ReadToolInput, WriteToolInput } from "../tools/index.js";
+import type { Channel } from "./channel-types.js";
 export type { ExecOptions, ExecResult } from "../exec.js";
 export type { BuildSystemPromptOptions } from "../system-prompt.js";
 export type { AgentToolResult, AgentToolUpdateCallback, ToolExecutionMode };
 export type { AppKeybinding, KeybindingsManager } from "../keybindings.js";
 /** Options for extension UI dialogs. */
 export interface ExtensionUIDialogOptions {
+    /** AbortSignal to programmatically dismiss the dialog. */
     signal?: AbortSignal;
+    /** Timeout in milliseconds. Dialog auto-dismisses with live countdown display. */
     timeout?: number;
     multiple?: boolean;
 }
@@ -60,6 +62,7 @@ export interface WorkingIndicatorOptions {
 }
 /** Wrap the current autocomplete provider with additional behavior. */
 export type AutocompleteProviderFactory = (current: AutocompleteProvider) => AutocompleteProvider;
+export type EditorFactory = (tui: TUI, theme: EditorTheme, keybindings: KeybindingsManager) => EditorComponent;
 /**
  * UI context for extensions to request interactive UI.
  * Each mode (interactive, RPC, print) provides its own implementation.
@@ -79,6 +82,8 @@ export interface ExtensionUIContext {
     setStatus(key: string, text: string | undefined): void;
     /** Set the working/loading message shown during streaming. Call with no argument to restore default. */
     setWorkingMessage(message?: string): void;
+    /** Show or hide the built-in interactive working loader row during streaming. */
+    setWorkingVisible(visible: boolean): void;
     /**
      * Configure the interactive working indicator shown during streaming.
      *
@@ -165,7 +170,9 @@ export interface ExtensionUIContext {
      * );
      * ```
      */
-    setEditorComponent(factory: ((tui: TUI, theme: EditorTheme, keybindings: KeybindingsManager) => EditorComponent) | undefined): void;
+    setEditorComponent(factory: EditorFactory | undefined): void;
+    /** Get the currently configured custom editor factory, or undefined when using the default editor. */
+    getEditorComponent(): EditorFactory | undefined;
     /** Get the current theme for styling. */
     readonly theme: Theme;
     /** Get all available themes with their names and file paths. */
@@ -207,18 +214,6 @@ export interface ExtensionContext {
     hasUI: boolean;
     /** Current working directory */
     cwd: string;
-    /** The name of the current extension. */
-    extensionName: string;
-    /** Canonical git root (worktree-aware). Falls back to cwd if not a git repo. */
-    projectRoot: string;
-    /** Per-session data directory. Automatically created on first access. Use this to store session-scoped data. */
-    sessionDataDir: string;
-    /** Per-project data directory (shared across sessions). Automatically created on first access. Use this to store project-scoped data. */
-    projectDataDir: string;
-    /** Per-cwd data directory (isolated by current working directory). Same as projectDataDir for normal repos; different in worktrees where each working directory gets its own storage. Automatically created on first access. */
-    cwdDataDir: string;
-    /** Global data directory shared across all projects. Use this for cross-project data like knowledge bases, shared caches, etc. Automatically created on first access. */
-    globalDataDir: string;
     /** Session manager (read-only) */
     sessionManager: ReadonlySessionManager;
     /** Model registry for API key resolution */
@@ -229,8 +224,6 @@ export interface ExtensionContext {
     isIdle(): boolean;
     /** The current abort signal, or undefined when the agent is not streaming. */
     signal: AbortSignal | undefined;
-    /** Signal that aborts on session shutdown. Available in ALL events, including agent_end. */
-    readonly sessionSignal: AbortSignal;
     /** Abort the current agent operation */
     abort(): void;
     /** Whether there are queued messages waiting */
@@ -243,6 +236,20 @@ export interface ExtensionContext {
     compact(options?: CompactOptions): void;
     /** Get the current effective system prompt. */
     getSystemPrompt(): string;
+    /** The name of the current extension. */
+    extensionName: string;
+    /** Canonical git root (worktree-aware). Falls back to cwd if not a git repo. */
+    projectRoot: string;
+    /** Per-session data directory. Automatically created on first access. Use this to store session-scoped data. */
+    sessionDataDir: string;
+    /** Per-project data directory (shared across sessions). Automatically created on first access. Use this to store project-scoped data. */
+    projectDataDir: string;
+    /** Per-cwd data directory (isolated by current working directory). Same as projectDataDir for normal repos; different in worktrees where each working directory gets its own storage. Automatically created on first access. */
+    cwdDataDir: string;
+    /** Global data directory shared across all projects. Use this for cross-project data like knowledge bases, shared caches, etc. Automatically created on first access. */
+    globalDataDir: string;
+    /** Signal that aborts on session shutdown. Available in ALL events, including agent_end. */
+    readonly sessionSignal: AbortSignal;
     /**
      * Asynchronously inject a response to a pending UI event.
      * Use with the `ui` event: capture event.id, return undefined from handler,
@@ -250,6 +257,8 @@ export interface ExtensionContext {
      * First response wins (original UI or respondUI), subsequent calls are ignored.
      */
     respondUI(id: string, result: UIEventResult): void;
+    /** File snapshot manager for turn-level file tracking and restore. Null when not available. */
+    fileSnapshotManager: import("../file-store/file-snapshot-manager.js").FileSnapshotManager | null;
 }
 /**
  * Extended context for command handlers.
@@ -435,6 +444,7 @@ export interface SessionShutdownEvent {
     reason: "quit" | "reload" | "new" | "resume" | "fork";
     /** Destination session file when shutting down due to session replacement. */
     targetSessionFile?: string;
+    entryId?: string;
 }
 /** Fired when the session display name is changed via pi.setSessionName(). */
 export interface SessionRenameEvent {
@@ -457,6 +467,8 @@ export interface TreePreparation {
     replaceInstructions?: boolean;
     /** Label to attach to the branch summary entry */
     label?: string;
+    skipFiles?: boolean;
+    preview?: boolean;
 }
 /** Fired before navigating in the session tree (can be cancelled) */
 export interface SessionBeforeTreeEvent {
@@ -474,11 +486,11 @@ export interface SessionTreeEvent {
     skipFiles?: boolean;
     preview?: boolean;
 }
+export type SessionEvent = SessionStartEvent | SessionBeforeSwitchEvent | SessionBeforeForkEvent | SessionBeforeCompactEvent | SessionCompactEvent | SessionShutdownEvent | SessionRenameEvent | SessionBeforeTreeEvent | SessionTreeEvent;
 export interface SessionTreePreviewResult {
     restored: string[];
     deleted: string[];
 }
-export type SessionEvent = SessionStartEvent | SessionBeforeSwitchEvent | SessionBeforeForkEvent | SessionBeforeCompactEvent | SessionCompactEvent | SessionShutdownEvent | SessionRenameEvent | SessionBeforeTreeEvent | SessionTreeEvent;
 /** Fired before each LLM call. Can modify messages. */
 export interface ContextEvent {
     type: "context";
@@ -506,6 +518,8 @@ export interface BeforeAgentStartEvent {
     systemPrompt: string;
     /** Structured options used to build the system prompt. Extensions can inspect this to understand what Pi loaded without re-discovering resources. */
     systemPromptOptions: BuildSystemPromptOptions;
+    /** Arbitrary key-value metadata from the current execution context (e.g. agent role, permission mode). */
+    variables?: Record<string, string>;
 }
 /** Fired when an agent loop starts */
 export interface AgentStartEvent {
@@ -544,7 +558,6 @@ export interface MessageUpdateEvent {
 export interface MessageEndEvent {
     type: "message_end";
     message: AgentMessage;
-    entryId?: string;
 }
 /** Fired when a tool starts executing */
 export interface ToolExecutionStartEvent {
@@ -577,6 +590,12 @@ export interface ModelSelectEvent {
     previousModel: Model<any> | undefined;
     source: ModelSelectSource;
 }
+/** Fired when a new thinking level is selected */
+export interface ThinkingLevelSelectEvent {
+    type: "thinking_level_select";
+    level: ThinkingLevel;
+    previousLevel: ThinkingLevel;
+}
 /** Fired when user executes a bash command via ! or !! prefix */
 export interface UserBashEvent {
     type: "user_bash";
@@ -631,8 +650,6 @@ export type UIEventResult = {
 interface ToolCallEventBase {
     type: "tool_call";
     toolCallId: string;
-    /** Arbitrary key-value metadata from the current execution context (e.g. agent role, permission mode). */
-    variables?: Record<string, string>;
 }
 export interface BashToolCallEvent extends ToolCallEventBase {
     toolName: "bash";
@@ -753,7 +770,7 @@ export declare function isToolCallEventType<TName extends string, TInput extends
     input: TInput;
 };
 /** Union of all event types */
-export type ExtensionEvent = ResourcesDiscoverEvent | SessionEvent | ContextEvent | BeforeProviderRequestEvent | AfterProviderResponseEvent | BeforeAgentStartEvent | AgentStartEvent | AgentEndEvent | TurnStartEvent | TurnEndEvent | MessageStartEvent | MessageUpdateEvent | MessageEndEvent | ToolExecutionStartEvent | ToolExecutionUpdateEvent | ToolExecutionEndEvent | ModelSelectEvent | UserBashEvent | InputEvent | ToolCallEvent | ToolResultEvent;
+export type ExtensionEvent = ResourcesDiscoverEvent | SessionEvent | ContextEvent | BeforeProviderRequestEvent | AfterProviderResponseEvent | BeforeAgentStartEvent | AgentStartEvent | AgentEndEvent | TurnStartEvent | TurnEndEvent | MessageStartEvent | MessageUpdateEvent | MessageEndEvent | ToolExecutionStartEvent | ToolExecutionUpdateEvent | ToolExecutionEndEvent | ModelSelectEvent | ThinkingLevelSelectEvent | UserBashEvent | InputEvent | ToolCallEvent | ToolResultEvent | UIEvent;
 export interface ContextEventResult {
     messages?: AgentMessage[];
 }
@@ -775,6 +792,10 @@ export interface ToolResultEventResult {
     details?: unknown;
     isError?: boolean;
 }
+export interface MessageEndEventResult {
+    /** Replace the finalized message. The replacement must keep the original message role. */
+    message?: AgentMessage;
+}
 export interface BeforeAgentStartEventResult {
     message?: Pick<CustomMessage, "customType" | "content" | "display" | "details">;
     /** Replace the system prompt for this turn. If multiple extensions return this, they are chained. */
@@ -824,36 +845,37 @@ export type ExtensionHandler<E, R = undefined> = (event: E, ctx: ExtensionContex
  * ExtensionAPI passed to extension factory functions.
  */
 export interface ExtensionAPI {
-    on(event: "resources_discover", handler: ExtensionHandler<ResourcesDiscoverEvent, ResourcesDiscoverResult>): () => void;
-    on(event: "session_start", handler: ExtensionHandler<SessionStartEvent>): () => void;
-    on(event: "session_before_switch", handler: ExtensionHandler<SessionBeforeSwitchEvent, SessionBeforeSwitchResult>): () => void;
-    on(event: "session_before_fork", handler: ExtensionHandler<SessionBeforeForkEvent, SessionBeforeForkResult>): () => void;
-    on(event: "session_before_compact", handler: ExtensionHandler<SessionBeforeCompactEvent, SessionBeforeCompactResult>): () => void;
-    on(event: "session_compact", handler: ExtensionHandler<SessionCompactEvent>): () => void;
-    on(event: "session_shutdown", handler: ExtensionHandler<SessionShutdownEvent>): () => void;
-    on(event: "session_rename", handler: ExtensionHandler<SessionRenameEvent>): () => void;
-    on(event: "session_before_tree", handler: ExtensionHandler<SessionBeforeTreeEvent, SessionBeforeTreeResult>): () => void;
-    on(event: "session_tree", handler: ExtensionHandler<SessionTreeEvent>): () => void;
-    on(event: "context", handler: ExtensionHandler<ContextEvent, ContextEventResult>): () => void;
-    on(event: "before_provider_request", handler: ExtensionHandler<BeforeProviderRequestEvent, BeforeProviderRequestEventResult>): () => void;
-    on(event: "after_provider_response", handler: ExtensionHandler<AfterProviderResponseEvent>): () => void;
-    on(event: "before_agent_start", handler: ExtensionHandler<BeforeAgentStartEvent, BeforeAgentStartEventResult>): () => void;
-    on(event: "agent_start", handler: ExtensionHandler<AgentStartEvent>): () => void;
-    on(event: "agent_end", handler: ExtensionHandler<AgentEndEvent>): () => void;
-    on(event: "turn_start", handler: ExtensionHandler<TurnStartEvent>): () => void;
-    on(event: "turn_end", handler: ExtensionHandler<TurnEndEvent>): () => void;
-    on(event: "message_start", handler: ExtensionHandler<MessageStartEvent>): () => void;
-    on(event: "message_update", handler: ExtensionHandler<MessageUpdateEvent>): () => void;
-    on(event: "message_end", handler: ExtensionHandler<MessageEndEvent>): () => void;
-    on(event: "tool_execution_start", handler: ExtensionHandler<ToolExecutionStartEvent>): () => void;
-    on(event: "tool_execution_update", handler: ExtensionHandler<ToolExecutionUpdateEvent>): () => void;
-    on(event: "tool_execution_end", handler: ExtensionHandler<ToolExecutionEndEvent>): () => void;
-    on(event: "model_select", handler: ExtensionHandler<ModelSelectEvent>): () => void;
-    on(event: "tool_call", handler: ExtensionHandler<ToolCallEvent, ToolCallEventResult>): () => void;
-    on(event: "tool_result", handler: ExtensionHandler<ToolResultEvent, ToolResultEventResult>): () => void;
-    on(event: "user_bash", handler: ExtensionHandler<UserBashEvent, UserBashEventResult>): () => void;
-    on(event: "input", handler: ExtensionHandler<InputEvent, InputEventResult>): () => void;
-    on(event: "ui", handler: ExtensionHandler<UIEvent, UIEventResult>): () => void;
+    on(event: "resources_discover", handler: ExtensionHandler<ResourcesDiscoverEvent, ResourcesDiscoverResult>): void;
+    on(event: "session_start", handler: ExtensionHandler<SessionStartEvent>): void;
+    on(event: "session_before_switch", handler: ExtensionHandler<SessionBeforeSwitchEvent, SessionBeforeSwitchResult>): void;
+    on(event: "session_before_fork", handler: ExtensionHandler<SessionBeforeForkEvent, SessionBeforeForkResult>): void;
+    on(event: "session_before_compact", handler: ExtensionHandler<SessionBeforeCompactEvent, SessionBeforeCompactResult>): void;
+    on(event: "session_compact", handler: ExtensionHandler<SessionCompactEvent>): void;
+    on(event: "session_shutdown", handler: ExtensionHandler<SessionShutdownEvent>): void;
+    on(event: "session_rename", handler: ExtensionHandler<SessionRenameEvent>): void;
+    on(event: "session_before_tree", handler: ExtensionHandler<SessionBeforeTreeEvent, SessionBeforeTreeResult>): void;
+    on(event: "session_tree", handler: ExtensionHandler<SessionTreeEvent>): void;
+    on(event: "context", handler: ExtensionHandler<ContextEvent, ContextEventResult>): void;
+    on(event: "before_provider_request", handler: ExtensionHandler<BeforeProviderRequestEvent, BeforeProviderRequestEventResult>): void;
+    on(event: "after_provider_response", handler: ExtensionHandler<AfterProviderResponseEvent>): void;
+    on(event: "before_agent_start", handler: ExtensionHandler<BeforeAgentStartEvent, BeforeAgentStartEventResult>): void;
+    on(event: "agent_start", handler: ExtensionHandler<AgentStartEvent>): void;
+    on(event: "agent_end", handler: ExtensionHandler<AgentEndEvent>): void;
+    on(event: "turn_start", handler: ExtensionHandler<TurnStartEvent>): void;
+    on(event: "turn_end", handler: ExtensionHandler<TurnEndEvent>): void;
+    on(event: "message_start", handler: ExtensionHandler<MessageStartEvent>): void;
+    on(event: "message_update", handler: ExtensionHandler<MessageUpdateEvent>): void;
+    on(event: "message_end", handler: ExtensionHandler<MessageEndEvent, MessageEndEventResult>): void;
+    on(event: "tool_execution_start", handler: ExtensionHandler<ToolExecutionStartEvent>): void;
+    on(event: "tool_execution_update", handler: ExtensionHandler<ToolExecutionUpdateEvent>): void;
+    on(event: "tool_execution_end", handler: ExtensionHandler<ToolExecutionEndEvent>): void;
+    on(event: "model_select", handler: ExtensionHandler<ModelSelectEvent>): void;
+    on(event: "thinking_level_select", handler: ExtensionHandler<ThinkingLevelSelectEvent>): void;
+    on(event: "tool_call", handler: ExtensionHandler<ToolCallEvent, ToolCallEventResult>): void;
+    on(event: "tool_result", handler: ExtensionHandler<ToolResultEvent, ToolResultEventResult>): void;
+    on(event: "user_bash", handler: ExtensionHandler<UserBashEvent, UserBashEventResult>): void;
+    on(event: "input", handler: ExtensionHandler<InputEvent, InputEventResult>): void;
+    on(event: "ui", handler: ExtensionHandler<UIEvent, UIEventResult>): void;
     /** Register a tool that the LLM can call. */
     registerTool<TParams extends TSchema = TSchema, TDetails = unknown, TState = any>(tool: ToolDefinition<TParams, TDetails, TState>): void;
     /** Register a custom command. */
@@ -891,16 +913,16 @@ export interface ExtensionAPI {
     }): void;
     /** Fold a message entry, replacing its content with a summary in LLM context. */
     foldEntry(entryId: string, summary: string, originalTokens: number): void;
-    /** Set the extension's display name. Used for storage path namespacing and error reporting. Must be called before any event handlers are registered. */
-    setName(name: string): void;
-    /** Get the extension's name. If not explicitly set via setName(), returns the auto-derived name. */
-    extensionName: string;
     /** Set the session display name (shown in session selector). */
     setSessionName(name: string): void;
     /** Get the current session name, if set. */
     getSessionName(): string | undefined;
     /** Set or clear a label on an entry. Labels are user-defined markers for bookmarking/navigation. */
     setLabel(entryId: string, label: string | undefined): void;
+    /** Set the extension's display name. Used for storage path namespacing and error reporting. Must be called before any event handlers are registered. */
+    setName(name: string): void;
+    /** Get the extension's name. If not explicitly set via setName(), returns the auto-derived name. */
+    extensionName: string;
     /** Execute a shell command. */
     exec(command: string, args: string[], options?: ExecOptions): Promise<ExecResult>;
     /** Get the list of currently active tool names. */
@@ -1003,6 +1025,8 @@ export interface ExtensionAPI {
 }
 /** Configuration for registering a provider via pi.registerProvider(). */
 export interface ProviderConfig {
+    /** Display name for the provider in UI. */
+    name?: string;
     /** Base URL for the API endpoint. Required when defining models. */
     baseUrl?: string;
     /** API key or environment variable name. Required when defining models (unless oauth provided). */
@@ -1039,8 +1063,12 @@ export interface ProviderModelConfig {
     name: string;
     /** API type override for this model. */
     api?: Api;
+    /** API endpoint URL override for this model. */
+    baseUrl?: string;
     /** Whether the model supports extended thinking. */
     reasoning: boolean;
+    /** Maps pi thinking levels to provider/model-specific values; null marks a level unsupported. */
+    thinkingLevelMap?: Model<Api>["thinkingLevelMap"];
     /** Supported input types. */
     input: ("text" | "image")[];
     /** Cost per token (for tracking, can be 0). */
@@ -1079,6 +1107,10 @@ export interface ExtensionShortcut {
     extensionPath: string;
 }
 type HandlerFn = (...args: unknown[]) => Promise<unknown>;
+/** Tool info with name, description, parameter schema, and source metadata */
+export type ToolInfo = Pick<ToolDefinition, "name" | "description" | "parameters"> & {
+    sourceInfo: SourceInfo;
+};
 export type SendMessageHandler = <T = unknown>(message: Pick<CustomMessage<T>, "customType" | "content" | "display" | "details">, options?: {
     triggerTurn?: boolean;
     deliverAs?: "steer" | "followUp" | "nextTurn";
@@ -1093,10 +1125,6 @@ export type FoldEntryHandler = (entryId: string, summary: string, originalTokens
 export type SetSessionNameHandler = (name: string) => void;
 export type GetSessionNameHandler = () => string | undefined;
 export type GetActiveToolsHandler = () => string[];
-/** Tool info with name, description, parameter schema, and source metadata */
-export type ToolInfo = Pick<ToolDefinition, "name" | "description" | "parameters"> & {
-    sourceInfo: SourceInfo;
-};
 export type GetAllToolsHandler = () => ToolInfo[];
 export type GetCommandsHandler = () => SlashCommandInfo[];
 export type SetActiveToolsHandler = (toolNames: string[]) => void;
@@ -1226,13 +1254,13 @@ export interface ExtensionContextActions {
     getModel: () => Model<any> | undefined;
     isIdle: () => boolean;
     getSignal: () => AbortSignal | undefined;
-    getSessionSignal: () => AbortSignal;
     abort: () => void;
     hasPendingMessages: () => boolean;
     shutdown: () => void;
     getContextUsage: () => ContextUsage | undefined;
     compact: (options?: CompactOptions) => void;
     getSystemPrompt: () => string;
+    getSessionSignal: () => AbortSignal;
 }
 /**
  * Actions for ExtensionCommandContext (ctx.* in command handlers).