litestar-vite-plugin 0.28.0 → 0.29.0

package/dist/js/helpers/htmx.js

@@ -27,7 +27,8 @@
  *
  * @module
  */
-import { DEFAULT_CSRF_HEADER_NAME, getCsrfToken } from "./csrf.js";
+import { getCsrfHeaderName, getCsrfToken } from "./csrf.js";
+import { compileExpression } from "./expression.js";
 function getHeadersFromConfigRequestEvent(evt) {
     const detail = evt.detail;
     if (!detail || typeof detail !== "object")
@@ -80,12 +81,13 @@ export function registerHtmxExtension() {
         onEvent(name, evt) {
             if (name === "htmx:configRequest") {
                 const token = getCsrfToken();
+                const headerName = getCsrfHeaderName();
                 const headers = getHeadersFromConfigRequestEvent(evt);
                 if (token && headers) {
                     if (headers instanceof Headers)
-                        headers.set(DEFAULT_CSRF_HEADER_NAME, token);
+                        headers.set(headerName, token);
                     else
-                        headers[DEFAULT_CSRF_HEADER_NAME] = token;
+                        headers[headerName] = token;
                 }
             }
             return true;
@@ -194,6 +196,28 @@ function swapKids(start, end, ctx, parse = false) {
         current = (r ?? current).nextSibling;
     }
 }
+function wrapEvent(event) {
+    const eventTarget = event.target;
+    let target = null;
+    if (eventTarget instanceof HTMLInputElement || eventTarget instanceof HTMLSelectElement || eventTarget instanceof HTMLTextAreaElement) {
+        target = Object.freeze({
+            value: eventTarget.value,
+            name: eventTarget.name,
+            checked: eventTarget instanceof HTMLInputElement ? eventTarget.checked : false,
+            id: eventTarget.id,
+            type: eventTarget instanceof HTMLInputElement ? eventTarget.type : "",
+        });
+    }
+    else if (eventTarget instanceof Element) {
+        target = Object.freeze({ value: "", name: "", checked: false, id: eventTarget.id, type: "" });
+    }
+    return Object.freeze({
+        type: event.type,
+        target,
+        preventDefault: () => event.preventDefault(),
+        stopPropagation: () => event.stopPropagation(),
+    });
+}
 const directives = [
     // :attr="expr" - attribute binding
     {
@@ -246,7 +270,7 @@ const directives = [
                     if (!current)
                         return;
                     const eventCtx = Object.create(current);
-                    eventCtx.$event = e;
+                    eventCtx.$event = wrapEvent(e);
                     g(eventCtx);
                 });
             };
@@ -458,131 +482,6 @@ function childCtx(parent, data, index, key) {
 // =============================================================================
 // Expression Compiler
 // =============================================================================
-/** Identifiers that must never appear as standalone words in expressions */
-const BLOCKED_GLOBALS = [
-    "window",
-    "document",
-    "globalThis",
-    "self",
-    "top",
-    "frames",
-    "Function",
-    "eval",
-    "setTimeout",
-    "setInterval",
-    "constructor",
-    "__proto__",
-    "prototype",
-    "import",
-    "require",
-];
-/** Build a single regex: matches any blocked word at a word boundary */
-const BLOCKED_RE = new RegExp(`\\b(${BLOCKED_GLOBALS.join("|")})\\b`);
-/** Strip string literals and template strings before checking for blocked patterns */
-function stripStrings(s) {
-    return s
-        .replace(/`(?:[^`\\]|\\.)*`/g, "") // template literals
-        .replace(/"(?:[^"\\]|\\.)*"/g, "") // double-quoted strings
-        .replace(/'(?:[^'\\]|\\.)*'/g, ""); // single-quoted strings
-}
-function readQuotedLiteral(s, start) {
-    const quote = s[start];
-    if (quote !== "'" && quote !== '"' && quote !== "`")
-        return null;
-    let value = "";
-    for (let i = start + 1; i < s.length; i++) {
-        const ch = s[i];
-        if (ch === "\\") {
-            if (i + 1 >= s.length)
-                return null;
-            const escaped = readEscapedCharacter(s, i + 1);
-            if (!escaped)
-                return null;
-            value += escaped.value;
-            i = escaped.end - 1;
-            continue;
-        }
-        if (quote === "`" && ch === "$" && s[i + 1] === "{") {
-            return null;
-        }
-        if (ch === quote) {
-            return { end: i + 1, value };
-        }
-        value += ch;
-    }
-    return null;
-}
-function readEscapedCharacter(s, start) {
-    const ch = s[start];
-    if (ch === "u") {
-        if (s[start + 1] === "{") {
-            const close = s.indexOf("}", start + 2);
-            if (close === -1)
-                return null;
-            const codePoint = Number.parseInt(s.slice(start + 2, close), 16);
-            return Number.isFinite(codePoint) ? { end: close + 1, value: String.fromCodePoint(codePoint) } : null;
-        }
-        const codePoint = Number.parseInt(s.slice(start + 1, start + 5), 16);
-        return Number.isFinite(codePoint) ? { end: start + 5, value: String.fromCharCode(codePoint) } : null;
-    }
-    if (ch === "x") {
-        const codePoint = Number.parseInt(s.slice(start + 1, start + 3), 16);
-        return Number.isFinite(codePoint) ? { end: start + 3, value: String.fromCharCode(codePoint) } : null;
-    }
-    const escapes = { b: "\b", f: "\f", n: "\n", r: "\r", t: "\t", v: "\v" };
-    return { end: start + 1, value: escapes[ch] ?? ch };
-}
-function skipTrivia(s, start) {
-    let i = start;
-    while (i < s.length) {
-        while (/\s/.test(s[i] ?? ""))
-            i += 1;
-        if (s[i] === "/" && s[i + 1] === "/") {
-            i = s.indexOf("\n", i + 2);
-            if (i === -1)
-                return s.length;
-            continue;
-        }
-        if (s[i] === "/" && s[i + 1] === "*") {
-            const close = s.indexOf("*/", i + 2);
-            if (close === -1)
-                return s.length;
-            i = close + 2;
-            continue;
-        }
-        break;
-    }
-    return i;
-}
-function hasBlockedStringConcatenation(s) {
-    for (let i = 0; i < s.length; i++) {
-        const first = readQuotedLiteral(s, i);
-        if (!first)
-            continue;
-        const parts = [first.value];
-        let cursor = skipTrivia(s, first.end);
-        while (s[cursor] === "+") {
-            const nextStart = skipTrivia(s, cursor + 1);
-            const next = readQuotedLiteral(s, nextStart);
-            if (!next)
-                break;
-            parts.push(next.value);
-            cursor = skipTrivia(s, next.end);
-        }
-        if (parts.length > 1 && BLOCKED_GLOBALS.includes(parts.join(""))) {
-            return true;
-        }
-        i = first.end - 1;
-    }
-    return false;
-}
-function isExpressionSafe(s) {
-    if (hasBlockedStringConcatenation(s)) {
-        return false;
-    }
-    const stripped = stripStrings(s);
-    return !BLOCKED_RE.test(stripped);
-}
 function expr(s) {
     if (!s)
         return null;
@@ -593,22 +492,16 @@ function expr(s) {
         expressionCache.set(s, cached);
         return cached;
     }
-    if (!isExpressionSafe(s)) {
+    const compiled = compileExpression(s);
+    if (!compiled) {
         if (debug)
             console.warn(`[litestar] blocked expression: ${s}`);
         cacheExpression(s, null);
         return null;
     }
-    try {
-        // Expression validated by isExpressionSafe() above — dangerous globals/constructors blocked
-        const fn = new Function("ctx", `with(ctx){return(${s})}`);
-        cacheExpression(s, fn);
-        return fn;
-    }
-    catch {
-        cacheExpression(s, null);
-        return null;
-    }
+    const fn = (context) => compiled(context);
+    cacheExpression(s, fn);
+    return fn;
 }
 /** Compile text with ${expr} interpolation - escapes backticks and backslashes */
 function compileTextExpr(t) {

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

@@ -38,7 +38,7 @@
  *
  * @module
  */
-export { csrfFetch, csrfHeaders, getCsrfToken } from "./csrf.js";
+export { csrfFetch, csrfHeaders, getCsrfHeaderName, getCsrfToken } from "./csrf.js";
 export { createChannelsStream, type ChannelName, type ChannelsStreamOptions } from "./channels.js";
 export { addDirective, registerHtmxExtension, setDebug as setHtmxDebug, swapJson } from "./htmx.js";
 export { createQueueEventStream, QUEUE_SSE_EVENTS, type QueueEventStreamOptions, type QueueStreamTarget, type QueueStreamValue } from "./queues.js";

package/dist/js/helpers/index.js

@@ -39,7 +39,7 @@
  * @module
  */
 // CSRF utilities
-export { csrfFetch, csrfHeaders, getCsrfToken } from "./csrf.js";
+export { csrfFetch, csrfHeaders, getCsrfHeaderName, getCsrfToken } from "./csrf.js";
 // Litestar Channels utilities
 export { createChannelsStream } from "./channels.js";
 // HTMX utilities

package/dist/js/index.d.ts

@@ -1,114 +1,12 @@
 import { type Config as FullReloadConfig } from "vite-plugin-full-reload";
+import { type TypesConfigShape } from "./shared/typegen-plugin.js";
 /**
  * Configuration for TypeScript type generation.
  *
- * Type generation works as follows:
- * 1. Python's Litestar exports openapi.json and routes.json on startup (and reload)
- * 2. The Vite plugin watches these files for changes
- * 3. When they change, it runs @hey-api/openapi-ts to generate TypeScript types
- * 4. HMR event is sent to notify the client
+ * Alias of the shared {@link TypesConfigShape}, which every framework integration also
+ * re-exports, so the `types` option is identical everywhere. Retained as a named export.
  */
-export interface TypesConfig {
-    /**
-     * Enable type generation.
-     *
-     * @default false
-     */
-    enabled?: boolean;
-    /**
-     * Path to output generated TypeScript types.
-     *
-     * @default 'src/generated'
-     */
-    output?: string;
-    /**
-     * Path where the OpenAPI schema is exported by Litestar.
-     * The Vite plugin watches this file and runs @hey-api/openapi-ts when it changes.
-     *
-     * @default 'src/generated/openapi.json'
-     */
-    openapiPath?: string;
-    /**
-     * Path where route metadata is exported by Litestar.
-     * The Vite plugin watches this file for route helper generation.
-     *
-     * @default 'src/generated/routes.json'
-     */
-    routesPath?: string;
-    /**
-     * Optional path for the generated schemas.ts helper file.
-     * Defaults to `${output}/schemas.ts` when not set.
-     */
-    schemasTsPath?: string;
-    /**
-     * Path where Inertia page props metadata is exported by Litestar.
-     * The Vite plugin watches this file for page props type generation.
-     *
-     * @default 'src/generated/inertia-pages.json'
-     */
-    pagePropsPath?: string;
-    /**
-     * Generate Zod schemas in addition to TypeScript types.
-     *
-     * @default false
-     */
-    generateZod?: boolean;
-    /**
-     * Generate a typed SDK client in addition to types.
-     *
-     * @default true
-     */
-    generateSdk?: boolean;
-    /**
-     * Generate typed routes.ts from routes.json metadata.
-     *
-     * Mirrors Python TypeGenConfig.generate_routes.
-     *
-     * @default true
-     */
-    generateRoutes?: boolean;
-    /**
-     * Generate Inertia page props types from inertia-pages.json metadata.
-     *
-     * Mirrors Python TypeGenConfig.generate_page_props.
-     *
-     * @default true
-     */
-    generatePageProps?: boolean;
-    /**
-     * Generate schemas.ts with ergonomic form/response type helpers.
-     *
-     * Creates helper types like FormInput<'api:login'> and FormResponse<'api:login', 201>
-     * that wrap hey-api generated types with cleaner DX.
-     *
-     * @default true
-     */
-    generateSchemas?: boolean;
-    /**
-     * Register route() function globally on window object.
-     *
-     * When true, the generated routes.ts will include code that registers
-     * the type-safe route() function on `window.route`, similar to Laravel's
-     * Ziggy library. This allows using route() without imports.
-     *
-     * @default false
-     */
-    globalRoute?: boolean;
-    /**
-     * Fail Vite when type generation fails.
-     *
-     * Defaults to true during `vite build` and false during `vite serve`.
-     */
-    failOnError?: boolean;
-    /**
-     * Debounce time in milliseconds for type regeneration.
-     * Prevents regeneration from running too frequently when
-     * multiple files are written in quick succession.
-     *
-     * @default 300
-     */
-    debounce?: number;
-}
+export type TypesConfig = TypesConfigShape;
 export interface PluginConfig {
     /**
      * The path or paths of the entry points to compile.

package/dist/js/install-hint.js

@@ -51,19 +51,7 @@ function resolveInstallHint(pkg = "@hey-api/openapi-ts") {
   return `npm install -D ${packageArgs}`;
 }
 function resolvePackageExecutor(pkg, executor) {
-  const runtime = executor || detectExecutor();
-  switch (runtime) {
-    case "bun":
-      return `bunx ${pkg}`;
-    case "deno":
-      return `deno run -A npm:${pkg}`;
-    case "pnpm":
-      return `pnpm dlx ${pkg}`;
-    case "yarn":
-      return `yarn dlx ${pkg}`;
-    default:
-      return `npx ${pkg}`;
-  }
+  return resolvePackageExecutorArgv(pkg.split(" "), executor).join(" ");
 }
 function getPackageNameFromSpec(packageSpec) {
   if (packageSpec.startsWith("@")) {
@@ -88,9 +76,14 @@ function resolvePackageExecutorArgv(args, executor, options = {}) {
     case "bun":
       if (requiresMultiplePackages) return [];
       return ["bunx", ...packageSpec ? [packageSpec, ...args] : args];
-    case "deno":
+    case "deno": {
       if (requiresMultiplePackages) return [];
-      return ["deno", "run", "-A", ...packageSpec ? [`npm:${resolveDenoPackageSpec(packageSpec, binName)}`, ...args] : args];
+      if (packageSpec) {
+        return ["deno", "run", "-A", `npm:${resolveDenoPackageSpec(packageSpec, binName)}`, ...args];
+      }
+      const [firstArg, ...restArgs] = args;
+      return firstArg ? ["deno", "run", "-A", `npm:${firstArg}`, ...restArgs] : ["deno", "run", "-A"];
+    }
     case "pnpm":
       if (requiresMultiplePackages && binName) {
         return ["pnpm", "dlx", ...packageSpecs.map((spec) => `--package=${spec}`), binName, ...args];

package/dist/js/nuxt.d.ts

@@ -23,138 +23,22 @@
  * @module
  */
 import type { Plugin } from "vite";
+import { type LitestarIntegrationConfig } from "./shared/integration-config.js";
+import { type TypesConfigShape } from "./shared/typegen-plugin.js";
 /**
- * Configuration for TypeScript type generation in Nuxt.
+ * Configuration for TypeScript type generation.
+ *
+ * Alias of the shared {@link TypesConfigShape} so every integration accepts an identical
+ * `types` option. Retained as a named export for backwards compatibility.
  */
-export interface NuxtTypesConfig {
-    /**
-     * Enable type generation.
-     *
-     * @default false
-     */
-    enabled?: boolean;
-    /**
-     * Path to output generated TypeScript types.
-     * Relative to the Nuxt project root.
-     *
-     * @default 'generated'
-     */
-    output?: string;
-    /**
-     * Path where the OpenAPI schema is exported by Litestar.
-     *
-     * @default `${output}/openapi.json`
-     */
-    openapiPath?: string;
-    /**
-     * Path where route metadata is exported by Litestar.
-     *
-     * @default `${output}/routes.json`
-     */
-    routesPath?: string;
-    /**
-     * Optional path for the generated schemas.ts helper file.
-     *
-     * @default `${output}/schemas.ts`
-     */
-    schemasTsPath?: string;
-    /**
-     * Path where Inertia page props metadata is exported by Litestar.
-     *
-     * @default `${output}/inertia-pages.json`
-     */
-    pagePropsPath?: string;
-    /**
-     * Generate Zod schemas in addition to TypeScript types.
-     *
-     * @default false
-     */
-    generateZod?: boolean;
-    /**
-     * Generate SDK client functions for API calls.
-     *
-     * @default true
-     */
-    generateSdk?: boolean;
-    /**
-     * Generate typed routes.ts from routes.json metadata.
-     *
-     * @default true
-     */
-    generateRoutes?: boolean;
-    /**
-     * Generate Inertia page props types from inertia-pages.json metadata.
-     *
-     * @default true
-     */
-    generatePageProps?: boolean;
-    /**
-     * Generate schemas.ts with ergonomic form/response type helpers.
-     *
-     * @default true
-     */
-    generateSchemas?: boolean;
-    /**
-     * Register route() globally on window object.
-     *
-     * @default false
-     */
-    globalRoute?: boolean;
-    /**
-     * Fail Vite when type generation fails.
-     *
-     * Defaults to true during build and false during dev.
-     */
-    failOnError?: boolean;
-    /**
-     * Debounce time in milliseconds for type regeneration.
-     *
-     * @default 300
-     */
-    debounce?: number;
-}
+export type NuxtTypesConfig = TypesConfigShape;
 /**
- * Configuration options for the Litestar Nuxt module.
+ * Configuration options for the Litestar integration.
+ *
+ * Alias of the shared {@link LitestarIntegrationConfig}. Retained as a named export for
+ * backwards compatibility.
  */
-export interface LitestarNuxtConfig {
-    /**
-     * URL of the Litestar API backend for proxying requests during development.
-     *
-     * @example 'http://127.0.0.1:8000'
-     * @default 'http://localhost:8000'
-     */
-    apiProxy?: string;
-    /**
-     * API route prefix to proxy to the Litestar backend.
-     * Requests matching this prefix will be forwarded to the apiProxy URL.
-     *
-     * @example '/api'
-     * @default '/api'
-     */
-    apiPrefix?: string;
-    /**
-     * Enable and configure TypeScript type generation.
-     *
-     * When set to `true`, enables type generation with default settings.
-     * When set to a NuxtTypesConfig object, enables type generation with custom settings.
-     *
-     * @default false
-     */
-    types?: boolean | NuxtTypesConfig;
-    /**
-     * Enable verbose logging for debugging.
-     *
-     * @default false
-     */
-    verbose?: boolean;
-    /**
-     * JavaScript runtime executor for package commands.
-     * Used when running tools like @hey-api/openapi-ts.
-     *
-     * @default undefined (uses LITESTAR_VITE_RUNTIME env or 'node')
-     */
-    executor?: "node" | "bun" | "deno" | "yarn" | "pnpm";
-}
+export type LitestarNuxtConfig = LitestarIntegrationConfig;
 /**
  * Nuxt module definition for Litestar integration.
  *

package/dist/js/nuxt.js

@@ -1,64 +1,13 @@
 import fs from "node:fs";
 import path from "node:path";
 import colors from "picocolors";
-import { readBridgeConfig } from "./shared/bridge-schema.js";
+import { resolveIntegrationConfig } from "./shared/integration-config.js";
 import { installManagedShutdown } from "./shared/managed-shutdown.js";
-import { normalizeHost, resolveHotFilePath, resolveLitestarPort } from "./shared/network.js";
-import { createLitestarTypeGenPlugin, resolveTypesConfig } from "./shared/typegen-plugin.js";
+import { normalizeHost } from "./shared/network.js";
+import { createLitestarTypeGenPlugin } from "./shared/typegen-plugin.js";
 import { hmrServerConfig } from "./shared/vite-compat.js";
 function resolveConfig(config = {}) {
-  let hotFile;
-  let proxyMode = "vite";
-  let devPort;
-  let pythonTypesConfig;
-  let hasPythonConfig = false;
-  const envPort = process.env.VITE_PORT;
-  if (envPort) {
-    devPort = Number.parseInt(envPort, 10);
-    if (Number.isNaN(devPort)) {
-      devPort = void 0;
-    }
-  }
-  let pythonExecutor;
-  let assetUrl;
-  let litestarPort;
-  const runtime = readBridgeConfig();
-  if (runtime) {
-    hasPythonConfig = true;
-    const hot = runtime.hotFile;
-    hotFile = resolveHotFilePath(runtime.bundleDir, hot);
-    proxyMode = runtime.proxyMode;
-    devPort = runtime.port;
-    pythonExecutor = runtime.executor;
-    assetUrl = runtime.assetUrl;
-    if (runtime.types) {
-      pythonTypesConfig = runtime.types;
-    }
-  }
-  const resolvedLitestarPort = resolveLitestarPort(runtime?.litestarPort, runtime?.appUrl);
-  if (resolvedLitestarPort !== null) {
-    litestarPort = resolvedLitestarPort;
-  }
-  const typesConfig = resolveTypesConfig({
-    requested: config.types,
-    pythonConfig: pythonTypesConfig ?? void 0,
-    defaultOutput: "generated",
-    mergePythonWhenTrue: true,
-    mergePythonForObject: true
-  });
-  return {
-    apiProxy: config.apiProxy ?? "http://localhost:8000",
-    apiPrefix: config.apiPrefix ?? "/api",
-    types: typesConfig,
-    verbose: config.verbose ?? false,
-    hotFile,
-    proxyMode,
-    devPort,
-    litestarPort,
-    assetUrl,
-    executor: config.executor ?? pythonExecutor,
-    hasPythonConfig
-  };
+  return resolveIntegrationConfig(config, "generated");
 }
 async function getPort() {
   return new Promise((resolve, reject) => {
@@ -81,7 +30,7 @@ function createProxyPlugin(config) {
     async config() {
       hmrPort = await getPort();
       const hmrPath = `${(config.assetUrl ?? "/static").replace(/\/$/, "")}/vite-hmr`;
-      const browserHmrPort = config.litestarPort ?? config.devPort;
+      const browserHmrPort = config.litestarPort ?? config.port;
       return {
         server: {
           // Force IPv4 binding for consistency with Python proxy configuration
@@ -89,8 +38,8 @@ function createProxyPlugin(config) {
           host: "127.0.0.1",
           // Set the port from Python config/env to ensure Nuxt uses the expected port
           // strictPort: true prevents auto-incrementing to a different port
-          ...config.devPort !== void 0 ? {
-            port: config.devPort,
+          ...config.port !== void 0 ? {
+            port: config.port,
             strictPort: true
           } : {},
           // Vite serves HMR on a separate internal port; browsers reach it through

package/dist/js/shared/bridge-schema.d.ts

@@ -8,9 +8,9 @@
  *
  * @module
  */
-export type BridgeMode = "spa" | "template" | "hybrid" | "framework" | "external";
-export type BridgeProxyMode = "vite" | "direct" | "proxy" | null;
-export type BridgeExecutor = "node" | "bun" | "deno" | "yarn" | "pnpm";
+type BridgeMode = "spa" | "template" | "hybrid" | "framework" | "external";
+type BridgeProxyMode = "vite" | "direct" | "proxy" | null;
+type BridgeExecutor = "node" | "bun" | "deno" | "yarn" | "pnpm";
 export interface BridgeTypesConfig {
     enabled: boolean;
     output: string;
@@ -27,7 +27,7 @@ export interface BridgeTypesConfig {
     globalRoute: boolean;
     failOnError?: boolean;
 }
-export interface BridgeSpaConfig {
+interface BridgeSpaConfig {
     /** Use script element instead of data-page attribute for Inertia page data */
     useScriptElement: boolean;
 }
@@ -35,6 +35,8 @@ export interface BridgeSchema {
     assetUrl: string;
     deployAssetUrl: string | null;
     appUrl: string | null;
+    csrfCookieName: string | null;
+    csrfHeaderName: string | null;
     /**
      * Litestar dev server port. Used by framework integrations to set
      * `vite.server.ws.clientPort` on Vite 8.1+ (`vite.server.hmr.clientPort` on
@@ -71,3 +73,4 @@ export interface BridgeSchema {
 }
 export declare function parseBridgeSchema(value: unknown): BridgeSchema;
 export declare function readBridgeConfig(explicitPath?: string): BridgeSchema | null;
+export {};