ibc-ai-web-sdk 2.0.5 → 2.1.0

package/dist-ts/core/AIChatClient.d.ts

@@ -0,0 +1,56 @@
+export declare class AIChatClient {
+    config: any;
+    conversationId: string | null;
+    currentRequestId: string | null;
+    abortController: AbortController | null;
+    refreshTokenPromise: Promise<any> | null;
+    _backgroundTimer: any;
+    _visibilityHandler: any;
+    constructor(config?: any);
+    buildUrl(path: any): any;
+    buildHeaders(extra?: any): any;
+    createError(code: any, message: any, extra?: any): any;
+    getAuthCodes(): Set<any>;
+    isAuthErrorCode(code: any): boolean;
+    isTokenExpiring(): boolean;
+    applyTokenResult(result: any): any;
+    refreshToken(reason?: string, { silent }?: any): Promise<any>;
+    _shouldStartBackgroundRefresh(): boolean;
+    startBackgroundRefresh(): void;
+    stopBackgroundRefresh(): void;
+    dispose(): void;
+    ensureFreshToken(): Promise<void>;
+    runAuthFn(): Promise<void>;
+    parseResponse(raw: any): {
+        success: boolean;
+        code: any;
+        message: any;
+        data: any;
+        requestId: any;
+    };
+    requestJson(path: any, payload?: {}, options?: any): Promise<any>;
+    buildAppPayload(prompt: any, options?: any): any;
+    normalizeAttachmentIds(attachments: any): any[];
+    sendMessage(prompt: any, token: any, options?: any): Promise<any>;
+    isRetryableError(error: any): boolean;
+    sendMessageStream(prompt: any, handlers?: any, options?: any): Promise<any>;
+    executeMessageStream(prompt: any, handlers: any, options: any, retriedAfterRefresh: any): any;
+    handleSseEvent(event: any, data: any, handlers: any, setFinalText: any, markDone: any): void;
+    isEventLike(text: any): boolean;
+    stopCompletion(requestId?: string): Promise<any>;
+    uploadAttachment(file: any, options?: any): Promise<any>;
+    queryConversation(options?: any): Promise<any>;
+    deleteConversation(conversationId?: string, options?: any): Promise<any>;
+    asyncCompletion(prompt: any, options?: any): Promise<any>;
+    getTaskStatus(taskId: any, options?: any): Promise<any>;
+    getAppDetail(appId?: any, options?: any): Promise<any>;
+    listApplications(options?: any): Promise<any>;
+    replyPermission(request: any): Promise<any>;
+    replyQuestion(request: any): Promise<any>;
+    rejectQuestion(request: any): Promise<any>;
+    setConversationId(conversationId: any): void;
+    clearConversation(): void;
+    cancelCurrentRequest(): void;
+    updateConfig(newConfig: any): void;
+}
+export default AIChatClient;

package/dist-ts/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * IBC AI Web SDK - 纯JavaScript版本
+ * 支持任意前端框架：Vue, React, Angular, 原生HTML等
+ *
+ * @author IBC AI Team
+ * @version 2.1.0
+ */
+import { AIChatDialog } from './AIChatDialog.js';
+import { AIChatClient } from './core/AIChatClient.js';
+export { AIChatDialog } from './AIChatDialog.js';
+export { default as AIChatDialogDefault } from './AIChatDialog.js';
+export { AIChatClient } from './core/AIChatClient.js';
+export { default as AIChatClientDefault } from './core/AIChatClient.js';
+export declare function createAIChatDialog(options?: any): HTMLElement;
+export declare function installVuePlugin(Vue: any): void;
+export declare function useAIChat(options?: any): {
+    open: () => void;
+    close: () => void;
+    isVisible: boolean;
+    messages: any[];
+    isLoading: boolean;
+    toggle?: undefined;
+    sendMessage?: undefined;
+    clearMessages?: undefined;
+    ref?: undefined;
+} | {
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    sendMessage: (content: any) => void;
+    clearMessages: () => void;
+    isVisible: any;
+    messages: any;
+    isLoading: any;
+    ref: any;
+};
+declare const _default: {
+    AIChatDialog: typeof AIChatDialog;
+    AIChatClient: typeof AIChatClient;
+    createAIChatDialog: typeof createAIChatDialog;
+    installVuePlugin: typeof installVuePlugin;
+    useAIChat: typeof useAIChat;
+    version: string;
+};
+export default _default;

