litestar-vite 0.1.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

litestar_vite-0.15.0.dist-info/METADATA

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: litestar-vite
+Version: 0.15.0
+Summary: Vite plugin for Litestar
+Project-URL: Changelog, https://litestar-org.github.io/litestar-vite/latest/changelog
+Project-URL: Discord, https://discord.gg/X3FJqy8d2j
+Project-URL: Documentation, https://litestar-org.github.io/litestar-vite/latest/
+Project-URL: Homepage, https://litestar-org.github.io/litestar-vite/latest/
+Project-URL: Issue, https://github.com/litestar-org/litestar-vite/issues/
+Project-URL: Source, https://github.com/litestar-org/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
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.24.1
+Requires-Dist: litestar>=2.7.0
+Requires-Dist: typing-extensions
+Requires-Dist: websockets>=12.0
+Provides-Extra: http2
+Requires-Dist: h2>=4.0.0; extra == 'http2'
+Provides-Extra: jinja
+Requires-Dist: jinja2; extra == 'jinja'
+Provides-Extra: nodeenv
+Requires-Dist: nodeenv; extra == 'nodeenv'
+Description-Content-Type: text/markdown
+
+# Litestar Vite
+
+Litestar Vite connects the Litestar backend to a Vite toolchain. It supports SPA, Template, and Inertia flows, and can proxy Vite dev traffic through your ASGI port or run Vite directly.
+
+## Features
+
+- One-port dev: proxies Vite HTTP + WS/HMR through Litestar by default; switch to two-port with `VITE_PROXY_MODE=direct`.
+- SSR framework support: use `mode="ssr"` for Astro, Nuxt, SvelteKit - proxies everything except your API routes.
+- Production assets: reads Vite manifest from `public/manifest.json` (configurable) and serves under `asset_url`.
+- Type-safe frontends: optional OpenAPI/routes export + `@hey-api/openapi-ts` via the Vite plugin.
+- Inertia support: v2 protocol with session middleware and optional SPA mode.
+
+## Quick Start (SPA)
+
+```bash
+pip install litestar-vite
+```
+
+```python
+import os
+from pathlib import Path
+from litestar import Litestar
+from litestar_vite import VitePlugin, ViteConfig, PathConfig
+
+DEV_MODE = os.getenv("VITE_DEV_MODE", "true").lower() in ("true", "1", "yes")
+
+app = Litestar(
+    plugins=[VitePlugin(config=ViteConfig(
+        dev_mode=DEV_MODE,
+        paths=PathConfig(root=Path(__file__).parent),
+    ))]
+)
+```
+
+```bash
+litestar run --reload  # Vite dev server is proxied automatically
+```
+
+Scaffold a frontend: `litestar assets init --template vue` (or `react`, `svelte`, `htmx`, `react-inertia`, `vue-inertia`, `angular`, `astro`, `nuxt`, `sveltekit`).
+
+## Development
+
+To contribute or run the development project:
+
+```bash
+# Install all dependencies and build packages
+make install && make build
+
+# Install frontend dependencies for an example
+uv run litestar --app-dir examples/vue-inertia assets install
+
+# Run the development server
+uv run litestar --app-dir examples/vue-inertia run
+```
+
+Replace `vue-inertia` with any other example: `vue`, `react`, `svelte`, `react-inertia`, `htmx`, `angular`, `astro`, `nuxt`, or `sveltekit`.
+
+## Template / HTMX
+
+```python
+from pathlib import Path
+from litestar import Litestar
+from litestar.contrib.jinja import JinjaTemplateEngine
+from litestar.template import TemplateConfig
+from litestar_vite import VitePlugin, ViteConfig, PathConfig
+
+here = Path(__file__).parent
+
+app = Litestar(
+    template_config=TemplateConfig(directory=here / "templates", engine=JinjaTemplateEngine),
+    plugins=[VitePlugin(config=ViteConfig(
+        dev_mode=True,
+        paths=PathConfig(root=here),
+    ))],
+)
+```
+
+## Inertia (v2)
+
+Requires session middleware (32-char secret).
+
+```python
+import os
+from pathlib import Path
+from litestar import Litestar
+from litestar.middleware.session.client_side import CookieBackendConfig
+from litestar_vite import VitePlugin, ViteConfig, PathConfig
+from litestar_vite.inertia import InertiaConfig
+
+here = Path(__file__).parent
+SECRET_KEY = os.environ.get("SECRET_KEY", "development-only-secret-32-chars")
+session = CookieBackendConfig(secret=SECRET_KEY.encode("utf-8"))
+
+app = Litestar(
+    middleware=[session.middleware],
+    plugins=[VitePlugin(config=ViteConfig(
+        dev_mode=True,
+        paths=PathConfig(root=here),
+        inertia=InertiaConfig(root_template="index.html"),
+    ))],
+)
+```
+
+## Meta-frameworks (Astro, Nuxt, SvelteKit)
+
+Use `mode="ssr"` (or `mode="framework"`) to proxy non-API routes to the framework's dev server:
+
+```python
+import os
+from pathlib import Path
+from litestar import Litestar
+from litestar_vite import VitePlugin, ViteConfig, PathConfig
+
+here = Path(__file__).parent
+DEV_MODE = os.getenv("VITE_DEV_MODE", "true").lower() in ("true", "1", "yes")
+
+app = Litestar(
+    plugins=[
+        VitePlugin(config=ViteConfig(
+            mode="ssr",
+            dev_mode=DEV_MODE,
+            paths=PathConfig(root=here),
+        ))
+    ],
+)
+```
+
+### Proxy Modes
+
+| Mode | Alias | Use Case |
+|------|-------|----------|
+| `vite` | - | SPAs - proxies Vite assets only (default) |
+| `direct` | - | Two-port dev - expose Vite port directly |
+| `proxy` | `ssr` | Meta-frameworks - proxies everything except API routes |
+
+### Production Deployment
+
+**Astro (static):** Astro generates static HTML by default. Build and serve with Litestar:
+
+```bash
+litestar --app-dir examples/astro assets install
+litestar --app-dir examples/astro assets build
+VITE_DEV_MODE=false litestar --app-dir examples/astro run
+```
+
+**Nuxt/SvelteKit (SSR):** These run their own Node servers. Deploy as two services:
+
+```bash
+# Terminal 1: SSR server
+litestar --app-dir examples/nuxt assets build
+litestar --app-dir examples/nuxt assets serve
+
+# Terminal 2: Litestar API
+VITE_DEV_MODE=false litestar --app-dir examples/nuxt run --port 8001
+```
+
+## Type generation
+
+```python
+VitePlugin(config=ViteConfig(types=True))  # enable exports
+```
+
+```bash
+litestar assets generate-types  # one-off or CI
+```
+
+## CLI cheat sheet
+
+- `litestar assets doctor` — diagnose/fix config
+- `litestar assets init --template react|vue|svelte|...` — scaffold frontend
+- `litestar assets build` / `serve` — build or watch
+- `litestar assets deploy --storage gcs://bucket/assets` — upload via fsspec
+- `litestar assets generate-types` — OpenAPI + routes → TS types
+- `litestar assets install` — install frontend deps with the configured executor
+
+### Doctor command highlights
+
+- Prints Python vs Vite config snapshot (asset URLs, bundle/hot paths, ports, modes).
+- Flags missing hot file (dev proxy), missing manifest (prod), type-gen exports, env/config mismatches, and plugin install issues.
+- `--fix` can rewrite simple vite.config values (assetUrl, bundleDir, hotFile, type paths) after creating a backup.
+
+## Links
+
+- Docs: <https://litestar-org.github.io/litestar-vite/>
+- Examples: `examples/` (react, vue, svelte, react-inertia, vue-inertia, astro, nuxt, sveltekit, htmx)
+- Real-world example: [litestar-fullstack](https://github.com/litestar-org/litestar-fullstack) - Full-featured application using litestar-vite
+- Issues: <https://github.com/litestar-org/litestar-vite/issues/>

litestar_vite-0.15.0.dist-info/RECORD

@@ -0,0 +1,164 @@
+litestar_vite/__init__.py,sha256=6z2O7JKG-PplQmFczzTyW862wkOrW4M_xm1VI47bHHM,1421
+litestar_vite/__metadata__.py,sha256=dMGIPS6M11LcmiEfnMJJrbSPH8Lf00pU8crIIUsIBPw,478
+litestar_vite/cli.py,sha256=b-vEKyphvA1IpqNkM75xTC2CoRAR5MvfJpNOrzL8ST8,39343
+litestar_vite/commands.py,sha256=A2h5a9wdPPfv62P8CtvzJlG1RViTEFaMzEEAogh_Z6Y,2470
+litestar_vite/deploy.py,sha256=2scl2WAI7VttUk-PVCSD7BJB3Ryndfpha93BrZUwZ4I,12251
+litestar_vite/doctor.py,sha256=_fScfKrwRvfbPtdcuaPAGyGQGl1iUlkDVtRzY6dWzs0,47301
+litestar_vite/exceptions.py,sha256=9PfOfC1eLxY3ZmMBCxv1NLAbkREMz5BZzpPgVbgYfTA,2651
+litestar_vite/executor.py,sha256=sckMrixPullgPm1QnMSlvMzB7MYbD5Yq9CAZRaUxKyg,12536
+litestar_vite/html_transform.py,sha256=gZrKAd3s6gEaz7P9nCU-0GFaOo0tj4poKD3T1tzi6UQ,20988
+litestar_vite/loader.py,sha256=Z4q7SmI0X-HTIL2HqaKE3SGotBMRIVDFb2MouWB9t2E,18492
+litestar_vite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litestar_vite/codegen/__init__.py,sha256=606DhmDtOTFD_4ohST1d20oU6NE0cC1_J2tCrXD2qj8,1667
+litestar_vite/codegen/_export.py,sha256=lLEHly9YNp-K8GYwI4epxD3L3QIF9oLPuculsuEsDGU,8647
+litestar_vite/codegen/_inertia.py,sha256=DceTgMtK7jC5_YZehXgYNtBEZ8oZpL9dYbZCqdiQEAc,24126
+litestar_vite/codegen/_openapi.py,sha256=ln8F80gOLt_6b0mfwNcx8sM0hbmG414nCDL5DA6Uc8s,10353
+litestar_vite/codegen/_routes.py,sha256=JdKVm_4ur-GTnaeIBqQ2mPMvz7Fn7UWxxWopb1oRZmQ,24955
+litestar_vite/codegen/_ts.py,sha256=T0BQyLuE4BIju688o95hnCvqSjCufyRBbijx5cB0xTY,7940
+litestar_vite/codegen/_utils.py,sha256=zNPRV0IbgAXSy0MkM4e6iruebyiIJI3BPaisKSs-6HA,4990
+litestar_vite/config/__init__.py,sha256=q0WUB1Jb2XUR_Q_Q0jscPJUUtLfdJ7RHWf-_j8Bvr4g,34375
+litestar_vite/config/_constants.py,sha256=a1heIM2-2vERJ5NPVZpnSqaaeXOl06YeHODAvs_Ni90,2379
+litestar_vite/config/_deploy.py,sha256=USASwxh4WE0N8hRzcPBIqDSF81keznrnxrfff93_hcQ,3103
+litestar_vite/config/_inertia.py,sha256=r_8LkvOeORIjfJWh6iJk1hh8ibcwSv7UkzoNeQNLPuA,9177
+litestar_vite/config/_paths.py,sha256=TpniHT7kWZ4_O2gY4mXFokHiVsdBWtqXGNPzKdbWCEE,2827
+litestar_vite/config/_runtime.py,sha256=fmxAEAS4w19int3-89siihDH3yt591LM_GPYV26yc3k,9840
+litestar_vite/config/_spa.py,sha256=tPPl8XM_8-dFtbB8xIHBDcxzieJynVsyMRJv8Ph9Hvc,3330
+litestar_vite/config/_types.py,sha256=TuQiGtL-Up4nrGM0zYQskrOgh9kRW0HpHYm-EaNqywM,4199
+litestar_vite/handler/__init__.py,sha256=B01DmuRKV6QJMfy_LrLQuFvf8mZ7BE8nDyX0ZQLJLVA,218
+litestar_vite/handler/_app.py,sha256=a2hTDgtNatKEr4BlC3yCESweFp4rdboVz6T2XRfZvzM,23783
+litestar_vite/handler/_routing.py,sha256=rHO7zsWOtFgQ1-A02BGh-QU3vEvze9MvUGIqPiF8jTs,4540
+litestar_vite/inertia/__init__.py,sha256=3u880UBcZwq42bGvpeHZmxsw7LItW1IXeK_CGoan1I0,1893
+litestar_vite/inertia/_utils.py,sha256=aSP37Z0VmIHoYoNgne2uPBR8EYtkGHpnggeytklhDj0,3154
+litestar_vite/inertia/exception_handler.py,sha256=HLFnl5jSxonCoz4pRRO0ChbtdiBtcDXm9-7cjHDwmDQ,7803
+litestar_vite/inertia/helpers.py,sha256=syCOMPthz1kcAVvteUHY1o-_ttwgXSSD6KGKtZbQ8UU,52734
+litestar_vite/inertia/middleware.py,sha256=GIwOl_KZyI6KAJ2VY4aK_WZiPM1F_LSgdH3yRFgkm1M,1998
+litestar_vite/inertia/plugin.py,sha256=5qDdnBcaFs8_wVzzfZa6W9JeZBFIKYvT2sclh-0JsSs,8362
+litestar_vite/inertia/precognition.py,sha256=DzeEJUBxKqxY4uxP8hLuj0Xb2c4Bbw5nIyvubZmKRcg,10476
+litestar_vite/inertia/request.py,sha256=uASJ0NTrbNlnWSvIrjjHL0HBdLTnKo6dY7aHotCgz-E,10916
+litestar_vite/inertia/response.py,sha256=CtMJ2ZyA53wM3nlQgaQ_3BwpWoxMO5teQSMIYs-C53Y,33726
+litestar_vite/inertia/types.py,sha256=dwYML3yLVrJ0EZExE4_p00aXvlLtzkuSrkKVLKrcK28,10694
+litestar_vite/plugin/__init__.py,sha256=FpnQj_kJ80EdJtea125On5oDzODrNUW69ZaNFSP2huU,26269
+litestar_vite/plugin/_process.py,sha256=OV04ft6u22H-arIp0Kwj5b6Z7SccydLk3IyXibZgIq0,7012
+litestar_vite/plugin/_proxy.py,sha256=cTgnRB8lfYk1ZzZ_Bubhcpjj_LO5K99Ek0n1gV30Q0w,26574
+litestar_vite/plugin/_proxy_headers.py,sha256=gPCFVJkccQYWkw_jjPHfTQHxVfezRW3jK9l8NPZdAOM,9613
+litestar_vite/plugin/_static.py,sha256=4Bzn4i8GTHDpaUtG7KcqqbvgW4o10m7BNTKwL1YLJp0,1421
+litestar_vite/plugin/_utils.py,sha256=Eh19QtwomASRFJ-ec3UnDAjqBTn3MnfakINWQ9XBifc,16035
+litestar_vite/scaffolding/__init__.py,sha256=3MkLZtAjyZYHh7THWYZF5HFsxXHHT9t3_pcF8zwL07g,652
+litestar_vite/scaffolding/generator.py,sha256=Y1PPT1-u-ujgaJ4aD43IdcnI_hal75HjsdOINNeCm8w,9172
+litestar_vite/scaffolding/templates.py,sha256=kX2jNmmddy48YqYQFdcMcWBaAo3IbGzEDcTYAgyVzcs,14371
+litestar_vite/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litestar_vite/templates/addons/tailwindcss/tailwind.css.j2,sha256=QgcOC0W7IBsrg4pSqqpull-WTgtULZfx_lF_5ZxLdag,23
+litestar_vite/templates/angular/index.html.j2,sha256=lEnI1yFMq2BGK_cxnHwFnhx6rfHbsdFzdid0clsJM1o,319
+litestar_vite/templates/angular/openapi-ts.config.ts.j2,sha256=bsnHZ9GiNk98_BK1V0G02cNHUHwtbgINzWr0zuu3mHg,400
+litestar_vite/templates/angular/package.json.j2,sha256=zMOsRLWYKuAxSMCLb683uCS3oW3QcwBAHlUgFcsElSA,873
+litestar_vite/templates/angular/tsconfig.app.json.j2,sha256=O1STsrXFeL-TM1z4zv7l38hGK3LgV7wtflN2zfdb_V4,988
+litestar_vite/templates/angular/tsconfig.json.j2,sha256=aB2V5FFJXYvJWHccnLTcxjYr8aH6Ffxc0dVqOPueBZI,491
+litestar_vite/templates/angular/vite.config.ts.j2,sha256=7mN399dErmChKLhRDXovHBMuTaagyu6Am8PUoneyhGY,600
+litestar_vite/templates/angular/src/main.ts.j2,sha256=GoGPeumY5SN3DZj7pbD3ct8_d6V5pVlc_-1Sk5Y7ips,327
+litestar_vite/templates/angular/src/styles.css.j2,sha256=ok41iiQlpVywb0lohl0x1HVAiPq19PX_6u8pEPDZvxM,242
+litestar_vite/templates/angular/src/app/app.component.css.j2,sha256=7CyJ_ekTyv90G6oLDzz2iprLXoVGfk8htsgk_a0gE5Q,28
+litestar_vite/templates/angular/src/app/app.component.html.j2,sha256=JtDZXjjOC8_g1GDMGiN8GCxkki8rGnfS2g_HpRD5RXs,14
+litestar_vite/templates/angular/src/app/app.component.ts.j2,sha256=SGbzdLsv_bijTbt6vCGF5rBLx4s3vixX-P9IB8GmAK8,207
+litestar_vite/templates/angular/src/app/app.config.ts.j2,sha256=vSMNCRyDqIIjIHUTZoa6mhjW1PrEeeKjpEkqrZtsFRA,123
+litestar_vite/templates/angular-cli/.postcssrc.json.j2,sha256=bJanvszoCUi1KJeoloqBVkTXDb5kcieuYnqcyg7curs,54
+litestar_vite/templates/angular-cli/angular.json.j2,sha256=XboCBhSihwkpQjbowuUJPqjfbQ3U2tP_3qg9AHnZ5pw,1092
+litestar_vite/templates/angular-cli/openapi-ts.config.ts.j2,sha256=bsnHZ9GiNk98_BK1V0G02cNHUHwtbgINzWr0zuu3mHg,400
+litestar_vite/templates/angular-cli/package.json.j2,sha256=DNvg8m-3jiSfIXHXzMnJ6A8PRXRb2AbOI3Rwy9QAVNY,670
+litestar_vite/templates/angular-cli/proxy.conf.json.j2,sha256=63K860aZoEizF4BsL-dUjguko0VfsNRdVvjQ3wG1b94,337
+litestar_vite/templates/angular-cli/tailwind.config.js.j2,sha256=uZ_nSmbT7e4kVeX5IggRM_q10ZLRPaqk0aypUOubdbE,100
+litestar_vite/templates/angular-cli/tsconfig.app.json.j2,sha256=oNNNykaLX3mVSnzreqTm1HeUyH6O5qKb4mBMBNULJc0,416
+litestar_vite/templates/angular-cli/tsconfig.json.j2,sha256=T2mVozneR2j34lBHB-pkpJ22CSEoN7f3lNmgYFJ9u9g,716
+litestar_vite/templates/angular-cli/tsconfig.spec.json.j2,sha256=Vt3nU6jZ_u1L8QELTX8KDwl4tVduRJ6S-EEd_BjXq-g,192
+litestar_vite/templates/angular-cli/src/index.html.j2,sha256=1MUNk69gJtKhc4hb3jSWiQaay7V6fZ66ACfvbLRJRhI,332
+litestar_vite/templates/angular-cli/src/main.ts.j2,sha256=71dZCa10Rw_gd3bbTkige2RFKGP5W7PIVjc4nUHvILY,248
+litestar_vite/templates/angular-cli/src/styles.css.j2,sha256=JW-NAUrCgTYsijNRWhOeuMPyYp0QMk2QPptpGB6-h_g,243
+litestar_vite/templates/angular-cli/src/app/app.component.css.j2,sha256=7CyJ_ekTyv90G6oLDzz2iprLXoVGfk8htsgk_a0gE5Q,28
+litestar_vite/templates/angular-cli/src/app/app.component.html.j2,sha256=JtDZXjjOC8_g1GDMGiN8GCxkki8rGnfS2g_HpRD5RXs,14
+litestar_vite/templates/angular-cli/src/app/app.component.ts.j2,sha256=SGbzdLsv_bijTbt6vCGF5rBLx4s3vixX-P9IB8GmAK8,207
+litestar_vite/templates/angular-cli/src/app/app.config.ts.j2,sha256=vSMNCRyDqIIjIHUTZoa6mhjW1PrEeeKjpEkqrZtsFRA,123
+litestar_vite/templates/astro/astro.config.mjs.j2,sha256=iV3C-g7vuJOhqeZ5CFXJQRArPFL59N-jgcctSOMDT7o,854
+litestar_vite/templates/astro/openapi-ts.config.ts.j2,sha256=SLbesyZvl5tDPy-e3wR2tcPYcQI2Osq21S8G5zS_T5w,356
+litestar_vite/templates/astro/src/layouts/Layout.astro.j2,sha256=fBwznyNapGZJgcGHBLmLvMjxuPsZ5ssPU_Ooae2oXJw,1252
+litestar_vite/templates/astro/src/pages/index.astro.j2,sha256=f8zErww-qoLHLxR7g5Ac7YFlx6LJJ2WrXyVQU56ICMw,626
+litestar_vite/templates/astro/src/styles/global.css.j2,sha256=oxYbL_6aNdNc9gc0BKFQdxZ0ZYxbtyiuf7k-1O0KnLA,49
+litestar_vite/templates/base/.gitignore.j2,sha256=NeAMLX5IAWbNw_HlBma846zKEaQEVbQN-iO9akBuOKk,355
+litestar_vite/templates/base/openapi-ts.config.ts.j2,sha256=tBS4wDuPZOtxXKiod7ZNi1v93uaATIEdd-UZ6H9TPVE,356
+litestar_vite/templates/base/package.json.j2,sha256=FJhhApMQy8UK-CjeaGEzLkWdmSnSq8mXxbYu-TnWP1M,1124
+litestar_vite/templates/base/tsconfig.json.j2,sha256=oLXhTh1ULIGka2aiTyyTRnRTzXgMyvPekPbBbH23VwU,1069
+litestar_vite/templates/base/resources/vite-env.d.ts.j2,sha256=ZZlpNvuwQpFfe3SiAPzd5-QQ8ypmmxq5WXz6pLD63bU,38
+litestar_vite/templates/htmx/vite.config.ts.j2,sha256=BVPMU1VADecUNIRbL2E9-9NLWvekak1aihyyVXr-U6g,865
+litestar_vite/templates/htmx/src/main.js.j2,sha256=F0qsnUECff7SBdYSF4eM087H04XH3uzjYo701T1nXb4,176
+litestar_vite/templates/htmx/templates/base.html.j2.j2,sha256=I8IUuSvADnKhyxbuTTMIDtCcLrVv2vIc8aoPAVCh6YU,1395
+litestar_vite/templates/htmx/templates/index.html.j2.j2,sha256=Lx7i_pdR5UaEUGTWpxsxBCXaU1Ppm9ZBP1wJROP1Icc,367
+litestar_vite/templates/nuxt/app.vue.j2,sha256=iiHHOzTsXiLau4o6al-W4fkubWNoFq4ImU47hUFZrKQ,551
+litestar_vite/templates/nuxt/nuxt.config.ts.j2,sha256=uW6_4zt-DvYrSxVDyQIeNOlfe3aFzai4PhO_p3SJdJ8,982
+litestar_vite/templates/nuxt/openapi-ts.config.ts.j2,sha256=ttFYDARQhtgZo5y1RPfJDm0n8GYsERKv8KtHs14K9hU,317
+litestar_vite/templates/nuxt/composables/useApi.ts.j2,sha256=G6Oqi9VMzquLPwkDVV3IsljGpUV6OycdlS-l1tXdbzI,905
+litestar_vite/templates/nuxt/pages/index.vue.j2,sha256=LxC7s_N-qXZhjdzW6-77_fGDxIbpVzJkEUvlnkOoCaA,851
+litestar_vite/templates/react/index.html.j2,sha256=vJQk1SeeL8zj7eh_R5Z9hulPhVqGogiC9wys72vff_I,382
+litestar_vite/templates/react/vite.config.ts.j2,sha256=4yoCesOaPcipOVV82AneKaBQHjz4rsBBD0PcKoTpDO0,811
+litestar_vite/templates/react/src/App.css.j2,sha256=OxIIilAjaaZ9J5bhJ-bybunK6GgEaCootwYL-sdghrM,987
+litestar_vite/templates/react/src/App.tsx.j2,sha256=eTMcZCisXmjPDTxlvl9mv0_mVmRaNS4ctfK07NjKgmM,392
+litestar_vite/templates/react/src/main.tsx.j2,sha256=jn5402e-IPzroxfS25upeLPtvd8aJod_pGHaYUVWKDU,228
+litestar_vite/templates/react-inertia/index.html.j2,sha256=UI0OvfKMFHwz7KNyLa9lxHGK3Dhrd-L6vtsiEu4PklM,449
+litestar_vite/templates/react-inertia/package.json.j2,sha256=W_TQJUW2SwVNFgDrI5WaAYI4sB-bGbiq8Kd3Qtni_I4,1334
+litestar_vite/templates/react-inertia/vite.config.ts.j2,sha256=2CWY1i_U7RcLM-HMCkGeAlDN0doc9UcW-xVPpHzPEzw,1150
+litestar_vite/templates/react-inertia/resources/App.css.j2,sha256=TPVP6MVH2zEgSR7enDt-AXj4LUnDIoMu7NvLoWC8xAY,1056
+litestar_vite/templates/react-inertia/resources/main.tsx.j2,sha256=GZsP-KJ42HvI_XOHb7dcOGlhG_6EGZqzmT-45gos-a4,500
+litestar_vite/templates/react-inertia/resources/ssr.tsx.j2,sha256=_vfiqA3_Dzma0omyjFfM7qqBDhmOz241NGZSLNsVHkE,614
+litestar_vite/templates/react-inertia/resources/pages/Home.tsx.j2,sha256=S1XAbXKFymCt3WSC_qayE5YA2btSG7S-XwTpF-jYa1k,375
+litestar_vite/templates/react-router/index.html.j2,sha256=M7mULWfMMDN_V7usfKw2v2Iw2-e-fuwn0-AIuOxaL6o,319
+litestar_vite/templates/react-router/vite.config.ts.j2,sha256=4yoCesOaPcipOVV82AneKaBQHjz4rsBBD0PcKoTpDO0,811
+litestar_vite/templates/react-router/src/App.css.j2,sha256=oKhbDtTpOdIQGI4llLwf6NPiGPx4h9FhzdvVpywlNHQ,346
+litestar_vite/templates/react-router/src/App.tsx.j2,sha256=uUzE_BV5THUCn2xIHo2DJJP9W8ADGsCY9yGbN0PWZik,119
+litestar_vite/templates/react-router/src/main.tsx.j2,sha256=6sAB4YrC8wyRYEFdfYegClpVvh4WT79yxwxV7HQ3NeA,227
+litestar_vite/templates/react-tanstack/index.html.j2,sha256=M7mULWfMMDN_V7usfKw2v2Iw2-e-fuwn0-AIuOxaL6o,319
+litestar_vite/templates/react-tanstack/openapi-ts.config.ts.j2,sha256=BdrmDeRh0dKHVyJOEBYNxNfDkivr5w_oF5o1v14HXlE,404
+litestar_vite/templates/react-tanstack/vite.config.ts.j2,sha256=7jTZ5quvBDSnBFqQZ7-R8Of5H4TtHKUbS1ZtDLFo1lA,870
+litestar_vite/templates/react-tanstack/src/App.css.j2,sha256=oKhbDtTpOdIQGI4llLwf6NPiGPx4h9FhzdvVpywlNHQ,346
+litestar_vite/templates/react-tanstack/src/main.tsx.j2,sha256=aRh7VWjNojS6V-pMTddoK2HxCz51FLoP-Ojtst5emvI,569
+litestar_vite/templates/react-tanstack/src/routeTree.gen.ts.j2,sha256=E7frsgniLGgl3jUkINs8KJJhy6wIIl0lNJA6XzIKzDg,294
+litestar_vite/templates/react-tanstack/src/routes/__root.tsx.j2,sha256=FH2STyfqDJGmtJPdcwGpK6IQVBdBcdpWIIrrqrD4lL0,176
+litestar_vite/templates/react-tanstack/src/routes/books.tsx.j2,sha256=VlChNKb4ggK8NRvOrshw-tzB4agdtem2Rr3YsSlcR38,186
+litestar_vite/templates/react-tanstack/src/routes/index.tsx.j2,sha256=8aVZrx0MV5m_qYRzSGRS-kcjCjil9uWUZ4bqzFPVmsQ,181
+litestar_vite/templates/svelte/index.html.j2,sha256=LW991plBL1vlU7tdoyJ-5aB54NztbKDCOXX-N3SK7ok,380
+litestar_vite/templates/svelte/svelte.config.js.j2,sha256=J7deVkC7BMu73RMcfX0LJxidaQgEMPNdDunarZzpmTA,116
+litestar_vite/templates/svelte/vite.config.ts.j2,sha256=6GqupB_dqHllrsi4Cglwc7cRIq7bCiKW8LVRBCR86Jk,824
+litestar_vite/templates/svelte/src/App.svelte.j2,sha256=D0LAFvgqLakIM192CYOIETNNtwaMQTZ4nIOjEacSrMc,444
+litestar_vite/templates/svelte/src/app.css.j2,sha256=danFuvZ3cTKGCS-GumMTlpxpqocQ_9rE80nDPdHOcwk,872
+litestar_vite/templates/svelte/src/main.ts.j2,sha256=4rroqhfFf5cqn6adcC-0MvvEGTt16yCJnPmIA-Aexh0,143
+litestar_vite/templates/svelte/src/vite-env.d.ts.j2,sha256=zJwBq4LNhm1ZaxEChjeihMPMpLEV0qpaAsMdLFmXf8E,71
+litestar_vite/templates/svelte-inertia/index.html.j2,sha256=kEucsfi-lVPR151vAhjxyC6rdrU2-2VhegTqmK2Ptjs,448
+litestar_vite/templates/svelte-inertia/svelte.config.js.j2,sha256=J7deVkC7BMu73RMcfX0LJxidaQgEMPNdDunarZzpmTA,116
+litestar_vite/templates/svelte-inertia/vite.config.ts.j2,sha256=RfC11aqGLEaKxuXoCRY_hYPuggXWl739fPDtvh0Nb14,768
+litestar_vite/templates/svelte-inertia/resources/app.css.j2,sha256=iGKzknt04zJ29-zIdThkszGnTQe-C2pdyt6zAT_3rdE,462
+litestar_vite/templates/svelte-inertia/resources/main.ts.j2,sha256=jP5KTQRn1jQLdn-70AypUxghSDs1wRi5p60i6Nufv74,346
+litestar_vite/templates/svelte-inertia/resources/vite-env.d.ts.j2,sha256=zJwBq4LNhm1ZaxEChjeihMPMpLEV0qpaAsMdLFmXf8E,71
+litestar_vite/templates/svelte-inertia/resources/pages/Home.svelte.j2,sha256=QGOmxp2Y8-HxW1LXJJVDjVdeYqMVwUn0c43nrFe6Tao,740
+litestar_vite/templates/sveltekit/openapi-ts.config.ts.j2,sha256=MpSEEQwJQ2zz-6wg_2kRsBVshoDYk1vS87i2xwEWMvQ,334
+litestar_vite/templates/sveltekit/svelte.config.js.j2,sha256=dvoVhI4FP-PlIf4tkKuXAt-m9J8OouN-nNWew45mrFA,270
+litestar_vite/templates/sveltekit/tsconfig.json.j2,sha256=Su4tOAJKM9eEI7rHcGxAjf_ya85j0Eigym1-2UQnnhw,363
+litestar_vite/templates/sveltekit/vite.config.ts.j2,sha256=l3buMnky7psThMwBfHUcgv7FIiyA5Ge5_G2AQqeNep4,942
+litestar_vite/templates/sveltekit/src/app.css.j2,sha256=pkFVaARbo97abjGZ60dCjLPi_VdFrOo7xHnqDQI_IsY,786
+litestar_vite/templates/sveltekit/src/app.html.j2,sha256=5FiwObWMDo2rDaxGG4-5BFPGj0_lO1NKHMOEsLR1mkc,360
+litestar_vite/templates/sveltekit/src/hooks.server.ts.j2,sha256=JeIKNDzctwlKqvbBq3yFBcACYSG6sCPh_HFmyLsPPLY,2239
+litestar_vite/templates/sveltekit/src/routes/+layout.svelte.j2,sha256=fKXQZNrYOURUPPTmiBo9F7crDLxwudh3-tQ2g9P_5aM,202
+litestar_vite/templates/sveltekit/src/routes/+page.svelte.j2,sha256=AXTPN9l_k1_zITu3hP_DHYE17EDChVdDA95th0AX0YU,504
+litestar_vite/templates/vue/env.d.ts.j2,sha256=FEzWdKE_58QVLmJj7EhACflloL4h4hxr9qCr6z8xjLU,189
+litestar_vite/templates/vue/index.html.j2,sha256=LW991plBL1vlU7tdoyJ-5aB54NztbKDCOXX-N3SK7ok,380
+litestar_vite/templates/vue/vite.config.ts.j2,sha256=KXXZhYxRCQ8YKwElTATXbT7d1L0yUwe2_fEFKPA1YrA,804
+litestar_vite/templates/vue/src/App.vue.j2,sha256=K8Zano4I_CZUQkCe16JIYPi2QMkpYj_576y1Lhr8Zb4,469
+litestar_vite/templates/vue/src/main.ts.j2,sha256=Qaecy31EDctV3TooxqYgVsWbTod9n8vhfJzV1_u-LBQ,115
+litestar_vite/templates/vue/src/style.css.j2,sha256=dynk8iHiXQgZHAnsBxMPxoyewP4P5s5ebliXVC95xVw,872
+litestar_vite/templates/vue-inertia/env.d.ts.j2,sha256=FEzWdKE_58QVLmJj7EhACflloL4h4hxr9qCr6z8xjLU,189
+litestar_vite/templates/vue-inertia/index.html.j2,sha256=kEucsfi-lVPR151vAhjxyC6rdrU2-2VhegTqmK2Ptjs,448
+litestar_vite/templates/vue-inertia/package.json.j2,sha256=FK-cG8ZCmYXFfvakGxkdxB_wrV8bBaY3yDw-rYksjjw,1471
+litestar_vite/templates/vue-inertia/vite.config.ts.j2,sha256=vWK9Ur43tY3c_g_9RPMvzRt1_pgiFU-7seYLMaoiBXY,1142
+litestar_vite/templates/vue-inertia/resources/main.ts.j2,sha256=6wi8R1QXY_fS1WDCgup1vaDtXSswtgYY-tWWzEVIumE,526
+litestar_vite/templates/vue-inertia/resources/ssr.ts.j2,sha256=ptxNGMv8mBDVLYzozpTZWfp2vYXLM_OmfXRDjbJD8l0,686
+litestar_vite/templates/vue-inertia/resources/style.css.j2,sha256=iGKzknt04zJ29-zIdThkszGnTQe-C2pdyt6zAT_3rdE,462
+litestar_vite/templates/vue-inertia/resources/pages/Home.vue.j2,sha256=wcTvXgjQZ9CxQ6aTWp95w6YS6pE1RD-BITy1lJtBmrU,702
+litestar_vite-0.15.0.dist-info/METADATA,sha256=TRaiAryEAoGS9ODyqiEJn6ZF_eMBVqLTQvKDabO58D8,7674
+litestar_vite-0.15.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+litestar_vite-0.15.0.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
+litestar_vite-0.15.0.dist-info/RECORD,,

{litestar_vite-0.1.1.dist-info → litestar_vite-0.15.0.dist-info}/WHEEL

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

litestar_vite/config.py

@@ -1,100 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass, field
-from functools import cached_property
-from inspect import isclass
-from typing import TYPE_CHECKING, Generic, TypeVar, cast
-
-from litestar.exceptions import ImproperlyConfiguredException
-from litestar.template import TemplateEngineProtocol
-
-__all__ = ["ViteConfig", "ViteTemplateConfig"]
-
-
-if TYPE_CHECKING:
-    from collections.abc import Callable
-    from pathlib import Path
-
-    from litestar.types import PathType
-
-    from litestar_vite.template_engine import ViteTemplateEngine
-
-T = TypeVar("T", bound=TemplateEngineProtocol)
-
-
-@dataclass
-class ViteConfig:
-    """Configuration for ViteJS support.
-
-    To enable Vite integration, pass an instance of this class to the
-    :class:`Litestar <litestar.app.Litestar>` constructor using the
-    'plugins' key.
-    """
-
-    static_dir: Path
-    """Location of the manifest file.
-
-    The path relative to the `static_url` location
-    """
-    templates_dir: Path
-    """Location of the Jinja2 template file.
-    """
-    manifest_name: str = "manifest.json"
-    """Name of the manifest file."""
-    hot_reload: bool = False
-    """Enable HMR for Vite development server."""
-    is_react: bool = False
-    """Enable React components."""
-    static_url: str = "/static/"
-    """Base URL to generate for static asset references.
-
-    This should match what you have for the STATIC_URL
-    """
-    host: str = "localhost"
-    """Default host to use for Vite server."""
-    protocol: str = "http"
-    """Protocol to use for communication"""
-    port: int = 3000
-    """Default port to use for Vite server."""
-    run_command: str = "npm run dev"
-    """Default command to use for running Vite."""
-    build_command: str = "npm run build"
-
-
-@dataclass
-class ViteTemplateConfig(Generic[T]):
-    """Configuration for Templating.
-
-    To enable templating, pass an instance of this class to the
-    :class:`Litestar <litestar.app.Litestar>` constructor using the
-    'template_config' key.
-    """
-
-    engine: type[ViteTemplateEngine]
-    """A template engine adhering to the :class:`TemplateEngineProtocol
-    <litestar.template.base.TemplateEngineProtocol>`."""
-    config: ViteConfig
-    """A a config for the vite engine`."""
-    directory: PathType | None = field(default=None)
-    """A directory or list of directories from which to serve templates."""
-    engine_callback: Callable[[T], None] | None = field(default=None)
-    """A callback function that allows modifying the instantiated templating
-    protocol."""
-
-    def __post_init__(self) -> None:
-        """Ensure that directory is set if engine is a class."""
-        if isclass(self.engine) and not self.directory:
-            msg = "directory is a required kwarg when passing a template engine class"
-            raise ImproperlyConfiguredException(msg)
-
-    def to_engine(self) -> T:
-        """Instantiate the template engine."""
-        template_engine = cast("T", self.engine(self.directory, self.config) if isclass(self.engine) else self.engine)
-        if callable(self.engine_callback):
-            self.engine_callback(template_engine)
-        return template_engine
-
-    @cached_property
-    def engine_instance(self) -> T:
-        """Return the template engine instance."""
-        return self.to_engine()

litestar_vite/plugin.py

@@ -1,45 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from litesatr_vite.config import ViteTemplateConfig
-from litesatr_vite.template_engine import ViteTemplateEngine
-from litestar.plugins import CLIPluginProtocol, InitPluginProtocol
-
-if TYPE_CHECKING:
-    from click import Group
-    from litesatr_vite.config import ViteConfig
-    from litestar.config.app import AppConfig
-
-
-class VitePlugin(InitPluginProtocol, CLIPluginProtocol):
-    """Vite plugin."""
-
-    __slots__ = ("_config",)
-
-    def __init__(self, config: ViteConfig) -> None:
-        """Initialize ``Vite``.
-
-        Args:
-            config: configure and start Vite.
-        """
-        self._config = config
-
-    def on_cli_init(self, cli: Group) -> None:
-        from litestar_vite.cli import vite_group
-
-        cli.add_command(vite_group)
-        return super().on_cli_init(cli)
-
-    def on_app_init(self, app_config: AppConfig) -> AppConfig:
-        """Configure application for use with Vite.
-
-        Args:
-            app_config: The :class:`AppConfig <.config.app.AppConfig>` instance.
-        """
-        app_config.template_config = ViteTemplateConfig(
-            directory=self._config.templates_dir,
-            engine=ViteTemplateEngine,
-            config=self._config,
-        )
-        return app_config

litestar_vite/template_engine.py

@@ -1,103 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Any, TypeVar
-
-import markupsafe
-from jinja2 import TemplateNotFound as JinjaTemplateNotFound
-from jinja2 import pass_context
-from litestar.contrib.jinja import JinjaTemplateEngine
-from litestar.exceptions import TemplateNotFoundException
-from litestar.template.base import (
-    TemplateEngineProtocol,
-)
-
-from .loader import ViteAssetLoader
-
-if TYPE_CHECKING:
-    from collections.abc import Callable
-
-    from jinja2 import Template as JinjaTemplate
-    from litesatr_vite.config import ViteConfig
-    from pydantic import DirectoryPath
-
-T = TypeVar("T", bound=TemplateEngineProtocol)
-
-
-class ViteTemplateEngine(JinjaTemplateEngine):
-    """Jinja Template Engine with Vite Integration."""
-
-    def __init__(self, directory: DirectoryPath | list[DirectoryPath], config: ViteConfig) -> None:
-        """Jinja2 based TemplateEngine.
-
-        Args:
-            directory: Direct path or list of directory paths from which to serve templates.
-            config: Vite config
-        """
-        super().__init__(directory=directory)
-        self.config = config
-        self.asset_loader = ViteAssetLoader.initialize_loader(config=self.config)
-        self.engine.globals["vite_hmr_client"] = self.hmr_client
-        self.engine.globals["vite_asset"] = self.resource
-
-    def get_template(self, template_name: str) -> JinjaTemplate:
-        """Retrieve a template by matching its name (dotted path) with files in the directory or directories provided.
-
-        Args:
-            template_name: A dotted path
-
-        Returns:
-            JinjaTemplate instance
-
-        Raises:
-            TemplateNotFoundException: if no template is found.
-        """
-        try:
-            return self.engine.get_template(name=template_name)
-        except JinjaTemplateNotFound as exc:
-            raise TemplateNotFoundException(template_name=template_name) from exc
-
-    def register_template_callable(self, key: str, template_callable: Callable[[dict[str, Any]], Any]) -> None:
-        """Register a callable on the template engine.
-
-        Args:
-            key: The callable key, i.e. the value to use inside the template to call the callable.
-            template_callable: A callable to register.
-
-        Returns:
-            None
-        """
-        self.engine.globals[key] = pass_context(template_callable)
-
-    def hmr_client(self) -> markupsafe.Markup:
-        """Generate the script tag for the Vite WS client for HMR.
-
-        Only used when hot module reloading is enabled, in production this method returns an empty string.
-
-
-        Returns:
-            str: The script tag or an empty string.
-        """
-        tags = [self.asset_loader.generate_react_hmr_tags()]
-        tags.append(self.asset_loader.generate_ws_client_tags())
-        return markupsafe.Markup("".join(tags))
-
-    def resource(self, path: str, scripts_attrs: dict[str, str] | None = None) -> markupsafe.Markup:
-        """Generate all assets include tags for the file in argument.
-
-        Generates all scripts tags for this file and all its dependencies
-        (JS and CSS) by reading the manifest file (for production only).
-        In development Vite imports all dependencies by itself.
-        Place this tag in <head> section of your page
-        (this function marks automatically <script> as "async" and "defer").
-
-        Arguments:
-            path: Path to a Vite asset to include.
-            scripts_attrs: script attributes
-
-        Keyword Arguments:
-            scripts_attrs {Optional[Dict[str, str]]}: Override attributes added to scripts tags. (default: {None})
-
-        Returns:
-            str: All tags to import this asset in your HTML page.
-        """
-        return markupsafe.Markup(self.asset_loader.generate_asset_tags(path, scripts_attrs=scripts_attrs))