@xiaozhi-client/shared-types 2.0.0 → 2.1.0

package/dist/tool-definition-B6f-mWPy.d.ts

@@ -0,0 +1,93 @@
+import { J as JSONSchema } from './schema-Bs4SCukS.js';
+
+/**
+ * CustomMCP 工具类型定义
+ * 前后端共享的权威类型定义
+ */
+
+/**
+ * 工具处理器配置联合类型
+ */
+type ToolHandlerConfig = MCPHandlerConfig | ProxyHandlerConfig | HttpHandlerConfig | FunctionHandlerConfig;
+/**
+ * MCP 处理器配置
+ * 用于标准 MCP 服务中的工具
+ */
+interface MCPHandlerConfig {
+    type: "mcp";
+    config: {
+        serviceName: string;
+        toolName: string;
+    };
+}
+/**
+ * 代理处理器配置
+ * 用于第三方平台代理（如 Coze、OpenAI 等）
+ */
+interface ProxyHandlerConfig {
+    type: "proxy";
+    platform: "coze" | "openai" | "anthropic" | "custom";
+    config: Record<string, unknown>;
+}
+/**
+ * HTTP 处理器配置
+ * 用于 HTTP API 工具
+ */
+interface HttpHandlerConfig {
+    type: "http";
+    config: {
+        url: string;
+        method?: string;
+        headers?: Record<string, string>;
+    };
+}
+/**
+ * 函数处理器配置
+ * 用于自定义函数工具
+ */
+interface FunctionHandlerConfig {
+    type: "function";
+    config: {
+        module: string;
+        function: string;
+    };
+}
+/**
+ * CustomMCP 工具基础接口
+ * 前后端共享的工具类型定义
+ */
+interface CustomMCPTool {
+    /** 工具唯一标识符 */
+    name: string;
+    /** 工具描述信息 */
+    description: string;
+    /** 工具输入参数的 JSON Schema 定义 */
+    inputSchema: JSONSchema;
+    /** 处理器配置 */
+    handler: ToolHandlerConfig;
+}
+/**
+ * 带统计信息的 CustomMCP 工具
+ * 用于 API 响应，使用扁平的统计信息结构
+ */
+interface CustomMCPToolWithStats extends CustomMCPTool {
+    /** 工具是否启用 (true=已启用，false=已禁用) */
+    enabled?: boolean;
+    /** 工具使用次数（扁平结构，与 API 响应格式一致） */
+    usageCount?: number;
+    /** 最后使用时间（ISO 8601 格式） */
+    lastUsedTime?: string;
+}
+/**
+ * 配置文件中的 CustomMCP 工具
+ * 使用嵌套的 stats 结构以保持 JSON 可读性
+ */
+interface CustomMCPToolConfig extends CustomMCPTool {
+    /** 使用统计信息（嵌套结构，仅用于配置文件） */
+    stats?: {
+        usageCount?: number;
+        lastUsedTime?: string;
+    };
+}
+
+export type { CustomMCPTool as C, FunctionHandlerConfig as F, HttpHandlerConfig as H, MCPHandlerConfig as M, ProxyHandlerConfig as P, ToolHandlerConfig as T, CustomMCPToolConfig as a, CustomMCPToolWithStats as b };

package/dist/toolApi-D-G8Chst.d.ts