package/dist-ts/types.d.ts

@@ -0,0 +1,456 @@
+/**
+ * IBC AI Web SDK - TypeScript 类型定义
+ * 统一定义所有类型和接口，提供完整的类型提示
+ */
+/**
+ * AI 聊天配置接口
+ */
+export interface AIChatConfig {
+    /** API 接口地址 */
+    apiEndpoint: string;
+    /** API 基础地址，默认空字符串 */
+    apiBaseUrl?: string;
+    /** 流式接口地址，默认 /v1/app/completion/stream */
+    streamEndpoint?: string;
+    /** 停止生成接口地址，默认 /v1/app/completion/stop */
+    stopEndpoint?: string;
+    /** 附件上传接口地址，默认 /v1/app/attachment/upload */
+    attachmentUploadEndpoint?: string;
+    /** 应用详情接口地址，默认 /v1/app/{appId} */
+    appDetailEndpoint?: string;
+    /** 异步任务提交接口地址，默认 /v1/app/completion/async */
+    asyncEndpoint?: string;
+    /** 任务状态查询接口地址，默认 /v1/app/task/{taskId} */
+    taskStatusEndpoint?: string;
+    /** 会话查询接口地址，默认 /v1/app/conversation/query */
+    conversationQueryEndpoint?: string;
+    /** 会话删除接口地址，默认 /v1/app/conversation/delete */
+    conversationDeleteEndpoint?: string;
+    /** 应用列表接口地址，默认 /v1/app/list */
+    appListEndpoint?: string;
+    /** 权限确认回复接口地址，默认 /v1/app/runtime/permission/reply */
+    runtimePermissionReplyEndpoint?: string;
+    /** 问题回复接口地址，默认 /v1/app/runtime/question/reply */
+    runtimeQuestionReplyEndpoint?: string;
+    /** 问题拒绝接口地址，默认 /v1/app/runtime/question/reject */
+    runtimeQuestionRejectEndpoint?: string;
+    /** 应用 ID */
+    appId: string;
+    /** @deprecated 请使用 appId */
+    agentAppId?: string;
+    /** 用户 ID */
+    userId: string;
+    /** 业务类型标识 */
+    bizType: string;
+    /** 认证 Token */
+    token?: string;
+    /** 刷新 Token，可由 refreshTokenFn 使用 */
+    refreshToken?: string;
+    /** Token 过期时间戳（毫秒），配置后 SDK 会在过期前自动刷新 */
+    tokenExpiresAt?: number;
+    /** Token 过期前多久主动刷新，默认 60000ms */
+    tokenRefreshBufferMs?: number;
+    /**
+     * Token 刷新函数。返回字符串时视为新的 access token；
+     * 返回对象时支持 token/accessToken、refreshToken、expiresAt、expiresIn、headers。
+     */
+    refreshTokenFn?: (context: TokenRefreshContext) => Promise<TokenRefreshResult>;
+    /** Token 刷新成功回调 */
+    onTokenRefreshed?: (result: TokenRefreshSuccess) => void;
+    /** Token 刷新失败或未配置刷新函数时触发 */
+    onTokenExpired?: (error: Error | unknown) => void;
+    /** 额外业务未授权错误码，默认已包含 401/403/1005/S00001/ET0006/999990 */
+    authErrorCodes?: Array<string | number>;
+    /** 请求超时时间（毫秒），默认 60000 */
+    timeout?: number;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 扩展信息 */
+    extendInfo?: Record<string, any> | null;
+    /** 对话框标题，默认 'AI 智能助理' */
+    title?: string;
+    /** 欢迎文本，默认 '您好！我是 AI 智能助理' */
+    welcomeText?: string;
+    /** 欢迎描述，默认 '我可以帮您解答系统使用问题' */
+    welcomeDesc?: string;
+    /** 最大消息数量，默认 50 */
+    maxMessages?: number;
+    /** 输入框最大字数，默认 500 */
+    maxLength?: number;
+    /** 历史记录查询条数，默认 20 */
+    historyPageSize?: number;
+    /** 历史记录保留天数，默认 30；0 表示不按天过滤 */
+    historyDays?: number;
+    /** 是否允许拖拽，默认 true */
+    enableDrag?: boolean;
+    /**
+     * 可选鉴权函数
+     * @param token - 当前用户的 token
+     * @param userId - 用户 ID
+     * @returns Promise<void>，resolve 表示通过，reject/throw 表示拒绝
+     */
+    authFn?: (token: string, userId: string) => Promise<void>;
+    /** SDK 加载完成回调 */
+    onLoad?: (client: AIChatClient) => void;
+    /** 错误回调 */
+    onError?: (error: Error | string) => void;
+    /** 主题配置 */
+    theme?: {
+        /** 主色调 */
+        primaryColor?: string;
+        /** 背景色 */
+        backgroundColor?: string;
+        /** 气泡背景色 */
+        bubbleColor?: string;
+    };
+}
+/**
+ * AI 聊天客户端接口
+ */
+export interface AIChatClient {
+    /** 发送聊天消息 */
+    sendMessage(prompt: string, token?: string, options?: AIChatRequestOptions): Promise<AIResponse>;
+    /** 发送流式聊天消息 */
+    sendMessageStream(prompt: string, handlers?: AIStreamHandlers, options?: AIChatRequestOptions): Promise<AIResponse>;
+    /** 停止当前流式生成 */
+    stopCompletion(requestId?: string): Promise<AIResponse>;
+    /** 上传附件 */
+    uploadAttachment(file: File, options?: UploadAttachmentOptions): Promise<AIResponse<AttachmentUploadResponse>>;
+    /** 查询会话记录 */
+    queryConversation(options?: ConversationQueryOptions): Promise<AIResponse<ConversationQueryResponse>>;
+    /** 删除会话记录 */
+    deleteConversation(conversationId?: string, options?: ConversationQueryOptions): Promise<AIResponse>;
+    /** 异步提交任务 */
+    asyncCompletion(prompt: string, options?: AIChatRequestOptions): Promise<AIResponse>;
+    /** 查询异步任务状态 */
+    getTaskStatus(taskId: string): Promise<AIResponse>;
+    /** 查询智能体详情 */
+    getAppDetail(appId?: string): Promise<AIResponse>;
+    /** 查询可用智能体应用列表 */
+    listApplications(options?: AppListOptions): Promise<AIResponse<AppListResponse>>;
+    /** 回复权限确认请求（HITL权限交互） */
+    replyPermission(request: PermissionReplyRequest): Promise<AIResponse>;
+    /** 回复智能体问题（HITL问答交互） */
+    replyQuestion(request: QuestionReplyRequest): Promise<AIResponse>;
+    /** 拒绝智能体问题（HITL问答拒绝） */
+    rejectQuestion(request: QuestionRejectRequest): Promise<AIResponse>;
+    /** 设置会话 ID */
+    setConversationId(conversationId: string): void;
+    /** 清除会话 ID（开始新对话） */
+    clearConversation(): void;
+    /** 取消当前请求 */
+    cancelCurrentRequest(): void;
+    /** 更新配置 */
+    updateConfig(newConfig: Partial<AIChatConfig>): void;
+}
+export interface TokenRefreshContext {
+    token: string;
+    refreshToken: string;
+    userId: string;
+    reason: 'preflight' | 'response' | 'authFn' | string;
+}
+export type TokenRefreshResult = string | {
+    token?: string;
+    accessToken?: string;
+    authorization?: string;
+    refreshToken?: string;
+    expiresAt?: number;
+    expiresIn?: number;
+    headers?: Record<string, string>;
+};
+export interface TokenRefreshSuccess {
+    token: string;
+    refreshToken?: string;
+    tokenExpiresAt?: number;
+    raw?: TokenRefreshResult;
+}
+/**
+ * AI 响应接口
+ */
+export interface AIResponse<TData = {
+    /** AI 回复内容 */
+    content?: string;
+    /** 回复文本（兼容旧格式） */
+    replyText?: string;
+    /** 会话 ID */
+    conversationId?: string;
+    /** 消息 ID */
+    messageId?: string;
+    /** 使用量统计 */
+    usage?: {
+        /** 输入 token 数 */
+        inputTokens: number;
+        /** 输出 token 数 */
+        outputTokens: number;
+    };
+} | null> {
+    /** 是否成功 */
+    success: boolean;
+    /** 状态码 */
+    code: number;
+    /** 消息 */
+    message: string;
+    /** 响应数据 */
+    data: TData;
+}
+export interface AIChatRequestOptions {
+    appId?: string;
+    userId?: string;
+    bizType?: string;
+    conversationId?: string;
+    requestId?: string;
+    attachmentIds?: string[];
+    attachments?: Array<string | {
+        attachmentId?: string;
+        fileId?: string;
+        id?: string;
+    }>;
+    bizParams?: Record<string, any> | string;
+    extendInfo?: Record<string, any> | string;
+    timeout?: number;
+    retries?: number;
+    endpoint?: string;
+}
+export interface AIStreamHandlers {
+    onStart?: () => void;
+    onProgress?: (message: string) => void;
+    onMessage?: (chunk: string) => void;
+    onMeta?: (meta: Record<string, any>) => void;
+    onPlanningEvent?: (event: Record<string, any>) => void;
+    /** 思考/推理文本增量（DeepSeek-R1 / Claude thinking） */
+    onThinking?: (thinking: string) => void;
+    /** 执行进度书签事件 */
+    onProgressEvent?: (stage: string, message: string) => void;
+    /** 工具调用开始 */
+    onToolStart?: (toolName: string, toolCallId: string) => void;
+    /** 工具调用结果增量 */
+    onToolResult?: (toolName: string, text: string) => void;
+    /** 工具调用结束 */
+    onToolEnd?: (toolName: string, toolCallId: string) => void;
+    /** 工作流节点开始 */
+    onNodeStart?: (nodeName: string, message: string) => void;
+    /** 工作流节点进度 */
+    onNodeProgress?: (nodeName: string, message: string) => void;
+    /** 工作流节点完成 */
+    onNodeComplete?: (nodeName: string, message: string) => void;
+    /** 警告事件 */
+    onWarning?: (message: string) => void;
+    /** HITL 人机交互中断（权限确认/问题提问） */
+    onHitlInterrupt?: (hitlData: HitlInterruptData) => void;
+    onError?: (message: string, raw?: any) => void;
+    onDone?: (finalText?: string) => void;
+}
+/**
+ * HITL 交互中断数据
+ */
+export interface HitlInterruptData {
+    type: 'TOOL_CONFIRMATION' | 'QUESTION';
+    requestId: string;
+    sessionId: string;
+    taskRunId?: string;
+    toolCalls?: ToolCallInfo[];
+    message?: string;
+}
+/**
+ * 工具调用信息
+ */
+export interface ToolCallInfo {
+    id?: string;
+    name?: string;
+    input?: Record<string, any>;
+}
+export interface UploadAttachmentOptions {
+    userId?: string;
+    fileType?: string;
+    conversationId?: string;
+    timeout?: number;
+    endpoint?: string;
+}
+export interface AttachmentUploadResponse {
+    attachmentId: string;
+    fileName: string;
+    fileSize?: number;
+    fileType?: string;
+    fileUrl?: string;
+    filePath?: string;
+    mimeType?: string;
+}
+export interface ConversationQueryOptions {
+    userId?: string;
+    conversationId?: string;
+    appId?: string;
+    bizType?: string;
+    pageIndex?: number;
+    pageSize?: number;
+    requestId?: string;
+}
+export interface ConversationRecord {
+    recordId?: string | number;
+    requestId?: string;
+    conversationId?: string;
+    role?: string;
+    content?: string;
+    prompt?: string;
+    replyText?: string;
+    answer?: string;
+    createTime?: string;
+    attachments?: AttachmentUploadResponse[];
+}
+export interface ConversationQueryResponse {
+    conversationId: string;
+    appId?: string;
+    records: ConversationRecord[];
+    total?: number;
+    pageIndex?: number;
+    pageSize?: number;
+}
+/**
+ * HITL 权限回复请求
+ */
+export interface PermissionReplyRequest {
+    /** 会话ID（来自[HITL]事件） */
+    sessionId: string;
+    /** 权限请求ID（来自[HITL]事件） */
+    requestId: string;
+    /** 回复动作：once-仅本次 always-始终允许 reject-拒绝 */
+    reply: 'once' | 'always' | 'reject';
+    /** 补充说明 */
+    message?: string;
+}
+/**
+ * HITL 问题回复请求
+ */
+export interface QuestionReplyRequest {
+    /** 会话ID（来自[HITL]事件） */
+    sessionId: string;
+    /** 问题请求ID（来自[HITL]事件） */
+    requestId: string;
+    /** 答案列表（二维数组） */
+    answers: string[][];
+}
+/**
+ * HITL 问题拒绝请求
+ */
+export interface QuestionRejectRequest {
+    /** 会话ID（来自[HITL]事件） */
+    sessionId: string;
+    /** 问题请求ID（来自[HITL]事件） */
+    requestId: string;
+}
+/**
+ * 应用列表查询选项
+ */
+export interface AppListOptions {
+    /** 应用类型过滤：1-简易问答 3-智能助手 2-高级编排，不传则返回全部 */
+    applicationType?: number;
+    /** 页码，默认1 */
+    pageIndex?: number;
+    /** 每页大小，默认20，最大50 */
+    pageSize?: number;
+}
+/**
+ * 应用列表项
+ */
+export interface AppListItem {
+    /** 应用ID */
+    appId: string;
+    /** 应用名称 */
+    name: string;
+    /** 应用描述 */
+    description?: string;
+    /** 应用类型 */
+    applicationType?: number;
+    /** 应用图标URL */
+    icon?: string;
+    /** 开场白/欢迎语 */
+    prologue?: string;
+}
+/**
+ * 应用列表响应
+ */
+export interface AppListResponse {
+    /** 应用列表 */
+    records: AppListItem[];
+    /** 总数 */
+    total?: number;
+    /** 当前页码 */
+    currentPage?: number;
+    /** 每页大小 */
+    pageSize?: number;
+    /** 总页数 */
+    pages?: number;
+    /** 默认对话应用ID */
+    defaultChatAppId?: string;
+}
+/**
+ * 消息类型枚举
+ */
+export declare enum MessageType {
+    /** 用户消息 */
+    USER = "user",
+    /** AI 消息 */
+    AI = "ai"
+}
+/**
+ * 消息接口
+ */
+export interface Message {
+    /** 消息 ID */
+    id: string;
+    /** 消息类型 */
+    type: MessageType;
+    /** 消息内容 */
+    content: string;
+    /** 渲染后的内容（HTML） */
+    renderedContent: string;
+    /** 消息时间 */
+    time: string;
+    /** 是否失败 */
+    error?: boolean;
+    /** 是否已复制 */
+    copied?: boolean;
+}
+/**
+ * SDK 事件参数
+ */
+export interface SDKEvents {
+    /** 用户发送消息 */
+    'message-send': {
+        message: string;
+        index: number;
+    };
+    /** AI 回复消息 */
+    'message-receive': {
+        response: AIResponse;
+        index: number;
+    };
+    /** Loading 状态变化 */
+    'loading-change': boolean;
+    /** 关闭对话框 */
+    close: void;
+    /** 展开/收起 */
+    expand: boolean;
+    /** 清除对话 */
+    clear: void;
+}
+/**
+ * 错误码枚举
+ */
+export declare const ERROR_CODES: {
+    readonly SUCCESS: 200;
+    readonly AGENT_NOT_FOUND: 40001;
+    readonly PROMPT_EMPTY: 40002;
+    readonly AUTH_FAILED: 40301;
+    readonly NETWORK_ERROR: 500;
+    readonly SERVER_ERROR: 50001;
+    readonly TIMEOUT_ERROR: 50002;
+    readonly REQUEST_CANCELLED: 0;
+};
+/**
+ * 导出错误码类型
+ */
+export type ErrorCode = typeof ERROR_CODES[keyof typeof ERROR_CODES];
+/**
+ * 默认配置
+ */
+export declare const defaultConfig: AIChatConfig;

