@kweaver-ai/chatkit 0.1.7 → 0.1.9

package/dist/components/base/ChatKitBase.d.ts

@@ -1,5 +1,5 @@
 import { Component } from 'react';
-import { ChatMessage, ApplicationContext, ChatKitInterface, OnboardingInfo, WebSearchQuery, ExecuteCodeResult, Text2SqlResult, Text2MetricResult, AfSailorResult, ChartDataSchema } from '../../types';
+import { ChatMessage, ApplicationContext, ChatKitInterface, OnboardingInfo, WebSearchQuery, ExecuteCodeResult, Text2SqlResult, Text2MetricResult, AfSailorResult, DatasourceFilterResult, ChartDataSchema } from '../../types';
 /**
  * ChatKitBase 组件的属性接口
  */
@@ -226,6 +226,13 @@ export declare abstract class ChatKitBase<P extends ChatKitBaseProps = ChatKitBa
      * @param result AfSailor 的输入和输出结果
      */
     protected appendAfSailorBlock(messageId: string, result: AfSailorResult): void;
+    /**
+     * 添加 DatasourceFilter 工具类型的消息块
+     * 该方法由子类调用，用于在消息中添加 DatasourceFilter 查询结果
+     * @param messageId 消息 ID
+     * @param result DatasourceFilter 的输入和输出结果
+     */
+    protected appendDatasourceFilterBlock(messageId: string, result: DatasourceFilterResult): void;
     /**
      * 创建新的会话
      * 内部会调用子类实现的 generateConversation() 和 getOnboardingInfo() 方法

package/dist/components/base/assistant/LeftHeaderTool/AgentTitle.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+export interface AgentTitleProps {
+    /** Agent 名称 */
+    name?: string;
+    /** Agent 图标 URL */
+    icon?: string;
+}
+/**
+ * Agent 标题组件
+ * 显示 Agent 的名称和图标，无点击交互
+ */
+declare const AgentTitle: React.FC<AgentTitleProps>;
+export default AgentTitle;

package/dist/components/base/assistant/LeftHeaderTool/KnowledgeNetworksTree.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { KnowledgeNetworkDetail, ObjectTypeListResponse } from './types';
+export interface KnowledgeNetworksTreeProps {
+    /** 知识网络配置项（来自 config.data_source.knowledge_networks 的每一项） */
+    knowledgeNetwork: {
+        id: string;
+        name?: string;
+    };
+    /** API 调用方法 */
+    getKnowledgeNetworksDetail: (id: string) => Promise<KnowledgeNetworkDetail>;
+    getKnowledgeNetworkObjectTypes: (id: string) => Promise<ObjectTypeListResponse>;
+}
+/**
+ * 知识网络业务组件
+ * 负责数据转换和 API 调用，将知识网络数据转换为树组件所需格式
+ */
+declare const KnowledgeNetworksTree: React.FC<KnowledgeNetworksTreeProps>;
+export default KnowledgeNetworksTree;

package/dist/components/base/assistant/LeftHeaderTool/KnowledgeSource.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { KnowledgeNetworkDetail, ObjectTypeListResponse, MetricModel } from './types';
+export interface KnowledgeSourceProps {
+    /** 知识网络列表数据 */
+    knowledgeNetworks?: Array<{
+        id: string;
+        name?: string;
+    }>;
+    /** 指标 ID 列表 */
+    metricIds?: string[];
+    /** API 调用方法（从 DIPBase 传入） */
+    apiMethods?: {
+        getKnowledgeNetworksDetail: (id: string) => Promise<KnowledgeNetworkDetail>;
+        getKnowledgeNetworkObjectTypes: (id: string) => Promise<ObjectTypeListResponse>;
+        getMetricInfoByIds: (ids: string[]) => Promise<MetricModel[]>;
+    };
+}
+/**
+ * 知识来源组件
+ * 作为知识来源的入口组件，提供点击展开/收起功能
+ */
+declare const KnowledgeSource: React.FC<KnowledgeSourceProps>;
+export default KnowledgeSource;

