@blueking/flow-canvas 0.0.13 → 0.0.14

package/dist/index.d.ts

@@ -17,6 +17,7 @@ interface FlowNodeModel {
         y: number;
     };
     label?: string;
+    category?: string;
     ports?: FlowPortModel[];
     payload?: Record<string, unknown>;
     extensions?: Record<string, unknown>;
@@ -381,6 +382,28 @@ interface InsertNodeOptions {
     direction?: InsertDirection;
 }
 type ZoomToFitOptions = Parameters<Graph['zoomToFit']>[0];
+interface ScrollToNodeOptions {
+    /** 居中后额外应用的画布视口偏移量，单位为屏幕像素；y 为负值时节点显示在中心偏上。 */
+    offset?: {
+        x?: number;
+        y?: number;
+    };
+}
+interface FocusNodeOptions {
+    /** 居中后额外应用的画布视口偏移量，单位为屏幕像素；y 为负值时节点显示在中心偏上。 */
+    offset?: {
+        x?: number;
+        y?: number;
+    };
+    /** 是否高亮目标节点，默认 true。 */
+    highlight?: boolean;
+    /** 需要一并高亮的边 id 列表。 */
+    edgeIds?: string[];
+    /** 高亮自动清除的延时（毫秒）；不传或为 0 时高亮保持，直到下次 focus 或手动清除。 */
+    autoClearMs?: number;
+    /** 是否同时选中目标节点，默认 false。 */
+    select?: boolean;
+}
 interface CanvasApi {
     zoomIn(): void;
     zoomOut(): void;
@@ -389,7 +412,12 @@ interface CanvasApi {
     getZoom(): number;
     centerContent(): void;
     scrollToOrigin(): void;
-    scrollToNode(nodeId: string): void;
+    scrollToNode(nodeId: string, options?: ScrollToNodeOptions): void;
+    /**
+     * 将指定节点置于画布中心并高亮。是 scrollToNode + highlightNodes 等原子能力的组合封装。
+     * 节点不存在时返回 false，存在并成功定位时返回 true。
+     */
+    focusNode(nodeId: string, options?: FocusNodeOptions): boolean;
     getSelection(): CanvasSelection;
     getSelectionBounds(selection?: CanvasSelection): DOMRect | null;
     selectNodes(ids: string[]): void;
@@ -914,10 +942,21 @@ interface SearchNodeMeta {
     subtitle?: string;
     keywords?: string[];
 }
+/**
+ * 声明式搜索字段路径，按节点对象逐层取值。
+ * 例如 ['payload', 'stageName'] 会读取 node.payload.stageName。
+ * 仅接收 string/number/boolean 或 string 数组作为关键词，复杂对象会被忽略。
+ */
+type SearchKeywordPath = readonly (string | number)[];
 interface SearchPluginOptions {
     placeholder?: string;
     maxResults?: number;
     getNodeMeta?: (node: FlowNodeModel) => SearchNodeMeta | null | undefined;
+    /**
+     * 声明式搜索字段路径列表。每条路径从节点对象根部逐层取值，命中的标量会并入搜索关键词，
+     * 无需通过 getNodeMeta 编写取值逻辑。与 getNodeMeta 同时存在时关键词合并去重。
+     */
+    keywordPaths?: SearchKeywordPath[];
 }
 declare function searchPlugin(options?: SearchPluginOptions): CanvasPlugin;
 
@@ -939,4 +978,4 @@ declare function minimapPlugin(options?: MinimapPluginOptions): CanvasPlugin;
 declare function clipboardPlugin(): CanvasPlugin;
 
 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, EdgeDropConfig, 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, ZoomToFitOptions };
+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, EdgeDropConfig, EdgeRenderState, EdgeStyle, EditorPluginContext, ExportOptions, FlowEdgeLabelModel, FlowEdgeModel, FlowModel, FlowModelChangeEvent, FlowNodeModel, FlowPortModel, FocusNodeOptions, GraphWithSelection, IdGenerator, InsertDirection, InsertNodeOptions, MinimapPluginOptions, NodeActionsConfig, NodeBehaviorConfig, NodeDecoration, NodePaletteItem, OverlayManager, PluginManagedToolbarType, QuickAddConfig, QuickAddInsertDirectionResolver, QuickAddPortResolver, RuntimePluginContext, ScreenPosition, ScrollToNodeOptions, SearchKeywordPath, SearchNodeMeta, SearchPluginOptions, SelectionPluginOptions, SnaplinePluginOptions, ZoomToFitOptions };