@deep-eye/core 0.2.1 → 0.3.0

package/README.md

@@ -1,32 +1,77 @@
 # @deep-eye/core
 
-深瞳前端团队企业级 Vue 3 组件库 | Deep-Eye - Enterprise Vue 3 Component Library for DeepTong Team
+深瞳前端 Vue 3 组件库 — 思维导图与 AI 会话渲染。
 
-## 💡 关于 About
+## 安装
 
-Deep-Eye 是为深瞳前端团队打造的企业级组件库，封装了团队内部常用且难以重新封装的组件。这是 King 为深瞳前端团队付出的一份努力，旨在提升团队开发效率，统一技术标准。
+```bash
+pnpm add @deep-eye/core
+# 或 npm install @deep-eye/core
+```
 
-Deep-Eye is an enterprise-grade component library built for the DeepTong frontend team, encapsulating commonly used and hard-to-reimplement components. This is King's contribution to the DeepTong frontend team, aiming to improve development efficiency and unify technical standards.
+```ts
+import { D3MindMap, AiConversation, useConversation, ASK_USER_FORM_SYSTEM_PROMPT } from '@deep-eye/core'
+import '@deep-eye/core/style.css'
+```
 
-## 安装 Installation
+> 注意：包名是 **`@deep-eye/core`**，不是旧的 `deepeye-core`。
 
-```bash
-# npm
-npm install @deep-eye/core
+## 组件
 
-# pnpm
-pnpm add @deep-eye/core
+| 组件 | 说明 |
+| --- | --- |
+| **D3MindMap** | D3 思维导图：缩放、拖拽、折叠、主题 |
+| **AiConversation** | AI 会话渲染：流式文本、富媒体、工具调用、AskUserForm |
+
+输入框与 SSE 由宿主实现；库只负责消息渲染。
+
+## AiConversation 快速上手
+
+### 基础流式
+
+```ts
+import { AiConversation, useConversation } from '@deep-eye/core'
+
+const { messages, appendDelta } = useConversation()
+
+appendDelta({ id: 'a1', role: 'assistant', contentDelta: chunk })
+appendDelta({ id: 'a1', contentDelta: more })
+appendDelta({ id: 'a1', done: true })
+```
 
-# yarn
-yarn add @deep-eye/core
+```vue
+<AiConversation :messages="messages" auto-scroll="smart" />
+```
+
+富媒体标记：`[IMG:{...}]` / `[VIDEO:{...}]` / `[AUDIO:{...}]`
+
+### 交互组件（AskUserForm）
+
+将 `ASK_USER_FORM_SYSTEM_PROMPT` 拼入 LLM system，模型输出 `{% ask-form %}` 后，表单 dock 在对话区底部；监听 `@action` 回传。
+
+```ts
+import { ASK_USER_FORM_SYSTEM_PROMPT } from '@deep-eye/core'
+
+const system = ['你是助手……', ASK_USER_FORM_SYSTEM_PROMPT].join('\n\n')
 ```
 
-## 使用 Usage
+```vue
+<AiConversation
+  :messages="messages"
+  :user-avatar="userAvatarUrl"
+  :assistant-avatar="assistantAvatarUrl"
+  @action="onAction"
+/>
+```
+
+- 不传 `userAvatar` / `assistantAvatar`（也无对应插槽）则不显示头像
+- AskUserForm 暂不支持自定义位置（固定底部居中）
+
+## D3MindMap 快速上手
 
 ```vue
 <script setup>
 import { D3MindMap } from '@deep-eye/core'
-import '@deep-eye/core/style.css'
 
 const data = {
   nodeData: {
@@ -34,28 +79,26 @@ const data = {
     topic: 'Deep-Eye',
     root: true,
     children: [
-      { id: '1', topic: '可视化组件' },
-      { id: '2', topic: '布局组件' },
+      { id: '1', topic: '可视化' },
+      { id: '2', topic: 'AI 会话' },
     ],
   },
 }
 </script>
 
 <template>
-  <D3MindMap :data="data" height="600px" />
+  <D3MindMap :data="data" height="600px" show-toolbar />
 </template>
 ```
 
-## 组件 Components
+## 要求
 
-- **D3MindMap** - 基于 D3.js 的高性能思维导图组件，支持缩放、拖拽、展开折叠等交互功能
-- **AiConversation** - AI 对话渲染组件，支持流式文本、富媒体（`[IMG]` / `[VIDEO]` / `[AUDIO]`）、工具调用与 AskUserForm（`{% ask-form %}`）；配合 `useConversation` 与 `ASK_USER_FORM_SYSTEM_PROMPT` 使用
+| 依赖 | 版本 |
+| --- | --- |
+| Node.js | ≥ 22 |
+| Vue | ≥ 3.5 |
+| TypeScript | ≥ 5.9（开发） |
 
 ## License
 
-MIT
-
----
-
-**作者 Author：King**  
-**团队 Team：深瞳前端团队 DeepTong Frontend Team**
+MIT · Author: King · 深瞳前端团队

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deep-eye/core",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -35,7 +35,10 @@
     "component-library",
     "ui",
     "mindmap",
-    "visualization"
+    "visualization",
+    "ai",
+    "chat",
+    "conversation"
   ],
   "author": "King <xintao.king@example.com>",
   "license": "MIT",