@huanban/rulego-editor-react 1.3.18 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/README.md +304 -10
  2. package/dist/components/AIAssistant.d.ts +1 -7
  3. package/dist/components/ComponentSidebar.d.ts +13 -52
  4. package/dist/components/ContextMenu.d.ts +1 -59
  5. package/dist/components/CopilotChat.d.ts +27 -22
  6. package/dist/components/DataViewDialog.d.ts +0 -33
  7. package/dist/components/DebugPanel.d.ts +5 -65
  8. package/dist/components/DynamicForm.d.ts +0 -40
  9. package/dist/components/EdgePropertyDrawer.d.ts +0 -35
  10. package/dist/components/EditorConnectionStatus.d.ts +12 -0
  11. package/dist/components/EditorEdgeHoverTools.d.ts +11 -0
  12. package/dist/components/EditorIcon.d.ts +7 -0
  13. package/dist/components/EditorNodeHoverTools.d.ts +16 -0
  14. package/dist/components/EditorPanelDock.d.ts +18 -0
  15. package/dist/components/EditorStatusBar.d.ts +34 -0
  16. package/dist/components/EditorToolbar.d.ts +2 -62
  17. package/dist/components/ImportExportDialog.d.ts +1 -37
  18. package/dist/components/LogViewer.d.ts +0 -29
  19. package/dist/components/MiniMap.d.ts +0 -46
  20. package/dist/components/NodePropertyDrawer.d.ts +19 -102
  21. package/dist/components/ProblemsPanel.d.ts +21 -0
  22. package/dist/components/RuleChainSettings.d.ts +0 -45
  23. package/dist/components/RuleGoEditor.d.ts +37 -147
  24. package/dist/components/RuleMaintenancePanel.d.ts +0 -1
  25. package/dist/components/SearchPanel.d.ts +0 -39
  26. package/dist/components/SearchableSelect.d.ts +0 -1
  27. package/dist/components/ValidationPanel.d.ts +0 -39
  28. package/dist/components/WorkflowExplorer.d.ts +24 -0
  29. package/dist/components/WorkflowInfoPanel.d.ts +1 -36
  30. package/dist/components/WorkflowList.d.ts +2 -69
  31. package/dist/components/WorkspaceTabs.d.ts +17 -0
  32. package/dist/components/properties/AgentOrchestrationProperties.d.ts +2 -1
  33. package/dist/hooks/useBoundStore.d.ts +8 -0
  34. package/dist/hooks/useClipboard.d.ts +2 -63
  35. package/dist/hooks/useEditorCore.d.ts +0 -79
  36. package/dist/hooks/useEditorI18n.d.ts +0 -26
  37. package/dist/hooks/useEditorPanels.d.ts +23 -0
  38. package/dist/hooks/useEditorShell.d.ts +35 -0
  39. package/dist/hooks/useEditorTheme.d.ts +0 -30
  40. package/dist/hooks/useEditorWorkspace.d.ts +25 -0
  41. package/dist/hooks/useKeyboardShortcuts.d.ts +4 -44
  42. package/dist/i18n.d.ts +6 -4
  43. package/dist/index.cjs +17 -0
  44. package/dist/index.d.ts +28 -62
  45. package/dist/index.esm.js +6235 -104685
  46. package/dist/style.css +1 -1
  47. package/package.json +13 -8
  48. package/dist/index.cjs.js +0 -9470
