fastapi-voyager 0.11.5__py3-none-any.whl → 0.11.7__py3-none-any.whl

fastapi_voyager/server.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Optional
+from typing import Optional, Literal
 from fastapi import FastAPI, APIRouter
 from starlette.middleware.gzip import GZipMiddleware
 from pydantic import BaseModel
@@ -15,6 +15,7 @@ from fastapi_voyager.version import __version__
 WEB_DIR = Path(__file__).parent / "web"
 WEB_DIR.mkdir(exist_ok=True)
 
+INITIAL_PAGE_POLICY = Literal['first', 'full', 'empty']
 
 class OptionParam(BaseModel):
 	tags: list[Tag]
@@ -22,6 +23,7 @@ class OptionParam(BaseModel):
 	dot: str
 	enable_brief_mode: bool
 	version: str
+	initial_page_policy: INITIAL_PAGE_POLICY
 	swagger_url: Optional[str] = None
 
 class Payload(BaseModel):
@@ -42,6 +44,7 @@ def create_route(
 	swagger_url: Optional[str] = None,
 	module_prefix: Optional[str] = None,
 	online_repo_url: Optional[str] = None,
+	initial_page_policy: INITIAL_PAGE_POLICY = 'first',
 ):
 	"""
 	module_color: dict mapping module name to color string, e.g. {'models': 'lightblue'}
@@ -67,7 +70,8 @@ def create_route(
 			dot=dot,
 			enable_brief_mode=bool(module_prefix),
 			version=__version__,
-			swagger_url=swagger_url)
+			swagger_url=swagger_url,
+			initial_page_policy=initial_page_policy)
 
 	@router.post("/dot", response_class=PlainTextResponse)
 	def get_filtered_dot(payload: Payload) -> str:
@@ -213,13 +217,16 @@ def create_voyager(
 	module_prefix: Optional[str] = None,
 	swagger_url: Optional[str] = None,
 	online_repo_url: Optional[str] = None,
+	initial_page_policy: INITIAL_PAGE_POLICY = 'first',
 ) -> FastAPI:
 	router = create_route(
 		target_app, 
 		module_color=module_color, 
 		module_prefix=module_prefix, 
 		swagger_url=swagger_url,
-		online_repo_url=online_repo_url)
+		online_repo_url=online_repo_url,
+		initial_page_policy=initial_page_policy,
+		)
 
 	app = FastAPI(title="fastapi-voyager demo server")
 	if gzip_minimum_size is not None and gzip_minimum_size >= 0:

fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.11.5"
+__version__ = "0.11.7"

fastapi_voyager/voyager.py

@@ -1,5 +1,6 @@
 from pydantic import BaseModel
 from fastapi import FastAPI, routing
+from typing import Callable
 from fastapi_voyager.type_helper import (
     get_core_types,
     full_class_name,
@@ -27,7 +28,8 @@ class Voyager:
             module_color: dict[str, str] | None = None,
             route_name: str | None = None,
             hide_primitive_route: bool = False,
-            show_module: bool = True
+            show_module: bool = True,
+            route_name_fn: Callable | None = None
         ):
 
         self.routes: list[Route] = []
@@ -50,6 +52,7 @@ class Voyager:
         self.route_name = route_name
         self.hide_primitive_route = hide_primitive_route
         self.show_module = show_module
+        self.route_name_fn = route_name_fn
     
 
     def _get_available_route(self, app: FastAPI):
@@ -123,7 +126,7 @@ class Voyager:
                     id=route_id,
                     name=route_name,
                     module=route_module,
-                    unique_id=route.unique_id,
+                    unique_id=self.route_name_fn(route) if self.route_name_fn else route.unique_id,
                     response_schema=get_type_name(route.response_model),
                     is_primitive=is_primitive_response
                 )

fastapi_voyager/web/index.html

@@ -59,8 +59,39 @@
     .adjust-fit {
       height: calc(100vh - 54px);
     }
+    /* App boot loading overlay & gating */
+    #app-loading-overlay {
+      position: fixed;
+      inset: 0;
+      display: none;
+      align-items: center;
+      justify-content: center;
+      gap: 12px;
+      background: #ffffff;
+      z-index: 9999;
+      font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Helvetica, Arial, sans-serif;
+      color: #009485;
+    }
+    .loading-text { font-size: 14px; }
+    .spinner {
+      width: 20px;
+      height: 20px;
+      border: 2px solid rgba(0, 148, 133, 0.2);
+      border-top-color: #009485;
+      border-radius: 50%;
+      animation: frv-spin 0.8s linear infinite;
+    }
+    @keyframes frv-spin { to { transform: rotate(360deg); } }
+    /* While JS not ready: hide app, show overlay */
+    body.app-loading #q-app { visibility: hidden; }
+    body.app-loading #app-loading-overlay { display: flex; }
   </style>
-  <body>
+  <body class="app-loading">
+    <!-- App boot loading overlay: shown until JS initializes -->
+    <div id="app-loading-overlay" aria-busy="true" aria-live="polite">
+      <div class="spinner" aria-hidden="true"></div>
+      <div class="loading-text">Loading…</div>
+    </div>
     <div id="q-app">
       <q-layout view="hHh lpR fff">
         <q-header bordered class="bg-primary text-white">
@@ -75,7 +106,7 @@
             </div>
             <div class="col-auto" style="font-size: 16px">
               <q-option-group
-                style="margin-left: 140px"
+                style="margin-left: 80px"
                 v-model="state.showFields"
                 :options="state.fieldOptions"
                 @update:model-value="(val) => toggleShowField(val)"
@@ -410,7 +441,8 @@
         />
       </q-dialog>
     </div>
-
+    <script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
+    <script src="fastapi-voyager-static/quasar.min.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.3/jquery.min.js" integrity="sha512-egJ/Y+22P9NQ9aIyVCh0VCOsfydyn8eNmqBy+y2CnJG+fpRIxXMS6jbWP8tVKp0jp+NO5n8WtMUAnNnGoJKi4w==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
     <script
       src="https://cdnjs.cloudflare.com/ajax/libs/d3/7.9.0/d3.min.js"
@@ -422,15 +454,6 @@
     <script src="https://cdnjs.cloudflare.com/ajax/libs/d3-graphviz/5.6.0/d3-graphviz.min.js" integrity="sha512-Le8HpIpS2Tc7SDHLM6AOgAKq6ZR4uDwLhjPSR20DtXE5dFb9xECHRwgpc1nxxnU0Dv+j6FNMoSddky5gyvI3lQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-mousewheel/3.1.13/jquery.mousewheel.min.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-color/2.1.2/jquery.color.min.js"></script>
-
-    <!-- Add the following at the end of your body tag -->
-    <script
-      src="https://cdnjs.cloudflare.com/ajax/libs/vue/3.5.22/vue.global.prod.min.js"
-      integrity="sha512-Y9sKU0AwzWRxKSLd2i35LuDpUdHY/E9tJrKG0mxw0qYQ75VVgGYazIUQPwKhFK9vGO3jIgAtxLiSq8GQ7PDfUg=="
-      crossorigin="anonymous"
-      referrerpolicy="no-referrer"
-    ></script>
-    <script src="fastapi-voyager-static/quasar.min.js"></script>
     <script src="fastapi-voyager-static/graphviz.svg.js"></script>
     <!-- highlight.js minimal ES module load (python only) -->
     <link
@@ -438,10 +461,18 @@
       href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css"
     />
     <script type="module">
-      import hljs from "https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/es/highlight.min.js";
-      import python from "https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/es/languages/python.min.js";
-      hljs.registerLanguage("python", python);
-      window.hljs = hljs;
+      window.addEventListener('DOMContentLoaded', async () => {
+        if (!window.hljs) {
+          try {
+            const { default: hljs } = await import('https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/es/highlight.min.js');
+            const { default: python } = await import('https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/es/languages/python.min.js');
+            hljs.registerLanguage("python", python);
+            window.hljs = hljs;
+          } catch (e) {
+            console.warn("Failed to preload highlight.js", e);
+          }
+        }
+      });
     </script>
     <script type="module" src="fastapi-voyager-static/vue-main.js"></script>
   </body>

fastapi_voyager/web/vue-main.js

@@ -34,7 +34,7 @@ const app = createApp({
       detailDrawer: false,
       drawerWidth: 300, // drawer 宽度
       version: "", // version from backend
-      showModule: true
+      showModule: true,
     });
 
     const showDetail = ref(false);
@@ -82,6 +82,19 @@ const app = createApp({
         state.version = data.version || "";
         state.swaggerUrl = data.swagger_url || null
 
+        switch (data.initial_page_policy) {
+          case "full":
+            onGenerate()
+            return
+          case "empty":
+            return
+          case "first":
+            state.tag = state.rawTags.length > 0 ? state.rawTags[0].name : null;
+            state._tag = state.tag;
+            onGenerate();
+            return
+        }
+
         // default route options placeholder
       } catch (e) {
         console.error("Initial load failed", e);
@@ -226,6 +239,7 @@ const app = createApp({
 
     async function onReset() {
       state.tag = null;
+      state._tag = null;
       state.routeId = "";
       state.schemaId = null;
       // state.showFields = "object";
@@ -308,7 +322,9 @@ const app = createApp({
     }
 
     onMounted(async () => {
+      document.body.classList.remove("app-loading")
       await loadInitial();
+      // Reveal app content only after initial JS/data is ready
     });
 
     return {

{fastapi_voyager-0.11.5.dist-info → fastapi_voyager-0.11.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.11.5
+Version: 0.11.7
 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
@@ -183,6 +183,9 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
 - [ ] animation effect for edges
 - [ ] customrized right click panel
     - [ ] show own dependencies
+- [ ] sort field name
+- [ ] set max limit for fields
+- [ ] logging information
 
 ### plan:
 #### <0.9:
@@ -269,10 +272,10 @@ or you can open router_viz.dot with vscode extension `graphviz interactive previ
     - [x] optimize open in swagger link
     - [x] change jquery cdn
 - 0.11.6
-    - [ ] flag of loading full graph in first render or not
-    - [ ] logging information
-    - [ ] sort field name
-    - [ ] set max limit for fields
+    - [x] flag of loading full graph in first render or not
+    - [x] optimize loading static resource 
+- 0.11.7
+    - [x] fix swagger link
 
 #### 0.12
 - [ ] add tests

{fastapi_voyager-0.11.5.dist-info → fastapi_voyager-0.11.7.dist-info}/RECORD

@@ -3,18 +3,18 @@ fastapi_voyager/cli.py,sha256=kQb4g6JEGZR99e5r8LyFFEeb_-uT-n_gp_sDoYG3R7k,11118
 fastapi_voyager/filter.py,sha256=GY2J9Vfsf_wbFwC-0t74-Lf-OlO77PnhEXD_rmgkfSw,11574
 fastapi_voyager/module.py,sha256=Z2QHNmiLk6ZAJlm2nSmO875Q33TweSg8UxZSzIpU9zY,3499
 fastapi_voyager/render.py,sha256=vdwqIync2wsP8gMPY0v_XjRhdPBtbKyRT8yTBa_Ep3Y,8744
-fastapi_voyager/server.py,sha256=cRTUQik4rvrdZgfkFabCs6LBZnC1FVU4z3lwd1r8GNk,6839
+fastapi_voyager/server.py,sha256=upc38XFWr3UqAxbst-EAqf3_uaA9eS0Q_pzn3gE59jk,7143
 fastapi_voyager/type.py,sha256=VmcTB1G-LOT70EWCzi4LU_FUkSGWUIBJX15T_J5HnOo,1764
 fastapi_voyager/type_helper.py,sha256=QqP4c642vEkoWTZAtl_Vvt-kys3MkVDp4BNkLrw5mHQ,9477
-fastapi_voyager/version.py,sha256=jjZSCgkES3-8Fj88lWI3Bp418XjCkMi4KhC0Rc564i8,49
-fastapi_voyager/voyager.py,sha256=hNal25S5Hi_ZRe-gnmdUKt8tnRd-BRCrzaybAEJ_1HI,13498
+fastapi_voyager/version.py,sha256=FDsWNAszzeAI5uYptGQNcnHKwUJ5yQ8avSPu41kgadI,49
+fastapi_voyager/voyager.py,sha256=Ocj4gKK8S3QMBlJYUmqRzSEKjGLV1lBuNsljEKYLV5M,13673
 fastapi_voyager/web/graph-ui.js,sha256=DTedkpZNbtufexONVkJ8mOwF_-VnvxoReYHtox6IKR4,5842
 fastapi_voyager/web/graphviz.svg.css,sha256=zDCjjpT0Idufu5YOiZI76PL70-avP3vTyzGPh9M85Do,1563
 fastapi_voyager/web/graphviz.svg.js,sha256=lvAdbjHc-lMSk4GQp-iqYA2PCFX4RKnW7dFaoe0LUHs,16005
-fastapi_voyager/web/index.html,sha256=ys5zhYNO-smzb1_EgrQ3cWSbhzgMSpk32d1AupX6EP8,18293
+fastapi_voyager/web/index.html,sha256=FJtx1_SiNq7tTMRXMKIx7zMInhEMCusw6VFTYBPtpak,19444
 fastapi_voyager/web/quasar.min.css,sha256=F5jQe7X2XT54VlvAaa2V3GsBFdVD-vxDZeaPLf6U9CU,203145
 fastapi_voyager/web/quasar.min.js,sha256=h0ftyPMW_CRiyzeVfQqiup0vrVt4_QWojpqmpnpn07E,502974
-fastapi_voyager/web/vue-main.js,sha256=sUjLmn06jYy1guwxAcouHwkcjxGD2UgZgkiiIEDbk04,10663
+fastapi_voyager/web/vue-main.js,sha256=D1H6UhwAlQta73shjZLmQAKbss7X2Y471fjC1H58p9g,11156
 fastapi_voyager/web/component/render-graph.js,sha256=e8Xgh2Kl-nYU0P1gstEmAepCgFnk2J6UdxW8TlMafGs,2322
 fastapi_voyager/web/component/route-code-display.js,sha256=8NJPPjNRUC21gjpY8XYEQs4RBbhX1pCiqEhJp39ku6k,3678
 fastapi_voyager/web/component/schema-code-display.js,sha256=FjoD3CLl967VMfbZNQMdbiEnS0z-doLJDJIeDCmKGew,6983
@@ -26,8 +26,8 @@ fastapi_voyager/web/icon/favicon-16x16.png,sha256=JC07jEzfIYxBIoQn_FHXvyHuxESdhW
 fastapi_voyager/web/icon/favicon-32x32.png,sha256=C7v1h58cfWOsiLp9yOIZtlx-dLasBcq3NqpHVGRmpt4,1859
 fastapi_voyager/web/icon/favicon.ico,sha256=tZolYIXkkBcFiYl1A8ksaXN2VjGamzcSdes838dLvNc,15406
 fastapi_voyager/web/icon/site.webmanifest,sha256=ep4Hzh9zhmiZF2At3Fp1dQrYQuYF_3ZPZxc1KcGBvwQ,263
-fastapi_voyager-0.11.5.dist-info/METADATA,sha256=-9xjzPJFY0WqW_SM9AGHLHI6tRrE3sqsy8iiKThQmvM,9712
-fastapi_voyager-0.11.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_voyager-0.11.5.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
-fastapi_voyager-0.11.5.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
-fastapi_voyager-0.11.5.dist-info/RECORD,,
+fastapi_voyager-0.11.7.dist-info/METADATA,sha256=M0F4nnUPt_wY5cot9IIf_fpFieR80iMDwN8nBmwblfk,9780
+fastapi_voyager-0.11.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_voyager-0.11.7.dist-info/entry_points.txt,sha256=pEIKoUnIDXEtdMBq8EmXm70m16vELIu1VPz9-TBUFWM,53
+fastapi_voyager-0.11.7.dist-info/licenses/LICENSE,sha256=lNVRR3y_bFVoFKuK2JM8N4sFaj3m-7j29kvL3olFi5Y,1067
+fastapi_voyager-0.11.7.dist-info/RECORD,,