payload-canvas 0.4.0 → 0.5.1

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.
Files changed (468) hide show
  1. package/README.md +626 -154
  2. package/dist/admin/AiKeyField.d.ts +8 -0
  3. package/dist/admin/AiKeyField.js +54 -0
  4. package/dist/admin/BuilderTab.js +4 -1
  5. package/dist/admin/DocumentEditView.d.ts +9 -0
  6. package/dist/admin/DocumentEditView.js +45 -0
  7. package/dist/admin/LayoutField.d.ts +2 -2
  8. package/dist/admin/LayoutField.js +10 -7
  9. package/dist/admin/TemplateConditionsField.d.ts +9 -0
  10. package/dist/admin/TemplateConditionsField.js +22 -0
  11. package/dist/admin/aiKeyField.scss +58 -0
  12. package/dist/admin/client.d.ts +3 -0
  13. package/dist/admin/client.js +6 -0
  14. package/dist/admin/diff/changes.js +5 -0
  15. package/dist/admin/editor/Canvas.js +20 -5
  16. package/dist/admin/editor/Editor.d.ts +3 -1
  17. package/dist/admin/editor/Editor.js +6 -3
  18. package/dist/admin/editor/Inspector.js +75 -28
  19. package/dist/admin/editor/Library.js +40 -15
  20. package/dist/admin/editor/Outline.js +21 -16
  21. package/dist/admin/editor/Overlay.js +8 -3
  22. package/dist/admin/editor/actions.d.ts +10 -2
  23. package/dist/admin/editor/actions.js +18 -3
  24. package/dist/admin/editor/assistant/AssistantPanel.js +3 -1
  25. package/dist/admin/editor/classes/ClassManager.d.ts +4 -0
  26. package/dist/admin/editor/classes/ClassManager.js +56 -0
  27. package/dist/admin/editor/classes/controller.d.ts +112 -0
  28. package/dist/admin/editor/classes/controller.js +326 -0
  29. package/dist/admin/editor/classes/manager.scss +262 -0
  30. package/dist/admin/editor/classes/managerModel.d.ts +5 -0
  31. package/dist/admin/editor/classes/managerModel.js +27 -0
  32. package/dist/admin/editor/comments/CommentLayer.d.ts +2 -0
  33. package/dist/admin/editor/comments/CommentLayer.js +143 -0
  34. package/dist/admin/editor/comments/CommentsPanel.d.ts +8 -0
  35. package/dist/admin/editor/comments/CommentsPanel.js +73 -0
  36. package/dist/admin/editor/comments/Thread.d.ts +26 -0
  37. package/dist/admin/editor/comments/Thread.js +84 -0
  38. package/dist/admin/editor/comments/comments.scss +539 -0
  39. package/dist/admin/editor/comments/controller.d.ts +48 -0
  40. package/dist/admin/editor/comments/controller.js +142 -0
  41. package/dist/admin/editor/contentMode.d.ts +17 -0
  42. package/dist/admin/editor/contentMode.js +37 -0
  43. package/dist/admin/editor/dnd/DropOutlines.d.ts +1 -0
  44. package/dist/admin/editor/dnd/DropOutlines.js +73 -0
  45. package/dist/admin/editor/dnd/dnd.scss +43 -0
  46. package/dist/admin/editor/dnd/mode.d.ts +4 -0
  47. package/dist/admin/editor/dnd/mode.js +39 -0
  48. package/dist/admin/editor/editor.scss +13 -58
  49. package/dist/admin/editor/empty/EmptyStart.js +18 -66
  50. package/dist/admin/editor/fields/AddButton.d.ts +15 -0
  51. package/dist/admin/editor/fields/AddButton.js +14 -0
  52. package/dist/admin/editor/fields/ArrayField.js +3 -2
  53. package/dist/admin/editor/fields/CheckedInputs.d.ts +1 -0
  54. package/dist/admin/editor/fields/ConditionRows.d.ts +19 -0
  55. package/dist/admin/editor/fields/ConditionRows.js +137 -0
  56. package/dist/admin/editor/fields/ListWhereField.d.ts +8 -0
  57. package/dist/admin/editor/fields/ListWhereField.js +20 -0
  58. package/dist/admin/editor/fields/QueryFiltersField.d.ts +18 -0
  59. package/dist/admin/editor/fields/QueryFiltersField.js +41 -0
  60. package/dist/admin/editor/fields/RelatedField.d.ts +19 -0
  61. package/dist/admin/editor/fields/RelatedField.js +44 -0
  62. package/dist/admin/editor/fields/SortField.d.ts +13 -0
  63. package/dist/admin/editor/fields/SortField.js +37 -0
  64. package/dist/admin/editor/fields/WhereField.d.ts +12 -4
  65. package/dist/admin/editor/fields/WhereField.js +33 -53
  66. package/dist/admin/editor/fields/collectionFields.d.ts +6 -0
  67. package/dist/admin/editor/fields/collectionFields.js +15 -0
  68. package/dist/admin/editor/fields/conditions.d.ts +99 -0
  69. package/dist/admin/editor/fields/conditions.js +339 -0
  70. package/dist/admin/editor/fields/fields.scss +232 -9
  71. package/dist/admin/editor/fields/listOptions.d.ts +44 -0
  72. package/dist/admin/editor/fields/listOptions.js +111 -0
  73. package/dist/admin/editor/fields/queryFilterRows.d.ts +8 -0
  74. package/dist/admin/editor/fields/queryFilterRows.js +29 -0
  75. package/dist/admin/editor/fields/whereRows.d.ts +11 -12
  76. package/dist/admin/editor/fields/whereRows.js +83 -34
  77. package/dist/admin/editor/icons.d.ts +16 -1
  78. package/dist/admin/editor/icons.js +30 -1
  79. package/dist/admin/editor/inline.js +9 -0
  80. package/dist/admin/editor/insert/InsertHandle.js +4 -1
  81. package/dist/admin/editor/insert/picker.d.ts +3 -1
  82. package/dist/admin/editor/insert/picker.js +17 -10
  83. package/dist/admin/editor/insert/spots.d.ts +12 -1
  84. package/dist/admin/editor/insert/spots.js +49 -10
  85. package/dist/admin/editor/layout/LeftPanel.js +11 -6
  86. package/dist/admin/editor/live/useMultiplayer.js +9 -1
  87. package/dist/admin/editor/menu/blockMenu.js +27 -17
  88. package/dist/admin/editor/names.js +11 -3
  89. package/dist/admin/editor/renderField.d.ts +3 -1
  90. package/dist/admin/editor/renderField.js +63 -12
  91. package/dist/admin/editor/runtime.d.ts +14 -0
  92. package/dist/admin/editor/runtime.js +67 -6
  93. package/dist/admin/editor/sections/ComponentFields.d.ts +8 -0
  94. package/dist/admin/editor/sections/ComponentFields.js +116 -0
  95. package/dist/admin/editor/sections/PropertyControls.d.ts +18 -0
  96. package/dist/admin/editor/sections/PropertyControls.js +65 -0
  97. package/dist/admin/editor/sections/components.d.ts +29 -0
  98. package/dist/admin/editor/sections/components.js +112 -0
  99. package/dist/admin/editor/sections/components.scss +238 -0
  100. package/dist/admin/editor/sections/variants.d.ts +32 -0
  101. package/dist/admin/editor/sections/variants.js +59 -0
  102. package/dist/admin/editor/sections/variants.scss +90 -0
  103. package/dist/admin/editor/shortcuts.d.ts +4 -1
  104. package/dist/admin/editor/shortcuts.js +19 -3
  105. package/dist/admin/editor/store.d.ts +18 -0
  106. package/dist/admin/editor/store.js +46 -0
  107. package/dist/admin/editor/styles/ClassBar.d.ts +14 -0
  108. package/dist/admin/editor/styles/ClassBar.js +90 -0
  109. package/dist/admin/editor/styles/ClassCss.d.ts +4 -0
  110. package/dist/admin/editor/styles/ClassCss.js +28 -0
  111. package/dist/admin/editor/styles/ClassDialog.d.ts +2 -0
  112. package/dist/admin/editor/styles/ClassDialog.js +151 -0
  113. package/dist/admin/editor/styles/ColorPicker.js +5 -2
  114. package/dist/admin/editor/styles/RawClasses.d.ts +26 -1
  115. package/dist/admin/editor/styles/RawClasses.js +184 -32
  116. package/dist/admin/editor/styles/StylesPanel.d.ts +3 -3
  117. package/dist/admin/editor/styles/StylesPanel.js +53 -14
  118. package/dist/admin/editor/styles/VariantBar.js +2 -2
  119. package/dist/admin/editor/styles/classEdit.d.ts +4 -0
  120. package/dist/admin/editor/styles/classEdit.js +20 -0
  121. package/dist/admin/editor/styles/classes.scss +381 -0
  122. package/dist/admin/editor/styles/context.d.ts +19 -6
  123. package/dist/admin/editor/styles/context.js +24 -6
  124. package/dist/admin/editor/styles/controls.d.ts +3 -1
  125. package/dist/admin/editor/styles/controls.js +30 -12
  126. package/dist/admin/editor/styles/popover.d.ts +6 -0
  127. package/dist/admin/editor/styles/popover.js +5 -5
  128. package/dist/admin/editor/styles/styles.scss +26 -104
  129. package/dist/admin/editor/styles/suggestions.d.ts +22 -0
  130. package/dist/admin/editor/styles/suggestions.js +77 -0
  131. package/dist/admin/editor/styles/tokens.js +14 -0
  132. package/dist/admin/editor/templates/Bindable.js +86 -57
  133. package/dist/admin/editor/templates/SamplePicker.js +1 -1
  134. package/dist/admin/editor/templates/Visibility.d.ts +9 -0
  135. package/dist/admin/editor/templates/Visibility.js +54 -0
  136. package/dist/admin/editor/templates/binding.d.ts +2 -2
  137. package/dist/admin/editor/templates/binding.js +2 -2
  138. package/dist/admin/editor/templates/templates.scss +27 -0
  139. package/dist/admin/editor/templates/visibilityRows.d.ts +22 -0
  140. package/dist/admin/editor/templates/visibilityRows.js +83 -0
  141. package/dist/admin/editor/topbar/ContentModeToggle.d.ts +5 -0
  142. package/dist/admin/editor/topbar/ContentModeToggle.js +26 -0
  143. package/dist/admin/editor/topbar/DocumentActions.d.ts +1 -1
  144. package/dist/admin/editor/topbar/DocumentActions.js +5 -4
  145. package/dist/admin/editor/topbar/DocumentTitle.js +7 -2
  146. package/dist/admin/editor/topbar/TopBar.js +15 -3
  147. package/dist/admin/editor/topbar/contentMode.scss +35 -0
  148. package/dist/admin/editor/topbar/topbar.scss +3 -1
  149. package/dist/admin/formChoice.d.ts +3 -0
  150. package/dist/admin/formChoice.js +10 -0
  151. package/dist/admin/layoutField.scss +69 -0
  152. package/dist/admin/screen/BuilderScreen.d.ts +6 -1
  153. package/dist/admin/screen/BuilderScreen.js +4 -3
  154. package/dist/admin/server/BuilderView.js +10 -3
  155. package/dist/admin/templateConditions.scss +24 -0
  156. package/dist/ai/adapters/anthropic.js +17 -4
  157. package/dist/ai/adapters/cloudflare-gateway.js +7 -1
  158. package/dist/ai/adapters/cloudflare-workers-ai.js +2 -0
  159. package/dist/ai/adapters/openai-compatible.js +1 -0
  160. package/dist/ai/adapters/openrouter.js +2 -0
  161. package/dist/ai/config.d.ts +24 -4
  162. package/dist/ai/config.js +27 -8
  163. package/dist/ai/endpoint.d.ts +5 -2
  164. package/dist/ai/endpoint.js +31 -26
  165. package/dist/ai/images/cloudflare-workers-ai.js +6 -2
  166. package/dist/ai/images/openai.js +8 -3
  167. package/dist/ai/images/openrouter.js +6 -2
  168. package/dist/ai/images/service.d.ts +10 -4
  169. package/dist/ai/images/service.js +23 -7
  170. package/dist/ai/openai-format.d.ts +7 -0
  171. package/dist/ai/openai-format.js +17 -5
  172. package/dist/ai/prompt.d.ts +8 -0
  173. package/dist/ai/prompt.js +25 -5
  174. package/dist/ai/settings/index.d.ts +62 -0
  175. package/dist/ai/settings/index.js +264 -0
  176. package/dist/ai/settings/secret.d.ts +11 -0
  177. package/dist/ai/settings/secret.js +46 -0
  178. package/dist/ai/settings/shared.d.ts +22 -0
  179. package/dist/ai/settings/shared.js +3 -0
  180. package/dist/ai/tools.d.ts +3 -0
  181. package/dist/ai/tools.js +79 -15
  182. package/dist/ai/types.d.ts +43 -0
  183. package/dist/blocks/builtins/adjacentLinks.d.ts +5 -0
  184. package/dist/blocks/builtins/adjacentLinks.js +76 -0
  185. package/dist/blocks/builtins/carousel.d.ts +2 -29
  186. package/dist/blocks/builtins/carousel.js +44 -51
  187. package/dist/blocks/builtins/disclosure.d.ts +2 -1
  188. package/dist/blocks/builtins/disclosure.js +22 -32
  189. package/dist/blocks/builtins/embed.d.ts +15 -0
  190. package/dist/blocks/builtins/embed.js +47 -0
  191. package/dist/blocks/builtins/faq.d.ts +1 -1
  192. package/dist/blocks/builtins/faq.js +2 -2
  193. package/dist/blocks/builtins/filterLink.d.ts +1 -19
  194. package/dist/blocks/builtins/filterLink.js +9 -50
  195. package/dist/blocks/builtins/icon.d.ts +2 -0
  196. package/dist/blocks/builtins/icon.js +8 -8
  197. package/dist/blocks/builtins/index.d.ts +18 -13
  198. package/dist/blocks/builtins/index.js +43 -22
  199. package/dist/blocks/builtins/marquee.d.ts +5 -0
  200. package/dist/blocks/builtins/marquee.js +68 -0
  201. package/dist/blocks/builtins/popup.d.ts +5 -0
  202. package/dist/blocks/builtins/popup.js +83 -0
  203. package/dist/blocks/builtins/sectionRef.d.ts +16 -2
  204. package/dist/blocks/builtins/sectionRef.js +34 -12
  205. package/dist/blocks/builtins/shared.d.ts +18 -23
  206. package/dist/blocks/builtins/shared.js +34 -42
  207. package/dist/blocks/builtins/tableOfContents.d.ts +4 -0
  208. package/dist/blocks/builtins/tableOfContents.js +12 -18
  209. package/dist/blocks/builtins/tabs.d.ts +6 -0
  210. package/dist/blocks/builtins/tabs.js +87 -0
  211. package/dist/blocks/client/adjacentLinks.d.ts +4 -0
  212. package/dist/blocks/client/adjacentLinks.js +4 -0
  213. package/dist/blocks/client/carousel.d.ts +45 -0
  214. package/dist/blocks/client/carousel.js +53 -0
  215. package/dist/blocks/client/embed.d.ts +21 -0
  216. package/dist/blocks/client/embed.js +23 -0
  217. package/dist/blocks/client/field.d.ts +7 -0
  218. package/dist/blocks/client/field.js +8 -0
  219. package/dist/blocks/client/filterLink.d.ts +19 -0
  220. package/dist/blocks/client/filterLink.js +30 -0
  221. package/dist/blocks/client/helpers.d.ts +21 -0
  222. package/dist/blocks/client/helpers.js +24 -0
  223. package/dist/blocks/client/marquee.d.ts +14 -0
  224. package/dist/blocks/client/marquee.js +25 -0
  225. package/dist/blocks/client/menu.d.ts +46 -0
  226. package/dist/blocks/client/menu.js +49 -0
  227. package/dist/blocks/client/popup.d.ts +15 -0
  228. package/dist/blocks/client/popup.js +16 -0
  229. package/dist/blocks/client/tabs.d.ts +10 -0
  230. package/dist/blocks/client/tabs.js +11 -0
  231. package/dist/blocks/defaults.d.ts +15 -52
  232. package/dist/blocks/defaults.js +203 -437
  233. package/dist/blocks/index.d.ts +1 -1
  234. package/dist/blocks/index.js +2 -1
  235. package/dist/classes/actions.d.ts +97 -0
  236. package/dist/classes/actions.js +296 -0
  237. package/dist/classes/collection.d.ts +5 -0
  238. package/dist/classes/collection.js +189 -0
  239. package/dist/classes/config.d.ts +34 -0
  240. package/dist/classes/config.js +8 -0
  241. package/dist/classes/endpoints.d.ts +2 -0
  242. package/dist/classes/endpoints.js +120 -0
  243. package/dist/classes/index.d.ts +36 -0
  244. package/dist/classes/index.js +42 -0
  245. package/dist/classes/mcp.d.ts +6 -0
  246. package/dist/classes/mcp.js +161 -0
  247. package/dist/classes/shared.d.ts +131 -0
  248. package/dist/classes/shared.js +300 -0
  249. package/dist/classes/sheet.d.ts +34 -0
  250. package/dist/classes/sheet.js +126 -0
  251. package/dist/classes/usage.d.ts +57 -0
  252. package/dist/classes/usage.js +208 -0
  253. package/dist/comments/collection.d.ts +38 -0
  254. package/dist/comments/collection.js +226 -0
  255. package/dist/comments/config.d.ts +15 -0
  256. package/dist/comments/config.js +2 -0
  257. package/dist/comments/index.d.ts +20 -0
  258. package/dist/comments/index.js +22 -0
  259. package/dist/comments/shared.d.ts +54 -0
  260. package/dist/comments/shared.js +104 -0
  261. package/dist/core/bindings.d.ts +77 -32
  262. package/dist/core/bindings.js +319 -134
  263. package/dist/core/blockNames.d.ts +9 -0
  264. package/dist/core/blockNames.js +11 -0
  265. package/dist/core/blocks.d.ts +21 -8
  266. package/dist/core/blocks.js +37 -16
  267. package/dist/core/classes.d.ts +16 -8
  268. package/dist/core/classes.js +31 -27
  269. package/dist/core/components.d.ts +72 -0
  270. package/dist/core/components.js +294 -0
  271. package/dist/core/contentMode.d.ts +27 -0
  272. package/dist/core/contentMode.js +0 -0
  273. package/dist/core/dropTarget.d.ts +11 -0
  274. package/dist/core/dropTarget.js +24 -1
  275. package/dist/core/fields.d.ts +5 -0
  276. package/dist/core/fields.js +11 -0
  277. package/dist/core/headings.d.ts +5 -2
  278. package/dist/core/headings.js +14 -6
  279. package/dist/core/index.d.ts +8 -3
  280. package/dist/core/index.js +8 -3
  281. package/dist/core/layers.d.ts +9 -0
  282. package/dist/core/layers.js +29 -0
  283. package/dist/core/operations.d.ts +6 -0
  284. package/dist/core/operations.js +85 -24
  285. package/dist/core/payloadBlocks.js +5 -1
  286. package/dist/core/references.js +28 -0
  287. package/dist/core/schema.js +20 -6
  288. package/dist/core/sectionOrigin.d.ts +6 -0
  289. package/dist/core/sectionOrigin.js +21 -0
  290. package/dist/core/sections.d.ts +72 -0
  291. package/dist/core/sections.js +331 -0
  292. package/dist/core/templateChoice.d.ts +24 -0
  293. package/dist/core/templateChoice.js +43 -0
  294. package/dist/core/tree.js +18 -6
  295. package/dist/core/types.d.ts +148 -18
  296. package/dist/core/validate.d.ts +4 -1
  297. package/dist/core/validate.js +28 -11
  298. package/dist/core/visibility.d.ts +63 -0
  299. package/dist/core/visibility.js +214 -0
  300. package/dist/core/whereValues.d.ts +22 -0
  301. package/dist/core/whereValues.js +43 -0
  302. package/dist/css/classes.d.ts +16 -0
  303. package/dist/css/classes.js +172 -0
  304. package/dist/css/index.d.ts +32 -1
  305. package/dist/css/index.js +64 -5
  306. package/dist/css/tokens.d.ts +10 -0
  307. package/dist/css/tokens.js +23 -10
  308. package/dist/index.d.ts +5 -2
  309. package/dist/index.js +6 -1
  310. package/dist/live/contentMode.d.ts +24 -0
  311. package/dist/live/contentMode.js +39 -0
  312. package/dist/live/endpoints.js +3 -0
  313. package/dist/live/session.d.ts +5 -0
  314. package/dist/live/session.js +8 -0
  315. package/dist/live/types.d.ts +16 -1
  316. package/dist/mcp/index.d.ts +10 -1
  317. package/dist/mcp/index.js +146 -54
  318. package/dist/mcp/shared.d.ts +93 -3
  319. package/dist/mcp/shared.js +211 -15
  320. package/dist/plugin/hook.d.ts +7 -1
  321. package/dist/plugin/hook.js +30 -4
  322. package/dist/plugin/index.d.ts +19 -8
  323. package/dist/plugin/index.js +89 -20
  324. package/dist/plugin/links.d.ts +24 -0
  325. package/dist/plugin/links.js +27 -0
  326. package/dist/plugin/listCollections.d.ts +9 -7
  327. package/dist/plugin/listCollections.js +30 -21
  328. package/dist/plugin/sections.d.ts +14 -7
  329. package/dist/plugin/sections.js +69 -23
  330. package/dist/plugin/sectionsUsedIn.d.ts +6 -0
  331. package/dist/plugin/sectionsUsedIn.js +24 -0
  332. package/dist/plugin/templateEndpoint.d.ts +9 -0
  333. package/dist/plugin/templateEndpoint.js +49 -0
  334. package/dist/plugin/templates.js +23 -8
  335. package/dist/protocol/index.d.ts +16 -1
  336. package/dist/react/canvas/BuilderCanvas.js +144 -21
  337. package/dist/react/canvas/classes.d.ts +17 -0
  338. package/dist/react/canvas/classes.js +102 -0
  339. package/dist/react/canvas/controls.d.ts +31 -0
  340. package/dist/react/canvas/controls.js +75 -0
  341. package/dist/react/canvas/fetchDocs.d.ts +2 -2
  342. package/dist/react/canvas/fetchDocs.js +16 -8
  343. package/dist/react/canvas/measure.d.ts +9 -0
  344. package/dist/react/canvas/measure.js +106 -7
  345. package/dist/react/canvas/resolveLayout.d.ts +1 -1
  346. package/dist/react/canvas/resolveLayout.js +4 -3
  347. package/dist/react/canvas/thumbnail/ThumbnailCanvas.js +17 -4
  348. package/dist/react/classes/ClassesStyle.d.ts +27 -0
  349. package/dist/react/classes/ClassesStyle.js +27 -0
  350. package/dist/react/components/Button.d.ts +2 -11
  351. package/dist/react/components/Button.js +8 -43
  352. package/dist/react/components/CollectionList.d.ts +4 -1
  353. package/dist/react/components/CollectionList.js +10 -3
  354. package/dist/react/components/Container.d.ts +5 -2
  355. package/dist/react/components/Container.js +7 -4
  356. package/dist/react/components/Field.js +3 -14
  357. package/dist/react/components/Link.d.ts +1 -1
  358. package/dist/react/components/Link.js +5 -3
  359. package/dist/react/components/List.d.ts +1 -1
  360. package/dist/react/components/List.js +2 -2
  361. package/dist/react/components/Menu.d.ts +10 -1
  362. package/dist/react/components/Menu.js +39 -12
  363. package/dist/react/components/RichText.d.ts +3 -4
  364. package/dist/react/components/RichText.js +5 -5
  365. package/dist/react/components/builtins/Accordion.d.ts +4 -3
  366. package/dist/react/components/builtins/Accordion.js +6 -5
  367. package/dist/react/components/builtins/AdjacentLinks.d.ts +11 -0
  368. package/dist/react/components/builtins/AdjacentLinks.js +20 -0
  369. package/dist/react/components/builtins/Carousel.d.ts +21 -10
  370. package/dist/react/components/builtins/Carousel.js +175 -100
  371. package/dist/react/components/builtins/Disclosure.d.ts +4 -3
  372. package/dist/react/components/builtins/Disclosure.js +6 -5
  373. package/dist/react/components/builtins/Embed.d.ts +11 -0
  374. package/dist/react/components/builtins/Embed.js +23 -0
  375. package/dist/react/components/builtins/EmbedHtml.d.ts +15 -0
  376. package/dist/react/components/builtins/EmbedHtml.js +51 -0
  377. package/dist/react/components/builtins/EmbedPreview.d.ts +34 -0
  378. package/dist/react/components/builtins/EmbedPreview.js +105 -0
  379. package/dist/react/components/builtins/FilterLink.d.ts +1 -1
  380. package/dist/react/components/builtins/FilterLink.js +4 -4
  381. package/dist/react/components/builtins/Marquee.d.ts +8 -0
  382. package/dist/react/components/builtins/Marquee.js +15 -0
  383. package/dist/react/components/builtins/Popup.d.ts +26 -0
  384. package/dist/react/components/builtins/Popup.js +146 -0
  385. package/dist/react/components/builtins/SectionRef.d.ts +4 -3
  386. package/dist/react/components/builtins/SectionRef.js +9 -5
  387. package/dist/react/components/builtins/Tab.d.ts +7 -0
  388. package/dist/react/components/builtins/Tab.js +21 -0
  389. package/dist/react/components/builtins/TableOfContents.d.ts +17 -3
  390. package/dist/react/components/builtins/TableOfContents.js +22 -7
  391. package/dist/react/components/builtins/Tabs.d.ts +17 -0
  392. package/dist/react/components/builtins/Tabs.js +71 -0
  393. package/dist/react/components/builtins/index.d.ts +37 -20
  394. package/dist/react/components/builtins/index.js +54 -20
  395. package/dist/react/components/builtins/tabsContext.d.ts +12 -0
  396. package/dist/react/components/builtins/tabsContext.js +6 -0
  397. package/dist/react/components/index.js +11 -8
  398. package/dist/react/components/lazy.d.ts +32 -0
  399. package/dist/react/components/lazy.js +20 -0
  400. package/dist/react/components/lazyBlock.d.ts +17 -0
  401. package/dist/react/components/lazyBlock.js +23 -0
  402. package/dist/react/index.d.ts +6 -3
  403. package/dist/react/index.js +5 -2
  404. package/dist/react/render/RenderLayout.d.ts +9 -7
  405. package/dist/react/render/RenderLayout.js +96 -45
  406. package/dist/react/render/canvasMode.d.ts +13 -0
  407. package/dist/react/render/canvasMode.js +13 -0
  408. package/dist/react/render/canvasServer.js +4 -3
  409. package/dist/react/render/canvasServerTypes.d.ts +5 -0
  410. package/dist/react/render/lists.d.ts +36 -4
  411. package/dist/react/render/lists.js +132 -15
  412. package/dist/react/render/marks.d.ts +15 -0
  413. package/dist/react/render/marks.js +23 -0
  414. package/dist/react/render/payload.d.ts +8 -1
  415. package/dist/react/render/payload.js +12 -3
  416. package/dist/react/render/preview.d.ts +11 -0
  417. package/dist/react/render/preview.js +13 -0
  418. package/dist/react/render/relations.d.ts +10 -0
  419. package/dist/react/render/relations.js +39 -0
  420. package/dist/react/render/resolve.d.ts +8 -4
  421. package/dist/react/render/resolve.js +11 -5
  422. package/dist/react/render/reveal.d.ts +17 -0
  423. package/dist/react/render/reveal.js +39 -0
  424. package/dist/react/render/sections.d.ts +11 -5
  425. package/dist/react/render/sections.js +52 -24
  426. package/dist/react/render/templates.d.ts +47 -0
  427. package/dist/react/render/templates.js +139 -0
  428. package/dist/react/render/types.d.ts +62 -5
  429. package/dist/react/server.d.ts +2 -37
  430. package/dist/react/server.js +8 -133
  431. package/dist/react/theme/ThemeLiveLoader.d.ts +4 -0
  432. package/dist/react/theme/ThemeLiveLoader.js +5 -0
  433. package/dist/react/theme/ThemeStyle.js +1 -1
  434. package/dist/theme/admin/Variables.d.ts +11 -0
  435. package/dist/theme/admin/Variables.js +115 -0
  436. package/dist/theme/admin/fields.scss +113 -0
  437. package/dist/theme/client.d.ts +1 -0
  438. package/dist/theme/client.js +2 -0
  439. package/dist/theme/css.d.ts +6 -1
  440. package/dist/theme/css.js +12 -4
  441. package/dist/theme/global.js +83 -0
  442. package/dist/theme/index.d.ts +1 -0
  443. package/dist/theme/index.js +1 -0
  444. package/dist/theme/server.d.ts +15 -0
  445. package/dist/theme/server.js +43 -0
  446. package/dist/theme/usage.d.ts +23 -0
  447. package/dist/theme/usage.js +68 -0
  448. package/dist/theme/variables.d.ts +72 -0
  449. package/dist/theme/variables.js +231 -0
  450. package/package.json +4 -2
  451. package/dist/admin/editor/styles/SiteClasses.d.ts +0 -9
  452. package/dist/admin/editor/styles/SiteClasses.js +0 -31
  453. package/dist/blocks/builtins/headingId.d.ts +0 -15
  454. package/dist/blocks/builtins/headingId.js +0 -36
  455. package/dist/blocks/builtins/lightbox.d.ts +0 -43
  456. package/dist/blocks/builtins/lightbox.js +0 -93
  457. package/dist/blocks/builtins/mediaBackdrop.d.ts +0 -11
  458. package/dist/blocks/builtins/mediaBackdrop.js +0 -79
  459. package/dist/react/components/Quote.d.ts +0 -3
  460. package/dist/react/components/Quote.js +0 -12
  461. package/dist/react/components/Spacer.d.ts +0 -3
  462. package/dist/react/components/Spacer.js +0 -6
  463. package/dist/react/components/builtins/BackdropVideo.d.ts +0 -13
  464. package/dist/react/components/builtins/BackdropVideo.js +0 -16
  465. package/dist/react/components/builtins/Lightbox.d.ts +0 -45
  466. package/dist/react/components/builtins/Lightbox.js +0 -252
  467. package/dist/react/components/builtins/MediaBackdrop.d.ts +0 -14
  468. package/dist/react/components/builtins/MediaBackdrop.js +0 -61
