@huanban/rulego-editor-core 1.3.18 → 1.4.0

package/dist/types/editor.d.ts

@@ -1,292 +1,139 @@
-/**
- * @file editor.ts
- * @description 编辑器选项、状态和配置的类型定义
- *
- * 定义了编辑器初始化选项、运行时状态、工具栏配置、
- * API 端点配置等核心类型。这些类型在 EditorCore 和各适配器中通用。
- */
 import type { RuleChainConfig, RuleNodeConfig, RuleConnectionConfig, RuleChainData } from './rule-chain';
 import type { ComponentDefinition, ComponentGroup, RawComponentData } from './component';
-/**
- * 后端 API 端点配置
- * 支持 :id 和 :chainId 等路径参数替换
- */
+import type { EditorAction } from '../core/ActionRegistry';
+import type { FieldCapabilityHandler } from '../core/FieldCapabilityRegistry';
+import type { OptionSourceResolver } from '../core/OptionSourceRegistry';
+import type { FieldChangeHandler } from '../core/FieldChangeRegistry';
+import type { ComponentDocProvider } from '../core/ComponentDocService';
 export interface ApiEndpoints {
-    /** 组件列表接口 (默认: /api/v1/components) */
     componentsApi: string;
-    /** 规则链保存/加载接口 (默认: /api/v1/rule/:id) */
     ruleApi: string;
-    /** 调试数据接口 (默认: /api/v1/event/debug) */
     debugDataApi: string;
-    /** 消息发送接口 (默认: /api/v1/msg/:chainId/:msgType) */
     msgApi: string;
 }
-/**
- * 通用 HTTP 请求配置
- * 统一所有 API 调用的请求行为
- */
 export interface RequestConfig {
-    /** 后端 API 基础 URL (默认: http://127.0.0.1:9090) */
     baseUrl: string;
-    /** 请求超时时间 (毫秒, 默认: 8000) */
     timeout: number;
-    /** 自定义请求头 */
     headers?: Record<string, string>;
-    /** 自定义 fetch 实现 (可用于注入认证 token 等) */
     fetchImpl?: typeof fetch;
 }
-/**
- * 工具栏按钮显示配置
- */
 export interface ToolbarConfig {
-    /** 显示测试按钮 */
     showTest: boolean;
-    /** 显示新建/打开按钮 */
     showNewOrOpen: boolean;
-    /** 显示数据查看按钮 */
     showData: boolean;
-    /** 显示设置按钮 */
     showSetting: boolean;
-    /** 显示文档按钮 */
     showDoc: boolean;
-    /** 显示全屏按钮 */
     showFullScreen: boolean;
-    /** 显示保存按钮 */
     showSave: boolean;
-    /** 显示重置按钮 */
     showReset: boolean;
-    /** 显示删除按钮 */
     showDelete: boolean;
 }
-/**
- * 画布网格配置
- */
 export interface GridConfig {
-    /** 是否显示网格 */
     visible: boolean;
-    /** 网格类型 (mesh 或 dot) */
     type: 'mesh' | 'dot';
-    /** 网格大小 */
     size: number;
-    /** 网格颜色配置 */
     config: {
         color: string;
     };
 }
-/**
- * AI 供应商预设选项
- * 与 editorOptions.aiProviders / aiEmbeddingProviders 协议保持兼容。
- */
 export interface AiProviderOption {
-    /** 供应商 ID */
     id?: string;
-    /** 兼容 select value 写法 */
     value?: string;
-    /** 展示名称 */
     label?: string;
-    /** 兼容 name 写法 */
     name?: string;
-    /** OpenAI 兼容 API 地址 */
     url?: string;
-    /** 默认模型 */
     defaultModel?: string;
-    /** 模型下拉选项 */
     models?: Array<string | {
         label?: string;
         value?: string;
         [key: string]: unknown;
     }>;
-    /** 数据来源，如 builtin、models.dev 或宿主自定义 */
     source?: string;
-    /** 文档地址 */
     doc?: string;
-    /** 推荐环境变量名 */
     env?: string[];
-    /** 供应商模型数量，用于大目录检索展示 */
     modelCount?: number;
-    /** 保留宿主扩展字段 */
     [key: string]: unknown;
 }
