litestar-vite-plugin 0.15.0-alpha.2 → 0.15.0-alpha.4

package/dist/js/sveltekit.js

@@ -3,43 +3,79 @@ import fs from "node:fs";
 import path from "node:path";
 import { promisify } from "node:util";
 import colors from "picocolors";
-import { resolveInstallHint } from "./install-hint.js";
+import { resolveInstallHint, resolvePackageExecutor } from "./install-hint.js";
+import { debounce } from "./shared/debounce.js";
 const execAsync = promisify(exec);
 function resolveConfig(config = {}) {
+  const runtimeConfigPath = process.env.LITESTAR_VITE_CONFIG_PATH;
+  let hotFile;
+  let proxyMode = "vite";
+  let port;
+  let pythonTypesConfig;
+  const envPort = process.env.VITE_PORT;
+  if (envPort) {
+    port = Number.parseInt(envPort, 10);
+    if (Number.isNaN(port)) {
+      port = void 0;
+    }
+  }
+  let pythonExecutor;
+  if (runtimeConfigPath && fs.existsSync(runtimeConfigPath)) {
+    try {
+      const json = JSON.parse(fs.readFileSync(runtimeConfigPath, "utf-8"));
+      const bundleDir = json.bundleDir ?? "public";
+      const hot = json.hotFile ?? "hot";
+      hotFile = path.resolve(process.cwd(), bundleDir, hot);
+      proxyMode = json.proxyMode ?? "vite";
+      if (json.port !== void 0) {
+        port = json.port;
+      }
+      pythonExecutor = json.executor;
+      if (json.types) {
+        pythonTypesConfig = json.types;
+      }
+    } catch {
+      hotFile = void 0;
+    }
+  }
   let typesConfig = false;
   if (config.types === true) {
     typesConfig = {
       enabled: true,
-      output: "src/lib/api",
-      openapiPath: "openapi.json",
-      routesPath: "routes.json",
-      generateZod: false,
+      output: pythonTypesConfig?.output ?? "src/lib/api",
+      openapiPath: pythonTypesConfig?.openapiPath ?? "openapi.json",
+      routesPath: pythonTypesConfig?.routesPath ?? "routes.json",
+      generateZod: pythonTypesConfig?.generateZod ?? false,
       debounce: 300
     };
   } else if (typeof config.types === "object" && config.types !== null) {
     typesConfig = {
       enabled: config.types.enabled ?? true,
-      output: config.types.output ?? "src/lib/api",
-      openapiPath: config.types.openapiPath ?? "openapi.json",
-      routesPath: config.types.routesPath ?? "routes.json",
-      generateZod: config.types.generateZod ?? false,
+      output: config.types.output ?? pythonTypesConfig?.output ?? "src/lib/api",
+      openapiPath: config.types.openapiPath ?? pythonTypesConfig?.openapiPath ?? "openapi.json",
+      routesPath: config.types.routesPath ?? pythonTypesConfig?.routesPath ?? "routes.json",
+      generateZod: config.types.generateZod ?? pythonTypesConfig?.generateZod ?? false,
       debounce: config.types.debounce ?? 300
     };
+  } else if (config.types !== false && pythonTypesConfig?.enabled) {
+    typesConfig = {
+      enabled: true,
+      output: pythonTypesConfig.output ?? "src/lib/api",
+      openapiPath: pythonTypesConfig.openapiPath ?? "openapi.json",
+      routesPath: pythonTypesConfig.routesPath ?? "routes.json",
+      generateZod: pythonTypesConfig.generateZod ?? false,
+      debounce: 300
+    };
   }
   return {
     apiProxy: config.apiProxy ?? "http://localhost:8000",
     apiPrefix: config.apiPrefix ?? "/api",
     types: typesConfig,
-    verbose: config.verbose ?? false
-  };
-}
-function debounce(func, wait) {
-  let timeout = null;
-  return (...args) => {
-    if (timeout) {
-      clearTimeout(timeout);
-    }
-    timeout = setTimeout(() => func(...args), wait);
+    verbose: config.verbose ?? false,
+    hotFile,
+    proxyMode,
+    port,
+    executor: config.executor ?? pythonExecutor
   };
 }
 function litestarSvelteKit(userConfig = {}) {
@@ -51,6 +87,12 @@ function litestarSvelteKit(userConfig = {}) {
     config() {
       return {
         server: {
+          // Set the port from Python config/env to ensure SvelteKit uses the expected port
+          // strictPort: true prevents SvelteKit from auto-incrementing to a different port
+          ...config.port !== void 0 ? {
+            port: config.port,
+            strictPort: true
+          } : {},
           proxy: {
             [config.apiPrefix]: {
               target: config.apiProxy,
@@ -70,6 +112,26 @@ function litestarSvelteKit(userConfig = {}) {
           next();
         });
       }
+      if (config.hotFile) {
+        const hotFile = config.hotFile;
+        server.httpServer?.once("listening", () => {
+          const address = server.httpServer?.address();
+          if (address && typeof address === "object" && "port" in address) {
+            let host = address.address;
+            if (host === "::" || host === "::1") {
+              host = "localhost";
+            } else if (host.includes(":")) {
+              host = `[${host}]`;
+            }
+            const url = `http://${host}:${address.port}`;
+            fs.mkdirSync(path.dirname(hotFile), { recursive: true });
+            fs.writeFileSync(hotFile, url);
+            if (config.verbose) {
+              console.log(colors.cyan("[litestar-sveltekit]"), colors.dim(`Hotfile written: ${hotFile} -> ${url}`));
+            }
+          }
+        });
+      }
       server.httpServer?.once("listening", () => {
         setTimeout(() => {
           console.log("");
@@ -87,11 +149,136 @@ function litestarSvelteKit(userConfig = {}) {
     }
   });
   if (config.types !== false && config.types.enabled) {
-    plugins.push(createTypeGenerationPlugin(config.types));
+    plugins.push(createTypeGenerationPlugin(config.types, config.executor));
   }
   return plugins;
 }
-function createTypeGenerationPlugin(typesConfig) {
+async function emitRouteTypes(routesPath, outputDir) {
+  const contents = await fs.promises.readFile(routesPath, "utf-8");
+  const json = JSON.parse(contents);
+  const outDir = path.resolve(process.cwd(), outputDir);
+  await fs.promises.mkdir(outDir, { recursive: true });
+  const outFile = path.join(outDir, "routes.ts");
+  const banner = `// AUTO-GENERATED by litestar-vite. Do not edit.
+/* eslint-disable */
+
+`;
+  const routesData = json.routes || json;
+  const routeNames = Object.keys(routesData);
+  const routeNameType = routeNames.length > 0 ? routeNames.map((n) => `"${n}"`).join(" | ") : "never";
+  const routeParamTypes = [];
+  for (const [name, data] of Object.entries(routesData)) {
+    const routeData = data;
+    if (routeData.parameters && routeData.parameters.length > 0) {
+      const params = routeData.parameters.map((p) => `${p}: string | number`).join("; ");
+      routeParamTypes.push(`  "${name}": { ${params} }`);
+    } else {
+      routeParamTypes.push(`  "${name}": Record<string, never>`);
+    }
+  }
+  const body = `/**
+ * AUTO-GENERATED by litestar-vite.
+ *
+ * Exports:
+ * - routesMeta: full route metadata
+ * - routes: name -> uri map
+ * - serverRoutes: alias of routes for clarity in apps
+ * - route(): type-safe URL generator
+ * - hasRoute(): type guard
+ * - csrf helpers re-exported from litestar-vite-plugin/helpers
+ *
+ * @see https://litestar-vite.litestar.dev/
+ */
+export const routesMeta = ${JSON.stringify(json, null, 2)} as const
+
+/**
+ * Route name to URI mapping.
+ */
+export const routes = ${JSON.stringify(Object.fromEntries(Object.entries(routesData).map(([name, data]) => [name, data.uri])), null, 2)} as const
+
+/**
+ * Alias for server-injected route map (more descriptive for consumers).
+ */
+export const serverRoutes = routes
+
+/**
+ * All available route names.
+ */
+export type RouteName = ${routeNameType}
+
+/**
+ * Parameter types for each route.
+ */
+export interface RouteParams {
+${routeParamTypes.join("\n")}
+}
+
+/**
+ * Generate a URL for a named route with type-safe parameters.
+ *
+ * @param name - The route name
+ * @param params - Route parameters (required if route has path parameters)
+ * @returns The generated URL
+ *
+ * @example
+ * \`\`\`ts
+ * import { route } from '@/generated/routes'
+ *
+ * // Route without parameters
+ * route('home')  // "/"
+ *
+ * // Route with parameters
+ * route('user:detail', { user_id: 123 })  // "/users/123"
+ * \`\`\`
+ */
+export function route<T extends RouteName>(
+  name: T,
+  ...args: RouteParams[T] extends Record<string, never> ? [] : [params: RouteParams[T]]
+): string {
+  let uri = routes[name] as string
+  const params = args[0] as Record<string, string | number> | undefined
+
+  if (params) {
+    for (const [key, value] of Object.entries(params)) {
+      // Handle both {param} and {param:type} syntax
+      uri = uri.replace(new RegExp(\`\\\\{\${key}(?::[^}]+)?\\\\}\`, "g"), String(value))
+    }
+  }
+
+  return uri
+}
+
+/**
+ * Check if a route name exists.
+ */
+export function hasRoute(name: string): name is RouteName {
+  return name in routes
+}
+
+declare global {
+  interface Window {
+    /**
+     * Fully-typed route metadata injected by Litestar.
+     */
+    __LITESTAR_ROUTES__?: typeof routesMeta
+    /**
+     * Simple route map (name -> uri) for legacy consumers.
+     */
+    routes?: typeof routes
+    serverRoutes?: typeof serverRoutes
+  }
+  // eslint-disable-next-line no-var
+  var routes: typeof routes | undefined
+  var serverRoutes: typeof serverRoutes | undefined
+}
+
+// Re-export helper functions from litestar-vite-plugin
+// These work with the routes defined above
+export { getCsrfToken, csrfHeaders, csrfFetch } from "litestar-vite-plugin/helpers"
+`;
+  await fs.promises.writeFile(outFile, `${banner}${body}`, "utf-8");
+}
+function createTypeGenerationPlugin(typesConfig, executor) {
   let server = null;
   let isGenerating = false;
   async function runTypeGeneration() {
@@ -109,11 +296,15 @@ function createTypeGenerationPlugin(typesConfig) {
       console.log(colors.cyan("[litestar-sveltekit]"), colors.dim("Generating TypeScript types..."));
       const args = ["@hey-api/openapi-ts", "-i", typesConfig.openapiPath, "-o", typesConfig.output];
       if (typesConfig.generateZod) {
-        args.push("--plugins", "@hey-api/schemas", "@hey-api/types");
+        args.push("--plugins", "zod", "@hey-api/typescript");
       }
-      await execAsync(`npx ${args.join(" ")}`, {
+      await execAsync(resolvePackageExecutor(args.join(" "), executor), {
         cwd: process.cwd()
       });
+      const routesPath = path.resolve(process.cwd(), typesConfig.routesPath);
+      if (fs.existsSync(routesPath)) {
+        await emitRouteTypes(routesPath, typesConfig.output);
+      }
       const duration = Date.now() - startTime;
       console.log(colors.cyan("[litestar-sveltekit]"), colors.green("Types generated"), colors.dim(`in ${duration}ms`));
       if (server) {

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "litestar-vite-plugin",
-  "version": "0.15.0-alpha.2",
+  "version": "0.15.0-alpha.4",
   "type": "module",
   "description": "Litestar plugin for Vite.",
-  "keywords": ["litestar", "vite", "vite-plugin"],
+  "keywords": [
+    "litestar",
+    "vite",
+    "vite-plugin"
+  ],
   "homepage": "https://github.com/litestar-org/litestar-vite",
   "repository": {
     "type": "git",
@@ -40,7 +44,10 @@
     }
   },
   "types": "./dist/js/index.d.ts",
-  "files": ["dist/js/**/*", "tools/clean.js"],
+  "files": [
+    "dist/js/**/*",
+    "tools/clean.js"
+  ],
   "bin": {
     "clean-orphaned-assets": "tools/clean.js"
   },
@@ -48,7 +55,7 @@
     "build": "npm run build-plugin && npm run build-helpers && npm run build-inertia-helpers && npm run build-integrations",
     "build-plugin": "rm -rf dist/js && npm run build-plugin-types && npm run build-plugin-esm && cp src/js/src/dev-server-index.html dist/js/",
     "build-plugin-types": "tsc --project src/js/tsconfig.json --emitDeclarationOnly",
-    "build-plugin-esm": "esbuild src/js/src/index.ts --platform=node --format=esm --outfile=dist/js/index.js && esbuild src/js/src/install-hint.ts --platform=node --format=esm --outfile=dist/js/install-hint.js && esbuild src/js/src/litestar-meta.ts --platform=node --format=esm --outfile=dist/js/litestar-meta.js",
+    "build-plugin-esm": "esbuild src/js/src/index.ts --platform=node --format=esm --outfile=dist/js/index.js && esbuild src/js/src/install-hint.ts --platform=node --format=esm --outfile=dist/js/install-hint.js && esbuild src/js/src/litestar-meta.ts --platform=node --format=esm --outfile=dist/js/litestar-meta.js && mkdir -p dist/js/shared && esbuild src/js/src/shared/debounce.ts --platform=node --format=esm --outfile=dist/js/shared/debounce.js",
     "build-helpers": "rm -rf dist/js/helpers && tsc --project src/js/tsconfig.helpers.json",
     "build-inertia-helpers": "rm -rf dist/js/inertia-helpers && tsc --project src/js/tsconfig.inertia-helpers.json",
     "build-integrations": "esbuild src/js/src/astro.ts src/js/src/sveltekit.ts src/js/src/nuxt.ts --platform=node --format=esm --outdir=dist/js",
@@ -56,8 +63,9 @@
     "test": "vitest --config ./src/js/vitest.config.ts run"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
+    "@biomejs/biome": "2.0.6",
     "@types/node": "^22.15.3",
+    "@vitest/coverage-v8": "^3.2.4",
     "esbuild": "0.25.3",
     "happy-dom": "^20.0.2",
     "typescript": "^5.8.3",
@@ -65,7 +73,7 @@
     "vitest": "^3.1.2"
   },
   "peerDependencies": {
-    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0"
+    "vite": "^6.0.0 || ^7.0.0"
   },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"

package/tools/clean.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { existsSync, readFileSync, readdirSync, unlinkSync } from "node:fs"
+import { existsSync, readdirSync, readFileSync, unlinkSync } from "node:fs"
 import { dirname } from "node:path"
 
 /*

package/dist/js/inertia-helpers/helpers/csrf.d.ts

@@ -1,76 +0,0 @@
-/**
- * CSRF token utilities for Litestar applications.
- *
- * The CSRF token is injected into the page by Litestar in one of these ways:
- * 1. window.__LITESTAR_CSRF__ (SPA mode)
- * 2. <meta name="csrf-token" content="..."> (template mode)
- * 3. Inertia shared props (Inertia mode)
- *
- * @module
- */
-declare global {
-    interface Window {
-        __LITESTAR_CSRF__?: string;
-    }
-}
-/**
- * Get the CSRF token from the page.
- *
- * Checks multiple sources in order:
- * 1. window.__LITESTAR_CSRF__ (injected by SPA handler)
- * 2. <meta name="csrf-token"> element
- * 3. Inertia page props (if Inertia is present)
- *
- * @returns The CSRF token or empty string if not found
- *
- * @example
- * ```ts
- * import { getCsrfToken } from 'litestar-vite-plugin/helpers'
- *
- * fetch('/api/submit', {
- *   method: 'POST',
- *   headers: {
- *     'X-CSRF-Token': getCsrfToken(),
- *   },
- *   body: JSON.stringify(data),
- * })
- * ```
- */
-export declare function getCsrfToken(): string;
-/**
- * Create headers object with CSRF token included.
- *
- * @param additionalHeaders - Additional headers to include
- * @returns Headers object with X-CSRF-Token set
- *
- * @example
- * ```ts
- * import { csrfHeaders } from 'litestar-vite-plugin/helpers'
- *
- * fetch('/api/submit', {
- *   method: 'POST',
- *   headers: csrfHeaders({ 'Content-Type': 'application/json' }),
- *   body: JSON.stringify(data),
- * })
- * ```
- */
-export declare function csrfHeaders(additionalHeaders?: Record<string, string>): Record<string, string>;
-/**
- * Create a fetch wrapper that automatically includes CSRF token.
- *
- * @param input - Request URL or Request object
- * @param init - Request options
- * @returns Fetch response promise
- *
- * @example
- * ```ts
- * import { csrfFetch } from 'litestar-vite-plugin/helpers'
- *
- * // Automatically includes CSRF token
- * csrfFetch('/api/submit', {
- *   method: 'POST',
- *   body: JSON.stringify(data),
- * })
- * ```
- */
-export declare function csrfFetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;

package/dist/js/inertia-helpers/helpers/csrf.js

@@ -1,114 +0,0 @@
-/**
- * CSRF token utilities for Litestar applications.
- *
- * The CSRF token is injected into the page by Litestar in one of these ways:
- * 1. window.__LITESTAR_CSRF__ (SPA mode)
- * 2. <meta name="csrf-token" content="..."> (template mode)
- * 3. Inertia shared props (Inertia mode)
- *
- * @module
- */
-/**
- * Get the CSRF token from the page.
- *
- * Checks multiple sources in order:
- * 1. window.__LITESTAR_CSRF__ (injected by SPA handler)
- * 2. <meta name="csrf-token"> element
- * 3. Inertia page props (if Inertia is present)
- *
- * @returns The CSRF token or empty string if not found
- *
- * @example
- * ```ts
- * import { getCsrfToken } from 'litestar-vite-plugin/helpers'
- *
- * fetch('/api/submit', {
- *   method: 'POST',
- *   headers: {
- *     'X-CSRF-Token': getCsrfToken(),
- *   },
- *   body: JSON.stringify(data),
- * })
- * ```
- */
-export function getCsrfToken() {
-    // Check window global (SPA mode)
-    if (typeof window !== "undefined" && window.__LITESTAR_CSRF__) {
-        return window.__LITESTAR_CSRF__;
-    }
-    // Check meta tag (template mode)
-    if (typeof document !== "undefined") {
-        const meta = document.querySelector('meta[name="csrf-token"]');
-        if (meta) {
-            return meta.getAttribute("content") || "";
-        }
-    }
-    // Check Inertia page props
-    if (typeof window !== "undefined") {
-        const win = window;
-        const inertiaPage = win.__INERTIA_PAGE__;
-        if (inertiaPage?.props) {
-            const props = inertiaPage.props;
-            if (typeof props.csrf_token === "string") {
-                return props.csrf_token;
-            }
-        }
-    }
-    return "";
-}
-/**
- * Create headers object with CSRF token included.
- *
- * @param additionalHeaders - Additional headers to include
- * @returns Headers object with X-CSRF-Token set
- *
- * @example
- * ```ts
- * import { csrfHeaders } from 'litestar-vite-plugin/helpers'
- *
- * fetch('/api/submit', {
- *   method: 'POST',
- *   headers: csrfHeaders({ 'Content-Type': 'application/json' }),
- *   body: JSON.stringify(data),
- * })
- * ```
- */
-export function csrfHeaders(additionalHeaders = {}) {
-    const token = getCsrfToken();
-    return {
-        ...additionalHeaders,
-        ...(token ? { "X-CSRF-Token": token } : {}),
-    };
-}
-/**
- * Create a fetch wrapper that automatically includes CSRF token.
- *
- * @param input - Request URL or Request object
- * @param init - Request options
- * @returns Fetch response promise
- *
- * @example
- * ```ts
- * import { csrfFetch } from 'litestar-vite-plugin/helpers'
- *
- * // Automatically includes CSRF token
- * csrfFetch('/api/submit', {
- *   method: 'POST',
- *   body: JSON.stringify(data),
- * })
- * ```
- */
-export function csrfFetch(input, init) {
-    const token = getCsrfToken();
-    if (!token) {
-        return fetch(input, init);
-    }
-    const headers = new Headers(init?.headers);
-    if (!headers.has("X-CSRF-Token")) {
-        headers.set("X-CSRF-Token", token);
-    }
-    return fetch(input, {
-        ...init,
-        headers,
-    });
-}

package/dist/js/inertia-helpers/helpers/index.d.ts

@@ -1,24 +0,0 @@
-/**
- * Litestar Vite Helpers
- *
- * Utilities for working with Litestar applications from the frontend.
- * These helpers work in both SPA and template modes.
- *
- * @example
- * ```ts
- * import { route, getCsrfToken, csrfFetch } from 'litestar-vite-plugin/helpers'
- *
- * // Generate a URL for a named route
- * const url = route('user:detail', { user_id: 123 })
- *
- * // Make a fetch request with CSRF token
- * await csrfFetch('/api/submit', {
- *   method: 'POST',
- *   body: JSON.stringify(data),
- * })
- * ```
- *
- * @module
- */
-export { getCsrfToken, csrfHeaders, csrfFetch } from "./csrf.js";
-export { route, getRoutes, toRoute, currentRoute, isRoute, isCurrentRoute, getRelativeUrlPath, type RouteDefinition, type RoutesMap, } from "./routes.js";

package/dist/js/inertia-helpers/helpers/index.js

@@ -1,26 +0,0 @@
-/**
- * Litestar Vite Helpers
- *
- * Utilities for working with Litestar applications from the frontend.
- * These helpers work in both SPA and template modes.
- *
- * @example
- * ```ts
- * import { route, getCsrfToken, csrfFetch } from 'litestar-vite-plugin/helpers'
- *
- * // Generate a URL for a named route
- * const url = route('user:detail', { user_id: 123 })
- *
- * // Make a fetch request with CSRF token
- * await csrfFetch('/api/submit', {
- *   method: 'POST',
- *   body: JSON.stringify(data),
- * })
- * ```
- *
- * @module
- */
-// CSRF utilities
-export { getCsrfToken, csrfHeaders, csrfFetch } from "./csrf.js";
-// Route utilities
-export { route, getRoutes, toRoute, currentRoute, isRoute, isCurrentRoute, getRelativeUrlPath, } from "./routes.js";