package/dist-ts/utils/errorCodes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 错误码常量
+ * 统一定义所有错误码，方便维护
+ */
+declare const ERROR_CODES: {
+    SUCCESS: number;
+    AGENT_NOT_FOUND: number;
+    PROMPT_EMPTY: number;
+    AUTH_FAILED: number;
+    NETWORK_ERROR: number;
+    SERVER_ERROR: number;
+    TIMEOUT_ERROR: number;
+    REQUEST_CANCELLED: number;
+};
+export default ERROR_CODES;

package/dist-ts/utils/logger.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 日志脱敏工具
+ * 防止敏感信息（如 Token）打印到控制台
+ */
+/**
+ * 脱敏对象中的敏感字段
+ * @param {Object} obj - 需要脱敏的对象
+ * @returns {Object} 脱敏后的对象
+ */
+export declare function maskSensitiveData(obj: any): any;
+/**
+ * 脱敏字符串中的 Token
+ * @param {string} str - 需要脱敏的字符串
+ * @returns {string} 脱敏后的字符串
+ */
+export declare function maskToken(str: any): any;

package/dist-ts/utils/messageIdGenerator.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 唯一 ID 生成器
+ * 避免消息 ID 冲突问题
+ */
+/**
+ * 生成唯一消息 ID
+ * 格式：{timestamp}-{counter}-{random}
+ * 例如：1713926400000-1-abc123
+ * @returns {string} 唯一 ID
+ */
+declare function generateMessageId(): string;
+export { generateMessageId };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibc-ai-web-sdk",
-  "version": "2.0.5",
+  "version": "2.1.0",
   "description": "IBC AI Web SDK - 纯JavaScript实现的AI对话组件，支持任意框架(Vue/React/Angular/原生HTML)",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -8,10 +8,15 @@
   "unpkg": "dist/index.umd.min.js",
   "jsdelivr": "dist/index.umd.min.js",
   "types": "./index.d.ts",
