@sanqianx/claude-ai-workbench 0.13.2 → 0.13.4

package/packages/client/README.md

@@ -1,29 +1,29 @@
-# @claude-ai-workbench/client
-
-浏览器和 Node.js 使用的 HTTP/SSE Client SDK。
-
-```js
-const { createClaudeWorkbenchClient } = require("@claude-ai-workbench/client");
-const client = createClaudeWorkbenchClient({ apiBase: "http://127.0.0.1:5760/api/claude-workbench/v1" });
-const profiles = await client.listProfiles();
-```
-
-浏览器也可直接加载 `index.js`，然后使用全局函数 `createClaudeWorkbenchClient`。
-
-## 原生任务历史（只读）
-
-```js
-const page = await client.listNativeTasks(sessionId, { storeScope, contextId });
-const ref = page.tasks.find((t) => t.taskRef)?.taskRef; // null = 尚未建立归属
-if (ref) {
-  let events = await client.loadNativeTaskHistory(sessionId, { taskRef: ref });
-  while (events.hasMore) {
-    events = await client.loadNativeTaskHistory(sessionId, { taskRef: ref, cursor: events.nextCursor });
-  }
-}
-```
-
-- `listNativeTasks` 必须传服务端身份（health 的 `taskIdentity.storeScope`）与该会话真实 `contextId`，逐项比对不符即 409。
-- `loadNativeTaskHistory` 需要列表页返回的完整 `NativeTaskRef`（含全部身份字段），不能缩成 taskId；cursor 只回传上一页的 `nextCursor`，不得自行构造。
-- 两个方法均为纯读取：不派发输入、不停止任务、不自动重试。响应中的 `incomplete`/`diagnostics` 如实反映日志扫描的已知缺口。
-- 失败抛出的 Error 带 `status` 与 `body`，服务器提供时还带 `code`（如 `SCOPE_MISMATCH`、`HISTORY_NOT_FOUND`、写失败闩锁的具体原因）与 `resync: true`（409：从任务列表重新同步）；503 表示历史暂不可读或写失败已闩锁，原文件保持不动。
+# @claude-ai-workbench/client
+
+浏览器和 Node.js 使用的 HTTP/SSE Client SDK。
+
+```js
+const { createClaudeWorkbenchClient } = require("@claude-ai-workbench/client");
+const client = createClaudeWorkbenchClient({ apiBase: "http://127.0.0.1:5760/api/claude-workbench/v1" });
+const profiles = await client.listProfiles();
+```
+
+浏览器也可直接加载 `index.js`，然后使用全局函数 `createClaudeWorkbenchClient`。
+
+## 原生任务历史（只读）
+
+```js
+const page = await client.listNativeTasks(sessionId, { storeScope, contextId });
+const ref = page.tasks.find((t) => t.taskRef)?.taskRef; // null = 尚未建立归属
+if (ref) {
+  let events = await client.loadNativeTaskHistory(sessionId, { taskRef: ref });
+  while (events.hasMore) {
+    events = await client.loadNativeTaskHistory(sessionId, { taskRef: ref, cursor: events.nextCursor });
+  }
+}
+```
+
+- `listNativeTasks` 必须传服务端身份（health 的 `taskIdentity.storeScope`）与该会话真实 `contextId`，逐项比对不符即 409。
+- `loadNativeTaskHistory` 需要列表页返回的完整 `NativeTaskRef`（含全部身份字段），不能缩成 taskId；cursor 只回传上一页的 `nextCursor`，不得自行构造。
+- 两个方法均为纯读取：不派发输入、不停止任务、不自动重试。响应中的 `incomplete`/`diagnostics` 如实反映日志扫描的已知缺口。
+- 失败抛出的 Error 带 `status` 与 `body`，服务器提供时还带 `code`（如 `SCOPE_MISMATCH`、`HISTORY_NOT_FOUND`、写失败闩锁的具体原因）与 `resync: true`（409：从任务列表重新同步）；503 表示历史暂不可读或写失败已闩锁，原文件保持不动。

package/packages/client/index.d.ts

