@tacoreai/web-sdk 1.0.12 → 1.3.0

package/database/core/apps/AppsClient.js

@@ -0,0 +1,215 @@
+import { isBrowser, isBackend } from "../../../utils/index.js";
+import { BaseAppsClient } from "./BaseAppsClient.js";
+import { VolcengineImpl } from "./AppsClient.Volcengine.js";
+import { appsClientAppServerMethods } from "./AppsClient.AppServer.js";
+import { appsClientDataMethods } from "./AppsClient.Data.js";
+import { appsClientEcommerceMethods } from "./AppsClient.Ecommerce.js";
+import { appsClientUserMethods } from "./AppsClient.Users.js";
+import { appsClientRealtimeMethods } from "./AppsClient.Realtime.js";
+import { appsClientMessageMethods } from "./AppsClient.Message.js";
+import { appsClientKnowledgeBaseMethods } from "./AppsClient.KnowledgeBase.js";
+import { appsClientDeployMethods } from "./AppsClient.Deploy.js";
+import { appsClientAiMethods } from "./AppsClient.AI.js";
+import { appsClientVoiceVideoMethods } from "./AppsClient.VoiceVideo.js";
+import { appsClientStorageMethods } from "./AppsClient.Storage.js";
+import { appsClientKvMethods } from "./AppsClient.KV.js";
+import { appsClientTextInMethods } from "./AppsClient.TextIn.js";
+import { appsClientToolsMethods } from "./AppsClient.Tools.js";
+import { appsClientDebugMethods } from "./AppsClient.Debug.js";
+import { appsClientCrawlerMethods } from "./AppsClient.Crawler.js";
+
+const instanceMap = new Map();
+/**
+ * AI应用数据库客户端 - 多模型版
+ *
+ * 核心理念：
+ * - 后端只负责数据持久化（按 Model 存储和读取）
+ * - 前端 Store 负责业务逻辑处理（查询、筛选、排序、分页等）
+ * - 每个 Store 独立管理自己对应的 Model 数据
+ */
+class AppsClient extends BaseAppsClient {
+  static getInstance(tagetAppId, config = {}) {
+    const instance = instanceMap.get(tagetAppId);
+    if (instance) {
+      return instance;
+    }
+    return new AppsClient(tagetAppId, config);
+  }
+
+  constructor(appId, config = {}) {
+    super(appId, config);
+
+    if (isBackend && !this.config.tacoreServerInteropAppServerApiKey) {
+      throw new Error(
+        "tacoreServerInteropAppServerApiKey is required for backend environment. Provide it in config or via TACORE_SERVER_INTEROP_APP_SERVER_API_KEY env var."
+      );
+    }
+
+    instanceMap.set(appId, this);
+
+    // 用于本地实时数据模式的订阅者管理
+    this.subscribers = new Map();
+
+    // 初始化火山引擎实时语音客户端
+    // 传入 this (AppsClient 实例) 以便 VolcengineImpl 复用请求逻辑
+    this.volcengine = new VolcengineImpl(this);
+  }
+
+  /**
+   * 定义策略适配器映射
+   * 将 invoke 的对象参数转换为老方法的位置参数
+   */
+  get adapters() {
+    return {
+      // === 数据 CRUD ===
+      "createData": ({ modelName, data, permissions, publicConfig }) =>
+        this.createData(modelName, data, permissions, publicConfig),
+
+      "updateData": ({ modelName, wyID, data, permissions, publicConfig }) =>
+        this.updateData(modelName, wyID, data, permissions, publicConfig),
+
+      "readData": params => {
+        // readData(modelName, query)
+        // 适配逻辑：如果 params 中除了 modelName 只有一个 wyID 字段，则视为单条查询
+        const { modelName, ...rest } = params;
+        if (rest.wyID && Object.keys(rest).length === 1) {
+          return this.readData(modelName, rest.wyID);
+        }
+        return this.readData(modelName, rest);
+      },
+
+      "deleteData": ({ modelName, wyID, options }) =>
+        this.deleteData(modelName, wyID, options),
+
+      // === 电商模块 ===
+      "createProduct": params => this.createProduct(params),
+      "updateProduct": ({ productId, data }) => this.updateProduct(productId, data),
+      "deleteProduct": ({ productId }) => this.deleteProduct(productId),
+      "getProduct": ({ productId }) => this.getProduct(productId),
+      "listProducts": options => this.listProducts(options),
+
+      "createOrder": params => this.createOrder(params),
+      "updateOrder": ({ orderId, data }) => this.updateOrder(orderId, data),
+      "deleteOrder": ({ orderId }) => this.deleteOrder(orderId),
+      "getOrder": ({ orderId }) => this.getOrder(orderId),
+      "listOrders": options => this.listOrders(options),
+
+      // === 用户与角色 ===
+      "createRole": params => this.createRole(params),
+      "updateUserRole": params => this.updateUserRole(params),
+      "listAppUsers": params => this.listAppUsers(params),
+
+      // === 文件存储 ===
+      "uploadFile": ({ file }) => this.uploadFile(file),
+      "uploadToR2": ({ file }) => this.uploadToR2(file),
+      "uploadToOSS": ({ file }) => this.uploadToOSS(file),
+      "uploadToGCS": ({ file }) => this.uploadToGCS(file),
+      "downloadFromR2": ({ key }) => this.downloadFromR2(key),
+      "deleteFromR2": ({ key }) => this.deleteFromR2(key),
+      "getR2PublicUrl": ({ key }) => this.getR2PublicUrl(key),
+      "getR2UploadUrl": ({ fileName, contentType }) => this.getR2UploadUrl(fileName, contentType),
+
+      // === KV 存储 ===
+      "kvGet": ({ key, params }) => this.kvGet(key, params),
+      "kvPut": ({ key, value, options }) => this.kvPut(key, value, options),
+      "kvDelete": ({ key, params }) => this.kvDelete(key, params),
+
+      // === TextIn / OCR ===
+      "recognizeText": ({ input, options }) => this.recognizeText(input, options),
+      "wordToPdf": ({ input }) => this.wordToPdf(input),
+      "pdfToWord": ({ input }) => this.pdfToWord(input),
+      "excelToPdf": ({ input }) => this.excelToPdf(input),
+      "pdfToExcel": ({ input }) => this.pdfToExcel(input),
+      "fileToMarkdown": ({ input, options }) => this.fileToMarkdown(input, options),
+
+      // === 工具 ===
+      "addWatermark": options => this.addWatermark(options),
+      "detectSensitiveInfo": ({ content }) => this.detectSensitiveInfo(content),
+      "sendMessage": params => this.sendMessage(params),
+
+      // === 爬虫 ===
+      "scrapeUrl": options => this.scrapeUrl(options),
+      "scrapeMultipleUrls": options => this.scrapeMultipleUrls(options),
+      "firecrawlScrape": options => this.firecrawlScrape(options),
+      "firecrawlMap": options => this.firecrawlMap(options),
+
+      // === 视频 ===
+      "createVideoJob": options => this.createVideoJob(options),
+      "remixVideoJob": ({ jobId, options }) => this.remixVideoJob(jobId, options),
+      "getVideoJob": ({ jobId }) => this.getVideoJob(jobId),
+      "listVideoJobs": options => this.listVideoJobs(options),
+
+      // === 语音 ===
+      "generateVoice": options => this.generateVoice(options),
+      "streamVoice": options => this.streamVoice(options),
+
+      // === 图像 ===
+      "generateImage": options => this.generateImage(options),
+      "editImage": options => this.editImage(options),
+
+      // === AI ===
+      "streamCompletion": options => this.streamCompletion(options),
+
+      // === Knowledge Base ===
+      "createKnowledgeBaseDataStore": params => this.createKnowledgeBaseDataStore(params),
+      "deleteKnowledgeBaseDataStore": ({ storeId, provider }) => this.deleteKnowledgeBaseDataStore(storeId, provider),
+      "getKnowledgeBaseDataStore": ({ storeId, provider }) => this.getKnowledgeBaseDataStore(storeId, provider),
+      "listKnowledgeBaseDataStores": ({ provider }) => this.listKnowledgeBaseDataStores(provider),
+      "importKnowledgeBaseDocuments": params => this.importKnowledgeBaseDocuments(params),
+      "listKnowledgeBaseDocuments": ({ storeId, pageToken, pageSize, provider }) =>
+        this.listKnowledgeBaseDocuments(storeId, pageToken, pageSize, provider),
+      "deleteKnowledgeBaseDocument": ({ storeId, documentId, provider }) =>
+        this.deleteKnowledgeBaseDocument(storeId, documentId, provider),
+
+      // === [新增] 部署与环境管理 ===
+      "deployCustomer": params => this.deployCustomer(params),
+      "addCustomDomain": params => this.addCustomDomain(params),
+      "deleteCustomDomain": params => this.deleteCustomDomain(params),
+      "createEnvironment": params => this.createEnvironment(params),
+      "updateEnvironment": params => this.updateEnvironment(params),
+      "deleteEnvironment": params => this.deleteEnvironment(params),
+    };
+  }
+
+  /**
+   * 重写基类方法，提供 Token
+   */
+  _getAccessToken() {
+    if (isBrowser) {
+      return localStorage.getItem("tacoreai_apps_access_token");
+    }
+    return null;
+  }
+
+  /**
+   * 重写基类方法，执行业务错误检查
+   */
+  _validateResponse(result) {
+    // 统一的业务层面错误检查
+    if (result.code && result.code !== 200 && result.code !== 201 && !result.success) {
+      throw new Error(result.message || result.error || `Business error: ${result.code}`);
+    }
+  }
+}
+
+Object.assign(
+  AppsClient.prototype,
+  appsClientAppServerMethods,
+  appsClientDataMethods,
+  appsClientEcommerceMethods,
+  appsClientUserMethods,
+  appsClientRealtimeMethods,
+  appsClientMessageMethods,
+  appsClientKnowledgeBaseMethods,
+  appsClientDeployMethods,
+  appsClientAiMethods,
+  appsClientVoiceVideoMethods,
+  appsClientStorageMethods,
+  appsClientKvMethods,
+  appsClientTextInMethods,
+  appsClientToolsMethods,
+  appsClientDebugMethods,
+  appsClientCrawlerMethods
+);
+
+export { AppsClient };