-/**
- * 编辑器初始化选项
- * 创建编辑器实例时传入，合并默认值后使用
- */
 export interface EditorOptions {
-    /** 编辑器挂载的 DOM 容器 (CSS 选择器或 HTMLElement) */
     container?: string | HTMLElement;
-    /** 后端 API 基础 URL */
     url?: string;
-    /** API 端点配置 */
     endpoints?: Partial<ApiEndpoints>;
-    /** HTTP 请求配置 */
     request?: Partial<RequestConfig>;
-    /** 工具栏配置 */
     toolbar?: Partial<ToolbarConfig>;
-    /** 画布网格配置 */
     grid?: Partial<GridConfig>;
-    /** 起始节点的 X 坐标 (默认: 280) */
     startX?: number;
-    /** 起始节点的 Y 坐标 (默认: 280) */
     startY?: number;
-    /** 预加载的组件列表，支持数组或 /api/v1/components 分段返回 */
     components?: RawComponentData;
-    /** AI 供应商预设；兼容 editorOptions.aiProviders */
     aiProviders?: AiProviderOption[];
-    /** 是否显示工具栏按钮文字，默认 false；设为 true 时显示图标 + 文字 */
     showToolbarButtonLabels?: boolean;
-    /** 工具栏是否只显示图标，默认 true；显式 false 时可显示文字 */
     toolbarIconOnly?: boolean;
-    /** 运行面板 AI 对话发送到 /rules/{chainId}/v1/chat/completions 的模型名 */
     runChatModel?: string;
-    /** 兼容旧集成命名；未设置 runChatModel 时作为运行面板 AI 对话默认模型 */
     defaultChatModel?: string;
-    /** Embedding AI 供应商预设；兼容 window.rulegoAiEmbeddingProviders 扩展 */
     aiEmbeddingProviders?: AiProviderOption[];
-    /** 组件列表格式转换函数 */
     adapterComponents?: (data: RawComponentData) => ComponentGroup[];
-    /** 初始规则链数据 (如果提供则直接渲染) */
     data?: RuleChainData;
-    /** 初始规则链配置 */
     ruleChain?: RuleChainConfig;
-    /** 是否为 headless 模式 (不渲染内置 UI) */
     headless?: boolean;
-    /** 是否允许编辑 (只读模式) */
     readonly?: boolean;
-    /** 是否允许拖动画布 */
     stopMoveGraph?: boolean;
-    /** 是否显示悬停轮廓 */
     hoverOutline?: boolean;
-    /** 是否调整边 */
     adjustEdge?: boolean;
-    /** 是否调整边的起终点 */
     adjustEdgeStartAndEnd?: boolean;
-    /** 是否允许双击编辑文本 */
     textEdit?: boolean;
-    /** 撤销/重做最大步数 (默认: 50) */
     maxHistory?: number;
-    /** 语言 (默认: zh-CN) */
     locale?: string;
-    /** 自定义 ID 生成器 */
     idGenerator?: (type: string) => string;
-    /** 主题名称 (内置: 'light' | 'dark' | 'blue', 也可传入自定义主题名) */
     theme?: string;
-    /** 编辑器插件列表 */
     plugins?: EditorPlugin[];
+    actionContributions?: EditorAction[];
+    capabilityContributions?: Record<string, FieldCapabilityHandler>;
+    optionSourceContributions?: Record<string, OptionSourceResolver>;
+    fieldChangeContributions?: Record<string, FieldChangeHandler>;
+    componentDocProvider?: ComponentDocProvider | null;
+    topology?: {
+        enabled?: boolean;
+        disabledRules?: string[];
+        throttleMs?: number;
+    };
 }
-/**
- * 面板显示状态枚举
- */
+export type EditorRuntimeOptionsPatch = Partial<Omit<EditorOptions, 'container'>>;
 export type PanelType = 'none' | 'node-add' | 'node-edit' | 'edge-add' | 'edge-edit';
-/**
- * 编辑器运行时状态
- * 由 StateStore 管理，供 UI 层订阅消费
- */
 export interface EditorState {
-    /** 编辑器是否已就绪 */
     isReady: boolean;
-    /** 数据是否已修改 (有未保存的更改) */
     isDirty: boolean;
-    /** 是否正在加载 */
     isLoading: boolean;
-    /** 当前选中的节点数据 */
     selectedNode: RuleNodeConfig | null;
-    /** 当前选中的边数据 */
     selectedEdge: RuleConnectionConfig | null;
-    /** 当前活跃的面板类型 */
     activePanel: PanelType;
-    /** 规则链配置 */
     ruleChain: RuleChainConfig;
-    /** 组件注册表 (type => definition 映射) */
     nodeComponents: Record<string, ComponentDefinition>;
-    /** 按分类分组的组件列表 */
     componentGroups: ComponentGroup[];
-    /** 当前正在编辑的节点视图定义 (对应的 ComponentDefinition) */
     currentNodeView: ComponentDefinition | null;
-    /** 当前正在编辑的节点配置数据 */
     currentNodeModel: Record<string, unknown>;
-    /** 当前正在编辑的边配置数据 */
     currentEdgeModel: Record<string, unknown>;
-    /** 是否可以撤销 */
     canUndo: boolean;
-    /** 是否可以重做 */
     canRedo: boolean;
 }