@@ -0,0 +1,300 @@
1
+ // Editable classes (the `builder-classes` collection): shared types, keys and pure helpers.
2
+ // Browser-safe: no Node built-ins and no Payload runtime imports. The editor, the canvas, the
3
+ // server and the MCP tools all use these. See the README section "Editable classes".
4
+ /** Default slug of the classes collection. */
5
+ export const DEFAULT_CLASSES_SLUG = 'builder-classes';
6
+ /** Default slug of the hidden global that stores the compiled stylesheet of the published classes. */
7
+ export const DEFAULT_CLASSES_SHEET_SLUG = 'builder-classes-sheet';
8
+ /** Path below the API route: `GET` lists the classes (latest drafts). Sub-paths: `/usage`, `/import`, `/rename`, `/delete`, `/remove-unused`. */
9
+ export const CLASSES_PATH = '/builder/classes';
10
+ /** Path below the API route of the compiled stylesheet: `GET {api}/builder/classes-sheet/<hash>.css`. */
11
+ export const CLASSES_SHEET_PATH = '/builder/classes-sheet';
12
+ /**
13
+ * BroadcastChannel name. The editor posts `{ classes }` (the latest drafts, with its own unsaved
14
+ * edits) after every class change; canvases in the same browser compile them at once.
15
+ */
16
+ export const CLASSES_CHANNEL = 'payload-canvas:classes';
17
+ /** Server-only key in `config.custom` that holds `ClassesServerConfig`. */
18
+ export const CLASSES_CONFIG_KEY = 'websiteBuilderClasses';
19
+ /** `context` flag: delete a class even while blocks use it (the plugin removed it from them first). */
20
+ export const FORCE_DELETE_CLASS_CONTEXT = 'builderForceDeleteClass';
21
+ export const CLASS_NAME_MAX = 64;
22
+ /** Former names a class keeps at most (see `previousNames`). */
23
+ export const CLASS_ALIASES_MAX = 10;
24
+ // ---------------------------------------------------------------------------------------------
25
+ // Names
26
+ const NAME = /^[A-Za-z_][A-Za-z0-9_-]*$/;
27
+ /** Prefix of the names the compile gives classes internally. Never a class name. */
28
+ export const INTERNAL_CLASS_PREFIX = 'pc-db-class-';
29
+ /** Names that never become classes: the marker of generated CSS and the plugin's own prefixes. */
30
+ const RESERVED = new Set(['builder-css', 'group', 'peer', 'dark', 'container']);
31
+ /**
32
+ * Why a class name is not usable, or null. Checks the form only (a CSS identifier without escapes,
33
+ * no variant prefix); `tailwindUtilityProblem` (server) checks that Tailwind has no utility with it.
34
+ */
35
+ export function classNameProblem(name) {
36
+ if (typeof name !== 'string' || !name.trim())
37
+ return 'Enter a class name.';
38
+ const value = name.trim();
39
+ if (value.length > CLASS_NAME_MAX)
40
+ return `Use at most ${CLASS_NAME_MAX} characters.`;
41
+ if (value.startsWith('.'))
42
+ return 'Leave out the dot: "card", not ".card".';
43
+ if (!NAME.test(value))
44
+ return 'Use letters, digits, "-" and "_", and start with a letter or "_". For example "card" or "btn-primary".';
45
+ if (RESERVED.has(value) || value.startsWith(INTERNAL_CLASS_PREFIX) || value.startsWith('builder-'))
46
+ return `“${value}” is reserved. Pick another name.`;
47
+ return null;
48
+ }
49
+ /** The variant prefix ("md:hover:"), the bare class and an important mark of one class token. */
50
+ export function splitClassToken(token) {
51
+ const prefix = /^(?:[^\s:[\]]+:|!)*/.exec(token)?.[0] ?? '';
52
+ const rest = token.slice(prefix.length);
53
+ const important = rest.endsWith('!');
54
+ return { prefix, bare: important ? rest.slice(0, -1) : rest, important };
55
+ }
56
+ /** The bare class of a token: "md:hover:card!" -> "card". */
57
+ export const bareClass = (token) => splitClassToken(token).bare;
58
+ export const classTokens = (className) => (className ?? '').split(/\s+/).filter(Boolean);
59
+ /** True when a class string uses the class, with or without a variant prefix. */
60
+ export function usesClass(className, name) {
61
+ return classTokens(className).some((token) => bareClass(token) === name);
62
+ }
63
+ /**
64
+ * Replaces every use of class `from` in a class string with `to` (keeping each variant prefix and
65
+ * important mark), or removes it when `to` is null. Duplicates go; the order stays.
66
+ */
67
+ export function replaceClass(className, from, to) {
68
+ const out = [];
69
+ for (const token of classTokens(className)) {
70
+ const { prefix, bare, important } = splitClassToken(token);
71
+ if (bare !== from) {
72
+ if (!out.includes(token))
73
+ out.push(token);
74
+ continue;
75
+ }
76
+ if (to === null)
77
+ continue;
78
+ const next = `${prefix}${to}${important ? '!' : ''}`;
79
+ if (!out.includes(next))
80
+ out.push(next);
81
+ }
82
+ return out.join(' ');
83
+ }
84
+ /** Removes the tokens whose bare class is in `names`. For page compiles: these classes come from the classes stylesheet. */
85
+ export function withoutClassNames(classes, names) {
86
+ if (names.size === 0)
87
+ return [...classes];
88
+ return classes.filter((token) => !names.has(bareClass(token)));
89
+ }
90
+ /** Every name the classes answer to: their names and their former names. */
91
+ export function classNamesOf(classes) {
92
+ const names = new Set();
93
+ for (const item of classes) {
94
+ names.add(item.name);
95
+ for (const alias of item.previousNames ?? [])
96
+ names.add(alias);
97
+ }
98
+ return names;
99
+ }
100
+ // ---------------------------------------------------------------------------------------------
101
+ // Custom CSS
102
+ /** At-rules that change the design system or load files. Custom CSS only styles the class. */
103
+ const FORBIDDEN_AT_RULES = ['import', 'plugin', 'config', 'source', 'theme', 'utility', 'custom-variant', 'tailwind', 'layer', 'reference', 'charset', 'namespace'];
104
+ /**
105
+ * Why a class's custom CSS cannot compile, or null: unbalanced braces, brackets or quotes, an
106
+ * at-rule that would change the design system (`@import`, `@theme`, `@utility`, …), or text that
107
+ * would end a `<style>` tag.
108
+ */
109
+ export function cssProblem(css) {
110
+ const value = css ?? '';
111
+ if (!value.trim())
112
+ return null;
113
+ if (/<\/style/i.test(value))
114
+ return 'Custom CSS cannot contain "</style".';
115
+ const at = new RegExp(`@(${FORBIDDEN_AT_RULES.join('|')})\\b`, 'i').exec(value.replace(/\/\*[^]*?\*\//g, ''));
116
+ if (at)
117
+ return `Custom CSS cannot use @${at[1]}. It styles this class only.`;
118
+ const stack = [];
119
+ const pairs = { '}': '{', ')': '(', ']': '[' };
120
+ for (let i = 0; i < value.length; i++) {
121
+ const ch = value[i];
122
+ if (ch === '/' && value[i + 1] === '*') {
123
+ const end = value.indexOf('*/', i + 2);
124
+ if (end === -1)
125
+ return 'A comment is not closed: add "*/".';
126
+ i = end + 1;
127
+ continue;
128
+ }
129
+ if (ch === '\\') {
130
+ i++;
131
+ continue;
132
+ }
133
+ if (ch === '"' || ch === "'") {
134
+ const end = closingQuote(value, i);
135
+ if (end === -1)
136
+ return `A string is not closed: add ${ch}.`;
137
+ i = end;
138
+ continue;
139
+ }
140
+ if (ch === '{' || ch === '(' || ch === '[')
141
+ stack.push(ch);
142
+ else if (ch in pairs) {
143
+ if (stack.pop() !== pairs[ch])
144
+ return `"${ch}" has no matching "${pairs[ch]}".`;
145
+ }
146
+ }
147
+ if (stack.length > 0)
148
+ return `"${stack.at(-1)}" is not closed.`;
149
+ return null;
150
+ }
151
+ function closingQuote(value, start) {
152
+ const quote = value[start];
153
+ for (let i = start + 1; i < value.length; i++) {
154
+ if (value[i] === '\\')
155
+ i++;
156
+ else if (value[i] === quote)
157
+ return i;
158
+ else if (value[i] === '\n')
159
+ return -1;
160
+ }
161
+ return -1;
162
+ }
163
+ // ---------------------------------------------------------------------------------------------
164
+ // Data helpers
165
+ const text = (value, max) => {
166
+ if (typeof value !== 'string')
167
+ return null;
168
+ const trimmed = value.trim().replace(/\s+/g, ' ').slice(0, max);
169
+ return trimmed || null;
170
+ };
171
+ /** One space between classes, no empty value. */
172
+ export const normalizeStyles = (value) => (typeof value === 'string' ? classTokens(value).join(' ') || null : null);
173
+ /** A classes document (REST or Local API, depth 0) as a `BuilderClass`. Null without an id or name. */
174
+ export function toBuilderClass(doc) {
175
+ const { id, name } = doc;
176
+ if ((typeof id !== 'string' && typeof id !== 'number') || typeof name !== 'string' || !name)
177
+ return null;
178
+ const previous = Array.isArray(doc.previousNames) ? doc.previousNames.filter((n) => typeof n === 'string' && n !== name) : [];
179
+ return {
180
+ id,
181
+ name,
182
+ label: text(doc.label, 120),
183
+ group: text(doc.group, 60),
184
+ styles: normalizeStyles(doc.styles),
185
+ css: typeof doc.css === 'string' && doc.css.trim() ? doc.css : null,
186
+ previousNames: previous.length > 0 ? previous : null,
187
+ status: doc._status === 'draft' ? 'draft' : 'published',
188
+ updatedAt: typeof doc.updatedAt === 'string' ? doc.updatedAt : null,
189
+ };
190
+ }
191
+ /** Former names to keep after a rename: the old name first, without the new name and duplicates. */
192
+ export function withPreviousName(previous, oldName, newName) {
193
+ return [oldName, ...(previous ?? [])].filter((n, i, all) => n !== newName && all.indexOf(n) === i).slice(0, CLASS_ALIASES_MAX);
194
+ }
195
+ /** A short preview of what a class does, for tooltips and suggestions. */
196
+ export function classPreview(item, max = 160) {
197
+ const parts = [item.styles ?? '', (item.css ?? '').replace(/\/\*[^]*?\*\//g, '').replace(/\s+/g, ' ').trim()].filter(Boolean);
198
+ const value = parts.join(' · ');
199
+ return value.length > max ? `${value.slice(0, max - 1)}…` : value;
200
+ }
201
+ /**
202
+ * The classes as site classes for the Classes box suggestions and the AI's tokens: the editable
203
+ * classes first, then the code classes (`@utility` in the site's CSS) that no editable class replaces.
204
+ */
205
+ export function mergeSiteClasses(classes, code) {
206
+ const own = classes.map((item) => ({
207
+ name: item.name,
208
+ ...(item.label ? { label: item.label } : {}),
209
+ ...(item.group ? { group: item.group } : {}),
210
+ css: classPreview(item),
211
+ }));
212
+ const names = new Set(own.map((c) => c.name));
213
+ return [...own, ...(code ?? []).filter((c) => !names.has(c.name))];
214
+ }
215
+ /** "1 block", "3 blocks". */
216
+ export const plural = (count, one, many = `${one}s`) => `${count} ${count === 1 ? one : many}`;
217
+ /** "changes 12 blocks on 3 pages", "is not used yet". */
218
+ export function usageText(usage) {
219
+ if (!usage || usage.blocks === 0)
220
+ return 'is not used on any page yet';
221
+ return `changes ${plural(usage.blocks, 'block')} on ${plural(usage.documents.length, 'page')}`;
222
+ }
223
+ /** Top-level statements of a rule body, comments removed, nested blocks kept whole. */
224
+ function statements(body) {
225
+ const out = [];
226
+ let depth = 0;
227
+ let start = 0;
228
+ const css = body.replace(/\/\*[^]*?\*\//g, '');
229
+ for (let i = 0; i < css.length; i++) {
230
+ const ch = css[i];
231
+ if (ch === '\\') {
232
+ i++;
233
+ continue;
234
+ }
235
+ if (ch === '"' || ch === "'") {
236
+ const end = closingQuote(css, i);
237
+ i = end === -1 ? css.length : end;
238
+ continue;
239
+ }
240
+ if (ch === '{')
241
+ depth++;
242
+ else if (ch === '}') {
243
+ depth--;
244
+ if (depth === 0) {
245
+ out.push(css.slice(start, i + 1).trim());
246
+ start = i + 1;
247
+ }
248
+ }
249
+ else if (ch === ';' && depth === 0) {
250
+ out.push(css.slice(start, i + 1).trim());
251
+ start = i + 1;
252
+ }
253
+ }
254
+ const rest = css.slice(start).trim();
255
+ if (rest)
256
+ out.push(rest.endsWith(';') ? rest : `${rest};`);
257
+ return out.filter(Boolean);
258
+ }
259
+ /** Re-indents a rule body for the custom CSS box: two spaces per level. */
260
+ function indent(statement) {
261
+ let depth = 0;
262
+ return statement
263
+ .split('\n')
264
+ .map((line) => line.trim())
265
+ .filter(Boolean)
266
+ .map((line) => {
267
+ if (line.startsWith('}'))
268
+ depth = Math.max(0, depth - 1);
269
+ const out = `${' '.repeat(depth)}${line}`;
270
+ depth += (line.match(/\{/g)?.length ?? 0) - (line.match(/\}/g)?.length ?? 0) + (line.startsWith('}') ? 1 : 0);
271
+ depth = Math.max(0, depth);
272
+ return out;
273
+ })
274
+ .join('\n');
275
+ }
276
+ /**
277
+ * Converts a code `@utility` rule into class data. `@apply a b;` statements (without `!important`)
278
+ * become `styles`; declarations, nested rules and anything else stay as `css`, in their order.
279
+ */
280
+ export function importSiteClass(rule) {
281
+ const styles = [];
282
+ const css = [];
283
+ for (const statement of statements(rule.body)) {
284
+ const apply = /^@apply\s+([^;{}]+?);$/.exec(statement);
285
+ if (apply && !/!important/.test(apply[1])) {
286
+ for (const token of classTokens(apply[1]))
287
+ if (!styles.includes(token))
288
+ styles.push(token);
289
+ continue;
290
+ }
291
+ css.push(indent(statement));
292
+ }
293
+ return {
294
+ name: rule.name,
295
+ label: rule.label?.trim() || null,
296
+ group: rule.group?.trim() || null,
297
+ styles: styles.join(' ') || null,
298
+ css: css.join('\n') || null,
299
+ };
300
+ }
@@ -0,0 +1,34 @@
1
+ import type { GlobalConfig, Payload, PayloadRequest } from 'payload';
2
+ import { type ClassesServerConfig } from './config.js';
3
+ import { type BuilderClass } from './shared.js';
4
+ /** The stored stylesheet. `input`: the key of the CSS input it was compiled from (`cssInputKey`). */
5
+ export type StoredClassSheet = {
6
+ hash: string;
7
+ css: string;
8
+ names: string[];
9
+ errors: Record<string, string>;
10
+ input: string;
11
+ };
12
+ /** The hidden global. Only the plugin reads and writes it (access off, `overrideAccess` in the plugin). */
13
+ export declare function classesSheetGlobal(slug: string): GlobalConfig;
14
+ /** The published classes (the main documents with `_status: published`). */
15
+ export declare function publishedClasses(payload: Payload, config: ClassesServerConfig, req?: PayloadRequest): Promise<BuilderClass[]>;
16
+ /** Compiles the published classes. */
17
+ export declare function compilePublishedSheet(payload: Payload, config: ClassesServerConfig, req?: PayloadRequest): Promise<StoredClassSheet>;
18
+ /**
19
+ * Compiles the published classes and stores the stylesheet when it changed. Runs in the classes
20
+ * collection's hooks with their `req` (same transaction). Returns the stored sheet.
21
+ */
22
+ export declare function storeClassesSheet(payload: Payload, req?: PayloadRequest): Promise<(StoredClassSheet & {
23
+ changed: boolean;
24
+ }) | null>;
25
+ /**
26
+ * The stored stylesheet for the site. Compiles it again when the site's CSS input changed since it
27
+ * was stored (a deploy with new theme tokens) or when it was never stored. `null` without classes.
28
+ */
29
+ export declare function loadClassesSheet(payload: Payload): Promise<StoredClassSheet | null>;
30
+ /**
31
+ * Names the classes stylesheet styles (published class names and former names). Page compiles
32
+ * leave them out. Cached for 10 s per process; a save of the sheet in this process updates it at once.
33
+ */
34
+ export declare function classNamesFor(payload: Payload): Promise<string[]>;
@@ -0,0 +1,126 @@
1
+ // The compiled stylesheet of the published classes: one site-wide sheet, stored in a hidden global
2
+ // with a hash of its CSS. The classes collection's hooks compile it again after every publish,
3
+ // unpublish and delete; the site loads it once per request (`ClassesStyle`) and the browser caches
4
+ // it by its hashed URL. Server-only.
5
+ import { createHash } from 'node:crypto';
6
+ import { compileClassesSheet, cssInputKey } from '../css/index.js';
7
+ import { withThemeVariables } from '../theme/server.js';
8
+ import { classesConfigOf } from './config.js';
9
+ import { toBuilderClass } from './shared.js';
10
+ const EMPTY = { hash: '', css: '', names: [], errors: {}, input: '' };
11
+ /** The hidden global. Only the plugin reads and writes it (access off, `overrideAccess` in the plugin). */
12
+ export function classesSheetGlobal(slug) {
13
+ return {
14
+ slug,
15
+ label: 'Classes stylesheet',
16
+ admin: { hidden: true },
17
+ access: { read: () => false, update: () => false },
18
+ fields: [
19
+ { name: 'hash', type: 'text' },
20
+ { name: 'css', type: 'textarea' },
21
+ { name: 'names', type: 'json' },
22
+ { name: 'errors', type: 'json' },
23
+ { name: 'input', type: 'text' },
24
+ ],
25
+ };
26
+ }
27
+ const hashOf = (css) => createHash('sha256').update(css).digest('hex').slice(0, 16);
28
+ function asSheet(value) {
29
+ const doc = (value ?? {});
30
+ return {
31
+ hash: typeof doc.hash === 'string' ? doc.hash : '',
32
+ css: typeof doc.css === 'string' ? doc.css : '',
33
+ names: Array.isArray(doc.names) ? doc.names.filter((n) => typeof n === 'string') : [],
34
+ errors: doc.errors && typeof doc.errors === 'object' && !Array.isArray(doc.errors) ? doc.errors : {},
35
+ input: typeof doc.input === 'string' ? doc.input : '',
36
+ };
37
+ }
38
+ /** The published classes (the main documents with `_status: published`). */
39
+ export async function publishedClasses(payload, config, req) {
40
+ const result = await payload.find({
41
+ collection: config.slug,
42
+ depth: 0,
43
+ pagination: false,
44
+ where: { _status: { equals: 'published' } },
45
+ overrideAccess: true,
46
+ ...(req ? { req } : {}),
47
+ });
48
+ return result.docs.flatMap((doc) => toBuilderClass(doc) ?? []);
49
+ }
50
+ /** Compiles the published classes. */
51
+ export async function compilePublishedSheet(payload, config, req) {
52
+ const classes = await publishedClasses(payload, config, req);
53
+ // The theme's variables work inside classes too (`bg-brand` in a class's styles).
54
+ const css = await withThemeVariables(payload, config.css);
55
+ const [sheet, input] = await Promise.all([compileClassesSheet(classes, css), cssInputKey(css)]);
56
+ return { hash: sheet.css ? hashOf(sheet.css) : '', css: sheet.css, names: sheet.names, errors: sheet.errors, input };
57
+ }
58
+ /** Names of the stored sheet per Payload instance, for page compiles in the save hook. */
59
+ const namesCache = new WeakMap();
60
+ const NAMES_TTL_MS = 10_000;
61
+ function remember(payload, sheet) {
62
+ namesCache.set(payload, { names: sheet.names, at: Date.now() });
63
+ }
64
+ /**
65
+ * Compiles the published classes and stores the stylesheet when it changed. Runs in the classes
66
+ * collection's hooks with their `req` (same transaction). Returns the stored sheet.
67
+ */
68
+ export async function storeClassesSheet(payload, req) {
69
+ const config = classesConfigOf(payload);
70
+ if (!config)
71
+ return null;
72
+ const sheet = await compilePublishedSheet(payload, config, req);
73
+ const current = asSheet(await payload.findGlobal({ slug: config.sheetSlug, depth: 0, overrideAccess: true, ...(req ? { req } : {}) }).catch(() => null));
74
+ const same = current.hash === sheet.hash && current.input === sheet.input && current.names.join(' ') === sheet.names.join(' ');
75
+ if (!same) {
76
+ await payload.updateGlobal({ slug: config.sheetSlug, data: sheet, depth: 0, overrideAccess: true, ...(req ? { req } : {}) });
77
+ }
78
+ remember(payload, sheet);
79
+ if (!same)
80
+ for (const [name, error] of Object.entries(sheet.errors))
81
+ payload.logger.warn(`[websiteBuilder] Class "${name}": ${error}`);
82
+ return { ...sheet, changed: !same };
83
+ }
84
+ /** One recompile at a time per Payload instance (a deploy with a new CSS entry: the first request compiles). */
85
+ const refreshing = new WeakMap();
86
+ /**
87
+ * The stored stylesheet for the site. Compiles it again when the site's CSS input changed since it
88
+ * was stored (a deploy with new theme tokens) or when it was never stored. `null` without classes.
89
+ */
90
+ export async function loadClassesSheet(payload) {
91
+ const config = classesConfigOf(payload);
92
+ if (!config)
93
+ return null;
94
+ const stored = asSheet(await payload.findGlobal({ slug: config.sheetSlug, depth: 0, overrideAccess: true }).catch(() => EMPTY));
95
+ // A CSS entry that cannot be read cannot compile either: keep the stored sheet.
96
+ const input = await withThemeVariables(payload, config.css)
97
+ .then(cssInputKey)
98
+ .catch(() => null);
99
+ if (input === null || (stored.input && stored.input === input)) {
100
+ remember(payload, stored);
101
+ return stored;
102
+ }
103
+ let pending = refreshing.get(payload);
104
+ if (!pending) {
105
+ pending = storeClassesSheet(payload).catch((error) => {
106
+ payload.logger.error({ err: error, msg: '[websiteBuilder] The classes stylesheet failed to compile. Using the stored one.' });
107
+ return stored;
108
+ });
109
+ refreshing.set(payload, pending);
110
+ void pending.finally(() => refreshing.delete(payload));
111
+ }
112
+ return pending;
113
+ }
114
+ /**
115
+ * Names the classes stylesheet styles (published class names and former names). Page compiles
116
+ * leave them out. Cached for 10 s per process; a save of the sheet in this process updates it at once.
117
+ */
118
+ export async function classNamesFor(payload) {
119
+ if (!classesConfigOf(payload))
120
+ return [];
121
+ const cached = namesCache.get(payload);
122
+ if (cached && Date.now() - cached.at < NAMES_TTL_MS)
123
+ return cached.names;
124
+ const sheet = await loadClassesSheet(payload).catch(() => null);
125
+ return sheet?.names ?? [];
126
+ }
@@ -0,0 +1,57 @@
1
+ import type { PayloadRequest } from 'payload';
2
+ import type { Layout, Operation } from '../core/types.js';
3
+ import { type ClassUsage } from './shared.js';
4
+ /** One layout of a builder document. */
5
+ export type ScannedLayout = {
6
+ collection: string;
7
+ id: string | number;
8
+ title: string;
9
+ layout: Layout;
10
+ };
11
+ /** Blocks per class name in one layout, for the names asked for. */
12
+ export declare function countClassUses(layout: Layout, names: ReadonlySet<string>): Map<string, number>;
13
+ /** The operations that rename (or with `to: null` remove) class `from` in a layout. */
14
+ export declare function replaceClassOps(layout: Layout, from: string, to: string | null): Operation[];
15
+ /**
16
+ * Every layout of the builder collections (JSON layouts; a Payload blocks field holds no classes):
17
+ * the latest drafts, with the open live session's layout instead where one is open. `asUser`:
18
+ * only the documents the request's user may read. `published`: the published layouts instead (what
19
+ * the live site renders; a collection without drafts: every document), saved sections left out.
20
+ */
21
+ export declare function scanLayouts(req: PayloadRequest, asUser: boolean, published?: boolean): Promise<ScannedLayout[]>;
22
+ /**
23
+ * Where each of `names` is used: blocks and documents. `asUser` (default true): only documents the
24
+ * request's user may read; the delete check counts every document.
25
+ */
26
+ export declare function classUsage(req: PayloadRequest, names: Iterable<string>, options?: {
27
+ asUser?: boolean;
28
+ }): Promise<Record<string, ClassUsage>>;
29
+ /**
30
+ * The published documents whose published layout uses one of `names` (the live site renders those
31
+ * layouts), as the request's user may read them. Each document once, with the block count.
32
+ */
33
+ export declare function publishedClassUsage(req: PayloadRequest, names: Iterable<string>): Promise<ClassUsage['documents']>;
34
+ /**
35
+ * The names among `names` that any layout uses: the latest drafts, open live sessions and the
36
+ * published layouts of every document (no access check: deleting must not miss a page).
37
+ */
38
+ export declare function usedClassNames(req: PayloadRequest, names: Iterable<string>): Promise<Set<string>>;
39
+ export type ReplaceResult = {
40
+ /** Documents changed. */
41
+ documents: number;
42
+ /** Blocks changed. */
43
+ blocks: number;
44
+ /** Documents that could not be changed, with the reason. */
45
+ failed: Array<{
46
+ collection: string;
47
+ id: string | number;
48
+ title: string;
49
+ error: string;
50
+ }>;
51
+ };
52
+ /**
53
+ * Renames class `from` to `to` (or removes it, with `to: null`) in every layout that uses it, as
54
+ * the request's user, through each document's live session. Documents the user may not update are
55
+ * reported in `failed`.
56
+ */
57
+ export declare function replaceClassInLayouts(req: PayloadRequest, from: string, to: string | null): Promise<ReplaceResult>;