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
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
// Endpoints of the editable classes. The editor writes styles with Payload's own REST API
|
|
2
|
+
// (`PATCH {api}/{collection}/{id}?draft=true&autosave=true`); these cover what REST cannot do in
|
|
3
|
+
// one call: the list for the canvas, usage, rename, delete with removal, import, and the site's
|
|
4
|
+
// stylesheet. Server-only.
|
|
5
|
+
import { deleteClass, importSiteClasses, loadClasses, namesOf, removeUnusedClasses, renameClass } from './actions.js';
|
|
6
|
+
import { loadClassesSheet } from './sheet.js';
|
|
7
|
+
import { CLASSES_PATH, CLASSES_SHEET_PATH } from './shared.js';
|
|
8
|
+
import { classUsage } from './usage.js';
|
|
9
|
+
const json = (body, status = 200, headers = {}) => Response.json(body, { status, headers: { 'Cache-Control': 'no-store', ...headers } });
|
|
10
|
+
const unauthorized = () => json({ ok: false, error: 'Sign in to edit classes.' }, 401);
|
|
11
|
+
async function readBody(req) {
|
|
12
|
+
try {
|
|
13
|
+
const value = typeof req.json === 'function' ? await req.json() : {};
|
|
14
|
+
return value && typeof value === 'object' ? value : {};
|
|
15
|
+
}
|
|
16
|
+
catch {
|
|
17
|
+
return {};
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
const reply = (result) => json(result, result.ok ? 200 : result.status);
|
|
21
|
+
const idOf = (value) => (typeof value === 'string' || typeof value === 'number') && value !== '' ? value : null;
|
|
22
|
+
export function classesEndpoints() {
|
|
23
|
+
return [
|
|
24
|
+
{
|
|
25
|
+
// The classes' latest drafts, as the user reads them: the editor's list and the canvas compile.
|
|
26
|
+
path: CLASSES_PATH,
|
|
27
|
+
method: 'get',
|
|
28
|
+
handler: async (req) => {
|
|
29
|
+
if (!req.user)
|
|
30
|
+
return unauthorized();
|
|
31
|
+
try {
|
|
32
|
+
return json({ classes: await loadClasses(req) });
|
|
33
|
+
}
|
|
34
|
+
catch (error) {
|
|
35
|
+
return json({ ok: false, error: error instanceof Error ? error.message : String(error) }, 500);
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
// Where each class is used: `{ usage: { [name]: { blocks, documents } } }`. `?names=a,b` limits it.
|
|
41
|
+
path: `${CLASSES_PATH}/usage`,
|
|
42
|
+
method: 'get',
|
|
43
|
+
handler: async (req) => {
|
|
44
|
+
if (!req.user)
|
|
45
|
+
return unauthorized();
|
|
46
|
+
const asked = typeof req.searchParams?.get === 'function' ? req.searchParams.get('names') : null;
|
|
47
|
+
const names = asked ? asked.split(',').filter(Boolean) : namesOf(await loadClasses(req));
|
|
48
|
+
return json({ usage: await classUsage(req, names) });
|
|
49
|
+
},
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
path: `${CLASSES_PATH}/rename`,
|
|
53
|
+
method: 'post',
|
|
54
|
+
handler: async (req) => {
|
|
55
|
+
if (!req.user)
|
|
56
|
+
return unauthorized();
|
|
57
|
+
const data = await readBody(req);
|
|
58
|
+
const id = idOf(data.id);
|
|
59
|
+
if (id === null || typeof data.name !== 'string')
|
|
60
|
+
return json({ ok: false, error: 'Send { id, name }.' }, 400);
|
|
61
|
+
return reply(await renameClass(req, id, data.name));
|
|
62
|
+
},
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
path: `${CLASSES_PATH}/delete`,
|
|
66
|
+
method: 'post',
|
|
67
|
+
handler: async (req) => {
|
|
68
|
+
if (!req.user)
|
|
69
|
+
return unauthorized();
|
|
70
|
+
const data = await readBody(req);
|
|
71
|
+
const id = idOf(data.id);
|
|
72
|
+
if (id === null)
|
|
73
|
+
return json({ ok: false, error: 'Send { id }.' }, 400);
|
|
74
|
+
return reply(await deleteClass(req, id, { removeFromBlocks: data.removeFromBlocks === true }));
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
// Deletes every class no layout uses (drafts, open sessions and published pages).
|
|
79
|
+
path: `${CLASSES_PATH}/remove-unused`,
|
|
80
|
+
method: 'post',
|
|
81
|
+
handler: async (req) => {
|
|
82
|
+
if (!req.user)
|
|
83
|
+
return unauthorized();
|
|
84
|
+
return reply(await removeUnusedClasses(req));
|
|
85
|
+
},
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
// Creates classes from the site's code `@utility` classes. `{ names?: string[] }` limits it.
|
|
89
|
+
path: `${CLASSES_PATH}/import`,
|
|
90
|
+
method: 'post',
|
|
91
|
+
handler: async (req) => {
|
|
92
|
+
if (!req.user)
|
|
93
|
+
return unauthorized();
|
|
94
|
+
const data = await readBody(req);
|
|
95
|
+
const names = Array.isArray(data.names) ? data.names.filter((n) => typeof n === 'string') : undefined;
|
|
96
|
+
return reply(await importSiteClasses(req, names));
|
|
97
|
+
},
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
// The site's stylesheet: `<hash>.css` is immutable (a new publish gets a new hash). Public:
|
|
101
|
+
// it holds only CSS of published classes.
|
|
102
|
+
path: `${CLASSES_SHEET_PATH}/:file`,
|
|
103
|
+
method: 'get',
|
|
104
|
+
handler: async (req) => {
|
|
105
|
+
const file = String(req.routeParams?.file ?? '');
|
|
106
|
+
const sheet = await loadClassesSheet(req.payload);
|
|
107
|
+
const css = sheet?.css ?? '';
|
|
108
|
+
const exact = Boolean(sheet?.hash) && file === `${sheet?.hash}.css`;
|
|
109
|
+
return new Response(css, {
|
|
110
|
+
status: 200,
|
|
111
|
+
headers: {
|
|
112
|
+
'Content-Type': 'text/css; charset=utf-8',
|
|
113
|
+
// An old hash (a page cached before a publish) gets the current sheet, briefly cached.
|
|
114
|
+
'Cache-Control': exact ? 'public, max-age=31536000, immutable' : 'public, max-age=60',
|
|
115
|
+
},
|
|
116
|
+
});
|
|
117
|
+
},
|
|
118
|
+
},
|
|
119
|
+
];
|
|
120
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { CollectionConfig, Endpoint, GlobalConfig } from 'payload';
|
|
2
|
+
import type { BlockDefinition } from '../core/types.js';
|
|
3
|
+
import type { CssOptions } from '../css/index.js';
|
|
4
|
+
import type { ClassesOptions, ClassesServerConfig } from './config.js';
|
|
5
|
+
import { type ClassesClientConfig } from './shared.js';
|
|
6
|
+
export * from './shared.js';
|
|
7
|
+
export { classesConfigOf, type ClassesOptions, type ClassesServerConfig } from './config.js';
|
|
8
|
+
export { classesCollection, SKIP_CLASSES_SHEET_CONTEXT } from './collection.js';
|
|
9
|
+
export { classesEndpoints } from './endpoints.js';
|
|
10
|
+
export { classNamesFor, classesSheetGlobal, compilePublishedSheet, loadClassesSheet, storeClassesSheet, type StoredClassSheet } from './sheet.js';
|
|
11
|
+
export { classUsage, countClassUses, replaceClassInLayouts, replaceClassOps, usedClassNames, type ReplaceResult } from './usage.js';
|
|
12
|
+
export { deleteClass, errorMessage, findClass, importSiteClasses, loadClasses, publishClass, publishClassesWithPage, removeUnusedClasses, unusedClasses, renameClass, upsertClass, type ActionResult, type ClassInput, } from './actions.js';
|
|
13
|
+
export type ResolvedClasses = {
|
|
14
|
+
server: ClassesServerConfig;
|
|
15
|
+
client: ClassesClientConfig;
|
|
16
|
+
collection: CollectionConfig;
|
|
17
|
+
global: GlobalConfig;
|
|
18
|
+
endpoints: Endpoint[];
|
|
19
|
+
/** Adds the hook that publishes a page's classes with the page (JSON layouts with drafts). */
|
|
20
|
+
withPublish: (collection: CollectionConfig, field: string) => CollectionConfig;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* The classes collection, the hidden stylesheet global, the endpoints and the configs, from the
|
|
24
|
+
* plugin's `classes` option (on by default; `false` turns it off). Throws on a slug clash.
|
|
25
|
+
*/
|
|
26
|
+
export declare function resolveClasses(option: ClassesOptions | boolean | undefined, args: {
|
|
27
|
+
apiRoute: string;
|
|
28
|
+
css: CssOptions;
|
|
29
|
+
blocks: BlockDefinition[];
|
|
30
|
+
collections: readonly {
|
|
31
|
+
slug: string;
|
|
32
|
+
}[];
|
|
33
|
+
globals: readonly {
|
|
34
|
+
slug: string;
|
|
35
|
+
}[];
|
|
36
|
+
}): ResolvedClasses | null;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
// Editable classes: a plugin collection of named classes (Tailwind classes plus custom CSS) that
|
|
2
|
+
// blocks use by name. Server entry. See the README section "Editable classes".
|
|
3
|
+
import { publishClassesWithPage } from './actions.js';
|
|
4
|
+
import { classesCollection } from './collection.js';
|
|
5
|
+
import { classesEndpoints } from './endpoints.js';
|
|
6
|
+
import { classesSheetGlobal } from './sheet.js';
|
|
7
|
+
import { CLASSES_PATH, CLASSES_SHEET_PATH, DEFAULT_CLASSES_SHEET_SLUG, DEFAULT_CLASSES_SLUG } from './shared.js';
|
|
8
|
+
export * from './shared.js';
|
|
9
|
+
export { classesConfigOf } from './config.js';
|
|
10
|
+
export { classesCollection, SKIP_CLASSES_SHEET_CONTEXT } from './collection.js';
|
|
11
|
+
export { classesEndpoints } from './endpoints.js';
|
|
12
|
+
export { classNamesFor, classesSheetGlobal, compilePublishedSheet, loadClassesSheet, storeClassesSheet } from './sheet.js';
|
|
13
|
+
export { classUsage, countClassUses, replaceClassInLayouts, replaceClassOps, usedClassNames } from './usage.js';
|
|
14
|
+
export { deleteClass, errorMessage, findClass, importSiteClasses, loadClasses, publishClass, publishClassesWithPage, removeUnusedClasses, unusedClasses, renameClass, upsertClass, } from './actions.js';
|
|
15
|
+
/**
|
|
16
|
+
* The classes collection, the hidden stylesheet global, the endpoints and the configs, from the
|
|
17
|
+
* plugin's `classes` option (on by default; `false` turns it off). Throws on a slug clash.
|
|
18
|
+
*/
|
|
19
|
+
export function resolveClasses(option, args) {
|
|
20
|
+
if (option === false)
|
|
21
|
+
return null;
|
|
22
|
+
const options = option === true || option === undefined ? {} : option;
|
|
23
|
+
const slug = options.slug ?? DEFAULT_CLASSES_SLUG;
|
|
24
|
+
const sheetSlug = options.sheetSlug ?? DEFAULT_CLASSES_SHEET_SLUG;
|
|
25
|
+
if (args.collections.some((c) => c.slug === slug)) {
|
|
26
|
+
throw new Error(`[websiteBuilder] A collection named "${slug}" already exists. Set \`classes.slug\` to another name, or \`classes: false\`.`);
|
|
27
|
+
}
|
|
28
|
+
if (args.globals.some((g) => g.slug === sheetSlug)) {
|
|
29
|
+
throw new Error(`[websiteBuilder] A global named "${sheetSlug}" already exists. Set \`classes.sheetSlug\` to another name, or \`classes: false\`.`);
|
|
30
|
+
}
|
|
31
|
+
const endpoint = `${args.apiRoute}${CLASSES_PATH}`;
|
|
32
|
+
return {
|
|
33
|
+
server: { slug, sheetSlug, endpoint, sheetPath: `${args.apiRoute}${CLASSES_SHEET_PATH}`, css: args.css, blocks: args.blocks },
|
|
34
|
+
client: { collection: slug, endpoint },
|
|
35
|
+
collection: classesCollection(slug, options),
|
|
36
|
+
global: classesSheetGlobal(sheetSlug),
|
|
37
|
+
endpoints: classesEndpoints(),
|
|
38
|
+
withPublish: (collection, field) => collection.versions && typeof collection.versions === 'object' && collection.versions.drafts
|
|
39
|
+
? { ...collection, hooks: { ...collection.hooks, afterChange: [...(collection.hooks?.afterChange ?? []), publishClassesWithPage(field)] } }
|
|
40
|
+
: collection,
|
|
41
|
+
};
|
|
42
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { BuilderMcpTool } from '../mcp/index.js';
|
|
2
|
+
/** How classes work, for the AI. Tool descriptions are prompts: keep them exact. */
|
|
3
|
+
export declare const CLASSES_GUIDE: string;
|
|
4
|
+
export declare function classMcpTools(options?: {
|
|
5
|
+
slug?: string;
|
|
6
|
+
}): BuilderMcpTool[];
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
// MCP tools for editable classes, in the `payload-mcp-toolkit` `customTools` format. Registered by
|
|
2
|
+
// `builderMcpTools` (src/mcp). Each tool takes `collection` (the classes collection), so the
|
|
3
|
+
// toolkit checks the API key's scope for it. Handlers run as the key's user.
|
|
4
|
+
import { z } from 'zod';
|
|
5
|
+
import { deleteClass, findClass, loadClasses, namesOf, upsertClass } from './actions.js';
|
|
6
|
+
import { DEFAULT_CLASSES_SLUG } from './shared.js';
|
|
7
|
+
import { classUsage, publishedClassUsage } from './usage.js';
|
|
8
|
+
const text = (value) => ({ content: [{ type: 'text', text: typeof value === 'string' ? value : JSON.stringify(value) }] });
|
|
9
|
+
const fail = (message, details) => ({
|
|
10
|
+
content: [{ type: 'text', text: details === undefined ? `Error: ${message}` : `Error: ${message}\n${JSON.stringify(details)}` }],
|
|
11
|
+
isError: true,
|
|
12
|
+
});
|
|
13
|
+
/** How classes work, for the AI. Tool descriptions are prompts: keep them exact. */
|
|
14
|
+
export const CLASSES_GUIDE = [
|
|
15
|
+
'Classes are named, shared styles of this site (for example "card", "btn-primary", "type-h2"). A block uses one by putting its name in its className, next to Tailwind classes: "card md:col-span-2".',
|
|
16
|
+
'A class holds `styles` (Tailwind classes with variants, exactly as in a className: "rounded-xl p-6 md:p-8 hover:shadow-lg"; another class name applies that class) and optional `css` (custom CSS inside the class rule for what Tailwind cannot express: layered gradients, "&::before { … }", @keyframes).',
|
|
17
|
+
'Changing a class restyles every block that uses it, on every page. A block\'s own Tailwind classes beat its class\'s styles. Prefer a class when the same look repeats (cards, buttons, section spacing); keep one-off tweaks as utilities on the block.',
|
|
18
|
+
'Saves are drafts: the builder\'s canvas shows them at once. The live site gets a class when it is published (publish: true), or when someone publishes a page that uses it.',
|
|
19
|
+
].join('\n');
|
|
20
|
+
/** The published pages that use one of `names`, for a tool result. Empty when there are none or the scan fails. */
|
|
21
|
+
async function livePages(req, names) {
|
|
22
|
+
const docs = await publishedClassUsage(req, names).catch(() => []);
|
|
23
|
+
return docs.map(({ collection, id, title }) => ({ collection, id, title }));
|
|
24
|
+
}
|
|
25
|
+
const summary = (item) => ({
|
|
26
|
+
name: item.name,
|
|
27
|
+
...(item.label ? { label: item.label } : {}),
|
|
28
|
+
...(item.group ? { group: item.group } : {}),
|
|
29
|
+
...(item.styles ? { styles: item.styles } : {}),
|
|
30
|
+
...(item.css ? { css: item.css } : {}),
|
|
31
|
+
...(item.previousNames?.length ? { previousNames: item.previousNames } : {}),
|
|
32
|
+
status: item.status,
|
|
33
|
+
});
|
|
34
|
+
export function classMcpTools(options = {}) {
|
|
35
|
+
const slug = options.slug ?? DEFAULT_CLASSES_SLUG;
|
|
36
|
+
// One possible value, so it may be left out: the default fills it in before the toolkit's scope check.
|
|
37
|
+
const collectionArg = z.enum([slug]).default(slug).describe(`Always "${slug}" (the classes collection; may be left out).`);
|
|
38
|
+
const nameArg = z.string().min(1).max(64).describe('The class name without the dot, e.g. "card".');
|
|
39
|
+
const listClasses = {
|
|
40
|
+
name: 'listClasses',
|
|
41
|
+
routing: { kind: 'collection', action: 'read' },
|
|
42
|
+
description: 'Lists the site\'s classes (named, shared styles such as "card" or "btn-primary") with their styles, status and how many blocks use each. The result\'s `guide` explains how classes work.',
|
|
43
|
+
parameters: { collection: collectionArg },
|
|
44
|
+
handler: async (_args, req) => {
|
|
45
|
+
try {
|
|
46
|
+
const classes = await loadClasses(req);
|
|
47
|
+
const usage = await classUsage(req, namesOf(classes));
|
|
48
|
+
return text({
|
|
49
|
+
guide: CLASSES_GUIDE,
|
|
50
|
+
classes: classes.map((item) => ({ ...summary(item), usedBy: { blocks: usage[item.name]?.blocks ?? 0, pages: usage[item.name]?.documents.length ?? 0 } })),
|
|
51
|
+
next: 'getClass for where a class is used. upsertClass to create or change one. Use a class on a block with applyOperations: update { id, addClassName: "card" }.',
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
catch (error) {
|
|
55
|
+
return fail(error instanceof Error ? error.message : String(error));
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
};
|
|
59
|
+
const getClass = {
|
|
60
|
+
name: 'getClass',
|
|
61
|
+
routing: { kind: 'collection', action: 'read' },
|
|
62
|
+
description: 'Returns one class (its latest draft) and the pages and blocks that use it.',
|
|
63
|
+
parameters: { collection: collectionArg, name: nameArg },
|
|
64
|
+
handler: async (args, req) => {
|
|
65
|
+
try {
|
|
66
|
+
const item = await findClass(req, String(args.name));
|
|
67
|
+
if (!item)
|
|
68
|
+
return fail(`No class named "${String(args.name)}". listClasses shows them.`);
|
|
69
|
+
const usage = (await classUsage(req, [item.name, ...(item.previousNames ?? [])]));
|
|
70
|
+
return text({ class: summary(item), usage: usage[item.name], ...(item.previousNames?.length ? { usageOfPreviousNames: Object.fromEntries(item.previousNames.map((n) => [n, usage[n]])) } : {}) });
|
|
71
|
+
}
|
|
72
|
+
catch (error) {
|
|
73
|
+
return fail(error instanceof Error ? error.message : String(error));
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
};
|
|
77
|
+
const upsertClassTool = {
|
|
78
|
+
name: 'upsertClass',
|
|
79
|
+
routing: { kind: 'collection', action: 'update' },
|
|
80
|
+
description: [
|
|
81
|
+
'Creates the class `name`, or changes it when it exists. Fields you leave out stay as they are; null clears one. Saves a draft; publish: true also publishes it. Without publish, the result lists the published pages that still show the old version (`publishedPagesWithOldVersion`).',
|
|
82
|
+
'`newName` renames the class and every block on every page that uses it (their drafts). Published pages keep working with the old name until they are published again.',
|
|
83
|
+
'The name must not be a Tailwind class ("flex", "shadow"). Unknown Tailwind classes in `styles` are left out of the stylesheet; invalid custom CSS blocks publishing.',
|
|
84
|
+
CLASSES_GUIDE,
|
|
85
|
+
].join('\n\n'),
|
|
86
|
+
parameters: {
|
|
87
|
+
collection: collectionArg,
|
|
88
|
+
name: nameArg,
|
|
89
|
+
newName: z.string().min(1).max(64).optional().describe('Renames the class everywhere.'),
|
|
90
|
+
label: z.string().max(120).nullable().optional().describe('A readable name, e.g. "Primary button".'),
|
|
91
|
+
group: z.string().max(60).nullable().optional().describe('Groups classes in the editor, e.g. "Buttons".'),
|
|
92
|
+
styles: z.string().nullable().optional().describe('Tailwind classes with variants, e.g. "rounded-xl p-6 md:p-8 hover:shadow-lg". Replaces all of them.'),
|
|
93
|
+
css: z.string().nullable().optional().describe('Custom CSS inside the class rule: declarations, nested rules ("&:hover { … }", "&::before { … }"), @keyframes. Replaces it.'),
|
|
94
|
+
publish: z.boolean().optional().describe('true: publish now. The live site changes on every page that uses the class.'),
|
|
95
|
+
},
|
|
96
|
+
handler: async (args, req) => {
|
|
97
|
+
const result = await upsertClass(req, {
|
|
98
|
+
name: String(args.name),
|
|
99
|
+
...(typeof args.newName === 'string' ? { newName: args.newName } : {}),
|
|
100
|
+
...(args.label !== undefined ? { label: args.label } : {}),
|
|
101
|
+
...(args.group !== undefined ? { group: args.group } : {}),
|
|
102
|
+
...(args.styles !== undefined ? { styles: args.styles } : {}),
|
|
103
|
+
...(args.css !== undefined ? { css: args.css } : {}),
|
|
104
|
+
publish: args.publish === true,
|
|
105
|
+
});
|
|
106
|
+
if (!result.ok)
|
|
107
|
+
return fail(result.error);
|
|
108
|
+
// Without publish the live site keeps the published class (and, after a rename, the old name)
|
|
109
|
+
// on every published page that uses it.
|
|
110
|
+
const oldName = String(args.name);
|
|
111
|
+
const live = args.publish === true ? [] : await livePages(req, [...new Set([oldName, result.class.name, ...(result.class.previousNames ?? [])])]);
|
|
112
|
+
const renamed = result.class.name !== oldName;
|
|
113
|
+
return text({
|
|
114
|
+
ok: true,
|
|
115
|
+
created: result.created,
|
|
116
|
+
class: summary(result.class),
|
|
117
|
+
...(result.renamed ? { renamedIn: { pages: result.renamed.documents, blocks: result.renamed.blocks, ...(result.renamed.failed.length ? { failed: result.renamed.failed } : {}) } } : {}),
|
|
118
|
+
...(live.length > 0
|
|
119
|
+
? {
|
|
120
|
+
publishedPagesWithOldVersion: live,
|
|
121
|
+
note: renamed
|
|
122
|
+
? `These published pages still show the old published version of .${oldName}. Publish the class (upsertClass with publish: true) to make the change live, then publish these pages again (publishDraft) so they use the new name.`
|
|
123
|
+
: `These published pages still show the old published version of .${result.class.name}. Publish the class (upsertClass with publish: true), or publish one of these pages (that publishes the classes it uses), to make the change live.`,
|
|
124
|
+
}
|
|
125
|
+
: {}),
|
|
126
|
+
});
|
|
127
|
+
},
|
|
128
|
+
};
|
|
129
|
+
const deleteClassTool = {
|
|
130
|
+
name: 'deleteClass',
|
|
131
|
+
routing: { kind: 'collection', action: 'delete' },
|
|
132
|
+
description: 'Deletes a class. While blocks use it, it is refused with the list of pages, unless removeFromBlocks is true: then the class is removed from those blocks (their drafts) first. Published pages lose its styles at once: the result lists them (`publishedPagesWithOldVersion`) so you can publish them again.',
|
|
133
|
+
parameters: {
|
|
134
|
+
collection: collectionArg,
|
|
135
|
+
name: nameArg,
|
|
136
|
+
removeFromBlocks: z.boolean().optional().describe('true: remove the class from every block that uses it, then delete it.'),
|
|
137
|
+
},
|
|
138
|
+
handler: async (args, req) => {
|
|
139
|
+
const item = await findClass(req, String(args.name)).catch(() => null);
|
|
140
|
+
if (!item)
|
|
141
|
+
return fail(`No class named "${String(args.name)}".`);
|
|
142
|
+
// Read before the delete. The published layouts keep the name after it.
|
|
143
|
+
const live = await livePages(req, [item.name, ...(item.previousNames ?? [])]);
|
|
144
|
+
const result = await deleteClass(req, item.id, { removeFromBlocks: args.removeFromBlocks === true });
|
|
145
|
+
if (!result.ok)
|
|
146
|
+
return fail(result.error, result.usage ? { usedOn: result.usage.documents } : undefined);
|
|
147
|
+
return text({
|
|
148
|
+
ok: true,
|
|
149
|
+
deleted: result.name,
|
|
150
|
+
removedFrom: { pages: result.replaced.documents, blocks: result.replaced.blocks },
|
|
151
|
+
...(live.length > 0
|
|
152
|
+
? {
|
|
153
|
+
publishedPagesWithOldVersion: live,
|
|
154
|
+
note: `These published pages still use .${result.name} in their published layout and lost its styles now. Their drafts no longer use it: check them, then publish them again (publishDraft).`,
|
|
155
|
+
}
|
|
156
|
+
: {}),
|
|
157
|
+
});
|
|
158
|
+
},
|
|
159
|
+
};
|
|
160
|
+
return [listClasses, getClass, upsertClassTool, deleteClassTool];
|
|
161
|
+
}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import type { SiteClass } from '../core/types.js';
|
|
2
|
+
/** Default slug of the classes collection. */
|
|
3
|
+
export declare const DEFAULT_CLASSES_SLUG = "builder-classes";
|
|
4
|
+
/** Default slug of the hidden global that stores the compiled stylesheet of the published classes. */
|
|
5
|
+
export declare const DEFAULT_CLASSES_SHEET_SLUG = "builder-classes-sheet";
|
|
6
|
+
/** Path below the API route: `GET` lists the classes (latest drafts). Sub-paths: `/usage`, `/import`, `/rename`, `/delete`, `/remove-unused`. */
|
|
7
|
+
export declare const CLASSES_PATH = "/builder/classes";
|
|
8
|
+
/** Path below the API route of the compiled stylesheet: `GET {api}/builder/classes-sheet/<hash>.css`. */
|
|
9
|
+
export declare const CLASSES_SHEET_PATH = "/builder/classes-sheet";
|
|
10
|
+
/**
|
|
11
|
+
* BroadcastChannel name. The editor posts `{ classes }` (the latest drafts, with its own unsaved
|
|
12
|
+
* edits) after every class change; canvases in the same browser compile them at once.
|
|
13
|
+
*/
|
|
14
|
+
export declare const CLASSES_CHANNEL = "payload-canvas:classes";
|
|
15
|
+
/** Server-only key in `config.custom` that holds `ClassesServerConfig`. */
|
|
16
|
+
export declare const CLASSES_CONFIG_KEY = "websiteBuilderClasses";
|
|
17
|
+
/** `context` flag: delete a class even while blocks use it (the plugin removed it from them first). */
|
|
18
|
+
export declare const FORCE_DELETE_CLASS_CONTEXT = "builderForceDeleteClass";
|
|
19
|
+
export declare const CLASS_NAME_MAX = 64;
|
|
20
|
+
/** Former names a class keeps at most (see `previousNames`). */
|
|
21
|
+
export declare const CLASS_ALIASES_MAX = 10;
|
|
22
|
+
/** One editable class as the editor, the canvas and the MCP tools see it (its newest version). */
|
|
23
|
+
export type BuilderClass = {
|
|
24
|
+
id: string | number;
|
|
25
|
+
/** The class name blocks use, e.g. "card". */
|
|
26
|
+
name: string;
|
|
27
|
+
label?: string | null;
|
|
28
|
+
group?: string | null;
|
|
29
|
+
/** Tailwind classes with variants, e.g. "rounded-xl p-6 md:p-8 hover:shadow-lg". */
|
|
30
|
+
styles?: string | null;
|
|
31
|
+
/** Custom CSS inside the class rule: declarations, nested rules (`&::before`), `@keyframes`. */
|
|
32
|
+
css?: string | null;
|
|
33
|
+
/** Names the class had when it was published before. Published pages that still use them keep their look. */
|
|
34
|
+
previousNames?: string[] | null;
|
|
35
|
+
/** `draft`: the newest version is not published (new, or has unpublished changes). */
|
|
36
|
+
status: 'draft' | 'published';
|
|
37
|
+
updatedAt?: string | null;
|
|
38
|
+
};
|
|
39
|
+
/** What the compile needs from a class. */
|
|
40
|
+
export type ClassStyleSource = Pick<BuilderClass, 'name' | 'styles' | 'css' | 'previousNames'>;
|
|
41
|
+
/** The client config of the classes (in `BuilderClientConfig.classes`). */
|
|
42
|
+
export type ClassesClientConfig = {
|
|
43
|
+
/** Slug of the classes collection, for REST writes (`{api}/{collection}/{id}`). */
|
|
44
|
+
collection: string;
|
|
45
|
+
/** Full API path of the plugin's class endpoints, e.g. "/api/builder/classes". */
|
|
46
|
+
endpoint: string;
|
|
47
|
+
};
|
|
48
|
+
/** Where one class is used: blocks in one document. */
|
|
49
|
+
export type ClassUsageDocument = {
|
|
50
|
+
collection: string;
|
|
51
|
+
id: string | number;
|
|
52
|
+
/** The document's title (its `useAsTitle` field), else its id. */
|
|
53
|
+
title: string;
|
|
54
|
+
/** Blocks (and inner parts) in this document that use the class. */
|
|
55
|
+
blocks: number;
|
|
56
|
+
};
|
|
57
|
+
/** Where one class is used, in the latest drafts (and open live sessions) of every builder collection. */
|
|
58
|
+
export type ClassUsage = {
|
|
59
|
+
blocks: number;
|
|
60
|
+
documents: ClassUsageDocument[];
|
|
61
|
+
};
|
|
62
|
+
/** Prefix of the names the compile gives classes internally. Never a class name. */
|
|
63
|
+
export declare const INTERNAL_CLASS_PREFIX = "pc-db-class-";
|
|
64
|
+
/**
|
|
65
|
+
* Why a class name is not usable, or null. Checks the form only (a CSS identifier without escapes,
|
|
66
|
+
* no variant prefix); `tailwindUtilityProblem` (server) checks that Tailwind has no utility with it.
|
|
67
|
+
*/
|
|
68
|
+
export declare function classNameProblem(name: unknown): string | null;
|
|
69
|
+
/** The variant prefix ("md:hover:"), the bare class and an important mark of one class token. */
|
|
70
|
+
export declare function splitClassToken(token: string): {
|
|
71
|
+
prefix: string;
|
|
72
|
+
bare: string;
|
|
73
|
+
important: boolean;
|
|
74
|
+
};
|
|
75
|
+
/** The bare class of a token: "md:hover:card!" -> "card". */
|
|
76
|
+
export declare const bareClass: (token: string) => string;
|
|
77
|
+
export declare const classTokens: (className: string | null | undefined) => string[];
|
|
78
|
+
/** True when a class string uses the class, with or without a variant prefix. */
|
|
79
|
+
export declare function usesClass(className: string | null | undefined, name: string): boolean;
|
|
80
|
+
/**
|
|
81
|
+
* Replaces every use of class `from` in a class string with `to` (keeping each variant prefix and
|
|
82
|
+
* important mark), or removes it when `to` is null. Duplicates go; the order stays.
|
|
83
|
+
*/
|
|
84
|
+
export declare function replaceClass(className: string | null | undefined, from: string, to: string | null): string;
|
|
85
|
+
/** Removes the tokens whose bare class is in `names`. For page compiles: these classes come from the classes stylesheet. */
|
|
86
|
+
export declare function withoutClassNames(classes: readonly string[], names: ReadonlySet<string>): string[];
|
|
87
|
+
/** Every name the classes answer to: their names and their former names. */
|
|
88
|
+
export declare function classNamesOf(classes: readonly ClassStyleSource[]): Set<string>;
|
|
89
|
+
/**
|
|
90
|
+
* Why a class's custom CSS cannot compile, or null: unbalanced braces, brackets or quotes, an
|
|
91
|
+
* at-rule that would change the design system (`@import`, `@theme`, `@utility`, …), or text that
|
|
92
|
+
* would end a `<style>` tag.
|
|
93
|
+
*/
|
|
94
|
+
export declare function cssProblem(css: string | null | undefined): string | null;
|
|
95
|
+
/** One space between classes, no empty value. */
|
|
96
|
+
export declare const normalizeStyles: (value: unknown) => string | null;
|
|
97
|
+
/** A classes document (REST or Local API, depth 0) as a `BuilderClass`. Null without an id or name. */
|
|
98
|
+
export declare function toBuilderClass(doc: Record<string, unknown>): BuilderClass | null;
|
|
99
|
+
/** Former names to keep after a rename: the old name first, without the new name and duplicates. */
|
|
100
|
+
export declare function withPreviousName(previous: readonly string[] | null | undefined, oldName: string, newName: string): string[];
|
|
101
|
+
/** A short preview of what a class does, for tooltips and suggestions. */
|
|
102
|
+
export declare function classPreview(item: Pick<BuilderClass, 'styles' | 'css'>, max?: number): string;
|
|
103
|
+
/**
|
|
104
|
+
* The classes as site classes for the Classes box suggestions and the AI's tokens: the editable
|
|
105
|
+
* classes first, then the code classes (`@utility` in the site's CSS) that no editable class replaces.
|
|
106
|
+
*/
|
|
107
|
+
export declare function mergeSiteClasses(classes: readonly BuilderClass[], code: readonly SiteClass[] | undefined): SiteClass[];
|
|
108
|
+
/** "1 block", "3 blocks". */
|
|
109
|
+
export declare const plural: (count: number, one: string, many?: string) => string;
|
|
110
|
+
/** "changes 12 blocks on 3 pages", "is not used yet". */
|
|
111
|
+
export declare function usageText(usage: ClassUsage | null | undefined): string;
|
|
112
|
+
/** One `@utility` rule of the site's CSS with its full body (see `siteClassRules` in css/tokens.ts). */
|
|
113
|
+
export type SiteClassRule = {
|
|
114
|
+
name: string;
|
|
115
|
+
label?: string;
|
|
116
|
+
group?: string;
|
|
117
|
+
body: string;
|
|
118
|
+
};
|
|
119
|
+
/** The data of a class made from a code `@utility` rule: `@apply` lists become `styles`, everything else `css`. */
|
|
120
|
+
export type ImportedClass = {
|
|
121
|
+
name: string;
|
|
122
|
+
label: string | null;
|
|
123
|
+
group: string | null;
|
|
124
|
+
styles: string | null;
|
|
125
|
+
css: string | null;
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* Converts a code `@utility` rule into class data. `@apply a b;` statements (without `!important`)
|
|
129
|
+
* become `styles`; declarations, nested rules and anything else stay as `css`, in their order.
|
|
130
|
+
*/
|
|
131
|
+
export declare function importSiteClass(rule: SiteClassRule): ImportedClass;
|