litestar-vite 0.8.3__tar.gz → 0.10.0__tar.gz

{litestar_vite-0.8.3 → litestar_vite-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: litestar-vite
-Version: 0.8.3
+Version: 0.10.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -53,6 +53,8 @@ from pathlib import Path
 from litestar import Controller, get, Litestar
 from litestar.response import Template
 from litestar.status_codes import HTTP_200_OK
+from litestar.template.config import TemplateConfig
+from litestar.contrib.jinja import JinjaTemplateEngine
 from litestar_vite import ViteConfig, VitePlugin
 
 class WebController(Controller):
@@ -64,9 +66,9 @@ class WebController(Controller):
     async def index(self) -> Template:
         return Template(template_name="index.html.j2")
 
-
-vite = VitePlugin(config=ViteConfig(template_dir='templates/'))
-app = Litestar(plugins=[vite], route_handlers=[WebController])
+template_config = TemplateConfig(engine=JinjaTemplateEngine(directory='templates/'))
+vite = VitePlugin(config=ViteConfig())
+app = Litestar(plugins=[vite], template_config=template_config, route_handlers=[WebController])
 
 ```
 

{litestar_vite-0.8.3 → litestar_vite-0.10.0}/README.md

@@ -18,6 +18,8 @@ from pathlib import Path
 from litestar import Controller, get, Litestar
 from litestar.response import Template
 from litestar.status_codes import HTTP_200_OK
+from litestar.template.config import TemplateConfig
+from litestar.contrib.jinja import JinjaTemplateEngine
 from litestar_vite import ViteConfig, VitePlugin
 
 class WebController(Controller):
@@ -29,9 +31,9 @@ class WebController(Controller):
     async def index(self) -> Template:
         return Template(template_name="index.html.j2")
 
-
-vite = VitePlugin(config=ViteConfig(template_dir='templates/'))
-app = Litestar(plugins=[vite], route_handlers=[WebController])
+template_config = TemplateConfig(engine=JinjaTemplateEngine(directory='templates/'))
+vite = VitePlugin(config=ViteConfig())
+app = Litestar(plugins=[vite], template_config=template_config, route_handlers=[WebController])
 
 ```
 

{litestar_vite-0.8.3 → litestar_vite-0.10.0}/pyproject.toml

@@ -25,7 +25,7 @@ license = { text = "MIT" }
 name = "litestar-vite"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.8.3"
+version = "0.10.0"
 
 [project.urls]
 Changelog = "https://cofin.github.io/litestar-vite/latest/changelog"
@@ -85,7 +85,7 @@ test = [
 allow_dirty = true
 commit = true
 commit_args = "--no-verify"
-current_version = "0.8.3"
+current_version = "0.10.0"
 ignore_missing_files = false
 ignore_missing_version = false
 message = "chore(release): bump to v{new_version}"
@@ -267,6 +267,8 @@ lint.select = ["ALL"]
 lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 src = ["src/py/litestar_vite", "src/py/tests"]
 target-version = "py38"
+unsafe-fixes = true
+
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

{litestar_vite-0.8.3 → litestar_vite-0.10.0}/src/js/src/index.ts

@@ -63,6 +63,12 @@ interface PluginConfig {
    * @default null
    */
   detectTls?: string | boolean | null
+  /**
+   * Automatically detect the index.html file.
+   *
+   * @default true
+   */
+  autoDetectIndex?: boolean
   /**
    * Transform the code while serving.
    */
@@ -82,7 +88,7 @@ type DevServerUrl = `${"http" | "https"}://${string}:${number}`
 
 let exitHandlersBound = false
 
-export const refreshPaths = ["**/*.py", "**/*.j2", "**/*.html.j2", "**/*.html", "**/assets/**/*"]
+export const refreshPaths = ["src/**", "resources/**", "assets/**"].filter((path) => fs.existsSync(path.replace(/\*\*$/, "")))
 
 /**
  * Litestar plugin for Vite.
@@ -184,10 +190,30 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
       }
       return undefined
     },
-    configureServer(server) {
+    async configureServer(server) {
       const envDir = resolvedConfig.envDir || process.cwd()
       const appUrl = loadEnv(resolvedConfig.mode, envDir, "APP_URL").APP_URL ?? "undefined"
 
+      // Check if we should serve SPA directly
+      const shouldServeIndex = () => {
+        if (!pluginConfig.autoDetectIndex) return false
+
+        // Check various common locations for index.html
+        const possiblePaths = [
+          path.join(server.config.root, "index.html"),
+          path.join(server.config.root, pluginConfig.resourceDirectory, "index.html"),
+          path.join(server.config.root, "public", "index.html"),
+        ]
+
+        for (const indexPath of possiblePaths) {
+          try {
+            fs.accessSync(indexPath)
+            return true
+          } catch {}
+        }
+        return false
+      }
+
       server.httpServer?.once("listening", () => {
         const address = server.httpServer?.address()
 
@@ -197,14 +223,23 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
           fs.mkdirSync(path.dirname(pluginConfig.hotFile), { recursive: true })
           fs.writeFileSync(pluginConfig.hotFile, viteDevServerUrl)
 
+          const hasIndex = shouldServeIndex()
+
           setTimeout(() => {
             server.config.logger.info(`\n  ${colors.red(`${colors.bold("LITESTAR")} ${litestarVersion()}`)}  ${colors.dim("plugin")} ${colors.bold(`v${pluginVersion()}`)}`)
             server.config.logger.info("")
-            server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
+            if (hasIndex) {
+              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("Serve Index")}: Serving application index with Vite`)
+              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("DEV URL")}: ${colors.cyan(viteDevServerUrl)}`)
+              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
+            } else {
+              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("Serve Index")}: Serving Litestar index with Vite`)
+              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("DEV URL")}: ${colors.cyan(viteDevServerUrl)}`)
+              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
+            }
           }, 100)
         }
       })
-
       if (!exitHandlersBound) {
         const clean = () => {
           if (fs.existsSync(pluginConfig.hotFile)) {
@@ -222,7 +257,7 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
 
       return () =>
         server.middlewares.use((req, res, next) => {
-          if (req.url === "/index.html") {
+          if (!shouldServeIndex() && req.url === "/index.html") {
             res.statusCode = 404
 
             res.end(
@@ -325,6 +360,7 @@ function resolvePluginConfig(config: string | string[] | PluginConfig): Required
     refresh: resolvedConfig.refresh ?? false,
     hotFile: resolvedConfig.hotFile ?? path.join(resolvedConfig.bundleDirectory ?? "public", "hot"),
     detectTls: resolvedConfig.detectTls ?? false,
+    autoDetectIndex: resolvedConfig.autoDetectIndex ?? true,
     transformOnServe: resolvedConfig.transformOnServe ?? ((code) => code),
   }
 }

{litestar_vite-0.8.3 → litestar_vite-0.10.0}/src/js/src/inertia-helpers/index.ts

@@ -125,8 +125,9 @@ export function isRoute(url: string, routeName: string): boolean {
     const regexPattern = routePattern.replace(/\//g, "\\/").replace(/\{([^}]+):([^}]+)\}/g, (match, paramName, paramType) => {
       switch (paramType) {
         case "str":
-        case "path":
           return "([^/]+)"
+        case "path":
+          return "(.*)"
         case "uuid":
           return "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
         default: