leafer-connector 0.1.0

package/dist/esm/types.d.ts

@@ -0,0 +1,202 @@
+import type { IArrowStyle, IPointData, ITextInputData, IUI } from "leafer-editor";
+export type ConnectorRouteType = "orthogonal" | "bezier" | "straight" | "custom";
+export type ConnectorScaleMode = "world" | "pixel";
+export type ConnectorSide = "top" | "right" | "bottom" | "left";
+export type ConnectorAnchorSpec = "center" | {
+    type: "center";
+} | {
+    type: "side";
+    side: ConnectorSide;
+} | {
+    type: "nearest-side";
+} | {
+    type: "nearest-edge";
+};
+export interface ConnectorPoint {
+    node: IUI;
+    side: ConnectorSide;
+    percent: number;
+    margin: number;
+    padding: number;
+    /**
+     * 与节点边界相交（考虑 margin）的点（world）
+     */
+    linkPoint: IPointData;
+    /**
+     * 从 linkPoint 沿法线方向外扩 padding 后的点（world）
+     */
+    paddingPoint: IPointData;
+}
+export interface TargetOption {
+    /**
+     * 强制连接面：top/right/bottom/left
+     * - "auto"：自动在有效 side 中择优
+     */
+    side?: ConnectorSide | "auto";
+    /**
+     * 连接点在该面上的比例位置（0~1）
+     */
+    percent?: number;
+    /**
+     * 单端 padding（覆盖全局）
+     */
+    padding?: number;
+    /**
+     * 单端 margin（覆盖全局）
+     */
+    margin?: number;
+    /**
+     * 固定连接点（world 坐标，优先级最高）
+     */
+    linkPoint?: IPointData;
+}
+export type ConnectorDrawResult = {
+    /**
+     * 生成的路径点（world 坐标）
+     */
+    points: IPointData[];
+    /**
+     * SVG path 字符串（world 坐标）
+     */
+    path: string;
+};
+export interface ConnectorOptions {
+    from: IUI;
+    to: IUI;
+    /**
+     * 全局：从边界外扩的距离（出线段长度）
+     */
+    padding?: number;
+    /**
+     * 全局：连线与对象之间间距（让线不贴边）
+     */
+    margin?: number;
+    /**
+     * 全局：正交/智能路由的圆角半径
+     */
+    cornerRadius?: number;
+    /**
+     * 端点配置（单端覆盖）
+     */
+    opt1?: TargetOption;
+    opt2?: TargetOption;
+    /**
+     * 路由类型
+     */
+    routeType?: ConnectorRouteType;
+    /**
+     * bezier 张力/曲率（用于控制点强度/或 smart-route 参数），默认 0.6
+     */
+    bezierCurvature?: number;
+    /**
+     * 自定义绘制（结构化回调）
+     * - 你可以基于默认结果修改 points/path
+     */
+    onDraw?: (param: {
+        s: ConnectorPoint;
+        e: ConnectorPoint;
+        defaultResult: ConnectorDrawResult;
+    }) => Partial<ConnectorDrawResult> | void;
+    /**
+     * 路由参数（smart-route 参数化）
+     */
+    routeOptions?: {
+        /**
+         * 避障 padding：将需要避开的 bounds 外扩多少（local 坐标）
+         * - 默认使用 margin
+         */
+        avoidPadding?: number;
+        /**
+         * 线段与避障矩形相交的惩罚分（越大越“绕开”）
+         */
+        intersectionPenalty?: number;
+        /**
+         * “长直线惩罚”的阈值（maxSegment/total > ratio 开始加惩罚）
+         */
+        longStraightRatio?: number;
+        /**
+         * “长直线惩罚”的权重
+         */
+        longStraightWeight?: number;
+        /**
+         * 生成候选路径时是否包含 S-route（两次转折）
+         */
+        enableSRoutes?: boolean;
+        /**
+         * routeType=bezier 时，距离小于该值会自动降级为 orthogonal（避免回勾/贴边）
+         */
+        bezierFallbackDistance?: number;
+    };
+    /**
+     * 自动更新模式
+     * - event: 仅 DragEvent + 交互触发 update（默认）
+     * - render: 每帧 RenderEvent.END 调用 update（适合协同/程序频繁改坐标）
+     * - manual: 完全手动（你需要自己调用 connector.update()）
+     */
+    updateMode?: "event" | "render" | "manual";
+    /**
+     * render 模式下的节流（ms）
+     * - 0 表示不节流（每帧都允许触发，但仍会走内部 key 去重）
+     * - 建议协同场景设置 16~33
+     */
+    renderThrottleMs?: number;
+    /**
+     * 协同序列化：从节点对象获取 id（用于 getState）
+     */
+    getNodeId?: (node: IUI) => string;
+    /**
+     * label 文本变化回调（用于协同同步 label）
+     */
+    onLabelChange?: (param: {
+        oldText: string;
+        newText: string;
+    }) => void;
+    /**
+     * 统一变更回调（用于协同同步 connector 状态）
+     * - 依赖 getNodeId，缺失时将无法生成 state（会跳过回调）
+     */
+    onChange?: (param: {
+        reason: "label" | "setState";
+        prev: ConnectorState;
+        next: ConnectorState;
+        diff: Partial<ConnectorState>;
+        changedKeys: (keyof ConnectorState)[];
+    }) => void;
+    stroke?: string;
+    strokeWidth?: number;
+    dashPattern?: number[];
+    startArrow?: IArrowStyle;
+    endArrow?: IArrowStyle;
+    scaleMode?: ConnectorScaleMode;
+    arrowBaseScale?: number;
+    label?: {
+        text?: string;
+        editable?: boolean;
+        style?: Partial<ITextInputData>;
+    };
+    labelOnDoubleClick?: boolean;
+}
+export interface ConnectorState {
+    fromId: string | number;
+    toId: string | number;
+    routeType: ConnectorRouteType;
+    padding: number;
+    margin: number;
+    cornerRadius: number;
+    bezierCurvature: number;
+    opt1?: TargetOption;
+    opt2?: TargetOption;
+    stroke?: string;
+    strokeWidth?: number;
+    dashPattern?: number[];
+    startArrow?: IArrowStyle;
+    endArrow?: IArrowStyle;
+    scaleMode?: ConnectorScaleMode;
+    arrowBaseScale?: number;
+    label?: {
+        text?: string;
+        editable?: boolean;
+        style?: Partial<ITextInputData>;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAElF,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AACjF,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEhE,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACrC;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,CAAC;AAE7B,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,GAAG,CAAC;IACV,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,GAAG,CAAC;IACV,EAAE,EAAE,GAAG,CAAC;IAER;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,CAAC,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;QACf,CAAC,EAAE,cAAc,CAAC;QAClB,CAAC,EAAE,cAAc,CAAC;QAClB,aAAa,EAAE,mBAAmB,CAAC;KACpC,KAAK,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,YAAY,CAAC,EAAE;QACb;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IAEF;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAE3C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,MAAM,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,KAAK,IAAI,CAAC;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;QACjB,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;QAC7B,IAAI,EAAE,cAAc,CAAC;QACrB,IAAI,EAAE,cAAc,CAAC;QACrB,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QAC9B,WAAW,EAAE,CAAC,MAAM,cAAc,CAAC,EAAE,CAAC;KACvC,KAAK,IAAI,CAAC;IAEX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;KACjC,CAAC;IACF,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;KACjC,CAAC;CACH"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/esm/utils.d.ts

@@ -0,0 +1,3 @@
+export declare function mid(a: number, b: number): number;
+export declare function clamp(n: number, min: number, max: number): number;
+//# sourceMappingURL=utils.d.ts.map

package/dist/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,UAEvC;AAED,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,UAExD"}

package/dist/esm/utils.js

@@ -0,0 +1,7 @@
+export function mid(a, b) {
+    return (a + b) / 2;
+}
+export function clamp(n, min, max) {
+    return Math.max(min, Math.min(max, n));
+}
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,CAAS;IACtC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,CAAS,EAAE,GAAW,EAAE,GAAW;IACvD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;AACzC,CAAC"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "leafer-connector",
+  "version": "0.1.0",
+  "description": "A LeaferJS connector (edge) component with arrows, multiple route types, labels, and collaboration helpers.",
+  "license": "MIT",
+  "homepage": "https://github.com/rideWind97/leafer-connector",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rideWind97/leafer-connector.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rideWind97/leafer-connector/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "keywords": [
+    "leafer",
+    "leaferjs",
+    "connector",
+    "edge",
+    "arrow",
+    "diagram",
+    "flow"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs"
+    }
+  },
+  "peerDependencies": {
+    "leafer-editor": "^1.12.1"
+  },
+  "peerDependenciesMeta": {
+    "leafer-editor": {
+      "optional": false
+    }
+  },
+  "scripts": {
+    "clean": "node scripts/clean.mjs",
+    "build:esm": "pnpm exec tsc -p tsconfig.build.esm.json",
+    "build:cjs": "pnpm exec tsc -p tsconfig.build.cjs.json && node scripts/rename-cjs.mjs",
+    "build": "pnpm run clean && pnpm run build:esm && pnpm run build:cjs",
+    "bundle:rollup": "pnpm run build && pnpm exec rollup -c rollup.config.mjs",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "rollup": "^4.40.0",
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
+
+