@@ -0,0 +1,200 @@
+import { C as CozeWorkflow, c as WorkflowParameterConfig } from './workflow-Dl-hsNZK.js';
+import { b as CustomMCPToolWithStats } from './tool-definition-B6f-mWPy.js';
+
+/**
+ * 工具添加 API 相关类型定义
+ * 支持多种工具类型的添加，包括 MCP 工具、Coze 工作流等
+ */
+
+/**
+ * 工具类型枚举
+ */
+declare enum ToolType {
+    /** MCP 工具（标准 MCP 服务中的工具） */
+    MCP = "mcp",
+    /** Coze 工作流工具 */
+    COZE = "coze",
+    /** HTTP API 工具（预留） */
+    HTTP = "http",
+    /** 自定义函数工具（预留） */
+    FUNCTION = "function"
+}
+/**
+ * MCP 工具数据
+ * 用于将标准 MCP 服务中的工具添加到 customMCP.tools 配置中
+ */
+interface MCPToolData {
+    /** MCP 服务名称 */
+    serviceName: string;
+    /** 工具名称 */
+    toolName: string;
+    /** 可选的自定义名称 */
+    customName?: string;
+    /** 可选的自定义描述 */
+    customDescription?: string;
+}
+/**
+ * Coze 工作流数据
+ * 保持与现有格式的兼容性
+ */
+interface CozeWorkflowData {
+    /** Coze 工作流信息 */
+    workflow: CozeWorkflow;
+    /** 可选的自定义名称 */
+    customName?: string;
+    /** 可选的自定义描述 */
+    customDescription?: string;
+    /** 可选的参数配置 */
+    parameterConfig?: WorkflowParameterConfig;
+}
+/**
+ * HTTP API 工具数据（预留）
+ */
+interface HttpApiToolData {
+    /** API 地址 */
+    url: string;
+    /** HTTP 方法 */
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    /** API 描述 */
+    description: string;
+    /** 请求头 */
+    headers?: Record<string, string>;
+    /** 请求体模板 */
+    bodyTemplate?: string;
+    /** 认证配置 */
+    auth?: {
+        type: "bearer" | "basic" | "api_key";
+        token?: string;
+        username?: string;
+        password?: string;
+        apiKey?: string;
+        apiKeyHeader?: string;
+    };
+    /** 可选的自定义名称 */
+    customName?: string;
+    /** 可选的自定义描述 */
+    customDescription?: string;
+}
+/**
+ * 函数工具数据（预留）
+ */
+interface FunctionToolData {
+    /** 模块路径 */
+    module: string;
+    /** 函数名 */
+    function: string;
+    /** 函数描述 */
+    description: string;
+    /** 函数执行上下文 */
+    context?: Record<string, any>;
+    /** 超时时间 */
+    timeout?: number;
+    /** 可选的自定义名称 */
+    customName?: string;
+    /** 可选的自定义描述 */
+    customDescription?: string;
+}
+/**
+ * 添加自定义工具的统一请求接口
+ */
+interface AddCustomToolRequest {
+    /** 工具类型 */
+    type: ToolType;
+    /** 工具数据（根据类型不同而不同） */
+    data: MCPToolData | CozeWorkflowData | HttpApiToolData | FunctionToolData;
+}
+/**
+ * 工具验证错误类型
+ */
+declare enum ToolValidationError {
+    /** 无效的工具类型 */
+    INVALID_TOOL_TYPE = "INVALID_TOOL_TYPE",
+    /** 缺少必需字段 */
+    MISSING_REQUIRED_FIELD = "MISSING_REQUIRED_FIELD",
+    /** 工具不存在 */
+    TOOL_NOT_FOUND = "TOOL_NOT_FOUND",
+    /** 服务不存在 */
+    SERVICE_NOT_FOUND = "SERVICE_NOT_FOUND",
+    /** 工具名称冲突 */
+    TOOL_NAME_CONFLICT = "TOOL_NAME_CONFLICT",
+    /** 配置验证失败 */
+    CONFIG_VALIDATION_FAILED = "CONFIG_VALIDATION_FAILED",
+    /** 系统配置错误 */
+    SYSTEM_CONFIG_ERROR = "SYSTEM_CONFIG_ERROR",
+    /** 资源限制超出 */
+    RESOURCE_LIMIT_EXCEEDED = "RESOURCE_LIMIT_EXCEEDED"
+}
+/**
+ * 工具验证错误详情
+ */
+interface ToolValidationErrorDetail {
+    /** 错误类型 */
+    error: ToolValidationError;
+    /** 错误消息 */
+    message: string;
+    /** 错误详情 */
+    details?: any;
+    /** 建议的解决方案 */
+    suggestions?: string[];
+}
+/**
+ * 添加工具的响应数据
+ */
+interface AddToolResponse {
+    /** 成功添加的工具 */
+    tool: any;
+    /** 工具名称 */
+    toolName: string;
+    /** 工具类型 */
+    toolType: ToolType;
+    /** 添加时间戳 */
+    addedAt: string;
+}
+/**
+ * 工具元数据信息
+ */
+interface ToolMetadata {
+    /** 工具原始来源 */
+    source: {
+        type: "mcp" | "coze" | "http" | "function";
+        serviceName?: string;
+        toolName?: string;
+        url?: string;
+    };
+    /** 添加时间 */
+    addedAt: string;
+    /** 最后更新时间 */
+    updatedAt?: string;
+    /** 版本信息 */
+    version?: string;
+}
+/**
+ * 工具配置选项
+ */
+interface ToolConfigOptions {
+    /** 是否启用工具（默认 true） */
+    enabled?: boolean;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 重试次数 */
+    retryCount?: number;
+    /** 重试间隔（毫秒） */
+    retryDelay?: number;
+    /** 自定义标签 */
+    tags?: string[];
+    /** 工具分组 */
+    group?: string;
+}
+/**
+ * 扩展的 CustomMCPTool 接口
+ * 包含额外的元数据信息
+ * 扩展自 CustomMCPToolWithStats，添加元数据和配置选项
+ */
+interface ExtendedCustomMCPTool extends CustomMCPToolWithStats {
+    /** 工具元数据 */
+    metadata?: ToolMetadata;
+    /** 配置选项 */
+    config?: ToolConfigOptions;
+}
+
+export { type AddCustomToolRequest as A, type CozeWorkflowData as C, type ExtendedCustomMCPTool as E, type FunctionToolData as F, type HttpApiToolData as H, type MCPToolData as M, ToolType as T, type AddToolResponse as a, ToolValidationError as b, type ToolConfigOptions as c, type ToolMetadata as d, type ToolValidationErrorDetail as e };

