litestar-vite-plugin 0.15.0-alpha.6 → 0.15.0-alpha.7

package/dist/js/index.d.ts

@@ -35,6 +35,13 @@ export interface TypesConfig {
      * @default 'routes.json'
      */
     routesPath?: string;
+    /**
+     * Path where Inertia page props metadata is exported by Litestar.
+     * The Vite plugin watches this file for page props type generation.
+     *
+     * @default 'inertia-pages.json'
+     */
+    pagePropsPath?: string;
     /**
      * Generate Zod schemas in addition to TypeScript types.
      *

package/dist/js/index.js

@@ -197,10 +197,7 @@ function resolveLitestarPlugin(pluginConfig) {
       }
       const resourceDir = path.resolve(resolvedConfig.root, pluginConfig.resourceDirectory);
       if (!fs.existsSync(resourceDir) && typeof resolvedConfig.logger?.warn === "function") {
-        resolvedConfig.logger.warn(
-          `${colors.cyan("litestar-vite")} ${colors.yellow("Resource directory not found:")} ${resourceDir}
-  Expected directory: ${colors.dim(pluginConfig.resourceDirectory)}`
-        );
+        resolvedConfig.logger.warn(`${colors.cyan("litestar-vite")} ${colors.yellow("Resource directory not found:")} ${pluginConfig.resourceDirectory}`);
       }
       const hint = pluginConfig.types !== false ? pluginConfig.types.routesPath : void 0;
       litestarMeta = await loadLitestarMeta(resolvedConfig, hint);
@@ -320,12 +317,13 @@ function resolveLitestarPlugin(pluginConfig) {
             res.end(transformedHtml);
             return;
           } catch (e) {
-            resolvedConfig.logger.error(`Error serving index.html from ${indexPath}: ${e instanceof Error ? e.message : e}`);
+            const relIndexPath = path.relative(server.config.root, indexPath);
+            resolvedConfig.logger.error(`Error serving index.html from ${relIndexPath}: ${e instanceof Error ? e.message : e}`);
             next(e);
             return;
           }
         }
-        if (!indexPath && req.url === "/index.html") {
+        if (!indexPath && (req.url === "/" || req.url === "/index.html")) {
           try {
             const placeholderPath = path.join(dirname(), "dev-server-index.html");
             const placeholderContent = await fs.promises.readFile(placeholderPath, "utf-8");
@@ -474,6 +472,7 @@ function resolvePluginConfig(config) {
       output: "src/generated/types",
       openapiPath: "src/generated/openapi.json",
       routesPath: "src/generated/routes.json",
+      pagePropsPath: "src/generated/inertia-pages.json",
       generateZod: false,
       generateSdk: false,
       debounce: 300
@@ -485,6 +484,7 @@ function resolvePluginConfig(config) {
         output: pythonDefaults.types.output,
         openapiPath: pythonDefaults.types.openapiPath,
         routesPath: pythonDefaults.types.routesPath,
+        pagePropsPath: pythonDefaults.types.pagePropsPath ?? path.join(pythonDefaults.types.output, "inertia-pages.json"),
         generateZod: pythonDefaults.types.generateZod,
         generateSdk: pythonDefaults.types.generateSdk,
         debounce: 300
@@ -493,11 +493,13 @@ function resolvePluginConfig(config) {
   } else if (typeof resolvedConfig.types === "object" && resolvedConfig.types !== null) {
     const userProvidedOpenapi = Object.hasOwn(resolvedConfig.types, "openapiPath");
     const userProvidedRoutes = Object.hasOwn(resolvedConfig.types, "routesPath");
+    const userProvidedPageProps = Object.hasOwn(resolvedConfig.types, "pagePropsPath");
     typesConfig = {
       enabled: resolvedConfig.types.enabled ?? true,
       output: resolvedConfig.types.output ?? "src/generated/types",
       openapiPath: resolvedConfig.types.openapiPath ?? (resolvedConfig.types.output ? path.join(resolvedConfig.types.output, "openapi.json") : "src/generated/openapi.json"),
       routesPath: resolvedConfig.types.routesPath ?? (resolvedConfig.types.output ? path.join(resolvedConfig.types.output, "routes.json") : "src/generated/routes.json"),
+      pagePropsPath: resolvedConfig.types.pagePropsPath ?? (resolvedConfig.types.output ? path.join(resolvedConfig.types.output, "inertia-pages.json") : "src/generated/inertia-pages.json"),
       generateZod: resolvedConfig.types.generateZod ?? false,
       generateSdk: resolvedConfig.types.generateSdk ?? false,
       debounce: resolvedConfig.types.debounce ?? 300
@@ -508,6 +510,9 @@ function resolvePluginConfig(config) {
     if (!userProvidedRoutes && resolvedConfig.types.output) {
       typesConfig.routesPath = path.join(typesConfig.output, "routes.json");
     }
+    if (!userProvidedPageProps && resolvedConfig.types.output) {
+      typesConfig.pagePropsPath = path.join(typesConfig.output, "inertia-pages.json");
+    }
   }
   return {
     input: resolvedConfig.input,
@@ -564,6 +569,154 @@ function resolveFullReloadConfig({ refresh: config }) {
     return plugin;
   });
 }
+async function emitPagePropsTypes(pagesPath, outputDir) {
+  const contents = await fs.promises.readFile(pagesPath, "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, "page-props.ts");
+  const { includeDefaultAuth, includeDefaultFlash } = json.typeGenConfig;
+  let userTypes = "";
+  let authTypes = "";
+  let flashTypes = "";
+  if (includeDefaultAuth) {
+    userTypes = `/**
+ * Default User interface - minimal baseline for common auth patterns.
+ * Users extend this via module augmentation with their full user model.
+ *
+ * @example
+ * declare module 'litestar-vite/inertia' {
+ *   interface User {
+ *     avatarUrl?: string | null
+ *     roles: Role[]
+ *     teams: Team[]
+ *   }
+ * }
+ */
+export interface User {
+  id: string
+  email: string
+  name?: string | null
+}
+
+`;
+    authTypes = `/**
+ * Default AuthData interface - mirrors Laravel Jetstream pattern.
+ * isAuthenticated + optional user is the universal pattern.
+ */
+export interface AuthData {
+  isAuthenticated: boolean
+  user?: User
+}
+
+`;
+  } else {
+    userTypes = `/**
+ * User interface - define via module augmentation.
+ * Default auth types are disabled.
+ *
+ * @example
+ * declare module 'litestar-vite/inertia' {
+ *   interface User {
+ *     uuid: string
+ *     username: string
+ *   }
+ * }
+ */
+export interface User {}
+
+`;
+    authTypes = `/**
+ * AuthData interface - define via module augmentation.
+ * Default auth types are disabled.
+ */
+export interface AuthData {}
+
+`;
+  }
+  if (includeDefaultFlash) {
+    flashTypes = `/**
+ * Default FlashMessages interface - category to messages mapping.
+ * Standard categories: success, error, info, warning.
+ */
+export interface FlashMessages {
+  [category: string]: string[]
+}
+
+`;
+  } else {
+    flashTypes = `/**
+ * FlashMessages interface - define via module augmentation.
+ * Default flash types are disabled.
+ */
+export interface FlashMessages {}
+
+`;
+  }
+  const sharedPropsContent = includeDefaultAuth || includeDefaultFlash ? `  auth?: AuthData
+  flash?: FlashMessages` : "";
+  const pageEntries = [];
+  for (const [component, data] of Object.entries(json.pages)) {
+    const propsType = data.propsType ? data.propsType : "Record<string, unknown>";
+    pageEntries.push(`  "${component}": ${propsType} & FullSharedProps`);
+  }
+  const body = `// AUTO-GENERATED by litestar-vite. Do not edit.
+/* eslint-disable */
+
+${userTypes}${authTypes}${flashTypes}/**
+ * Generated shared props (always present).
+ * Includes built-in props + static config props.
+ */
+export interface GeneratedSharedProps {
+  errors?: Record<string, string[]>
+  csrf_token?: string
+}
+
+/**
+ * User-defined shared props for dynamic share() calls in guards/middleware.
+ * Extend this interface via module augmentation.
+ *
+ * @example
+ * declare module 'litestar-vite/inertia' {
+ *   interface User {
+ *     avatarUrl?: string | null
+ *     roles: Role[]
+ *     teams: Team[]
+ *   }
+ *   interface SharedProps {
+ *     locale?: string
+ *     currentTeam?: CurrentTeam
+ *   }
+ * }
+ */
+export interface SharedProps {
+${sharedPropsContent}
+}
+
+/** Full shared props = generated + user-defined */
+export type FullSharedProps = GeneratedSharedProps & SharedProps
+
+/** Page props mapped by component name */
+export interface PageProps {
+${pageEntries.join("\n")}
+}
+
+/** Component name union type */
+export type ComponentName = keyof PageProps
+
+/** Type-safe props for a specific component */
+export type InertiaPageProps<C extends ComponentName> = PageProps[C]
+
+/** Get props type for a specific page component */
+export type PagePropsFor<C extends ComponentName> = PageProps[C]
+
+// Re-export for module augmentation
+declare module "litestar-vite/inertia" {
+  export { User, AuthData, FlashMessages, SharedProps, GeneratedSharedProps, FullSharedProps, PageProps, ComponentName, InertiaPageProps, PagePropsFor }
+}
+`;
+  await fs.promises.writeFile(outFile, body, "utf-8");
+}
 async function emitRouteTypes(routesPath, outputDir) {
   const contents = await fs.promises.readFile(routesPath, "utf-8");
   const json = JSON.parse(contents);
@@ -689,6 +842,7 @@ export { getCsrfToken, csrfHeaders, csrfFetch } from "litestar-vite-plugin/helpe
 function resolveTypeGenerationPlugin(typesConfig, executor, hasPythonConfig) {
   let lastTypesHash = null;
   let lastRoutesHash = null;
+  let lastPagePropsHash = null;
   let server = null;
   let isGenerating = false;
   let resolvedConfig = null;
@@ -703,6 +857,7 @@ function resolveTypeGenerationPlugin(typesConfig, executor, hasPythonConfig) {
       const projectRoot = resolvedConfig?.root ?? process.cwd();
       const openapiPath = path.resolve(projectRoot, typesConfig.openapiPath);
       const routesPath = path.resolve(projectRoot, typesConfig.routesPath);
+      const pagePropsPath = path.resolve(projectRoot, typesConfig.pagePropsPath);
       let generated = false;
       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;
@@ -711,7 +866,8 @@ function resolveTypeGenerationPlugin(typesConfig, executor, hasPythonConfig) {
       if (fs.existsSync(openapiPath) && shouldRunOpenApiTs) {
         resolvedConfig?.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("generating TypeScript types...")}`);
         if (resolvedConfig) {
-          resolvedConfig.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("openapi-ts config: ")}${configPath ?? "<built-in defaults>"}`);
+          const relConfigPath = configPath ? path.relative(resolvedConfig.root, configPath) : null;
+          resolvedConfig.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("openapi-ts config: ")}${relConfigPath ?? "<built-in defaults>"}`);
         }
         const sdkOutput = path.join(typesConfig.output, "api");
         let args;
