Move htmx.py into core

Author: chriscarrollsmith

docs/architecture.qmd

@@ -8,7 +8,7 @@ description: "Overview of the FastAPI webapp template architecture including dat
 This application uses a **hybrid Post-Redirect-Get (PRG) + HTMX** architecture. Every mutating endpoint supports both paths simultaneously:
 
 - **Non-HTMX path (PRG):** A standard browser form submission sends a POST request. On success the server issues a `303 See Other` redirect to a GET endpoint, which re-renders the full page with updated data. On error a full-page error template is returned.
-- **HTMX path:** When the browser sends the `HX-Request: true` header (added automatically by [htmx.org](https://htmx.org)), the same POST endpoint detects the header via `utils/htmx.py:is_htmx_request()` and instead returns a `200` HTML partial that HTMX swaps into the relevant section of the page. On error a toast partial is returned and swapped into `#toast-container` via out-of-band (OOB) swap.
+- **HTMX path:** When the browser sends the `HX-Request: true` header (added automatically by [htmx.org](https://htmx.org)), the same POST endpoint detects the header via `utils/core/htmx.py:is_htmx_request()` and instead returns a `200` HTML partial that HTMX swaps into the relevant section of the page. On error a toast partial is returned and swapped into `#toast-container` via out-of-band (OOB) swap.
 
 The HTMX rollout keeps the existing POST route contract intact — dedicated `PUT`/`PATCH`/`DELETE` routes may be introduced in a future iteration.
 
@@ -129,7 +129,7 @@ Toast partials are rendered from `templates/base/partials/toast.html` and inject
 
 ### HTMX request detection
 
-All HTMX-aware endpoints use the `is_htmx_request()` helper from `utils/htmx.py`:
+All HTMX-aware endpoints use the `is_htmx_request()` helper from `utils/core/htmx.py`:
 
 ```python
 def is_htmx_request(request: Request) -> bool:

docs/customization.qmd

@@ -173,7 +173,7 @@ Middleware functions are decorated with `@app.exception_handler(ExceptionType)`
 Here's a middleware for handling the `PasswordValidationError` exception, which returns a toast partial for HTMX requests or a full error page for non-HTMX requests:
 
 ```python
-from utils.htmx import is_htmx_request
+from utils.core.htmx import is_htmx_request
 
 @app.exception_handler(PasswordValidationError)
 async def password_validation_exception_handler(request: Request, exc: PasswordValidationError):

docs/static/documentation.txt

@@ -229,7 +229,7 @@ description: "Overview of the FastAPI webapp template architecture including dat
 This application uses a **hybrid Post-Redirect-Get (PRG) + HTMX** architecture. Every mutating endpoint supports both paths simultaneously:
 
 - **Non-HTMX path (PRG):** A standard browser form submission sends a POST request. On success the server issues a `303 See Other` redirect to a GET endpoint, which re-renders the full page with updated data. On error a full-page error template is returned.
-- **HTMX path:** When the browser sends the `HX-Request: true` header (added automatically by [htmx.org](https://htmx.org)), the same POST endpoint detects the header via `utils/htmx.py:is_htmx_request()` and instead returns a `200` HTML partial that HTMX swaps into the relevant section of the page. On error a toast partial is returned and swapped into `#toast-container` via out-of-band (OOB) swap.
+- **HTMX path:** When the browser sends the `HX-Request: true` header (added automatically by [htmx.org](https://htmx.org)), the same POST endpoint detects the header via `utils/core/htmx.py:is_htmx_request()` and instead returns a `200` HTML partial that HTMX swaps into the relevant section of the page. On error a toast partial is returned and swapped into `#toast-container` via out-of-band (OOB) swap.
 
 The HTMX rollout keeps the existing POST route contract intact — dedicated `PUT`/`PATCH`/`DELETE` routes may be introduced in a future iteration.
 
@@ -350,7 +350,7 @@ Toast partials are rendered from `templates/base/partials/toast.html` and inject
 
 ### HTMX request detection
 
-All HTMX-aware endpoints use the `is_htmx_request()` helper from `utils/htmx.py`:
+All HTMX-aware endpoints use the `is_htmx_request()` helper from `utils/core/htmx.py`:
 
 ```python
 def is_htmx_request(request: Request) -> bool:
@@ -843,7 +843,7 @@ Middleware functions are decorated with `@app.exception_handler(ExceptionType)`
 Here's a middleware for handling the `PasswordValidationError` exception, which returns a toast partial for HTMX requests or a full error page for non-HTMX requests:
 
 ```python
-from utils.htmx import is_htmx_request
+from utils.core.htmx import is_htmx_request
 
 @app.exception_handler(PasswordValidationError)
 async def password_validation_exception_handler(request: Request, exc: PasswordValidationError):

main.py

@@ -13,7 +13,7 @@
     require_unauthenticated_client
 )
 from utils.core.auth import COOKIE_SECURE
-from utils.htmx import is_htmx_request, toast_response
+from utils.core.htmx import is_htmx_request, toast_response
 from exceptions.http_exceptions import (
     AlreadyAuthenticatedError,
     AuthenticationError,

routers/core/account.py

@@ -51,7 +51,7 @@
     check_forgot_password_email_rate_limit,
     login_email_limiter,
 )
-from utils.htmx import is_htmx_request, toast_response, set_flash_cookie
+from utils.core.htmx import is_htmx_request, toast_response, set_flash_cookie
 logger = getLogger("uvicorn.error")
 
 router = APIRouter(prefix="/account", tags=["account"])

routers/core/invitation.py

@@ -20,7 +20,7 @@
     InvalidInvitationTokenError,
 )
 from exceptions.exceptions import EmailSendFailedError
-from utils.htmx import is_htmx_request, append_toast
+from utils.core.htmx import is_htmx_request, append_toast
 # Import the account router to generate URLs for login/register
 from routers.core.account import router as account_router
 from routers.core.organization import router as org_router # Already imported, check usage

routers/core/organization.py

@@ -15,7 +15,7 @@
     UserNotFoundError, UserAlreadyMemberError, DataIntegrityError
 )
 from pydantic import EmailStr
-from utils.htmx import is_htmx_request, set_flash_cookie
+from utils.core.htmx import is_htmx_request, set_flash_cookie
 
 logger = getLogger("uvicorn.error")
 

routers/core/role.py

@@ -12,7 +12,7 @@
 from utils.core.models import Role, Permission, ValidPermissions, utc_now, User, DataIntegrityError, Organization
 from exceptions.http_exceptions import InsufficientPermissionsError, InvalidPermissionError, RoleAlreadyExistsError, RoleNotFoundError, RoleHasUsersError, CannotModifyDefaultRoleError
 from routers.core.organization import router as organization_router
-from utils.htmx import is_htmx_request, append_toast
+from utils.core.htmx import is_htmx_request, append_toast
 
 logger = getLogger("uvicorn.error")
 

routers/core/user.py

@@ -14,7 +14,7 @@
     OrganizationNotFoundError
 )
 from routers.core.organization import router as organization_router
-from utils.htmx import is_htmx_request, append_toast
+from utils.core.htmx import is_htmx_request, append_toast
 
 router = APIRouter(prefix="/user", tags=["user"])
 templates = Jinja2Templates(directory="templates")

tests/test_htmx.py

@@ -11,7 +11,7 @@
 from starlette.requests import Request
 from fastapi.templating import Jinja2Templates
 from tests.conftest import htmx_headers
-from utils.htmx import is_htmx_request, toast_response, append_toast
+from utils.core.htmx import is_htmx_request, toast_response, append_toast
 from utils.core.rate_limit import (
     login_ip_limiter,
     login_email_limiter,