package/database/core/apps/AppsPublicClient.js

@@ -0,0 +1,107 @@
+import { BaseAppsClient } from "./BaseAppsClient.js";
+
+/**
+ * AI应用公共数据客户端 - 无需认证
+ *
+ * 核心理念：
+ * - 用于匿名读取被 `writeData` 设为公共的数据。
+ * - 用于匿名提交数据到指定的、允许公开写入的模型。
+ * - 此客户端的所有操作都无需用户登录。
+ */
+export class AppsPublicClient extends BaseAppsClient {
+  constructor(appId, config = {}) {
+    super(appId, config);
+  }
+
+  /**
+   * 定义策略适配器映射
+   * 将 invoke 的对象参数转换为老方法的位置参数
+   */
+  get adapters() {
+    return {
+      'submitPublicData': ({ modelName, data }) => this.submitPublicData(modelName, data),
+      'readConfiguredPublicData': (params) => {
+        const { modelName, ...rest } = params;
+        if (rest.wyID && Object.keys(rest).length === 1) {
+          return this.readConfiguredPublicData(modelName, rest.wyID);
+        }
+        return this.readConfiguredPublicData(modelName, rest);
+      }
+    };
+  }
+
+  /**
+   * 提交公共数据 (例如 waitlist, contact form)
+   * @param {string} modelName - 目标模型名称 (后端会校验白名单)
+   * @param {Object} jsonData - 要提交的数据
+   * @returns {Promise<Object>} 提交成功后的响应，包含 wyID
+   */
+  async submitPublicData(modelName, jsonData) {
+    try {
+      if (!modelName) {
+        throw new Error("modelName is required");
+      }
+      if (!jsonData || typeof jsonData !== "object") {
+        throw new Error("jsonData must be a valid object");
+      }
+
+      const result = await this._post("/apps/public/data/submit", {
+        appId: this.appId,
+        modelName: modelName,
+        data: jsonData,
+      });
+
+      console.log(
+        `✅ [AppsPublicClient] Public data submitted successfully for model: ${modelName} in app: ${this.appId}`
+      );
+      return result;
+    } catch (error) {
+      console.error(`提交公共数据失败 (model: ${modelName}):`, error);
+      throw error;
+    }
+  }
+
+  /**
+   * 读取由 AppsClient.writeData 设为公共的数据 (通过 publicConfig)
+   * @param {string} modelName - 模型名称
+   * @param {string|Object} [query] - 查询参数。可以是单个 wyID 字符串，或包含分页/过滤的对象。
+   * @returns {Promise<Object|null>} 查询结果，结构与 AppsClient.readData 一致，但只包含公共字段。
+   */
+  async readConfiguredPublicData(modelName, query) {
+    try {
+      if (!modelName) {
+        throw new Error("modelName is required");
+      }
+
+      const params = {
+        appId: this.appId,
+        modelName: modelName,
+      };
+
+      if (typeof query === "string") {
+        // 支持按 wyID 查询单条
+        params.wyID = query;
+      } else if (query && typeof query === "object") {
+        // 支持列表查询、过滤和分页
+        Object.assign(params, query);
+      }
+
+      // 注意：此接口用于读取通过 publicConfig 配置的数据
+      const result = await this._get("/apps/data/public/read", params);
+
+      if (result.data === null || (Array.isArray(result.data) && result.data.length === 0)) {
+        console.log(
+          `📋 [AppsPublicClient] No configured public data found for model: ${modelName} in app: ${this.appId}`
+        );
+      } else {
+        console.log(
+          `✅ [AppsPublicClient] Configured public data read successfully for model: ${modelName} in app: ${this.appId}`
+        );
+      }
+      return result;
+    } catch (error) {
+      console.error(`读取配置的公共数据失败 (model: ${modelName}):`, error);
+      throw error;
+    }
+  }
+}

