Litestar Vite Type Generation

Overview

Generate deterministic, typed artifacts from the Python backend and consume them in TypeScript.

Quick Start

Python config (enable type generation in ViteConfig):

from litestar_vite import TypeGenConfig, ViteConfig

vite_config = ViteConfig(
    types=TypeGenConfig(
        enabled=True,
        generate_sdk=True,
        generate_routes=True,
        generate_page_props=True,
        generate_schemas=True,
        output="src/generated",
    ),
)

Generate artifacts:

litestar assets generate-types
litestar assets export-routes

Key Outputs and Defaults

• output: src/generated
• openapi_path: src/generated/openapi.json
• routes_path: src/generated/routes.json
• routes_ts_path: src/generated/routes.ts
• schemas_ts_path: src/generated/schemas.ts
• page_props_path: src/generated/inertia-pages.json

TypeGenConfig Knobs

• generate_zod: emit Zod schemas (optional)
• generate_sdk: emit TS client SDK
• generate_routes: emit type-safe routes.ts
• generate_page_props: emit Inertia page props metadata
• generate_schemas: emit schemas.ts
• global_route: global route helper (optional)
• fallback_type: fallback for unknown schema types
• type_import_paths: custom TS import paths

Inertia Type Generation

Use InertiaTypeGenConfig when you need default shared props:

• include_default_auth
• include_default_flash

Frontend Consumption Patterns

Routes

import { route } from '../generated/routes';

const url = route('users:get', { id: 123 });

Schemas

import type { components } from '../generated/schemas';

type User = components['schemas']['User'];

Page Props (Inertia)

Use the generated Inertia metadata to keep page props typed and in sync with server props.

Determinism and Write-on-Change

• Generated files are deterministic and only written when content changes.
• If files change unexpectedly, check for non-deterministic fields or route ordering changes.

Troubleshooting

• If generated files are missing, confirm types.enabled is true.
• If outputs are in unexpected paths, check TypeGenConfig overrides.
• If the frontend cannot resolve generated imports, verify output matches TS path expectations.

Related Files

• src/py/litestar_vite/codegen/
• src/py/litestar_vite/config/
• src/js/src/shared/typegen-core.ts
• src/js/src/shared/typegen-plugin.ts
• specs/guides/architecture.md