@blueking/flow-canvas 0.0.1-beta.3 → 0.0.1-beta.4

package/dist/types/command.d.ts

@@ -1,160 +0,0 @@
-import type { FlowNodeModel, FlowEdgeModel, FlowEdgeLabelModel, FlowModel } from './flow-model';
-export type CanvasCommand = {
-    type: 'node.add';
-    node: FlowNodeModel;
-} | {
-    type: 'node.move';
-    nodeId: string;
-    position: {
-        x: number;
-        y: number;
-    };
-} | {
-    type: 'node.remove';
-    nodeId: string;
-} | {
-    type: 'node.update';
-    nodeId: string;
-    patch: Partial<Omit<FlowNodeModel, 'id' | 'payload' | 'extensions'>>;
-} | {
-    type: 'node.set-payload';
-    nodeId: string;
-    path: string[];
-    value: unknown;
-} | {
-    type: 'node.set-extensions';
-    nodeId: string;
-    path: string[];
-    value: unknown;
-} | {
-    type: 'edge.add';
-    edge: FlowEdgeModel;
-} | {
-    type: 'edge.remove';
-    edgeId: string;
-} | {
-    type: 'edge.reconnect';
-    edgeId: string;
-    source?: {
-        nodeId: string;
-        portId?: string;
-    };
-    target?: {
-        nodeId: string;
-        portId?: string;
-    };
-} | {
-    type: 'edge.update';
-    edgeId: string;
-    patch: Partial<Omit<FlowEdgeModel, 'id' | 'payload' | 'extensions'>>;
-} | {
-    type: 'edge.set-payload';
-    edgeId: string;
-    path: string[];
-    value: unknown;
-} | {
-    type: 'edge.label.update';
-    edgeId: string;
-    labelId: string;
-    patch: Partial<FlowEdgeLabelModel>;
-} | {
-    type: 'model.set-meta';
-    path: string[];
-    value: unknown;
-};
-export type CommandSource = 'user:drag' | 'user:keyboard' | 'user:toolbar' | 'user:quick-add' | 'user:panel' | 'plugin' | 'system' | 'system:replace';
-export interface CommandEnvelope {
-    id: string;
-    label?: string;
-    source: CommandSource;
-    timestamp: number;
-    commands: CanvasCommand[];
-}
-export interface CommandExecutionResult {
-    status: 'applied' | 'rejected' | 'invalid';
-    envelope: Readonly<CommandEnvelope>;
-    flowModel?: FlowModel;
-    error?: CommandExecutionError;
-}
-export interface CommandExecutionError {
-    code: 'plugin_rejected' | 'validation_failed' | 'constraint_violated';
-    reason: string;
-    source: string;
-    details?: unknown;
-}
-export interface CommandRejection {
-    rejected: true;
-    reason: string;
-    code?: string;
-}
-export interface CommandPreview {
-    previewFlowModel(commands?: CanvasCommand[]): FlowModel;
-}
-export interface FlowModelChangeEvent {
-    flowModel: Readonly<FlowModel>;
-    prevFlowModel: Readonly<FlowModel>;
-    envelope: Readonly<CommandEnvelope>;
-    source: CommandSource;
-}
-export type ScreenPosition = {
-    x: number;
-    y: number;
-};
-export type CanvasPosition = {
-    x: number;
-    y: number;
-};
-export type CanvasUiEvent = {
-    type: 'node.click';
-    nodeId: string;
-} | {
-    type: 'node.dblclick';
-    nodeId: string;
-} | {
-    type: 'node.contextmenu';
-    nodeId: string;
-    position: ScreenPosition;
-} | {
-    type: 'node.quick-add';
-    nodeId: string;
-    position: ScreenPosition;
-} | {
-    type: 'edge.click';
-    edgeId: string;
-} | {
-    type: 'edge.label.click';
-    edgeId: string;
-    labelId: string;
-} | {
-    type: 'blank.click';
-    position: CanvasPosition;
-} | {
-    type: 'blank.contextmenu';
-    position: ScreenPosition;
-} | {
-    type: 'selection.change';
-    nodeIds: string[];
-    edgeIds: string[];
-} | {
-    type: 'node.action.delete';
-    nodeId: string;
-} | {
-    type: 'node.action.copy';
-    sourceNodeId: string;
-    newNodeId: string;
-} | {
-    type: 'node.action.copy-insert';
-    sourceNodeId: string;
-    newNodeId: string;
-} | {
-    type: 'node.action.disconnect';
-    nodeId: string;
-    edgeIds: string[];
-} | {
-    type: 'node.action.debug';
-    nodeId: string;
-} | {
-    type: 'node.action.quick-insert';
-    sourceNodeId: string;
-    newNodeId: string;
-};

