@blueking/flow-canvas 0.0.1-beta.1

package/dist/types/schema.d.ts

@@ -0,0 +1,77 @@
+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';
+import type { NodeOverlayAnchors } from './overlay';
+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;
+}
+export interface CanvasNodeDefinition {
+    component: Component;
+    getSize: (node: FlowNodeModel) => {
+        width: number;
+        height: number;
+    };
+    getPorts?: (node: FlowNodeModel) => FlowPortModel[];
+    getBehavior?: (node: FlowNodeModel, ctx: CanvasCallbackContext) => NodeBehaviorConfig;
+    getOverlayAnchors?: (node: FlowNodeModel, ctx?: CanvasCallbackContext) => NodeOverlayAnchors;
+    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

@@ -0,0 +1,7 @@
+/**
+ * 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

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

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@blueking/flow-canvas",
+  "version": "0.0.1-beta.1",
+  "description": "通用流程画布编辑引擎",
+  "type": "module",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js"
+    },
+    "./style": "./dist/style.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build:lib": "vite build --mode lib",
+    "build:types": "vue-tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build:lib && npm run build:types",
+    "type-check": "vue-tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@antv/x6": "^2.18.0",
+    "@antv/x6-plugin-dnd": "^2.1.1",
+    "@antv/x6-plugin-export": "^2.1.6",
+    "@antv/x6-plugin-minimap": "^2.0.7",
+    "@antv/x6-plugin-selection": "^2.2.2",
+    "@antv/x6-plugin-snapline": "^2.1.7",
+    "@antv/x6-vue-shape": "^2.1.2",
+    "vue": "^3.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@antv/x6-plugin-dnd": {
+      "optional": true
+    },
+    "@antv/x6-plugin-export": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^6.0.1",
+    "@vitejs/plugin-vue-jsx": "^5.1.1",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.2",
+    "vue-tsc": "^3.0.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}