-/**
- * 编辑器插件接口
- *
- * 用于扩展编辑器功能。插件可以在编辑器的各个生命周期阶段注入自定义逻辑。
- *
- * 钩子方法说明:
- * - onInit: 编辑器实例初始化后调用 (DOM 已挂载)
- * - onDestroy: 编辑器销毁前调用 (用于清理资源)
- * - beforeDataLoad: 数据加载前调用 (可修改原始数据)
- * - beforeDataSave: 数据保存前调用 (可修改导出数据)
- * - beforeNodeAdd: 节点添加前调用 (返回 false 阻止添加)
- * - beforeEdgeAdd: 边添加前调用 (返回 false 阻止添加)
- *
- * @example
- * ```typescript
- * const debugPlugin: EditorPlugin = {
- *   name: 'debug',
- *   onInit(editor) {
- *     console.log('编辑器已初始化')
- *   },
- *   beforeDataSave(data) {
- *     console.log('保存前数据:', data)
- *     return data
- *   },
- * }
- * ```
- *
- * @see EditorCore.use() 安装插件
- */
 export interface EditorPlugin {
-    /** 插件名称 (唯一标识) */
     name: string;
-    /** 插件优先级 (数字越小越先执行, 默认: 100) */
     priority?: number;
-    /** 编辑器初始化后的回调 (此时 DOM 已挂载, LogicFlow 已就绪) */
     onInit?(editor: unknown): void;
-    /** 编辑器销毁前的回调 (用于清理插件注册的资源) */
     onDestroy?(editor: unknown): void;
-    /** 数据加载前回调 (可修改原始数据后返回) */
     beforeDataLoad?(data: RuleChainData): RuleChainData;
-    /** 数据保存前回调 (可修改导出数据后返回) */
     beforeDataSave?(data: RuleChainData): RuleChainData;
-    /** 节点添加前回调 (返回 false 阻止添加) */
     beforeNodeAdd?(node: RuleNodeConfig): boolean | void;
-    /** 边添加前回调 (返回 false 阻止添加) */
     beforeEdgeAdd?(edge: RuleConnectionConfig): boolean | void;
-    /**
-     * UI 渲染钩子 (可选)
-     * 用于向编辑器的特定区域注入自定义 UI 元素
-     * 每个函数接收对应区域的容器 HTMLElement
-     */
     ui?: {
-        /** 侧边栏区域注入 */
         sidebar?: (container: HTMLElement) => void;
-        /** 工具栏区域注入 */
         toolbar?: (container: HTMLElement) => void;
-        /** 属性面板区域注入 */
         panel?: (container: HTMLElement) => void;
     };
 }
-/**
- * 编辑器内部运行时数据
- * 对应原版 initData 对象
- */
 export interface EditorInternalData {
-    /** 节点计数器 (用于生成节点 ID) */
     nodeCount: number;
-    /** 边计数器 (用于生成边 ID) */
     edgeCount: number;
-    /** 起始节点的固定 ID */
     startNodeId: string;
-    /** 节点默认宽度 */
     nodeWidth: number;
-    /** 关系类型分隔符 (多关系合并显示时用 '/' 连接, 如 'True/False') */
     relationTypeSplit: string;
-    /** 当前正在复制的节点 ID (用于 Ctrl+C / Ctrl+V, 默认空字符串) */
     currentCloneNodeId?: string;
 }
-//# sourceMappingURL=editor.d.ts.map

package/dist/types/events.d.ts

@@ -1,132 +1,71 @@
-/**
- * @file events.ts
- * @description 编辑器事件类型定义 - 强类型事件系统
- *
- * 定义编辑器所有事件的名称和对应的负载类型。
- * 通过 TypeScript 泛型约束，确保事件触发和监听的类型安全。
- *
- * 事件分类:
- * - 节点事件 (node:*)
- * - 边事件 (edge:*)
- * - 画布事件 (canvas:*)
- * - 编辑器事件 (editor:*)
- * - 历史事件 (history:*)
- */
 import type { RuleNodeConfig, RuleConnectionConfig, RuleChainData, RuleChainConfig } from './rule-chain';
 import type { ComponentGroup } from './component';
