litestar-vite 0.1.22__tar.gz → 0.2.0__tar.gz

litestar_vite-0.2.0/.github/dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/.github/workflows/ci.yaml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -21,7 +21,7 @@ jobs:
 
       - name: Load cached Pre-Commit Dependencies
         id: cached-pre-commit-dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pre-commit/
           key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
@@ -34,7 +34,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     timeout-minutes: 30
     defaults:
       run:
@@ -43,16 +43,16 @@ jobs:
       - name: Check out repository
         uses: actions/checkout@v4
 
-      - uses: pdm-project/setup-pdm@v3
+      - uses: pdm-project/setup-pdm@v4
         name: Set up PDM
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
-        run: pdm install
+        run: pdm install -d -G:all
 
       - name: Test
-        run: pdm run pytest -m ""
+        run: pdm run pytest -m "" tests
 
   build-docs:
     needs:
@@ -64,17 +64,17 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
-      - uses: pdm-project/setup-pdm@v3
+      - uses: pdm-project/setup-pdm@v4
         name: Set up PDM
         with:
           python-version: "3.11"
 
       - name: Install dependencies
-        run: pdm install -G:all
+        run: pdm install -d -G:all
 
       - name: Build docs
         run: pdm run make docs
@@ -85,7 +85,7 @@ jobs:
         run: echo $PR_NUMBER > .pr_number
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: docs-preview
           path: |

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/.github/workflows/docs-preview.yaml

@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Download artifact
-        uses: dawidd6/action-download-artifact@v2
+        uses: dawidd6/action-download-artifact@v6
         with:
           workflow_conclusion: success
           run_id: ${{ github.event.workflow_run.id }}
@@ -38,7 +38,7 @@ jobs:
           target-folder: ${{ env.PR_NUMBER }}
           branch: gh-pages
 
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v7
         env:
           PR_NUMBER: ${{ env.PR_NUMBER }}
         with:

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/.github/workflows/docs.yaml

@@ -15,11 +15,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
-      - uses: pdm-project/setup-pdm@v3
+      - uses: pdm-project/setup-pdm@v4
         name: Set up PDM
         with:
           python-version: "3.11"

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/.github/workflows/publish.yaml

@@ -15,11 +15,11 @@ jobs:
       - name: Check out repository
         uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
-      - uses: pdm-project/setup-pdm@v3
+      - uses: pdm-project/setup-pdm@v4
         name: Set up PDM
         with:
           python-version: "3.11"

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/.pre-commit-config.yaml

@@ -2,12 +2,12 @@ default_language_version:
   python: "3.11"
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v3.1.0
+    rev: v3.3.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-ast
       - id: check-case-conflict
@@ -17,17 +17,17 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.3.3"
+    rev: "v0.5.4"
     hooks:
       - id: ruff
         args: ["--fix"]
         exclude: "docs"
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.9.0"
+    rev: "v1.11.0"
     hooks:
       - id: mypy
         exclude: "docs"

litestar_vite-0.2.0/.python-version

@@ -0,0 +1 @@
+3.8

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: litestar-vite
-Version: 0.1.22
+Version: 0.2.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -70,19 +70,9 @@ class WebController(Controller):
         return Template(template_name="index.html.j2")
 
 
-vite = VitePlugin(
-    config=ViteConfig(
-        bundle_dir=Path("./public"),
-        resource_dir=Path("./resources"),
-        template_dir=Path("./templates"),
-        # Should be False when in production
-        dev_mode=True,
-        hot_reload=True, # Websocket HMR asset reloading is enabled when true.
-    ),
-)
+vite = VitePlugin(config=ViteConfig(template_dir='templates/'))
 app = Litestar(plugins=[vite], route_handlers=[WebController])
 
-
 ```
 
 Create a template to serve the application in `./templates/index.html.h2`:

{litestar_vite-0.1.22 → litestar_vite-0.2.0}/README.md

@@ -33,19 +33,9 @@ class WebController(Controller):
         return Template(template_name="index.html.j2")
 
 
-vite = VitePlugin(
-    config=ViteConfig(
-        bundle_dir=Path("./public"),
-        resource_dir=Path("./resources"),
-        template_dir=Path("./templates"),
-        # Should be False when in production
-        dev_mode=True,
-        hot_reload=True, # Websocket HMR asset reloading is enabled when true.
-    ),
-)
+vite = VitePlugin(config=ViteConfig(template_dir='templates/'))
 app = Litestar(plugins=[vite], route_handlers=[WebController])
 
-
 ```
 
 Create a template to serve the application in `./templates/index.html.h2`:

litestar_vite-0.2.0/examples/basic/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ES2020",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "jsx": "preserve",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+    "noEmit": true,
+    "composite": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": "resources",
+    "paths": {
+      "@/*": ["./*"]
+    },
+    "types": ["vite/client"]
+  },
+  "include": [
+    "**/*.d.ts",
+    "resources/**/*.js",
+    "resources/**/*.ts",
+
+    "vite.config.ts"
+  ]
+}

litestar_vite-0.2.0/examples/flash/app.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from litestar import Controller, Litestar, Request, get
+from litestar.middleware.session.server_side import ServerSideSessionConfig
+from litestar.plugins.flash import FlashConfig, FlashPlugin, flash  # pyright: ignore[reportUnknownVariableType]
+from litestar.response import Template
+from litestar.stores.memory import MemoryStore
+
+from litestar_vite import ViteConfig, VitePlugin
+from litestar_vite.inertia import InertiaConfig, InertiaPlugin
+
+if TYPE_CHECKING:
+    from litestar.connection.base import AuthT, StateT, UserT
+
+here = Path(__file__).parent
+
+
+class WebController(Controller):
+    """Web Controller."""
+
+    opt = {"exclude_from_auth": True}
+    include_in_schema = False
+
+    @get("/")
+    async def index(self, request: Request[UserT, AuthT, StateT]) -> Template:
+        """Serve site root."""
+        flash(request, "Oh no! I've been flashed!", category="error")
+
+        return Template(template_name="index.html.j2")
+
+
+vite = VitePlugin(
+    config=ViteConfig(
+        hot_reload=True,
+        port=3006,
+        use_server_lifespan=True,
+        dev_mode=True,
+        template_dir="templates/",
+    ),
+)
+inertia = InertiaPlugin(config=InertiaConfig())
+flasher = FlashPlugin(config=FlashConfig(template_config=vite.template_config))
+
+app = Litestar(
+    plugins=[vite, flasher],
+    route_handlers=[WebController],
+    middleware=[ServerSideSessionConfig().middleware],
+    stores={"sessions": MemoryStore()},
+)