package/database/core/apps/BaseAppsClient.js

@@ -0,0 +1,216 @@
+import { getAppsApiBaseUrl, isBrowser, isBackend, getGlobalOptions } from "../../../utils/index.js";
+
+/**
+ * Apps SDK 基类
+ * 封装通用的配置管理、Header构建、HTTP请求逻辑
+ */
+export class BaseAppsClient {
+  constructor(appId, config = {}) {
+    if (!appId) {
+      throw new Error("appId is required during initialization.");
+    }
+    this.appId = appId;
+
+    const globalOptions = getGlobalOptions();
+    const defaultConfig = {
+      // 默认统一走平台接口；如需特殊链路可显式传入 apiBaseUrl 覆盖。
+      apiBaseUrl: getAppsApiBaseUrl(),
+    };
+
+    this.config = {
+      ...globalOptions.clientDefaultConfig,
+      ...defaultConfig,
+      ...config,
+    };
+
+    // 后端环境通用逻辑：尝试从环境变量加载 API Key
+    if (isBackend && !this.config.tacoreServerInteropAppServerApiKey) {
+      this.config.tacoreServerInteropAppServerApiKey = process.env.TACORE_SERVER_INTEROP_APP_SERVER_API_KEY;
+    }
+  }
+
+  /**
+   * 获取当前实例定义的策略适配器映射
+   * 子类应该重写此 getter 以注册需要参数适配的老方法
+   * @returns {Object} { 'apiName': (params) => this.method(...) }
+   */
+  get adapters() {
+    return {};
+  }
+
+  /**
+   * 统一调用入口 (策略模式)
+   * @param {string} apiName - API 名称 或 URL 路径 (如 'createData', 'agent/completions')
+   * @param {Object} params - 参数对象
+   * @returns {Promise<any>}
+   */
+  async invoke(apiName, params = {}) {
+    // 1. 优先查找适配器 (处理老方法的位置参数问题)
+    const adapter = this.adapters[apiName];
+    if (adapter) {
+      // 绑定 this 并传入 params
+      return adapter.call(this, params);
+    }
+
+    // 2. 查找原型方法 (前提：该方法必须支持单对象参数，或者 params 就是该方法需要的唯一参数)
+    // 这允许调用那些本身就设计为接收一个对象参数的方法 (如 generateImage) 而无需显式注册适配器
+    if (typeof this[apiName] === 'function') {
+      return this[apiName](params);
+    }
+
+    // 3. 默认回退机制 (通用后端接口调用)
+    // 支持两级路径，如 'agent/completions' -> '/apps/agent/completions'
+    // 如果 apiName 以 / 开头，则直接使用
+    const endpoint = apiName.startsWith('/') ? apiName : `/apps/${apiName}`;
+    
+    // console.log(`[SDK] Invoke generic API: ${endpoint}`);
+    return this._post(endpoint, params);
+  }
+
+  /**
+   * 获取 Access Token (钩子方法)
+   * 子类需重写此方法以提供认证 Token
+   * @returns {string|null}
+   */
+  _getAccessToken() {
+    return null;
+  }
+
+  /**
+   * 验证响应数据 (钩子方法)
+   * 子类可重写此方法以抛出业务特定的错误
+   * @param {Object} result - 解析后的 JSON 响应
+   */
+  _validateResponse(result) {
+    // 默认不进行额外的业务错误检查
+  }
+
+  /**
+   * 构建请求头
+   * @param {Object} additionalHeaders - 额外的 Header
+   */
+  _getRequestHeaders(additionalHeaders = {}) {
+    const headers = {
+      "Content-Type": "application/json",
+      ...additionalHeaders,
+    };
+
+    if (this.config.datasource) {
+      headers["x-datasource"] = this.config.datasource;
+    }
+
+    if (this.config.supabaseBaseUrl) {
+      headers["x-supabase-base-url"] = this.config.supabaseBaseUrl;
+    }
+    if (this.config.supabaseAnonKey) {
+      headers["x-supabase-anon-key"] = this.config.supabaseAnonKey;
+    }
+    if (this.config.supabaseRoleKey) {
+      headers["x-supabase-role-key"] = this.config.supabaseRoleKey;
+    }
+
+    if (this.config.organizationId) {
+      headers["x-org-id"] = this.config.organizationId;
+    }
+    if (this.config.projectId) {
+      headers["x-project-id"] = this.config.projectId;
+    }
+    if (this.appId) {
+      headers["x-app-id"] = this.appId;
+    }
+
+    if (isBrowser) {
+      const token = this._getAccessToken();
+      if (token) {
+        headers["Authorization"] = `Bearer ${token}`;
+      }
+    } else { // isBackend
+      if (this.config.tacoreServerInteropAppServerApiKey) {
+        headers["x-tacore-server-interop-app-server-api-key"] = this.config.tacoreServerInteropAppServerApiKey;
+      }
+    }
+
+    return headers;
+  }
+
+  /**
+   * 发送 API 请求
+   */
+  async _apiRequest(endpoint, options = {}) {
+    const url = `${this.config.apiBaseUrl}${endpoint}`;
+    const headers = this._getRequestHeaders(options.headers);
+
+    const response = await fetch(url, {
+      ...options,
+      headers,
+    });
+
+    if (!response.ok) {
+      const errorData = await response.json().catch(() => ({ error: "Network error" }));
+      console.error(`[SDK][${this.appId}] API request failed: ${response.status} ${response.statusText}`, errorData);
+      throw new Error(errorData.error || `HTTP ${response.status}: ${response.statusText}`);
+    }
+
+    const result = await response.json();
+    
+    // 调用子类的验证钩子
+    this._validateResponse(result);
+
+    return result;
+  }
+
+  /**
+   * GET 请求辅助方法
+   */
+  async _get(endpoint, params = {}) {
+    const searchParams = new URLSearchParams();
+    Object.keys(params).forEach((key) => {
+      if (params[key] !== undefined && params[key] !== null) {
+        if (typeof params[key] === "object") {
+          searchParams.append(key, JSON.stringify(params[key]));
+        } else {
+          searchParams.append(key, params[key]);
+        }
+      }
+    });
+
+    const queryString = searchParams.toString();
+    const url = queryString ? `${endpoint}?${queryString}` : endpoint;
+
+    return this._apiRequest(url, { method: "GET" });
+  }
+
+  /**
+   * POST 请求辅助方法
+   */
+  async _post(endpoint, data = {}) {
+    return this._apiRequest(endpoint, {
+      method: "POST",
+      body: JSON.stringify(data),
+    });
+  }
+
+  /**
+   * DELETE 请求辅助方法
+   */
+  async _delete(endpoint, data = {}) {
+    return this._apiRequest(endpoint, {
+      method: "DELETE",
+      body: JSON.stringify(data),
+    });
+  }
+
+  /**
+   * 更新配置
+   */
+  updateConfig(newConfig) {
+    this.config = { ...this.config, ...newConfig };
+  }
+
+  /**
+   * 获取当前配置
+   */
+  getConfig() {
+    return { ...this.config };
+  }
+}

