@tacoreai/web-sdk 1.0.12 → 1.3.0

package/database/core/apps/AppsClient.TextIn.js

@@ -0,0 +1,341 @@
+import { isBrowser } from "../../../utils/index.js";
+
+export const appsClientTextInMethods = {
+  // ==================== TextIn OCR & File Convert ====================
+
+  /**
+   * TextIn OCR 识别
+   * @param {File | {data: string, encoding: 'base64', name: string} | string} input - 文件对象、Base64对象或URL字符串
+   * @param {Object} options - TextIn 识别参数 (如 pdf_page_count, page_start 等)
+   * @returns {Promise<Object>} 识别结果
+   */
+  async recognizeText(input, options = {}) {
+    if (!input) throw new Error("input (file or url) is required");
+
+    // 构建查询参数
+    const queryParams = new URLSearchParams();
+    for (const [key, value] of Object.entries(options)) {
+      if (value !== undefined && value !== null) {
+        queryParams.append(key, value.toString());
+      }
+    }
+    const queryString = queryParams.toString() ? `?${queryParams.toString()}` : "";
+    const url = `${this.config.apiBaseUrl}/apps/textIn/recognize${queryString}`;
+
+    // 判断输入类型
+    if (typeof input === "string" && (input.startsWith("http://") || input.startsWith("https://"))) {
+      // URL 模式
+      return this._post(`/apps/textIn/recognize${queryString}`, { url: input });
+    }
+    // 文件模式 (FormData)
+    const form = new FormData();
+    form.append("appId", this.appId);
+
+    if (isBrowser) {
+      if (!(input instanceof File)) {
+        throw new Error("Invalid file input in browser. Provide a File object or URL string.");
+      }
+      form.append("file", input, input.name);
+    } else {
+      // isBackend
+      if (typeof input === "object" && input.data && input.name && input.encoding === "base64") {
+        const buffer = Buffer.from(input.data, "base64");
+        const fileBlob = new Blob([buffer]);
+        form.append("file", fileBlob, input.name);
+      } else {
+        throw new Error(
+          "Invalid file input in Node.js. Provide { data: base64_string, encoding: 'base64', name: string } or URL string."
+        );
+      }
+    }
+
+    const headers = this._getRequestHeaders();
+    delete headers["Content-Type"]; // Let fetch set Content-Type for multipart/form-data
+
+    const resp = await fetch(url, {
+      method: "POST",
+      headers,
+      body: form,
+    });
+
+    if (!resp.ok) {
+      const err = await resp.json().catch(() => ({}));
+      throw new Error(err.message || err.error || `HTTP ${resp.status}: ${resp.statusText}`);
+    }
+    return resp.json();
+  },
+
+  /**
+   * Word 转 PDF
+   * @param {File | {data: string, encoding: 'base64', name: string} | string} input - 文件对象、Base64对象或URL字符串
+   * @returns {Promise<{success: boolean, data: {url: string}}>} 转换结果，包含文件下载链接
+   */
+  async wordToPdf(input) {
+    if (!input) throw new Error("input (file or url) is required");
+
+    const url = `${this.config.apiBaseUrl}/apps/textIn/word-to-pdf`;
+
+    // 判断输入类型
+    if (typeof input === "string" && (input.startsWith("http://") || input.startsWith("https://"))) {
+      // URL 模式
+      return this._post("/apps/textIn/word-to-pdf", { url: input });
+    }
+    // 文件模式 (FormData)
+    const form = new FormData();
+    form.append("appId", this.appId);
+
+    if (isBrowser) {
+      if (!(input instanceof File)) {
+        throw new Error("Invalid file input in browser. Provide a File object or URL string.");
+      }
+      form.append("file", input, input.name);
+    } else {
+      // isBackend
+      if (typeof input === "object" && input.data && input.name && input.encoding === "base64") {
+        const buffer = Buffer.from(input.data, "base64");
+        const fileBlob = new Blob([buffer]);
+        form.append("file", fileBlob, input.name);
+      } else {
+        throw new Error(
+          "Invalid file input in Node.js. Provide { data: base64_string, encoding: 'base64', name: string } or URL string."
+        );
+      }
+    }
+
+    const headers = this._getRequestHeaders();
+    delete headers["Content-Type"]; // Let fetch set Content-Type for multipart/form-data
+
+    const resp = await fetch(url, {
+      method: "POST",
+      headers,
+      body: form,
+    });
+
+    if (!resp.ok) {
+      const err = await resp.json().catch(() => ({}));
+      throw new Error(err.message || err.error || `HTTP ${resp.status}: ${resp.statusText}`);
+    }
+    return resp.json();
+  },
+
+  /**
+   * PDF 转 Word
+   * @param {File | {data: string, encoding: 'base64', name: string} | string} input - 文件对象、Base64对象或URL字符串
+   * @returns {Promise<{success: boolean, data: {url: string}}>} 转换结果，包含文件下载链接
+   */
+  async pdfToWord(input) {
+    if (!input) throw new Error("input (file or url) is required");
+
+    const url = `${this.config.apiBaseUrl}/apps/textIn/pdf-to-word`;
+
+    // 判断输入类型
+    if (typeof input === "string" && (input.startsWith("http://") || input.startsWith("https://"))) {
+      // URL 模式
+      return this._post("/apps/textIn/pdf-to-word", { url: input });
+    }
+    // 文件模式 (FormData)
+    const form = new FormData();
+    form.append("appId", this.appId);
+
+    if (isBrowser) {
+      if (!(input instanceof File)) {
+        throw new Error("Invalid file input in browser. Provide a File object or URL string.");
+      }
+      form.append("file", input, input.name);
+    } else {
+      // isBackend
+      if (typeof input === "object" && input.data && input.name && input.encoding === "base64") {
+        const buffer = Buffer.from(input.data, "base64");
+        const fileBlob = new Blob([buffer]);
+        form.append("file", fileBlob, input.name);
+      } else {
+        throw new Error(
+          "Invalid file input in Node.js. Provide { data: base64_string, encoding: 'base64', name: string } or URL string."
+        );
+      }
+    }
+
+    const headers = this._getRequestHeaders();
+    delete headers["Content-Type"]; // Let fetch set Content-Type for multipart/form-data
+
+    const resp = await fetch(url, {
+      method: "POST",
+      headers,
+      body: form,
+    });
+
+    if (!resp.ok) {
+      const err = await resp.json().catch(() => ({}));
+      throw new Error(err.message || err.error || `HTTP ${resp.status}: ${resp.statusText}`);
+    }
+    return resp.json();
+  },
+
+  /**
+   * Excel 转 PDF
+   * @param {File | {data: string, encoding: 'base64', name: string} | string} input - 文件对象、Base64对象或URL字符串
+   * @returns {Promise<{success: boolean, data: {url: string}}>} 转换结果，包含文件下载链接
+   */
+  async excelToPdf(input) {
+    if (!input) throw new Error("input (file or url) is required");
+
+    const url = `${this.config.apiBaseUrl}/apps/textIn/excel-to-pdf`;
+
+    // 判断输入类型
+    if (typeof input === "string" && (input.startsWith("http://") || input.startsWith("https://"))) {
+      // URL 模式
+      return this._post("/apps/textIn/excel-to-pdf", { url: input });
+    }
+    // 文件模式 (FormData)
+    const form = new FormData();
+    form.append("appId", this.appId);
+
+    if (isBrowser) {
+      if (!(input instanceof File)) {
+        throw new Error("Invalid file input in browser. Provide a File object or URL string.");
+      }
+      form.append("file", input, input.name);
+    } else {
+      // isBackend
+      if (typeof input === "object" && input.data && input.name && input.encoding === "base64") {
+        const buffer = Buffer.from(input.data, "base64");
+        const fileBlob = new Blob([buffer]);
+        form.append("file", fileBlob, input.name);
+      } else {
+        throw new Error(
+          "Invalid file input in Node.js. Provide { data: base64_string, encoding: 'base64', name: string } or URL string."
+        );
+      }
+    }
+
+    const headers = this._getRequestHeaders();
+    delete headers["Content-Type"]; // Let fetch set Content-Type for multipart/form-data
+
+    const resp = await fetch(url, {
+      method: "POST",
+      headers,
+      body: form,
+    });
+
+    if (!resp.ok) {
+      const err = await resp.json().catch(() => ({}));
+      throw new Error(err.message || err.error || `HTTP ${resp.status}: ${resp.statusText}`);
+    }
+    return resp.json();
+  },
+
+  /**
+   * PDF 转 Excel
+   * @param {File | {data: string, encoding: 'base64', name: string} | string} input - 文件对象、Base64对象或URL字符串
+   * @returns {Promise<{success: boolean, data: {url: string}}>} 转换结果，包含文件下载链接
+   */
+  async pdfToExcel(input) {
+    if (!input) throw new Error("input (file or url) is required");
+
+    const url = `${this.config.apiBaseUrl}/apps/textIn/pdf-to-excel`;
+
+    // 判断输入类型
+    if (typeof input === "string" && (input.startsWith("http://") || input.startsWith("https://"))) {
+      // URL 模式
+      return this._post("/apps/textIn/pdf-to-excel", { url: input });
+    }
+    // 文件模式 (FormData)
+    const form = new FormData();
+    form.append("appId", this.appId);
+
+    if (isBrowser) {
+      if (!(input instanceof File)) {
+        throw new Error("Invalid file input in browser. Provide a File object or URL string.");
+      }
+      form.append("file", input, input.name);
+    } else {
+      // isBackend
+      if (typeof input === "object" && input.data && input.name && input.encoding === "base64") {
+        const buffer = Buffer.from(input.data, "base64");
+        const fileBlob = new Blob([buffer]);
+        form.append("file", fileBlob, input.name);
+      } else {
+        throw new Error(
+          "Invalid file input in Node.js. Provide { data: base64_string, encoding: 'base64', name: string } or URL string."
+        );
+      }
+    }
+
+    const headers = this._getRequestHeaders();
+    delete headers["Content-Type"]; // Let fetch set Content-Type for multipart/form-data
+
+    const resp = await fetch(url, {
+      method: "POST",
+      headers,
+      body: form,
+    });
+
+    if (!resp.ok) {
+      const err = await resp.json().catch(() => ({}));
+      throw new Error(err.message || err.error || `HTTP ${resp.status}: ${resp.statusText}`);
+    }
+    return resp.json();
+  },
+
+  /**
+   * 通用文件转 Markdown (支持 PDF, Word, Excel, PPT, 图片等)
+   * @param {File | {data: string, encoding: 'base64', name: string} | string} input - 文件对象、Base64对象或URL字符串
+   * @param {Object} options - 转换选项 (如 page_start, page_count 等)
+   * @returns {Promise<{success: boolean, data: {url: string}}>} 转换结果，包含 Markdown 文件下载链接
+   */
+  async fileToMarkdown(input, options = {}) {
+    if (!input) throw new Error("input (file or url) is required");
+
+    // 构建查询参数
+    const queryParams = new URLSearchParams();
+    for (const [key, value] of Object.entries(options)) {
+      if (value !== undefined && value !== null) {
+        queryParams.append(key, value.toString());
+      }
+    }
+    const queryString = queryParams.toString() ? `?${queryParams.toString()}` : "";
+    const url = `${this.config.apiBaseUrl}/apps/textIn/file-to-markdown${queryString}`;
+
+    // 判断输入类型
+    if (typeof input === "string" && (input.startsWith("http://") || input.startsWith("https://"))) {
+      // URL 模式
+      return this._post(`/apps/textIn/file-to-markdown${queryString}`, { url: input });
+    }
+    // 文件模式 (FormData)
+    const form = new FormData();
+    form.append("appId", this.appId);
+
+    if (isBrowser) {
+      if (!(input instanceof File)) {
+        throw new Error("Invalid file input in browser. Provide a File object or URL string.");
+      }
+      form.append("file", input, input.name);
+    } else {
+      // isBackend
+      if (typeof input === "object" && input.data && input.name && input.encoding === "base64") {
+        const buffer = Buffer.from(input.data, "base64");
+        const fileBlob = new Blob([buffer]);
+        form.append("file", fileBlob, input.name);
+      } else {
+        throw new Error(
+          "Invalid file input in Node.js. Provide { data: base64_string, encoding: 'base64', name: string } or URL string."
+        );
+      }
+    }
+
+    const headers = this._getRequestHeaders();
+    delete headers["Content-Type"]; // Let fetch set Content-Type for multipart/form-data
+
+    const resp = await fetch(url, {
+      method: "POST",
+      headers,
+      body: form,
+    });
+
+    if (!resp.ok) {
+      const err = await resp.json().catch(() => ({}));
+      throw new Error(err.message || err.error || `HTTP ${resp.status}: ${resp.statusText}`);
+    }
+    return resp.json();
+  },
+};

