fastapi-voyager 0.12.5__tar.gz → 0.12.6__tar.gz

{fastapi_voyager-0.12.5 → fastapi_voyager-0.12.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.12.5
+Version: 0.12.6
 Summary: Visualize FastAPI application's routing tree and dependencies
 Project-URL: Homepage, https://github.com/allmonday/fastapi-voyager
 Project-URL: Source, https://github.com/allmonday/fastapi-voyager

{fastapi_voyager-0.12.5 → fastapi_voyager-0.12.6}/docs/changelog.md

@@ -116,9 +116,12 @@
     - [x] refactor fe with store based on reactive
     - [x] fix duplicated focus toggle
 - 0.12.6
+    - [x] fix overlapped edges
+    - [x] click link(edge) to highlight related nodes
+    - [x] on hover cursor effect
+- 0.12.7
     - [ ] refactor render.py
     - [ ] remove search component, integrated into main page
-    - [ ] click link to highlight related nodes
 
 ## 0.13
 - 0.13.2

{fastapi_voyager-0.12.5 → fastapi_voyager-0.12.6}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.12.5"
+__version__ = "0.12.6"

{fastapi_voyager-0.12.5 → fastapi_voyager-0.12.6}/src/fastapi_voyager/web/graph-ui.js

@@ -9,14 +9,31 @@ export class GraphUI {
     this._init();
   }
 
-  _highlight() {
+  _highlight(mode = "bidirectional") {
     let highlightedNodes = $();
     for (const selection of this.currentSelection) {
-      const nodes = this._getAffectedNodes(selection.set, "bidirectional");
+      const nodes = this._getAffectedNodes(selection.set, mode);
       highlightedNodes = highlightedNodes.add(nodes);
     }
     if (this.gv) {
       this.gv.highlight(highlightedNodes, true);
+      this.gv.bringToFront(highlightedNodes);
+    }
+  }
+
+  _highlightEdgeNodes() {
+    let highlightedNodes = $();
+    const [up, down, edge] = this.currentSelection
+    highlightedNodes = highlightedNodes.add(
+      this._getAffectedNodes(up.set, up.direction)
+    );
+    highlightedNodes = highlightedNodes.add(
+      this._getAffectedNodes(down.set, down.direction)
+    );
+    highlightedNodes = highlightedNodes.add(edge.set)
+    if (this.gv) {
+      this.gv.highlight(highlightedNodes, true);
+      this.gv.bringToFront(highlightedNodes);
     }
   }
 
@@ -65,6 +82,7 @@ export class GraphUI {
     }
   }
 
+
   _init() {
     const self = this;
     $(this.selector).graphviz({
@@ -93,13 +111,20 @@ export class GraphUI {
         });
 
         self.gv.edges().click(function (event) {
-          // const set = $();
-          // const downStreamNode = event.currentTarget.dataset.name.split("->")[1];
-          // const nodes = self.gv.nodesByName();
-          // set.push(nodes[downStreamNode]);
-          // const obj = { set, direction: "single" };
-          // self.currentSelection = [obj];
-          // todo highlight edge and downstream node
+          const up = $();
+          const down = $();
+          const edge = $();
+          const [upStreamNode, downStreamNode] = event.currentTarget.dataset.name.split("->");
+          const nodes = self.gv.nodesByName();
+          up.push(nodes[upStreamNode]);
+          down.push(nodes[downStreamNode]);
+          edge.push(this)
+          const upObj = { set: up, direction: "upstream" };
+          const downObj = { set: down, direction: "downstream" };
+          const edgeOjb = { set: edge, direction: "single"};
+          self.currentSelection = [upObj, downObj, edgeOjb];
+
+          self._highlightEdgeNodes();
         })
 
         self.gv.nodes().click(function (event) {
@@ -127,15 +152,6 @@ export class GraphUI {
           }
         });
 
-        self.gv.clusters().click(function (event) {
-          const set = $();
-          set.push(this);
-          const obj = { set, direction: "single" };
-          self.currentSelection = [obj];
-          self._highlight();
-        });
-
-        // click background to reset highlight 
         $(document)
           .off("click.graphui")
           .on("click.graphui", function (evt) {
@@ -150,9 +166,9 @@ export class GraphUI {
             }
 
             let isNode = false;
-            const $nodes = self.gv.nodes();
+            const $everything = self.gv.$nodes.add(self.gv.$edges).add(self.gv.$clusters);
             const node = evt.target.parentNode;
-            $nodes.each(function () {
+            $everything.each(function () {
               if (this === node) {
                 isNode = true;
               }

{fastapi_voyager-0.12.5 → fastapi_voyager-0.12.6}/src/fastapi_voyager/web/graphviz.svg.js

@@ -21,6 +21,8 @@
     url: null,
     svg: null,
     shrink: "0.125pt",
+    edgeHitPadding: 12,
+    pointerCursor: true,
     tooltips: {
       init: function ($graph) {
         var $a = $(this);
@@ -168,9 +170,20 @@
     var that = this;
     var options = this.options;
 
+    if (type === "edge" && options.edgeHitPadding) {
+      this.ensureEdgeHitArea($el, options.edgeHitPadding);
+    }
+
+    if (options.pointerCursor && (type === "edge" || type === "node")) {
+      this.setInteractiveCursor($el, type === "edge");
+    }
+
     // save the colors of the paths, ellipses and polygons
     $el.find("polygon, ellipse, path").each(function () {
       var $this = $(this);
+      if ($this.attr("data-graphviz-hitbox") === "true") {
+        return;
+      }
       // save original colors
       $this.data("graphviz.svg.color", {
         fill: $this.attr("fill"),
@@ -314,6 +327,69 @@
     }
   };
 
+  GraphvizSvg.prototype.ensureEdgeHitArea = function ($edge, padding) {
+    var width = parseFloat(padding);
+    if (!isFinite(width) || width <= 0) {
+      return;
+    }
+    var $paths = $edge
+      .children("path")
+      .filter(function () {
+        return $(this).attr("data-graphviz-hitbox") !== "true";
+      });
+    if (!$paths.length) {
+      return;
+    }
+    $paths.each(function () {
+      var $path = $(this);
+      var $existing = $path.prev('[data-graphviz-hitbox="true"]');
+      if ($existing.length) {
+        $existing.attr("stroke-width", width);
+        return;
+      }
+      var clone = this.cloneNode(false);
+
+      /**
+       * gtp-5-codex:
+       * Cloning the edge paths without copying D3’s data binding caused those Cannot 
+       * read properties of undefined (reading 'key') errors when d3-graphviz re-rendered. 
+       * I now copy the original path’s bound datum (__data__) onto the transparent hitbox 
+       * clone inside ensureEdgeHitArea, so D3 still finds the expected metadata.
+       */
+      if (this.__data__) {
+        clone.__data__ = this.__data__;
+      }
+
+      var $clone = $(clone);
+      $clone.attr({
+        "data-graphviz-hitbox": "true",
+        stroke: "transparent",
+        fill: "none",
+        "stroke-width": width,
+      });
+      $clone.attr("pointer-events", "stroke");
+      $clone.css("pointer-events", "stroke");
+      if (!$clone.attr("stroke-linecap")) {
+        $clone.attr("stroke-linecap", $path.attr("stroke-linecap") || "round");
+      }
+      $clone.insertBefore($path);
+    });
+  };
+
+  GraphvizSvg.prototype.setInteractiveCursor = function ($el, isEdge) {
+    $el.css("cursor", "pointer");
+    var selectors = "path, polygon, ellipse, rect, text";
+    $el.find(selectors).each(function () {
+      $(this).css("cursor", "pointer");
+    });
+    if (isEdge) {
+      $el.children('[data-graphviz-hitbox="true"]').css("cursor", "pointer");
+    }
+    $el.find("a").each(function () {
+      $(this).css("cursor", "pointer");
+    });
+  };
+
   GraphvizSvg.prototype.convertToPx = function (val) {
     var retval = val;
     if (typeof val == "string") {
@@ -372,6 +448,9 @@
     var bg = this.$element.css("background");
     $el.find("polygon, ellipse, path").each(function () {
       var $this = $(this);
+      if ($this.attr("data-graphviz-hitbox") === "true") {
+        return;
+      }
       var color = $this.data("graphviz.svg.color");
       if (color.fill && color.fill != "none") {
         $this.attr("fill", getColor(color.fill, bg)); // don't set  fill if it's a path
@@ -386,6 +465,9 @@
   GraphvizSvg.prototype.restoreElement = function ($el) {
     $el.find("polygon, ellipse, path").each(function () {
       var $this = $(this);
+      if ($this.attr("data-graphviz-hitbox") === "true") {
+        return;
+      }
       var color = $this.data("graphviz.svg.color");
       if (color.fill && color.fill != "none") {
         $this.attr("fill", color.fill); // don't set  fill if it's a path