package/dist/components/base/assistant/LeftHeaderTool/MetricTree.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { MetricModel } from './types';
+export interface MetricTreeProps {
+    /** 指标 ID 列表（来自 config.data_source.metric） */
+    metricIds: string[];
+    /** API 调用方法 */
+    getMetricInfoByIds: (ids: string[]) => Promise<MetricModel[]>;
+}
+/**
+ * 指标业务组件
+ * 负责数据转换和 API 调用，将指标数据按分组组织，转换为树组件所需格式
+ */
+declare const MetricTree: React.FC<MetricTreeProps>;
+export default MetricTree;

package/dist/components/base/assistant/LeftHeaderTool/TreeView.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import { TreeNode } from './types';
+export interface TreeViewProps {
+    /** 树节点数据 */
+    data: TreeNode[];
+    /** 节点点击回调（可选） */
+    onNodeClick?: (node: TreeNode) => void;
+    /** 节点展开/收起回调（可选） */
+    onExpand?: (expandedKeys: string[], node: TreeNode) => void;
+}
+/**
+ * 通用树组件
+ * 纯展示组件，负责渲染树形结构，自动处理 key 和 id 生成
+ */
+declare const TreeView: React.FC<TreeViewProps>;
+export default TreeView;

package/dist/components/base/assistant/LeftHeaderTool/index.d.ts

@@ -0,0 +1,34 @@
+import React from 'react';
+import { KnowledgeNetworkDetail, ObjectTypeListResponse, MetricModel } from './types';
+export interface LeftHeaderToolProps {
+    /** DIPBase 的 agentInfo 对象 */
+    agentInfo: {
+        name?: string;
+        avatar?: string;
+        config?: {
+            data_source?: {
+                knowledge_network?: Array<{
+                    knowledge_network_id: string;
+                    name?: string;
+                }>;
+                metric?: Array<{
+                    metric_model_id: string;
+                    name?: string;
+                }>;
+            };
+        };
+    };
+    /** API 调用方法（从 DIPBase 传入） */
+    apiMethods?: {
+        getKnowledgeNetworksDetail: (id: string) => Promise<KnowledgeNetworkDetail>;
+        getKnowledgeNetworkObjectTypes: (id: string) => Promise<ObjectTypeListResponse>;
+        getMetricInfoByIds: (ids: string[]) => Promise<MetricModel[]>;
+    };
+    showAside?: boolean;
+}
+/**
+ * LeftHeaderTool 主入口组件
+ * 渲染到左侧顶栏位置，包含 AgentTitle 和 KnowledgeSource
+ */
+declare const LeftHeaderTool: React.FC<LeftHeaderToolProps>;
+export default LeftHeaderTool;

package/dist/components/base/assistant/LeftHeaderTool/types.d.ts