package/database/core/apps/AppsClient.Tools.js

@@ -0,0 +1,36 @@
+export const appsClientToolsMethods = {
+  // ==================== PDF 水印 ====================
+
+  /**
+   * 给 PDF 添加水印
+   * @param {object} options
+   * @param {string} options.url - PDF 文件的 URL
+   * @param {string} options.text - 水印文案
+   * @param {object} [options.style] - 水印样式 { size, opacity, color, rotate, fontUrl }
+   * @returns {Promise<{success: boolean, data: {url: string, fileId: string, size: number}}>} 
+   */
+  async addWatermark(options = {}) {
+    if (!options.url || !options.text) {
+      throw new Error("url and text are required for addWatermark.");
+    }
+    return this._post("/apps/watermark/process", {
+      appId: this.appId,
+      ...options,
+    });
+  },
+
+  // ==================== 敏感信息检测 ====================
+
+  /**
+   * 检测内容中的敏感信息
+   * @param {string} content - 待检测的内容（文本字符串、图片URL或文档URL）
+   * @returns {Promise<{isSensitive: boolean, result: string}>}
+   */
+  async detectSensitiveInfo(content) {
+    if (!content) {
+      throw new Error("content is required for sensitive detection.");
+    }
+    const result = await this._post("/apps/sensitive/detect", { content });
+    return result.data;
+  },
+};