package/dist/utils.d.ts

@@ -0,0 +1,115 @@
+export { T as TimeoutError, a as TimeoutResponse, i as isTimeoutError, b as utilsIsTimeoutResponse } from './timeout-D1mc0P3r.js';
+
+/**
+ * 性能监控相关类型定义
+ */
+/**
+ * 性能指标接口
+ */
+interface PerformanceMetrics {
+    serviceName: string;
+    connectionLatency: number;
+    averageToolCallLatency: number;
+    toolCallLatencies: Map<string, number[]>;
+    successRate: number;
+    errorRate: number;
+    totalOperations: number;
+    successfulOperations: number;
+    failedOperations: number;
+    lastUpdated: Date;
+    uptime: number;
+    startTime: Date;
+}
+/**
+ * 操作类型枚举
+ */
+declare enum OperationType {
+    CONNECTION = "connection",
+    TOOL_CALL = "tool_call",
+    RECONNECTION = "reconnection",
+    HEALTH_CHECK = "health_check"
+}
+/**
+ * 计时器接口
+ */
+interface Timer {
+    id: string;
+    operation: string;
+    serviceName: string;
+    startTime: number;
+    type: OperationType;
+}
+/**
+ * 性能统计摘要
+ */
+interface PerformanceSummary {
+    /** 总连接数 */
+    totalConnections: number;
+    /** 活跃连接数 */
+    activeConnections: number;
+    /** 平均连接延迟 */
+    averageConnectionLatency: number;
+    /** 平均工具调用延迟 */
+    averageToolCallLatency: number;
+    /** 总体成功率 */
+    overallSuccessRate: number;
+    /** 总操作数 */
+    totalOperations: number;
+    /** 性能评分（0-100） */
+    performanceScore: number;
+}
+
+/**
+ * 日志相关类型定义
+ */
+/**
+ * 工具调用记录接口
+ */
+interface ToolCallRecord {
+    toolName: string;
+    originalToolName?: string;
+    serverName?: string;
+    arguments?: any;
+    result?: any;
+    success: boolean;
+    duration?: number;
+    error?: string;
+    timestamp?: number;
+}
+/**
+ * 工具调用日志配置接口
+ */
+interface ToolCallLogConfig {
+    maxRecords?: number;
+    logFilePath?: string;
+}
+/**
+ * 日志级别枚举
+ */
+declare enum LogLevel {
+    TRACE = "trace",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    FATAL = "fatal"
+}
+/**
+ * 日志配置接口
+ */
+interface LogConfig {
+    /** 日志级别 */
+    level?: LogLevel;
+    /** 是否启用彩色输出 */
+    colorize?: boolean;
+    /** 是否启用时间戳 */
+    timestamp?: boolean;
+    /** 日志格式 */
+    format?: "json" | "pretty";
+    /** 日志输出路径 */
+    outputPath?: string;
+    /** 是否同时输出到文件和控制台 */
+    both?: boolean;
+}
+
+export { type LogConfig, LogLevel, OperationType, type PerformanceMetrics, type PerformanceSummary, type Timer, type ToolCallLogConfig, type ToolCallRecord };