package/index.js

@@ -0,0 +1,9 @@
+import * as utils from "./utils/index.js"
+
+// 导出AI应用专用客户端
+export { AppsClient } from "./database/core/apps/AppsClient.js"
+export { AppsAuthManager } from "./database/core/apps/AppsAuthManager.js"
+export { AppsPublicClient } from "./database/core/apps/AppsPublicClient.js"
+
+// 导出工具函数
+export { utils }

package/package.json

@@ -1,29 +1,17 @@
 {
   "name": "@tacoreai/web-sdk",
-  "version": "1.0.12",
-  "description": "TacoreAI Web SDK for AI generated applications",
-  "main": "dist/index.umd.js",
-  "unpkg": "dist/index.umd.js",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "vite build"
-  },
-  "keywords": [
-    "tacoreai",
-    "web-sdk",
-    "ai",
-    "database",
-    "utils"
-  ],
-  "author": "TacoreAI",
-  "devDependencies": {
-    "vite": "^5.0.0"
-  },
-  "peerDependencies": {},
+  "description": "This file is for app server package, not the real npm package",
+  "version": "1.3.0",
+  "type": "module",
   "publishConfig": {
     "access": "public",
-    "registry": "https://registry.npmjs.org/"
+    "registry": "https://registry.npmjs.com"
+  },
+  "exports": {
+    ".": "./index.js",
+    "./utils": "./utils/index.js"
+  },
+  "scripts": {
+    "release": "npm version minor && git commit -am \"web-sdk update version\" && npm publish"
   }
 }