package/database/core/apps/AppsClient.Users.js

@@ -0,0 +1,49 @@
+export const appsClientUserMethods = {
+  // ==================== 新增：应用用户与角色管理 ====================
+
+  /**
+   * 获取当前 App 下的用户列表（含 appRole）
+   * @param {Object} params { page?: number, pageSize?: number }
+   * @returns {Promise<{ success: boolean, data: Array, pagination: Object }>}
+   */
+  async listAppUsers(params = {}) {
+    const { page = 1, pageSize = 20 } = params || {};
+    return this._get("/apps/users/list", {
+      appId: this.appId,
+      page,
+      pageSize,
+    });
+  },
+
+  /**
+   * [新增] 为当前应用创建一个新的自定义角色
+   * @param {Object} params { roleName: string, description?: string }
+   * @returns {Promise<{success: boolean, data: {name: string, description: string}}>} 
+   */
+  async createRole({ roleName, description }) {
+    if (!roleName) {
+      throw new Error("roleName is required.");
+    }
+    return this._post("/apps/roles/create", {
+      appId: this.appId,
+      roleName,
+      description,
+    });
+  },
+
+  /**
+   * [新增] 更新或设置一个用户在当前应用中的角色
+   * @param {Object} params { userId: string, role: string }
+   * @returns {Promise<{success: boolean, data: {userId: string, appId: string, role: string}}>} 
+   */
+  async updateUserRole({ userId, role }) {
+    if (!userId || !role) {
+      throw new Error("userId and role are required.");
+    }
+    return this._post("/apps/users/update-role", {
+      appId: this.appId,
+      targetUserId: userId,
+      role: role,
+    });
+  },
+};

