fastapi-voyager 0.12.10__tar.gz → 0.12.11__tar.gz

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.12.10
+Version: 0.12.11
 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
@@ -31,7 +31,6 @@ Description-Content-Type: text/markdown
 [![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-
 Visualize your FastAPI endpoints, and explore them interactively.
 
 > This repo is still in early stage, it supports pydantic v2 only
@@ -49,7 +48,7 @@ app.mount('/voyager',
             module_color={'src.services': 'tomato'}, 
             module_prefix='src.services', 
             swagger_url="/docs",
-            ga_id="G-R64S7Q49VL",
+            ga_id="G-XXXXXXXXVL",
             initial_page_policy='first',
             online_repo_url='https://github.com/allmonday/composition-oriented-development-pattern/blob/master'))
 ```

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/README.md

@@ -3,7 +3,6 @@
 [![PyPI Downloads](https://static.pepy.tech/badge/fastapi-voyager/month)](https://pepy.tech/projects/fastapi-voyager)
 
 
-
 Visualize your FastAPI endpoints, and explore them interactively.
 
 > This repo is still in early stage, it supports pydantic v2 only
@@ -21,7 +20,7 @@ app.mount('/voyager',
             module_color={'src.services': 'tomato'}, 
             module_prefix='src.services', 
             swagger_url="/docs",
-            ga_id="G-R64S7Q49VL",
+            ga_id="G-XXXXXXXXVL",
             initial_page_policy='first',
             online_repo_url='https://github.com/allmonday/composition-oriented-development-pattern/blob/master'))
 ```

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/docs/changelog.md

@@ -128,7 +128,11 @@
 - 0.12.10
     - [x] fix: double trigger on reset search
 - 0.12.11
-    - [ ] fix: pick tag and then pick route directly from another tag will render nothing
+    - [x] better ui for schema select
+    - [x] fix: pick tag and then pick route directly from another tag will render nothing
+    - [x] feat: cancel search schema triggered by shift click will redirect back to previous tag, route selection
+    - [x] optimize the node style
+- 0.12.12
     - [ ] refactor vue-main.js, move methods to store
     - [ ] refactor render.py
 

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/src/fastapi_voyager/render.py

@@ -57,7 +57,7 @@ class Renderer:
         header_color = 'tomato' if node.id == self.schema else default_color
         header = f"""<tr><td cellpadding="6" bgcolor="{header_color}" align="center" colspan="1" port="{PK}"> <font color="white">    {node.name}    </font></td> </tr>"""
         field_content = ''.join(fields_parts) if fields_parts else ''
-        return f"""<<table border="1" cellborder="0" cellpadding="0" bgcolor="white"> {header} {field_content}   </table>>"""
+        return f"""<<table border="0" cellborder="1" cellpadding="0" cellspacing="0" bgcolor="white"> {header} {field_content}   </table>>"""
 
     def _handle_schema_anchor(self, source: str) -> str:
         if '::' in source:

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.12.10"
+__version__ = "0.12.11"

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/src/fastapi_voyager/web/graph-ui.js

@@ -91,7 +91,13 @@ export class GraphUI {
       ready: function () {
         self.gv = this;
 
-        self.gv.nodes().dblclick(function (event) {
+        const nodes = self.gv.nodes();
+        const edges = self.gv.edges();
+
+        nodes.off(".graphui");
+        edges.off(".graphui");
+
+        nodes.on("dblclick.graphui", function (event) {
           event.stopPropagation();
           try {
             self.highlightSchemaBanner(this)
@@ -110,7 +116,7 @@ export class GraphUI {
           }
         });
 
-        self.gv.edges().click(function (event) {
+        edges.on("click.graphui", function (event) {
           const up = $();
           const down = $();
           const edge = $();
@@ -127,13 +133,14 @@ export class GraphUI {
           self._highlightEdgeNodes();
         })
 
-        self.gv.nodes().click(function (event) {
+        nodes.on("click.graphui", function (event) {
           const set = $();
           set.push(this);
           const obj = { set, direction: "bidirectional" };
 
           const schemaName = event.currentTarget.dataset.name;
-          if (event.shiftKey && self.options.onSchemaClick) {
+          console.log("shift click detected");
+          if (event.shiftKey && self.options.onSchemaShiftClick) {
             if (schemaName) {
               try {
                 self.options.onSchemaShiftClick(schemaName);

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/src/fastapi_voyager/web/index.html

@@ -158,7 +158,16 @@
                 @update:model-value="onSearchSchemaChange"
                 @filter="filterSearchSchemas"
                 @clear="resetSearch"
-              ></q-select>
+              >
+               <template v-slot:option="scope">
+                <q-item v-bind="scope.itemProps">
+                  <q-item-section>
+                    <q-item-label>{{ scope.opt.label }}</q-item-label>
+                    <q-item-label caption>{{ scope.opt.desc }}</q-item-label>
+                  </q-item-section>
+                </q-item>
+              </template>
+            </q-select>
               
               <q-select
                 dense
@@ -272,7 +281,6 @@
                       expand-separator
                       :model-value="store.state.leftPanel._tag === tag.name || store.state.search.mode"
                       @update:model-value="(val) => toggleTag(tag.name, val)"
-                      @click="() => toggleTag(tag.name, true)"
                       :header-class="store.state.leftPanel.tag === tag.name ? 'text-primary text-bold tag-bg' : 'tag-bg'"
                       content-class="q-pa-none"
                     >

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/src/fastapi_voyager/web/store.js

@@ -9,6 +9,12 @@ const state = reactive({
     config: {
         initial_page_policy: 'first'
     },
+    
+    previousTagRoute: {  // for shift + click, store previous tag/route, and populate back when needed
+        hasValue: false,
+        tag: null,
+        routeId: null
+    },
 
     swagger: {
         url: ''

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/src/fastapi_voyager/web/vue-main.js

@@ -12,14 +12,11 @@ const app = createApp({
     let graphUI = null;
     const allSchemaOptions = ref([]);
 
-    const NBSP = String.fromCharCode(160);
-    const formatSchemaLabel = (name, id) =>
-      `${name}${NBSP}${NBSP}${NBSP}-${NBSP}${NBSP}${NBSP}${id}`;
-
     function rebuildSchemaOptions() {
       const dict = store.state.graph.schemaMap || {};
       const opts = Object.values(dict).map((s) => ({
-        label: formatSchemaLabel(s.name, s.id),
+        label: s.name,
+        desc: s.id,
         value: s.id,
       }));
       allSchemaOptions.value = opts;
@@ -136,9 +133,19 @@ const app = createApp({
 
     async function resetSearch() {
       store.state.search.mode = false;
-      store.state.leftPanel.tag = null;
-      store.state.leftPanel._tag = null;
-      store.state.leftPanel.routeId = null;
+      console.log(store.state.previousTagRoute.hasValue)
+      console.log(store.state.previousTagRoute)
+      if (store.state.previousTagRoute.hasValue) {
+        store.state.leftPanel.tag = store.state.previousTagRoute.tag;
+        store.state.leftPanel._tag = store.state.previousTagRoute.tag;
+        store.state.leftPanel.routeId = store.state.previousTagRoute.routeId;
+        store.state.previousTagRoute.hasValue = false;
+      } else {
+        store.state.leftPanel.tag = null;
+        store.state.leftPanel._tag = null;
+        store.state.leftPanel.routeId = null;
+      }
+
       syncSelectionToUrl()
       await loadSearchedTags();
       renderBasedOnInitialPolicy()
@@ -274,12 +281,19 @@ const app = createApp({
           graphUI = new GraphUI("#graph", {
             onSchemaShiftClick: (id) => {
               if (store.state.graph.schemaKeys.has(id)) {
+
+                console.log(store.state.leftPanel)
+                store.state.previousTagRoute.tag = store.state.leftPanel.tag;
+                store.state.previousTagRoute.routeId = store.state.leftPanel.routeId;
+                store.state.previousTagRoute.hasValue = true;
+
                 store.state.search.mode = true;
                 store.state.search.schemaName = id;
                 onSearch();
               }
             },
             onSchemaClick: (id) => {
+              console.log("schema clicked:", id);
               resetDetailPanels();
               if (store.state.graph.schemaKeys.has(id)) {
                 store.state.schemaDetail.schemaCodeName = id;
@@ -318,7 +332,7 @@ const app = createApp({
     }
 
     function toggleTag(tagName, expanded = null) {
-      if (expanded === true) {
+      if (expanded === true || store.state.search.mode === true) {
         store.state.leftPanel._tag = tagName;
         store.state.leftPanel.tag = tagName;
         store.state.leftPanel.routeId = "";
@@ -335,16 +349,24 @@ const app = createApp({
     }
 
     function selectRoute(routeId) {
+      // find belonging tag
+      const belongingTag = findTagByRoute(routeId);
+      if (belongingTag) {
+        store.state.leftPanel.tag = belongingTag;
+        store.state.leftPanel._tag = belongingTag;
+      }
+
       if (store.state.leftPanel.routeId === routeId) {
         store.state.leftPanel.routeId = "";
       } else {
         store.state.leftPanel.routeId = routeId;
       }
+
       store.state.rightDrawer.drawer = false;
       store.state.routeDetail.show = false;
       store.state.schemaDetail.schemaCodeName = "";
-      onGenerate();
       syncSelectionToUrl();
+      onGenerate();
     }
 
     function toggleShowModule(val) {

{fastapi_voyager-0.12.10 → fastapi_voyager-0.12.11}/tests/programatic.py

@@ -1,6 +1,6 @@
 from fastapi_voyager import create_voyager
-from tests.demo_anno import app
-# from tests.demo import app
+# from tests.demo_anno import app
+from tests.demo import app
 
 app.mount(
     '/voyager',