reactflow-edge-routing 0.1.7 → 0.1.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reactflow-edge-routing",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Orthogonal edge routing for React Flow using obstacle-router. Edges route around nodes while pins stay fixed at their anchor points.",
   "main": "./src/index.ts",
   "types": "./src/index.ts",

package/src/index.ts

@@ -34,7 +34,7 @@ export { useEdgeRouting } from "./use-edge-routing";
 export type { UseEdgeRoutingOptions, UseEdgeRoutingResult } from "./use-edge-routing";
 
 export { useRoutedEdgePath } from "./use-routed-edge-path";
-export type { UseRoutedEdgePathParams } from "./use-routed-edge-path";
+export type { UseRoutedEdgePathParams, RoutePinPoints } from "./use-routed-edge-path";
 
 // Collision resolution
 export { resolveCollisions } from "./resolve-collisions";

package/src/routing-core.ts

@@ -60,6 +60,8 @@ export type AvoidRoute = {
   sourceY: number;
   targetX: number;
   targetY: number;
+  /** Raw routed waypoints (including handle stubs). Use slice(1,-1) for editable edge control points. */
+  points?: { x: number; y: number }[];
 };
 
 export type ConnectorType = "orthogonal" | "polyline" | "bezier";
@@ -522,53 +524,62 @@ export class PathBuilder {
   }
 
   /**
-   * Convert routed waypoints to a smooth bezier spline.
+   * Convert routed waypoints to a smooth cubic Bezier spline using
+   * Catmull-Rom → Bezier conversion with adaptive tension.
    *
-   * Takes the orthogonal waypoints from libavoid, keeps only corners
-   * (where direction changes), then draws a smooth cubic bezier spline
-   * through them. The result is a flowing curve — not orthogonal at all —
-   * that still follows the obstacle-avoiding route.
+   * Steps:
+   * 1. Deduplicate and remove collinear intermediate points (keep corners only).
+   * 2. For each segment, compute control points from neighboring points.
+   * 3. Clamp control-point reach to prevent overshooting / edge crossings.
+   * 4. Adapt tension based on segment length — short segments get less curvature.
    */
   static routedBezierPath(
     points: { x: number; y: number }[],
-    options: { gridSize?: number } = {}
+    options: { gridSize?: number; baseTension?: number } = {}
   ): string {
     if (points.length < 2) return "";
     const gridSize = options.gridSize ?? 0;
+    const baseTension = options.baseTension ?? 0.2;
     const snap = (p: { x: number; y: number }) =>
       gridSize > 0 ? Geometry.snapToGrid(p.x, p.y, gridSize) : p;
 
     const raw = points.map(snap);
 
-    // Deduplicate
+    // Deduplicate near-identical consecutive points
     const deduped: { x: number; y: number }[] = [raw[0]];
     for (let i = 1; i < raw.length; i++) {
       const prev = deduped[deduped.length - 1];
-      if (Math.abs(raw[i].x - prev.x) > 0.5 || Math.abs(raw[i].y - prev.y) > 0.5) {
+      if (Math.abs(raw[i].x - prev.x) > 1 || Math.abs(raw[i].y - prev.y) > 1) {
         deduped.push(raw[i]);
       }
     }
 
     // Remove collinear midpoints — keep only corners + endpoints
-    const pts: { x: number; y: number }[] = [deduped[0]];
-    for (let i = 1; i < deduped.length - 1; i++) {
-      const prev = deduped[i - 1];
-      const curr = deduped[i];
-      const next = deduped[i + 1];
-      const sameX = Math.abs(prev.x - curr.x) < 1 && Math.abs(curr.x - next.x) < 1;
-      const sameY = Math.abs(prev.y - curr.y) < 1 && Math.abs(curr.y - next.y) < 1;
-      if (!sameX || !sameY) pts.push(curr);
+    let pts: { x: number; y: number }[];
+    if (deduped.length <= 2) {
+      pts = deduped;
+    } else {
+      pts = [deduped[0]];
+      for (let i = 1; i < deduped.length - 1; i++) {
+        const prev = deduped[i - 1];
+        const curr = deduped[i];
+        const next = deduped[i + 1];
+        const sameX = Math.abs(prev.x - curr.x) < 1 && Math.abs(curr.x - next.x) < 1;
+        const sameY = Math.abs(prev.y - curr.y) < 1 && Math.abs(curr.y - next.y) < 1;
+        if (!sameX || !sameY) pts.push(curr);
+      }
+      pts.push(deduped[deduped.length - 1]);
     }
-    pts.push(deduped[deduped.length - 1]);
 
-    if (pts.length < 2) return `M ${pts[0].x} ${pts[0].y}`;
+    if (pts.length === 0) return "";
+    if (pts.length === 1) return `M ${pts[0].x} ${pts[0].y}`;
 
-    // 2 points: simple bezier with offset control points
+    // 2 points: simple bezier with offset control points scaled to distance
     if (pts.length === 2) {
       const [s, t] = pts;
       const dx = t.x - s.x;
       const dy = t.y - s.y;
-      const offset = Math.max(50, Math.max(Math.abs(dx), Math.abs(dy)) * 0.5);
+      const offset = Math.max(30, Math.max(Math.abs(dx), Math.abs(dy)) * 0.4);
       if (Math.abs(dx) >= Math.abs(dy)) {
         const sign = dx >= 0 ? 1 : -1;
         return `M ${s.x} ${s.y} C ${s.x + offset * sign} ${s.y}, ${t.x - offset * sign} ${t.y}, ${t.x} ${t.y}`;
@@ -577,10 +588,6 @@ export class PathBuilder {
       return `M ${s.x} ${s.y} C ${s.x} ${s.y + offset * sign}, ${t.x} ${t.y - offset * sign}, ${t.x} ${t.y}`;
     }
 
-    // 3+ points: smooth cubic bezier spline through all corner points.
-    // For each segment i→i+1, compute tangent-based control points using
-    // neighbors (Catmull-Rom style, tension 0.3).
-    const tension = 0.3;
     const dist = (a: { x: number; y: number }, b: { x: number; y: number }) =>
       Math.hypot(b.x - a.x, b.y - a.y);
 
@@ -594,10 +601,21 @@ export class PathBuilder {
 
       const segLen = dist(p1, p2);
 
-      // Tangent at p1: direction from p0 to p2
+      // Skip curvature for very short segments
+      if (segLen < 5) {
+        d += ` L ${p2.x} ${p2.y}`;
+        continue;
+      }
+
+      // Adaptive tension: shorter segments get less curvature to avoid overshooting
+      const tension =
+        segLen < 40 ? baseTension * 0.3 :
+        segLen < 80 ? baseTension * 0.6 :
+        baseTension;
+
+      // Catmull-Rom to cubic bezier control points
       let cp1x = p1.x + (p2.x - p0.x) * tension;
       let cp1y = p1.y + (p2.y - p0.y) * tension;
-      // Tangent at p2: direction from p1 to p3
       let cp2x = p2.x - (p3.x - p1.x) * tension;
       let cp2y = p2.y - (p3.y - p1.y) * tension;
 
@@ -1023,7 +1041,7 @@ export class RoutingEngine {
       const labelP = gridSize > 0 ? Geometry.snapToGrid(midP.x, midP.y, gridSize) : midP;
       const first = points[0];
       const last = points[points.length - 1];
-      result[edgeId] = { path, labelX: labelP.x, labelY: labelP.y, sourceX: first.x, sourceY: first.y, targetX: last.x, targetY: last.y };
+      result[edgeId] = { path, labelX: labelP.x, labelY: labelP.y, sourceX: first.x, sourceY: first.y, targetX: last.x, targetY: last.y, points };
     }
 
     RoutingEngine.cleanup(router, connRefs, shapeRefList);
@@ -1229,7 +1247,7 @@ export class PersistentRouter {
       const labelP = gridSize > 0 ? Geometry.snapToGrid(midP.x, midP.y, gridSize) : midP;
       const first = points[0];
       const last = points[points.length - 1];
-      result[edgeId] = { path, labelX: labelP.x, labelY: labelP.y, sourceX: first.x, sourceY: first.y, targetX: last.x, targetY: last.y };
+      result[edgeId] = { path, labelX: labelP.x, labelY: labelP.y, sourceX: first.x, sourceY: first.y, targetX: last.x, targetY: last.y, points };
     }
     return result;
   }

package/src/use-routed-edge-path.ts

@@ -56,16 +56,29 @@ function getFallback(
   return getStraightPath({ sourceX, sourceY, targetX, targetY });
 }
 
+export type RoutePinPoints = {
+  sourceX: number; sourceY: number;
+  targetX: number; targetY: number;
+};
+
 /**
- * Returns [path, labelX, labelY, wasRouted] for a routed edge.
+ * Returns [path, labelX, labelY, wasRouted, controlPoints, pinPoints] for a routed edge.
  *
  * - While a connected node is being dragged → dashed fallback
  * - If a routed path exists for this edge → solid routed path
  * - No route yet (worker hasn't responded) → dashed fallback
+ *
+ * `controlPoints` are the intermediate waypoints of the routed path (excluding
+ * the source and target anchor points). Use them to build an editable edge on
+ * top of auto-routing — e.g. render draggable handles at each waypoint.
+ * When no route is available (fallback), `controlPoints` is an empty array.
+ *
+ * `pinPoints` are the exact source/target positions the router snapped to.
+ * Falls back to the passed-in sourceX/Y, targetX/Y when no route is available.
  */
 export function useRoutedEdgePath(
   params: UseRoutedEdgePathParams
-): [path: string, labelX: number, labelY: number, wasRouted: boolean] {
+): [path: string, labelX: number, labelY: number, wasRouted: boolean, controlPoints: { x: number; y: number }[], pinPoints: RoutePinPoints] {
   const {
     id, sourceX, sourceY, targetX, targetY,
     sourcePosition, targetPosition,
@@ -76,6 +89,8 @@ export function useRoutedEdgePath(
   const draggingNodeIds = useEdgeRoutingStore((s) => s.draggingNodeIds);
 
   return useMemo(() => {
+    const fallbackPins: RoutePinPoints = { sourceX, sourceY, targetX, targetY };
+
     // If a connected node is being dragged, show fallback
     const isDragging =
       draggingNodeIds.size > 0 &&
@@ -84,16 +99,25 @@ export function useRoutedEdgePath(
 
     if (isDragging) {
       const [path, lx, ly] = getFallback(sourceX, sourceY, targetX, targetY, sourcePosition, targetPosition, connectorType, params.borderRadius, offset);
-      return [path, lx, ly, false];
+      return [path, lx, ly, false, [], fallbackPins];
     }
 
     // If we have a routed path, use it (no stale check — trust the router)
     if (route?.path) {
-      return [route.path, route.labelX, route.labelY, true];
+      // Strip the first (source anchor) and last (target anchor) points — the
+      // middle points are the editable control points for the connector.
+      const controlPoints = route.points && route.points.length > 2
+        ? route.points.slice(1, -1)
+        : [];
+      const pins: RoutePinPoints = {
+        sourceX: route.sourceX, sourceY: route.sourceY,
+        targetX: route.targetX, targetY: route.targetY,
+      };
+      return [route.path, route.labelX, route.labelY, true, controlPoints, pins];
     }
 
     // No route yet — show fallback
     const [path, lx, ly] = getFallback(sourceX, sourceY, targetX, targetY, sourcePosition, targetPosition, connectorType, params.borderRadius, offset);
-    return [path, lx, ly, false];
+    return [path, lx, ly, false, [], fallbackPins];
   }, [route, sourceX, sourceY, targetX, targetY, sourcePosition, targetPosition, offset, connectorType, params.borderRadius, source, target, draggingNodeIds]);
 }