package/README.md CHANGED
@@ -24,7 +24,7 @@ pnpm add @huanban/rulego-editor-react
24
24
  ```
25
25
 
26
26
  > **自动安装的依赖:** `@huanban/rulego-editor-core`、`@logicflow/core`、`@logicflow/extension`
27
- > **需要宿主项目提供:** `react >= 16.8`、`react-dom >= 16.8`
27
+ > **需要宿主项目提供:** `react >= 17.0`、`react-dom >= 17.0`。发布产物使用经典 JSX runtime,浏览器打包、Node ESM、CommonJS 和 SSR 均复用宿主提供的 React。
28
28
 
29
29
  ---
30
30
 
@@ -45,6 +45,33 @@ import '@huanban/rulego-editor-react/style.css'
45
45
  | `RuleGoEditor` | 规则链编辑器 | 完整的可视化编辑器(内置工具栏、侧边栏、属性面板等全部 UI)|
46
46
  | `WorkflowList` | 工作流列表 | 卡片/列表两种布局,支持搜索、创建、部署/下线、复制、删除、详情联动和设计跳转 |
47
47
  | `WorkflowInfoPanel` | 工作流信息面板 | 展示单条链的详细信息和配置 |
48
+ | `CopilotChat` | 独立 AI 对话 | 可单独引用;支持流式响应、停止、思考过程和宿主持久化 |
49
+
50
+ ### 独立 `CopilotChat`
51
+
52
+ `CopilotChat` 是独立组件,不依赖 `RuleGoEditor`。默认只保留内存会话;需要刷新恢复
53
+ 或多个实例隔离时,由宿主显式传入 `persistence`。组件不会自行选择 `localStorage`
54
+ 或创建自定义请求:
55
+
56
+ ```tsx
57
+ <CopilotChat
58
+ ruleChainId="orders"
59
+ apiBase={apiBase}
60
+ model="gpt-5.4-mini"
61
+ fetchHeaders={() => ({ Authorization: `Bearer ${token}` })}
62
+ persistence={{
63
+ adapter: {
64
+ getItem: key => localStorage.getItem(key),
65
+ setItem: (key, value) => localStorage.setItem(key, value),
66
+ removeItem: key => localStorage.removeItem(key),
67
+ },
68
+ namespace: { host: 'orders-app', editorInstance: 'customer-copilot', version: 'v1' },
69
+ }}
70
+ />
71
+ ```
72
+
73
+ 持久化 key 按 `host/editorInstance/version/chainId/component` 隔离;不传
74
+ `persistence` 时组件仍可正常调用宿主提供的 OpenAI 兼容接口,但刷新后不恢复历史。
48
75
 
49
76
  ---
50
77
 
@@ -82,7 +109,7 @@ function EditorPage({ chainId }: { chainId: string }) {
82
109
  | 功能 | 说明 |
83
110
  |------|------|
84
111
  | 工具栏 | 保存、撤销/重做、部署、运行、导入/导出、主题切换、语言切换 |
85
- | 组件侧边栏 | 按分类展示节点组件,支持搜索(拼音搜索)和拖拽添加 |
112
+ | 组件侧边栏 | 按分类展示节点组件,支持搜索(拼音搜索)和拖拽添加;超大分类自动使用固定行高虚拟窗口 |
86
113
  | 右键菜单 | 节点/边/画布右键菜单(复制、删除、查看属性等)|
87
114
  | 节点属性面板 | 点击节点弹出属性编辑 Drawer,含 CodeMirror 代码编辑器 |
88
115
  | 边属性面板 | 点击连线弹出路由关系编辑 Drawer |
@@ -96,16 +123,22 @@ function EditorPage({ chainId }: { chainId: string }) {
96
123
  |------|------|--------|------|
97
124
  | `data` | `RuleChainData \| null` | `null` | 规则链数据 |
98
125
  | `apiBase` | `string` | - | 后端 API 地址(如 `http://localhost:9090/api/v1`)|
99
- | `theme` | `string` | `'modern'` | 主题:`classic` / `dark` / `nature` / `elegant` / `tech` / `modern` |
126
+ | `components` | `RawComponentData` | - | 可选组件表;不传时按 `apiBase` 请求真实 `/components` |
127
+ | `mode` | `EditorMode` | `'standalone'` | standalone / embedded / headless 能力模式 |
128
+ | `capabilities` | `EditorCapabilitiesOverride` | - | 覆盖当前模式的能力树 |
129
+ | `disabled` | `boolean` | `false` | 禁用编辑动作但保留查看能力 |
130
+ | `dataUpdatePolicy` | `'preserve-dirty' \| 'replace'` | `'preserve-dirty'` | 外部数据更新时的 dirty 保护策略 |
131
+ | `theme` | `string` | `'default'` | 主题:`default` / `dark` / `nature` / `elegant` / `tech` / `modern` |
100
132
  | `locale` | `string` | `'zh-CN'` | 语言:`zh-CN` / `en-US` |
101
133
  | `toolbarTitle` | `string` | - | 工具栏标题 |
102
- | `showChainInfo` | `boolean` | `true` | 是否显示链信息头部 |
103
134
  | `height` | `string \| number` | `'100%'` | 编辑器高度 |
104
135
  | `width` | `string \| number` | `'100%'` | 编辑器宽度 |
105
136
  | `className` | `string` | `''` | 自定义 className |
106
137
  | `style` | `CSSProperties` | `{}` | 自定义样式 |
107
138
  | `fetchHeaders` | `Record<string,string> \| () => Record<string,string>` | - | 给编辑器内部请求注入认证 headers |
108
139
  | `customFetch` | `(url, init) => Promise<Response>` | - | 完全替换请求逻辑 |
140
+ | `enableConnectionStatus` | `boolean` | `false` | 启用真实规则链节点、endpoint 和共享节点连接状态轮询 |
141
+ | `onConnectionStatusChange` | `(state) => void` | - | 当前 Core 节点/共享节点连接状态变化,不增加轮询 |
109
142
  | `showSettingsButton` | `boolean` | `true` | 是否显示设置入口 |
110
143
  | `showAiChatButton` | `boolean` | `true` | 是否显示 AI 助理入口 |
111
144
  | `showRunButton` | `boolean` | `true` | 是否显示运行调试入口 |
