litestar-vite 0.11.1__py3-none-any.whl → 0.12.0__py3-none-any.whl

litestar_vite/commands.py

@@ -14,7 +14,7 @@ DEFAULT_RESOURCES: set[str] = {"styles.css.j2", "main.ts.j2"}
 DEFAULT_DEV_DEPENDENCIES: dict[str, str] = {
     "typescript": "^5.7.2",
     "vite": "^6.0.3",
-    "litestar-vite-plugin": "^0.11.1",
+    "litestar-vite-plugin": "^0.12.0",
     "@types/node": "^22.10.1",
 }
 DEFAULT_DEPENDENCIES: dict[str, str] = {"axios": "^1.7.2"}

litestar_vite/inertia/plugin.py

@@ -2,18 +2,8 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from litestar.exceptions import ImproperlyConfiguredException
-from litestar.middleware import DefineMiddleware
-from litestar.middleware.session import SessionMiddleware
+from anyio.from_thread import BlockingPortalProvider
 from litestar.plugins import InitPluginProtocol
-from litestar.security.session_auth.middleware import MiddlewareWrapper
-from litestar.utils.predicates import is_class_and_subclass
-
-from litestar_vite.inertia.exception_handler import exception_to_http_response
-from litestar_vite.inertia.middleware import InertiaMiddleware
-from litestar_vite.inertia.request import InertiaRequest
-from litestar_vite.inertia.response import InertiaResponse
-from litestar_vite.inertia.routes import generate_js_routes
 
 if TYPE_CHECKING:
     from litestar import Litestar
@@ -24,6 +14,8 @@ if TYPE_CHECKING:
 
 def set_js_routes(app: Litestar) -> None:
     """Generate the route structure of the application on startup."""
+    from litestar_vite.inertia.routes import generate_js_routes
+
     js_routes = generate_js_routes(app)
     app.state.js_routes = js_routes
 
@@ -31,7 +23,7 @@ def set_js_routes(app: Litestar) -> None:
 class InertiaPlugin(InitPluginProtocol):
     """Inertia plugin."""
 
-    __slots__ = ("config",)
+    __slots__ = ("config", "portal")
 
     def __init__(self, config: InertiaConfig) -> None:
         """Initialize ``Inertia``.
@@ -41,12 +33,29 @@ class InertiaPlugin(InitPluginProtocol):
         """
         self.config = config
 
+        self.portal = BlockingPortalProvider()
+
+    def get_portal(self) -> BlockingPortalProvider:
+        return self.portal
+
     def on_app_init(self, app_config: AppConfig) -> AppConfig:
         """Configure application for use with Vite.
 
         Args:
             app_config: The :class:`AppConfig <litestar.config.app.AppConfig>` instance.
         """
+
+        from litestar.exceptions import ImproperlyConfiguredException
+        from litestar.middleware import DefineMiddleware
+        from litestar.middleware.session import SessionMiddleware
+        from litestar.security.session_auth.middleware import MiddlewareWrapper
+        from litestar.utils.predicates import is_class_and_subclass
+
+        from litestar_vite.inertia.exception_handler import exception_to_http_response
+        from litestar_vite.inertia.middleware import InertiaMiddleware
+        from litestar_vite.inertia.request import InertiaRequest
+        from litestar_vite.inertia.response import DeferredProp, InertiaBack, InertiaResponse, StaticProp
+
         for mw in app_config.middleware:
             if isinstance(mw, DefineMiddleware) and is_class_and_subclass(
                 mw.middleware,
@@ -61,4 +70,15 @@ class InertiaPlugin(InitPluginProtocol):
         app_config.response_class = InertiaResponse
         app_config.middleware.append(InertiaMiddleware)
         app_config.on_startup.append(set_js_routes)
+        app_config.signature_types.extend([InertiaRequest, InertiaResponse, InertiaBack, StaticProp, DeferredProp])
+        app_config.type_encoders = {
+            StaticProp: lambda val: val.render(),
+            DeferredProp: lambda val: val.render(),
+            **(app_config.type_encoders or {}),
+        }
+        app_config.type_decoders = [
+            (lambda x: x is StaticProp, lambda t, v: t(v)),
+            (lambda x: x is DeferredProp, lambda t, v: t(v)),
+            *(app_config.type_decoders or []),
+        ]
         return app_config

litestar_vite/inertia/response.py

@@ -1,14 +1,31 @@
 from __future__ import annotations
 
+import inspect
 import itertools
 from collections import defaultdict
+from collections.abc import Mapping
+from contextlib import contextmanager
 from functools import lru_cache
 from mimetypes import guess_type
 from pathlib import PurePath
 from textwrap import dedent
-from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Mapping, TypeVar, cast
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Coroutine,
+    Dict,
+    Generator,
+    Generic,
+    Iterable,
+    List,
+    TypeVar,
+    cast,
+    overload,
+)
 from urllib.parse import quote, urlparse, urlunparse
 
