litestar-vite-plugin 0.15.0-alpha.3 → 0.15.0-alpha.5

package/dist/js/sveltekit.d.ts

@@ -66,6 +66,12 @@ export interface SvelteKitTypesConfig {
      * @default false
      */
     generateZod?: boolean;
+    /**
+     * Generate SDK client functions for API calls.
+     *
+     * @default true
+     */
+    generateSdk?: boolean;
     /**
      * Debounce time in milliseconds for type regeneration.
      *

package/dist/js/sveltekit.js

@@ -46,6 +46,7 @@ function resolveConfig(config = {}) {
       openapiPath: pythonTypesConfig?.openapiPath ?? "openapi.json",
       routesPath: pythonTypesConfig?.routesPath ?? "routes.json",
       generateZod: pythonTypesConfig?.generateZod ?? false,
+      generateSdk: pythonTypesConfig?.generateSdk ?? true,
       debounce: 300
     };
   } else if (typeof config.types === "object" && config.types !== null) {
@@ -55,6 +56,7 @@ function resolveConfig(config = {}) {
       openapiPath: config.types.openapiPath ?? pythonTypesConfig?.openapiPath ?? "openapi.json",
       routesPath: config.types.routesPath ?? pythonTypesConfig?.routesPath ?? "routes.json",
       generateZod: config.types.generateZod ?? pythonTypesConfig?.generateZod ?? false,
+      generateSdk: config.types.generateSdk ?? pythonTypesConfig?.generateSdk ?? true,
       debounce: config.types.debounce ?? 300
     };
   } else if (config.types !== false && pythonTypesConfig?.enabled) {
@@ -64,6 +66,7 @@ function resolveConfig(config = {}) {
       openapiPath: pythonTypesConfig.openapiPath ?? "openapi.json",
       routesPath: pythonTypesConfig.routesPath ?? "routes.json",
       generateZod: pythonTypesConfig.generateZod ?? false,
+      generateSdk: pythonTypesConfig.generateSdk ?? true,
       debounce: 300
     };
   }
@@ -87,6 +90,9 @@ function litestarSvelteKit(userConfig = {}) {
     config() {
       return {
         server: {
+          // Force IPv4 binding for consistency with Python proxy configuration
+          // Without this, SvelteKit might bind to IPv6 localhost which the proxy can't reach
+          host: "127.0.0.1",
           // 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 ? {
@@ -294,12 +300,28 @@ function createTypeGenerationPlugin(typesConfig, executor) {
         return false;
       }
       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", "zod", "@hey-api/typescript");
+      const projectRoot = process.cwd();
+      const candidates = [path.resolve(projectRoot, "openapi-ts.config.ts"), path.resolve(projectRoot, "hey-api.config.ts"), path.resolve(projectRoot, ".hey-api.config.ts")];
+      const configPath = candidates.find((p) => fs.existsSync(p)) || null;
+      let args;
+      if (configPath) {
+        console.log(colors.cyan("[litestar-sveltekit]"), colors.dim("Using config:"), configPath);
+        args = ["@hey-api/openapi-ts", "--file", configPath];
+      } else {
+        args = ["@hey-api/openapi-ts", "-i", typesConfig.openapiPath, "-o", typesConfig.output];
+        const plugins = ["@hey-api/typescript", "@hey-api/schemas"];
+        if (typesConfig.generateSdk) {
+          plugins.push("@hey-api/sdk", "@hey-api/client-fetch");
+        }
+        if (typesConfig.generateZod) {
+          plugins.push("zod");
+        }
+        if (plugins.length) {
+          args.push("--plugins", ...plugins);
+        }
       }
       await execAsync(resolvePackageExecutor(args.join(" "), executor), {
-        cwd: process.cwd()
+        cwd: projectRoot
       });
       const routesPath = path.resolve(process.cwd(), typesConfig.routesPath);
       if (fs.existsSync(routesPath)) {
@@ -338,6 +360,14 @@ function createTypeGenerationPlugin(typesConfig, executor) {
       server = devServer;
       console.log(colors.cyan("[litestar-sveltekit]"), colors.dim("Watching for schema changes:"), colors.yellow(typesConfig.openapiPath));
     },
+    async buildStart() {
+      if (typesConfig.enabled) {
+        const openapiPath = path.resolve(process.cwd(), typesConfig.openapiPath);
+        if (fs.existsSync(openapiPath)) {
+          await runTypeGeneration();
+        }
+      }
+    },
     handleHotUpdate({ file }) {
       if (!typesConfig.enabled) {
         return;

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "litestar-vite-plugin",
-  "version": "0.15.0-alpha.3",
+  "version": "0.15.0-alpha.5",
   "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",
@@ -14,33 +18,36 @@
   "exports": {
     ".": {
       "types": "./dist/js/index.d.ts",
-      "default": "./dist/js/index.js"
+      "import": "./dist/js/index.js"
     },
     "./helpers": {
       "types": "./dist/js/helpers/index.d.ts",
-      "default": "./dist/js/helpers/index.js"
+      "import": "./dist/js/helpers/index.js"
     },
     "./install-hint": "./dist/js/install-hint.js",
     "./litestar-meta": "./dist/js/litestar-meta.js",
     "./inertia-helpers": {
       "types": "./dist/js/inertia-helpers/index.d.ts",
-      "default": "./dist/js/inertia-helpers/index.js"
+      "import": "./dist/js/inertia-helpers/index.js"
     },
     "./astro": {
       "types": "./dist/js/astro.d.ts",
-      "default": "./dist/js/astro.js"
+      "import": "./dist/js/astro.js"
     },
     "./sveltekit": {
       "types": "./dist/js/sveltekit.d.ts",
-      "default": "./dist/js/sveltekit.js"
+      "import": "./dist/js/sveltekit.js"
     },
     "./nuxt": {
       "types": "./dist/js/nuxt.d.ts",
-      "default": "./dist/js/nuxt.js"
+      "import": "./dist/js/nuxt.js"
     }
   },
   "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"
   },
@@ -56,7 +63,7 @@
     "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",
@@ -66,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/helpers/routes.d.ts

@@ -1,159 +0,0 @@
-/**
- * Route utilities for Litestar applications.
- *
- * These helpers work with route metadata injected by Litestar:
- * - window.__LITESTAR_ROUTES__ (SPA mode with route injection)
- * - window.routes (legacy/Inertia mode)
- * - Generated routes from src/generated/routes.ts (typed routing)
- *
- * For typed routing, import from your generated routes instead:
- * ```ts
- * import { route, routes } from '@/generated/routes'
- * ```
- *
- * @module
- */
-/**
- * Route definition from Litestar.
- */
-export interface RouteDefinition {
-    uri: string;
-    methods: string[];
-    parameters?: string[];
-    parameterTypes?: Record<string, string>;
-    queryParameters?: Record<string, string>;
-    component?: string;
-}
-/**
- * Routes object mapping route names to definitions.
- */
-export interface RoutesMap {
-    routes: Record<string, RouteDefinition>;
-}
-/**
- * Convenience alias for route names when using injected metadata.
- */
-export type RouteName = keyof RoutesMap["routes"];
-/**
- * Litestar helpers namespace for clean global access.
- */
-export interface LitestarHelpers {
-    route: typeof route;
-    toRoute: typeof toRoute;
-    currentRoute: typeof currentRoute;
-    isRoute: typeof isRoute;
-    isCurrentRoute: typeof isCurrentRoute;
-    getRelativeUrlPath: typeof getRelativeUrlPath;
-    routes: Record<string, string>;
-}
-declare global {
-    interface Window {
-        __LITESTAR_ROUTES__?: RoutesMap;
-        __LITESTAR__?: LitestarHelpers;
-        routes?: Record<string, string>;
-        serverRoutes?: Record<string, string>;
-    }
-    var __LITESTAR__: LitestarHelpers | undefined;
-    var routes: Record<string, string>;
-    var serverRoutes: Record<string, string>;
-}
-declare global {
-    interface ImportMeta {
-        hot?: {
-            on: (event: string, callback: (...args: unknown[]) => void) => void;
-            accept?: (cb?: () => void) => void;
-        };
-    }
-}
-type RouteArg = string | number | boolean;
-type RouteArgs = Record<string, RouteArg> | RouteArg[];
-/**
- * Get the routes object from the page.
- *
- * Checks multiple sources:
- * 1. window.__LITESTAR_ROUTES__ (SPA mode with full metadata)
- * 2. window.routes (legacy mode with just paths)
- *
- * @returns Routes map or null if not found
- */
-export declare function getRoutes(): Record<string, string> | null;
-/**
- * Generate a URL for a named route with parameters.
- *
- * @param routeName - The name of the route
- * @param args - Route parameters (object or array)
- * @returns The generated URL or "#" if route not found
- *
- * @example
- * ```ts
- * import { route } from 'litestar-vite-plugin/helpers'
- *
- * // Named parameters
- * route('user:detail', { user_id: 123 })  // "/users/123"
- *
- * // Positional parameters
- * route('user:detail', [123])  // "/users/123"
- * ```
- */
-export declare function route(routeName: string, ...args: [RouteArgs?]): string;
-/**
- * Get the relative path portion of a URL.
- *
- * @param url - Full URL or path
- * @returns Relative path with query string and hash
- */
-export declare function getRelativeUrlPath(url: string): string;
-/**
- * Convert a URL to a route name.
- *
- * @param url - URL to match
- * @returns Route name or null if no match
- *
- * @example
- * ```ts
- * toRoute('/users/123')  // "user:detail"
- * ```
- */
-export declare function toRoute(url: string): string | null;
-/**
- * Get the current route name based on window.location.
- *
- * @returns Current route name or null if no match
- */
-export declare function currentRoute(): string | null;
-/**
- * Check if a URL matches a route pattern.
- *
- * Supports wildcard patterns like "user:*" to match "user:list", "user:detail", etc.
- *
- * @param url - URL to check
- * @param routeName - Route name or pattern (supports * wildcards)
- * @returns True if the URL matches the route
- *
- * @example
- * ```ts
- * isRoute('/users/123', 'user:detail')  // true
- * isRoute('/users/123', 'user:*')       // true
- * ```
- */
-export declare function isRoute(url: string, routeName: string): boolean;
-/**
- * Check if the current URL matches a route pattern.
- *
- * @param routeName - Route name or pattern (supports * wildcards)
- * @returns True if the current URL matches the route
- *
- * @example
- * ```ts
- * // On /users/123
- * isCurrentRoute('user:detail')  // true
- * isCurrentRoute('user:*')       // true
- * ```
- */
-export declare function isCurrentRoute(routeName: string): boolean;
-/**
- * Litestar helpers namespace object.
- * Access via window.__LITESTAR__ or import functions directly from this module.
- */
-export declare const LITESTAR: LitestarHelpers;
-export {};

package/dist/js/helpers/routes.js

@@ -1,302 +0,0 @@
-/**
- * Route utilities for Litestar applications.
- *
- * These helpers work with route metadata injected by Litestar:
- * - window.__LITESTAR_ROUTES__ (SPA mode with route injection)
- * - window.routes (legacy/Inertia mode)
- * - Generated routes from src/generated/routes.ts (typed routing)
- *
- * For typed routing, import from your generated routes instead:
- * ```ts
- * import { route, routes } from '@/generated/routes'
- * ```
- *
- * @module
- */
-/**
- * Cache for compiled route patterns to avoid repeated regex compilation.
- */
-const routePatternCache = new Map();
-/**
- * Compile a route pattern to a regex for URL matching.
- * Results are cached for performance.
- *
- * @param routePattern - Route pattern with optional {param:type} placeholders
- * @returns Compiled regex pattern
- */
-function compileRoutePattern(routePattern) {
-    const cached = routePatternCache.get(routePattern);
-    if (cached) {
-        return cached;
-    }
-    const regexPattern = routePattern.replace(/\//g, "\\/").replace(/\{([^}]+)\}/g, (_, paramSpec) => {
-        // Handle {param:type} syntax
-        const paramType = paramSpec.includes(":") ? paramSpec.split(":")[1] : "str";
-        switch (paramType) {
-            case "uuid":
-                return "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}";
-            case "path":
-                return ".*";
-            case "int":
-                return "\\d+";
-            default:
-                return "[^/]+";
-        }
-    });
-    const compiled = new RegExp(`^${regexPattern}$`);
-    routePatternCache.set(routePattern, compiled);
-    return compiled;
-}
-/**
- * Get the routes object from the page.
- *
- * Checks multiple sources:
- * 1. window.__LITESTAR_ROUTES__ (SPA mode with full metadata)
- * 2. window.routes (legacy mode with just paths)
- *
- * @returns Routes map or null if not found
- */
-export function getRoutes() {
-    if (typeof window === "undefined") {
-        return null;
-    }
-    // Check for full route metadata (SPA mode)
-    if (window.__LITESTAR_ROUTES__?.routes) {
-        const routes = {};
-        for (const [name, def] of Object.entries(window.__LITESTAR_ROUTES__.routes)) {
-            routes[name] = def.uri;
-        }
-        // Expose a descriptive alias for consumers
-        window.serverRoutes = routes;
-        return routes;
-    }
-    // Check for simple routes object (legacy/Inertia mode)
-    if (window.routes) {
-        return window.routes;
-    }
-    // Check globalThis.routes
-    if (typeof globalThis !== "undefined" && globalThis.routes) {
-        return globalThis.routes;
-    }
-    return null;
-}
-/**
- * Generate a URL for a named route with parameters.
- *
- * @param routeName - The name of the route
- * @param args - Route parameters (object or array)
- * @returns The generated URL or "#" if route not found
- *
- * @example
- * ```ts
- * import { route } from 'litestar-vite-plugin/helpers'
- *
- * // Named parameters
- * route('user:detail', { user_id: 123 })  // "/users/123"
- *
- * // Positional parameters
- * route('user:detail', [123])  // "/users/123"
- * ```
- */
-export function route(routeName, ...args) {
-    const routes = getRoutes();
-    if (!routes) {
-        console.error("Routes not available. Ensure route metadata is injected.");
-        return "#";
-    }
-    let url = routes[routeName];
-    if (!url) {
-        console.error(`Route '${routeName}' not found.`);
-        return "#";
-    }
-    const argTokens = url.match(/\{([^}]+)\}/g);
-    if (!argTokens && args.length > 0 && args[0] !== undefined) {
-        console.error(`Route '${routeName}' does not accept parameters.`);
-        return "#";
-    }
-    if (!argTokens) {
-        return new URL(url, window.location.origin).href;
-    }
-    try {
-        if (typeof args[0] === "object" && !Array.isArray(args[0])) {
-            // Named parameters
-            for (const token of argTokens) {
-                let argName = token.slice(1, -1);
-                // Handle {param:type} syntax
-                if (argName.includes(":")) {
-                    argName = argName.split(":")[0];
-                }
-                const argValue = args[0][argName];
-                if (argValue === undefined) {
-                    throw new Error(`Missing parameter '${argName}'.`);
-                }
-                url = url.replace(token, String(argValue));
-            }
-        }
-        else {
-            // Positional parameters
-            const argsArray = Array.isArray(args[0]) ? args[0] : Array.from(args);
-            if (argTokens.length !== argsArray.length) {
-                throw new Error(`Expected ${argTokens.length} parameters, got ${argsArray.length}.`);
-            }
-            argTokens.forEach((token, i) => {
-                const argValue = argsArray[i];
-                if (argValue === undefined) {
-                    throw new Error(`Missing parameter at position ${i}.`);
-                }
-                url = url.replace(token, String(argValue));
-            });
-        }
-    }
-    catch (error) {
-        console.error(error instanceof Error ? error.message : String(error));
-        return "#";
-    }
-    return new URL(url, window.location.origin).href;
-}
-/**
- * Get the relative path portion of a URL.
- *
- * @param url - Full URL or path
- * @returns Relative path with query string and hash
- */
-export function getRelativeUrlPath(url) {
-    try {
-        const urlObject = new URL(url);
-        return urlObject.pathname + urlObject.search + urlObject.hash;
-    }
-    catch {
-        return url;
-    }
-}
-/**
- * Convert a URL to a route name.
- *
- * @param url - URL to match
- * @returns Route name or null if no match
- *
- * @example
- * ```ts
- * toRoute('/users/123')  // "user:detail"
- * ```
- */
-export function toRoute(url) {
-    const routes = getRoutes();
-    if (!routes) {
-        return null;
-    }
-    const processedUrl = getRelativeUrlPath(url);
-    const normalizedUrl = processedUrl === "/" ? processedUrl : processedUrl.replace(/\/$/, "");
-    for (const [routeName, routePattern] of Object.entries(routes)) {
-        const regex = compileRoutePattern(routePattern);
-        if (regex.test(normalizedUrl)) {
-            return routeName;
-        }
-    }
-    return null;
-}
-/**
- * Get the current route name based on window.location.
- *
- * @returns Current route name or null if no match
- */
-export function currentRoute() {
-    if (typeof window === "undefined") {
-        return null;
-    }
-    return toRoute(window.location.pathname);
-}
-/**
- * Check if a URL matches a route pattern.
- *
- * Supports wildcard patterns like "user:*" to match "user:list", "user:detail", etc.
- *
- * @param url - URL to check
- * @param routeName - Route name or pattern (supports * wildcards)
- * @returns True if the URL matches the route
- *
- * @example
- * ```ts
- * isRoute('/users/123', 'user:detail')  // true
- * isRoute('/users/123', 'user:*')       // true
- * ```
- */
-export function isRoute(url, routeName) {
-    const routes = getRoutes();
-    if (!routes) {
-        return false;
-    }
-    const processedUrl = getRelativeUrlPath(url);
-    const normalizedUrl = processedUrl === "/" ? processedUrl : processedUrl.replace(/\/$/, "");
-    // Convert route name pattern to regex
-    const routeNameRegex = new RegExp(`^${routeName.replace(/\*/g, ".*")}$`);
-    // Find all matching route names based on the pattern
-    const matchingRouteNames = Object.keys(routes).filter((name) => routeNameRegex.test(name));
-    for (const name of matchingRouteNames) {
-        const routePattern = routes[name];
-        const regex = compileRoutePattern(routePattern);
-        if (regex.test(normalizedUrl)) {
-            return true;
-        }
-    }
-    return false;
-}
-/**
- * Check if the current URL matches a route pattern.
- *
- * @param routeName - Route name or pattern (supports * wildcards)
- * @returns True if the current URL matches the route
- *
- * @example
- * ```ts
- * // On /users/123
- * isCurrentRoute('user:detail')  // true
- * isCurrentRoute('user:*')       // true
- * ```
- */
-export function isCurrentRoute(routeName) {
-    const current = currentRoute();
-    if (!current) {
-        return false;
-    }
-    const routeNameRegex = new RegExp(`^${routeName.replace(/\*/g, ".*")}$`);
-    return routeNameRegex.test(current);
-}
-/**
- * Litestar helpers namespace object.
- * Access via window.__LITESTAR__ or import functions directly from this module.
- */
-export const LITESTAR = {
-    route,
-    toRoute,
-    currentRoute,
-    isRoute,
-    isCurrentRoute,
-    getRelativeUrlPath,
-    routes: {},
-};
-// Set up namespaced global access
-if (typeof globalThis !== "undefined") {
-    globalThis.__LITESTAR__ = LITESTAR;
-    // Also set up routes for internal use
-    globalThis.routes = globalThis.routes || LITESTAR.routes;
-    globalThis.serverRoutes = globalThis.serverRoutes || globalThis.routes;
-}
-// Keep routes fresh during Vite HMR when the plugin regenerates metadata/types
-if (import.meta.hot) {
-    import.meta.hot.on("litestar:types-updated", () => {
-        if (typeof window === "undefined") {
-            return;
-        }
-        const updated = getRoutes();
-        if (updated) {
-            // Update all references
-            LITESTAR.routes = updated;
-            window.serverRoutes = updated;
-            window.routes = updated;
-            if (window.__LITESTAR__) {
-                window.__LITESTAR__.routes = updated;
-            }
-        }
-    });
-}