Vite Plugin & Core Types¶

The litestar-vite-plugin npm package ships 18 typed ESM entrypoints covering the Vite 7+ plugin, runtime helpers, framework bindings, meta-framework integrations, and server/island fragment adapters. This page documents the root Vite plugin (litestar-vite-plugin), base Inertia ambient types (litestar-vite-plugin/inertia), and the virtual:litestar-static-props ambient module (litestar-vite-plugin/virtual).

litestar-vite-plugin¶

Package Subpath: . · Types: ./dist/js/index.d.ts · Source: src/js/src/index.ts

PluginConfig¶

export interface PluginConfig

RefreshConfig¶

export interface RefreshConfig

ResolvedPluginConfig¶

export interface ResolvedPluginConfig extends Omit<Required<PluginConfig>, "types" | "executor" | "inertiaMode" | "deployAssetUrl">

Resolved plugin configuration with all defaults applied. Note: types is resolved to RequiredTypeGenConfig | false instead of boolean | TypesConfig Note: executor remains optional - undefined means auto-detect from env Note: inertiaMode is resolved to boolean (auto-detected from .litestar.json Inertia metadata)

TypesConfig¶

export type TypesConfig = TypesConfigShape

Configuration for TypeScript type generation.

DevServerUrl¶

export type DevServerUrl = `${"http" | "https"}://${string}:${number}`

litestar¶

export default function litestar(config: string | string[] | PluginConfig): any[]

Litestar plugin for Vite.

litestarViteSsrPlugin¶

export function litestarViteSsrPlugin(options: DevSsrOptions = {}): Plugin

DevSsrOptions¶

export interface DevSsrOptions

SsrRenderRequest¶

export interface SsrRenderRequest

SsrRenderResponse¶

export interface SsrRenderResponse

litestar-vite-plugin/inertia¶

Package Subpath: ./inertia · Types: ./dist/js/inertia-types.d.ts · Source: src/js/src/inertia-types.ts

Base types for Inertia.js type generation.

User¶

export interface User

User interface - customize in page-props.user.ts

AuthData¶

export interface AuthData

Authentication data interface

FlashMessages¶

export interface FlashMessages

Flash messages interface

SharedProps¶

export interface SharedProps

User-defined shared props - customize in page-props.user.ts

GeneratedSharedProps¶

export interface GeneratedSharedProps

Generated shared props (populated by page-props.ts)

PageProps¶

export interface PageProps

Page props mapped by component name (populated by page-props.ts)

FullSharedProps¶

export type FullSharedProps = GeneratedSharedProps & SharedProps & { [key: string]: unknown }

Full shared props = generated + user-defined

ComponentName¶

export type ComponentName = keyof PageProps

Component name union type

InertiaPageProps¶

export type InertiaPageProps<C extends ComponentName> = PageProps[C]

Type-safe props for a specific component

PagePropsFor¶

export type PagePropsFor<C extends ComponentName> = PageProps[C]

Get props type for a specific page component

litestar-vite-plugin/virtual¶

Package Subpath: ./virtual · Types: ./dist/js/virtual.d.ts · Source: src/js/src/virtual.d.ts

Type declarations for litestar-vite virtual modules.

StaticProps¶

export interface StaticProps

Static props configured in Python ViteConfig.static_props.

virtual:litestar-static-props¶

declare module "virtual:litestar-static-props"

Vite virtual module exposing static props configured in Python ViteConfig.static_props.