@@ -746,6 +902,10 @@ function resolveTypeGenerationPlugin(typesConfig, executor, hasPythonConfig) {
         await emitRouteTypes(routesPath, typesConfig.output);
         generated = true;
       }
+      if (fs.existsSync(pagePropsPath)) {
+        await emitPagePropsTypes(pagePropsPath, typesConfig.output);
+        generated = true;
+      }
       if (generated && resolvedConfig) {
         const duration = Date.now() - startTime;
         resolvedConfig.logger.info(`${colors.cyan("litestar-vite")} ${colors.green("TypeScript artifacts updated")} ${colors.dim(`in ${duration}ms`)}`);
@@ -789,11 +949,12 @@ function resolveTypeGenerationPlugin(typesConfig, executor, hasPythonConfig) {
       server = devServer;
       if (typesConfig.enabled) {
         const root = resolvedConfig?.root ?? process.cwd();
-        const openapiAbs = path.resolve(root, typesConfig.openapiPath);
-        const routesAbs = path.resolve(root, typesConfig.routesPath);
-        resolvedConfig?.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("watching schema/routes:")} ${colors.yellow(openapiAbs)}, ${colors.yellow(routesAbs)}`);
+        const openapiRel = typesConfig.openapiPath;
+        const routesRel = typesConfig.routesPath;
+        resolvedConfig?.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("watching schema/routes:")} ${colors.yellow(openapiRel)}, ${colors.yellow(routesRel)}`);
         if (chosenConfigPath) {
-          resolvedConfig?.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("openapi-ts config:")} ${colors.yellow(chosenConfigPath)}`);
+          const relConfigPath = path.relative(root, chosenConfigPath);
+          resolvedConfig?.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("openapi-ts config:")} ${colors.yellow(relConfigPath)}`);
         }
       }
     },
