@blueking/flow-canvas 0.0.2 → 0.0.4

package/dist/index.d.ts

@@ -207,6 +207,8 @@ type CanvasUiEvent = {
     type: 'node.action.quick-insert';
     sourceNodeId: string;
     newNodeId: string;
+} | {
+    type: 'toolbar.auto-layout';
 };
 
 interface CanvasHistory {
@@ -229,17 +231,23 @@ interface OverlayManager {
     getNodeScreenRect(nodeId: string): DOMRect | null;
 }
 
+declare function generateId(): string;
+type IdGenerator = (type: 'node' | 'edge') => string;
+
 interface EditorPluginContext {
     flowModel: Readonly<Ref<FlowModel>>;
     history: CanvasHistory;
     schema: CanvasSchema;
     mode: Ref<CanvasMode>;
+    idGenerator: IdGenerator;
     executeCommand(envelope: CommandEnvelope): CommandExecutionResult;
 }
 interface RuntimePluginContext extends EditorPluginContext {
     api: CanvasApi;
     overlay: OverlayManager;
     graph: Graph;
+    /** 框选模式是否激活（由 editor.selectionMode 驱动） */
+    selectionMode: Readonly<Ref<boolean>>;
 }
 interface CanvasSelection {
     nodeIds: string[];
@@ -284,7 +292,12 @@ interface CanvasPlugin {
     extendApi?(api: CanvasApi, ctx: RuntimePluginContext): Record<string, Function>;
 }
 
-type BuiltinToolbarType = 'undo' | 'redo' | 'select' | 'auto-layout' | 'search' | 'minimap' | 'export' | 'zoom-in' | 'zoom-out' | 'zoom-display' | 'fit' | 'reset';
+type CoreToolbarType = 'undo' | 'redo' | 'select' | 'auto-layout' | 'export' | 'zoom-in' | 'zoom-out' | 'zoom-display' | 'fit' | 'reset';
+/**
+ * 这类工具项默认由内置插件提供入口与行为，toolbar 壳层只负责渲染与隐藏控制。
+ */
+type PluginManagedToolbarType = 'search' | 'minimap';
+type BuiltinToolbarType = CoreToolbarType | PluginManagedToolbarType;
 interface CanvasToolbarItem {
     id: string;
     type: BuiltinToolbarType | 'custom';
@@ -300,12 +313,21 @@ interface CanvasToolbarItem {
     order?: number;
     visible?: boolean | ((ctx: CanvasCallbackContext) => boolean);
     disabled?: boolean | ((ctx: CanvasCallbackContext) => boolean);
+    active?: boolean | ((ctx: CanvasCallbackContext) => boolean);
     onClick?: (ctx: CanvasCallbackContext) => void;
 }
 interface ExportOptions {
     backgroundColor?: string;
     padding?: number;
     quality?: number;
+    /** 输出图片的缩放倍率，默认跟随 devicePixelRatio */
+    scale?: number;
+}
+interface DeleteSelectionOptions {
+    selection?: CanvasSelection;
+    source?: CommandSource;
+    label?: string;
+    clearSelectionAfterApply?: boolean;
 }
 interface NodeActionsConfig {
     showDebug?: boolean;
@@ -332,13 +354,14 @@ interface CanvasApi {
     scrollToOrigin(): void;
     scrollToNode(nodeId: string): void;
     getSelection(): CanvasSelection;
+    getSelectionBounds(selection?: CanvasSelection): DOMRect | null;
     selectNodes(ids: string[]): void;
     selectEdges(ids: string[]): void;
     clearSelection(): void;
+    deleteSelection(options?: DeleteSelectionOptions): CommandExecutionResult | null;
     registerDndSource(el: HTMLElement, factory: () => FlowNodeModel): () => void;
     startConnection(nodeId: string, portId?: string): void;
     exportAsImage(options?: ExportOptions): Promise<Blob>;
-    exportAsSVG(): Promise<string>;
     highlightNodes(nodeIds: string[]): void;
     highlightEdges(edgeIds: string[]): void;
     clearHighlight(): void;
@@ -377,8 +400,6 @@ type QuickAddInsertDirectionResolver = (node: FlowNodeModel, port: FlowPortModel
 interface QuickAddConfig {
     /** 全局开关，默认 true */
     enabled?: boolean;
-    /** "+"按钮 hover 时的 tooltip 文案 */
-    tooltipText?: string;
     /** quick-add 绑定的端口分组，默认 'right'；节点不存在该分组端口时将不显示 quick-add */
     portGroup?: string;
     /** 精确指定 quick-add 使用哪个端口；优先级高于 portGroup */
@@ -404,7 +425,10 @@ interface NodeBehaviorConfig {
     draggable?: boolean;
     selectable?: boolean;
     deletable?: boolean;
+    /** 是否允许从此节点发起连线（控制端口 magnet 属性） */
     connectable?: boolean;
+    /** 是否允许将连线连入此节点；为 false 时拖拽连线期间不显示该节点端口 */
+    targetable?: boolean;
     copyable?: boolean;
     disconnectable?: boolean;
     debuggable?: boolean;
@@ -415,6 +439,10 @@ interface NodeBehaviorConfig {
     debugDisabled?: boolean;
     /** 逐节点控制右侧"+"快捷添加按钮是否显示，默认跟随全局配置 */
     quickAddEnabled?: boolean;
+    /** 拖拽时是否临时置顶节点（z-index），默认 true */
+    bringToFrontOnDrag?: boolean;
+    /** quick-add 激活时是否隐藏对应方向的连接端口，默认 true */
+    hidePortForQuickAdd?: boolean;
     /** 快捷操作工具栏的位置偏移（px），相对于默认位置（节点右下角） */
     actionsOffset?: {
         x?: number;
@@ -468,6 +496,13 @@ interface CanvasCallbackContext {
     mode: CanvasMode;
 }
 
+/**
+ * @antv/x6-plugin-selection 在运行时向 Graph 原型注入的方法。
+ * 仅在 selectionPlugin 已通过 graph.use() 注册后可用。
+ * 当前 X6 类型声明已包含这些方法，因此这里保留别名供运行时语义标注使用。
+ */
+type GraphWithSelection = Graph;
+
 /**
  * 纯函数 reducer：将一条原子命令应用到 FlowModel 上，返回新 FlowModel（不可变）。
  * 所有 FlowModel 不变量在此处保证：
@@ -559,6 +594,7 @@ interface CanvasEditorOptions {
     plugins?: CanvasPlugin[];
     mode?: CanvasMode;
     historyOptions?: CanvasHistoryOptions;
+    idGenerator?: IdGenerator;
     onCommandResult?(result: CommandExecutionResult): void;
     onFlowModelChange?(event: FlowModelChangeEvent): void;
 }
@@ -567,6 +603,7 @@ interface CanvasEditorContext {
     history: CanvasHistory;
     schema: CanvasSchema;
     mode: Ref<CanvasMode>;
+    idGenerator: IdGenerator;
     executeCommand(envelope: CommandEnvelope): CommandExecutionResult;
     replaceFlowModel(model: FlowModel): void;
     setMode(mode: CanvasMode): void;
@@ -578,6 +615,11 @@ interface CanvasEditorContext {
     extendedApi: Record<string, Function>;
     /** @internal used by CanvasRuntime */
     _pluginManager: PluginManager;
+    /**
+     * @internal 发出 UI 事件。Runtime mount 前仅分发到插件；mount 后同时触发 Vue emit('ui-event')。
+     * 由 CanvasRuntime 在挂载时注入完整实现。
+     */
+    _emitUiEvent: (event: CanvasUiEvent) => void;
 }
 /**
  * 画布编辑引擎的核心 composable。
@@ -601,6 +643,8 @@ type __VLS_Props$5 = {
     graphOptions?: Record<string, unknown>;
     nodeActions?: NodeActionsConfig;
     quickAdd?: QuickAddConfig;
+    /** 拖拽连线时，根据源节点 ID 返回不应显示端口的节点 ID 集合（如自身、上游、不可作为目标的节点） */
+    getConnectionExcludedNodeIds?: (sourceNodeId: string) => Iterable<string>;
 };
 type __VLS_Slots$2 = {
     'quick-add-panel'?: (props: {
@@ -696,7 +740,6 @@ declare const _default$1: typeof __VLS_export$1;
 type __VLS_Props = {
     node: FlowNodeModel;
     portPosition: ScreenPosition;
-    tooltipText?: string;
 };
 declare function closePopover(): void;
 declare var __VLS_7: {};
@@ -728,17 +771,18 @@ type __VLS_WithSlots<T, S> = T & {
 };
 
 interface DefaultToolbarItemsOptions {
-    /** 要排除的操作项类型（仅对可隐藏的组生效，zoom 和 reset 组固定不可排除） */
-    exclude?: BuiltinToolbarType[];
     /** 要恢复显示的默认隐藏项（默认隐藏：undo、redo） */
     include?: BuiltinToolbarType[];
 }
 /**
  * 工具栏默认项分为四组（从左到右）：
  *  1. history: 撤销、重做 — 默认隐藏，通过 include: ['undo', 'redo'] 恢复显示
- *  2. tools:   框选、自动排版、搜索、缩略图、下载 — 可隐藏
+ *  2. tools:   框选、自动排版、下载
+ *     search / minimap 由内置插件默认提供，不在 core 默认项中声明
  *  3. zoom:    缩小、放大 — 固定
  *  4. reset:   重置 — 固定
+ *
+ * exclude 过滤统一由 CanvasToolbar 组件在合并 plugin items 后执行，此函数不处理。
  */
 declare function createDefaultToolbarItems(options?: DefaultToolbarItemsOptions): CanvasToolbarItem[];
 
@@ -797,7 +841,21 @@ interface SnaplinePluginOptions {
 }
 declare function snaplinePlugin(options?: SnaplinePluginOptions): CanvasPlugin;
 
+interface SearchNodeMeta {
+    label?: string;
+    subtitle?: string;
+    keywords?: string[];
+}
+interface SearchPluginOptions {
+    placeholder?: string;
+    emptyText?: string;
+    maxResults?: number;
+    getNodeMeta?: (node: FlowNodeModel) => SearchNodeMeta | null | undefined;
+}
+declare function searchPlugin(options?: SearchPluginOptions): CanvasPlugin;
+
 interface MinimapPluginOptions {
+    /** 外部容器（传入后使用外部容器渲染，不创建浮动面板） */
     container?: HTMLElement;
     width?: number;
     height?: number;
@@ -813,7 +871,5 @@ declare function minimapPlugin(options?: MinimapPluginOptions): CanvasPlugin;
  */
 declare function clipboardPlugin(): CanvasPlugin;
 
-declare function generateId(): string;
-
-export { CanvasConstraintError, _default$5 as CanvasLayout, _default$3 as CanvasNodePalette, _default$6 as CanvasRuntime, CanvasSchemaError, _default$4 as CanvasToolbar, _default$2 as DefaultNode, _default$1 as NodeActionsToolbar, _default as NodeQuickAddPopover, applyCanvasCommand, clipboardPlugin, connectionValidatorPlugin, createBuiltinEdgeTypes, createCanvasHistory, createDefaultSchema, createDefaultToolbarItems, createEmptyFlowModel, generateId, minimapPlugin, selectionPlugin, snaplinePlugin, useCanvasEditor };
-export type { BuiltinEdgeType, BuiltinToolbarType, CanvasApi, CanvasCallbackContext, CanvasCommand, CanvasEdgeDefinition, CanvasEditorContext, CanvasEditorOptions, CanvasHistory, CanvasHistoryOptions, CanvasMode, CanvasNodeDefinition, CanvasPlugin, CanvasPosition, CanvasSchema, CanvasSelection, CanvasToolbarItem, CanvasUiEvent, CommandEnvelope, CommandExecutionError, CommandExecutionResult, CommandPreview, CommandRejection, CommandSource, ConnectionValidateContext, ConnectionValidateResult, ConnectionValidator, ContextMenuItem, DefaultNodeTypeConfig, DefaultSchemaOptions, DefaultSchemaResult, DefaultToolbarItemsOptions, EdgeDecoration, EdgeRenderState, EdgeStyle, EditorPluginContext, ExportOptions, FlowEdgeLabelModel, FlowEdgeModel, FlowModel, FlowModelChangeEvent, FlowNodeModel, FlowPortModel, InsertDirection, InsertNodeOptions, MinimapPluginOptions, NodeActionsConfig, NodeBehaviorConfig, NodeDecoration, NodePaletteItem, OverlayManager, QuickAddConfig, QuickAddInsertDirectionResolver, QuickAddPortResolver, RuntimePluginContext, ScreenPosition, SelectionPluginOptions, SnaplinePluginOptions };
+export { CanvasConstraintError, _default$5 as CanvasLayout, _default$3 as CanvasNodePalette, _default$6 as CanvasRuntime, CanvasSchemaError, _default$4 as CanvasToolbar, _default$2 as DefaultNode, _default$1 as NodeActionsToolbar, _default as NodeQuickAddPopover, applyCanvasCommand, clipboardPlugin, connectionValidatorPlugin, createBuiltinEdgeTypes, createCanvasHistory, createDefaultSchema, createDefaultToolbarItems, createEmptyFlowModel, generateId, minimapPlugin, searchPlugin, selectionPlugin, snaplinePlugin, useCanvasEditor };
+export type { BuiltinEdgeType, BuiltinToolbarType, CanvasApi, CanvasCallbackContext, CanvasCommand, CanvasEdgeDefinition, CanvasEditorContext, CanvasEditorOptions, CanvasHistory, CanvasHistoryOptions, CanvasMode, CanvasNodeDefinition, CanvasPlugin, CanvasPosition, CanvasSchema, CanvasSelection, CanvasToolbarItem, CanvasUiEvent, CommandEnvelope, CommandExecutionError, CommandExecutionResult, CommandPreview, CommandRejection, CommandSource, ConnectionValidateContext, ConnectionValidateResult, ConnectionValidator, ContextMenuItem, CoreToolbarType, DefaultNodeTypeConfig, DefaultSchemaOptions, DefaultSchemaResult, DefaultToolbarItemsOptions, DeleteSelectionOptions, EdgeDecoration, EdgeRenderState, EdgeStyle, EditorPluginContext, ExportOptions, FlowEdgeLabelModel, FlowEdgeModel, FlowModel, FlowModelChangeEvent, FlowNodeModel, FlowPortModel, GraphWithSelection, IdGenerator, InsertDirection, InsertNodeOptions, MinimapPluginOptions, NodeActionsConfig, NodeBehaviorConfig, NodeDecoration, NodePaletteItem, OverlayManager, PluginManagedToolbarType, QuickAddConfig, QuickAddInsertDirectionResolver, QuickAddPortResolver, RuntimePluginContext, ScreenPosition, SearchNodeMeta, SearchPluginOptions, SelectionPluginOptions, SnaplinePluginOptions };