package/dist/types/flow-model.d.ts

@@ -1,46 +0,0 @@
-export interface FlowModel {
-    version?: '1.0';
-    nodes: Record<string, FlowNodeModel>;
-    edges: Record<string, FlowEdgeModel>;
-    meta?: Record<string, unknown>;
-    extensions?: Record<string, unknown>;
-}
-export interface FlowNodeModel {
-    id: string;
-    type: string;
-    position: {
-        x: number;
-        y: number;
-    };
-    label?: string;
-    ports?: FlowPortModel[];
-    payload?: Record<string, unknown>;
-    extensions?: Record<string, unknown>;
-}
-export interface FlowEdgeModel {
-    id: string;
-    type?: string;
-    source: {
-        nodeId: string;
-        portId?: string;
-    };
-    target: {
-        nodeId: string;
-        portId?: string;
-    };
-    labels?: FlowEdgeLabelModel[];
-    payload?: Record<string, unknown>;
-    extensions?: Record<string, unknown>;
-}
-export interface FlowPortModel {
-    id: string;
-    group: 'top' | 'right' | 'bottom' | 'left' | string;
-    x6PortConfig?: Record<string, unknown>;
-}
-export interface FlowEdgeLabelModel {
-    id: string;
-    text?: string;
-    position?: number;
-    payload?: Record<string, unknown>;
-}
-export declare function createEmptyFlowModel(): FlowModel;

package/dist/types/history.d.ts

@@ -1,18 +0,0 @@
-import type { Ref } from 'vue';
-import type { FlowModel } from './flow-model';
-import type { CommandEnvelope } from './command';
-export interface CanvasHistory {
-    execute(envelope: CommandEnvelope): FlowModel;
-    undo(): FlowModel | null;
-    redo(): FlowModel | null;
-    readonly canUndo: Ref<boolean>;
-    readonly canRedo: Ref<boolean>;
-    readonly undoStack: readonly CommandEnvelope[];
-    readonly redoStack: readonly CommandEnvelope[];
-    clear(): void;
-    createSnapshot(): FlowModel;
-    replaceFlowModel(model: FlowModel): void;
-}
-export interface CanvasHistoryOptions {
-    maxHistorySize?: number;
-}

package/dist/types/overlay.d.ts

@@ -1,3 +0,0 @@
-export interface OverlayManager {
-    getNodeScreenRect(nodeId: string): DOMRect | null;
-}

package/dist/types/plugin.d.ts

@@ -1,64 +0,0 @@
-import type { Component } from 'vue';
-import type { Ref } from 'vue';
-import type { FlowNodeModel, FlowEdgeModel, FlowModel } from './flow-model';
-import type { CommandEnvelope, CommandPreview, CommandRejection, CommandExecutionResult, CanvasUiEvent, ScreenPosition } from './command';
-import type { CanvasSchema, CanvasMode } from './schema';
-import type { CanvasHistory } from './history';
-import type { CanvasApi } from './api';
-import type { OverlayManager } from './overlay';
-import type { CanvasToolbarItem } from './api';
-import type { Graph } from '@antv/x6';
-export interface EditorPluginContext {
-    flowModel: Readonly<Ref<FlowModel>>;
-    history: CanvasHistory;
-    schema: CanvasSchema;
-    mode: Ref<CanvasMode>;
-    executeCommand(envelope: CommandEnvelope): CommandExecutionResult;
-}
-export interface RuntimePluginContext extends EditorPluginContext {
-    api: CanvasApi;
-    overlay: OverlayManager;
-    graph: Graph;
-}
-export interface CanvasSelection {
-    nodeIds: string[];
-    edgeIds: string[];
-}
-export interface NodeDecoration {
-    className?: string;
-    badge?: {
-        text: string;
-        color: string;
-    };
-    borderColor?: string;
-}
-export interface EdgeDecoration {
-    className?: string;
-    strokeColor?: string;
-}
-export interface ContextMenuItem {
-    id: string;
-    label: string;
-    icon?: Component | string;
-    disabled?: boolean;
-    action: () => void;
-    children?: ContextMenuItem[];
-}
-export interface CanvasPlugin {
-    name: string;
-    priority?: number;
-    install?(ctx: EditorPluginContext): void;
-    attachRuntime?(ctx: RuntimePluginContext): void;
-    detachRuntime?(): void;
-    dispose?(): void;
-    transformCommand?(envelope: Readonly<CommandEnvelope>, preview: CommandPreview, ctx: EditorPluginContext): CommandEnvelope | CommandRejection | null;
-    afterCommand?(envelope: Readonly<CommandEnvelope>, prevModel: Readonly<FlowModel>, newModel: Readonly<FlowModel>, ctx: EditorPluginContext): void;
-    onUiEvent?(event: CanvasUiEvent, ctx: RuntimePluginContext): void;
-    onSelectionChange?(selection: CanvasSelection, ctx: RuntimePluginContext): void;
-    onKeyboardShortcut?(event: KeyboardEvent, ctx: RuntimePluginContext): boolean;
-    onBlankContextMenu?(position: ScreenPosition, ctx: RuntimePluginContext): ContextMenuItem[] | void;
-    decorateNode?(node: FlowNodeModel, ctx: EditorPluginContext): NodeDecoration | void;
-    decorateEdge?(edge: FlowEdgeModel, ctx: EditorPluginContext): EdgeDecoration | void;
-    provideToolbarItems?(ctx: EditorPluginContext): CanvasToolbarItem[];
-    extendApi?(api: CanvasApi, ctx: RuntimePluginContext): Record<string, Function>;
-}

