wagtail-write-api 0.2.2__tar.gz → 0.2.3__tar.gz

{wagtail_write_api-0.2.2 → wagtail_write_api-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagtail-write-api
-Version: 0.2.2
+Version: 0.2.3
 Summary: A read/write REST API for Wagtail CMS
 Project-URL: Homepage, https://tomdyson.github.io/wagtail-write-api/
 Project-URL: Repository, https://github.com/tomdyson/wagtail-write-api

{wagtail_write_api-0.2.2 → wagtail_write_api-0.2.3}/docs/api/pages.md

@@ -34,8 +34,8 @@ GET /pages/
 | Parameter | Type | Description |
 |-----------|------|-------------|
 | `type` | string | Filter by page type, e.g. `blog.BlogPage` |
-| `parent` | int | Direct children of this page ID |
-| `descendant_of` | int | All descendants of this page ID |
+| `parent` | int or string | Direct children of this page ID or URL path (e.g. `5` or `/blog/`) |
+| `descendant_of` | int or string | All descendants of this page ID or URL path |
 | `status` | string | `draft`, `live`, or `live+draft` |
 | `slug` | string | Exact slug match (may return multiple if slug exists under different parents) |
 | `path` | string | Exact URL path match, e.g. `/blog/my-post/` (always 0 or 1 result) |

{wagtail_write_api-0.2.2 → wagtail_write_api-0.2.3}/docs/guides/rich-text.md

@@ -92,6 +92,12 @@ WAGTAIL_WRITE_API = {
 !!! tip "For CMS editors"
     If your client needs to read content, edit it, and write it back, use `"wagtail"` format. This preserves the internal link references (page IDs) through the round trip. With `"html"` format, internal links are expanded to URL paths, which can't be losslessly converted back.
 
+## StreamField blocks sent to a RichTextField
+
+If a client accidentally sends StreamField-style blocks (a list of `{"type": ..., "value": ...}` dicts) to a `RichTextField`, the API extracts the HTML content from the blocks rather than storing a stringified list. Paragraph and text block values are concatenated, and heading blocks are converted to HTML heading tags.
+
+This is a convenience fallback — for best results, send one of the documented input formats above.
+
 ## Rich text in StreamField
 
 `RichTextBlock` values in StreamField accept the same input format:

{wagtail_write_api-0.2.2 → wagtail_write_api-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "wagtail-write-api"
-version = "0.2.2"
+version = "0.2.3"
 description = "A read/write REST API for Wagtail CMS"
 readme = "README.md"
 license = "BSD-3-Clause"

wagtail_write_api-0.2.3/src/wagtail_write_api/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.3"

{wagtail_write_api-0.2.2 → wagtail_write_api-0.2.3}/src/wagtail_write_api/converters/rich_text.py

@@ -14,6 +14,9 @@ def convert_rich_text_input(value) -> str:
     if isinstance(value, str):
         return value
 
+    if isinstance(value, list):
+        return _blocks_to_html(value)
+
     if not isinstance(value, dict):
         return str(value)
 
@@ -54,3 +57,24 @@ def markdown_to_wagtail(md_text: str) -> str:
     # The wagtail links are already in the output as <a linktype="..." id="...">
     # because we replaced them before markdown processing
     return html
+
+
+def _blocks_to_html(blocks: list) -> str:
+    """Extract HTML from a list of StreamField-style blocks.
+
+    Handles the case where a client sends block data to a RichTextField —
+    we pull out the text content rather than storing a stringified list.
+    """
+    parts = []
+    for block in blocks:
+        if not isinstance(block, dict):
+            continue
+        value = block.get("value", "")
+        block_type = block.get("type", "")
+        if block_type == "heading" and isinstance(value, dict):
+            size = value.get("size", "h2")
+            text = value.get("text", "")
+            parts.append(f"<{size}>{text}</{size}>")
+        elif isinstance(value, str):
+            parts.append(value)
+    return "".join(parts)

{wagtail_write_api-0.2.2 → wagtail_write_api-0.2.3}/tests/test_rich_text.py

@@ -87,6 +87,54 @@ class TestRichTextInput:
         page = SimplePage.objects.get(title="Plain String")
         assert page.body == "<p>Just plain HTML</p>"
 
+    def test_streamfield_blocks_coerced_to_html(self, api_client, auth_header, home_page):
+        """StreamField-style blocks sent to a RichTextField are coerced to HTML."""
+        response = api_client.post(
+            "/api/write/v1/pages/",
+            data=json.dumps(
+                {
+                    "type": "testapp.SimplePage",
+                    "parent": home_page.id,
+                    "title": "Blocks Coerced",
+                    "body": [
+                        {"type": "paragraph", "value": "<p>Hello</p>", "id": "a"},
+                        {"type": "paragraph", "value": "<p>World</p>", "id": "b"},
+                    ],
+                }
+            ),
+            content_type="application/json",
+            **auth_header,
+        )
+        assert response.status_code == 201
+        page = SimplePage.objects.get(title="Blocks Coerced")
+        assert isinstance(page.body, str)
+        assert "<p>Hello</p>" in page.body
+        assert "<p>World</p>" in page.body
+        assert "[{" not in page.body  # not stringified Python
+
+    def test_streamfield_heading_blocks_coerced(self, api_client, auth_header, home_page):
+        """Heading blocks are converted to HTML heading tags."""
+        response = api_client.post(
+            "/api/write/v1/pages/",
+            data=json.dumps(
+                {
+                    "type": "testapp.SimplePage",
+                    "parent": home_page.id,
+                    "title": "Heading Coerced",
+                    "body": [
+                        {"type": "heading", "value": {"text": "Title", "size": "h2"}, "id": "a"},
+                        {"type": "paragraph", "value": "<p>Body text</p>", "id": "b"},
+                    ],
+                }
+            ),
+            content_type="application/json",
+            **auth_header,
+        )
+        assert response.status_code == 201
+        page = SimplePage.objects.get(title="Heading Coerced")
+        assert "<h2>Title</h2>" in page.body
+        assert "<p>Body text</p>" in page.body
+
     def test_markdown_wagtail_page_link(self, api_client, auth_header, home_page):
         response = api_client.post(
             "/api/write/v1/pages/",

wagtail_write_api-0.2.2/src/wagtail_write_api/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.2"