@blade-hq/agent-client 1.1.1

package/public-api.md

@@ -0,0 +1,1103 @@
+# @blade-hq/agent-client 公共 API 报告
+
+> 本文件由 `scripts/public-api-report.mjs` 生成，请勿手改。
+> 公共面变更时重新生成本报告，并同步更新 README 对应章节——CI 会校验两者。
+
+共 104 个公开声明。
+
+## `ActiveCompactionState` (interface)
+
+```ts
+archived_count: number | null | undefined
+archived_files: ArchivedFileInfo[] | null | undefined
+archived_tool_calls: ArchivedToolCallInfo[] | null | undefined
+compaction_id: string
+failure_reason: string | null | undefined
+fallback_applied: boolean | null | undefined
+saved_ratio: number | null | undefined
+status: "streaming" | "completed" | "paused" | "failed" | "interrupted"
+summary_full: string | null | undefined
+summary_preview: string | null | undefined
+tokens_after: number | null | undefined
+tokens_before: number | null | undefined
+trigger: "auto" | "manual" | "forced_retry" | null | undefined
+turn_id: string
+```
+
+## `AgentLoopInfo` (interface)
+
+```ts
+description: string
+status: "running" | "done" | "error" | "cancelled" | "awaiting_answer"
+toolCallId: string
+```
+
+## `AgentSession` (class)
+
+```ts
+append: (text: string) => void
+attach: (label: string, data: unknown) => void
+compact: () => Promise<Record<string, unknown>>
+dispose: () => void
+getState: () => SessionState
+insertText: (text: string) => void
+isDisposed: boolean
+off: <K extends keyof AgentSessionEvents>(name: K, handler: (event: AgentSessionEvents[K]) => void) => void
+on: <K extends keyof AgentSessionEvents>(name: K, handler: (event: AgentSessionEvents[K]) => void) => () => void
+onCommand: (action: string, handler: CommandHandler) => () => void
+send: (content: MessageContent, options?: SendOptions) => Promise<void>
+sessionId: string
+stop: () => Promise<Record<string, unknown>>
+subscribe: (listener: () => void) => () => void
+```
+
+## `AgentSessionEventName` (type)
+
+```ts
+export type AgentSessionEventName = keyof AgentSessionEvents
+```
+
+## `AgentSessionEvents` (interface)
+
+```ts
+artifact: { filePath: string; contentType: string; title: string; content: string; oldString?: string; newString?: string; kind: "created" | "updated"; }
+attachRequested: { label: string; content: string; }
+backgroundTask: { id: string; command: string; description?: string; status: "running" | "done" | "failed"; exitCode?: number | null; elapsedSeconds: number; output?: string; }
+chatEnd: { status: string; }
+command: { action: string; payload: unknown; toolCallId?: string; }
+error: { message: string; }
+insertTextRequested: { text: string; }
+message: { message: ChatMessage; turn: TurnProjection; }
+modeChange: { mode: "planning" | "executing"; }
+notification: { type: string; title: string; detail?: string; status: "info" | "running" | "done" | "error"; loopId?: string; metadata?: Record<string, unknown>; }
+replayMismatch: { actualMessage?: string; expectedMessage?: string; respond: (decision: "keep_replay" | "continue_replay") => void; }
+rewind: { checkpointId: string; }
+sandboxOom: { toolCallId: string; }
+sessionUpdated: { intent?: string; status?: SessionStatus; model?: string | null; boundSkillId?: string | null; replayState?: Record<string, unknown> | null; }
+taskListUpdated: { tasks: unknown[]; }
+toolCall: { toolCall: ToolCallInfo; turn: TurnProjection; }
+toolPreview: { toolCallId: string; type: "resource-html" | "resource-uri"; content: string; title: string; }
+toolResult: { toolCall: ToolCallInfo; turn: TurnProjection; }
+workspaceChanged: { filePath?: string; }
+```
+
+## `ArchivedFileInfo` (interface)
+
+```ts
+filename: string | null | undefined
+relative_path: string | null | undefined
+size_bytes: number | null | undefined
+tool_name: string | null | undefined
+```
+
+## `ArchivedToolCallInfo` (interface)
+
+```ts
+archive_path: string | null | undefined
+entry_id: string | null | undefined
+replacement_content: string | null | undefined
+tool_call_id: string | null | undefined
+tool_name: string | null | undefined
+```
+
+## `AskUserAnswerData` (interface)
+
+```ts
+custom: Record<number, string>
+selections: Record<number, number[]>
+```
+
+## `AsrAudioPayload` (type)
+
+```ts
+export type AsrAudioPayload =
+  | ArrayBuffer
+  | Uint8Array
+  | { pcm: ArrayBuffer | Uint8Array; request_id?: string }
+```
+
+## `AuthResource` (class)
+
+```ts
+getMe: () => Promise<UserInfo>
+getProviders: () => Promise<ProvidersResponse>
+login: (options?: LoginOptions) => Promise<LoginResult>
+logout: () => Promise<{ logout_url: string; }>
+logoutToken: () => void
+```
+
+## `BackgroundTask` (interface)
+
+```ts
+command: string
+description: string | undefined
+elapsed_seconds: number
+exit_code: number | null | undefined
+finished_at: number | null | undefined
+heartbeat_at: number | null | undefined
+id: string
+legacy_status: "failed" | "running" | "done" | undefined
+log_path: string | null | undefined
+output: string | undefined
+output_lines_count: number | undefined
+output_preview: string[] | undefined
+started_at: number | null | undefined
+status: "failed" | "running" | "done" | "cancelled" | "queued" | "starting" | "succeeded" | "timeout" | "lost"
+```
+
+## `BizRole` (interface)
+
+```ts
+description: string | null | undefined
+id: string
+name: string
+preview: { url: string; title?: string | null; } | null | undefined
+```
+
+## `BladeApiError` (class)
+
+```ts
+cause: unknown
+message: string
+name: string
+response: Response
+stack: string | undefined
+status: number
+statusText: string
+```
+
+## `BladeClient` (class)
+
+```ts
+auth: AuthResource
+blob: (method: HttpMethod, path: string) => Promise<Blob>
+buildAuthedUrl: (path: string) => string
+ensureVersionCompatible: () => Promise<void>
+fetch: (method: HttpMethod, path: string, init?: BladeFetchInit, isRetry?: boolean) => Promise<Response>
+formData: (method: HttpMethod, path: string, form: FormData, options?: { expectOk?: boolean; onUploadProgress?: (progress: UploadProgress) => void; }) => Promise<Response>
+hasToken: () => boolean
+headless: HeadlessResource
+hub: SessionHub
+json: <T>(method: HttpMethod, path: string, body?: unknown) => Promise<T>
+jsonFromInit: <T>(path: string, init?: RequestInit) => Promise<T>
+login: (options?: LoginOptions) => Promise<LoginResult>
+logoutToken: () => void
+onSocketReplaced: (listener: () => void) => () => void
+options: BladeClientOptions
+responseFromInit: (path: string, init?: RequestInit) => Promise<Response>
+sessions: SessionsResource
+setBaseUrl: (baseUrl: string) => void
+setToken: (token: string | null) => void
+socket: () => TypedSocket
+text: (method: HttpMethod, path: string) => Promise<string>
+textFromInit: (path: string, init?: RequestInit) => Promise<string>
+token: string | null
+```
+
+## `BladeClientOptions` (interface)
+
+```ts
+baseUrl: string
+fetchImpl: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
+onRefreshSuccess: (() => void | Promise<void>) | undefined
+socketToken: string | (() => string | null | undefined) | undefined
+token: string | (() => string | null | undefined) | undefined
+tokenStorage: TokenStorageMode | undefined
+```
+
+## `buildMessageContent` (function)
+
+```ts
+buildMessageContent: (text: string, attachments: Array<{ kind: "file"; name: string; uploadedPath?: string; textContent?: string | null; mimeType?: string; }>) => MessageContent
+```
+
+## `ChatMessage` (interface)
+
+```ts
+blocks: ContentBlock[] | undefined
+compaction: CompactionInfo | undefined
+content: MessageContent
+duration_ms: number | undefined
+entry_id: string | undefined
+kind: string | undefined
+loop_name: string | undefined
+memory_refs: MemoryRefInfo[] | undefined
+parent_id: string | null | undefined
+reasoning: string | undefined
+role: "error" | "user" | "assistant" | "tool"
+status: "streaming" | "completed" | "paused" | "failed" | "interrupted" | undefined
+timestamp: string | undefined
+tool_calls: ToolCallInfo[] | undefined
+```
+
+## `ClientProjectionBuilder` (class)
+
+```ts
+processBatch: (events: RawEvent[]) => ProjectionUpdate[]
+processEvent: (event: RawEvent) => ProjectionUpdate[] | null
+reset: () => void
+seedSequence: (maxSeq: number) => void
+```
+
+## `CommandEnvelope` (interface)
+
+```ts
+action: string
+direction: "agent-to-host"
+meta: { sessionId: string; toolCallId?: string; timestamp: number; }
+payload: unknown
+```
+
+## `CommandHandler` (type)
+
+```ts
+export type CommandHandler = (payload: unknown, meta: { toolCallId?: string }) => void
+```
+
+## `CompactionInfo` (interface)
+
+```ts
+archived_count: number | null | undefined
+archived_files: ArchivedFileInfo[] | null | undefined
+archived_tool_calls: ArchivedToolCallInfo[] | null | undefined
+compaction_id: string
+failure_reason: string | null | undefined
+fallback_applied: boolean | null | undefined
+saved_ratio: number | null | undefined
+summary_full: string | null | undefined
+summary_preview: string | null | undefined
+tokens_after: number | null | undefined
+tokens_before: number | null | undefined
+trigger: "auto" | "manual" | "forced_retry" | null | undefined
+```
+
+## `connectEmbedded` (function)
+
+```ts
+connectEmbedded: (options: EmbeddedChatOptions) => EmbeddedChat
+```
+
+## `ConnectionStatus` (type)
+
+```ts
+export type ConnectionStatus = "connecting" | "connected" | "reconnecting" | "disconnected"
+```
+
+## `ContentBlock` (interface)
+
+```ts
+content: unknown
+display_name: string | null | undefined
+tool_call_id: string | null | undefined
+tool_name: string | null | undefined
+type: "text" | "thinking" | "tool_use" | "tool_result" | "tool_ui" | "tool_bridge" | "system_notification" | "mode_change" | "plan_status" | "ask_user_answer"
+```
+
+## `contentPreview` (function)
+
+```ts
+contentPreview: (content: MessageContent, maxLen?: number) => string
+```
+
+## `createInitialSessionState` (function)
+
+```ts
+createInitialSessionState: (sessionId: string) => SessionState
+```
+
+## `CreateSessionRequest` (interface)
+
+```ts
+biz_role_id: string | null | undefined
+compaction_ratio: number | null | undefined
+daemon_id: string | null | undefined
+disable_tools: string[] | null | undefined
+enable_thinking: boolean | null | undefined
+env: Record<string, string> | undefined
+intent: string | undefined
+memory_enabled: boolean | null | undefined
+model: string | null | undefined
+primary_skill_id: string | null | undefined
+runtime_type: "sandbox" | "daemon" | null | undefined
+session_solution_asset_id: string | null | undefined
+solution_id: string | undefined
+template_id: TemplateId | undefined
+```
+
+## `createSocket` (function)
+
+```ts
+createSocket: (options: CreateSocketOptions) => TypedSocket
+```
+
+## `CreateSocketOptions` (interface)
+
+```ts
+baseUrl: string
+path: string | undefined
+token: string | (() => string | null | undefined) | undefined
+```
+
+## `EmbeddedChat` (interface)
+
+```ts
+attach: (label: string, data: unknown) => void
+dispose: () => void
+insertText: (text: string) => void
+onCommand: (action: string, handler: CommandHandler) => () => void
+send: (text: string) => void
+```
+
+## `EmbeddedChatOptions` (interface)
+
+```ts
+allowedOrigins: string[]
+iframe: HTMLIFrameElement | undefined
+```
+
+## `ExistingSolutionRef` (interface)
+
+```ts
+bizRoleId: string | undefined
+kind: "existing"
+solutionId: string
+```
+
+## `extractTextAttachments` (function)
+
+```ts
+extractTextAttachments: (content: MessageContent) => { cleanText: string; attachments: ParsedTextAttachment[]; contexts: ParsedTextContext[]; }
+```
+
+## `FileContentPart` (interface)
+
+```ts
+data: string
+name: string
+type: "file"
+```
+
+## `FileEntry` (interface)
+
+```ts
+created_at: number
+is_dir: boolean
+name: string
+path: string
+tags: string[] | undefined
+```
+
+## `getFileParts` (function)
+
+```ts
+getFileParts: (content: MessageContent) => FileContentPart[]
+```
+
+## `getImageParts` (function)
+
+```ts
+getImageParts: (content: MessageContent) => ImageUrlContentPart[]
+```
+
+## `getTextContent` (function)
+
+```ts
+getTextContent: (content: MessageContent) => string
+```
+
+## `groupMessagesByLoop` (function)
+
+```ts
+groupMessagesByLoop: (messages: ChatMessage[]) => MessageGroup[]
+```
+
+## `HeadlessResource` (class)
+
+```ts
+run: { <T = unknown>(prompt: string, options: HeadlessRunOptions & { schema: JsonSchemaObject; }): Promise<T>; (prompt: string, options?: HeadlessRunOptions): Promise<string>; }
+runInSession: { <T = unknown>(sessionId: string, prompt: string, options: HeadlessRunOptions & { schema: JsonSchemaObject; }): Promise<T>; (sessionId: string, prompt: string, options?: HeadlessRunOptions): Promise<string>; }
+runWithSession: { <T = unknown>(prompt: string, options: HeadlessRunOptions & { schema: JsonSchemaObject; }): Promise<HeadlessRunInSessionResult<T>>; (prompt: string, options?: HeadlessRunOptions): Promise<HeadlessRunInSessionResult<string>>; }
+```
+
+## `ImageUrlContentPart` (interface)
+
+```ts
+image_url: { url: string; }
+type: "image_url"
+```
+
+## `InboundAction` (type)
+
+```ts
+export type InboundAction = "addContext" | "appendInput" | "sendMessage"
+```
+
+## `InboundEnvelope` (interface)
+
+```ts
+action: InboundAction
+direction: "host-to-agent"
+payload: unknown
+```
+
+## `isCommandEnvelope` (function)
+
+```ts
+isCommandEnvelope: (value: unknown) => value is CommandEnvelope
+```
+
+## `isHiddenInternalMessage` (function)
+
+```ts
+isHiddenInternalMessage: (message: Pick<ChatMessage, "role" | "content">) => boolean
+```
+
+## `isInboundEnvelope` (function)
+
+```ts
+isInboundEnvelope: (value: unknown) => value is InboundEnvelope
+```
+
+## `LayoutType` (enum)
+
+```ts
+export enum LayoutType {
+  Default = "default",
+  SkillEditor = "skill-editor",
+  BladeCoa = "blade-coa",
+  SolutionEditor = "solution-editor",
+  SolutionEditor2 = "solution-editor2",
+  ChatPreview = "chat-preview",
+  ChatOnly = "chat-only",
+  SolutionApp = "solution-app",
+  Custom = "custom",
+}
+```
+
+## `LoginOptions` (interface)
+
+```ts
+height: number | undefined
+timeoutMs: number | undefined
+width: number | undefined
+```
+
+## `LoginResult` (interface)
+
+```ts
+token: string
+user: { id?: string; username?: string; display_name?: string; } | undefined
+```
+
+## `MemoryRef` (interface)
+
+```ts
+content_preview: string
+id: number
+skill_name: string | null | undefined
+```
+
+## `MemoryRefInfo` (interface)
+
+```ts
+content_preview: string
+id: number
+skill_name: string | null | undefined
+```
+
+## `MessageContent` (type)
+
+```ts
+export type MessageContent = string | MessageContentPart[]
+```
+
+## `MessageContentPart` (type)
+
+```ts
+export type MessageContentPart = TextContentPart | ImageUrlContentPart | FileContentPart
+```
+
+## `MIN_SERVER_VERSION` (const)
+
+```ts
+MIN_SERVER_VERSION: "1.1.1"
+```
+
+## `ModeId` (type)
+
+```ts
+export type ModeId = "planning" | "executing"
+```
+
+## `normalizeMessageContent` (function)
+
+```ts
+normalizeMessageContent: (content: unknown) => MessageContent
+```
+
+## `PaginatedSessionsResult` (interface)
+
+```ts
+content_match_truncated: boolean | undefined
+items: SessionInfo[]
+limit: number
+offset: number
+total: number
+```
+
+## `ParsedTextAttachment` (interface)
+
+```ts
+name: string
+uploadedPath: string | undefined
+```
+
+## `ParsedTextContext` (interface)
+
+```ts
+content: string
+label: string
+```
+
+## `PatchEnvelope` (interface)
+
+```ts
+data: { turn?: TurnProjection; workspace_changed?: { tool_call_id?: string; tool_name?: string; }; }
+loop_id: string
+patch_type: string
+sequence: number
+turn_id: string
+```
+
+## `PreparedSolution` (interface)
+
+```ts
+assetId: string
+bizRoleId: string | undefined
+expiresAt: string
+kind: "prepared"
+roles: string[]
+solutionId: string
+```
+
+## `PreparedSolutionAsset` (interface)
+
+```ts
+assetId: string
+bizRoleId: string | undefined
+kind: "prepared"
+```
+
+## `PrimarySkillParallelMode` (interface)
+
+```ts
+id: string
+name: string
+prompt_hint: string
+```
+
+## `PrimarySkillSnapshot` (interface)
+
+```ts
+captured_at: string
+description: string
+parallel_modes: PrimarySkillParallelMode[]
+skill_id: string
+stages: PrimarySkillStageSpec[]
+title: string
+version: number
+```
+
+## `ProvidersResponse` (interface)
+
+```ts
+password_enabled: boolean
+providers: { name: string; authorize_url: string; }[]
+```
+
+## `RawEvent` (interface)
+
+```ts
+payload: Record<string, unknown>
+type: string
+```
+
+## `RunOptions` (interface)
+
+```ts
+compactionRatio: number | undefined
+headless: boolean | undefined
+model: string | undefined
+outputSchema: Record<string, unknown> | undefined
+runtimeEnv: Record<string, string> | undefined
+timeoutMs: number | undefined
+trace: boolean | undefined
+```
+
+## `RunResult` (interface)
+
+```ts
+chatRunId: string | undefined
+events: unknown[]
+result: unknown
+sessionId: string
+```
+
+## `RunTrace` (interface)
+
+```ts
+configSnapshot: Record<string, unknown>
+events: unknown[]
+history: unknown[]
+result: unknown
+```
+
+## `SDK_NAME` (const)
+
+```ts
+SDK_NAME: "agent-client"
+```
+
+## `SDK_VERSION` (const)
+
+```ts
+SDK_VERSION: "2.0.0"
+```
+
+## `SendOptions` (interface)
+
+```ts
+askUserAnswer: Record<string, unknown> | undefined
+mode: string | undefined
+model: string | undefined
+replayDecision: "keep_replay" | "continue_replay" | undefined
+thinkingOverride: boolean | undefined
+whatif: { from_step: number; quotes: Array<Record<string, unknown>>; deprecate_entry_ids: string[]; } | undefined
+```
+
+## `ServerVersionInfo` (interface)
+
+```ts
+min_sdk: string | undefined
+version: string
+```
+
+## `SessionContextStats` (interface)
+
+```ts
+compaction_ratio: number
+context_window: number
+tokens_used: number
+```
+
+## `SessionDetail` (interface)
+
+```ts
+biz_role_id: string | null | undefined
+bound_skill_id: string | null | undefined
+created_at: string
+daemon_id: string | null | undefined
+disable_tools: (string[] & string[]) | undefined
+enable_thinking: boolean | null | undefined
+env: Record<string, string> | undefined
+id: string
+intent: string
+is_example: boolean | undefined
+is_headless: boolean | undefined
+is_persistent: boolean | undefined
+is_pinned: boolean | undefined
+match: SessionSearchMatch | null | undefined
+memory_enabled: boolean | undefined
+model: string | null | undefined
+pinned_at: string | null | undefined
+plan_summary: string | null | undefined
+ports: SessionPortMapping[] | undefined
+preview_url: string | null | undefined
+primary_skill_id: string | null | undefined
+primary_skill_snapshot: PrimarySkillSnapshot | null | undefined
+replay_state: ReplayState | null | undefined
+runtime_type: string | null | undefined
+shared: boolean | undefined
+solution: Solution | null | undefined
+solution_id: string | null | undefined
+status: "completed" | "failed" | "interrupted" | "running" | "created" | "waiting_for_input"
+template_id: TemplateId | null | undefined
+updated_at: string
+viewer_role: "owner" | "viewer" | undefined
+```
+
+## `SessionHistory` (interface)
+
+```ts
+active_branch: string | null
+branches: string[]
+nodes: HistoryNode[]
+system_prompt_tokens: number | null | undefined
+tokenizer_model: string | null | undefined
+tools_tokens: number | null | undefined
+```
+
+## `SessionHub` (class)
+
+```ts
+connect: (sessionId: string) => Promise<AgentSession>
+disconnect: () => void
+disposeAll: () => void
+getConnection: () => ConnectionStatus
+onConnectionChange: (listener: (status: ConnectionStatus) => void) => () => void
+peek: (sessionId: string) => AgentSession | undefined
+reconnect: () => void
+```
+
+## `SessionInfo` (type)
+
+```ts
+SessionInfo = type({
+  id: "string",
+  intent: "string",
+  status: SessionStatus,
+  created_at: "string",
+  updated_at: "string",
+  "shared?": "boolean",
+  "memory_enabled?": "boolean",
+  "is_persistent?": "boolean",
+  "is_headless?": "boolean",
+  "viewer_role?": "'owner' | 'viewer'",
+  "template_id?": "string | null",
+  "model?": "string | null",
+  "enable_thinking?": "boolean | null",
+  "solution_id?": "string | null",
+  "biz_role_id?": "string | null",
+  "solution?": "unknown",
+  "plan_summary?": "string | null",
+  "primary_skill_id?": "string | null",
+  // ship-attack v2：后端 engine.set_bound_skill 写入的"绑定 skill id"。
+  // 未绑定 / 非 ship-attack session 为 null。
+  "bound_skill_id?": "string | null",
+  "replay_state?": "unknown",
+  "is_pinned?": "boolean",
+  "pinned_at?": "string | null",
+  "is_example?": "boolean",
+  "ports?": "unknown",
+  "disable_tools?": "string[]",
+  "runtime_type?": "string | null",
+  "daemon_id?": "string | null",
+  "match?": "unknown",
+})
+```
+
+## `SessionPortMapping` (interface)
+
+```ts
+container_port: number
+host_port: number
+```
+
+## `SessionProfile` (interface)
+
+```ts
+compactionRatio: number | undefined
+disableTools: string[] | undefined
+enableThinking: boolean | undefined
+env: Record<string, string> | undefined
+memoryEnabled: boolean | undefined
+model: string | undefined
+solution: SolutionRef | undefined
+```
+
+## `SessionsResource` (class)
+
+```ts
+checkoutSession: (sessionId: string, checkpointId: string, position: "before" | "turn_end", mode?: "both" | "conversation" | "code", linear?: boolean) => Promise<{ id: string; content: string; position: string; mode?: string; files_restored?: boolean; linear?: boolean; }>
+connect: (sessionId: string) => Promise<AgentSession>
+copyFile: (sessionId: string, filePath: string) => Promise<{ path: string; }>
+create: (request?: CreateSessionRequest) => Promise<AgentSession>
+createSession: (intent?: string, template_id?: TemplateId, primary_skill_id?: string | null) => Promise<{ session_id: string; }>
+createSessionWithRequest: (request: CreateSessionRequest) => Promise<{ session_id: string; }>
+createShare: (sessionId: string) => Promise<ShareLinkResult>
+createWithProfile: (params: { intent: string; profile: SessionProfile; }) => Promise<{ session_id: string; }>
+deleteFile: (sessionId: string, filePath: string) => Promise<void>
+deleteSession: (sessionId: string) => Promise<{ deleted: boolean; }>
+exportSession: (sessionId: string) => Promise<void>
+getBackgroundTask: (sessionId: string, taskId: string, tail?: number, init?: RequestInit) => Promise<BackgroundTask>
+getDownloadDirUrl: (sessionId: string, dirPath: string) => string
+getSession: (sessionId: string, init?: RequestInit) => Promise<SessionDetail>
+getSessionCheckpoints: (sessionId: string, init?: RequestInit) => Promise<{ nodes: CheckpointNode[]; leaf_id: string | null; }>
+getSessionContextStats: (sessionId: string, init?: RequestInit) => Promise<SessionContextStats>
+getSessionHistory: (sessionId: string, init?: RequestInit) => Promise<SessionHistory>
+getSessionTasks: (sessionId: string) => Promise<Task[]>
+getSessionTurns: (sessionId: string) => Promise<TurnProjection[]>
+getSharedSession: (token: string) => Promise<TurnProjection[]>
+importSession: (file: File, name?: string, solutionId?: string | null) => Promise<{ session_id: string; }>
+listBackgroundTasks: (sessionId: string, init?: RequestInit) => Promise<BackgroundTask[]>
+listDir: (sessionId: string, dirPath: string) => Promise<FileEntry[]>
+listSessions: (template_id_prefix?: string, solution_id?: string) => Promise<SessionInfo[]>
+listSessionsPaginated: (params: { limit: number; offset: number; template_id_prefix?: string; solution_id?: string; q?: string; }) => Promise<PaginatedSessionsResult>
+listSessionsWithSkillData: () => Promise<SkillDevSession[]>
+pinSession: (sessionId: string, pinned: boolean) => Promise<SessionInfo>
+previewImport: (file: File) => Promise<ImportPreview>
+probeSessionUrl: (sessionId: string, url: string) => Promise<{ reachable: boolean; }>
+renameFile: (sessionId: string, filePath: string, newName: string) => Promise<{ path: string; }>
+revokeShare: (sessionId: string, token: string) => Promise<{ revoked: boolean; }>
+rewindSession: (sessionId: string, checkpointId: string) => Promise<{ id: string; content: string; }>
+setSessionEnv: (sessionId: string, env: Record<string, string>) => Promise<SessionDetail>
+shareFile: (sessionId: string, sourcePath: string, linkName?: string, shareFolder?: string) => Promise<{ path: string; target: string; }>
+startReplaySession: (sourceSessionId: string, speed?: 1 | 2 | 5) => Promise<{ session_id: string; }>
+stopBackgroundTask: (sessionId: string, taskId: string) => Promise<{ message: string; task?: BackgroundTask | null; }>
+switchBranch: (sessionId: string, checkpointId: string) => Promise<{ id: string; leaf_id: string; }>
+tokenizeMessages: (messages: Array<Record<string, unknown>>, options?: { model?: string; add_generation_prompt?: boolean; enable_thinking?: boolean | null; tools?: Array<Record<string, unknown>>; }) => Promise<TokenizeResult>
+tokenizePrompt: (prompt: string, model?: string) => Promise<TokenizeResult>
+updateReplaySession: (sessionId: string, payload: { speed?: 1 | 2 | 5; status?: "autonomous"; }) => Promise<{ replay_state: SessionInfo["replay_state"]; }>
+updateSession: (sessionId: string, payload: { intent?: string; }) => Promise<SessionDetail>
+updateSessionMemory: (sessionId: string, memoryEnabled: boolean) => Promise<{ memory_enabled: boolean; }>
+updateSharing: (sessionId: string, shared: boolean) => Promise<{ shared: boolean; }>
+uploadFiles: (sessionId: string, dirPath: string, files: FileList | File[] | UploadFileEntry[], options?: UploadFilesOptions) => Promise<{ uploaded: string[]; failed: string[]; }>
+writeFile: (sessionId: string, filePath: string, content: string) => Promise<{ success: boolean; }>
+```
+
+## `SessionState` (interface)
+
+```ts
+activeCompaction: ActiveCompactionState | null
+agentLoops: Record<string, AgentLoopInfo>
+askAnswers: Record<string, AskUserAnswerData>
+connection: ConnectionStatus
+errorMessage: string | null
+isStreaming: boolean
+messages: ChatMessage[]
+mode: "planning" | "executing" | null
+sessionId: string
+status: "completed" | "failed" | "interrupted" | "running" | "created" | "waiting_for_input" | null
+turns: TurnProjection[]
+```
+
+## `SessionStatus` (type)
+
+```ts
+SessionStatus = type(
+  "'created' | 'running' | 'completed' | 'failed' | 'interrupted' | 'waiting_for_input'",
+)
+```
+
+## `ShareLinkResult` (interface)
+
+```ts
+expires_at: string | null
+token: string
+url: string
+```
+
+## `Solution` (interface)
+
+```ts
+data: Record<string, unknown> | null | undefined
+description: string | null | undefined
+id: string
+initial_message: string | null | undefined
+initial_mode: string | null | undefined
+layout: { available?: boolean; source_dir?: string; entry?: string; export?: string; } | null | undefined
+layout_type: string
+name: string
+preview: { url: string; title?: string | null; } | null | undefined
+roles: BizRole[] | null | undefined
+source: string | null | undefined
+ui_config: SolutionAppUiConfig | null | undefined
+version: string
+```
+
+## `SolutionAppField` (type)
+
+```ts
+export type SolutionAppField =
+  | {
+      id: string
+      kind: "textarea"
+      label: string
+      placeholder?: string
+    }
+  | {
+      id: string
+      kind: "file-upload"
+      accept?: string[]
+      categories?: Array<{
+        label: string
+        description: string
+        color: string
+      }>
+    }
+```
+
+## `SolutionAppState` (interface)
+
+```ts
+meta: Record<string, { label: string; value: string; color?: string; }>
+pipeline: { id: string; label: string; status: "done" | "active" | "pending" | "error"; }[]
+```
+
+## `SolutionAppUiConfig` (interface)
+
+```ts
+branding: { name: string; subtitle?: string; icon_text: string; icon_gradient?: string; }
+create: { title: string; description?: string; submit_button: string; sections: Array<{ id: string; title: string; description?: string; fields: Array<SolutionAppField>; }>; }
+list: { title: string; create_button: string; card?: { subtitle?: string; stats?: Array<{ label: string; value: string; color?: string; }>; }; }
+```
+
+## `SolutionRef` (type)
+
+```ts
+export type SolutionRef = ExistingSolutionRef | PreparedSolutionAsset
+```
+
+## `Task` (type)
+
+```ts
+Task = type({
+  id: "string",
+  goal: "string",
+  skills: "string[]",
+  depends_on: "string[]",
+  status: TaskStatus,
+  result_summary: "string",
+  number: "string",
+})
+```
+
+## `TaskStatus` (type)
+
+```ts
+TaskStatus = type("'pending' | 'in_progress' | 'done' | 'failed' | 'skipped'")
+```
+
+## `TemplateId` (type)
+
+```ts
+export type TemplateId =
+  | "default"
+  | "skill_editor"
+  // ship-attack v2：用户从 ship-attack 页面点"新建 session"创建的会话。
+  // 后端 _maybe_bind_first_skill 只对此模板触发首次绑定。
+  | "ship_attack"
+```
+
+## `TextContentPart` (interface)
+
+```ts
+text: string
+type: "text"
+```
+
+## `TokenStorageMode` (type)
+
+```ts
+export type TokenStorageMode = "local" | "memory"
+```
+
+## `ToolBridgeContent` (interface)
+
+```ts
+action: string
+payload: unknown
+```
+
+## `ToolCallInfo` (interface)
+
+```ts
+arguments: string
+display_name: string | null | undefined
+duration_ms: number | null | undefined
+id: string
+name: string
+pending_question_ref: PendingQuestionRef | null | undefined
+result: unknown
+status: "done" | "error" | "cancelled" | "awaiting_answer" | "pending" | undefined
+```
+
+## `transformSlashCommand` (function)
+
+```ts
+transformSlashCommand: (skillName: string, rawInput: string) => string
+```
+
+## `TurnProjection` (interface)
+
+```ts
+archived_count: number | null | undefined
+archived_files: ArchivedFileInfo[] | null | undefined
+archived_tool_calls: ArchivedToolCallInfo[] | null | undefined
+blocks: ContentBlock[]
+compaction_id: string | null | undefined
+context_window: number | undefined
+duration_ms: number | undefined
+failure_reason: string | null | undefined
+fallback_applied: boolean | null | undefined
+id: string
+kind: "message" | "compaction" | undefined
+loop_id: string
+memory_refs: MemoryRef[] | null | undefined
+model: string | null | undefined
+parent_fork_tool_call_id: string | null | undefined
+role: "user" | "assistant" | "system"
+saved_ratio: number | null | undefined
+sequence: number
+started_at: string | null | undefined
+status: "streaming" | "completed" | "paused" | "failed" | "interrupted"
+summary_full: string | null | undefined
+summary_preview: string | null | undefined
+tokens_after: number | null | undefined
+tokens_before: number | null | undefined
+tool_calls: ToolCallProjection[]
+trigger: "auto" | "manual" | "forced_retry" | null | undefined
+turn_id: string
+usage: Record<string, unknown> | null | undefined
+```
+
+## `TypedSocket` (type)
+
+```ts
+export type TypedSocket = Socket<ServerToClientEvents, ClientToServerEvents>
+```
+
+## `UploadFileEntry` (type)
+
+```ts
+export type UploadFileEntry = File | { file: File; name: string }
+```
+
+## `UploadFilesOptions` (interface)
+
+```ts
+onProgress: ((progress: UploadProgress) => void) | undefined
+```
+
+## `UploadProgress` (interface)
+
+```ts
+loaded: number
+percent: number | undefined
+total: number | undefined
+```
+
+## `UserInfo` (interface)
+
+```ts
+auth_type: "casdoor"
+avatar_url: string | null
+display_name: string | null | undefined
+id: string
+is_admin: boolean | undefined
+token: string
+username: string
+```
+
+## `VersionMismatchError` (class)
+
+```ts
+cause: unknown
+hint: string
+message: string
+name: string
+sdkVersion: string
+serverVersion: string | null
+stack: string | undefined
+```
+