@iflow-ai/iflow-cli-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,966 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * iFlow SDK 错误类定义
+ *
+ * 提供完整的错误处理体系，包括连接错误、协议错误、权限错误等。
+ * 所有错误类都继承自 IFlowError 基类，提供统一的错误处理接口。
+ */
+/**
+ * IFlowError - SDK 基础错误类
+ *
+ * 所有 iFlow SDK 相关错误的基类，提供错误详情存储功能。
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.connect();
+ * } catch (error) {
+ *   if (error instanceof IFlowError) {
+ *     console.log("Error details:", error.details);
+ *   }
+ * }
+ * ```
+ */
+export declare class IFlowError extends Error {
+	/** 错误详细信息，包含上下文数据 */
+	readonly details: Record<string, any>;
+	/**
+	 * @param message - 错误消息
+	 * @param details - 可选的错误详情对象
+	 */
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * TimeoutError - 超时错误
+ *
+ * 当操作超过指定时间限制时抛出，如连接超时、响应超时等。
+ */
+export declare class TimeoutError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * JSONDecodeError - JSON 解析错误
+ *
+ * 当接收到的数据无法解析为有效 JSON 时抛出。
+ * 包含原始数据以便调试。
+ */
+export declare class JSONDecodeError extends IFlowError {
+	/** 导致解析失败的原始数据 */
+	readonly rawData: string;
+	/**
+	 * @param message - 错误消息
+	 * @param rawData - 导致解析失败的原始数据
+	 */
+	constructor(message: string, rawData: string);
+}
+/**
+ * IFlowNotInstalledError - iFlow CLI 未安装错误
+ *
+ * 当系统中未找到 iFlow CLI 时抛出。
+ * 用户需要先安装 iFlow CLI 才能使用 SDK。
+ */
+export declare class IFlowNotInstalledError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * IFlowProcessError - iFlow 进程错误
+ *
+ * 当 iFlow CLI 进程启动失败或运行异常时抛出。
+ */
+export declare class IFlowProcessError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * PortNotAvailableError - 端口不可用错误
+ *
+ * 当指定的端口已被占用或无法绑定时抛出。
+ */
+export declare class PortNotAvailableError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * ConnectionError - 连接错误
+ *
+ * 当 WebSocket 连接失败或断开时抛出。
+ */
+export declare class ConnectionError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * TransportError - 传输层错误
+ *
+ * 当 WebSocket 传输过程中发生错误时抛出。
+ */
+export declare class TransportError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * PermissionError - 权限错误
+ *
+ * 当工具调用或文件操作权限不足时抛出。
+ */
+export declare class PermissionError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * ValidationError - 验证错误
+ *
+ * 当输入参数或数据格式验证失败时抛出。
+ */
+export declare class ValidationError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * ProtocolError - 协议错误
+ *
+ * 当 ACP 协议消息格式错误或协议违规时抛出。
+ */
+export declare class ProtocolError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * AuthenticationError - 认证错误
+ *
+ * 当身份验证失败时抛出。
+ */
+export declare class AuthenticationError extends IFlowError {
+	constructor(message: string, details?: Record<string, any>);
+}
+/**
+ * iFlow SDK 配置选项类型定义
+ *
+ * 定义了 IFlowClient 的各种配置选项，包括日志级别、权限模式、
+ * 审批模式、钩子事件类型等。
+ */
+/**
+ * 日志级别枚举
+ */
+export declare enum LogLevel {
+	/** 调试级别 - 输出所有日志信息，包括详细的调试信息 */
+	DEBUG = 0,
+	/** 信息级别 - 输出一般信息、警告和错误 */
+	INFO = 1,
+	/** 警告级别 - 只输出警告和错误信息 */
+	WARN = 2,
+	/** 错误级别 - 只输出错误信息 */
+	ERROR = 3
+}
+/**
+ * 权限模式枚举
+ *
+ */
+export declare enum PermissionMode {
+	/** 自动模式 - 自动批准所有工具调用 */
+	AUTO = "auto",
+	/** 手动模式 - 需要手动确认每个工具调用 */
+	MANUAL = "manual",
+	/** 选择性模式 - 根据工具类型选择性批准 */
+	SELECTIVE = "selective"
+}
+/**
+ * 审批模式枚举
+ */
+export declare enum ApprovalMode {
+	/** 默认模式 - 使用系统默认的审批策略 */
+	DEFAULT = "default",
+	/** 自动编辑模式 - 自动批准文件编辑操作 */
+	AUTO_EDIT = "autoEdit",
+	/** YOLO 模式 - 自动批准所有操作（谨慎使用） */
+	YOLO = "yolo",
+	/** 计划模式 - 需要审批任务计划 */
+	PLAN = "plan"
+}
+/**
+ * 钩子事件类型枚举
+ */
+export declare enum HookEventType {
+	/** 工具使用前 - 在工具调用执行前触发 */
+	PRE_TOOL_USE = "PreToolUse",
+	/** 工具使用后 - 在工具调用执行后触发 */
+	POST_TOOL_USE = "PostToolUse",
+	/** 停止事件 - 在任务停止时触发 */
+	STOP = "Stop",
+	/** 子代理停止 - 在子代理停止时触发 */
+	SUBAGENT_STOP = "SubagentStop",
+	/** 环境设置 - 在环境设置时触发 */
+	SET_UP_ENVIRONMENT = "SetUpEnvironment"
+}
+/**
+ * MCP 服务器环境变量配置
+ */
+export interface MCPServerEnv {
+	/** 环境变量名称 */
+	name: string;
+	/** 环境变量值 */
+	value: string;
+}
+/**
+ * MCP 服务器配置
+ */
+export interface MCPServerConfig {
+	/** 服务器名称，用于标识 */
+	name: string;
+	/** 启动命令 */
+	command: string;
+	/** 命令行参数数组 */
+	args: string[];
+	/** 环境变量配置数组 */
+	env: MCPServerEnv[];
+}
+export type MCPServerConfigs = MCPServerConfig[];
+export interface HookCommand {
+	type: "command";
+	command: string;
+	timeout?: number;
+}
+export interface HookConfig {
+	matcher?: string;
+	hooks: HookCommand[];
+}
+export type HookConfigs = {
+	[key in HookEventType]?: HookConfig[];
+};
+export interface CommandConfig {
+	name: string;
+	content: string;
+}
+export type CommandConfigs = CommandConfig[];
+export interface SubAgentConfig {
+	agentType: string;
+	whenToUse: string;
+	allowedTools: string[];
+	systemPrompt: string;
+	name?: string;
+	description?: string;
+	allowedMcps?: string[];
+	proactive?: boolean;
+	location?: "global" | "project";
+	model?: string;
+	isInheritTools?: boolean;
+	isInheritMcps?: boolean;
+}
+export type SubAgentConfigs = SubAgentConfig[];
+export interface SessionSettings {
+	system_prompt?: string;
+	append_system_prompt?: string;
+	allowed_tools?: string[];
+	disallowed_tools?: string[];
+	permission_mode?: `${ApprovalMode}`;
+	max_turns?: number;
+	add_dirs?: string[];
+}
+export interface AuthMethodInfo {
+	apiKey?: string;
+	baseUrl?: string;
+	modelName?: string;
+}
+export interface IFlowOptions {
+	url?: string;
+	cwd?: string;
+	timeout?: number;
+	logLevel?: keyof typeof LogLevel;
+	processStartPort?: number;
+	autoStartProcess?: boolean;
+	authMethodId?: string;
+	authMethodInfo?: AuthMethodInfo;
+	mcpServers?: MCPServerConfigs;
+	hooks?: HookConfigs;
+	commands?: CommandConfigs;
+	agents?: SubAgentConfigs;
+	sessionSettings?: SessionSettings;
+	permissionMode?: `${PermissionMode}`;
+	autoApproveTypes?: string[];
+	fileAccess?: boolean;
+	fileMaxSize?: number;
+	fileReadOnly?: boolean;
+	fileAllowedDirs?: string[];
+	metadata?: Record<string, any>;
+}
+/**
+ * iFlow SDK 消息类型定义
+ * 定义了与 iFlow CLI 通信过程中使用的所有消息类型、枚举和接口。
+ */
+/**
+ * 任务计划优先级枚举
+ */
+export declare enum PlanPriority {
+	/** 高优先级 - 需要立即处理的重要任务 */
+	HIGH = "high",
+	/** 中等优先级 - 正常处理的任务 */
+	MEDIUM = "medium",
+	/** 低优先级 - 可以延后处理的任务 */
+	LOW = "low"
+}
+/**
+ * 任务计划状态枚举
+ */
+export declare enum PlanStatus {
+	/** 待处理 - 任务已创建但尚未开始 */
+	PENDING = "pending",
+	/** 进行中 - 任务正在执行 */
+	IN_PROGRESS = "in_progress",
+	/** 已完成 - 任务执行完毕 */
+	COMPLETED = "completed"
+}
+/**
+ * 停止原因枚举
+ */
+export declare enum StopReason {
+	/** 正常结束 - AI 主动结束对话轮次 */
+	END_TURN = "end_turn",
+	/** 达到最大令牌数 - 响应长度超出限制 */
+	MAX_TOKENS = "max_tokens",
+	/** 拒绝响应 - AI 拒绝执行请求 */
+	REFUSAL = "refusal",
+	/** 用户取消 - 用户主动取消操作 */
+	CANCELLED = "cancelled"
+}
+/**
+ * 工具调用状态枚举
+ */
+export declare enum ToolCallStatus {
+	/** 待处理 - 工具调用请求已发出但尚未开始执行 */
+	PENDING = "pending",
+	/** 执行中 - 工具正在执行 */
+	IN_PROGRESS = "in_progress",
+	/** 执行完成 - 工具成功执行并返回结果 */
+	COMPLETED = "completed",
+	/** 执行失败 - 工具执行过程中发生错误 */
+	FAILED = "failed"
+}
+/**
+ * 工具调用内容类型枚举
+ */
+export declare enum ToolCallContentType {
+	/** 差异格式 - 显示文件变更的 diff 格式 */
+	DIFF = "diff",
+	/** Markdown 格式 - 结构化的 Markdown 文本 */
+	MARKDOWN = "markdown"
+}
+export declare enum ToolCallConfirmationType {
+	/** 编辑 - 编辑文件 */
+	EDIT = "edit",
+	/** 执行 - 执行命令 */
+	EXECUTE = "execute",
+	/** MCP - MCP 服务器 */
+	MCP = "mcp",
+	/** FETCH - FETCH 服务器 */
+	FETCH = "fetch",
+	/** OTHER - 其他 */
+	OTHER = "other"
+}
+/**
+ * 工具调用确认结果枚举
+ */
+export declare enum ToolCallConfirmationOutcome {
+	/** 允许 - 允许工具调用 */
+	ALLOW = "allow",
+	/** 总是允许 - 总是允许工具调用 */
+	ALWAYS_ALLOW = "alwaysAllow",
+	/** 总是允许工具 - 总是允许工具调用 */
+	ALWAYS_ALLOW_TOOL = "alwaysAllowTool",
+	/** 总是允许 MCP 服务器 - 总是允许 MCP 服务器 */
+	ALWAYS_ALLOW_MCP_SERVER = "alwaysAllowMcpServer",
+	/** 拒绝 - 拒绝工具调用 */
+	REJECT = "reject"
+}
+/**
+ * 工具调用图标类型枚举
+ */
+export declare enum ToolCallIconType {
+	/** URL - URL 图标 */
+	URL = "url",
+	/** EMOJI - 表情图标 */
+	EMOJI = "emoji"
+}
+/** 消息类型枚举 */
+export declare enum MessageType {
+	PLAN = "plan",
+	/** USER - 用户消息 */
+	USER = "user",
+	/** ASSISTANT - 助手消息 */
+	ASSISTANT = "assistant",
+	/** TOOL_CALL - 工具调用消息 */
+	TOOL_CALL = "tool_call",
+	/** ERROR - 错误消息 */
+	ERROR = "error",
+	/** TASK_FINISH - 任务完成消息 */
+	TASK_FINISH = "task_finish"
+}
+/**
+ * 代理信息接口
+ */
+export interface AgentInfo {
+	/** 代理 ID */
+	agentId: string;
+	/** 代理索引 */
+	agentIndex?: number;
+	/** 任务 ID */
+	taskId?: string;
+	/** 时间戳 */
+	timestamp?: number;
+}
+/** 计划项接口 */
+export interface PlanEntry {
+	/** 内容 */
+	content: string;
+	/** 状态 */
+	status: `${PlanStatus}`;
+	/** 优先级 */
+	priority: `${PlanPriority}`;
+}
+/** 计划消息接口 */
+export interface PlanMessage {
+	/** 类型 */
+	type: `${MessageType.PLAN}`;
+	/** 计划项 */
+	entries: PlanEntry[];
+}
+/** 用户消息片段接口 */
+export interface UserMessageChunk {
+	/** 文本 */
+	text: string;
+}
+/** 用户消息接口 */
+export interface UserMessage {
+	type: `${MessageType.USER}`;
+	chunks: UserMessageChunk[];
+}
+/** 助手消息接口 */
+export interface AssistantMessage {
+	/** 类型 */
+	type: `${MessageType.ASSISTANT}`;
+	chunk: {
+		text?: string;
+		thought?: string;
+	};
+	agentId?: string;
+	agentInfo?: AgentInfo;
+}
+export interface ToolCallContent {
+	type: `${ToolCallContentType}`;
+	markdown?: string;
+	path?: string;
+	oldText?: string;
+	newText?: string;
+}
+export interface ToolCallLocation {
+	path: string;
+	lineStart?: number;
+	lineEnd?: number;
+}
+export interface ToolCallConfirmation {
+	type: `${ToolCallConfirmationType}`;
+	description?: string;
+	command?: string;
+	rootCommand?: string;
+	serverName?: string;
+	toolName?: string;
+	toolDisplayName?: string;
+	urls?: string[];
+}
+export interface ToolCallMessage {
+	type: `${MessageType.TOOL_CALL}`;
+	id: string;
+	label: string;
+	icon: {
+		type: `${ToolCallIconType}`;
+		value: string;
+	};
+	status: `${ToolCallStatus}`;
+	toolName?: string;
+	content?: ToolCallContent;
+	locations?: ToolCallLocation[];
+	confirmation?: ToolCallConfirmation;
+	args?: any;
+	output?: string;
+	agentId?: string;
+	agentInfo?: AgentInfo;
+}
+export interface ErrorMessage {
+	type: `${MessageType.ERROR}`;
+	code: number;
+	message: string;
+	details?: Record<string, any>;
+}
+export interface TaskFinishMessage {
+	type: `${MessageType.TASK_FINISH}`;
+	stopReason?: `${StopReason}`;
+}
+export type Message = PlanMessage | UserMessage | AssistantMessage | ToolCallMessage | ErrorMessage | TaskFinishMessage;
+export interface RawMessage {
+	isControl: boolean;
+	messageType: string;
+	rawData: string;
+	jsonData?: Record<string, any>;
+	parsedMessage?: Message;
+	timestamp: number;
+}
+/**
+ * 日志记录器配置选项
+ */
+export interface LoggerOptions {
+	/** 日志级别，默认为 INFO */
+	level?: keyof typeof LogLevel;
+}
+declare class Logger {
+	private readonly level;
+	constructor(options?: Partial<LoggerOptions>);
+	debug(message: string): void;
+	info(message: string): void;
+	warn(message: string): void;
+	error(message: string, error?: Error): void;
+	private log;
+}
+/**
+ * Transport 类构造选项
+ */
+export interface TransportOptions {
+	/** WebSocket 连接 URL */
+	url: string;
+	/** 日志记录器实例 */
+	logger?: Logger;
+	/** 连接超时时间（毫秒），默认 300000ms (5分钟) */
+	timeout?: number;
+}
+declare class Transport {
+	private readonly url;
+	private readonly logger;
+	private readonly timeout;
+	private ws;
+	private connected;
+	constructor(options: TransportOptions);
+	get isConnected(): boolean;
+	private checkConnected;
+	connect(): Promise<void>;
+	close(): Promise<void>;
+	send(data: string | object): Promise<void>;
+	receive(): AsyncGenerator<string>;
+	private receiveRawData;
+}
+/**
+ * FileHandler 类构造选项
+ */
+export interface FileHandlerOptions {
+	/** 工作目录，默认为当前进程工作目录 */
+	cwd?: string;
+	/** 日志记录器实例 */
+	logger?: Logger;
+	/** 只读模式，禁止写入操作 */
+	readOnly?: boolean;
+	/** 最大文件大小限制（字节），默认 10MB */
+	maxFileSize?: number;
+	/** 允许访问的目录列表，为空则允许访问所有目录 */
+	allowedDirs?: string[];
+}
+declare class FileHandler {
+	private readonly cwd;
+	private readonly logger;
+	private readonly readOnly;
+	private readonly maxFileSize;
+	private readonly allowedDirs;
+	constructor(options?: FileHandlerOptions);
+	private isPathAllowed;
+	readFile(filePath: string, line?: number, limit?: number): Promise<string>;
+	writeFile(filePath: string, content: string): Promise<void>;
+	addAllowedDir(dir: string): Promise<void>;
+	removeAllowedDir(dir: string): void;
+}
+export type ACPRequestId = number | string;
+declare enum ACPSessionUpdateType {
+	PLAN = "plan",
+	TOOL_CALL = "tool_call",
+	TOOL_CALL_UPDATE = "tool_call_update",
+	USER_MESSAGE_CHUNK = "user_message_chunk",
+	AGENT_MESSAGE_CHUNK = "agent_message_chunk",
+	AGENT_THOUGHT_CHUNK = "agent_thought_chunk"
+}
+export interface ACPInitializeResult {
+	protocolVersion: number;
+	isAuthenticated?: boolean;
+}
+export type ACPSessionUpdateData = ACPSessionUpdatePlanData | ACPSessionUpdateToolCallData | ACPSessionUpdateToolCallUpdateData | ACPSessionUpdateUserMessageChunkData | ACPSessionUpdateAgentMessageChunkData | ACPSessionUpdateAgentThoughtChunkData;
+export interface ACPSessionUpdatePlanData {
+	sessionUpdate: `${ACPSessionUpdateType.PLAN}`;
+	entries?: Partial<PlanEntry>[];
+}
+export interface ACPSessionUpdateToolCallData {
+	sessionUpdate: `${ACPSessionUpdateType.TOOL_CALL}`;
+	toolCallId: string;
+	title?: string;
+	status?: `${ToolCallStatus}`;
+	toolName?: string;
+	agentId?: string;
+}
+export interface ACPSessionUpdateToolCallUpdateData {
+	sessionUpdate: `${ACPSessionUpdateType.TOOL_CALL_UPDATE}`;
+	toolCallId: string;
+	title?: string;
+	status?: `${ToolCallStatus}`;
+	toolName?: string;
+	agentId?: string;
+	content?: Array<{
+		type: "content";
+		content?: {
+			type: "text";
+			text?: string;
+		};
+	}>;
+}
+export interface ACPSessionUpdateUserMessageChunkData {
+	sessionUpdate: `${ACPSessionUpdateType.USER_MESSAGE_CHUNK}`;
+	content?: {
+		type: "text";
+		text?: string;
+	};
+}
+export interface ACPSessionUpdateAgentMessageChunkData {
+	sessionUpdate: `${ACPSessionUpdateType.AGENT_MESSAGE_CHUNK}`;
+	content?: {
+		type: "text";
+		text?: string;
+	};
+}
+export interface ACPSessionUpdateAgentThoughtChunkData {
+	sessionUpdate: `${ACPSessionUpdateType.AGENT_THOUGHT_CHUNK}`;
+	content?: {
+		type: "text";
+		text?: string;
+	};
+}
+export interface ACPRequestPermissionParams {
+	toolCall?: {
+		type?: string;
+		title?: string;
+	};
+	options?: Array<{
+		optionId: string;
+	}>;
+}
+declare enum ProtocolMessageType {
+	ERROR = "error",
+	RESPONSE = "response",
+	FILE_READ = "file_read",
+	FILE_WRITE = "file_write",
+	SESSION_UPDATE = "session_update",
+	TOOL_CALL = "tool_call",
+	TOOL_UPDATE = "tool_update",
+	TOOL_CONFIRMATION = "tool_confirmation",
+	TASK_FINISH = "task_finish",
+	UNKNOWN = "unknown"
+}
+export interface ProtocolErrorMessage {
+	type: `${ProtocolMessageType.ERROR}`;
+	code: number;
+	error: string;
+	method?: string;
+}
+export interface ProtocolResponseMessage {
+	type: `${ProtocolMessageType.RESPONSE}`;
+	id: ACPRequestId;
+	result: any;
+}
+export interface ProtocolFileReadMessage {
+	type: `${ProtocolMessageType.FILE_READ}`;
+	path: string;
+	content: string;
+}
+export interface ProtocolFileWriteMessage {
+	type: `${ProtocolMessageType.FILE_WRITE}`;
+	path: string;
+	content: string;
+}
+export interface ProtocolSessionUpdateMessage {
+	type: `${ProtocolMessageType.SESSION_UPDATE}`;
+	sessionId: string;
+	updateData: ACPSessionUpdateData;
+}
+export interface ProtocolToolConfirmationMessage {
+	type: `${ProtocolMessageType.TOOL_CONFIRMATION}`;
+	params: ACPRequestPermissionParams;
+	response: {
+		outcome: {
+			outcome: string;
+			optionId?: string;
+		};
+	};
+}
+export interface ProtocolToolCallMessage {
+	type: `${ProtocolMessageType.TOOL_CALL}`;
+	id: string;
+	params: any;
+}
+export interface ProtocolToolUpdateMessage {
+	type: `${ProtocolMessageType.TOOL_UPDATE}`;
+	params: any;
+}
+export interface ProtocolTaskFinishMessage {
+	type: `${ProtocolMessageType.TASK_FINISH}`;
+	params: any;
+}
+export interface ProtocolUnknownMessage {
+	type: `${ProtocolMessageType.UNKNOWN}`;
+	method: string;
+	params: any;
+}
+export type ProtocolMessage = ProtocolErrorMessage | ProtocolResponseMessage | ProtocolFileReadMessage | ProtocolFileWriteMessage | ProtocolSessionUpdateMessage | ProtocolToolCallMessage | ProtocolToolUpdateMessage | ProtocolToolConfirmationMessage | ProtocolTaskFinishMessage | ProtocolUnknownMessage;
+export interface TextPrompt {
+	type: "text";
+	text: string;
+}
+export interface ImagePrompt {
+	type: "image";
+	data: string;
+	mimeType: string;
+}
+export interface AudioPrompt {
+	type: "audio";
+	data: string;
+	mimeType: string;
+}
+export interface ResourceLinkPrompt {
+	type: "resource_link";
+	uri: string;
+	name: string;
+	title: string;
+	size: number;
+}
+export type Prompt = TextPrompt | ImagePrompt | AudioPrompt | ResourceLinkPrompt;
+/**
+ * Protocol 类构造选项
+ */
+export interface ProtocolOptions {
+	/** 日志记录器实例 */
+	logger?: Logger;
+	/** WebSocket 传输层实例 */
+	transport: Transport;
+	/** 文件处理器实例，用于文件读写操作 */
+	fileHandler?: FileHandler;
+	/** 权限模式，控制工具调用的审批方式 */
+	permissionMode?: `${PermissionMode}`;
+	/** 自动批准的工具类型列表 */
+	autoApproveTypes?: string[];
+}
+declare class Protocol {
+	private readonly logger;
+	private readonly transport;
+	private readonly fileHandler?;
+	private readonly permissionMode;
+	private readonly autoApproveTypes;
+	private requestId;
+	private initialized;
+	private authenticated;
+	constructor(options: ProtocolOptions);
+	private nextRequestId;
+	private checkAuthenticated;
+	private sendResult;
+	private sendError;
+	private waitForReadySignal;
+	private waitForMessageResponse;
+	initialize(params?: {
+		mcpServers?: MCPServerConfigs;
+		hooks?: HookConfigs;
+		commands?: CommandConfigs;
+		agents?: SubAgentConfigs;
+	}): Promise<ACPInitializeResult>;
+	authenticate(params?: {
+		methodId?: string;
+		methodInfo?: AuthMethodInfo;
+	}): Promise<void>;
+	createSession(params?: {
+		cwd?: string;
+		mcpServers?: MCPServerConfigs;
+		hooks?: HookConfigs;
+		commands?: CommandConfigs;
+		agents?: SubAgentConfigs;
+		settings?: SessionSettings;
+	}): Promise<string>;
+	loadSession(params: {
+		sessionId: string;
+		cwd?: string;
+		mcpServers?: MCPServerConfigs;
+	}): Promise<void>;
+	sendPrompt(params: {
+		sessionId: string;
+		prompt: Prompt[];
+	}): Promise<number>;
+	cancelSession(params: {
+		sessionId: string;
+	}): Promise<void>;
+	handleMessages(): AsyncGenerator<ProtocolMessage>;
+	private handleClientMessage;
+	private handleReadTextFile;
+	private handleWriteTextFile;
+	private handleSessionUpdate;
+	private handleRequestPermission;
+	private handlePushToolCall;
+	private handleUpdateToolCall;
+	private handleNotifyTaskFinish;
+	private handleUnknownMessage;
+}
+/**
+ * IFlowClient - iFlow CLI SDK 的核心客户端类
+ *
+ * 提供与 iFlow CLI 的完整交互能力，包括：
+ * - 自动进程管理：自动启动和管理 iFlow CLI 进程
+ * - WebSocket 通信：基于 ACP 协议的双向实时通信
+ * - 工具调用管理：处理和控制工具执行，支持细粒度权限控制
+ * - 多代理支持：跟踪和管理多个 AI 代理（SubAgent）
+ * - 任务规划：接收和处理结构化任务计划
+ * - 会话管理：创建、加载和管理对话会话
+ *
+ * @example
+ * ```typescript
+ * // 基本用法 - SDK 自动管理进程
+ * const client = new IFlowClient();
+ * await client.connect();
+ * await client.sendMessage("Hello, iFlow!");
+ *
+ * for await (const message of client.receiveMessages()) {
+ *   console.log(message);
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // 高级配置
+ * const client = new IFlowClient({
+ *   permissionMode: PermissionMode.AUTO,
+ *   sessionSettings: {
+ *     allowed_tools: ["read_file", "write_file"],
+ *     system_prompt: "You are a helpful assistant"
+ *   },
+ *   agents: [{
+ *     agentType: "code-reviewer",
+ *     name: "reviewer",
+ *     allowedTools: ["fs", "grep"]
+ *   }]
+ * });
+ * ```
+ */
+export declare class IFlowClient {
+	/** 客户端配置选项 */
+	private readonly options;
+	/** 日志记录器 */
+	protected readonly logger: Logger;
+	/** ACP 协议处理器 */
+	protected protocol: Protocol | null;
+	/** WebSocket 传输层 */
+	protected transport: Transport | null;
+	/** 连接状态标识 */
+	protected connected: boolean;
+	/** 认证状态标识 */
+	protected authenticated: boolean;
+	/** 消息处理任务 */
+	private messageTask;
+	/** 消息队列，用于缓存接收到的消息 */
+	private messageQueue;
+	/** 待处理的工具调用映射表，key 为工具调用 ID */
+	private pendingToolCalls;
+	/** WebSocket 连接 URL */
+	private url;
+	/** 当前会话 ID */
+	private sessionId;
+	/** 进程管理器，用于自动启动和管理 iFlow CLI 进程 */
+	private processManager;
+	/** 进程启动状态标识 */
+	private processStarted;
+	/**
+	 * 构造函数 - 创建 IFlowClient 实例
+	 *
+	 * @param options - 可选的配置选项，包括连接设置、权限模式、代理配置等
+	 */
+	constructor(options?: IFlowOptions);
+	connect(): Promise<void>;
+	loadSession(sessionId: string): Promise<void>;
+	disconnect(): Promise<void>;
+	sendMessage(text: string, files?: string[]): Promise<void>;
+	interrupt(): Promise<void>;
+	receiveMessages(): AsyncGenerator<Message>;
+	approveToolCall(toolId: string, outcome?: `${ToolCallConfirmationOutcome}`): Promise<void>;
+	rejectToolCall(toolId: string): Promise<void>;
+	protected handleMessages(): Promise<void>;
+	protected processProtocolMessage(protocolMessage: ProtocolMessage): Message | null;
+}
+export declare class RawDataClient extends IFlowClient {
+	private readonly captureRaw;
+	private readonly rawQueue;
+	private readonly rawHistory;
+	private readonly rawQueueResolvers;
+	private readonly messageQueueResolvers;
+	constructor(options?: IFlowOptions, captureRaw?: boolean);
+	protected handleMessages(): Promise<void>;
+	private captureRawStream;
+	private handleParsedStream;
+	receiveRawMessages(): AsyncGenerator<RawMessage>;
+	receiveDualStream(): AsyncGenerator<[
+		RawMessage,
+		Message | undefined
+	]>;
+	getRawHistory(): RawMessage[];
+	getProtocolStats(): Record<string, any>;
+	sendRaw(data: string | Record<string, any>): Promise<void>;
+}
+/**
+ * 简单的异步查询函数 - 发送提示并等待完整响应
+ *
+ * 这是最简单的使用方式，适合单次查询场景。
+ * SDK 会自动管理连接生命周期。
+ *
+ * @param prompt - 用户提示文本
+ * @param files - 可选的文件路径数组，用于上下文
+ * @param options - 可选的 iFlow 配置选项
+ * @returns Promise<string> - 完整的 AI 响应文本
+ *
+ * @example
+ * ```typescript
+ * const response = await query("What is the capital of France?");
+ * console.log(response); // "The capital of France is Paris."
+ * ```
+ */
+export declare function query(prompt: string, files?: string[], options?: IFlowOptions): Promise<string>;
+/**
+ * 同步查询函数 - 阻塞等待响应完成
+ *
+ * 注意：这是一个同步函数，会阻塞当前线程直到响应完成。
+ * 建议在大多数情况下使用异步的 query() 函数。
+ *
+ * @param prompt - 用户提示文本
+ * @param files - 可选的文件路径数组，用于上下文
+ * @param options - 可选的 iFlow 配置选项
+ * @returns string - 完整的 AI 响应文本
+ * @throws Error - 如果查询过程中发生错误
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const response = querySync("Hello, world!");
+ *   console.log(response);
+ * } catch (error) {
+ *   console.error("Query failed:", error);
+ * }
+ * ```
+ */
+export declare function querySync(prompt: string, files?: string[], options?: IFlowOptions): string;
+/**
+ * 流式查询函数 - 实时返回响应片段
+ *
+ * 使用异步生成器模式，可以实时接收 AI 响应的每个文本片段，
+ * 适合需要实时显示响应进度的场景。
+ *
+ * @param prompt - 用户提示文本
+ * @param files - 可选的文件路径数组，用于上下文
+ * @param options - 可选的 iFlow 配置选项
+ * @yields string - AI 响应的文本片段
+ *
+ * @example
+ * ```typescript
+ * for await (const chunk of queryStream("Explain quantum computing")) {
+ *   process.stdout.write(chunk); // 实时显示响应
+ * }
+ * ```
+ */
+export declare function queryStream(prompt: string, files?: string[], options?: IFlowOptions): AsyncGenerator<string>;
+
+export {};