@@ -0,0 +1,78 @@
+import { ReactNode } from 'react';
+/**
+ * 树节点数据结构
+ * 注意：使用 childrens（复数）作为子节点属性名
+ */
+export interface TreeNode {
+    /** 节点标题 */
+    title: string;
+    /** 节点图标（React 节点） */
+    icon?: ReactNode;
+    /** 节点唯一标识（可选，组件会自动生成） */
+    key?: string;
+    /** 子节点列表（可选，使用 childrens 而非 children） */
+    childrens?: Array<{
+        title: string;
+        icon?: ReactNode;
+        key?: string;
+        childrens?: Array<TreeNode>;
+    }>;
+}
+/**
+ * 知识网络详情接口
+ * 参考 agent-app.schemas.yaml#/components/schemas/KnowledgeNetworkDetail
+ */
+export interface KnowledgeNetworkDetail {
+    id: string;
+    name: string;
+    tags?: string[];
+    comment?: string;
+    icon?: string;
+    color?: string;
+    detail?: string;
+    branch?: string;
+    business_domain?: string;
+    [key: string]: any;
+}
+/**
+ * 对象类型列表响应接口
+ * 参考 agent-app.schemas.yaml#/components/schemas/ObjectTypeListResponse
+ */
+export interface ObjectTypeListResponse {
+    entries: ObjectType[];
+    total_count: number;
+}
+/**
+ * 对象类型接口
+ * 参考 agent-app.schemas.yaml#/components/schemas/ObjectType
+ */
+export interface ObjectType {
+    id: string;
+    name: string;
+    data_properties: DataProperty[];
+    [key: string]: any;
+}
+/**
+ * 数据属性接口
+ * 参考 agent-app.schemas.yaml#/components/schemas/DataProperty
+ */
+export interface DataProperty {
+    name: string;
+    display_name?: string;
+    type: string;
+    comment?: string;
+    [key: string]: any;
+}
+/**
+ * 指标模型接口
+ * 参考 agent-app.schemas.yaml#/components/schemas/MetricModel
+ */
+export interface MetricModel {
+    id: string;
+    name: string;
+    group_id?: string;
+    group_name?: string;
+    catalog_id?: string;
+    catalog_content?: string;
+    [key: string]: any;
+}

package/dist/components/dip/DIPBase.d.ts

@@ -318,6 +318,24 @@ export declare function DIPBaseMixin<TBase extends Constructor>(Base: TBase): {
             cites?: any[];
             result_cache_key?: string;
         } | null;
+        /**
+         * 从 skill_info.args 和 answer 中提取 DatasourceFilter 结果
+         * 用于处理 datasource_filter 工具的输入和输出
+         * 根据 OpenAPI 规范，DatasourceFilterResult 包含 result
+         * - result: DatasourceFilterResultData（包含 result、result_cache_key）
+         * - result.result: DataCatalogMatch[]（数据目录匹配结果列表）
+         * @param _args skill_info.args 数组，包含查询参数（当前未使用，保留以保持接口一致性）
+         * @param answer 技能执行的 answer 字段，包含数据源过滤结果
+         * @returns DatasourceFilterResult 对象，包含 result、result_cache_key 等信息
+         */
+        extractDatasourceFilterResult(_args: Array<{
+            name?: string;
+            type?: string;
+            value?: string;
+        }> | undefined, answer: any): {
+            result: Array<any>;
+            result_cache_key?: string;
+        } | null;
         /**
          * 将技能调用或 LLM 回答的内容追加到消息中
          * 用于历史消息解析，根据 stage 和 skill_info 将内容添加到 ChatMessage.content 数组
@@ -394,6 +412,35 @@ export declare function DIPBaseMixin<TBase extends Constructor>(Base: TBase): {
          * @returns 返回 Promise，成功时 resolve，失败时 reject
          */
         deleteConversation(conversationID: string): Promise<void>;
+        /**
+         * 获取知识网络详情
+         * 调用 DIP 的 GET /api/ontology-manager/v1/knowledge-networks/{id} 接口
+         * API 端点: GET /api/ontology-manager/v1/knowledge-networks/{id}
+         * 注意：该方法是一个无状态无副作用的函数，不允许修改 state
+         * @param id 知识网络 ID
+         * @returns 返回知识网络详情
+         */
+        getKnowledgeNetworksDetail(id: string): Promise<any>;
+        /**
+         * 获取知识网络的对象类型
+         * 调用 DIP 的 GET /api/ontology-manager/v1/knowledge-networks/{id}/object-types 接口
+         * API 端点: GET /api/ontology-manager/v1/knowledge-networks/{id}/object-types
+         * 注意：该方法是一个无状态无副作用的函数，不允许修改 state
+         * @param id 知识网络 ID
+         * @param offset 偏移量，默认 0
+         * @param limit 每页返回条数，默认 -1（全部）
+         * @returns 返回对象类型列表
+         */
+        getKnowledgeNetworkObjectTypes(id: string, offset?: number, limit?: number): Promise<any>;
+        /**
+         * 根据指标 ID 获取指标信息
+         * 调用 DIP 的 GET /api/mdl-data-model/v1/metric-models/{ids} 接口
+         * API 端点: GET /api/mdl-data-model/v1/metric-models/{ids}
+         * 注意：该方法是一个无状态无副作用的函数，不允许修改 state
+         * @param ids 指标 ID 列表，多个用逗号隔开
+         * @returns 返回指标信息列表
+         */
+        getMetricInfoByIds(ids: string[]): Promise<any[]>;
     };
 } & TBase;
 export {};