package/dist/types/schema.d.ts

@@ -1,80 +0,0 @@
-import type { Component } from 'vue';
-import type { FlowNodeModel, FlowEdgeModel, FlowPortModel } from './flow-model';
-import type { CanvasApi } from './api';
-import type { FlowModel } from './flow-model';
-import type { CanvasHistory } from './history';
-export type CanvasMode = 'edit' | 'readonly' | 'thumbnail';
-export interface CanvasSchema {
-    nodeTypes: Record<string, CanvasNodeDefinition>;
-    edgeTypes?: Record<string, CanvasEdgeDefinition>;
-    defaultEdgeType?: string;
-}
-export interface NodeBehaviorConfig {
-    showActions?: boolean;
-    showPorts?: boolean;
-    draggable?: boolean;
-    selectable?: boolean;
-    deletable?: boolean;
-    connectable?: boolean;
-    copyable?: boolean;
-    disconnectable?: boolean;
-    debuggable?: boolean;
-    deleteDisabled?: boolean;
-    copyDisabled?: boolean;
-    copyInsertDisabled?: boolean;
-    disconnectDisabled?: boolean;
-    debugDisabled?: boolean;
-    /** 逐节点控制右侧"+"快捷添加按钮是否显示，默认跟随全局配置 */
-    quickAddEnabled?: boolean;
-    /** 快捷操作工具栏的位置偏移（px），相对于默认位置（节点右下角） */
-    actionsOffset?: {
-        x?: number;
-        y?: number;
-    };
-}
-export interface CanvasNodeDefinition {
-    component: Component;
-    getSize: (node: FlowNodeModel) => {
-        width: number;
-        height: number;
-    };
-    getPorts?: (node: FlowNodeModel) => FlowPortModel[];
-    getBehavior?: (node: FlowNodeModel, ctx: CanvasCallbackContext) => NodeBehaviorConfig;
-    x6CellConfig?: Record<string, unknown>;
-}
-export interface EdgeRenderState {
-    selected: boolean;
-    highlighted: boolean;
-    hovered: boolean;
-}
-export interface EdgeStyle {
-    stroke?: string;
-    strokeWidth?: number;
-    strokeDasharray?: string;
-}
-export interface CanvasEdgeDefinition {
-    router?: string | {
-        name: string;
-        args?: Record<string, unknown>;
-    };
-    connector?: string | {
-        name: string;
-        args?: Record<string, unknown>;
-    };
-    /** 根据边模型和渲染状态（selected/highlighted/hovered）返回边的视觉样式 */
-    style?: (edge: FlowEdgeModel, state: EdgeRenderState) => EdgeStyle;
-    /**
-     * @experimental 边标签的自定义渲染组件。
-     * 当前版本尚未完整实现（X6 边标签基于 SVG，集成 Vue 组件需要 HTML overlay 方案）。
-     * 如需自定义标签样式，建议通过 x6EdgeConfig.defaultLabel 配置 X6 原生标签 markup。
-     */
-    labelRenderer?: Component;
-    labelDraggable?: boolean;
-    x6EdgeConfig?: Record<string, unknown>;
-}
-export interface CanvasCallbackContext {
-    api: CanvasApi;
-    flowModel: FlowModel;
-    history: CanvasHistory;
-    mode: CanvasMode;
-}

package/dist/utils/path.d.ts

@@ -1,7 +0,0 @@
-/**
- * Immutable path-based set on a plain object.
- * - Empty path replaces the root value (must be object or undefined).
- * - Auto-creates intermediate objects for missing keys.
- * - `undefined` value deletes the leaf key.
- */
-export declare function setByPath(root: Record<string, unknown> | undefined, path: string[], value: unknown): Record<string, unknown> | undefined;

package/dist/utils/uuid.d.ts

@@ -1 +0,0 @@
-export declare function generateId(): string;