@@ -831,17 +992,24 @@ Solutions:
       const relativePath = path.relative(root, file);
       const openapiPath = typesConfig.openapiPath.replace(/^\.\//, "");
       const routesPath = typesConfig.routesPath.replace(/^\.\//, "");
-      if (relativePath === openapiPath || relativePath === routesPath || file.endsWith(openapiPath) || file.endsWith(routesPath)) {
+      const pagePropsPath = typesConfig.pagePropsPath.replace(/^\.\//, "");
+      const isOpenapi = relativePath === openapiPath || file.endsWith(openapiPath);
+      const isRoutes = relativePath === routesPath || file.endsWith(routesPath);
+      const isPageProps = relativePath === pagePropsPath || file.endsWith(pagePropsPath);
+      if (isOpenapi || isRoutes || isPageProps) {
         if (resolvedConfig) {
           resolvedConfig.logger.info(`${colors.cyan("litestar-vite")} ${colors.dim("schema changed:")} ${colors.yellow(relativePath)}`);
         }
         const newHash = await hashFile(file);
-        if (relativePath === openapiPath) {
+        if (isOpenapi) {
           if (lastTypesHash === newHash) return;
           lastTypesHash = newHash;
-        } else {
+        } else if (isRoutes) {
           if (lastRoutesHash === newHash) return;
           lastRoutesHash = newHash;
+        } else if (isPageProps) {
+          if (lastPagePropsHash === newHash) return;
+          lastPagePropsHash = newHash;
         }
         debouncedRunTypeGeneration();
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "litestar-vite-plugin",
-  "version": "0.15.0-alpha.6",
+  "version": "0.15.0-alpha.7",
   "type": "module",
   "description": "Litestar plugin for Vite.",
   "keywords": [