package/dist/components/icons/KnowledgeSourceIcon.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+/**
+ * 知识源图标组件
+ */
+export declare const KnowledgeSourceIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+export default KnowledgeSourceIcon;

package/dist/components/icons/KownledgeNetworkIcon.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+/**
+ * 知识网络图标组件
+ */
+export declare const KownledgeNetworkIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+export default KownledgeNetworkIcon;

package/dist/components/icons/MetricIcon.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+/**
+ * 指标图标组件
+ */
+export declare const MetricIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+export default MetricIcon;

package/dist/components/icons/TreeExpandIcon.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+/**
+ * 树节点展开/收起图标（收起态，右箭头 chevron）
+ * 展开时由使用方顺时针旋转 90°，收起时逆时针旋转回去
+ */
+export declare const TreeExpandIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+export default TreeExpandIcon;

package/dist/components/icons/index.d.ts

@@ -19,3 +19,6 @@ export { NewIcon } from './NewIcon';
 export { ExpandIcon } from './ExpandIcon';
 export { CopyIcon } from './CopyIcon';
 export { RefreshIcon } from './RefreshIcon';
+export { KnowledgeSourceIcon } from './KnowledgeSourceIcon';
+export { MetricIcon } from './MetricIcon';
+export { TreeExpandIcon } from './TreeExpandIcon';

package/dist/types/index.d.ts

@@ -244,6 +244,33 @@ export interface AfSailorResult {
     /** 结果缓存key */
     result_cache_key?: string;
 }
+/**
+ * 数据目录匹配结果接口
+ * 根据 OpenAPI 规范定义
+ */
+export interface DataCatalogMatch {
+    /** 引用类型 */
+    type: 'data_catalog';
+    /** 数据目录标题 */
+    title: string;
+    /** 数据目录ID */
+    id: string;
+    /** 匹配原因 */
+    reason?: string;
+    /** 匹配的列信息，键为字段技术名称，值为字段值 */
+    matched_columns?: Array<Record<string, string>>;
+}
+/**
+ * DatasourceFilter 结果接口
+ * DatasourceFilter 工具的输入和输出信息
+ * 根据 OpenAPI 规范和设计文档定义
+ */
+export interface DatasourceFilterResult {
+    /** 数据目录匹配结果列表 */
+    result: DataCatalogMatch[];
+    /** 结果缓存key */
+    result_cache_key?: string;
+}
 /**
  * 工具调用数据接口
  * 工具调用的输入和输出信息

package/dist/utils/BlockRegistry.d.ts

@@ -23,11 +23,17 @@ export interface ToolBlockRegistration {
 export declare class BlockRegistry {
     private static registry;
     /**
-     * 注册工具信息
+     * 注册单个工具信息
      * @param registration 工具注册信息，包含 name, Icon, onClick
-     * @throws 如果工具名称已注册，将抛出错误
+     * 如果工具已注册，将直接覆盖原有注册信息
      */
     static registerTool(registration: ToolBlockRegistration): void;
+    /**
+     * 批量注册工具信息
+     * @param registrations 工具注册信息数组，包含 name, Icon, onClick
+     * 如果工具已注册，将直接覆盖原有注册信息
+     */
+    static registerTools(registrations: Array<ToolBlockRegistration>): void;
     /**
      * 取消注册
      * @param toolName 工具名称

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kweaver-ai/chatkit",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "publishConfig": {
     "access": "public"
   },