feat: Add RESTRenderer (#42)

* feat: Add RESTRenderer

* ruff issues

* Add json formatting

* Fix placeholder rendering

* feat: collapse objects

* better evt handling

* update formatting

* Remove js

* css tweaks

* Robust plugin moving

* fix rendering

* Unify rendering

* Fix linting

* Sort imports

* Add tests

* Fix rendering bug

* Fix bool formatting

* Add link resolution

* Fix tests

* Improve tests

* Add bs4 test requirement

* Add tests for fk serialization

* Update djangocms_rest/serializers/pages.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update djangocms_rest/apps.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update djangocms_rest/cms_config.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update djangocms_rest/cms_config.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update djangocms_rest/serializers/plugins.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Add test for preview endpoint

* Removed last trailing comma

* Add comment

* Add setting for JSON view and update readme

* Fix tests

* Update plugin-list

* Remove unused method

* Test enum types

* Add test for nested serializer

* Remove debug code

* Add autolinks

* feat: Add ellipses for folded json

* fix: reflect site when getting current language

* fix: Import get_current_site

* fix: Import cycle

* Feat/json edit review (#44)

* fix: add render support for nested-only plugins

* fix: TypeError: cannot pickle 'generator' object with caching

* docs: fix typo and structure

* Update djangocms_rest/serializers/plugins.py

* Update djangocms_rest/serializers/plugins.py

---------

Co-authored-by: Fabian Braun <[email protected]>

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: Marc Widmer <[email protected]>

Author: 3 people

README.md

@@ -66,11 +66,11 @@ projects, this is often not the case.
 
 **Limitations and considerations in headless mode:**
 
-- Inline editing and content preview are currently only available in a structured view. (Solutions
-  are currently being evaluated).
-- Not all features of a standard Django CMS are available through the API (eg. templates and tags).
+- Inline editing and content preview are available as JSON views on both edit and preview mode. Turn
+  JSON rendering on and off using the `REST_JSON_RENDERING` setting.
 - The API focuses on fetching plugin content and page structure as JSON data.
 - Website rendering is entirely decoupled and must be implemented in the frontend framework.
+- Not (yet) all features of a standard Django CMS are available through the API (eg. Menu).
 
 ## Are there js packages for drop-in support of frontend editing in the javascript framework of my choice?
 
@@ -140,12 +140,15 @@ class CustomHeadingPluginModel(CMSPlugin):
 Yes, djangocms-rest provides out of the box support for any and all django CMS plugins whose content
 can be serialized.
 
+Custom DRF serializers can be declared for custom plugins by setting its `serializer_class` property.
 
 ## Does the TextPlugin (Rich Text Editor, RTE) provide a json representation of the rich text?
 
 Yes, djangocms-text has both HTML blob and structured JSON support for rich text.
 
-URLs to other CMS objects are dynamic, in the form of `<app-name>.<object-name>:<uid>`, for example
+URLs to other Django model objects are dynamic and resolved to API endpoints if possible. If the referenced model
+provides a `get_api_endpoint()` method, it is used for resolution. If not, djangocms-rest tries to reverse `<model-name>-detail`.
+If resolution fails dynamic objects are returned in the form of `<app-name>.<object-name>:<uid>`, for example
 `cms.page:2`. The frontend can then use this to resolve the object and create the appropriate URLs
 to the object's frontend representation.
 

djangocms_rest/apps.py

@@ -0,0 +1,12 @@
+from django.apps import AppConfig
+
+
+class DjangocmsRestConfig(AppConfig):
+    """
+    AppConfig for the djangocms_rest application.
+    This application provides RESTful APIs for Django CMS.
+    """
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "djangocms_rest"
+    verbose_name = "Django CMS REST API"

djangocms_rest/cms_config.py

@@ -0,0 +1,75 @@
+from functools import cached_property
+
+from django.conf import settings
+from django.urls import NoReverseMatch, reverse
+
+from cms.app_base import CMSAppConfig
+from cms.models import Page
+from cms.utils.i18n import force_language, get_current_language
+
+
+try:
+    from filer.models import File
+except ImportError:
+    File = None
+
+
+def get_page_api_endpoint(page, language=None, fallback=True):
+    """Get the API endpoint for a given page in a specific language.
+    If the page is a home page, return the root endpoint.
+    """
+    if not language:
+        language = get_current_language()
+
+    with force_language(language):
+        try:
+            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
+            )
+        except NoReverseMatch:
+            return None
+
+
+def get_file_api_endpoint(file):
+    """For a file reference, return the URL of the file if it is public."""
+    if not file:
+        return None
+    return file.url if file.is_public else None
+
+
+class RESTToolbarMixin:
+    """
+    Mixin to add REST rendering capabilities to the CMS toolbar.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    if getattr(
+        settings, "REST_JSON_RENDERING", not getattr(settings, "CMS_TEMPLATES", False)
+    ):
+        try:
+            from djangocms_text import settings
+
+            settings.TEXT_INLINE_EDITING = False
+        except ImportError:
+            pass
+
+        @cached_property
+        def content_renderer(self):
+            from .plugin_rendering import RESTRenderer
+
+            return RESTRenderer(request=self.request)
+
+
+class RESTCMSConfig(CMSAppConfig):
+    cms_enabled = True
+    cms_toolbar_mixin = RESTToolbarMixin
+
+    Page.add_to_class("get_api_endpoint", get_page_api_endpoint)
+    File.add_to_class("get_api_endpoint", get_file_api_endpoint) if File else None

djangocms_rest/cms_toolbars.py

@@ -0,0 +1,8 @@
+from cms.toolbar_base import CMSToolbar
+from cms.toolbar_pool import toolbar_pool
+
+
+@toolbar_pool.register
+class RestToolbar(CMSToolbar):
+    class Media:
+        css = {"all": ("djangocms_rest/highlight.css",)}

djangocms_rest/permissions.py

@@ -1,6 +1,9 @@
+from django.contrib.sites.shortcuts import get_current_site
+
 from cms.models import Page, PageContent
 from cms.utils.i18n import get_language_tuple, get_languages
 from cms.utils.page_permissions import user_can_view_page
+
 from rest_framework.exceptions import NotFound
 from rest_framework.permissions import BasePermission
 from rest_framework.request import Request
@@ -30,7 +33,7 @@ class IsAllowedPublicLanguage(IsAllowedLanguage):
     def has_permission(self, request: Request, view: BaseAPIView) -> bool:
         super().has_permission(request, view)
         language = view.kwargs.get("language")
-        languages = get_languages()
+        languages = get_languages(get_current_site(request).pk)
         public_languages = [
             lang["code"] for lang in languages if lang.get("public", True)
         ]