Merge branch 'main' into feat/search

Author: fsbraun

.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.10", "3.11", "3.12", "3.13"]
+        python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14"]
         requirements-file: [
           dj42_cms41.txt,
           dj42_cms50.txt,
@@ -26,27 +26,53 @@ jobs:
             requirements-file: dj60_cms50.txt
           - python-version: "3.11"
             requirements-file: dj60_cms50.txt
+          - python-version: "3.14"
+            requirements-file: dj42_cms41.txt
+            os: ubuntu-latest
+          - python-version: "3.14"
+            requirements-file: dj42_cms50.txt
+            os: ubuntu-latest
+          - python-version: "3.14"
+            requirements-file: dj51_cms50.txt
+            os: ubuntu-latest
+          - python-version: "3.14"
+            requirements-file: dj50_cms50.txt
+            os: ubuntu-latest
+          - python-version: "3.10"
+            requirements-file: dj60_cms50.txt
+            os: ubuntu-latest
+          - python-version: "3.11"
+            requirements-file: dj60_cms50.txt
+            os: ubuntu-latest
     steps:
     - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Install uv
+      run: curl -LsSf https://astral.sh/uv/install.sh | sh
     - name: Install system deps (cairo stack)
       run: |
         sudo apt-get update
         sudo apt-get install -y \
           build-essential libcairo2-dev pkg-config python3-dev
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install -r tests/requirements/${{ matrix.requirements-file }}
-        pip install .
+        uv venv
+        source .venv/bin/activate
+        uv pip install -r tests/requirements/${{ matrix.requirements-file }}
+        uv pip install .
 
     - name: Run coverage
-      run: coverage run -m pytest
+      run: |
+        source .venv/bin/activate
+        coverage run -m pytest
+        coverage xml
 
     - name: Upload Coverage to Codecov
       uses: codecov/[email protected]
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        fail_ci_if_error: false

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+formats:
+  - epub
+  - pdf
+
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -411,4 +411,4 @@ like to change.
 
 ## License
 
-[BSD-3](https://github.com/fsbraun/djangocms-rest/blob/main/LICENSE)
+[BSD-3](https://github.com/django-cms/djangocms-rest/blob/main/LICENSE)

djangocms_rest/cms_config.py

@@ -28,11 +28,7 @@ def get_page_api_endpoint(page, language=None, fallback=True):
             if page.is_home:
                 return reverse("page-root", kwargs={"language": language})
             path = page.get_path(language, fallback)
-            return (
-                reverse("page-detail", kwargs={"language": language, "path": path})
-                if path
-                else None
-            )
+            return reverse("page-detail", kwargs={"language": language, "path": path}) if path else None
         except NoReverseMatch:
             return None
 
@@ -51,6 +47,10 @@ def inner(self, page_content: PageContent, *args, **kwargs):
             page_content.page,
             page_content.language,
         )
+        # To save API calls, we add the page's path to the node attributes
+        node.attr["path"] = page_content.page.get_path(
+            page_content.language,
+        )
         return node
 
     return inner
@@ -59,9 +59,7 @@ def inner(self, page_content: PageContent, *args, **kwargs):
 def patch_page_menu(menu: type[CMSMenu]):
     """Patch the CMSMenu to use the REST API endpoint for pages."""
     if hasattr(menu, "get_menu_node_for_page_content"):
-        menu.get_menu_node_for_page_content = patch_get_menu_node_for_page_content(
-            menu.get_menu_node_for_page_content
-        )
+        menu.get_menu_node_for_page_content = patch_get_menu_node_for_page_content(menu.get_menu_node_for_page_content)
 
 
 class NavigationNodeMixin:
@@ -101,9 +99,7 @@ class RESTToolbarMixin:
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-    if getattr(
-        settings, "REST_JSON_RENDERING", not getattr(settings, "CMS_TEMPLATES", False)
-    ):
+    if getattr(settings, "REST_JSON_RENDERING", not getattr(settings, "CMS_TEMPLATES", False)):
         try:
             from djangocms_text import settings
 

djangocms_rest/middleware.py

@@ -1,4 +1,4 @@
-from typing import Callable
+from collections.abc import Callable
 
 from django.contrib.sites.shortcuts import get_current_site
 from django.contrib.sites.models import Site

djangocms_rest/plugin_rendering.py

@@ -1,5 +1,6 @@
 import json
-from typing import Any, Iterable, Optional, TypeVar
+from typing import Any, TypeVar
+from collections.abc import Iterable
 
 from django.contrib.sites.shortcuts import get_current_site
 from django.core.exceptions import ValidationError
@@ -50,8 +51,8 @@ def get_auto_model_serializer(model_class: type[ModelType]) -> type:
 
 
 def serialize_cms_plugin(
-    instance: Optional[Any], context: dict[str, Any]
-) -> Optional[dict[str, Any]]:
+    instance: Any | None, context: dict[str, Any]
+) -> dict[str, Any] | None:
     if not instance or not hasattr(instance, "get_plugin_instance"):
         return None
     plugin_instance, plugin = instance.get_plugin_instance()

djangocms_rest/serializers/menus.py

@@ -9,7 +9,6 @@ class NavigationNodeSerializer(serializers.Serializer):
     namespace = serializers.CharField(allow_null=True)
     title = serializers.CharField()
     url = serializers.URLField(allow_null=True)
-    path = serializers.CharField(allow_null=True)
     api_endpoint = serializers.URLField(allow_null=True)
     visible = serializers.BooleanField()
     selected = serializers.BooleanField()
@@ -28,12 +27,18 @@ def get_children(self, obj: NavigationNode) -> list[dict]:
 
     def to_representation(self, obj: NavigationNode) -> dict:
         """Customize the base representation of the NavigationNode."""
+        path = getattr(obj, "api_endpoint", "")
+        api_endpoint = get_absolute_frontend_url(self.request, path) if path else ""
+        if self.request._preview_mode:
+            if "?" in api_endpoint:
+                api_endpoint += "&preview=1"
+            else:
+                api_endpoint += "?preview=1"
         return {
             "namespace": getattr(obj, "namespace", None),
             "title": obj.title,
             "url": get_absolute_frontend_url(self.request, obj.url) or "",
-            "api_endpoint": get_absolute_frontend_url(self.request, getattr(obj, "api_endpoint", None)) or "",
-            "path": getattr(obj, "api_endpoint", ""),
+            "api_endpoint": api_endpoint,
             "visible": obj.visible,
             "selected": obj.selected or obj.attr.get("is_home", False) and getattr(self.request, "is_home", False),
             "attr": obj.attr,

djangocms_rest/serializers/pages.py

@@ -1,6 +1,7 @@
 from django.db import models
 
 from cms.models import PageContent
+from cms.utils.placeholder import get_declared_placeholders_for_obj
 
 from rest_framework import serializers
 
@@ -42,6 +43,11 @@ def get_base_representation(self, page_content: PageContent) -> dict:
         path = page_content.page.get_path(page_content.language)
         absolute_url = get_absolute_frontend_url(request, path)
         api_endpoint = get_absolute_frontend_url(request, page_content.page.get_api_endpoint(page_content.language))
+        if self.is_preview:
+            if "?" in api_endpoint:
+                api_endpoint += "&preview=1"
+            else:
+                api_endpoint += "?preview=1"
         redirect = str(page_content.redirect or "")
         xframe_options = str(page_content.xframe_options or "")
         application_namespace = str(page_content.page.application_namespace or "")
@@ -132,7 +138,7 @@ def __init__(self, *args, **kwargs):
         self.request = self.context.get("request")
 
     def to_representation(self, page_content: PageContent) -> dict:
-        declared_slots = [placeholder.slot for placeholder in page_content.page.get_declared_placeholders()]
+        declared_slots = [placeholder.slot for placeholder in get_declared_placeholders_for_obj(page_content)]
         placeholders = [
             placeholder for placeholder in page_content.placeholders.all() if placeholder.slot in declared_slots
         ]

djangocms_rest/serializers/placeholders.py

@@ -11,9 +11,7 @@ class PlaceholderSerializer(serializers.Serializer):
     slot = serializers.CharField()
     label = serializers.CharField()
     language = serializers.CharField()
-    content = serializers.ListSerializer(
-        child=serializers.JSONField(), allow_empty=True, required=False
-    )
+    content = serializers.ListSerializer(child=serializers.JSONField(), allow_empty=True, required=False)
     html = serializers.CharField(default="", required=False)
 
     def __init__(self, *args, **kwargs):
@@ -64,7 +62,7 @@ def to_representation(self, instance):
         return super().to_representation(instance)
 
     def get_details(self, instance):
-        return get_absolute_frontend_url(
+        api_endpoint = get_absolute_frontend_url(
             self.request,
             reverse(
                 "placeholder-detail",
@@ -76,3 +74,9 @@ def get_details(self, instance):
                 ],
             ),
         )
+        if self.request._preview_mode:
+            if "?" in api_endpoint:
+                api_endpoint += "&preview=1"
+            else:
+                api_endpoint += "?preview=1"
+        return api_endpoint

djangocms_rest/serializers/plugins.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional
+from typing import Any
 
 from django.apps import apps
 from django.db.models import Field, Model
@@ -17,7 +17,7 @@ def serialize_fk(
     request: HttpRequest,
     related_model: type[CMSPlugin],
     pk: Any,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
 ) -> dict[str, Any]:
     """
     Serializes a foreign key reference to a related model as a URL or identifier.
@@ -157,7 +157,7 @@ class PluginDefinitionSerializer(serializers.Serializer):
     properties = serializers.DictField(help_text="Property definitions")
 
     @staticmethod
-    def get_field_format(field: Field) -> Optional[str]:
+    def get_field_format(field: Field) -> str | None:
         """
         Get the format for specific field types.