@iflow-ai/iflow-cli-sdk 0.1.9-beta.2 → 0.2.0-beta.0

package/dist/index.d.ts

@@ -258,10 +258,12 @@ export interface AuthMethodInfo {
 export interface IFlowOptions {
 	url?: string;
 	cwd?: string;
+	sessionId?: string;
 	timeout?: number;
 	logLevel?: keyof typeof LogLevel;
 	processStartPort?: number;
 	autoStartProcess?: boolean;
+	stream?: boolean;
 	authMethodId?: string;
 	authMethodInfo?: AuthMethodInfo;
 	mcpServers?: MCPServerConfigs;
@@ -386,7 +388,13 @@ export declare enum MessageType {
 	/** ERROR - 错误消息 */
 	ERROR = "error",
 	/** TASK_FINISH - 任务完成消息 */
-	TASK_FINISH = "task_finish"
+	TASK_FINISH = "task_finish",
+	/** ASK_USER_QUESTIONS - 询问用户问题 */
+	ASK_USER_QUESTIONS = "ask_user_questions",
+	/** EXIT_PLAN_MODE - 退出计划模式 */
+	EXIT_PLAN_MODE = "exit_plan_mode",
+	/** PERMISSION_REQUEST - 权限请求 */
+	PERMISSION_REQUEST = "permission_request"
 }
 /**
  * 代理信息接口
@@ -473,7 +481,7 @@ export interface ToolCallMessage {
 	content?: ToolCallContent;
 	locations?: ToolCallLocation[];
 	confirmation?: ToolCallConfirmation;
-	args?: any;
+	args?: unknown;
 	output?: string;
 	agentId?: string;
 	agentInfo?: AgentInfo;
@@ -482,13 +490,43 @@ export interface ErrorMessage {
 	type: `${MessageType.ERROR}`;
 	code: number;
 	message: string;
-	details?: Record<string, any>;
+	details?: Record<string, unknown>;
 }
 export interface TaskFinishMessage {
 	type: `${MessageType.TASK_FINISH}`;
 	stopReason?: `${StopReason}`;
 }
-export type Message = PlanMessage | UserMessage | AssistantMessage | ToolCallMessage | ErrorMessage | TaskFinishMessage;
+export interface QuestionOption {
+	label: string;
+	description: string;
+}
+export interface Question {
+	question: string;
+	header: string;
+	options: QuestionOption[];
+	multiSelect: boolean;
+}
+export interface AskUserQuestionsMessage {
+	type: `${MessageType.ASK_USER_QUESTIONS}`;
+	questions: Question[];
+}
+export interface ExitPlanModeMessage {
+	type: `${MessageType.EXIT_PLAN_MODE}`;
+	plan: string;
+}
+export interface PermissionRequestMessage {
+	type: `${MessageType.PERMISSION_REQUEST}`;
+	requestId: number | string;
+	sessionId?: string;
+	toolCall: {
+		type?: string;
+		title?: string;
+	};
+	options: Array<{
+		optionId: string;
+	}>;
+}
+export type Message = PlanMessage | UserMessage | AssistantMessage | ToolCallMessage | ErrorMessage | TaskFinishMessage | AskUserQuestionsMessage | ExitPlanModeMessage | PermissionRequestMessage;
 export interface RawMessage {
 	isControl: boolean;
 	messageType: string;
@@ -497,77 +535,82 @@ export interface RawMessage {
 	parsedMessage?: Message;
 	timestamp: number;
 }
+export type ACPRequestId = number | string;
 /**
- * 日志记录器配置选项
+ * 模式信息接口
  */
-export interface LoggerOptions {
-	/** 日志级别，默认为 INFO */
-	level?: keyof typeof LogLevel;
+export interface ModeInfo {
+	id: string;
+	name: string;
+	description: string;
 }
-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;
+/**
+ * 模式集合接口
+ */
+export interface Modes {
+	currentModeId: string;
+	availableModes: ModeInfo[];
 }
 /**
- * Transport 类构造选项
+ * 模型信息接口
  */
-export interface TransportOptions {
-	/** WebSocket 连接 URL */
-	url: string;
-	/** 日志记录器实例 */
-	logger?: Logger;
-	/** 连接超时时间（毫秒），默认 300000ms (5分钟) */
-	timeout?: number;
+export interface ModelInfo {
+	id: string;
+	name: string;
+	description: string;
 }
-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;
+/**
+ * 模型集合接口
+ */
+export interface Models {
+	currentModelId: string;
+	availableModels: ModelInfo[];
 }
 /**
- * FileHandler 类构造选项
+ * 命令信息接口
  */
-export interface FileHandlerOptions {
-	/** 工作目录，默认为当前进程工作目录 */
-	cwd?: string;
-	/** 日志记录器实例 */
-	logger?: Logger;
-	/** 只读模式，禁止写入操作 */
-	readOnly?: boolean;
-	/** 最大文件大小限制（字节），默认 10MB */
-	maxFileSize?: number;
-	/** 允许访问的目录列表，为空则允许访问所有目录 */
-	allowedDirs?: string[];
+export interface CommandInfo {
+	name: string;
+	description: string;
+	input?: {
+		hint: string;
+	};
+	_meta?: {
+		scope: "user" | "project";
+	};
 }
-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 interface AvailableAgent {
+	name: string;
+	description: string;
+	_meta?: {
+		scope: "user" | "project";
+	};
+}
+/**
+ * 技能信息接口
+ */
+export interface SkillInfo {
+	name: string;
+	description: string;
+	_meta?: {
+		scope: "user" | "project";
+	};
+}
+/**
+ * MCP 服务器信息接口
+ */
+export interface McpServerInfo {
+	name: string;
+	command: string;
+	args: string[];
+	env: string[];
+	_meta?: {
+		scope: "user" | "project";
+	};
 }
-export type ACPRequestId = number | string;
 declare enum ACPSessionUpdateType {
 	PLAN = "plan",
 	TOOL_CALL = "tool_call",
@@ -580,6 +623,17 @@ export interface ACPInitializeResult {
 	protocolVersion: number;
 	isAuthenticated?: boolean;
 }
+export interface ACPCreateSessionResult {
+	sessionId: string;
+	modes?: Modes;
+	_meta?: {
+		models?: Models;
+		availableCommands?: CommandInfo[];
+		availableAgents?: AvailableAgent[];
+		availableSkills?: SkillInfo[];
+		availableMcpServers?: McpServerInfo[];
+	};
+}
 export type ACPSessionUpdateData = ACPSessionUpdatePlanData | ACPSessionUpdateToolCallData | ACPSessionUpdateToolCallUpdateData | ACPSessionUpdateUserMessageChunkData | ACPSessionUpdateAgentMessageChunkData | ACPSessionUpdateAgentThoughtChunkData;
 export interface ACPSessionUpdatePlanData {
 	sessionUpdate: `${ACPSessionUpdateType.PLAN}`;
@@ -591,7 +645,7 @@ export interface ACPSessionUpdateToolCallData {
 	title?: string;
 	status?: `${ToolCallStatus}`;
 	toolName?: string;
-	args?: any;
+	args?: unknown;
 	agentId?: string;
 }
 export interface ACPSessionUpdateToolCallUpdateData {
@@ -600,7 +654,7 @@ export interface ACPSessionUpdateToolCallUpdateData {
 	title?: string;
 	status?: `${ToolCallStatus}`;
 	toolName?: string;
-	args?: any;
+	args?: unknown;
 	agentId?: string;
 	content?: Array<{
 		type: "content";
@@ -631,14 +685,129 @@ export interface ACPSessionUpdateAgentThoughtChunkData {
 		text?: string;
 	};
 }
-export interface ACPRequestPermissionParams {
-	toolCall?: {
-		type?: string;
-		title?: string;
-	};
-	options?: Array<{
-		optionId: string;
-	}>;
+export interface ACPQuestionOption {
+	label: string;
+	description: string;
+}
+export interface ACPQuestion {
+	question: string;
+	header: string;
+	options: ACPQuestionOption[];
+	multiSelect: boolean;
+}
+export interface ACPAskUserQuestionsParams {
+	sessionId: string;
+	questions: ACPQuestion[];
+}
+export interface ACPExitPlanModeParams {
+	sessionId: string;
+	plan: string;
+}
+/**
+ * setThink 操作的请求参数
+ */
+export interface ACPSetThinkParams {
+	sessionId: string;
+	thinkEnabled: boolean;
+	thinkConfig?: string;
+}
+/**
+ * setThink 操作的服务器响应结果
+ */
+export interface ACPSetThinkResult {
+	success: boolean;
+	currentThinkEnabled: boolean;
+	currentThinkConfig?: string;
+}
+/**
+ * IFlowClient.setThink 方法的参数类型
+ */
+export interface SetThinkParams {
+	/** 是否启用思考模式 */
+	enabled: boolean;
+	/** 思考配置级别，可选值: 'think', 'megathink', 'ultrathink' */
+	config?: string;
+}
+/**
+ * IFlowClient.setThink 方法的返回类型
+ */
+export interface SetThinkResult {
+	/** 操作是否成功 */
+	success: boolean;
+	/** 当前思考模式是否启用 */
+	currentThinkEnabled: boolean;
+	/** 当前思考配置级别 */
+	currentThinkConfig?: string;
+}
+/**
+ * 日志记录器配置选项
+ */
+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;
 }
 declare enum ProtocolMessageType {
 	ERROR = "error",
@@ -648,8 +817,10 @@ declare enum ProtocolMessageType {
 	SESSION_UPDATE = "session_update",
 	TOOL_CALL = "tool_call",
 	TOOL_UPDATE = "tool_update",
-	TOOL_CONFIRMATION = "tool_confirmation",
 	TASK_FINISH = "task_finish",
+	ASK_USER_QUESTIONS = "ask_user_questions",
+	EXIT_PLAN_MODE = "exit_plan_mode",
+	PERMISSION_REQUEST = "permission_request",
 	UNKNOWN = "unknown"
 }
 export interface ProtocolErrorMessage {
@@ -661,7 +832,7 @@ export interface ProtocolErrorMessage {
 export interface ProtocolResponseMessage {
 	type: `${ProtocolMessageType.RESPONSE}`;
 	id: ACPRequestId;
-	result: any;
+	result: unknown;
 }
 export interface ProtocolFileReadMessage {
 	type: `${ProtocolMessageType.FILE_READ}`;
@@ -678,35 +849,48 @@ export interface ProtocolSessionUpdateMessage {
 	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;
+	params: unknown;
 }
 export interface ProtocolToolUpdateMessage {
 	type: `${ProtocolMessageType.TOOL_UPDATE}`;
-	params: any;
+	params: unknown;
 }
 export interface ProtocolTaskFinishMessage {
 	type: `${ProtocolMessageType.TASK_FINISH}`;
-	params: any;
+	params: unknown;
+}
+export interface ProtocolAskUserQuestionsMessage {
+	type: `${ProtocolMessageType.ASK_USER_QUESTIONS}`;
+	requestId: ACPRequestId;
+	params: ACPAskUserQuestionsParams;
+}
+export interface ProtocolExitPlanModeMessage {
+	type: `${ProtocolMessageType.EXIT_PLAN_MODE}`;
+	requestId: ACPRequestId;
+	params: ACPExitPlanModeParams;
 }
 export interface ProtocolUnknownMessage {
 	type: `${ProtocolMessageType.UNKNOWN}`;
 	method: string;
-	params: any;
+	params: unknown;
+}
+export interface ProtocolPermissionRequestMessage {
+	type: `${ProtocolMessageType.PERMISSION_REQUEST}`;
+	requestId: ACPRequestId;
+	sessionId?: string;
+	toolCall: {
+		type?: string;
+		title?: string;
+	};
+	options: Array<{
+		optionId: string;
+	}>;
+	needsUserResponse: boolean;
 }
-export type ProtocolMessage = ProtocolErrorMessage | ProtocolResponseMessage | ProtocolFileReadMessage | ProtocolFileWriteMessage | ProtocolSessionUpdateMessage | ProtocolToolCallMessage | ProtocolToolUpdateMessage | ProtocolToolConfirmationMessage | ProtocolTaskFinishMessage | ProtocolUnknownMessage;
+export type ProtocolMessage = ProtocolErrorMessage | ProtocolResponseMessage | ProtocolFileReadMessage | ProtocolFileWriteMessage | ProtocolSessionUpdateMessage | ProtocolToolCallMessage | ProtocolToolUpdateMessage | ProtocolTaskFinishMessage | ProtocolAskUserQuestionsMessage | ProtocolExitPlanModeMessage | ProtocolUnknownMessage | ProtocolPermissionRequestMessage;
 export interface TextPrompt {
 	type: "text";
 	text: string;
@@ -729,6 +913,16 @@ export interface ResourceLinkPrompt {
 	size: number;
 }
 export type Prompt = TextPrompt | ImagePrompt | AudioPrompt | ResourceLinkPrompt;
+export type FilePath = string;
+export interface Selection {
+	type: "selection";
+	data: string;
+	uri: string;
+	line: {
+		start: number;
+		end: number;
+	};
+}
 /**
  * Protocol 类构造选项
  */
@@ -753,6 +947,9 @@ declare class Protocol {
 	private requestId;
 	private initialized;
 	private authenticated;
+	private pendingPermissionRequests;
+	private readonly maxPendingRequests;
+	private readonly requestTtl;
 	constructor(options: ProtocolOptions);
 	private nextRequestId;
 	private checkAuthenticated;
@@ -777,7 +974,7 @@ declare class Protocol {
 		commands?: CommandConfigs;
 		agents?: SubAgentConfigs;
 		settings?: SessionSettings;
-	}): Promise<string>;
+	}): Promise<ACPCreateSessionResult>;
 	loadSession(params: {
 		sessionId: string;
 		cwd?: string;
@@ -790,6 +987,19 @@ declare class Protocol {
 	cancelSession(params: {
 		sessionId: string;
 	}): Promise<void>;
+	setMode(params: {
+		sessionId: string;
+		modeId: string;
+	}): Promise<string>;
+	setModel(params: {
+		sessionId: string;
+		modelId: string;
+	}): Promise<string>;
+	setThink(params: ACPSetThinkParams): Promise<ACPSetThinkResult>;
+	respondToAskUserQuestions(requestId: ACPRequestId, answers: Record<string, string | string[]>): Promise<void>;
+	respondToExitPlanMode(requestId: ACPRequestId, approved: boolean): Promise<void>;
+	sendPermissionResponse(requestId: ACPRequestId, optionId: string): Promise<void>;
+	cancelPermissionResponse(requestId: ACPRequestId): Promise<void>;
 	handleMessages(): AsyncGenerator<ProtocolMessage>;
 	private handleClientMessage;
 	private handleReadTextFile;
@@ -799,6 +1009,8 @@ declare class Protocol {
 	private handlePushToolCall;
 	private handleUpdateToolCall;
 	private handleNotifyTaskFinish;
+	private handleAskUserQuestions;
+	private handleExitPlanMode;
 	private handleUnknownMessage;
 }
 /**
@@ -860,6 +1072,14 @@ export declare class IFlowClient {
 	private messageQueue;
 	/** 待处理的工具调用映射表，key 为工具调用 ID */
 	private pendingToolCalls;
+	/** 待处理的 ask_user_questions 请求 ID */
+	private pendingAskUserQuestionsRequestId;
+	/** 待处理的问题列表，用于验证答案 */
+	private pendingQuestions;
+	/** 待处理的 exit_plan_mode 请求 ID */
+	private pendingExitPlanModeRequestId;
+	/** 待处理的权限请求映射表，key 为 requestId，value 为权限请求信息 */
+	private pendingPermissionRequests;
 	/** WebSocket 连接 URL */
 	private url;
 	/** 当前会话 ID */
@@ -868,6 +1088,18 @@ export declare class IFlowClient {
 	private processManager;
 	/** 进程启动状态标识 */
 	private processStarted;
+	/** 会话模式数据 */
+	private modes;
+	/** 会话模型数据 */
+	private models;
+	/** 可用命令列表 */
+	private availableCommands;
+	/** 可用代理列表 */
+	private availableAgents;
+	/** 可用技能列表 */
+	private availableSkills;
+	/** 可用 MCP 服务器列表 */
+	private availableMcpServers;
 	/**
 	 * 构造函数 - 创建 IFlowClient 实例
 	 *
@@ -877,11 +1109,46 @@ export declare class IFlowClient {
 	connect(): Promise<void>;
 	loadSession(sessionId: string): Promise<void>;
 	disconnect(): Promise<void>;
-	sendMessage(text: string, files?: string[]): Promise<void>;
+	sendMessage(text: string, files?: Array<FilePath | ImagePrompt | Selection>): Promise<void>;
 	interrupt(): Promise<void>;
 	receiveMessages(): AsyncGenerator<Message>;
+	/**
+	 * @deprecated 此方法已弃用。请使用 respondToToolConfirmation 方法来处理工具权限确认。
+	 * 该方法不会实际影响工具执行，仅从本地状态中移除记录。
+	 */
 	approveToolCall(toolId: string, outcome?: `${ToolCallConfirmationOutcome}`): Promise<void>;
+	/**
+	 * @deprecated 此方法已弃用。请使用 cancelToolConfirmation 方法来处理工具权限确认。
+	 * 该方法不会实际影响工具执行，仅从本地状态中移除记录。
+	 */
 	rejectToolCall(toolId: string): Promise<void>;
+	respondToAskUserQuestions(answers: Record<string, string | string[]>): Promise<void>;
+	respondToExitPlanMode(approved: boolean): Promise<void>;
+	respondToToolConfirmation(requestId: number | string, optionId: string): Promise<void>;
+	cancelToolConfirmation(requestId: number | string): Promise<void>;
+	/**
+	 * 配置管理器，支持获取和设置会话配置
+	 */
+	readonly config: {
+		/**
+		 * 获取配置值
+		 * @param key 配置键，支持: models, model, modes, mode, commands, agents, skills, mcpServers
+		 * @returns 配置值
+		 */
+		get: <T>(key: string) => Promise<T>;
+		/**
+		 * 设置配置值
+		 * @param key 配置键，支持: model, mode
+		 * @param value 配置值
+		 */
+		set: <T>(key: string, value: T) => Promise<void>;
+	};
+	/**
+	 * 设置思考模式配置
+	 * @param params 思考配置参数
+	 * @returns 返回设置后的配置信息
+	 */
+	setThink(params: SetThinkParams): Promise<SetThinkResult>;
 	protected handleMessages(): Promise<void>;
 	protected processProtocolMessage(protocolMessage: ProtocolMessage): Message | null;
 }