-/**
- * 节点点击/选择事件的负载
- */
+import type { DiagnosticItem } from '../core/topology-rules';
+import type { EditorActionSource } from '../core/ActionRegistry';
+import type { EditorCapabilities } from '../core/editor-capabilities';
 export interface NodeEventPayload {
-    /** 节点的 LogicFlow ID */
     id: string;
-    /** 节点类型 (simple-node, start-node, chain-node, group-node) */
     type: string;
-    /** 节点 X 坐标 */
     x: number;
-    /** 节点 Y 坐标 */
     y: number;
-    /** 节点显示文本 */
     text: string;
-    /** 节点属性 (包含 model 和 view) */
     properties: {
         model: RuleNodeConfig;
         view?: Record<string, unknown>;
     };
 }
-/**
- * 边点击/选择事件的负载
- */
 export interface EdgeEventPayload {
-    /** 边的 LogicFlow ID */
     id: string;
-    /** 边类型 */
     type: string;
-    /** 源节点 ID */
     sourceNodeId: string;
-    /** 目标节点 ID */
     targetNodeId: string;
-    /** 边显示文本 */
     text: string;
-    /** 边属性 (包含 model) */
     properties: {
         model: RuleConnectionConfig;
     };
 }
-/**
- * 保存事件负载
- */
 export interface SaveEventPayload {
-    /** 保存的规则链数据 */
     data: RuleChainData;
-    /** 是否保存成功 */
     success: boolean;
-    /** 错误信息 (如果失败) */
     error?: Error;
 }
-/**
- * 历史变更事件负载
- */
+export interface SaveLifecycleResultPayload {
+    success: boolean;
+    mode: 'builtin' | 'host';
+    data: RuleChainData;
+    chainId: string;
+    message?: string;
+    verified?: boolean;
+    error?: unknown;
+}
 export interface HistoryChangePayload {
-    /** 是否可以撤销 */
     canUndo: boolean;
-    /** 是否可以重做 */
     canRedo: boolean;
-    /** 撤销栈深度 */
     undoCount: number;
-    /** 重做栈深度 */
     redoCount: number;
 }
-/**
- * 验证事件负载
- */
 export interface ValidationPayload {
-    /** 验证是否通过 */
     valid: boolean;
-    /** 验证错误列表 */
     errors: Array<{
-        /** 规则名称 */
         rule: string;
-        /** 错误消息 */
         message: string;
-        /** 相关的节点/边 ID */
         elementId?: string;
     }>;
 }
