litestar-vite-plugin 0.16.3 → 0.17.0

package/dist/js/index.js

@@ -26,6 +26,7 @@ function litestar(config) {
       })
     );
   }
+  plugins.push(createStaticPropsPlugin());
   return plugins;
 }
 async function findIndexHtmlPath(server, pluginConfig) {
@@ -489,26 +490,37 @@ function resolvePluginConfig(config) {
   if (typeof resolvedConfig.input === "undefined") {
     throw new Error('litestar-vite-plugin: missing configuration for "input".');
   }
+  const normalizeDir = (dir) => {
+    const trimmed = dir.trim().replace(/\/+$/, "");
+    if (trimmed.startsWith("/")) {
+      const withoutSlash = trimmed.slice(1);
+      const segments = withoutSlash.split("/").filter(Boolean);
+      if (segments.length <= 2) {
+        return withoutSlash;
+      }
+    }
+    return trimmed;
+  };
   if (typeof resolvedConfig.resourceDir === "string") {
-    resolvedConfig.resourceDir = resolvedConfig.resourceDir.trim().replace(/^\/+/, "").replace(/\/+$/, "");
+    resolvedConfig.resourceDir = normalizeDir(resolvedConfig.resourceDir);
     if (resolvedConfig.resourceDir === "") {
       throw new Error("litestar-vite-plugin: resourceDir must be a subdirectory. E.g. 'resources'.");
     }
   }
   if (typeof resolvedConfig.bundleDir === "string") {
-    resolvedConfig.bundleDir = resolvedConfig.bundleDir.trim().replace(/^\/+/, "").replace(/\/+$/, "");
+    resolvedConfig.bundleDir = normalizeDir(resolvedConfig.bundleDir);
     if (resolvedConfig.bundleDir === "") {
       throw new Error("litestar-vite-plugin: bundleDir must be a subdirectory. E.g. 'public'.");
     }
   }
   if (typeof resolvedConfig.staticDir === "string") {
-    resolvedConfig.staticDir = resolvedConfig.staticDir.trim().replace(/^\/+/, "").replace(/\/+$/, "");
+    resolvedConfig.staticDir = normalizeDir(resolvedConfig.staticDir);
     if (resolvedConfig.staticDir === "") {
       throw new Error("litestar-vite-plugin: staticDir must be a subdirectory. E.g. 'src/public'.");
     }
   }
   if (typeof resolvedConfig.ssrOutDir === "string") {
-    resolvedConfig.ssrOutDir = resolvedConfig.ssrOutDir.trim().replace(/^\/+/, "").replace(/\/+$/, "");
+    resolvedConfig.ssrOutDir = normalizeDir(resolvedConfig.ssrOutDir);
   }
   if (resolvedConfig.refresh === true) {
     resolvedConfig.refresh = [{ paths: refreshPaths }];
@@ -619,20 +631,26 @@ function validateAgainstPythonDefaults(resolved, pythonDefaults, userConfig) {
   if (!pythonDefaults) return;
   const warnings = [];
   const hasPythonValue = (value) => typeof value === "string" && value.length > 0;
+  const pathsAreSame = (a, b) => {
+    if (!a && !b) return true;
+    if (!a || !b) return false;
+    const normalize = (p) => path.resolve(process.cwd(), p).replace(/\\/g, "/").replace(/\/+$/, "");
+    return normalize(a) === normalize(b);
+  };
   if (userConfig.assetUrl !== void 0 && hasPythonValue(pythonDefaults.assetUrl) && resolved.assetUrl !== pythonDefaults.assetUrl) {
     warnings.push(`assetUrl: vite.config.ts="${resolved.assetUrl}" differs from Python="${pythonDefaults.assetUrl}"`);
   }
-  if (userConfig.bundleDir !== void 0 && hasPythonValue(pythonDefaults.bundleDir) && resolved.bundleDir !== pythonDefaults.bundleDir) {
+  if (userConfig.bundleDir !== void 0 && hasPythonValue(pythonDefaults.bundleDir) && !pathsAreSame(resolved.bundleDir, pythonDefaults.bundleDir)) {
     warnings.push(`bundleDir: vite.config.ts="${resolved.bundleDir}" differs from Python="${pythonDefaults.bundleDir}"`);
   }
-  if (userConfig.resourceDir !== void 0 && hasPythonValue(pythonDefaults.resourceDir) && resolved.resourceDir !== pythonDefaults.resourceDir) {
+  if (userConfig.resourceDir !== void 0 && hasPythonValue(pythonDefaults.resourceDir) && !pathsAreSame(resolved.resourceDir, pythonDefaults.resourceDir)) {
     warnings.push(`resourceDir: vite.config.ts="${resolved.resourceDir}" differs from Python="${pythonDefaults.resourceDir}"`);
   }
-  if (userConfig.staticDir !== void 0 && hasPythonValue(pythonDefaults.staticDir) && resolved.staticDir !== pythonDefaults.staticDir) {
+  if (userConfig.staticDir !== void 0 && hasPythonValue(pythonDefaults.staticDir) && !pathsAreSame(resolved.staticDir, pythonDefaults.staticDir)) {
     warnings.push(`staticDir: vite.config.ts="${resolved.staticDir}" differs from Python="${pythonDefaults.staticDir}"`);
   }
   const frameworkMode = pythonDefaults.mode === "framework" || pythonDefaults.mode === "ssr" || pythonDefaults.mode === "ssg";
-  if (frameworkMode && userConfig.ssrOutDir !== void 0 && hasPythonValue(pythonDefaults.ssrOutDir) && resolved.ssrOutDir !== pythonDefaults.ssrOutDir) {
+  if (frameworkMode && userConfig.ssrOutDir !== void 0 && hasPythonValue(pythonDefaults.ssrOutDir) && !pathsAreSame(resolved.ssrOutDir, pythonDefaults.ssrOutDir)) {
     warnings.push(`ssrOutDir: vite.config.ts="${resolved.ssrOutDir}" differs from Python="${pythonDefaults.ssrOutDir}"`);
   }
   if (warnings.length > 0) {
@@ -685,6 +703,35 @@ function resolveFullReloadConfig({ refresh: config }) {
     return plugin;
   });
 }
+const STATIC_PROPS_VIRTUAL_MODULE_ID = "virtual:litestar-static-props";
+const STATIC_PROPS_RESOLVED_ID = "\0virtual:litestar-static-props";
+function createStaticPropsPlugin() {
+  const bridgeConfig = readBridgeConfig();
+  const staticProps = bridgeConfig?.staticProps ?? {};
+  return {
+    name: "litestar-vite-static-props",
+    enforce: "pre",
+    resolveId(id) {
+      if (id === STATIC_PROPS_VIRTUAL_MODULE_ID) {
+        return STATIC_PROPS_RESOLVED_ID;
+      }
+      return void 0;
+    },
+    load(id) {
+      if (id === STATIC_PROPS_RESOLVED_ID) {
+        const namedExports = [];
+        for (const key of Object.keys(staticProps)) {
+          if (/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
+            namedExports.push(`export const ${key} = ${JSON.stringify(staticProps[key])};`);
+          }
+        }
+        const defaultExport = `export default ${JSON.stringify(staticProps)};`;
+        return [...namedExports, defaultExport].join("\n");
+      }
+      return void 0;
+    }
+  };
+}
 function resolveDevServerUrl(address, config, userConfig) {
   const configHmrProtocol = typeof config.server.hmr === "object" ? config.server.hmr.protocol : null;
   const clientProtocol = configHmrProtocol ? configHmrProtocol === "wss" ? "https" : "http" : null;

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

@@ -54,6 +54,11 @@ export interface BridgeSchema {
         timestamps: boolean;
     } | null;
     litestarVersion: string;
+    /**
+     * Static props configured in Python ViteConfig.static_props.
+     * Available in JS via `virtual:litestar-static-props` module.
+     */
+    staticProps?: Record<string, unknown> | null;
 }
 export declare function parseBridgeSchema(value: unknown): BridgeSchema;
 export declare function readBridgeConfig(explicitPath?: string): BridgeSchema | null;

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

@@ -17,7 +17,8 @@ const allowedTopLevelKeys = /* @__PURE__ */ new Set([
   "spa",
   "executor",
   "logging",
-  "litestarVersion"
+  "litestarVersion",
+  "staticProps"
 ]);
 const allowedModes = /* @__PURE__ */ new Set(["spa", "template", "htmx", "hybrid", "inertia", "framework", "ssr", "ssg", "external"]);
 const allowedProxyModes = /* @__PURE__ */ new Set(["vite", "direct", "proxy"]);
@@ -135,6 +136,10 @@ function parseSpaConfig(value) {
   const useScriptElement = assertBoolean(obj, "useScriptElement");
   return { useScriptElement };
 }
+function parseStaticProps(value) {
+  if (value === null || value === void 0) return null;
+  return assertObject(value, "staticProps");
+}
 function parseBridgeSchema(value) {
   const obj = assertObject(value, "root");
   for (const key of Object.keys(obj)) {
@@ -159,6 +164,7 @@ function parseBridgeSchema(value) {
   const executor = assertEnum(obj.executor, "executor", allowedExecutors);
   const logging = parseLogging(obj.logging);
   const litestarVersion = assertString(obj, "litestarVersion");
+  const staticProps = parseStaticProps(obj.staticProps);
   return {
     assetUrl,
     deployAssetUrl,
@@ -176,7 +182,8 @@ function parseBridgeSchema(value) {
     spa,
     executor,
     logging,
-    litestarVersion
+    litestarVersion,
+    staticProps
   };
 }
 function readBridgeConfig(explicitPath) {

package/dist/js/shared/emit-static-props-types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generate `static-props.ts` from `.litestar.json` static props.
+ *
+ * This reads the staticProps from the bridge config and generates:
+ * - An interface with all properties typed
+ * - Named exports for each property
+ * - Default export with all properties
+ *
+ * @returns true if file was changed, false if unchanged
+ */
+export declare function emitStaticPropsTypes(outputDir: string): Promise<boolean>;

package/dist/js/shared/emit-static-props-types.js

@@ -0,0 +1,130 @@
+import fs from "node:fs";
+import path from "node:path";
+import { readBridgeConfig } from "./bridge-schema.js";
+import { writeIfChanged } from "./write-if-changed.js";
+function inferType(value, indent = 0) {
+  const spaces = "  ".repeat(indent);
+  const innerSpaces = "  ".repeat(indent + 1);
+  if (value === null) {
+    return "null";
+  }
+  if (value === void 0) {
+    return "undefined";
+  }
+  if (typeof value === "string") {
+    return "string";
+  }
+  if (typeof value === "number") {
+    return "number";
+  }
+  if (typeof value === "boolean") {
+    return "boolean";
+  }
+  if (Array.isArray(value)) {
+    if (value.length === 0) {
+      return "unknown[]";
+    }
+    const elementType = inferType(value[0], indent);
+    const allSameType = value.every((v) => inferType(v, indent) === elementType);
+    if (allSameType) {
+      return `${elementType}[]`;
+    }
+    const types = [...new Set(value.map((v) => inferType(v, indent)))];
+    return `(${types.join(" | ")})[]`;
+  }
+  if (typeof value === "object") {
+    const obj = value;
+    const keys = Object.keys(obj);
+    if (keys.length === 0) {
+      return "Record<string, unknown>";
+    }
+    const entries = keys.map((key) => {
+      const safeKey = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key) ? key : JSON.stringify(key);
+      const valueType = inferType(obj[key], indent + 1);
+      return `${innerSpaces}${safeKey}: ${valueType}`;
+    });
+    return `{
+${entries.join("\n")}
+${spaces}}`;
+  }
+  return "unknown";
+}
+function toInterfaceName(key) {
+  const pascal = key.replace(/[^a-zA-Z0-9_$]/g, "_").replace(/_+/g, "_").replace(/^_|_$/g, "").replace(/(^|_)([a-z])/g, (_, __, c) => c.toUpperCase());
+  return pascal || "StaticProp";
+}
+async function emitStaticPropsTypes(outputDir) {
+  const bridgeConfig = readBridgeConfig();
+  const staticProps = bridgeConfig?.staticProps ?? {};
+  const outDir = path.resolve(process.cwd(), outputDir);
+  await fs.promises.mkdir(outDir, { recursive: true });
+  const outFile = path.join(outDir, "static-props.ts");
+  if (Object.keys(staticProps).length === 0) {
+    const emptyBody = `// AUTO-GENERATED by litestar-vite. Do not edit.
+/* eslint-disable */
+
+/**
+ * Static props configured in Python ViteConfig.static_props.
+ * Currently empty - add static_props to your ViteConfig to generate types.
+ *
+ * @example
+ * config = ViteConfig(
+ *     static_props={
+ *         "appName": "My App",
+ *         "version": "1.0.0",
+ *     }
+ * )
+ */
+export interface StaticProps {}
+
+/** All static props */
+export const staticProps: StaticProps = {}
+
+export default staticProps
+`;
+    const result2 = await writeIfChanged(outFile, emptyBody, { encoding: "utf-8" });
+    return result2.changed;
+  }
+  const interfaceProps = [];
+  const namedExports = [];
+  const nestedInterfaces = [];
+  for (const [key, value] of Object.entries(staticProps)) {
+    const safeKey = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key) ? key : JSON.stringify(key);
+    const inferredType = inferType(value, 1);
+    if (typeof value === "object" && value !== null && !Array.isArray(value) && Object.keys(value).length > 0) {
+      const interfaceName = toInterfaceName(key);
+      nestedInterfaces.push(`export interface ${interfaceName} ${inferType(value, 0)}`);
+      interfaceProps.push(`  ${safeKey}: ${interfaceName}`);
+    } else {
+      interfaceProps.push(`  ${safeKey}: ${inferredType}`);
+    }
+    if (/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
+      namedExports.push(`export const ${key} = staticProps.${key}`);
+    }
+  }
+  const body = `// AUTO-GENERATED by litestar-vite. Do not edit.
+/* eslint-disable */
+
+${nestedInterfaces.length > 0 ? `${nestedInterfaces.join("\n\n")}
+
+` : ""}/**
+ * Static props configured in Python ViteConfig.static_props.
+ * These values are set at build time and do not change at runtime.
+ */
+export interface StaticProps {
+${interfaceProps.join("\n")}
+}
+
+/** All static props with inferred types */
+export const staticProps: StaticProps = ${JSON.stringify(staticProps, null, 2)} as const satisfies StaticProps
+
+${namedExports.join("\n")}
+
+export default staticProps
+`;
+  const result = await writeIfChanged(outFile, body, { encoding: "utf-8" });
+  return result.changed;
+}
+export {
+  emitStaticPropsTypes
+};

package/dist/js/shared/typegen-plugin.js

@@ -4,6 +4,7 @@ import colors from "picocolors";
 import { debounce } from "./debounce.js";
 import { emitPagePropsTypes } from "./emit-page-props-types.js";
 import { emitSchemasTypes } from "./emit-schemas-types.js";
+import { emitStaticPropsTypes } from "./emit-static-props-types.js";
 import { formatPath } from "./format-path.js";
 import { shouldRunOpenApiTs, updateOpenApiTsCache } from "./typegen-cache.js";
 import { buildHeyApiPlugins, findOpenApiTsConfig, runHeyApiGeneration } from "./typegen-core.js";
@@ -114,6 +115,17 @@ function createLitestarTypeGenPlugin(typesConfig, options) {
           logger.error(`Schema types generation failed: ${message}`);
         }
       }
+      try {
+        const changed = await emitStaticPropsTypes(typesConfig.output);
+        if (changed) {
+          generated = true;
+        } else {
+          resolvedConfig?.logger.info(`${colors.cyan("\u2022")} Static props types ${colors.dim("(unchanged)")}`);
+        }
+      } catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        logger.error(`Static props generation failed: ${message}`);
+      }
       if (generated && resolvedConfig) {
         const duration = Date.now() - startTime;
         resolvedConfig.logger.info(`${colors.green("\u2713")} TypeScript artifacts updated ${colors.dim(`(${duration}ms)`)}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "litestar-vite-plugin",
-  "version": "0.16.3",
+  "version": "0.17.0",
   "type": "module",
   "description": "Litestar plugin for Vite.",
   "keywords": [
@@ -45,6 +45,9 @@
     "./inertia": {
       "types": "./dist/js/inertia-types.d.ts",
       "import": "./dist/js/inertia-types.js"
+    },
+    "./virtual": {
+      "types": "./dist/js/virtual.d.ts"
     }
   },
   "types": "./dist/js/index.d.ts",
@@ -67,6 +70,9 @@
       ],
       "inertia": [
         "./dist/js/inertia-types.d.ts"
+      ],
+      "virtual": [
+        "./dist/js/virtual.d.ts"
       ]
     }
   },
@@ -84,7 +90,7 @@
     "build-plugin": "rm -rf dist/js && npm run build-plugin-types && npm run build-plugin-esm && npm run build-dev-server",
     "build-dev-server": "vite build --config src/js/src/dev-server/vite.config.ts && mv dist/js/index.html dist/js/dev-server-index.html",
     "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 && esbuild src/js/src/typegen-cli.ts --platform=node --format=esm --outfile=dist/js/typegen-cli.js --banner:js='#!/usr/bin/env node' && mkdir -p dist/js/shared && esbuild src/js/src/shared/bridge-schema.ts src/js/src/shared/constants.ts src/js/src/shared/debounce.ts src/js/src/shared/format-path.ts src/js/src/shared/logger.ts src/js/src/shared/emit-page-props-types.ts src/js/src/shared/emit-schemas-types.ts src/js/src/shared/typegen-plugin.ts src/js/src/shared/typegen-core.ts src/js/src/shared/write-if-changed.ts src/js/src/shared/typegen-cache.ts src/js/src/shared/network.ts --platform=node --format=esm --outdir=dist/js/shared",
+    "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 && esbuild src/js/src/typegen-cli.ts --platform=node --format=esm --outfile=dist/js/typegen-cli.js --banner:js='#!/usr/bin/env node' && mkdir -p dist/js/shared && esbuild src/js/src/shared/bridge-schema.ts src/js/src/shared/constants.ts src/js/src/shared/debounce.ts src/js/src/shared/format-path.ts src/js/src/shared/logger.ts src/js/src/shared/emit-page-props-types.ts src/js/src/shared/emit-schemas-types.ts src/js/src/shared/emit-static-props-types.ts src/js/src/shared/typegen-plugin.ts src/js/src/shared/typegen-core.ts src/js/src/shared/write-if-changed.ts src/js/src/shared/typegen-cache.ts src/js/src/shared/network.ts --platform=node --format=esm --outdir=dist/js/shared",
     "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 src/js/src/inertia-types.ts --platform=node --format=esm --outdir=dist/js",