Merge remote-tracking branch 'upstream/main'

Author: Arne Tarara - Automated

bakerydemo/base/blocks.py

@@ -12,6 +12,17 @@
 from wagtail.images.blocks import ImageChooserBlock
 
 
+def get_image_api_representation(image):
+    return {
+        "id": image.pk,
+        "title": image.title,
+        "meta": {
+            "type": type(image)._meta.label,
+            "download_url": image.file.url,
+        },
+    }
+
+
 class CaptionedImageBlock(StructBlock):
     """
     Custom `StructBlock` for utilizing images with associated caption and
@@ -34,6 +45,11 @@ def get_preview_value(self):
             "caption": self.preview_image.description,
         }
 
+    def get_api_representation(self, value, context=None):
+        data = super().get_api_representation(value, context)
+        data["image"] = get_image_api_representation(value["image"])
+        return data
+
     class Meta:
         icon = "image"
         template = "blocks/captioned_image_block.html"

bakerydemo/base/migrations/0024_alter_formpage_body_alter_gallerypage_body_and_more.py

@@ -7,10 +7,12 @@
 from wagtail.admin.panels import (
     FieldPanel,
     FieldRowPanel,
+    HelpPanel,
     InlinePanel,
     MultiFieldPanel,
     PublishingPanel,
 )
+from wagtail.api import APIField
 from wagtail.contrib.forms.models import AbstractEmailForm, AbstractFormField
 from wagtail.contrib.forms.panels import FormSubmissionsPanel
 from wagtail.contrib.settings.models import (
@@ -19,6 +21,7 @@
     register_setting,
 )
 from wagtail.fields import RichTextField, StreamField
+from wagtail.images.models import Image
 from wagtail.models import (
     Collection,
     DraftStateMixin,
@@ -35,6 +38,9 @@
 
 from .blocks import BaseStreamBlock
 
+# Allow filtering by collection
+Image.api_fields = [APIField("collection")]
+
 
 class Person(
     WorkflowMixin,
@@ -111,6 +117,13 @@ class Person(
         index.AutocompleteField("last_name"),
     ]
 
+    api_fields = [
+        APIField("first_name"),
+        APIField("last_name"),
+        APIField("job_title"),
+        APIField("image"),
+    ]
+
     @property
     def thumb_image(self):
         # Returns an empty string if there is no profile pic or the rendition
@@ -195,6 +208,10 @@ class FooterText(
         PublishingPanel(),
     ]
 
+    api_fields = [
+        APIField("body"),
+    ]
+
     def __str__(self):
         return "Footer text"
 
@@ -234,6 +251,12 @@ class StandardPage(Page):
         FieldPanel("image"),
     ]
 
+    api_fields = [
+        APIField("introduction"),
+        APIField("image"),
+        APIField("body"),
+    ]
+
 
 class HomePage(Page):
     """
@@ -358,13 +381,15 @@ class HomePage(Page):
             ],
             heading="Hero section",
         ),
+        HelpPanel("This is a help panel"),
         MultiFieldPanel(
             [
                 FieldPanel("promo_image"),
                 FieldPanel("promo_title"),
                 FieldPanel("promo_text"),
             ],
             heading="Promo section",
+            help_text="This is just a help text",
         ),
         FieldPanel("body"),
         MultiFieldPanel(
@@ -392,6 +417,23 @@ class HomePage(Page):
         ),
     ]
 
+    api_fields = [
+        APIField("image"),
+        APIField("hero_text"),
+        APIField("hero_cta"),
+        APIField("hero_cta_link"),
+        APIField("body"),
+        APIField("promo_image"),
+        APIField("promo_title"),
+        APIField("promo_text"),
+        APIField("featured_section_1_title"),
+        APIField("featured_section_1"),
+        APIField("featured_section_2_title"),
+        APIField("featured_section_2"),
+        APIField("featured_section_3_title"),
+        APIField("featured_section_3"),
+    ]
+
     def __str__(self):
         return self.title
 
@@ -411,7 +453,7 @@ class GalleryPage(Page):
         blank=True,
         on_delete=models.SET_NULL,
         related_name="+",