-  "sideEffects": ["./src/index.js", "./dist/index.esm.js", "./src/AIChatDialog.js", "./src/core/AIChatClient.js"],
+  "sideEffects": [
+    "./src/index.js",
+    "./dist/index.esm.js",
+    "./src/AIChatDialog.js",
+    "./src/core/AIChatClient.js"
+  ],
   "exports": {
     ".": {
-      "types": "./index.d.ts",
+      "types": "./dist-ts/index.d.ts",
       "import": "./dist/index.esm.js",
       "require": "./dist/index.cjs.js",
       "default": "./dist/index.umd.min.js"
@@ -21,17 +26,18 @@
     "./package.json": "./package.json"
   },
   "files": [
-    "dist",
+    "dist/*.js",
+    "dist-ts/*.d.ts",
+    "dist-ts/**/*.d.ts",
     "miniprogram",
-    "index.d.ts",
-    "src/types.ts",
     "README.md"
   ],
   "scripts": {
     "dev": "rollup -c rollup.config.js --watch",
-    "build": "rollup -c rollup.config.js",
+    "build": "tsc && rollup -c rollup.config.js",
+    "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build",
-    "lint": "eslint src/**/*.js",
+    "lint": "eslint src/**/*.ts",
     "test": "jest"
   },
   "keywords": [
@@ -60,7 +66,9 @@
     "@rollup/plugin-node-resolve": "^15.2.0",
     "@rollup/plugin-terser": "^0.4.0",
     "@types/dompurify": "^3.0.5",
-    "rollup": "^4.6.0"
+    "rollup": "^4.6.0",
+    "tslib": "^2.8.1",
+    "typescript": "^6.0.3"
   },
   "engines": {
     "node": ">=14.0.0"