package/dist/utils.js

@@ -0,0 +1,15 @@
+import {
+  LogLevel,
+  OperationType,
+  TimeoutError,
+  isTimeoutError,
+  isTimeoutResponse
+} from "./chunk-25HXKDEV.js";
+export {
+  LogLevel,
+  OperationType,
+  TimeoutError,
+  isTimeoutError,
+  isTimeoutResponse as utilsIsTimeoutResponse
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/workflow-Dl-hsNZK.d.ts

@@ -0,0 +1,86 @@
+import { J as JSONSchema } from './schema-Bs4SCukS.js';
+
+/**
+ * 扣子工作流相关类型定义
+ */
+
+/**
+ * 扣子工作流创建者信息
+ */
+interface CozeWorkflowCreator {
+    /** 创建者ID */
+    id: string;
+    /** 创建者名称 */
+    name: string;
+}
+/**
+ * 扣子工作流接口
+ */
+interface CozeWorkflow {
+    /** 工作流ID */
+    workflow_id: string;
+    /** 工作流名称 */
+    workflow_name: string;
+    /** 工作流描述 */
+    description: string;
+    /** 工作流图标URL */
+    icon_url: string;
+    /** 关联应用ID */
+    app_id: string;
+    /** 创建者信息 */
+    creator: CozeWorkflowCreator;
+    /** 创建时间戳 */
+    created_at: number;
+    /** 更新时间戳 */
+    updated_at: number;
+    /** 是否已添加为工具（前端运行时属性） */
+    isAddedAsTool?: boolean;
+    /** 输入参数Schema（前端运行时属性） */
+    inputSchema?: JSONSchema;
+    /** 工具名称（前端运行时属性） */
+    toolName?: string | null;
+}
+/**
+ * 获取工作流列表的响应数据
+ */
+interface CozeWorkflowsData {
+    /** 是否有更多数据 */
+    has_more: boolean;
+    /** 工作流列表 */
+    items: CozeWorkflow[];
+}
+/**
+ * 获取工作流列表的请求参数
+ */
+interface CozeWorkflowsParams {
+    /** 工作空间ID */
+    workspace_id: string;
+    /** 页码，从1开始 */
+    page_num?: number;
+    /** 每页数量，默认20 */
+    page_size?: number;
+    /** 工作流模式，默认为 workflow */
+    workflow_mode?: "workflow";
+}
+/**
+ * 工作流参数定义
+ */
+interface WorkflowParameter {
+    /** 英文字段名，用作参数标识符 */
+    fieldName: string;
+    /** 中英文描述，说明参数用途 */
+    description: string;
+    /** 参数类型 */
+    type: "string" | "number" | "boolean";
+    /** 是否必填参数 */
+    required: boolean;
+}
+/**
+ * 工作流参数配置
+ */
+interface WorkflowParameterConfig {
+    /** 参数列表 */
+    parameters: WorkflowParameter[];
+}
+
+export type { CozeWorkflow as C, WorkflowParameter as W, CozeWorkflowCreator as a, CozeWorkflowsParams as b, WorkflowParameterConfig as c, CozeWorkflowsData as d };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiaozhi-client/shared-types",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "小智项目的共享类型定义",
   "type": "module",
   "main": "./dist/index.js",