-        help_text="Landscape mode only; horizontal width between 1000px and " "3000px.",
+        help_text="Landscape mode only; horizontal width between 1000px and 3000px.",
     )
     body = StreamField(
         BaseStreamBlock(), verbose_name="Page body", blank=True, use_json_field=True
@@ -436,6 +478,13 @@ class GalleryPage(Page):
     # array no subpage can be added
     subpage_types = []
 
+    api_fields = [
+        APIField("introduction"),
+        APIField("image"),
+        APIField("body"),
+        APIField("collection"),
+    ]
+
 
 class FormField(AbstractFormField):
     """
@@ -483,6 +532,16 @@ class FormPage(AbstractEmailForm):
         ),
     ]
 
+    api_fields = [
+        APIField("form_fields"),
+        APIField("from_address"),
+        APIField("to_address"),
+        APIField("subject"),
+        APIField("image"),
+        APIField("body"),
+        APIField("thank_you_text"),
+    ]
+
 
 @register_setting(icon="cog")
 class GenericSettings(ClusterableModel, BaseGenericSetting):

bakerydemo/base/models.py

@@ -0,0 +1,99 @@
+# Generated by Django 5.1.8 on 2025-06-19 11:15
+
+import wagtail.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("blog", "0006_rename_blogpeoplerelationship_person"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="blogpage",
+            name="body",
+            field=wagtail.fields.StreamField(
+                [
+                    ("heading_block", 2),
+                    ("paragraph_block", 3),
+                    ("image_block", 6),
+                    ("block_quote", 9),
+                    ("embed_block", 10),
+                ],
+                blank=True,
+                block_lookup={
+                    0: (
+                        "wagtail.blocks.CharBlock",
+                        (),
+                        {"form_classname": "title", "required": True},
+                    ),
+                    1: (
+                        "wagtail.blocks.ChoiceBlock",
+                        [],
+                        {
+                            "blank": True,
+                            "choices": [
+                                ("", "Select a header size"),
+                                ("h2", "H2"),
+                                ("h3", "H3"),
+                                ("h4", "H4"),
+                            ],
+                            "required": False,
+                        },
+                    ),
+                    2: (
+                        "wagtail.blocks.StructBlock",
+                        [[("heading_text", 0), ("size", 1)]],
+                        {},
+                    ),
+                    3: (
+                        "wagtail.blocks.RichTextBlock",
+                        (),
+                        {
+                            "description": "A rich text paragraph",
+                            "icon": "pilcrow",
+                            "preview_value": '\n            <h2>Our bread pledge</h2>\n            <p>As a bakery, <b>breads</b> have <i>always</i> been in our hearts.\n            <a href="https://en.wikipedia.org/wiki/Staple_food">Staple foods</a>\n            are essential for society, and – bread is the tastiest of all.\n            We love to transform batters and doughs into baked goods with a firm\n            dry crust and fluffy center.</p>\n            ',
+                            "template": "blocks/paragraph_block.html",
+                        },
+                    ),
+                    4: (
+                        "wagtail.images.blocks.ImageChooserBlock",
+                        (),
+                        {"required": True},
+                    ),
+                    5: ("wagtail.blocks.CharBlock", (), {"required": False}),
+                    6: (
+                        "wagtail.blocks.StructBlock",
+                        [[("image", 4), ("caption", 5), ("attribution", 5)]],
+                        {},
+                    ),
+                    7: ("wagtail.blocks.TextBlock", (), {}),
+                    8: (
+                        "wagtail.blocks.CharBlock",
+                        (),
+                        {"blank": True, "label": "e.g. Mary Berry", "required": False},
+                    ),
+                    9: (
+                        "wagtail.blocks.StructBlock",
+                        [[("text", 7), ("attribute_name", 8)]],
+                        {},
+                    ),
+                    10: (
+                        "wagtail.embeds.blocks.EmbedBlock",
+                        (),
+                        {
+                            "description": "An embedded video or other media",
+                            "help_text": "Insert an embed URL e.g https://www.youtube.com/watch?v=SGJFWirQ3ks",
+                            "icon": "media",
+                            "preview_template": "base/preview/static_embed_block.html",
+                            "preview_value": "https://www.youtube.com/watch?v=mwrGSfiB1Mg",
+                            "template": "blocks/embed_block.html",
+                        },
+                    ),
+                },
+                verbose_name="Page body",
+            ),
+        ),
+    ]

bakerydemo/blog/migrations/0007_alter_blogpage_body.py

@@ -5,6 +5,7 @@
 from modelcluster.fields import ParentalKey
 from taggit.models import Tag, TaggedItemBase
 from wagtail.admin.panels import FieldPanel, MultipleChooserPanel
+from wagtail.api import APIField
 from wagtail.contrib.routable_page.models import RoutablePageMixin, route
 from wagtail.fields import StreamField
 from wagtail.models import Orderable, Page
@@ -30,6 +31,11 @@ class BlogPersonRelationship(Orderable, models.Model):
     )
     panels = [FieldPanel("person")]
 
+    api_fields = [
+        APIField("page"),
+        APIField("person"),
+    ]
+
 
 class BlogPageTag(TaggedItemBase):
     """
@@ -89,6 +95,16 @@ class BlogPage(Page):
         index.SearchField("body"),
     ]
 
+    api_fields = [
+        APIField("introduction"),
+        APIField("image"),
+        APIField("body"),
+        APIField("subtitle"),
+        APIField("tags"),
+        APIField("date_published"),
+        APIField("blog_person_relationship"),
+    ]
+
     def authors(self):
         """
         Returns the BlogPage's related people. Again note that we are using
@@ -151,6 +167,11 @@ class BlogIndexPage(RoutablePageMixin, Page):
         FieldPanel("image"),
     ]
 
+    api_fields = [
+        APIField("introduction"),
+        APIField("image"),
+    ]
+
     # Specifies that only BlogPage objects can live under this index page
     subpage_types = ["BlogPage"]
 
@@ -176,7 +197,6 @@ def get_context(self, request):
     @route(r"^tags/$", name="tag_archive")
     @route(r"^tags/([\w-]+)/$", name="tag_archive")
     def tag_archive(self, request, tag=None):
-
         try:
             tag = Tag.objects.get(slug=tag)
         except Tag.DoesNotExist: