payload-canvas 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +625 -153
- package/dist/admin/AiKeyField.d.ts +8 -0
- package/dist/admin/AiKeyField.js +54 -0
- package/dist/admin/BuilderTab.js +4 -1
- package/dist/admin/DocumentEditView.d.ts +9 -0
- package/dist/admin/DocumentEditView.js +45 -0
- package/dist/admin/LayoutField.d.ts +2 -2
- package/dist/admin/LayoutField.js +10 -7
- package/dist/admin/TemplateConditionsField.d.ts +9 -0
- package/dist/admin/TemplateConditionsField.js +22 -0
- package/dist/admin/aiKeyField.scss +58 -0
- package/dist/admin/client.d.ts +3 -0
- package/dist/admin/client.js +6 -0
- package/dist/admin/diff/changes.js +5 -0
- package/dist/admin/editor/Canvas.js +20 -5
- package/dist/admin/editor/Editor.d.ts +3 -1
- package/dist/admin/editor/Editor.js +6 -3
- package/dist/admin/editor/Inspector.js +75 -28
- package/dist/admin/editor/Library.js +40 -15
- package/dist/admin/editor/Outline.js +21 -16
- package/dist/admin/editor/Overlay.js +8 -3
- package/dist/admin/editor/actions.d.ts +10 -2
- package/dist/admin/editor/actions.js +18 -3
- package/dist/admin/editor/assistant/AssistantPanel.js +3 -1
- package/dist/admin/editor/classes/ClassManager.d.ts +4 -0
- package/dist/admin/editor/classes/ClassManager.js +56 -0
- package/dist/admin/editor/classes/controller.d.ts +112 -0
- package/dist/admin/editor/classes/controller.js +326 -0
- package/dist/admin/editor/classes/manager.scss +262 -0
- package/dist/admin/editor/classes/managerModel.d.ts +5 -0
- package/dist/admin/editor/classes/managerModel.js +27 -0
- package/dist/admin/editor/comments/CommentLayer.d.ts +2 -0
- package/dist/admin/editor/comments/CommentLayer.js +143 -0
- package/dist/admin/editor/comments/CommentsPanel.d.ts +8 -0
- package/dist/admin/editor/comments/CommentsPanel.js +73 -0
- package/dist/admin/editor/comments/Thread.d.ts +26 -0
- package/dist/admin/editor/comments/Thread.js +84 -0
- package/dist/admin/editor/comments/comments.scss +539 -0
- package/dist/admin/editor/comments/controller.d.ts +48 -0
- package/dist/admin/editor/comments/controller.js +142 -0
- package/dist/admin/editor/contentMode.d.ts +17 -0
- package/dist/admin/editor/contentMode.js +37 -0
- package/dist/admin/editor/dnd/DropOutlines.d.ts +1 -0
- package/dist/admin/editor/dnd/DropOutlines.js +73 -0
- package/dist/admin/editor/dnd/dnd.scss +43 -0
- package/dist/admin/editor/dnd/mode.d.ts +4 -0
- package/dist/admin/editor/dnd/mode.js +39 -0
- package/dist/admin/editor/editor.scss +13 -58
- package/dist/admin/editor/empty/EmptyStart.js +18 -66
- package/dist/admin/editor/fields/AddButton.d.ts +15 -0
- package/dist/admin/editor/fields/AddButton.js +14 -0
- package/dist/admin/editor/fields/ArrayField.js +3 -2
- package/dist/admin/editor/fields/CheckedInputs.d.ts +1 -0
- package/dist/admin/editor/fields/ConditionRows.d.ts +19 -0
- package/dist/admin/editor/fields/ConditionRows.js +137 -0
- package/dist/admin/editor/fields/ListWhereField.d.ts +8 -0
- package/dist/admin/editor/fields/ListWhereField.js +20 -0
- package/dist/admin/editor/fields/QueryFiltersField.d.ts +18 -0
- package/dist/admin/editor/fields/QueryFiltersField.js +41 -0
- package/dist/admin/editor/fields/RelatedField.d.ts +19 -0
- package/dist/admin/editor/fields/RelatedField.js +44 -0
- package/dist/admin/editor/fields/SortField.d.ts +13 -0
- package/dist/admin/editor/fields/SortField.js +37 -0
- package/dist/admin/editor/fields/WhereField.d.ts +12 -4
- package/dist/admin/editor/fields/WhereField.js +33 -53
- package/dist/admin/editor/fields/collectionFields.d.ts +6 -0
- package/dist/admin/editor/fields/collectionFields.js +15 -0
- package/dist/admin/editor/fields/conditions.d.ts +99 -0
- package/dist/admin/editor/fields/conditions.js +339 -0
- package/dist/admin/editor/fields/fields.scss +232 -9
- package/dist/admin/editor/fields/listOptions.d.ts +44 -0
- package/dist/admin/editor/fields/listOptions.js +111 -0
- package/dist/admin/editor/fields/queryFilterRows.d.ts +8 -0
- package/dist/admin/editor/fields/queryFilterRows.js +29 -0
- package/dist/admin/editor/fields/whereRows.d.ts +11 -12
- package/dist/admin/editor/fields/whereRows.js +83 -34
- package/dist/admin/editor/icons.d.ts +16 -1
- package/dist/admin/editor/icons.js +30 -1
- package/dist/admin/editor/inline.js +9 -0
- package/dist/admin/editor/insert/InsertHandle.js +4 -1
- package/dist/admin/editor/insert/picker.d.ts +3 -1
- package/dist/admin/editor/insert/picker.js +17 -10
- package/dist/admin/editor/insert/spots.d.ts +12 -1
- package/dist/admin/editor/insert/spots.js +49 -10
- package/dist/admin/editor/layout/LeftPanel.js +11 -6
- package/dist/admin/editor/live/useMultiplayer.js +9 -1
- package/dist/admin/editor/menu/blockMenu.js +27 -17
- package/dist/admin/editor/names.js +11 -3
- package/dist/admin/editor/renderField.d.ts +3 -1
- package/dist/admin/editor/renderField.js +63 -12
- package/dist/admin/editor/runtime.d.ts +14 -0
- package/dist/admin/editor/runtime.js +67 -6
- package/dist/admin/editor/sections/ComponentFields.d.ts +8 -0
- package/dist/admin/editor/sections/ComponentFields.js +116 -0
- package/dist/admin/editor/sections/PropertyControls.d.ts +18 -0
- package/dist/admin/editor/sections/PropertyControls.js +65 -0
- package/dist/admin/editor/sections/components.d.ts +29 -0
- package/dist/admin/editor/sections/components.js +112 -0
- package/dist/admin/editor/sections/components.scss +238 -0
- package/dist/admin/editor/sections/variants.d.ts +32 -0
- package/dist/admin/editor/sections/variants.js +59 -0
- package/dist/admin/editor/sections/variants.scss +90 -0
- package/dist/admin/editor/shortcuts.d.ts +4 -1
- package/dist/admin/editor/shortcuts.js +19 -3
- package/dist/admin/editor/store.d.ts +18 -0
- package/dist/admin/editor/store.js +46 -0
- package/dist/admin/editor/styles/ClassBar.d.ts +14 -0
- package/dist/admin/editor/styles/ClassBar.js +90 -0
- package/dist/admin/editor/styles/ClassCss.d.ts +4 -0
- package/dist/admin/editor/styles/ClassCss.js +28 -0
- package/dist/admin/editor/styles/ClassDialog.d.ts +2 -0
- package/dist/admin/editor/styles/ClassDialog.js +151 -0
- package/dist/admin/editor/styles/ColorPicker.js +5 -2
- package/dist/admin/editor/styles/RawClasses.d.ts +26 -1
- package/dist/admin/editor/styles/RawClasses.js +184 -32
- package/dist/admin/editor/styles/StylesPanel.d.ts +3 -3
- package/dist/admin/editor/styles/StylesPanel.js +53 -14
- package/dist/admin/editor/styles/VariantBar.js +2 -2
- package/dist/admin/editor/styles/classEdit.d.ts +4 -0
- package/dist/admin/editor/styles/classEdit.js +20 -0
- package/dist/admin/editor/styles/classes.scss +381 -0
- package/dist/admin/editor/styles/context.d.ts +19 -6
- package/dist/admin/editor/styles/context.js +24 -6
- package/dist/admin/editor/styles/controls.d.ts +3 -1
- package/dist/admin/editor/styles/controls.js +30 -12
- package/dist/admin/editor/styles/popover.d.ts +6 -0
- package/dist/admin/editor/styles/popover.js +5 -5
- package/dist/admin/editor/styles/styles.scss +26 -104
- package/dist/admin/editor/styles/suggestions.d.ts +22 -0
- package/dist/admin/editor/styles/suggestions.js +77 -0
- package/dist/admin/editor/styles/tokens.js +14 -0
- package/dist/admin/editor/templates/Bindable.js +86 -57
- package/dist/admin/editor/templates/SamplePicker.js +1 -1
- package/dist/admin/editor/templates/Visibility.d.ts +9 -0
- package/dist/admin/editor/templates/Visibility.js +54 -0
- package/dist/admin/editor/templates/binding.d.ts +2 -2
- package/dist/admin/editor/templates/binding.js +2 -2
- package/dist/admin/editor/templates/templates.scss +27 -0
- package/dist/admin/editor/templates/visibilityRows.d.ts +22 -0
- package/dist/admin/editor/templates/visibilityRows.js +83 -0
- package/dist/admin/editor/topbar/ContentModeToggle.d.ts +5 -0
- package/dist/admin/editor/topbar/ContentModeToggle.js +26 -0
- package/dist/admin/editor/topbar/DocumentActions.d.ts +1 -1
- package/dist/admin/editor/topbar/DocumentActions.js +5 -4
- package/dist/admin/editor/topbar/DocumentTitle.js +7 -2
- package/dist/admin/editor/topbar/TopBar.js +15 -3
- package/dist/admin/editor/topbar/contentMode.scss +35 -0
- package/dist/admin/editor/topbar/topbar.scss +3 -1
- package/dist/admin/formChoice.d.ts +3 -0
- package/dist/admin/formChoice.js +10 -0
- package/dist/admin/layoutField.scss +69 -0
- package/dist/admin/screen/BuilderScreen.d.ts +6 -1
- package/dist/admin/screen/BuilderScreen.js +4 -3
- package/dist/admin/server/BuilderView.js +10 -3
- package/dist/admin/templateConditions.scss +24 -0
- package/dist/ai/adapters/anthropic.js +17 -4
- package/dist/ai/adapters/cloudflare-gateway.js +7 -1
- package/dist/ai/adapters/cloudflare-workers-ai.js +2 -0
- package/dist/ai/adapters/openai-compatible.js +1 -0
- package/dist/ai/adapters/openrouter.js +2 -0
- package/dist/ai/config.d.ts +24 -4
- package/dist/ai/config.js +27 -8
- package/dist/ai/endpoint.d.ts +5 -2
- package/dist/ai/endpoint.js +31 -26
- package/dist/ai/images/cloudflare-workers-ai.js +6 -2
- package/dist/ai/images/openai.js +8 -3
- package/dist/ai/images/openrouter.js +6 -2
- package/dist/ai/images/service.d.ts +10 -4
- package/dist/ai/images/service.js +23 -7
- package/dist/ai/openai-format.d.ts +7 -0
- package/dist/ai/openai-format.js +17 -5
- package/dist/ai/prompt.d.ts +8 -0
- package/dist/ai/prompt.js +25 -5
- package/dist/ai/settings/index.d.ts +62 -0
- package/dist/ai/settings/index.js +264 -0
- package/dist/ai/settings/secret.d.ts +11 -0
- package/dist/ai/settings/secret.js +46 -0
- package/dist/ai/settings/shared.d.ts +22 -0
- package/dist/ai/settings/shared.js +3 -0
- package/dist/ai/tools.d.ts +3 -0
- package/dist/ai/tools.js +79 -15
- package/dist/ai/types.d.ts +43 -0
- package/dist/blocks/builtins/adjacentLinks.d.ts +5 -0
- package/dist/blocks/builtins/adjacentLinks.js +76 -0
- package/dist/blocks/builtins/carousel.d.ts +2 -29
- package/dist/blocks/builtins/carousel.js +44 -51
- package/dist/blocks/builtins/disclosure.d.ts +2 -1
- package/dist/blocks/builtins/disclosure.js +22 -32
- package/dist/blocks/builtins/embed.d.ts +15 -0
- package/dist/blocks/builtins/embed.js +47 -0
- package/dist/blocks/builtins/faq.d.ts +1 -1
- package/dist/blocks/builtins/faq.js +2 -2
- package/dist/blocks/builtins/filterLink.d.ts +1 -19
- package/dist/blocks/builtins/filterLink.js +9 -50
- package/dist/blocks/builtins/icon.d.ts +2 -0
- package/dist/blocks/builtins/icon.js +8 -8
- package/dist/blocks/builtins/index.d.ts +18 -13
- package/dist/blocks/builtins/index.js +43 -22
- package/dist/blocks/builtins/marquee.d.ts +5 -0
- package/dist/blocks/builtins/marquee.js +68 -0
- package/dist/blocks/builtins/popup.d.ts +5 -0
- package/dist/blocks/builtins/popup.js +83 -0
- package/dist/blocks/builtins/sectionRef.d.ts +16 -2
- package/dist/blocks/builtins/sectionRef.js +34 -12
- package/dist/blocks/builtins/shared.d.ts +18 -23
- package/dist/blocks/builtins/shared.js +34 -42
- package/dist/blocks/builtins/tableOfContents.d.ts +4 -0
- package/dist/blocks/builtins/tableOfContents.js +12 -18
- package/dist/blocks/builtins/tabs.d.ts +6 -0
- package/dist/blocks/builtins/tabs.js +87 -0
- package/dist/blocks/client/adjacentLinks.d.ts +4 -0
- package/dist/blocks/client/adjacentLinks.js +4 -0
- package/dist/blocks/client/carousel.d.ts +45 -0
- package/dist/blocks/client/carousel.js +53 -0
- package/dist/blocks/client/embed.d.ts +21 -0
- package/dist/blocks/client/embed.js +23 -0
- package/dist/blocks/client/field.d.ts +7 -0
- package/dist/blocks/client/field.js +8 -0
- package/dist/blocks/client/filterLink.d.ts +19 -0
- package/dist/blocks/client/filterLink.js +30 -0
- package/dist/blocks/client/helpers.d.ts +21 -0
- package/dist/blocks/client/helpers.js +24 -0
- package/dist/blocks/client/marquee.d.ts +14 -0
- package/dist/blocks/client/marquee.js +25 -0
- package/dist/blocks/client/menu.d.ts +46 -0
- package/dist/blocks/client/menu.js +49 -0
- package/dist/blocks/client/popup.d.ts +15 -0
- package/dist/blocks/client/popup.js +16 -0
- package/dist/blocks/client/tabs.d.ts +10 -0
- package/dist/blocks/client/tabs.js +11 -0
- package/dist/blocks/defaults.d.ts +15 -52
- package/dist/blocks/defaults.js +203 -437
- package/dist/blocks/index.d.ts +1 -2
- package/dist/blocks/index.js +1 -2
- package/dist/classes/actions.d.ts +97 -0
- package/dist/classes/actions.js +296 -0
- package/dist/classes/collection.d.ts +5 -0
- package/dist/classes/collection.js +189 -0
- package/dist/classes/config.d.ts +34 -0
- package/dist/classes/config.js +8 -0
- package/dist/classes/endpoints.d.ts +2 -0
- package/dist/classes/endpoints.js +120 -0
- package/dist/classes/index.d.ts +36 -0
- package/dist/classes/index.js +42 -0
- package/dist/classes/mcp.d.ts +6 -0
- package/dist/classes/mcp.js +161 -0
- package/dist/classes/shared.d.ts +131 -0
- package/dist/classes/shared.js +300 -0
- package/dist/classes/sheet.d.ts +34 -0
- package/dist/classes/sheet.js +126 -0
- package/dist/classes/usage.d.ts +57 -0
- package/dist/classes/usage.js +208 -0
- package/dist/comments/collection.d.ts +38 -0
- package/dist/comments/collection.js +226 -0
- package/dist/comments/config.d.ts +15 -0
- package/dist/comments/config.js +2 -0
- package/dist/comments/index.d.ts +20 -0
- package/dist/comments/index.js +22 -0
- package/dist/comments/shared.d.ts +54 -0
- package/dist/comments/shared.js +104 -0
- package/dist/core/bindings.d.ts +77 -32
- package/dist/core/bindings.js +319 -134
- package/dist/core/blockNames.d.ts +9 -0
- package/dist/core/blockNames.js +11 -0
- package/dist/core/blocks.d.ts +21 -8
- package/dist/core/blocks.js +37 -16
- package/dist/core/classes.d.ts +16 -8
- package/dist/core/classes.js +31 -27
- package/dist/core/components.d.ts +72 -0
- package/dist/core/components.js +294 -0
- package/dist/core/contentMode.d.ts +27 -0
- package/dist/core/contentMode.js +0 -0
- package/dist/core/dropTarget.d.ts +11 -0
- package/dist/core/dropTarget.js +24 -1
- package/dist/core/fields.d.ts +5 -0
- package/dist/core/fields.js +11 -0
- package/dist/core/headings.d.ts +5 -2
- package/dist/core/headings.js +14 -6
- package/dist/core/index.d.ts +8 -3
- package/dist/core/index.js +8 -3
- package/dist/core/layers.d.ts +9 -0
- package/dist/core/layers.js +29 -0
- package/dist/core/operations.d.ts +6 -0
- package/dist/core/operations.js +85 -24
- package/dist/core/payloadBlocks.js +5 -1
- package/dist/core/references.js +28 -0
- package/dist/core/schema.js +20 -6
- package/dist/core/sectionOrigin.d.ts +6 -0
- package/dist/core/sectionOrigin.js +21 -0
- package/dist/core/sections.d.ts +72 -0
- package/dist/core/sections.js +331 -0
- package/dist/core/templateChoice.d.ts +24 -0
- package/dist/core/templateChoice.js +43 -0
- package/dist/core/tree.js +18 -6
- package/dist/core/types.d.ts +148 -18
- package/dist/core/validate.d.ts +4 -1
- package/dist/core/validate.js +28 -11
- package/dist/core/visibility.d.ts +63 -0
- package/dist/core/visibility.js +214 -0
- package/dist/core/whereValues.d.ts +22 -0
- package/dist/core/whereValues.js +43 -0
- package/dist/css/classes.d.ts +16 -0
- package/dist/css/classes.js +172 -0
- package/dist/css/index.d.ts +32 -1
- package/dist/css/index.js +64 -5
- package/dist/css/tokens.d.ts +10 -0
- package/dist/css/tokens.js +23 -10
- package/dist/index.d.ts +5 -2
- package/dist/index.js +6 -1
- package/dist/live/contentMode.d.ts +24 -0
- package/dist/live/contentMode.js +39 -0
- package/dist/live/endpoints.js +3 -0
- package/dist/live/session.d.ts +5 -0
- package/dist/live/session.js +8 -0
- package/dist/live/types.d.ts +16 -1
- package/dist/mcp/index.d.ts +10 -1
- package/dist/mcp/index.js +146 -54
- package/dist/mcp/shared.d.ts +93 -3
- package/dist/mcp/shared.js +211 -15
- package/dist/plugin/hook.d.ts +7 -1
- package/dist/plugin/hook.js +30 -4
- package/dist/plugin/index.d.ts +19 -8
- package/dist/plugin/index.js +89 -20
- package/dist/plugin/links.d.ts +24 -0
- package/dist/plugin/links.js +27 -0
- package/dist/plugin/listCollections.d.ts +9 -7
- package/dist/plugin/listCollections.js +30 -21
- package/dist/plugin/sections.d.ts +14 -7
- package/dist/plugin/sections.js +69 -23
- package/dist/plugin/sectionsUsedIn.d.ts +6 -0
- package/dist/plugin/sectionsUsedIn.js +24 -0
- package/dist/plugin/templateEndpoint.d.ts +9 -0
- package/dist/plugin/templateEndpoint.js +49 -0
- package/dist/plugin/templates.js +23 -8
- package/dist/protocol/index.d.ts +16 -1
- package/dist/react/canvas/BuilderCanvas.js +144 -21
- package/dist/react/canvas/classes.d.ts +17 -0
- package/dist/react/canvas/classes.js +102 -0
- package/dist/react/canvas/controls.d.ts +31 -0
- package/dist/react/canvas/controls.js +75 -0
- package/dist/react/canvas/fetchDocs.d.ts +2 -2
- package/dist/react/canvas/fetchDocs.js +16 -8
- package/dist/react/canvas/measure.d.ts +9 -0
- package/dist/react/canvas/measure.js +106 -7
- package/dist/react/canvas/resolveLayout.d.ts +1 -1
- package/dist/react/canvas/resolveLayout.js +4 -3
- package/dist/react/canvas/thumbnail/ThumbnailCanvas.js +17 -4
- package/dist/react/classes/ClassesStyle.d.ts +27 -0
- package/dist/react/classes/ClassesStyle.js +27 -0
- package/dist/react/components/Button.d.ts +2 -11
- package/dist/react/components/Button.js +8 -43
- package/dist/react/components/CollectionList.d.ts +4 -1
- package/dist/react/components/CollectionList.js +10 -3
- package/dist/react/components/Container.d.ts +5 -2
- package/dist/react/components/Container.js +7 -4
- package/dist/react/components/Field.js +3 -14
- package/dist/react/components/Link.d.ts +1 -1
- package/dist/react/components/Link.js +5 -3
- package/dist/react/components/List.d.ts +1 -1
- package/dist/react/components/List.js +2 -2
- package/dist/react/components/Menu.d.ts +10 -1
- package/dist/react/components/Menu.js +39 -12
- package/dist/react/components/RichText.d.ts +3 -4
- package/dist/react/components/RichText.js +5 -5
- package/dist/react/components/builtins/Accordion.d.ts +4 -3
- package/dist/react/components/builtins/Accordion.js +6 -5
- package/dist/react/components/builtins/AdjacentLinks.d.ts +11 -0
- package/dist/react/components/builtins/AdjacentLinks.js +20 -0
- package/dist/react/components/builtins/Carousel.d.ts +21 -10
- package/dist/react/components/builtins/Carousel.js +175 -100
- package/dist/react/components/builtins/Disclosure.d.ts +4 -3
- package/dist/react/components/builtins/Disclosure.js +6 -5
- package/dist/react/components/builtins/Embed.d.ts +11 -0
- package/dist/react/components/builtins/Embed.js +23 -0
- package/dist/react/components/builtins/EmbedHtml.d.ts +15 -0
- package/dist/react/components/builtins/EmbedHtml.js +51 -0
- package/dist/react/components/builtins/EmbedPreview.d.ts +34 -0
- package/dist/react/components/builtins/EmbedPreview.js +105 -0
- package/dist/react/components/builtins/FilterLink.d.ts +1 -1
- package/dist/react/components/builtins/FilterLink.js +4 -4
- package/dist/react/components/builtins/Marquee.d.ts +8 -0
- package/dist/react/components/builtins/Marquee.js +15 -0
- package/dist/react/components/builtins/Popup.d.ts +26 -0
- package/dist/react/components/builtins/Popup.js +146 -0
- package/dist/react/components/builtins/SectionRef.d.ts +4 -3
- package/dist/react/components/builtins/SectionRef.js +9 -5
- package/dist/react/components/builtins/Tab.d.ts +7 -0
- package/dist/react/components/builtins/Tab.js +21 -0
- package/dist/react/components/builtins/TableOfContents.d.ts +17 -3
- package/dist/react/components/builtins/TableOfContents.js +22 -7
- package/dist/react/components/builtins/Tabs.d.ts +17 -0
- package/dist/react/components/builtins/Tabs.js +71 -0
- package/dist/react/components/builtins/index.d.ts +37 -20
- package/dist/react/components/builtins/index.js +54 -20
- package/dist/react/components/builtins/tabsContext.d.ts +12 -0
- package/dist/react/components/builtins/tabsContext.js +6 -0
- package/dist/react/components/index.js +11 -8
- package/dist/react/components/lazy.d.ts +32 -0
- package/dist/react/components/lazy.js +20 -0
- package/dist/react/components/lazyBlock.d.ts +17 -0
- package/dist/react/components/lazyBlock.js +23 -0
- package/dist/react/index.d.ts +6 -3
- package/dist/react/index.js +5 -2
- package/dist/react/render/RenderLayout.d.ts +9 -7
- package/dist/react/render/RenderLayout.js +96 -45
- package/dist/react/render/canvasMode.d.ts +13 -0
- package/dist/react/render/canvasMode.js +13 -0
- package/dist/react/render/canvasServer.js +4 -3
- package/dist/react/render/canvasServerTypes.d.ts +5 -0
- package/dist/react/render/lists.d.ts +36 -4
- package/dist/react/render/lists.js +132 -15
- package/dist/react/render/marks.d.ts +15 -0
- package/dist/react/render/marks.js +23 -0
- package/dist/react/render/payload.d.ts +8 -1
- package/dist/react/render/payload.js +12 -3
- package/dist/react/render/preview.d.ts +11 -0
- package/dist/react/render/preview.js +13 -0
- package/dist/react/render/relations.d.ts +10 -0
- package/dist/react/render/relations.js +39 -0
- package/dist/react/render/resolve.d.ts +8 -4
- package/dist/react/render/resolve.js +11 -5
- package/dist/react/render/reveal.d.ts +17 -0
- package/dist/react/render/reveal.js +39 -0
- package/dist/react/render/sections.d.ts +11 -5
- package/dist/react/render/sections.js +52 -24
- package/dist/react/render/templates.d.ts +47 -0
- package/dist/react/render/templates.js +139 -0
- package/dist/react/render/types.d.ts +62 -5
- package/dist/react/server.d.ts +2 -37
- package/dist/react/server.js +8 -133
- package/dist/react/theme/ThemeLiveLoader.d.ts +4 -0
- package/dist/react/theme/ThemeLiveLoader.js +5 -0
- package/dist/react/theme/ThemeStyle.js +1 -1
- package/dist/theme/admin/Variables.d.ts +11 -0
- package/dist/theme/admin/Variables.js +115 -0
- package/dist/theme/admin/fields.scss +113 -0
- package/dist/theme/client.d.ts +1 -0
- package/dist/theme/client.js +2 -0
- package/dist/theme/css.d.ts +6 -1
- package/dist/theme/css.js +12 -4
- package/dist/theme/global.js +83 -0
- package/dist/theme/index.d.ts +1 -0
- package/dist/theme/index.js +1 -0
- package/dist/theme/server.d.ts +15 -0
- package/dist/theme/server.js +43 -0
- package/dist/theme/usage.d.ts +23 -0
- package/dist/theme/usage.js +68 -0
- package/dist/theme/variables.d.ts +72 -0
- package/dist/theme/variables.js +231 -0
- package/package.json +4 -2
- package/dist/admin/editor/styles/SiteClasses.d.ts +0 -9
- package/dist/admin/editor/styles/SiteClasses.js +0 -31
- package/dist/blocks/builtins/headingId.d.ts +0 -15
- package/dist/blocks/builtins/headingId.js +0 -36
- package/dist/blocks/builtins/lightbox.d.ts +0 -43
- package/dist/blocks/builtins/lightbox.js +0 -93
- package/dist/blocks/builtins/mediaBackdrop.d.ts +0 -11
- package/dist/blocks/builtins/mediaBackdrop.js +0 -79
- package/dist/react/components/Quote.d.ts +0 -3
- package/dist/react/components/Quote.js +0 -12
- package/dist/react/components/Spacer.d.ts +0 -3
- package/dist/react/components/Spacer.js +0 -6
- package/dist/react/components/builtins/BackdropVideo.d.ts +0 -13
- package/dist/react/components/builtins/BackdropVideo.js +0 -16
- package/dist/react/components/builtins/Lightbox.d.ts +0 -45
- package/dist/react/components/builtins/Lightbox.js +0 -252
- package/dist/react/components/builtins/MediaBackdrop.d.ts +0 -14
- package/dist/react/components/builtins/MediaBackdrop.js +0 -61
package/dist/core/types.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
import type { Field } from 'payload';
|
|
1
|
+
import type { Field, PayloadRequest } from 'payload';
|
|
2
2
|
import type { AiClientConfig } from '../ai/types.js';
|
|
3
3
|
import type { BlockMotion, MotionPatch } from './motion.js';
|
|
4
|
+
import type { BlockVisibility } from './visibility.js';
|
|
5
|
+
import type { VariableToken } from '../theme/variables.js';
|
|
4
6
|
export type BlockProps = Record<string, unknown>;
|
|
5
7
|
export type Block = {
|
|
6
8
|
/** Stable id. Selection, operations and bindings use it, never an array index. */
|
|
@@ -13,10 +15,19 @@ export type Block = {
|
|
|
13
15
|
className?: string;
|
|
14
16
|
/** Child blocks by slot name. No depth limit. */
|
|
15
17
|
slots?: Record<string, Block[]>;
|
|
16
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Prop path -> binding (a field path, a fallback chain, formatters or a `{{ }}` template; see
|
|
20
|
+
* `bindingValue`). Used in templates and inside collection list and repeat items.
|
|
21
|
+
*/
|
|
17
22
|
bindings?: Record<string, string>;
|
|
18
23
|
/** Hidden blocks stay in the data but do not render on the site. */
|
|
19
24
|
hidden?: boolean;
|
|
25
|
+
/**
|
|
26
|
+
* Visibility conditions (`core/visibility.ts`): the block shows only when they match the current
|
|
27
|
+
* document (a template's document, a list item, a repeat row). Without a current document they
|
|
28
|
+
* are not checked. Stored only when it holds a condition.
|
|
29
|
+
*/
|
|
30
|
+
visibility?: BlockVisibility;
|
|
20
31
|
/**
|
|
21
32
|
* A name the editor gives the block (outline, breadcrumbs, error messages), e.g. "Hero".
|
|
22
33
|
* Never rendered on the site. Stored only when non-empty.
|
|
@@ -40,11 +51,28 @@ export type Block = {
|
|
|
40
51
|
*/
|
|
41
52
|
attrs?: BlockAttrs;
|
|
42
53
|
/**
|
|
43
|
-
* Tailwind classes of
|
|
44
|
-
* `styles: true` (
|
|
45
|
-
* Stored only when one is set.
|
|
54
|
+
* Tailwind classes of the block's inner elements, by part name (`blockParts`): a slot whose
|
|
55
|
+
* definition sets `styles: true` (the `empty` slot of a collection list) or a name in
|
|
56
|
+
* `BlockDefinition.parts` (a carousel's `arrow`). Compiled like `className`. Stored only when one is set.
|
|
57
|
+
*/
|
|
58
|
+
partClassName?: Record<string, string>;
|
|
59
|
+
/**
|
|
60
|
+
* The ready-made section this block is the root of (`core/sections.ts`): set on insert of an
|
|
61
|
+
* app section with one root block. The editor offers the section's other variants from it.
|
|
62
|
+
* Never rendered. Stored only when set.
|
|
63
|
+
*/
|
|
64
|
+
section?: SectionOrigin;
|
|
65
|
+
/**
|
|
66
|
+
* Content mode (`core/contentMode.ts`): editors without design rights may duplicate, delete and
|
|
67
|
+
* reorder this block's direct children (FAQ items, team cards), but not restyle them. Stored
|
|
68
|
+
* only when true.
|
|
46
69
|
*/
|
|
47
|
-
|
|
70
|
+
editableItems?: boolean;
|
|
71
|
+
};
|
|
72
|
+
/** Where a section's root block came from: the section id and, for a variant, the variant id. */
|
|
73
|
+
export type SectionOrigin = {
|
|
74
|
+
id: string;
|
|
75
|
+
variant?: string;
|
|
48
76
|
};
|
|
49
77
|
/** A block's own HTML attributes. Empty values are left out. */
|
|
50
78
|
export type BlockAttrs = {
|
|
@@ -87,11 +115,26 @@ export type SlotDefinition = {
|
|
|
87
115
|
*/
|
|
88
116
|
allowInline?: boolean;
|
|
89
117
|
/**
|
|
90
|
-
* The slot renders in an element of its own that takes classes (`block.
|
|
91
|
-
* The Styles panel
|
|
92
|
-
* `
|
|
118
|
+
* The slot renders in an element of its own that takes classes (`block.partClassName[slot]`):
|
|
119
|
+
* the slot is a part of the block (see `PartDefinition`). The Styles panel offers it as a style
|
|
120
|
+
* target. The component spreads `partAttributes[slot]` (which carries the `className`) on that
|
|
121
|
+
* element. Default false.
|
|
93
122
|
*/
|
|
94
123
|
styles?: boolean;
|
|
124
|
+
/** With `styles`: the classes a newly inserted block starts with on the slot's element. */
|
|
125
|
+
defaultClassName?: string;
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* A styled inner element of a block that is not a slot: a carousel's arrows, a pager's links.
|
|
129
|
+
* The block stores its classes in `block.partClassName[name]`; the Styles panel offers it as a
|
|
130
|
+
* style target; the component gets them in `partAttributes[name].className` (with the
|
|
131
|
+
* `builder-css` marker) and puts them on the element.
|
|
132
|
+
*/
|
|
133
|
+
export type PartDefinition = {
|
|
134
|
+
/** The name in the Styles panel's "Style target" list, e.g. "Arrows". */
|
|
135
|
+
label: string;
|
|
136
|
+
/** Classes a newly inserted block starts with on this part (like `defaultClassName`). */
|
|
137
|
+
defaultClassName?: string;
|
|
95
138
|
};
|
|
96
139
|
export type BlockDefinition = {
|
|
97
140
|
type: string;
|
|
@@ -113,6 +156,11 @@ export type BlockDefinition = {
|
|
|
113
156
|
inline?: boolean;
|
|
114
157
|
/** Classes a newly inserted block starts with (e.g. "flex flex-col gap-4" for a stack). */
|
|
115
158
|
defaultClassName?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Inner elements that take classes of their own, by name (`PartDefinition`). Slots with
|
|
161
|
+
* `styles: true` are parts too. A name must not be a slot name.
|
|
162
|
+
*/
|
|
163
|
+
parts?: Record<string, PartDefinition>;
|
|
116
164
|
/**
|
|
117
165
|
* Tailwind classes the block's React component uses itself. They are added to the generated
|
|
118
166
|
* CSS (save hook and canvas) whenever the block type appears in a layout.
|
|
@@ -122,6 +170,8 @@ export type BlockDefinition = {
|
|
|
122
170
|
icon?: string;
|
|
123
171
|
/** Group in the block library, e.g. "Layout", "Content", "Media", "Interactive". */
|
|
124
172
|
category?: string;
|
|
173
|
+
/** One short plain sentence for editors. The block library shows it as the tooltip. */
|
|
174
|
+
description?: string;
|
|
125
175
|
/** Text for AI tools: what the block is for, plus a small example. */
|
|
126
176
|
ai?: {
|
|
127
177
|
description: string;
|
|
@@ -151,17 +201,24 @@ export type SectionDefinition = {
|
|
|
151
201
|
*/
|
|
152
202
|
savedId?: string | number;
|
|
153
203
|
/**
|
|
154
|
-
* Other versions of the section
|
|
155
|
-
*
|
|
156
|
-
*
|
|
204
|
+
* Other versions of the section (a split hero next to a centred one). The library shows one
|
|
205
|
+
* card with arrows to flip between the versions; the editor switches an inserted section to
|
|
206
|
+
* another version in place; `insertSection` (MCP, assistant) takes `variant`. See
|
|
207
|
+
* `core/sections.ts`. Give a block the same `id` in each version to carry its edited content
|
|
208
|
+
* over exactly on a switch.
|
|
157
209
|
*/
|
|
158
210
|
variants?: SectionVariant[];
|
|
159
|
-
/**
|
|
211
|
+
/** The name of the section's own version among its variants. Default "Default". */
|
|
212
|
+
variantLabel?: string;
|
|
213
|
+
/**
|
|
214
|
+
* Set only by the old flat list (`sectionsWithVariants`): the id of the section this variant
|
|
215
|
+
* belongs to.
|
|
216
|
+
*/
|
|
160
217
|
variantOf?: string;
|
|
161
218
|
};
|
|
162
219
|
/** One version of a section (`SectionDefinition.variants`). It shares the section's category. */
|
|
163
220
|
export type SectionVariant = {
|
|
164
|
-
/** Unique in the section, e.g. "split".
|
|
221
|
+
/** Unique in the section, e.g. "split". `insertSection` takes it as `variant`. */
|
|
165
222
|
id: string;
|
|
166
223
|
label: string;
|
|
167
224
|
description?: string;
|
|
@@ -185,6 +242,11 @@ export type BindingField = {
|
|
|
185
242
|
type: string;
|
|
186
243
|
relationTo?: string | string[];
|
|
187
244
|
hasMany?: boolean;
|
|
245
|
+
/** The options of a select or radio field, for condition values. */
|
|
246
|
+
options?: Array<{
|
|
247
|
+
label: string;
|
|
248
|
+
value: string;
|
|
249
|
+
}>;
|
|
188
250
|
children?: BindingField[];
|
|
189
251
|
};
|
|
190
252
|
/** Template data for the editor. Null when no collection uses templates. */
|
|
@@ -242,6 +304,21 @@ export type BuilderClientConfig = {
|
|
|
242
304
|
* library's section thumbnails follow it. Null without the theme global.
|
|
243
305
|
*/
|
|
244
306
|
themeEndpoint: string | null;
|
|
307
|
+
/**
|
|
308
|
+
* Editable classes (`websiteBuilder({ classes })`): the classes collection and the plugin's class
|
|
309
|
+
* endpoints. Null or left out when turned off. Shape: `ClassesClientConfig` in `classes/shared.ts`.
|
|
310
|
+
*/
|
|
311
|
+
classes?: {
|
|
312
|
+
collection: string;
|
|
313
|
+
endpoint: string;
|
|
314
|
+
} | null;
|
|
315
|
+
/**
|
|
316
|
+
* Comments on the canvas (`websiteBuilder({ comments })`): the comments collection, read and
|
|
317
|
+
* written over Payload's REST API. Null or left out when turned off.
|
|
318
|
+
*/
|
|
319
|
+
comments?: {
|
|
320
|
+
collection: string;
|
|
321
|
+
} | null;
|
|
245
322
|
/** Editor behaviour from `websiteBuilder({ editor })`. */
|
|
246
323
|
editor: EditorClientConfig;
|
|
247
324
|
/**
|
|
@@ -329,9 +406,31 @@ export type DragMode = 'indicator' | 'smooth';
|
|
|
329
406
|
export type EditorOptions = {
|
|
330
407
|
/** The default drag and drop style. Each user can change it in the editor. Default 'indicator'. */
|
|
331
408
|
dragMode?: DragMode;
|
|
409
|
+
/**
|
|
410
|
+
* While a block is dragged, thin dashed outlines show every slot on the canvas that takes it.
|
|
411
|
+
* Each user can turn them off in the editor. Default true.
|
|
412
|
+
*/
|
|
413
|
+
dropOutlines?: boolean;
|
|
414
|
+
/**
|
|
415
|
+
* Opening a saved document of a builder collection in the admin goes straight to the
|
|
416
|
+
* full-screen builder. A new document keeps Payload's create form until its first save. The
|
|
417
|
+
* builder's "All fields" menu item still opens the form. Default false.
|
|
418
|
+
*/
|
|
419
|
+
openInBuilder?: boolean;
|
|
420
|
+
/**
|
|
421
|
+
* Who may change the design. Users for whom it returns false get content mode: they change
|
|
422
|
+
* text, images and links only (see the README's "Content mode"). The server enforces it on every
|
|
423
|
+
* write. Default: everyone.
|
|
424
|
+
*/
|
|
425
|
+
canEditDesign?: (args: {
|
|
426
|
+
req: PayloadRequest;
|
|
427
|
+
user: PayloadRequest['user'];
|
|
428
|
+
}) => boolean | Promise<boolean>;
|
|
332
429
|
};
|
|
333
430
|
export type EditorClientConfig = {
|
|
334
431
|
dragMode: DragMode;
|
|
432
|
+
dropOutlines: boolean;
|
|
433
|
+
openInBuilder: boolean;
|
|
335
434
|
};
|
|
336
435
|
/** A named theme value, e.g. { name: "primary", value: "var(--primary)" } for `--color-primary`. */
|
|
337
436
|
export type ThemeToken = {
|
|
@@ -369,10 +468,16 @@ export type StyleTokens = {
|
|
|
369
468
|
classList: string[];
|
|
370
469
|
/**
|
|
371
470
|
* The site's own static `@utility` classes (`type-h2`, `btn-primary`, `glass`), in CSS order, from
|
|
372
|
-
* the CSS entry and the files it imports (not from packages). The
|
|
373
|
-
*
|
|
471
|
+
* the CSS entry and the files it imports (not from packages). The Classes box suggests them
|
|
472
|
+
* first, with their labels. Left out by servers before this field existed.
|
|
374
473
|
*/
|
|
375
474
|
siteClasses?: SiteClass[];
|
|
475
|
+
/**
|
|
476
|
+
* The theme's design variables (named colors, sizes and fonts, `theme/variables.ts`). Their
|
|
477
|
+
* names are in `colors`, `spacing` and `fonts` too; the Styles panel lists them first. Left out
|
|
478
|
+
* without variables.
|
|
479
|
+
*/
|
|
480
|
+
variables?: VariableToken[];
|
|
376
481
|
};
|
|
377
482
|
/** One `@utility` class of the site. A `/* @canvas Group: Label *\/` comment right above the rule sets `label` and `group`. */
|
|
378
483
|
export type SiteClass = {
|
|
@@ -430,7 +535,16 @@ export type Operation = {
|
|
|
430
535
|
locale?: string;
|
|
431
536
|
/** `null` removes the className. */
|
|
432
537
|
className?: string | null;
|
|
538
|
+
/**
|
|
539
|
+
* Classes to add (space-separated). Each class not already there goes at the end. Runs after
|
|
540
|
+
* `className` and `removeClassName`. The inverse sets the old `className`.
|
|
541
|
+
*/
|
|
542
|
+
addClassName?: string;
|
|
543
|
+
/** Classes to remove (space-separated, exact match, variant prefix included). Runs after `className`. */
|
|
544
|
+
removeClassName?: string;
|
|
433
545
|
hidden?: boolean;
|
|
546
|
+
/** Content mode: editors may duplicate, delete and reorder the block's children. */
|
|
547
|
+
editableItems?: boolean;
|
|
434
548
|
/** Shallow merge into `bindings`. A `null` value removes that binding. */
|
|
435
549
|
bindings?: Record<string, string | null>;
|
|
436
550
|
/** The editor's name for the block. `null` or "" removes it. */
|
|
@@ -442,8 +556,10 @@ export type Operation = {
|
|
|
442
556
|
motion?: MotionPatch | null;
|
|
443
557
|
/** HTML attributes. Each key given replaces that key, `null` removes it. `attrs: null` removes all. */
|
|
444
558
|
attrs?: BlockAttrsPatch | null;
|
|
445
|
-
/**
|
|
446
|
-
|
|
559
|
+
/** Visibility conditions. Replaces them all; `null` removes them. */
|
|
560
|
+
visibility?: BlockVisibility | null;
|
|
561
|
+
/** Classes per part (`blockParts`). Each part given replaces that part's classes, `null` or "" removes them. */
|
|
562
|
+
partClassName?: Record<string, string | null>;
|
|
447
563
|
};
|
|
448
564
|
/** `inverse` undoes this operation when applied in order to the resulting layout. */
|
|
449
565
|
export type ApplyResult = {
|
|
@@ -462,9 +578,11 @@ export type Rect = {
|
|
|
462
578
|
height: number;
|
|
463
579
|
};
|
|
464
580
|
export type Axis = 'x' | 'y';
|
|
581
|
+
/** `layer`: the index in `CanvasMeasurement.layers` of the layer the block shows in. Left out on the page. */
|
|
465
582
|
export type BlockRect = {
|
|
466
583
|
id: string;
|
|
467
584
|
rect: Rect;
|
|
585
|
+
layer?: number;
|
|
468
586
|
};
|
|
469
587
|
/** The element that holds a slot's children. Empty slots render a placeholder with this rect. */
|
|
470
588
|
export type SlotRect = {
|
|
@@ -473,6 +591,16 @@ export type SlotRect = {
|
|
|
473
591
|
rect: Rect;
|
|
474
592
|
axis: Axis;
|
|
475
593
|
empty: boolean;
|
|
594
|
+
layer?: number;
|
|
595
|
+
};
|
|
596
|
+
/**
|
|
597
|
+
* A box that shows over the page on the canvas: an open popup. `ownerId`: the block it belongs
|
|
598
|
+
* to; while the box is open, that block's rect is the box. Over the box the pointer reaches only
|
|
599
|
+
* the blocks in it (see `reachableAt`).
|
|
600
|
+
*/
|
|
601
|
+
export type LayerRect = {
|
|
602
|
+
ownerId: string | null;
|
|
603
|
+
rect: Rect;
|
|
476
604
|
};
|
|
477
605
|
export type CanvasMeasurement = {
|
|
478
606
|
blocks: BlockRect[];
|
|
@@ -486,6 +614,8 @@ export type CanvasMeasurement = {
|
|
|
486
614
|
root?: Rect;
|
|
487
615
|
/** Fixed regions of the page frame. Left out without a frame. */
|
|
488
616
|
regions?: RegionRect[];
|
|
617
|
+
/** Boxes over the page (open popups), outermost first. Left out when none is open. */
|
|
618
|
+
layers?: LayerRect[];
|
|
489
619
|
viewport: {
|
|
490
620
|
width: number;
|
|
491
621
|
height: number;
|
package/dist/core/validate.d.ts
CHANGED
|
@@ -9,8 +9,11 @@ import type { BlockDefinition, LocaleSettings } from './types.js';
|
|
|
9
9
|
* publishing. Each of them can be true while someone is still typing, so drafts, autosave and
|
|
10
10
|
* live sessions keep saving unfinished work.
|
|
11
11
|
* - `unknown-prop`, `unknown-key`: warnings, never blocking.
|
|
12
|
+
* - `no-effect`: a warning, never blocking: a key that does nothing where it is (for example
|
|
13
|
+
* `visibility` on a normal page, see `contextOnlyWarnings` in src/mcp/shared.ts). `validateLayout`
|
|
14
|
+
* never returns it: it does not know where the layout renders.
|
|
12
15
|
*/
|
|
13
|
-
export type LayoutErrorCode = 'invalid' | 'required' | 'format' | 'constraint' | 'validate' | 'nesting' | 'binding' | 'unknown-prop' | 'unknown-key';
|
|
16
|
+
export type LayoutErrorCode = 'invalid' | 'required' | 'format' | 'constraint' | 'validate' | 'nesting' | 'binding' | 'unknown-prop' | 'unknown-key' | 'no-effect';
|
|
14
17
|
/**
|
|
15
18
|
* `locale`: the problem is in that locale's own values (a translation), not the default locale's.
|
|
16
19
|
* `path` still names the prop below `.props.`, so path readers work the same for every locale.
|
package/dist/core/validate.js
CHANGED
|
@@ -2,18 +2,21 @@
|
|
|
2
2
|
// the rules a schema cannot express (unique ids). Optional props may be `null` (Payload's own
|
|
3
3
|
// "empty" value); the schema leaves that out to keep it simple for AI tools.
|
|
4
4
|
import { checkAttrs } from './attrs.js';
|
|
5
|
-
import {
|
|
5
|
+
import { blockParts } from './classes.js';
|
|
6
|
+
import { getBlockDefinition, slotLabel, slotLimitText, withInlineBlocks } from './blocks.js';
|
|
6
7
|
import { conditionMet, readCondition } from './conditions.js';
|
|
7
8
|
import { formatProblem } from './formats.js';
|
|
8
9
|
import { dataFields, fieldBlocks, hasStaticDefault, optionValues } from './fields.js';
|
|
9
10
|
import { isPlainObject } from './tree.js';
|
|
10
11
|
import { motionProblems } from './motion.js';
|
|
12
|
+
import { checkSectionOrigin } from './sectionOrigin.js';
|
|
13
|
+
import { checkVisibility } from './visibility.js';
|
|
11
14
|
import { fallbackChain, localizedKeys } from './locale.js';
|
|
12
15
|
/** Codes that block publishing but not draft saves. */
|
|
13
16
|
export const PUBLISH_ONLY_CODES = new Set(['required', 'format', 'constraint', 'validate', 'nesting', 'binding']);
|
|
14
17
|
/** True when the error never blocks a save (only logged or shown). */
|
|
15
18
|
export function isLayoutWarning(error) {
|
|
16
|
-
return error.code === 'unknown-prop' || error.code === 'unknown-key';
|
|
19
|
+
return error.code === 'unknown-prop' || error.code === 'unknown-key' || error.code === 'no-effect';
|
|
17
20
|
}
|
|
18
21
|
/** True when the error blocks this save: everything but warnings, and publish-only codes only when publishing. */
|
|
19
22
|
export function isBlockingError(error, publishing) {
|
|
@@ -21,7 +24,7 @@ export function isBlockingError(error, publishing) {
|
|
|
21
24
|
return false;
|
|
22
25
|
return publishing || !PUBLISH_ONLY_CODES.has(error.code);
|
|
23
26
|
}
|
|
24
|
-
const BLOCK_KEYS = new Set(['id', 'type', 'props', 'className', 'slots', 'bindings', 'hidden', 'label', 'locales', 'motion', 'attrs', '
|
|
27
|
+
const BLOCK_KEYS = new Set(['id', 'type', 'props', 'className', 'slots', 'bindings', 'hidden', 'label', 'locales', 'motion', 'attrs', 'visibility', 'partClassName', 'section', 'editableItems']);
|
|
25
28
|
/** Checks structure, unique ids, known block types, slot rules and prop types. */
|
|
26
29
|
export function validateLayout(layout, blocks, options = {}) {
|
|
27
30
|
const errors = [];
|
|
@@ -36,7 +39,9 @@ export function validateLayout(layout, blocks, options = {}) {
|
|
|
36
39
|
const seen = new Set();
|
|
37
40
|
const localization = options.localization ?? null;
|
|
38
41
|
const htmlIds = new Map();
|
|
39
|
-
|
|
42
|
+
// Inline blocks may go into `allowInline` slots, as in the editor, also with a site's own list.
|
|
43
|
+
const definitions = withInlineBlocks(blocks);
|
|
44
|
+
layout.blocks.forEach((block, i) => checkBlock(block, `blocks[${i}]`, null, [], definitions, seen, errors, localization, htmlIds));
|
|
40
45
|
return errors;
|
|
41
46
|
}
|
|
42
47
|
const nameOf = (value, def, type) => (typeof value.label === 'string' && value.label.trim()) || def?.label || type;
|
|
@@ -99,21 +104,27 @@ function checkBlock(value, path, owner, banned, blocks, seen, errors, localizati
|
|
|
99
104
|
else if (def?.styles === false)
|
|
100
105
|
report(`${path}.className`, `Block type "${type}" does not take a className`);
|
|
101
106
|
}
|
|
102
|
-
if (value.
|
|
103
|
-
if (!isPlainObject(value.
|
|
104
|
-
report(`${path}.
|
|
107
|
+
if (value.partClassName !== undefined) {
|
|
108
|
+
if (!isPlainObject(value.partClassName))
|
|
109
|
+
report(`${path}.partClassName`, 'partClassName must be an object of part name -> classes');
|
|
105
110
|
else {
|
|
106
|
-
|
|
111
|
+
const parts = def ? new Set(blockParts(def).map((part) => part.name)) : null;
|
|
112
|
+
for (const [part, classes] of Object.entries(value.partClassName)) {
|
|
107
113
|
if (typeof classes !== 'string')
|
|
108
|
-
report(`${path}.
|
|
109
|
-
else if (def && !
|
|
110
|
-
|
|
114
|
+
report(`${path}.partClassName.${part}`, 'Part classes must be a string');
|
|
115
|
+
else if (def && parts && !parts.has(part)) {
|
|
116
|
+
const known = [...parts].join(', ');
|
|
117
|
+
report(`${path}.partClassName.${part}`, `${def.label} has no part "${part}" that takes classes${known ? ` (parts: ${known})` : ''}`);
|
|
118
|
+
}
|
|
111
119
|
}
|
|
112
120
|
}
|
|
113
121
|
}
|
|
114
122
|
if (value.hidden !== undefined && typeof value.hidden !== 'boolean') {
|
|
115
123
|
report(`${path}.hidden`, 'hidden must be a boolean');
|
|
116
124
|
}
|
|
125
|
+
if (value.editableItems !== undefined && typeof value.editableItems !== 'boolean') {
|
|
126
|
+
report(`${path}.editableItems`, 'editableItems must be a boolean');
|
|
127
|
+
}
|
|
117
128
|
if (value.label !== undefined && typeof value.label !== 'string') {
|
|
118
129
|
report(`${path}.label`, 'label must be a string');
|
|
119
130
|
}
|
|
@@ -128,6 +139,12 @@ function checkBlock(value, path, owner, banned, blocks, seen, errors, localizati
|
|
|
128
139
|
else
|
|
129
140
|
htmlIds.set(attrs.id, blockId ?? path);
|
|
130
141
|
}
|
|
142
|
+
const visibility = checkVisibility(value.visibility);
|
|
143
|
+
if (typeof visibility === 'string')
|
|
144
|
+
report(`${path}.visibility`, visibility);
|
|
145
|
+
const origin = checkSectionOrigin(value.section);
|
|
146
|
+
if (typeof origin === 'string')
|
|
147
|
+
report(`${path}.section`, origin);
|
|
131
148
|
for (const problem of motionProblems(value.motion)) {
|
|
132
149
|
report(`${path}.${problem.path}`, problem.message, problem.unknown ? 'unknown-key' : 'invalid');
|
|
133
150
|
}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The operators of a condition. The names and meanings follow Payload's `where` operators
|
|
3
|
+
* (`equals`, `in`, `greater_than`, `like`, …), plus `is_set` and `is_empty`, which need no value.
|
|
4
|
+
*/
|
|
5
|
+
export declare const VISIBILITY_OPERATORS: readonly ['is_set', 'is_empty', 'equals', 'not_equals', 'in', 'not_in', 'greater_than', 'greater_than_equal', 'less_than', 'less_than_equal', 'like', 'contains'];
|
|
6
|
+
export type VisibilityOperator = (typeof VISIBILITY_OPERATORS)[number];
|
|
7
|
+
/** A condition value: text, a number or a boolean; a list for `in` and `not_in`; none for `is_set` and `is_empty`. */
|
|
8
|
+
export type VisibilityValue = string | number | boolean | Array<string | number>;
|
|
9
|
+
/** One condition row. */
|
|
10
|
+
export type VisibilityCondition = {
|
|
11
|
+
/** A field path of the current document, or a virtual path (`$index`, `$item`, `$parent.name`, `$page.title`). */
|
|
12
|
+
field: string;
|
|
13
|
+
operator: VisibilityOperator;
|
|
14
|
+
value?: VisibilityValue;
|
|
15
|
+
/**
|
|
16
|
+
* Compare with the value of this field (the same paths as `field`) instead of `value`. A
|
|
17
|
+
* condition has `value` or `valueField`, never both.
|
|
18
|
+
*/
|
|
19
|
+
valueField?: string;
|
|
20
|
+
/** True: the condition tests the number of items of the field (an array or a hasMany field), not its value. */
|
|
21
|
+
count?: true;
|
|
22
|
+
};
|
|
23
|
+
/** Conditions that must all match: an entry of `conditions` when `match` is "any". */
|
|
24
|
+
export type VisibilityGroup = {
|
|
25
|
+
all: VisibilityCondition[];
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* A block's visibility: shown when all conditions match, or any with `match: 'any'`. With "any"
|
|
29
|
+
* an entry may be a group (`{ all: [...] }`) that matches when all its conditions match, so
|
|
30
|
+
* "any" with groups is an "or" of "and" groups.
|
|
31
|
+
*/
|
|
32
|
+
export type BlockVisibility = {
|
|
33
|
+
match?: 'any';
|
|
34
|
+
conditions: Array<VisibilityCondition | VisibilityGroup>;
|
|
35
|
+
};
|
|
36
|
+
/** Operators that take no value. */
|
|
37
|
+
export declare const VALUELESS_OPERATORS: ReadonlySet<VisibilityOperator>;
|
|
38
|
+
/** Operators that take a list of values. */
|
|
39
|
+
export declare const LIST_OPERATORS: ReadonlySet<VisibilityOperator>;
|
|
40
|
+
/** True for a group entry (`{ all: [...] }`). */
|
|
41
|
+
export declare const isVisibilityGroup: (entry: VisibilityCondition | VisibilityGroup) => entry is VisibilityGroup;
|
|
42
|
+
/**
|
|
43
|
+
* Checks stored or inserted `visibility` and returns it in canonical form: trimmed field paths,
|
|
44
|
+
* no value for `is_set`/`is_empty`, `match` only when "any", groups only under "any", `undefined`
|
|
45
|
+
* without conditions. A string is the error message.
|
|
46
|
+
*/
|
|
47
|
+
export declare function checkVisibility(value: unknown): BlockVisibility | undefined | string;
|
|
48
|
+
/** `visibility` as stored, with bad conditions dropped one by one: a stored layout never fails to load. */
|
|
49
|
+
export declare function normalizeVisibility(value: unknown): BlockVisibility | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* The conditions as "or" groups of "and" conditions: one group without "any", one group per
|
|
52
|
+
* entry with "any". The block shows when every condition of one group matches.
|
|
53
|
+
*/
|
|
54
|
+
export declare function visibilityGroups(visibility: BlockVisibility | undefined): VisibilityCondition[][];
|
|
55
|
+
/**
|
|
56
|
+
* The visibility of "or" groups of "and" conditions, in canonical form. One group: its
|
|
57
|
+
* conditions. Several: `match: "any"`, with a group entry for each group of two or more.
|
|
58
|
+
*/
|
|
59
|
+
export declare function groupsVisibility(groups: readonly VisibilityCondition[][]): BlockVisibility | undefined;
|
|
60
|
+
/** Every condition, groups flattened: for readers that need only the fields or the number. */
|
|
61
|
+
export declare const visibilityConditions: (visibility: BlockVisibility | undefined) => VisibilityCondition[];
|
|
62
|
+
/** JSON Schema of `visibility`, for the block schemas AI tools read. */
|
|
63
|
+
export declare function visibilityJsonSchema(): Record<string, unknown>;
|