package/database/core/apps/AppsClient.VoiceVideo.js

@@ -0,0 +1,106 @@
+export const appsClientVoiceVideoMethods = {
+  // ==================== 新增：语音生成 ====================
+
+  /**
+   * 生成语音文件和字幕（非流式）
+   * @param {object} options - { text, voiceId?, speed?, vol?, pitch?, projectId? }
+   * @returns {Promise<{audioUrl: string, fileID: string, subtitles: object, duration: number, cost: number}>}
+   */
+  async generateVoice(options = {}) {
+    if (!options.text) {
+      throw new Error("text is required for voice generation.");
+    }
+    const result = await this._post("/apps/voice/generate", {
+      appId: this.appId,
+      ...options,
+    });
+    return result.data;
+  },
+
+  /**
+   * 获取语音流式响应（流式）
+   * @param {object} options - { text, voiceId?, speed?, vol?, pitch?, projectId? }
+   * @returns {Promise<Response>} - Fetch API 的 Response 对象，其 body 是一个 ReadableStream。
+   */
+  async streamVoice(options = {}) {
+    if (!options.text) {
+      throw new Error("text is required for voice streaming.");
+    }
+    const url = `${this.config.apiBaseUrl}/apps/voice/stream`;
+    const headers = this._getRequestHeaders();
+
+    const response = await fetch(url, {
+      method: "POST",
+      headers,
+      body: JSON.stringify({
+        appId: this.appId,
+        ...options,
+      }),
+    });
+
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({ error: "Network error" }));
+      throw new Error(errorData.error || `HTTP ${response.status}: ${response.statusText}`);
+    }
+
+    return response; // 直接返回 Response 对象
+  },
+
+  // ==================== 新增：Sora 视频生成 ====================
+
+  /**
+   * 创建一个 Sora 视频生成任务
+   * @param {object} options - { prompt, model, size, seconds }
+   * @returns {Promise<object>} 视频任务文档
+   */
+  async createVideoJob(options = {}) {
+    if (!options.prompt || !options.model) {
+      throw new Error("prompt and model are required for video generation.");
+    }
+    // The middleware uses appId from the body to find the organization
+    return this._post("/apps/sora/videos", {
+      appId: this.appId,
+      ...options,
+    });
+  },
+
+  /**
+   * 基于现有视频创建一个 Remix 任务
+   * @param {string} jobId - 原始视频任务的 wyID
+   * @param {object} options - { prompt }
+   * @returns {Promise<object>} 新的 Remix 任务初始状态的文档
+   */
+  async remixVideoJob(jobId, options = {}) {
+    if (!jobId) {
+      throw new Error("jobId of the original video is required for remixing.");
+    }
+    if (!options.prompt) {
+      throw new Error("A new prompt is required for remixing.");
+    }
+    return this._post(`/apps/sora/videos/${jobId}/remix`, {
+      appId: this.appId,
+      prompt: options.prompt,
+    });
+  },
+
+  /**
+   * 查询视频生成任务的状态
+   * @param {string} jobId - 任务的 wyID
+   * @returns {Promise<object>} 视频任务文档
+   */
+  async getVideoJob(jobId) {
+    if (!jobId) {
+      throw new Error("jobId is required.");
+    }
+    return this._get(`/apps/sora/videos/${jobId}`, { appId: this.appId });
+  },
+
+  /**
+   * 获取视频任务列表
+   * @param {object} [options] - { page = 1, pageSize = 10 }
+   * @returns {Promise<object>} 任务列表和分页信息
+   */
+  async listVideoJobs(options = {}) {
+    return this._get("/apps/sora/videos", { appId: this.appId, ...options });
+  },
+};