-/**
- * 编辑器事件映射表
- * Key 为事件名称, Value 为事件负载类型
- *
- * @example
- * ```typescript
- * // 使用:
- * editor.on('node:click', (payload: NodeEventPayload) => { ... })
- * editor.emit('editor:save', { data, success: true })
- * ```
- */
 export interface EditorEventMap {
-    /** 节点被点击 */
     'node:click': NodeEventPayload;
-    /** 节点被双击 (触发编辑) */
     'node:dbclick': NodeEventPayload;
-    /** 节点被选中 */
     'node:selected': NodeEventPayload;
-    /** 节点被拖入画布 (外部拖入) */
     'node:dnd-add': NodeEventPayload;
-    /** 节点被添加到画布 */
     'node:add': NodeEventPayload;
-    /** 节点被删除 */
     'node:delete': {
         id: string;
     };
-    /** 节点被拖动/移动 */
     'node:drop': NodeEventPayload;
-    /** 节点属性被更新 */
     'node:property-update': {
         id: string;
         properties: Record<string, unknown>;
     };
-    /** Headless HTML 节点挂载，用于 Vue/React Portal 渲染 */
     'node:html-mount': {
         id: string;
         type: string;
@@ -134,82 +73,66 @@ export interface EditorEventMap {
         model: unknown;
         el: HTMLElement;
     };
-    /** Headless HTML 节点卸载 */
     'node:html-unmount': {
         id: string;
     };
-    /** 边被点击 */
     'edge:click': EdgeEventPayload;
-    /** 边被双击 (触发编辑) */
     'edge:dbclick': EdgeEventPayload;
-    /** 边被添加 */
     'edge:add': EdgeEventPayload;
-    /** 边被删除 */
     'edge:delete': {
         id: string;
     };
-    /** 边属性被更新 */
     'edge:property-update': {
         id: string;
         properties: Record<string, unknown>;
     };
-    /** 画布空白区被点击 (取消选择) */
     'blank:click': void;
-    /** 画布缩放 */
     'canvas:zoom': {
         scale: number;
     };
-    /** 组件列表加载完成 */
     'editor:components-loaded': ComponentGroup[];
-    /** 数据加载完成 (通知适配层渲染 LogicFlow 数据) */
     'editor:data-loaded': {
         lfData: import('../core/DataAdapter').LFGraphData;
         ruleChain: RuleChainConfig;
     };
-    /** 编辑器就绪 */
     'editor:ready': void;
-    /** 编辑器销毁 */
     'editor:destroy': void;
-    /** 保存请求 */
     'editor:save': SaveEventPayload;
-    /** 保存成功 */
     'editor:save-ok': RuleChainData;
-    /** 保存失败 */
     'editor:save-error': {
         data: RuleChainData;
         error: Error;
     };
-    /** 新建规则链 */
+    'save:request': RuleChainData;
+    'save:success': SaveLifecycleResultPayload;
+    'save:error': SaveLifecycleResultPayload;
     'editor:new': RuleChainConfig;
-    /** 打开规则链 */
     'editor:open': RuleChainData;
-    /** 配置变更 */
     'editor:setting': Record<string, unknown>;
-    /** 全屏切换 */
     'editor:fullscreen': void;
-    /** 重置 */
     'editor:reset': void;
-    /** 删除选中元素 */
     'editor:delete-selected': void;
-    /** 元素已被删除 */
     'editor:deleted': void;
-    /** 编辑面板请求 */
     'editor:show-edit-panel': void;
-    /** 自动排版 — 手动触发 DAG 分层排版 */
     'editor:auto-layout': void;
-    /** 历史记录变更 */
+    'editor:options-change': {
+        changedKeys: string[];
+    };
+    'editor:capabilities-change': EditorCapabilities;
+    'editor:external-data-conflict': {
+        current: RuleChainData | null;
+        incoming: RuleChainData;
+    };
+    'action:complete': {
+        id: string;
+        source: EditorActionSource;
+        success: boolean;
+        error?: unknown;
+    };
+    'diagnostics:change': DiagnosticItem[];
     'history:change': HistoryChangePayload;
-    /** 验证完成 */
     'validation:complete': ValidationPayload;
-    /** 调试日志写入 */
     'debug:log': unknown;
 }
-/**
- * 事件名称联合类型
- */
 export type EditorEventName = keyof EditorEventMap;
-/**
- * 通用事件监听器类型
- */
 export type EventListener<T = unknown> = (payload: T) => void;
-//# sourceMappingURL=events.d.ts.map

package/dist/types/index.d.ts

@@ -1,12 +1,5 @@
-/**
- * @file types/index.ts
- * @description 类型统一导出入口
- *
- * 所有类型定义从这里集中导出，
- * 方便外部使用: import type { RuleChainData, EditorOptions } from '@huanban/rulego-editor-core'
- */
 export type { LayoutInfo, AdditionalInfo, RuleChainConfig, RuleNodeConfig, RuleConnectionConfig, RuleEndpointConfig, RuleChainMetadata, RuleChainData, } from './rule-chain';
-export type { FieldValidation, ComponentField, ComponentCategory, ComponentDefinition, ComponentGroup, RawComponentData, ComponentRegistryOptions, } from './component';
-export type { ApiEndpoints, RequestConfig, ToolbarConfig, GridConfig, AiProviderOption, EditorOptions, PanelType, EditorState, EditorPlugin, EditorInternalData, } from './editor';
+export type { FieldValidation, FieldDependencyOperator, FieldDependency, FieldAttachment, FieldOptionsSource, AiProviderCapability, ComponentFieldControl, ComponentFieldOption, ComponentFieldControlOption, ComponentFieldGroup, DynamicFieldReference, DynamicFieldsDefinition, ComponentField, ComponentCategory, ComponentDefinition, ComponentGroup, RawComponentData, ComponentRegistryOptions, } from './component';
+export { isComponentFieldOption } from './component';
+export type { ApiEndpoints, RequestConfig, ToolbarConfig, GridConfig, AiProviderOption, EditorOptions, PanelType, EditorState, EditorPlugin, EditorInternalData, EditorRuntimeOptionsPatch, } from './editor';
 export type { NodeEventPayload, EdgeEventPayload, SaveEventPayload, HistoryChangePayload, ValidationPayload, EditorEventMap, EditorEventName, EventListener, } from './events';
-//# sourceMappingURL=index.d.ts.map