@@ -1,122 +1,122 @@
-import type {
-  AgentId,
-  AgentStatus,
-  AiProfile,
-  AiProfileInput,
-  CredentialInput,
-  DelegationAcceptResult,
-  DelegationCommandInput,
-  DelegationListPage,
-  EffortLevel,
-  HealthResult,
-  PermissionMode,
-  ProfileTestResult,
-  Project,
-  ProjectInput,
-  ProjectPatch,
-  RuntimeInfo,
-  NativeTaskEventsPage,
-  NativeTaskListPage,
-  NativeTaskRef,
-  AttachmentInput,
-  SlashCommand,
-  SessionSnapshot,
-  SessionHistoryPage,
-  SessionSummary,
-  SessionChangeEvent,
-  WorkbenchContext,
-  WorkbenchEvent,
-} from "@claude-ai-workbench/contracts";
-
-export interface RequestOptions { signal?: AbortSignal; [key: string]: unknown; }
-export interface StartSessionOptions extends RequestOptions {
-  permissionMode?: PermissionMode;
-  agentId?: AgentId;
-  effort?: EffortLevel;
-  aiProfileId?: string | null;
-  model?: string | null;
-  inputOrigin?: 'human' | 'agent-delegation' | 'unknown';
-}
-export interface ListSessionsOptions extends RequestOptions { archived?: boolean; includeArchived?: boolean; }
-export interface SendOptions { permissionMode?: PermissionMode; [key: string]: unknown; }
-// Scope echo the server compares against its own frozen identity: exactly
-// the fields from the trusted task scope, never client-invented ones.
-export interface NativeTaskScopeQuery { storeScope: string; contextId: string; }
-// One task's durable history page request. taskRef must be the full
-// reference echoed from a list result - reducing it to taskId cannot address
-// the task.
-export interface LoadNativeTaskHistoryOptions extends RequestOptions {
-  taskRef: NativeTaskRef;
-  cursor?: string | null;
-  limit?: number;
-}
-// Scope echo the server compares against its own frozen identity for
-// delegation reads; same contract as NativeTaskScopeQuery.
-export interface DelegationScopeQuery { storeScope: string; contextId: string; }
-// Thrown for every non-2xx response; status/body always carry the raw HTTP
-// truth, code/resync mirror the structured server verdict when present
-// (e.g. 409 SCOPE_MISMATCH with resync, or a 503 latched write-failure code).
-export interface WorkbenchRequestError extends Error {
-  status: number;
-  body: Record<string, unknown> | null;
-  code?: string;
-  resync?: boolean;
-}
-export interface StreamHandlers {
-  onEvent?: (event: WorkbenchEvent) => void;
-  onError?: (error: Error) => void;
-  onOpen?: () => void;
-  afterSequence?: number;
-}
-export interface ClientResourceCounts { streams: number; requests: number; reconnects: number; }
-export interface ClaudeWorkbenchClientOptions {
-  apiBase?: string;
-  fetch?: typeof fetch;
-  EventSource?: typeof EventSource;
-  readTimeoutMs?: number;
-}
-
-export interface ClaudeWorkbenchClient {
-  health(): Promise<HealthResult>;
-  runtime(): Promise<RuntimeInfo>;
-  listAgents(): Promise<AgentStatus[]>;
-  agentStatus(): Promise<{ agents: AgentStatus[]; scan?: { state: string; generation: number; updatedAt: string | null } }>;
-  refreshAgents(): ReturnType<ClaudeWorkbenchClient['agentStatus']>;
-  listProjects(): Promise<Project[]>;
-  createProject(project: ProjectInput): Promise<Project>;
-  getProject(id: string): Promise<Project>;
-  renameProject(id: string, name: string): Promise<Project>;
-  updateProject(id: string, patch: ProjectPatch): Promise<Project>;
-  removeProject(id: string): Promise<void>;
-  listProfiles(): Promise<AiProfile[]>;
-  saveProfile(profile: AiProfileInput): Promise<AiProfile>;
-  deleteProfile(id: string): Promise<void>;
-  setCredential(id: string, credential: string | CredentialInput): Promise<void>;
-  testProfile(id: string): Promise<ProfileTestResult>;
-  testProfileDraft(profile: AiProfileInput, credential?: string): Promise<ProfileTestResult>;
-  listSessions(context: WorkbenchContext | string, options?: ListSessionsOptions): Promise<SessionSummary[]>;
-  startSession(context: WorkbenchContext, options?: StartSessionOptions): Promise<SessionSummary>;
-  loadSession(id: string, options?: RequestOptions): Promise<SessionSnapshot>;
-  loadHistory(id: string, options?: RequestOptions & { before?: string; limit?: number }): Promise<SessionHistoryPage>;
-  listNativeTasks(id: string, scope: NativeTaskScopeQuery, options?: RequestOptions): Promise<NativeTaskListPage>;
-  loadNativeTaskHistory(id: string, options: LoadNativeTaskHistoryOptions): Promise<NativeTaskEventsPage>;
-  createDelegation(id: string, payload: DelegationCommandInput, options?: RequestOptions): Promise<DelegationAcceptResult>;
-  listDelegations(id: string, scope: DelegationScopeQuery, options?: RequestOptions): Promise<DelegationListPage>;
-  listCommands(id: string, options?: RequestOptions): Promise<SlashCommand[]>;
-  subscribe(id: string, handlers: StreamHandlers | ((event: WorkbenchEvent) => void), onError?: (error: Error) => void, options?: {afterSequence?: number}): () => void;
-  subscribeSessionChanges(contextId: string, handlers: ((event: SessionChangeEvent) => void), onError?: (error: Error) => void, options?: {afterRevision?: number; onOpen?: () => void}): () => void;
-  send(sessionId: string, text: string, options?: SendOptions): Promise<unknown>;
-  send(args: {sessionId: string; text?: string; attachments?: AttachmentInput[]; options?: SendOptions}): Promise<unknown>;
-  resolvePermission(sessionId: string, requestId: string, allow: boolean, message?: string): Promise<unknown>;
-  resolvePermission(args: {sessionId: string; requestId: string; allow: boolean; message?: string}): Promise<unknown>;
-  abort(sessionId: string | {sessionId: string}): Promise<unknown>;
-  setPermissionMode(sessionId: string, mode: PermissionMode): Promise<unknown>;
-  setPermissionMode(args: {sessionId: string; mode: PermissionMode}): Promise<unknown>;
-  archiveSession(sessionId: string | {sessionId: string}): Promise<{sessionId: string; archivedAt: string}>;
-  restoreSession(sessionId: string | {sessionId: string}): Promise<void>;
-  resourceCounts(): ClientResourceCounts;
-  destroy(): void;
-}
-
-export declare const EVENT_TYPES: readonly string[];
-export declare function createClaudeWorkbenchClient(options?: ClaudeWorkbenchClientOptions): ClaudeWorkbenchClient;
+import type {
+  AgentId,
+  AgentStatus,
+  AiProfile,
+  AiProfileInput,
+  CredentialInput,
+  DelegationAcceptResult,
+  DelegationCommandInput,
+  DelegationListPage,
+  EffortLevel,
+  HealthResult,
+  PermissionMode,
+  ProfileTestResult,
+  Project,
+  ProjectInput,
+  ProjectPatch,
+  RuntimeInfo,
+  NativeTaskEventsPage,
+  NativeTaskListPage,
+  NativeTaskRef,
+  AttachmentInput,
+  SlashCommand,
+  SessionSnapshot,
+  SessionHistoryPage,
+  SessionSummary,
+  SessionChangeEvent,
+  WorkbenchContext,
+  WorkbenchEvent,
+} from "@claude-ai-workbench/contracts";
+
+export interface RequestOptions { signal?: AbortSignal; [key: string]: unknown; }
+export interface StartSessionOptions extends RequestOptions {
+  permissionMode?: PermissionMode;
+  agentId?: AgentId;
+  effort?: EffortLevel;
+  aiProfileId?: string | null;
+  model?: string | null;
+  inputOrigin?: 'human' | 'agent-delegation' | 'unknown';
+}
+export interface ListSessionsOptions extends RequestOptions { archived?: boolean; includeArchived?: boolean; }
+export interface SendOptions { permissionMode?: PermissionMode; [key: string]: unknown; }
+// Scope echo the server compares against its own frozen identity: exactly
+// the fields from the trusted task scope, never client-invented ones.
+export interface NativeTaskScopeQuery { storeScope: string; contextId: string; }
+// One task's durable history page request. taskRef must be the full
+// reference echoed from a list result - reducing it to taskId cannot address
+// the task.
+export interface LoadNativeTaskHistoryOptions extends RequestOptions {
+  taskRef: NativeTaskRef;
+  cursor?: string | null;
+  limit?: number;
+}
+// Scope echo the server compares against its own frozen identity for
+// delegation reads; same contract as NativeTaskScopeQuery.
+export interface DelegationScopeQuery { storeScope: string; contextId: string; }
+// Thrown for every non-2xx response; status/body always carry the raw HTTP
+// truth, code/resync mirror the structured server verdict when present
+// (e.g. 409 SCOPE_MISMATCH with resync, or a 503 latched write-failure code).
+export interface WorkbenchRequestError extends Error {
+  status: number;
+  body: Record<string, unknown> | null;
+  code?: string;
+  resync?: boolean;
+}
+export interface StreamHandlers {
+  onEvent?: (event: WorkbenchEvent) => void;
+  onError?: (error: Error) => void;
+  onOpen?: () => void;
+  afterSequence?: number;
+}
+export interface ClientResourceCounts { streams: number; requests: number; reconnects: number; }
+export interface ClaudeWorkbenchClientOptions {
+  apiBase?: string;
+  fetch?: typeof fetch;
+  EventSource?: typeof EventSource;
+  readTimeoutMs?: number;
+}
+
+export interface ClaudeWorkbenchClient {
+  health(): Promise<HealthResult>;
+  runtime(): Promise<RuntimeInfo>;
+  listAgents(): Promise<AgentStatus[]>;
+  agentStatus(): Promise<{ agents: AgentStatus[]; scan?: { state: string; generation: number; updatedAt: string | null } }>;
+  refreshAgents(): ReturnType<ClaudeWorkbenchClient['agentStatus']>;
+  listProjects(): Promise<Project[]>;
+  createProject(project: ProjectInput): Promise<Project>;
+  getProject(id: string): Promise<Project>;
+  renameProject(id: string, name: string): Promise<Project>;
+  updateProject(id: string, patch: ProjectPatch): Promise<Project>;
+  removeProject(id: string): Promise<void>;
+  listProfiles(): Promise<AiProfile[]>;
+  saveProfile(profile: AiProfileInput): Promise<AiProfile>;
+  deleteProfile(id: string): Promise<void>;
+  setCredential(id: string, credential: string | CredentialInput): Promise<void>;
+  testProfile(id: string): Promise<ProfileTestResult>;
+  testProfileDraft(profile: AiProfileInput, credential?: string): Promise<ProfileTestResult>;
+  listSessions(context: WorkbenchContext | string, options?: ListSessionsOptions): Promise<SessionSummary[]>;
+  startSession(context: WorkbenchContext, options?: StartSessionOptions): Promise<SessionSummary>;
+  loadSession(id: string, options?: RequestOptions): Promise<SessionSnapshot>;
+  loadHistory(id: string, options?: RequestOptions & { before?: string; limit?: number }): Promise<SessionHistoryPage>;
+  listNativeTasks(id: string, scope: NativeTaskScopeQuery, options?: RequestOptions): Promise<NativeTaskListPage>;
+  loadNativeTaskHistory(id: string, options: LoadNativeTaskHistoryOptions): Promise<NativeTaskEventsPage>;
+  createDelegation(id: string, payload: DelegationCommandInput, options?: RequestOptions): Promise<DelegationAcceptResult>;
+  listDelegations(id: string, scope: DelegationScopeQuery, options?: RequestOptions): Promise<DelegationListPage>;
+  listCommands(id: string, options?: RequestOptions): Promise<SlashCommand[]>;
+  subscribe(id: string, handlers: StreamHandlers | ((event: WorkbenchEvent) => void), onError?: (error: Error) => void, options?: {afterSequence?: number; onOpen?: () => void}): () => void;
+  subscribeSessionChanges(contextId: string, handlers: ((event: SessionChangeEvent) => void), onError?: (error: Error) => void, options?: {afterRevision?: number; onOpen?: () => void}): () => void;
+  send(sessionId: string, text: string, options?: SendOptions): Promise<unknown>;
+  send(args: {sessionId: string; text?: string; attachments?: AttachmentInput[]; options?: SendOptions}): Promise<unknown>;
+  resolvePermission(sessionId: string, requestId: string, allow: boolean, message?: string): Promise<unknown>;
+  resolvePermission(args: {sessionId: string; requestId: string; allow: boolean; message?: string; answers?: Record<string, string[]>}): Promise<unknown>;
+  abort(sessionId: string | {sessionId: string}): Promise<unknown>;
+  setPermissionMode(sessionId: string, mode: PermissionMode): Promise<unknown>;
+  setPermissionMode(args: {sessionId: string; mode: PermissionMode}): Promise<unknown>;
+  archiveSession(sessionId: string | {sessionId: string}): Promise<{sessionId: string; archivedAt: string}>;
+  restoreSession(sessionId: string | {sessionId: string}): Promise<void>;
+  resourceCounts(): ClientResourceCounts;
+  destroy(): void;
+}
+
+export declare const EVENT_TYPES: readonly string[];
+export declare function createClaudeWorkbenchClient(options?: ClaudeWorkbenchClientOptions): ClaudeWorkbenchClient;