package/database/core/apps/AppsClient.Volcengine.js

@@ -0,0 +1,169 @@
+/**
+ * 火山引擎实时语音对话客户端实现
+ * 内部类，直接集成在 AppsClient 中
+ */
+class VolcengineImpl {
+  /**
+   * @param {AppsClient} appsClient - AppsClient 实例
+   */
+  constructor(appsClient) {
+    this.appsClient = appsClient;
+    this.ws = null;
+    this.sessionId = null;
+    this.listeners = {
+      asr: [],
+      content: [], // AI 回复的文本
+      audio: [], // TTS 音频数据 (Uint8Array)
+      sys_error: [],
+      close: [],
+      json: [], // 原始 JSON 事件
+    };
+  }
+
+  /**
+   * 注册事件监听器
+   * @param {'asr'|'content'|'audio'|'sys_error'|'close'|'json'} event 
+   * @param {Function} callback 
+   */
+  on(event, callback) {
+    if (this.listeners[event]) {
+      this.listeners[event].push(callback);
+    }
+  }
+
+  /**
+   * 移除事件监听器
+   * @param {'asr'|'content'|'audio'|'sys_error'|'close'|'json'} event 
+   * @param {Function} callback 
+   */
+  off(event, callback) {
+    if (this.listeners[event]) {
+      this.listeners[event] = this.listeners[event].filter(cb => cb !== callback);
+    }
+  }
+
+  _emit(event, data) {
+    if (this.listeners[event]) {
+      this.listeners[event].forEach(cb => {
+        try {
+          cb(data);
+        } catch (e) {
+          console.error(`[VolcengineClient] Error in ${event} listener:`, e);
+        }
+      });
+    }
+  }
+
+  /**
+   * 开启会话
+   * 1. 建立 WebSocket 连接
+   * 2. 发送 start 指令
+   * 
+   * @param {Object} options - 配置项
+   * @param {string} [options.dataStoreId] - 知识库 ID (用于 RAG)
+   * @param {string} [options.botName] - 机器人名称 (如 "客服小助手")
+   * @param {string} [options.systemRole] - 系统角色设定 (如 "你是一个专业的客服...")
+   * @param {string} [options.speakingStyle] - 说话风格 (如 "亲切、温柔")
+   */
+  async start(options = {}) {
+    // 1. 建立 WebSocket 连接
+    let baseUrl = this.appsClient.config.apiBaseUrl.replace(/^http/, "ws"); // http->ws, https->wss
+
+    // [Removed] 本地开发环境特殊处理已移除，现在通过 Vite 代理 (ws: true) 统一转发
+
+    const token = this.appsClient._getAccessToken();
+    const url = `${baseUrl}/apps/volcengine/connect?access_token=${token || ""}`;
+
+    this.ws = new WebSocket(url);
+    this.ws.binaryType = "arraybuffer"; // 关键：接收二进制音频
+
+    return new Promise((resolve, reject) => {
+      this.ws.onopen = () => {
+        console.log("[VolcengineClient] WebSocket Connected");
+        // 2. 连接成功后，发送 start 指令
+        this.ws.send(JSON.stringify({
+          type: "start",
+          ...options,
+        }));
+      };
+
+      this.ws.onmessage = event => {
+        const data = event.data;
+
+        // === 处理二进制音频 (TTS) ===
+        if (data instanceof ArrayBuffer) {
+          const audioData = new Uint8Array(data);
+          this._emit("audio", audioData);
+          return;
+        }
+
+        // === 处理 JSON 消息 ===
+        try {
+          const msg = JSON.parse(data);
+
+          if (msg.type === "started") {
+            this.sessionId = msg.sessionId;
+            resolve(msg);
+          } else if (msg.type === "json") {
+            this._emit("json", msg);
+          } else if (msg.type === "error") {
+            this._emit("sys_error", msg);
+            reject(new Error(msg.message || "Unknown error"));
+          } else if (msg.type === "close") {
+            this._emit("close", msg);
+          }
+
+          // === 业务事件分发 ===
+          if (msg.eventId === 451 && msg.data?.results) {
+            const asrText = msg.data.results[0]?.text;
+            if (asrText) this._emit("asr", { text: asrText });
+          }
+          if (msg.eventId === 550 && msg.data?.content) {
+            this._emit("content", { text: msg.data.content });
+          }
+        } catch (err) {
+          console.warn("[VolcengineClient] Failed to parse message:", data);
+        }
+      };
+
+      this.ws.onerror = err => {
+        console.error("[VolcengineClient] WebSocket error:", err);
+        reject(err);
+      };
+
+      this.ws.onclose = () => {
+        console.log("[VolcengineClient] WebSocket Closed");
+        this._emit("close", { reason: "closed" });
+      };
+    });
+  }
+
+  /**
+   * 发送音频数据 (PCM)
+   * @param {ArrayBuffer|Uint8Array} audioData - 16k 16bit PCM 音频数据
+   */
+  async sendAudio(audioData) {
+    if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+      // 直接发送二进制数据
+      this.ws.send(audioData);
+    } else {
+      console.warn("[VolcengineClient] Cannot send audio: WebSocket not open");
+    }
+  }
+
+  /**
+   * 结束会话
+   */
+  async stop() {
+    if (this.ws) {
+      if (this.ws.readyState === WebSocket.OPEN) {
+        this.ws.send(JSON.stringify({ type: "stop" }));
+        this.ws.close();
+      }
+      this.ws = null;
+      this.sessionId = null;
+    }
+  }
+}
+
+export { VolcengineImpl };