+from anyio.from_thread import BlockingPortal, start_blocking_portal
 from litestar import Litestar, MediaType, Request, Response
 from litestar.datastructures.cookie import Cookie
 from litestar.exceptions import ImproperlyConfiguredException
@@ -21,6 +38,7 @@ from litestar.utils.empty import value_or_default
 from litestar.utils.helpers import get_enum_string_value
 from litestar.utils.scope.state import ScopeState
 from markupsafe import Markup
+from typing_extensions import ParamSpec, TypeGuard
 
 from litestar_vite.inertia._utils import get_headers
 from litestar_vite.inertia.types import InertiaHeaderType, PageProps
@@ -33,53 +51,224 @@ if TYPE_CHECKING:
     from litestar.connection.base import AuthT, StateT, UserT
     from litestar.types import ResponseCookies, ResponseHeaders, TypeEncodersMap
 
+    from litestar_vite.inertia.plugin import InertiaPlugin
     from litestar_vite.inertia.routes import Routes
 
-    from .plugin import InertiaPlugin
-
 T = TypeVar("T")
+T_ParamSpec = ParamSpec("T_ParamSpec")
+PropKeyT = TypeVar("PropKeyT", bound=str)
+StaticT = TypeVar("StaticT", bound=object)
 
 
-def share(
-    connection: ASGIConnection[Any, Any, Any, Any],
+@overload
+def lazy(key: str, value_or_callable: None) -> StaticProp[str, None]: ...
+
+
+@overload
+def lazy(key: str, value_or_callable: T) -> StaticProp[str, T]: ...
+
+
+@overload
+def lazy(
     key: str,
-    value: Any,
-) -> None:
-    try:
-        connection.session.setdefault("_shared", {}).update({key: value})
-    except (AttributeError, ImproperlyConfiguredException):
-        msg = "Unable to set `share` session state.  A valid session was not found for this request."
-        connection.logger.warning(msg)
+    value_or_callable: Callable[..., None] = ...,
+) -> DeferredProp[str, None]: ...
 
 
-def error(
-    connection: ASGIConnection[Any, Any, Any, Any],
+@overload
+def lazy(
     key: str,
-    message: str,
-) -> None:
-    try:
-        connection.session.setdefault("_errors", {}).update({key: message})
-    except (AttributeError, ImproperlyConfiguredException):
-        msg = "Unable to set `error` session state.  A valid session was not found for this request."
-        connection.logger.warning(msg)
+    value_or_callable: Callable[T_ParamSpec, T | Coroutine[Any, Any, T]] = ...,  # pyright: ignore[reportInvalidTypeVarUse]
+) -> DeferredProp[str, T]: ...
+
+
+def lazy(  # type: ignore[misc]
+    key: str,
+    value_or_callable: T | Callable[T_ParamSpec, T | Coroutine[Any, Any, T]],  # pyright: ignore[reportInvalidTypeVarUse]
+) -> StaticProp[str, None] | StaticProp[str, T] | DeferredProp[str, T] | DeferredProp[str, None]:
+    """Wrap an async function to return a DeferredProp."""
+    if value_or_callable is None:
+        return StaticProp[str, None](key=key, value=None)
+
+    if not callable(value_or_callable):
+        return StaticProp[str, T](key=key, value=value_or_callable)
+
+    return DeferredProp[str, T](key=key, value=value_or_callable)  # pyright: ignore[reportArgumentType]
+
+
+class StaticProp(Generic[PropKeyT, StaticT]):
+    """A wrapper for static property evaluation."""
+
+    def __init__(self, key: PropKeyT, value: StaticT) -> None:
+        self._key = key
+        self._result = value
+
+    @property
+    def key(self) -> PropKeyT:
+        return self._key
+
+    def render(self, portal: BlockingPortal | None = None) -> StaticT:
+        return self._result
+
+
+class DeferredProp(Generic[PropKeyT, T]):
+    """A wrapper for deferred property evaluation."""
+
+    def __init__(self, key: PropKeyT, value: Callable[T_ParamSpec, T | Coroutine[Any, Any, T]] | None = None) -> None:
+        self._key = key
+        self._value = value
+        self._evaluated = False
+        self._result: T | None = None
+
+    @property
+    def key(self) -> PropKeyT:
+        return self._key
+
+    @staticmethod
+    def _is_awaitable(
+        v: Callable[T_ParamSpec, T | Coroutine[Any, Any, T]],
+    ) -> TypeGuard[Coroutine[Any, Any, T]]:
+        return inspect.iscoroutinefunction(v)
+
+    @staticmethod
+    @contextmanager
+    def _with_portal(portal: BlockingPortal | None = None) -> Generator[BlockingPortal, None, None]:
+        if portal is None:
+            with start_blocking_portal() as new_portal:
+                yield new_portal
+        else:
+            yield portal
+
+    def render(self, portal: BlockingPortal | None = None) -> T | None:
+        if self._evaluated:
+            return self._result
+        if self._value is None or not callable(self._value):
+            self._result = self._value
+        elif not self._is_awaitable(self._value):
+            self._result = self._value()  # type: ignore[call-arg,assignment,unused-ignore]
+        else:
+            with self._with_portal(portal) as bp:
+                self._result = bp.call(self._value)  # type: ignore[call-overload]
+        self._evaluated = True
+        return self._result  # pyright: ignore[reportUnknownVariableType,reportUnknownMemberType]
+
+
+def is_lazy_prop(value: Any) -> TypeGuard[DeferredProp[Any, Any]]:
+    """Check if value is a deferred property.
+
+    Args:
+        value: Any value to check
+
+    Returns:
+        bool: True if value is a deferred property
+    """
+    return isinstance(value, (DeferredProp, StaticProp))
+
+
+def should_render(value: Any, partial_data: set[str] | None = None) -> bool:
+    """Check if value should be rendered.
+
+    Args:
+        value: Any value to check
+        partial_data: Optional set of keys for partial rendering
+
+    Returns:
+        bool: True if value should be rendered
+    """
+    partial_data = partial_data or set()
+    if is_lazy_prop(value):
+        return value.key in partial_data
+    return True
+
+
+def is_or_contains_lazy_prop(value: Any) -> bool:
+    """Check if value is or contains a deferred property.
+
+    Args:
+        value: Any value to check
+
+    Returns:
+        bool: True if value is or contains a deferred property
+    """
+    if is_lazy_prop(value):
+        return True
+    if isinstance(value, str):
+        return False
+    if isinstance(value, Mapping):
+        return any(is_or_contains_lazy_prop(v) for v in cast("Mapping[str, Any]", value).values())
+    if isinstance(value, Iterable):
+        return any(is_or_contains_lazy_prop(v) for v in cast("Iterable[Any]", value))
+    return False
+
+
+def lazy_render(value: T, partial_data: set[str] | None = None, portal: BlockingPortal | None = None) -> T:
+    """Filter deferred properties from the value based on partial data.
+
+    Args:
+        value: The value to filter
+        partial_data: Keys for partial rendering
+        portal: Optional portal to use for async rendering
+    Returns:
+        The filtered value
+    """
+    partial_data = partial_data or set()
+    if isinstance(value, str):
+        return cast("T", value)
+    if isinstance(value, Mapping):
+        return cast(
+            "T",
+            {
+                k: lazy_render(v, partial_data)
+                for k, v in cast("Mapping[str, Any]", value).items()
+                if should_render(v, partial_data)
+            },
+        )
+
+    if isinstance(value, (list, tuple)):
+        filtered = [
+            lazy_render(v, partial_data) for v in cast("Iterable[Any]", value) if should_render(v, partial_data)
+        ]
+        return cast("T", type(value)(filtered))  # pyright: ignore[reportUnknownArgumentType]
+
+    if is_lazy_prop(value) and should_render(value, partial_data):
+        return cast("T", value.render())
+
+    return cast("T", value)
 
 
 def get_shared_props(
     request: ASGIConnection[Any, Any, Any, Any],
     partial_data: set[str] | None = None,
-) -> Dict[str, Any]:  # noqa: UP006
-    """Return shared session props for a request
+) -> dict[str, Any]:
+    """Return shared session props for a request.
+
+    Args:
+        request: The ASGI connection.
+        partial_data: Optional set of keys for partial rendering.
 
