@yushaw/sanqian-sdk 0.3.9 → 0.3.11

package/dist/index.browser.d.mts

@@ -273,8 +273,20 @@ interface ChatStreamEvent {
     /** Run ID (for "interrupt" event) - needed to send HITL response */
     run_id?: string;
 }
-/** HITL interrupt types */
-type HitlInterruptType = "approval_request" | "user_input_request";
+/**
+ * HITL interrupt types.
+ *
+ * - approval_request: Pre-execution approval. User approves/rejects tool execution.
+ *   Example: "Delete file X?" -> Approve / Reject
+ *
+ * - user_input_request: Agent asks for user input. User provides text or selects options.
+ *   Example: "What format?" -> ["JSON", "CSV"] or free text
+ *
+ * - user_action_request: Tool requires user to complete an action externally.
+ *   User performs the action (e.g., login), then confirms completion.
+ *   Example: "Login required" -> [User logs in] -> "Done" / "Skip"
+ */
+type HitlInterruptType = "approval_request" | "user_input_request" | "user_action_request";
 /** HITL risk levels for approval requests */
 type HitlRiskLevel = "low" | "medium" | "high";
 /** HITL interrupt payload - sent from backend when HITL is triggered */
@@ -303,6 +315,14 @@ interface HitlInterruptPayload {
     required?: boolean;
     /** Timeout in seconds */
     timeout?: number;
+    /** Interrupt source - "tool_interrupt" means a tool triggered this during execution */
+    source?: "tool_interrupt";
+    /** Name of the tool that triggered the interrupt */
+    source_tool?: string;
+    /** Tool call ID for correlation */
+    source_tool_call_id?: string;
+    /** Reason for the interrupt (e.g., "login_required", "captcha_detected") */
+    source_reason?: string;
 }
 /** HITL response - sent from client to backend */
 interface HitlResponse {
@@ -455,6 +475,161 @@ interface AgentUpdateConfig {
      */
     searchable?: boolean;
 }
+/** Embedding configuration returned from Sanqian */
+interface EmbeddingConfigResult {
+    /** Whether embedding is configured in Sanqian */
+    available: boolean;
+    /** API URL for embedding service */
+    apiUrl?: string;
+    /** API key (decrypted) */
+    apiKey?: string;
+    /** Model name */
+    modelName?: string;
+    /** Embedding dimensions */
+    dimensions?: number;
+}
+/** Rerank configuration returned from Sanqian */
+interface RerankConfigResult {
+    /** Whether rerank is configured in Sanqian */
+    available: boolean;
+    /** API URL for rerank service */
+    apiUrl?: string;
+    /** API key (decrypted) */
+    apiKey?: string;
+    /** Model name */
+    modelName?: string;
+}
+/** Capability type */
+type CapabilityType = "tool" | "skill" | "agent" | "context";
+/** Tool capability info */
+interface ToolCapability {
+    type: "tool";
+    /** Tool ID (e.g., "file_ops", "sdk_myapp_xxx", "mcp_server_tool") */
+    id: string;
+    /** Tool description */
+    description: string;
+    /** Source: builtin, sdk, or mcp */
+    source: "builtin" | "sdk" | "mcp";
+    /** Source ID (SDK app name or MCP server name) */
+    sourceId?: string;
+    /** Tool category */
+    category?: string;
+    /** Tool tags */
+    tags?: string[];
+    /** Tool parameters JSON Schema */
+    parameters?: JSONSchema;
+    /** Display name (localized) */
+    display?: {
+        zh?: string;
+        en?: string;
+    };
+    /** Short description (localized) */
+    shortDesc?: {
+        zh?: string;
+        en?: string;
+    };
+}
+/** Skill capability info */
+interface SkillCapability {
+    type: "skill";
+    /** Skill ID (e.g., "pdf", "web-research") */
+    id: string;
+    /** Skill description */
+    description: string;
+    /** Source: builtin or custom */
+    source: "builtin" | "custom";
+    /** Display name (localized) */
+    display?: {
+        zh?: string;
+        en?: string;
+    };
+    /** Short description (localized) */
+    shortDesc?: {
+        zh?: string;
+        en?: string;
+    };
+}
+/** Agent capability info */
+interface AgentCapability {
+    type: "agent";
+    /** Agent ID */
+    id: string;
+    /** Agent display name */
+    name: string;
+    /** Agent description */
+    description?: string;
+    /** Source: builtin, custom, or sdk */
+    source: "builtin" | "custom" | "sdk";
+    /** Source ID (SDK app name for sdk agents) */
+    sourceId?: string;
+    /** Agent icon/emoji */
+    icon?: string;
+    /** Display name (localized) */
+    display?: {
+        zh?: string;
+        en?: string;
+    };
+    /** Short description (localized) */
+    shortDesc?: {
+        zh?: string;
+        en?: string;
+    };
+}
+/** Context capability info */
+interface ContextCapability {
+    type: "context";
+    /** Context provider ID */
+    id: string;
+    /** Context provider display name */
+    name: string;
+    /** Context provider description */
+    description?: string;
+    /** Source: sdk (context providers are always from SDK apps) */
+    source: "sdk";
+    /** Source ID (SDK app name) */
+    sourceId: string;
+    /** Context provider icon/emoji */
+    icon?: string;
+    /** Whether this provider supports getCurrent */
+    hasCurrent: boolean;
+    /** Whether this provider supports getList */
+    hasList: boolean;
+    /** Whether this provider supports getById */
+    hasGetById: boolean;
+}
+/** Union type for all capabilities */
+type Capability = ToolCapability | SkillCapability | AgentCapability | ContextCapability;
+/** Capability search result with score */
+interface CapabilitySearchResult {
+    /** The capability */
+    capability: Capability;
+    /** Relevance score */
+    score: number;
+    /** Usage hint */
+    howToUse?: string;
+}
+/** Options for listing capabilities */
+interface ListCapabilitiesOptions {
+    /** Filter by type (default: "all") */
+    type?: CapabilityType | "all";
+    /** Filter by source (e.g., "builtin", "sdk", "mcp") */
+    source?: string;
+    /** Filter by category (tools only) */
+    category?: string;
+    /** SDK app name (for including own private agents) */
+    appName?: string;
+    /** Agent scope filter: "searchable" (default) or "available" (includes non-searchable but enabled agents) */
+    scope?: "searchable" | "available";
+}
+/** Options for searching capabilities */
+interface SearchCapabilitiesOptions {
+    /** Filter by type (default: "all") */
+    type?: CapabilityType | "all";
+    /** Max results (default: 10) */
+    limit?: number;
+    /** Exclude these IDs */
+    exclude?: string[];
+}
 /**
  * Session resource pushed by an app.
  * Content is provided at push time (not fetched like attached_resources).
@@ -518,6 +693,10 @@ declare class SanqianSDK {
     private connectingPromise;
     private reconnectRefCount;
     private eventListeners;
+    private sessionResources;
+    private contextProviders;
+    private runIdToMsgId;
+    private pendingStreamMsgId;
     private log;
     private warn;
     constructor(config: SDKConfig);
@@ -531,6 +710,18 @@ declare class SanqianSDK {
     private register;
     private handleMessage;
     private handleChatStream;
+    private handleResourceRemovedByUser;
+    private getHandlerByRunId;
+    private handleBackendStart;
+    private handleBackendStream;
+    private handleBackendThinking;
+    private handleBackendToolStart;
+    private handleBackendToolArgsChunk;
+    private handleBackendToolResult;
+    private handleBackendComplete;
+    private handleBackendError;
+    private handleBackendCancelled;
+    private handleBackendInterrupt;
     private handleToolCall;
     private sendToolResult;
     private handleDisconnect;
@@ -605,7 +796,74 @@ declare class SanqianSDK {
      * @param response - User's response (approval, input, etc.)
      */
     sendHitlResponse(runId: string, response: HitlResponse): void;
+    /**
+     * Cancel an in-flight chat run
+     *
+     * @param runId - The run_id from the stream "start"/"interrupt" event
+     */
+    cancelRun(runId: string): void;
     startConversation(agentId: string): Conversation;
+    /**
+     * Get embedding configuration from Sanqian
+     *
+     * Returns the current embedding model configuration including API URL, key, and model name.
+     * This allows external apps to use the same embedding service configured in Sanqian.
+     */
+    getEmbeddingConfig(): Promise<EmbeddingConfigResult>;
+    /**
+     * Get rerank configuration from Sanqian
+     *
+     * Returns the current rerank model configuration including API URL, key, and model name.
+     * This allows external apps to use the same rerank service configured in Sanqian.
+     */
+    getRerankConfig(): Promise<RerankConfigResult>;
+    /**
+     * Push a session resource to Sanqian
+     *
+     * Session resources are temporary context pushed by the app, visible in all Chat UI instances.
+     * They persist until the app disconnects or explicitly removes them.
+     */
+    pushResource(resource: SessionResource): Promise<StoredSessionResource>;
+    /**
+     * Remove a session resource
+     */
+    removeResource(resourceId: string): Promise<void>;
+    /**
+     * Clear all session resources pushed by this app
+     */
+    clearResources(): Promise<void>;
+    /**
+     * Get all session resources pushed by this app (local cache)
+     */
+    getSessionResources(): StoredSessionResource[];
+    /**
+     * Fetch session resources from server
+     */
+    fetchSessionResources(agentId?: string): Promise<StoredSessionResource[]>;
+    /**
+     * List available capabilities (tools, skills, agents)
+     */
+    listCapabilities(options?: ListCapabilitiesOptions): Promise<Capability[]>;
+    /**
+     * Search capabilities by query using hybrid search (BM25 + Vector)
+     */
+    searchCapabilities(query: string, options?: SearchCapabilitiesOptions): Promise<CapabilitySearchResult[]>;
+    /**
+     * List available tools
+     */
+    listTools(source?: "builtin" | "sdk" | "mcp"): Promise<ToolCapability[]>;
+    /**
+     * List available skills
+     */
+    listSkills(): Promise<SkillCapability[]>;
+    /**
+     * List all available agents
+     */
+    listAvailableAgents(): Promise<AgentCapability[]>;
+    /**
+     * Update context providers dynamically
+     */
+    updateContexts(contexts: ContextProvider[]): Promise<void>;
     on<T extends SDKEventName>(event: T, listener: SDKEvents[T]): this;
     off<T extends SDKEventName>(event: T, listener: SDKEvents[T]): this;
     once<T extends SDKEventName>(event: T, listener: SDKEvents[T]): this;
@@ -704,4 +962,4 @@ declare class SanqianSDKError extends Error {
  */
 declare function createSDKError(code: SDKErrorCode, details?: string): SanqianSDKError;
 
-export { type AgentConfig, type AgentInfo, type AgentUpdateConfig, type ChatMessage, type ChatRequest, type ChatResponse, type ChatStreamEvent, type ConnectionInfo, type ConnectionState, Conversation, type ConversationDetail, type ConversationInfo, type ConversationMessage, ErrorMessages, type HitlInterruptPayload, type HitlInterruptType, type HitlResponse, type HitlRiskLevel, type JSONSchema, type JSONSchemaProperty, type RemoteToolDefinition, SANQIAN_WEBSITE, type SDKConfig, SDKErrorCode, type SDKEventName, type SDKEvents, SanqianSDK, SanqianSDKError, type ToolCall, type ToolDefinition, createSDKError };
+export { type AgentCapability, type AgentConfig, type AgentInfo, type AgentUpdateConfig, type Capability, type CapabilitySearchResult, type CapabilityType, type ChatMessage, type ChatRequest, type ChatResponse, type ChatStreamEvent, type ConnectionInfo, type ConnectionState, type ContextData, type ContextListItem, type ContextProvider, Conversation, type ConversationDetail, type ConversationInfo, type ConversationMessage, type EmbeddingConfigResult, ErrorMessages, type HitlInterruptPayload, type HitlInterruptType, type HitlResponse, type HitlRiskLevel, type JSONSchema, type JSONSchemaProperty, type ListCapabilitiesOptions, type RemoteToolDefinition, type RerankConfigResult, SANQIAN_WEBSITE, type SDKConfig, SDKErrorCode, type SDKEventName, type SDKEvents, SanqianSDK, SanqianSDKError, type SearchCapabilitiesOptions, type SessionResource, type SkillCapability, type StoredSessionResource, type ToolCall, type ToolCapability, type ToolDefinition, createSDKError };