package/utils/errorLogger.js

@@ -0,0 +1,28 @@
+/**
+ * 记录运行时业务逻辑错误，用于 AI 自动修复闭环。
+ * @param {string} appId - 当前应用的 ID。
+ * @param {object} errorDetails - 包含完整上下文的错误对象。
+ * @param {string} errorDetails.type - 错误类型 (e.g., 'api_error', 'data_validation_error')。
+ * @param {string} errorDetails.message - 具体的错误信息。
+ * @param {object} errorDetails.context - 错误的上下文，必须包含 params 和 response。
+ */
+export const logRuntimeError = (appId, errorDetails) => {
+  if (!appId) return
+
+  const errorKey = `TACORE_RUNTIME_ERRORS_${appId}`
+
+  try {
+    const existingErrors = JSON.parse(localStorage.getItem(errorKey) || "[]")
+    const newError = {
+      ...errorDetails,
+      timestamp: new Date().toISOString(),
+    }
+
+    // 为避免 localStorage 溢出，只保留最近的 20 条错误记录
+    const updatedErrors = [newError, ...existingErrors].slice(0, 20)
+
+    localStorage.setItem(errorKey, JSON.stringify(updatedErrors))
+  } catch (e) {
+    console.error("Failed to log runtime error:", e)
+  }
+}