+    Returns:
+        Dict[str, Any]: The shared props.
 
-    Be sure to call this before `self.create_template_context` if you would like to include the `flash` message details.
+    Note:
+        Be sure to call this before `self.create_template_context` if you would like to include the `flash` message details.
     """
     props: dict[str, Any] = {}
     flash: dict[str, list[str]] = defaultdict(list)
     errors: dict[str, Any] = {}
     error_bag = request.headers.get("X-Inertia-Error-Bag", None)
+
     try:
         errors = request.session.pop("_errors", {})
-        props.update(cast("Dict[str,Any]", request.session.pop("_shared", {})))
+        shared_props = cast("Dict[str,Any]", request.session.pop("_shared", {}))
+
+        # Handle deferred props
+        for key, value in shared_props.items():
+            if is_lazy_prop(value) and should_render(value, partial_data):
+                props[key] = value.render()
+                continue
+            if should_render(value, partial_data):
+                props[key] = value
+
         for message in cast("List[Dict[str,Any]]", request.session.pop("_messages", [])):
             flash[message["category"]].append(message["message"])
 
@@ -92,12 +281,51 @@ def get_shared_props(
     except (AttributeError, ImproperlyConfiguredException):
         msg = "Unable to generate all shared props.  A valid session was not found for this request."
         request.logger.warning(msg)
+
     props["flash"] = flash
     props["errors"] = {error_bag: errors} if error_bag is not None else errors
     props["csrf_token"] = value_or_default(ScopeState.from_scope(request.scope).csrf_token, "")
     return props
 
 
+def share(
+    connection: ASGIConnection[Any, Any, Any, Any],
+    key: str,
+    value: Any,
+) -> None:
+    """Share a value in the session.
+
+    Args:
+        connection: The ASGI connection.
+        key: The key to store the value under.
+        value: The value to store.
+    """
+    try:
+        connection.session.setdefault("_shared", {}).update({key: value})
+    except (AttributeError, ImproperlyConfiguredException):
+        msg = "Unable to set `share` session state.  A valid session was not found for this request."
+        connection.logger.warning(msg)
+
+
+def error(
+    connection: ASGIConnection[Any, Any, Any, Any],
+    key: str,
+    message: str,
+) -> None:
+    """Set an error message in the session.
+
+    Args:
+        connection: The ASGI connection.
+        key: The key to store the error under.
+        message: The error message.
+    """
+    try:
+        connection.session.setdefault("_errors", {}).update({key: message})
+    except (AttributeError, ImproperlyConfiguredException):
+        msg = "Unable to set `error` session state.  A valid session was not found for this request."
+        connection.logger.warning(msg)
+
+
 def js_routes_script(js_routes: Routes) -> Markup:
     @lru_cache
     def _markup_safe_json_dumps(js_routes: str) -> Markup:
@@ -197,7 +425,7 @@ class InertiaResponse(Response[T]):
             "csrf_input": f'<input type="hidden" name="_csrf_token" value="{csrf_token}" />',
         }
 
-    def to_asgi_response(
+    def to_asgi_response(  # noqa: C901, PLR0912
         self,
         app: Litestar | None,
         request: Request[UserT, AuthT, StateT],
@@ -250,7 +478,13 @@ class InertiaResponse(Response[T]):
             {"Vary": "Accept", **get_headers(InertiaHeaderType(enabled=True))},
         )
         shared_props = get_shared_props(request, partial_data=partial_keys if is_partial_render else None)
-        shared_props["content"] = self.content
+        if is_or_contains_lazy_prop(self.content):
+            filtered_content = lazy_render(self.content, partial_keys if is_partial_render else None)
+            if filtered_content is not None:
+                shared_props["content"] = filtered_content
+        elif should_render(self.content, partial_keys):
+            shared_props["content"] = self.content
+
         page_props = PageProps[T](
             component=request.inertia.route_component,  # type: ignore[attr-defined] # pyright: ignore[reportUnknownArgumentType,reportUnknownMemberType,reportAttributeAccessIssue]
             props=shared_props,  # pyright: ignore[reportArgumentType]

{litestar_vite-0.11.1.dist-info → litestar_vite-0.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: litestar-vite
-Version: 0.11.1
+Version: 0.12.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -10,6 +10,7 @@ Project-URL: Issue, https://github.com/cofin/litestar-vite/issues/
 Project-URL: Source, https://github.com/cofin/litestar-vite
 Author-email: Cody Fincher <cody.fincher@gmail.com>
 License: MIT
+License-File: LICENSE
 Keywords: litestar,vite
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers

{litestar_vite-0.11.1.dist-info → litestar_vite-0.12.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 litestar_vite/__init__.py,sha256=OioNGhH88mdivQlFz9JlbJV8R6wyjSYE3c8C-RIM4Ls,277
 litestar_vite/__metadata__.py,sha256=_Wo-vNQuj5co9J4FwJAB2rRafbFo8ztTHrXmEPrYrV8,514
 litestar_vite/cli.py,sha256=CBSRohDLU9cDeKMAfSbFiw1x8OE_b15ZlUaxji9Rdw8,10749
-litestar_vite/commands.py,sha256=E-PaU7Hk9BDj63d8u7-FSwR8oH9hfSB41BGOpmVuv3o,5228
+litestar_vite/commands.py,sha256=JTRBvpR_3ddFb2o4-AJSELegw-ZGDsJ_yMaT5FVdp4w,5228
 litestar_vite/config.py,sha256=cZWIwTwNnBYScCty8OxxPaOL8cELx57dm7JQeV8og3Y,4565
 litestar_vite/loader.py,sha256=nrXL2txXoBZEsdLZnysgBYZSreMXQ7ckLuNcu7MqnSM,10277
 litestar_vite/plugin.py,sha256=2ypzvlW5TaOeXTWPa2yHXzkPUf4okRBDl9YHo2qg-cM,8043
@@ -11,9 +11,9 @@ litestar_vite/inertia/_utils.py,sha256=ijO9Lgka7ZPIAHkby9szbTGoSg0nDShC2bqWT9cDx
 litestar_vite/inertia/config.py,sha256=0Je9SLg0acv0eRvudk3aJLj5k1DjPxULoVOwAfpjnUc,1232
 litestar_vite/inertia/exception_handler.py,sha256=0FiW8jVib0xT453BzMPOeJa7bRwnxkOUdJ91kiFHPIo,5308
 litestar_vite/inertia/middleware.py,sha256=23HfQ8D2wNGXUXt_isuGfZ8AFKrr1d_498qGFLynocs,1650
-litestar_vite/inertia/plugin.py,sha256=OgXmmvjl7KWlt4KEkYhS3mU2EY4iYN9JtJ20S3Qlht8,2349
+litestar_vite/inertia/plugin.py,sha256=f2oFwlEDt9WZ8zt-AqiCIRPlkHIyzLtPYYo8WJZX-tI,3186
 litestar_vite/inertia/request.py,sha256=Ogt_ikauWrsgKafaip7IL1YhbybwjdBAQ0PQS7cImoQ,3848
-litestar_vite/inertia/response.py,sha256=drOn8wdxEhoffPJLBpLGqEX1UJVgSOL-qbsTR3bJG2M,16222
+litestar_vite/inertia/response.py,sha256=CY-qziEPc9FZ4oXxtgO0Iipg1Hz4x-fiUeLK04Br8kM,23425
 litestar_vite/inertia/routes.py,sha256=QksJm2RUfL-WbuhOieYnPXXWO5GYnPtmsYEm6Ef8Yeo,1782
 litestar_vite/inertia/types.py,sha256=tLp0pm1N__hcWC875khf6wH1nuFlKS9-VjDqgsRkXnw,702
 litestar_vite/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -23,7 +23,7 @@ litestar_vite/templates/package.json.j2,sha256=0JWgdTuaSZ25EmCltF_zbqDdpxfvCLeYu
 litestar_vite/templates/styles.css.j2,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 litestar_vite/templates/tsconfig.json.j2,sha256=q1REIuVyXUHCy4Zi2kgTkmrhdT98vyY89k-WTrImOj8,843
 litestar_vite/templates/vite.config.ts.j2,sha256=bF5kOPFafYMkhhV0VkIwetN-_zoVMGVM1jEMX_wKoNc,1037
-litestar_vite-0.11.1.dist-info/METADATA,sha256=_qb3u3hyEBieCsfpMOPNBSjCPRfX8JH9tt0UyJOxh5Y,6222
-litestar_vite-0.11.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-litestar_vite-0.11.1.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
-litestar_vite-0.11.1.dist-info/RECORD,,
+litestar_vite-0.12.0.dist-info/METADATA,sha256=0Nv7ZBioTYS6JTE0KzPht82kwBhcBGH7W1cBRB8vgCM,6244
+litestar_vite-0.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+litestar_vite-0.12.0.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
+litestar_vite-0.12.0.dist-info/RECORD,,

{litestar_vite-0.11.1.dist-info → litestar_vite-0.12.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any