Plugin#

class litestar_vite.inertia.plugin.InertiaPlugin[source]#

Bases: InitPlugin

Inertia plugin.

This plugin configures Litestar for Inertia.js support, including: - Optional session-backed redirect state - Exception handler for Inertia responses - InertiaRequest and InertiaResponse as default classes - Type encoders for StaticProp and DeferredProp - Shared IPC transport and circuit breaker for SSR

Async Prop Resolution:: Async optional()/defer()/lazy()/once() callbacks are pre-resolved by InertiaResponse on the request event loop before the body is serialized. This guarantees they share the loop with request-scoped async resources (asyncpg/aiosqlite/sqlspec sessions), so callbacks can safely use those resources.

Example:

from litestar_vite.inertia import InertiaPlugin, InertiaConfig

app = Litestar(
    plugins=[InertiaPlugin(InertiaConfig())],
)

__init__(config: InertiaConfig) → None[source]#: Initialize the plugin with Inertia configuration.

lifespan(app: Litestar) → AsyncGenerator[None, None][source]#

Lifespan to manage the shared SSR IPC transport and circuit breaker.

Parameters:: app¶ – The Litestar instance.
Yields:: An asynchronous context manager.

property circuit_breaker: SSRCircuitBreaker | None#: Return the active SSRCircuitBreaker instance.

property ipc_transport: BaseIPCTransport | None#: Return the active BaseIPCTransport instance.

on_app_init(app_config: AppConfig) → AppConfig[source]#

Configure application for use with Vite.

Parameters:: app_config¶ – The AppConfig instance.
Returns:: The AppConfig instance.