@@ -114,8 +147,90 @@ function EditorPage({ chainId }: { chainId: string }) {
114
147
  | `onNodeClick` | `(node) => void` | - | 节点点击回调 |
115
148
  | `onNodeDbClick` | `(node) => void` | - | 节点双击回调 |
116
149
  | `onEdgeClick` | `(edge) => void` | - | 边点击回调 |
117
- | `onSave` | `(data) => boolean \| { success?: boolean; message?: string } \| Promise<...>` | - | 宿主接管保存回调;不传时内置 `POST + GET` 保存校验 |
118
- | `onDeploy` | `(chainId, action: 'start' \| 'stop' \| 'reload') => void \| Promise<void>` | - | 部署/下线/重载回调;部署对应 `start`,下线对应 `stop` |
150
+ | `onSave` | `(data) => void` | - | 保存请求观察事件,不接管实际保存 |
151
+ | `saveMode` | `'builtin' \| 'host'` | `'builtin'` | 保存执行模式 |
152
+ | `saveHandler` | `(data) => EditorSaveResult \| Promise<EditorSaveResult>` | - | `saveMode="host"` 时的宿主保存执行器 |
153
+ | `showRestartButton` | `boolean` | `false` | 显示真实重启按钮;不会调用 `operate/reload` |
154
+ | `onDeploy` | `(chainId, action: 'start' \| 'stop') => void \| Promise<void>` | - | 部署/下线回调;后端动作严格对应 `start/stop` |
155
+ | `onRestart` | `(chainId) => void \| Promise<void>` | - | 宿主接管重启;必须读取服务端 DSL 后原样保存 |
156
+
157
+ 重启不是 `operate` 的第三种动作。内置实现会先读取 `GET /rules/:id`,再把服务端返回的
158
+ 完整 DSL 原样提交到 `POST /rules/:id`。画布有未保存修改时会先确认并完成真实保存;
159
+ 保存未确认成功则不会重启。`showReloadButton` 只作为旧配置的弃用别名保留。
160
+
161
+ `enableConnectionStatus` 默认关闭。开启后,编辑器实例按当前规则链串行请求
162
+ `GET {apiBase}/rules/:id/status`,共享节点管理面板打开期间按引用请求
163
+ `GET {apiBase}/shared-node-statuses`。React 适配层不会额外创建轮询器;刷新和共享状态引用
164
+ 通过同一个 standalone 实例暴露:
165
+
166
+ ```tsx
167
+ editorRef.current?.refreshConnectionStatuses()
168
+ const release = editorRef.current?.acquireSharedConnectionStatuses()
169
+ // 关闭共享节点管理面板时释放本次引用。
170
+ release?.()
171
+ ```
172
+
173
+ 宿主需要在自定义 UI 中响应式展示状态时,主组件直接使用变更回调:
174
+
175
+ ```tsx
176
+ const [connectionState, setConnectionState] = useState<ConnectionStatusState | null>(null)
177
+
178
+ <RuleGoEditor
179
+ ref={editorRef}
180
+ enableConnectionStatus
181
+ onConnectionStatusChange={setConnectionState}
182
+ />
183
+ ```
184
+
185
+ 自定义组合层已经持有 `ConnectionStatusStore` 时,可使用
186
+ `useConnectionStatus({ connectionStatus: hostStore })` 订阅同一个 store。hook 不创建请求;
187
+ 未传 store 时只返回空状态。
188
+
189
+ 状态接口返回 `401/403` 时会暂停对应轮询并交给宿主认证流程,`404/501` 表示后端未提供能力
190
+ 并停止探测,网络错误只标记状态可能已过期,不会伪造在线状态。连接状态是运行时展示数据,
191
+ 不会写入 LogicFlow history、节点复制结果、DSL 导出或保存 payload。
192
+
193
+ ---
194
+
195
+ ### 命令式加载与工作区 Tab
196
+
197
+ 通过 `ref` 可以加载规则链或激活已有工作区 Tab。适配层只把调用透传给同一个
198
+ `HuanbanRulegoEditor` 实例,不会重建 LogicFlow:
199
+
200
+ ```tsx
201
+ import { useRef } from 'react'
202
+ import {
203
+ RuleGoEditor,
204
+ type RuleGoEditorRef,
205
+ } from '@huanban/rulego-editor-react'
206
+
207
+ const editorRef = useRef<RuleGoEditorRef>(null)
208
+
209
+ <RuleGoEditor ref={editorRef} apiBase={apiBase} data={chainData} />
210
+
211
+ // 新远程数据或导入数据:建立新的已保存基线。
212
+ editorRef.current?.loadData(remoteChain)
213
+
214
+ // 恢复当前 Tab 的草稿:保留原 savedData,dirty 标记和 JSON diff 不会丢失。
215
+ editorRef.current?.loadData(tabDraft, { preserveWorkspaceTab: true })
216
+
217
+ // 激活已有 Tab,并把该 Tab 的草稿同步回画布;Tab 不存在时返回 false。
218
+ const activated = editorRef.current?.activateWorkspaceTab(tabId) ?? false
219
+ ```
220
+
221
+ `preserveWorkspaceTab` 只用于恢复当前已有 Tab 的草稿。首次加载、新建远程规则链或
222
+ 导入 clean 快照时不要开启,否则宿主可能保留错误的保存基线。确实需要同时打开同一
223
+ `chainId` 的多个工作副本时,可以显式传 `{ allowDuplicateWorkspaceTab: true }`。
224
+
225
+ 自定义工作台隐藏内置工具栏时,可以直接打开组件管理的指定页签:
226
+
227
+ ```tsx
228
+ editorRef.current?.openComponentManager('shared')
229
+ ```
230
+
231
+ 页签类型为 `ComponentManageDialogTab`,可选 `installed` / `market` / `dsl` /
232
+ `shared`。设置 `onComponentManage` 接管弹窗时,回调会收到同一个初始页签;未接管时使用
233
+ Core 内置管理器,不会在 React 层创建第二套请求或状态轮询。
119
234
 
120
235
  ---
121
236
 
@@ -151,6 +266,29 @@ function EditorPage({ chainId }: { chainId: string }) {
151
266
 
152
267
  如果不传 `onLoginClick`,内置设置页会打开默认登录弹窗,并请求 `POST {apiBase}/login`。完整新项目接入说明见根目录 [docs/CLIENT_INTEGRATION.md](../../docs/CLIENT_INTEGRATION.md)。
153
268
 
269
+ ### 结构性配置与重建边界
270
+
271
+ `lfOptions`、`lfPlugins` 和 `persistence` 在 `HuanbanRulegoEditor` 构造时绑定,属于结构性配置。
272
+ 它们不会被普通 props 更新热替换;这是为了避免 LogicFlow 插件、Dock/Panel 持久化订阅和当前画布
273
+ 在设置页切换时被隐式销毁。`updateOptions()` 返回的 `structuralKeys` 会列出这类变更。
274
+
275
+ 宿主需要更换这些配置时,应先处理未保存修改,再改变 React 的原生 `key`,让适配器完整销毁并重建:
276
+
277
+ ```tsx
278
+ <RuleGoEditor
279
+ key={`${editorInstanceId}:${structuralConfigVersion}`}
280
+ lfOptions={lfOptions}
281
+ lfPlugins={lfPlugins}
282
+ options={{ persistence }}
283
+ data={chainData}
284
+ apiBase={apiBase}
285
+ />
286
+ ```
287
+
288
+ 不要用每次 render 都新建的对象内容作为 `key`,否则会造成画布闪屏、焦点丢失和未保存数据风险。
289
+ Vue 适配器使用同一契约:通过 `<RuleGoEditor :key="structuralConfigVersion" ... />` 显式重建,
290
+ 普通 API、主题、语言、显示开关和回调仍使用热更新,不应为了这些选项重建画布。
291
+
154
292
  ---
155
293
 
156
294
  ### 保存协议
@@ -164,13 +302,15 @@ GET {apiBase}/rules/:id
164
302
 
165
303
  第二次 `GET` 用于回读校验,只有后端返回的数据与当前画布一致时才会显示已保存。
166
304
 
167
- 只有宿主确实要完全接管保存时才传 `onSave`。接管后必须返回明确结果:
305
+ 只有宿主确实要完全接管保存时才设置 `saveMode="host"` 并传 `saveHandler`。执行器必须
306
+ 返回明确结果:
168
307
 
169
308
  ```tsx
170
309
  <RuleGoEditor
171
310
  apiBase={apiBase}
172
311
  data={chainData}
173
- onSave={async (data: any) => {
312
+ saveMode="host"
313
+ saveHandler={async (data: any) => {
174
314
  const id = data?.ruleChain?.id
175
315
  const resp = await fetch(`${apiBase}/rules/${encodeURIComponent(id)}`, {
176
316
  method: 'POST',
@@ -182,7 +322,8 @@ GET {apiBase}/rules/:id
182
322
  />
183
323
  ```
184
324
 
185
- 如果只是打印日志,不要传 `onSave`,否则会改变保存语义。需要观察变化时使用 `onChange` 或浏览器日志。
325
+ `onSave` 只观察一次保存请求,不会短路或重复执行内置保存。需要观察画布变化时使用
326
+ `onChange`;不要在 `onSave` 中再次 POST,否则宿主自己的请求会和内置保存重复。
186
327
 
187
328
  ---
188
329
 
@@ -220,13 +361,34 @@ function WorkflowPage() {
220
361
  | `autoOpenAfterCreate` | `boolean` | ❌ | 传了 `onDesign` 时默认开启;新建成功后自动进入编辑器 |
221
362
  | `onDesign` | `(chainId: string) => void` | ❌ | 点击“设计”按钮的回调,宿主在这里进入编辑器 |
222
363
  | `onInfo` | `(workflow: WorkflowItem) => void` | ❌ | 单击卡片或点击“信息”后的回调 |
223
- | `onViewLogs` | `(chainId: string) => void` | ❌ | 点击“日志”按钮的回调 |
364
+ | `onViewLogs` | `(chainId: string, workflow?: WorkflowItem) => void` | ❌ | 点击“日志”按钮的回调;第二个参数是当前列表接口返回的真实工作流对象 |
224
365
  | `onCreateSuccess` | `(chainId: string) => void` | ❌ | 创建成功后的通知回调;进入编辑器建议交给 `onDesign` |
225
366
  | `icons` | `WorkflowListIcons` | ❌ | 自定义图标 |
226
367
  | `theme` | `WorkflowTheme` | ❌ | 自定义主题色 |
227
368
 
228
369
  默认新建弹窗包含 ID、名称、主链/子链、初始状态、调试模式、分类、描述。ID 自动生成,也可手动输入;为兼容后台路由,ID 不能包含 `/`、`\` 或 `.`。卡片单击会调用 `onInfo`,双击或菜单“设计”会调用 `onDesign`。
229
370
 
371
+ `apiOptions` 可直接接入宿主登录态,不需要在 `WorkflowList` 内部重复维护登录页:
372
+
373
+ ```tsx
374
+ <WorkflowList
375
+ apiBase={apiBase}
376
+ apiOptions={{
377
+ headers: () => ({ Authorization: `Bearer ${readToken()}` }),
378
+ credentials: 'include',
379
+ onAuthRequired: ({ status }) => host.openLogin({ reason: status }),
380
+ serverStatus,
381
+ }}
382
+ onError={showRequestError}
383
+ />
384
+ ```
385
+
386
+ 内置 `RuleChainAPI` 默认兼容读取浏览器 `token`/`access_token`;纯 Cookie 宿主应设置
387
+ `includeStoredToken: false`。HTTP 401 表示凭据缺失或失效,宿主应打开登录流程并清理失效凭据;
388
+ HTTP 403 表示凭据有效但权限不足,保留当前凭据并显示权限提示;网络失败和超时通过
389
+ `onError` 暴露为离线或请求失败。列表不会把这些结果误显示成空数据。`customFetch` 可由宿主
390
+ 统一接管 CSRF、Cookie、刷新 token 和请求取消。
391
+
230
392
  ---
231
393
 
232
394
  ## 三、WorkflowInfoPanel — 工作流信息面板
@@ -332,6 +494,11 @@ function App() {
332
494
  | Hook | 说明 |
333
495
  |------|------|
334
496
  | `useEditorCore` | 创建和管理 EditorCore 实例 |
497
+ | `useEditorWorkspace` | 多 Tab、草稿、保存冲突和 dirty 关闭确认 |
498
+ | `useEditorDock` | 左右/底部/AI Dock 的响应式状态和拖动尺寸 |
499
+ | `useEditorPanels` | 节点配置、文档、Problems、调试、运行记录、发送和 AI Tab 状态 |
500
+ | `useServerStatus` | API 授权状态与 WebSocket 连接状态 |
501
+ | `useConnectionStatus` | 节点、endpoint 与共享节点连接状态;只订阅 Core store |
335
502
  | `useEditorTheme` | 主题切换 |
336
503
  | `useEditorI18n` | 国际化切换 |
337
504
  | `useKeyboardShortcuts` | 键盘快捷键绑定 |
@@ -356,6 +523,133 @@ export default function EditorPage() {
356
523
  }
357
524
  ```
358
525
 
526
+ ### 独立工作区 Tab
527
+
528
+ 需要自己组合多规则链工作台时,可以直接使用 `WorkspaceTabs`,它只渲染
529
+ `EditorWorkspace` 的状态,不自行保存或删除数据。未保存 Tab 的关闭确认由宿主
530
+ 调用 `workspace.closeTabWithDecision` 处理:
531
+
532
+ ```tsx
533
+ import { WorkspaceTabs, useEditorWorkspace } from '@huanban/rulego-editor-react'
534
+ import '@huanban/rulego-editor-react/style.css'
535
+
536
+ const workspace = useEditorWorkspace()
537
+ return (
538
+ <WorkspaceTabs
539
+ tabs={workspace.tabs}
540
+ activeTabId={workspace.activeTab?.id}
541
+ onActivate={workspace.activateTab}
542
+ onClose={tabId => workspace.closeTab(tabId)}
543
+ onAdd={() => workspace.openTab({ title: '新规则链' })}
544
+ onEditInfo={tabId => openRuleChainInfo(tabId)}
545
+ onTabAction={(tabId, action) => {
546
+ if (action === 'rename') openRuleChainInfo(tabId)
547
+ if (action === 'run-history') openRunHistory(tabId)
548
+ if (action === 'debug') openDebugPanel(tabId)
549
+ if (action === 'toggle-disabled') toggleChainDisabled(tabId)
550
+ }}
551
+ />
552
+ )
553
+ ```
554
+
555
+ Tab 组件会显示主链/子链、加载状态、未保存标记和超出宽度后的选择菜单;它不
556
+ 会重新创建画布,也不会绕过宿主的保存、权限和后端请求策略。右键菜单动作 ID
557
+ 由 Core 固定为 `rename`、`toggle-disabled`、`run-history`、`debug`;动作的真实
558
+ 保存、`start`/`stop` 请求、登录和错误反馈由宿主处理。
559
+
560
+ ### 独立状态栏与连接状态
561
+
562
+ 需要自己组合编辑器外壳时,可以直接复用 `EditorStatusBar` 和
563
+ `EditorConnectionStatus`。两者只读取宿主传入的 LogicFlow/Core 状态,不会自行
564
+ 请求后端、重连 WebSocket 或触发登录;401/403 的登录和离线重试由宿主接管:
565
+
566
+ ```tsx
567
+ import {
568
+ EditorConnectionStatus,
569
+ EditorStatusBar,
570
+ useServerStatus,
571
+ } from '@huanban/rulego-editor-react'
572
+
573
+ const { state: serverState } = useServerStatus({ baseUrl: API_BASE })
574
+ return (
575
+ <>
576
+ <EditorConnectionStatus
577
+ state={serverState}
578
+ onLogin={() => openLogin()}
579
+ onRetry={() => checkConnection()}
580
+ />
581
+ <EditorStatusBar
582
+ lf={editorRef.current?.lf}
583
+ problemCount={problems.length}
584
+ onOpenDiagnostics={() => openDiagnostics()}
585
+ />
586
+ </>
587
+ )
588
+ ```
589
+
590
+ `EditorConnectionStatus` 会分别展示 API 和 WS 状态,避免把未授权、网络不可达
591
+ 和实时连接断开混成一个状态。`EditorStatusBar` 提供缩放、节点数、边数、选中数
592
+ 和诊断入口;缩放操作直接委托给传入的 `lf`。
593
+
594
+ ### 独立 Dock 面板
595
+
596
+ `EditorPanelDock` 是 `EditorPanelRegistry` / `EditorDockStore` 的展示层,不创建第二套
597
+ 面板状态。它支持左侧堆叠面板、右侧/底部/AI Dock Tab、关闭 Dock、关闭面板和拖动尺寸:
598
+
599
+ ```tsx
600
+ import { EditorPanelDock, useEditorDock, useEditorPanels } from '@huanban/rulego-editor-react'
601
+
602
+ const dock = useEditorDock()
603
+ const panels = useEditorPanels({ dockStore: dock.dock })
604
+ return (
605
+ <EditorPanelDock
606
+ dock="right"
607
+ dockState={dock.state}
608
+ panelState={panels.state}
609
+ onActivatePanel={panels.activatePanel}
610
+ onClosePanel={panels.closePanel}
611
+ onToggleDock={(id, visible) => dock.setDockVisibility(id, visible)}
612
+ onResize={(id, size) => id === 'bottom'
613
+ ? dock.setDockHeight(id, size)
614
+ : dock.setDockWidth(id, size)}
615
+ renderPanel={panel => panel.id === 'info' ? <InfoPanel /> : <ConfigPanel />}
616
+ />
617
+ )
618
+ ```
619
+
620
+ 面板定义只保存 ID、Dock、标题、图标和排序;具体内容由宿主 render 函数提供,避免
621
+ 把 Vue 单体页面或客服场景打进通用 React 包。
622
+
623
+ ### 节点与连线悬浮工具
624
+
625
+ `EditorNodeHoverTools` 和 `EditorEdgeHoverTools` 是独立的画布操作条。宿主负责把
626
+ LogicFlow 的选中目标和画布坐标传入,组件只展示按钮和转发动作:
627
+
628
+ ```tsx
629
+ <EditorNodeHoverTools
630
+ targetId={selectedNode.id}
631
+ x={toolbarPosition.x}
632
+ y={toolbarPosition.y}
633
+ onEdit={openNodeEditor}
634
+ onDelete={id => confirmDeleteNode(id)}
635
+ onRunFrom={openRunPanel}
636
+ />
637
+ <EditorEdgeHoverTools
638
+ targetId={selectedEdge.id}
639
+ x={edgePosition.x}
640
+ y={edgePosition.y}
641
+ onInsertNode={insertNodeOnEdge}
642
+ onDelete={id => confirmDeleteEdge(id)}
643
+ />
644
+ ```
645
+
646
+ 删除不会直接操作 LogicFlow,必须由宿主/Core 完成二次确认和实际变更;按钮自带
647
+ `title` 与 `aria-label`,位置接近画布边界时可以通过 `flipDown` 翻转。
648
+
649
+ `EditorEdgeHoverTools` 的 `onInsertNode` 回调参数是连线 ID。宿主应调用主编辑器的
650
+ `openNodePicker({ edgeId, excludeInputNodes: true })`,由 Core 完成
651
+ `source -> new -> target` 替换和失败回滚,不能把该 ID 当作节点 ID 直接追加边。
652
+
359
653
  ### App Router
360
654
 
361
655
  ```tsx
@@ -2,21 +2,15 @@ import React from 'react';
2
2
  import type { AIAssistantOpenOptions, HuanbanRulegoEditor } from '@huanban/rulego-editor-core';
3
3
  import type { RuleGoEditorRef } from './RuleGoEditor';
4
4
  export interface AIAssistantProps {
5
- /** RuleGoEditor ref;适合放在宿主自定义工具栏中 */
6
5
  editorRef?: React.RefObject<RuleGoEditorRef | null>;
7
- /** core 编辑器实例;适合非 ref 场景直接调用 */
8
6
  editor?: HuanbanRulegoEditor | null;
9
- /** 打开 AI 助手时携带的上下文 */
10
7
  options?: AIAssistantOpenOptions;
11
- /** 是否只显示图标 */
12
8
  iconOnly?: boolean;
13
- /** 按钮文本 */
14
9
  label?: string;
15
10
  className?: string;
16
11
  style?: React.CSSProperties;
17
12
  disabled?: boolean;
18
13
  onOpen?: () => void;
19
14
  }
20
- export declare function AIAssistant({ editorRef, editor, options, iconOnly, label, className, style, disabled, onOpen, }: AIAssistantProps): import("react/jsx-runtime").JSX.Element;
15
+ export declare function AIAssistant({ editorRef, editor, options, iconOnly, label, className, style, disabled, onOpen, }: AIAssistantProps): React.JSX.Element;
21
16
  export default AIAssistant;
22
- //# sourceMappingURL=AIAssistant.d.ts.map
@@ -1,87 +1,48 @@
1
- /**
2
- * @file components/ComponentSidebar.tsx
3
- * @description 组件侧边栏 — React 实现
4
- *
5
- * 功能:
6
- * - 展示 RuleGo 组件列表,按 category 分组折叠
7
- * - 支持关键词搜索过滤组件
8
- * - 拖拽组件到画布触发 onDragStart 事件
9
- * - 根据组件类型显示不同分类的颜色标签
10
- * - 零 UI 框架依赖(纯 React + CSS)
11
- *
12
- * 数据入参:
13
- * @param components — 后端返回的原始组件数组
14
- * @param onDragStart — 拖拽开始的回调,传递组件数据
15
- * @param collapsed — 是否收起侧边栏
16
- *
17
- * @see ComponentDefinition — 组件定义类型
18
- */
19
1
  import React from 'react';
20
2
  import { type LocaleMessages } from '@huanban/rulego-editor-core';
21
3
  import type { EditorTranslate } from '../i18n';
22
- /** 组件字段定义(用于属性编辑面板) */
23
4
  export interface ComponentField {
24
- /** 字段名 */
25
5
  name: string;
26
- /** 字段类型:string | bool | int | float | map | array | code | json | select */
27
6
  type: string;
28
- /** 显示标签 */
29
7
  label?: string;
30
- /** 字段描述 */
31
8
  desc?: string;
32
- /** 默认值 */
33
9
  defaultValue?: unknown;
34
- /** 校验规则 */
35
10
  rules?: unknown[];
36
11
  }
37
- /** 单个组件定义 */
38
12
  export interface RuleGoComponent {
39
- /** 组件类型标识,如 'action/log' */
40
13
  type: string;
41
- /** 分类,如 'action' | 'filter' | 'transform' */
42
14
  category: string;
43
- /** 显示标签 */
15
+ categoryPath?: string;
16
+ subgroup?: string;
17
+ categorySubgroups?: Array<Record<string, unknown>>;
44
18
  label?: string;
45
- /** 描述 */
46
19
  desc?: string;
47
- /** 字段定义列表 */
48
20
  fields?: ComponentField[];
49
- /** 自定义图标 */
50
21
  icon?: string;
51
- /** 组件颜色 */
52
22
  background?: string;
53
- /** 是否无输入端口 */
23
+ order?: number;
24
+ disabled?: boolean;
54
25
  notInput?: boolean;
55
- /** 是否无输出端口 */
56
26
  notOutput?: boolean;
57
- /** 额外扩展属性 */
58
27
  [key: string]: unknown;
59
28
  }
60
- /** 组件侧边栏 Props */
61
29
  export interface ComponentSidebarProps {
62
- /** 后端组件原始列表 */
63
30
  components: RuleGoComponent[];
64
- /** 拖拽开始回调 */
65
31
  onDragStart?: (component: RuleGoComponent) => void;
66
- /** 是否收起 */
32
+ recentComponentTypes?: string[];
67
33
  collapsed?: boolean;
68
- /** 搜索框占位符 */
69
34
  searchPlaceholder?: string;
70
- /** Current locale. Defaults to zh-CN. */
71
35
  locale?: string;
72
- /** Extra locale messages merged into the selected locale. */
73
36
  messages?: LocaleMessages;
74
- /** Host-provided translation function. */
75
37
  t?: EditorTranslate;
76
- /** Icon theme. Defaults to default; accepts default/dark/nature/elegant/tech/modern. */
77
38
  theme?: string;
39
+ virtualization?: {
40
+ enabled?: boolean;
41
+ threshold?: number;
42
+ itemHeight?: number;
43
+ viewportHeight?: number;
44
+ overscan?: number;
45
+ };
78
46
  }
79
- /**
80
- * ComponentSidebar 组件
81
- *
82
- * 纯 React + CSS 实现的组件侧边栏,无 antd 依赖。
83
- * 提供分类分组、搜索过滤、拖拽功能。
84
- */
85
47
  declare const ComponentSidebar: React.FC<ComponentSidebarProps>;
86
48
  export default ComponentSidebar;
87
- //# sourceMappingURL=ComponentSidebar.d.ts.map
@@ -1,75 +1,29 @@
1
- /**
2
- * @file components/ContextMenu.tsx
3
- * @description 右键上下文菜单 — React 实现
4
- *
5
- * 功能:
6
- * - 节点右键菜单(复制/粘贴/删除/编辑属性/查看连接)
7
- * - 边右键菜单(编辑属性/删除)
8
- * - 画布右键菜单(粘贴/适配画布/选中全部)
9
- * - 子菜单支持
10
- * - 点击外部自动关闭
11
- * - 键盘导航支持
12
- * - 零 UI 框架依赖(纯 React + CSS)
13
- *
14
- * @see ContextMenuProps — 菜单参数
15
- */
16
1
  import React from 'react';
17
2
  import type { FrameworkI18nProps } from '../i18n';
18
- /** 菜单项定义 */
19
3
  export interface ContextMenuItem {
20
- /** 唯一标识 */
21
4
  key: string;
22
- /** 显示标签 */
23
5
  label: string;
24
- /** 图标(emoji 或文本) */
25
6
  icon?: string;
26
- /** 快捷键提示文本 */
27
7
  shortcut?: string;
28
- /** 是否禁用 */
29
8
  disabled?: boolean;
30
- /** 是否隐藏 */
31
9
  hidden?: boolean;
32
- /** 是否为危险操作(红色样式) */
33
10
  danger?: boolean;
34
- /** 分隔线(在此项前添加分隔线) */
35
11
  dividerBefore?: boolean;
36
- /** 子菜单 */
37
12
  children?: ContextMenuItem[];
38
- /** 点击回调 */
39
13
  onClick?: () => void;
40
14
  }
41
- /** 菜单目标类型 */
42
15
  export type ContextMenuTarget = 'node' | 'edge' | 'canvas';
43
16
  export type ContextMenuI18nOptions = FrameworkI18nProps;
44
- /** ContextMenu Props */
45
17
  export interface ContextMenuProps {
46
- /** 是否可见 */
47
18
  visible: boolean;
48
- /** 菜单显示坐标 X */
49
19
  x: number;
50
- /** 菜单显示坐标 Y */
51
20
  y: number;
52
- /** 右键目标类型 */
53
21
  targetType?: ContextMenuTarget;
54
- /** 右键目标 ID */
55
22
  targetId?: string;
56
- /** 菜单项列表 */
57
23
  items: ContextMenuItem[];
58
- /** 关闭菜单回调 */
59
24
  onClose: () => void;
60
25
  }
61
- /**
62
- * ContextMenu 组件
63
- *
64
- * 纯 React 实现的右键菜单,支持子菜单和键盘导航。
65
- */
66
26
  declare const ContextMenu: React.FC<ContextMenuProps>;
67
- /**
68
- * 生成节点右键菜单项
69
- *
70
- * @param handlers - 菜单操作回调
71
- * @returns 菜单项列表
72
- */
73
27
  export declare function getNodeContextMenuItems(handlers: {
74
28
  onCopy?: () => void;
75
29
  onPaste?: () => void;
@@ -79,23 +33,12 @@ export declare function getNodeContextMenuItems(handlers: {
79
33
  onDuplicate?: () => void;
80
34
  onRunFromNode?: () => void;
81
35
  onRunSingleNode?: () => void;
36
+ nodeType?: unknown;
82
37
  }, i18n?: ContextMenuI18nOptions): ContextMenuItem[];
83
- /**
84
- * 生成边右键菜单项
85
- *
86
- * @param handlers - 菜单操作回调
87
- * @returns 菜单项列表
88
- */
89
38
  export declare function getEdgeContextMenuItems(handlers: {
90
39
  onEditProperties?: () => void;
91
40
  onDelete?: () => void;
92
41
  }, i18n?: ContextMenuI18nOptions): ContextMenuItem[];
93
- /**
94
- * 生成画布右键菜单项
95
- *
96
- * @param handlers - 菜单操作回调
97
- * @returns 菜单项列表
98
- */
99
42
  export declare function getCanvasContextMenuItems(handlers: {
100
43
  onPaste?: () => void;
101
44
  onSelectAll?: () => void;
@@ -103,4 +46,3 @@ export declare function getCanvasContextMenuItems(handlers: {
103
46
  onResetZoom?: () => void;
104
47
  }, i18n?: ContextMenuI18nOptions): ContextMenuItem[];
105
48
  export default ContextMenu;
106
- //# sourceMappingURL=ContextMenu.d.ts.map