@focus-reactive/payload-plugin-visual-editing 1.1.1 → 1.2.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.
Files changed (325) hide show
  1. package/README.md +365 -95
  2. package/dist/admin/InstantPreviewBroadcaster.d.ts +3 -0
  3. package/dist/admin/InstantPreviewBroadcaster.js +64 -0
  4. package/dist/admin/InstantPreviewBroadcaster.js.map +1 -0
  5. package/dist/admin/VisualEditingBridgeProvider.js +28 -27
  6. package/dist/admin/VisualEditingBridgeProvider.js.map +1 -1
  7. package/dist/admin/expandAndFocus.d.ts +0 -1
  8. package/dist/admin/expandAndFocus.js +19 -61
  9. package/dist/admin/expandAndFocus.js.map +1 -1
  10. package/dist/admin/fieldDomId.d.ts +5 -0
  11. package/dist/admin/fieldDomId.js +11 -0
  12. package/dist/admin/fieldDomId.js.map +1 -0
  13. package/dist/admin/index.d.ts +2 -0
  14. package/dist/admin/index.js +2 -0
  15. package/dist/admin/index.js.map +1 -1
  16. package/dist/admin/instantPreview/fieldMessages.d.ts +26 -0
  17. package/dist/admin/instantPreview/fieldMessages.js +90 -0
  18. package/dist/admin/instantPreview/fieldMessages.js.map +1 -0
  19. package/dist/admin/instantPreview/formFields.d.ts +9 -0
  20. package/dist/admin/instantPreview/formFields.js +54 -0
  21. package/dist/admin/instantPreview/formFields.js.map +1 -0
  22. package/dist/admin/instantPreview/previewSession.d.ts +18 -0
  23. package/dist/admin/instantPreview/previewSession.js +157 -0
  24. package/dist/admin/instantPreview/previewSession.js.map +1 -0
  25. package/dist/admin/instantPreview/richTextReads.d.ts +29 -0
  26. package/dist/admin/instantPreview/richTextReads.js +67 -0
  27. package/dist/admin/instantPreview/richTextReads.js.map +1 -0
  28. package/dist/admin/instantPreview/unsavedStructures.d.ts +16 -0
  29. package/dist/admin/instantPreview/unsavedStructures.js +71 -0
  30. package/dist/admin/instantPreview/unsavedStructures.js.map +1 -0
  31. package/dist/admin/instantPreview/useEditableSchema.d.ts +7 -0
  32. package/dist/admin/instantPreview/useEditableSchema.js +30 -0
  33. package/dist/admin/instantPreview/useEditableSchema.js.map +1 -0
  34. package/dist/admin/instantPreview/usePreviewPage.d.ts +3 -0
  35. package/dist/admin/instantPreview/usePreviewPage.js +50 -0
  36. package/dist/admin/instantPreview/usePreviewPage.js.map +1 -0
  37. package/dist/admin/instantPreview/usePreviewWindow.d.ts +7 -0
  38. package/dist/admin/instantPreview/usePreviewWindow.js +46 -0
  39. package/dist/admin/instantPreview/usePreviewWindow.js.map +1 -0
  40. package/dist/admin/openField/OpenFormAnnouncer.d.ts +1 -0
  41. package/dist/admin/openField/OpenFormAnnouncer.js +8 -0
  42. package/dist/admin/openField/OpenFormAnnouncer.js.map +1 -0
  43. package/dist/admin/openField/formPathOfKey.d.ts +11 -0
  44. package/dist/admin/openField/formPathOfKey.js +20 -0
  45. package/dist/admin/openField/formPathOfKey.js.map +1 -0
  46. package/dist/admin/openField/openDocument.d.ts +8 -0
  47. package/dist/admin/openField/openDocument.js +13 -0
  48. package/dist/admin/openField/openDocument.js.map +1 -0
  49. package/dist/admin/openField/openForms.d.ts +9 -0
  50. package/dist/admin/openField/openForms.js +20 -0
  51. package/dist/admin/openField/openForms.js.map +1 -0
  52. package/dist/admin/openField/useOpenFormAnnouncement.d.ts +1 -0
  53. package/dist/admin/openField/useOpenFormAnnouncement.js +29 -0
  54. package/dist/admin/openField/useOpenFormAnnouncement.js.map +1 -0
  55. package/dist/admin/parseFieldPath.js +7 -17
  56. package/dist/admin/parseFieldPath.js.map +1 -1
  57. package/dist/admin/resolveContainerChain.d.ts +3 -2
  58. package/dist/admin/resolveContainerChain.js +10 -33
  59. package/dist/admin/resolveContainerChain.js.map +1 -1
  60. package/dist/client/VisualEditingOverlay.js +24 -15
  61. package/dist/client/VisualEditingOverlay.js.map +1 -1
  62. package/dist/client/VisualEditingProvider.d.ts +5 -3
  63. package/dist/client/VisualEditingProvider.js +6 -6
  64. package/dist/client/VisualEditingProvider.js.map +1 -1
  65. package/dist/client/VisualEditingToggle.js +1 -11
  66. package/dist/client/VisualEditingToggle.js.map +1 -1
  67. package/dist/client/adminWindow.d.ts +2 -0
  68. package/dist/client/adminWindow.js +8 -0
  69. package/dist/client/adminWindow.js.map +1 -0
  70. package/dist/client/createOverlay.d.ts +17 -0
  71. package/dist/client/createOverlay.js +30 -0
  72. package/dist/client/createOverlay.js.map +1 -0
  73. package/dist/client/index.d.ts +5 -1
  74. package/dist/client/index.js +3 -1
  75. package/dist/client/index.js.map +1 -1
  76. package/dist/client/instantPreview/LiveRichText.d.ts +16 -0
  77. package/dist/client/instantPreview/LiveRichText.js +18 -0
  78. package/dist/client/instantPreview/LiveRichText.js.map +1 -0
  79. package/dist/client/instantPreview/adminChannel.d.ts +14 -0
  80. package/dist/client/instantPreview/adminChannel.js +40 -0
  81. package/dist/client/instantPreview/adminChannel.js.map +1 -0
  82. package/dist/client/instantPreview/instantPreview.d.ts +8 -0
  83. package/dist/client/instantPreview/instantPreview.js +49 -0
  84. package/dist/client/instantPreview/instantPreview.js.map +1 -0
  85. package/dist/client/instantPreview/liveFields.d.ts +18 -0
  86. package/dist/client/instantPreview/liveFields.js +158 -0
  87. package/dist/client/instantPreview/liveFields.js.map +1 -0
  88. package/dist/client/instantPreview/liveMessages.d.ts +6 -0
  89. package/dist/client/instantPreview/liveMessages.js +39 -0
  90. package/dist/client/instantPreview/liveMessages.js.map +1 -0
  91. package/dist/client/instantPreview/liveRichTextOf.d.ts +6 -0
  92. package/dist/client/instantPreview/liveRichTextOf.js +23 -0
  93. package/dist/client/instantPreview/liveRichTextOf.js.map +1 -0
  94. package/dist/client/instantPreview/pageLoad.d.ts +6 -0
  95. package/dist/client/instantPreview/pageLoad.js +11 -0
  96. package/dist/client/instantPreview/pageLoad.js.map +1 -0
  97. package/dist/client/instantPreview/unsavedRender/UnsavedRenderBoundary.d.ts +19 -0
  98. package/dist/client/instantPreview/unsavedRender/UnsavedRenderBoundary.js +28 -0
  99. package/dist/client/instantPreview/unsavedRender/UnsavedRenderBoundary.js.map +1 -0
  100. package/dist/client/instantPreview/unsavedRender/announcer.d.ts +3 -0
  101. package/dist/client/instantPreview/unsavedRender/announcer.js +25 -0
  102. package/dist/client/instantPreview/unsavedRender/announcer.js.map +1 -0
  103. package/dist/client/instantPreview/unsavedRender/savedShapes.d.ts +6 -0
  104. package/dist/client/instantPreview/unsavedRender/savedShapes.js +20 -0
  105. package/dist/client/instantPreview/unsavedRender/savedShapes.js.map +1 -0
  106. package/dist/client/instantPreview/unsavedRender/unsavedRender.d.ts +40 -0
  107. package/dist/client/instantPreview/unsavedRender/unsavedRender.js +158 -0
  108. package/dist/client/instantPreview/unsavedRender/unsavedRender.js.map +1 -0
  109. package/dist/client/instantPreview/unsavedRender/useUnsavedRender.d.ts +10 -0
  110. package/dist/client/instantPreview/unsavedRender/useUnsavedRender.js +118 -0
  111. package/dist/client/instantPreview/unsavedRender/useUnsavedRender.js.map +1 -0
  112. package/dist/client/overlay/constants.d.ts +2 -2
  113. package/dist/client/overlay/constants.js +4 -12
  114. package/dist/client/overlay/constants.js.map +1 -1
  115. package/dist/client/overlay/editBadge.d.ts +2 -8
  116. package/dist/client/overlay/editBadge.js +0 -8
  117. package/dist/client/overlay/editBadge.js.map +1 -1
  118. package/dist/client/overlay/editTargets.d.ts +3 -0
  119. package/dist/client/overlay/editTargets.js +98 -0
  120. package/dist/client/overlay/editTargets.js.map +1 -0
  121. package/dist/client/overlay/fieldTracker.d.ts +20 -0
  122. package/dist/client/overlay/fieldTracker.js +194 -0
  123. package/dist/client/overlay/fieldTracker.js.map +1 -0
  124. package/dist/client/overlay/hoverController.d.ts +0 -5
  125. package/dist/client/overlay/hoverController.js +0 -16
  126. package/dist/client/overlay/hoverController.js.map +1 -1
  127. package/dist/client/overlay/markerExtractor.d.ts +4 -3
  128. package/dist/client/overlay/markerExtractor.js +12 -19
  129. package/dist/client/overlay/markerExtractor.js.map +1 -1
  130. package/dist/client/overlay/mutationPipeline.d.ts +2 -2
  131. package/dist/client/overlay/mutationPipeline.js +51 -35
  132. package/dist/client/overlay/mutationPipeline.js.map +1 -1
  133. package/dist/client/overlay/targetRegistry.d.ts +5 -11
  134. package/dist/client/overlay/targetRegistry.js +14 -7
  135. package/dist/client/overlay/targetRegistry.js.map +1 -1
  136. package/dist/client/overlay/targetSelector.js +0 -9
  137. package/dist/client/overlay/targetSelector.js.map +1 -1
  138. package/dist/client/overlayClickHandler.d.ts +1 -1
  139. package/dist/client/overlayClickHandler.js +7 -13
  140. package/dist/client/overlayClickHandler.js.map +1 -1
  141. package/dist/client/overlayContext.d.ts +3 -0
  142. package/dist/client/overlayContext.js +5 -0
  143. package/dist/client/overlayContext.js.map +1 -0
  144. package/dist/client/useIsomorphicLayoutEffect.d.ts +2 -0
  145. package/dist/client/useIsomorphicLayoutEffect.js +4 -0
  146. package/dist/client/useIsomorphicLayoutEffect.js.map +1 -0
  147. package/dist/client/useVisualEditingOverlay.d.ts +2 -2
  148. package/dist/client/useVisualEditingOverlay.js +21 -9
  149. package/dist/client/useVisualEditingOverlay.js.map +1 -1
  150. package/dist/client/visualEditingMode.d.ts +3 -0
  151. package/dist/client/visualEditingMode.js +8 -0
  152. package/dist/client/visualEditingMode.js.map +1 -0
  153. package/dist/client/withVisualEditingPath.d.ts +3 -1
  154. package/dist/client/withVisualEditingPath.js +17 -10
  155. package/dist/client/withVisualEditingPath.js.map +1 -1
  156. package/dist/excludeValues.d.ts +4 -0
  157. package/dist/excludeValues.js +4 -16
  158. package/dist/excludeValues.js.map +1 -1
  159. package/dist/index.d.ts +6 -1
  160. package/dist/index.js +40 -30
  161. package/dist/index.js.map +1 -1
  162. package/dist/readUnsavedRichText.d.ts +13 -0
  163. package/dist/readUnsavedRichText.js +75 -0
  164. package/dist/readUnsavedRichText.js.map +1 -0
  165. package/dist/server/hooks/readHooks.d.ts +14 -0
  166. package/dist/server/hooks/readHooks.js +67 -0
  167. package/dist/server/hooks/readHooks.js.map +1 -0
  168. package/dist/{internal → server/hooks}/stripStegaHook.js +11 -12
  169. package/dist/server/hooks/stripStegaHook.js.map +1 -0
  170. package/dist/server/localeCodesKeyingValues.d.ts +4 -0
  171. package/dist/server/localeCodesKeyingValues.js +15 -0
  172. package/dist/server/localeCodesKeyingValues.js.map +1 -0
  173. package/dist/server/markRead.d.ts +12 -0
  174. package/dist/server/markRead.js +220 -0
  175. package/dist/server/markRead.js.map +1 -0
  176. package/dist/server/markedReads.d.ts +28 -0
  177. package/dist/server/markedReads.js +58 -0
  178. package/dist/server/markedReads.js.map +1 -0
  179. package/dist/server/richText/markTextLeaves.d.ts +1 -0
  180. package/dist/server/richText/markTextLeaves.js +16 -0
  181. package/dist/server/richText/markTextLeaves.js.map +1 -0
  182. package/dist/server/schemaCache.d.ts +29 -0
  183. package/dist/server/schemaCache.js +35 -0
  184. package/dist/server/schemaCache.js.map +1 -0
  185. package/dist/server/unsavedRichText/hooks.d.ts +4 -0
  186. package/dist/server/unsavedRichText/hooks.js +42 -0
  187. package/dist/server/unsavedRichText/hooks.js.map +1 -0
  188. package/dist/server/unsavedRichText/jsonBody.d.ts +1 -0
  189. package/dist/server/unsavedRichText/jsonBody.js +47 -0
  190. package/dist/server/unsavedRichText/jsonBody.js.map +1 -0
  191. package/dist/server/unsavedRichText/latestReads.d.ts +17 -0
  192. package/dist/server/unsavedRichText/latestReads.js +70 -0
  193. package/dist/server/unsavedRichText/latestReads.js.map +1 -0
  194. package/dist/server/unsavedRichText/placeUnsavedState.d.ts +8 -0
  195. package/dist/server/unsavedRichText/placeUnsavedState.js +12 -0
  196. package/dist/server/unsavedRichText/placeUnsavedState.js.map +1 -0
  197. package/dist/server/unsavedRichText/postedEditorState.d.ts +2 -0
  198. package/dist/server/unsavedRichText/postedEditorState.js +45 -0
  199. package/dist/server/unsavedRichText/postedEditorState.js.map +1 -0
  200. package/dist/server/unsavedRichText/postedRequest.d.ts +36 -0
  201. package/dist/server/unsavedRichText/postedRequest.js +96 -0
  202. package/dist/server/unsavedRichText/postedRequest.js.map +1 -0
  203. package/dist/server/unsavedRichText/readAsUser.d.ts +6 -0
  204. package/dist/server/unsavedRichText/readAsUser.js +60 -0
  205. package/dist/server/unsavedRichText/readAsUser.js.map +1 -0
  206. package/dist/server/unsavedRichText/readContext.d.ts +10 -0
  207. package/dist/server/unsavedRichText/readContext.js +9 -0
  208. package/dist/server/unsavedRichText/readContext.js.map +1 -0
  209. package/dist/server/unsavedRichText/relatedIds.d.ts +2 -0
  210. package/dist/server/unsavedRichText/relatedIds.js +30 -0
  211. package/dist/server/unsavedRichText/relatedIds.js.map +1 -0
  212. package/dist/server/unsavedRichText/savedNodeFields.d.ts +2 -0
  213. package/dist/server/unsavedRichText/savedNodeFields.js +47 -0
  214. package/dist/server/unsavedRichText/savedNodeFields.js.map +1 -0
  215. package/dist/server/withInstantPreview.d.ts +9 -0
  216. package/dist/server/withInstantPreview.js +41 -0
  217. package/dist/server/withInstantPreview.js.map +1 -0
  218. package/dist/{client → shared}/buildAdminEditUrl.d.ts +2 -2
  219. package/dist/{client → shared}/buildAdminEditUrl.js +2 -1
  220. package/dist/shared/buildAdminEditUrl.js.map +1 -0
  221. package/dist/shared/editableSchema/editableSchema.d.ts +26 -0
  222. package/dist/shared/editableSchema/editableSchema.js +165 -0
  223. package/dist/shared/editableSchema/editableSchema.js.map +1 -0
  224. package/dist/shared/editableSchema/schemaOfFields.d.ts +16 -0
  225. package/dist/shared/editableSchema/schemaOfFields.js +106 -0
  226. package/dist/shared/editableSchema/schemaOfFields.js.map +1 -0
  227. package/dist/shared/fieldKey.d.ts +23 -0
  228. package/dist/shared/fieldKey.js +44 -0
  229. package/dist/shared/fieldKey.js.map +1 -0
  230. package/dist/shared/messageSource.d.ts +1 -0
  231. package/dist/shared/messageSource.js +3 -0
  232. package/dist/shared/messageSource.js.map +1 -0
  233. package/dist/shared/packageName.d.ts +1 -0
  234. package/dist/shared/packageName.js +3 -0
  235. package/dist/shared/packageName.js.map +1 -0
  236. package/dist/shared/plainObject.d.ts +2 -0
  237. package/dist/shared/plainObject.js +3 -0
  238. package/dist/shared/plainObject.js.map +1 -0
  239. package/dist/shared/protocol.d.ts +80 -0
  240. package/dist/shared/protocol.js +26 -0
  241. package/dist/shared/protocol.js.map +1 -0
  242. package/dist/shared/richText/blockNodes.d.ts +3 -0
  243. package/dist/shared/richText/blockNodes.js +35 -0
  244. package/dist/shared/richText/blockNodes.js.map +1 -0
  245. package/dist/shared/richText/editorNodes.d.ts +6 -0
  246. package/dist/shared/richText/editorNodes.js +25 -0
  247. package/dist/shared/richText/editorNodes.js.map +1 -0
  248. package/dist/shared/richText/nodeKey.d.ts +13 -0
  249. package/dist/shared/richText/nodeKey.js +22 -0
  250. package/dist/shared/richText/nodeKey.js.map +1 -0
  251. package/dist/shared/richText/nodeTypes.d.ts +5 -0
  252. package/dist/shared/richText/nodeTypes.js +20 -0
  253. package/dist/shared/richText/nodeTypes.js.map +1 -0
  254. package/dist/shared/richText/shapeOf.d.ts +1 -0
  255. package/dist/shared/richText/shapeOf.js +24 -0
  256. package/dist/shared/richText/shapeOf.js.map +1 -0
  257. package/dist/shared/richText/textLeaves.d.ts +14 -0
  258. package/dist/shared/richText/textLeaves.js +32 -0
  259. package/dist/shared/richText/textLeaves.js.map +1 -0
  260. package/dist/shared/rowWithId.d.ts +2 -0
  261. package/dist/shared/rowWithId.js +7 -0
  262. package/dist/shared/rowWithId.js.map +1 -0
  263. package/dist/{internal → shared}/shared.d.ts +5 -13
  264. package/dist/shared/shared.js +38 -0
  265. package/dist/shared/shared.js.map +1 -0
  266. package/dist/shared/stegaText.d.ts +2 -0
  267. package/dist/shared/stegaText.js +6 -0
  268. package/dist/shared/stegaText.js.map +1 -0
  269. package/dist/shared/veDocument.d.ts +15 -0
  270. package/dist/shared/veDocument.js +31 -0
  271. package/dist/shared/veDocument.js.map +1 -0
  272. package/dist/stripMarkers.d.ts +1 -0
  273. package/dist/stripMarkers.js +19 -0
  274. package/dist/stripMarkers.js.map +1 -0
  275. package/package.json +8 -9
  276. package/dist/client/buildAdminEditUrl.js.map +0 -1
  277. package/dist/client/overlay/createOverlay.d.ts +0 -11
  278. package/dist/client/overlay/createOverlay.js +0 -99
  279. package/dist/client/overlay/createOverlay.js.map +0 -1
  280. package/dist/client/overlay/stegaBookkeeper.d.ts +0 -11
  281. package/dist/client/overlay/stegaBookkeeper.js +0 -36
  282. package/dist/client/overlay/stegaBookkeeper.js.map +0 -1
  283. package/dist/client/overlay/stegaScanner.d.ts +0 -11
  284. package/dist/client/overlay/stegaScanner.js +0 -54
  285. package/dist/client/overlay/stegaScanner.js.map +0 -1
  286. package/dist/constants.d.ts +0 -16
  287. package/dist/constants.js +0 -15
  288. package/dist/constants.js.map +0 -1
  289. package/dist/internal/afterOperationHook.d.ts +0 -12
  290. package/dist/internal/afterOperationHook.js +0 -28
  291. package/dist/internal/afterOperationHook.js.map +0 -1
  292. package/dist/internal/afterReadHook.d.ts +0 -3
  293. package/dist/internal/afterReadHook.js +0 -16
  294. package/dist/internal/afterReadHook.js.map +0 -1
  295. package/dist/internal/beforeOperationHook.d.ts +0 -4
  296. package/dist/internal/beforeOperationHook.js +0 -16
  297. package/dist/internal/beforeOperationHook.js.map +0 -1
  298. package/dist/internal/buildFieldSchema.d.ts +0 -3
  299. package/dist/internal/buildFieldSchema.js +0 -67
  300. package/dist/internal/buildFieldSchema.js.map +0 -1
  301. package/dist/internal/encodeStega.d.ts +0 -7
  302. package/dist/internal/encodeStega.js +0 -171
  303. package/dist/internal/encodeStega.js.map +0 -1
  304. package/dist/internal/enrichWithPathMeta.d.ts +0 -4
  305. package/dist/internal/enrichWithPathMeta.js +0 -76
  306. package/dist/internal/enrichWithPathMeta.js.map +0 -1
  307. package/dist/internal/filterEditableFields.d.ts +0 -2
  308. package/dist/internal/filterEditableFields.js +0 -88
  309. package/dist/internal/filterEditableFields.js.map +0 -1
  310. package/dist/internal/gate.d.ts +0 -3
  311. package/dist/internal/gate.js +0 -16
  312. package/dist/internal/gate.js.map +0 -1
  313. package/dist/internal/globalAfterReadHook.d.ts +0 -12
  314. package/dist/internal/globalAfterReadHook.js +0 -19
  315. package/dist/internal/globalAfterReadHook.js.map +0 -1
  316. package/dist/internal/markTerminalUploads.d.ts +0 -13
  317. package/dist/internal/markTerminalUploads.js +0 -79
  318. package/dist/internal/markTerminalUploads.js.map +0 -1
  319. package/dist/internal/schemaCache.d.ts +0 -10
  320. package/dist/internal/schemaCache.js +0 -29
  321. package/dist/internal/schemaCache.js.map +0 -1
  322. package/dist/internal/shared.js +0 -55
  323. package/dist/internal/shared.js.map +0 -1
  324. package/dist/internal/stripStegaHook.js.map +0 -1
  325. /package/dist/{internal → server/hooks}/stripStegaHook.d.ts +0 -0
package/dist/index.js CHANGED
@@ -1,18 +1,21 @@
1
+ import { PACKAGE_NAME } from "./shared/packageName.js";
1
2
  import { defaultExcludeValues } from "./excludeValues.js";
2
- import { createAfterOperationHook } from "./internal/afterOperationHook.js";
3
- import { createAfterReadHook } from "./internal/afterReadHook.js";
4
- import { createBeforeOperationHook, createGlobalBeforeReadHook } from "./internal/beforeOperationHook.js";
5
- import { createGlobalAfterReadHook } from "./internal/globalAfterReadHook.js";
6
- import { createSchemaCache } from "./internal/schemaCache.js";
7
- import { createStripStegaHook } from "./internal/stripStegaHook.js";
3
+ import { createReadHooks } from "./server/hooks/readHooks.js";
4
+ import { createGlobalUnsavedRichTextHook, createUnsavedRichTextHook } from "./server/unsavedRichText/hooks.js";
5
+ import { createSchemaCache, withSchemaCache } from "./server/schemaCache.js";
6
+ import { createStripStegaHook } from "./server/hooks/stripStegaHook.js";
7
+ import { withInstantPreviewCollection, withInstantPreviewGlobal } from "./server/withInstantPreview.js";
8
8
  export { defaultExcludeValues, isHash, isIsoDate, isSlug, isUrl } from "./excludeValues.js";
9
+ export { stripMarkers } from "./stripMarkers.js";
10
+ export { DEFAULT_MAX_UNSAVED_STATE_LENGTH, DEFAULT_UNSAVED_READ_TIME_LIMIT_MS, readUnsavedRichText } from "./readUnsavedRichText.js";
11
+ export { isUnsavedRichTextRead } from "./server/unsavedRichText/readContext.js";
9
12
  const INTERNAL_COLLECTIONS = [
10
13
  "payload-preferences",
11
14
  "payload-migrations",
12
15
  "payload-locked-documents",
13
16
  "payload-jobs"
14
17
  ];
15
- const BRIDGE_COMPONENT_PATH = "@focus-reactive/payload-plugin-visual-editing/admin#VisualEditingBridgeProvider";
18
+ const BRIDGE_COMPONENT_PATH = `${PACKAGE_NAME}/admin#VisualEditingBridgeProvider`;
16
19
  export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
17
20
  const skipCols = new Set([
18
21
  ...INTERNAL_COLLECTIONS,
@@ -22,61 +25,67 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
22
25
  const adminBasePath = pluginConfig.adminBasePath ?? "/admin";
23
26
  const excludeValues = pluginConfig.excludeValues ?? defaultExcludeValues;
24
27
  const enrichment = pluginConfig.enrichment ?? "auto";
28
+ const instantPreview = pluginConfig.instantPreview ?? false;
29
+ const excludeFieldNames = pluginConfig.excludeFieldNames ?? [];
30
+ const instantPreviewOptions = {
31
+ excludeFieldNames,
32
+ rootLivePreview: config.admin?.livePreview
33
+ };
25
34
  const schemaCache = createSchemaCache({
26
- excludeFieldNames: pluginConfig.excludeFieldNames
27
- });
28
- const beforeOperation = createBeforeOperationHook();
29
- const afterRead = createAfterReadHook(adminBasePath, enrichment);
30
- const afterOperation = createAfterOperationHook({
31
- schemaCache,
32
- excludeValues,
33
- adminBasePath,
34
- enrichment
35
+ excludeFieldNames
35
36
  });
36
- const globalBeforeRead = createGlobalBeforeReadHook();
37
- const globalAfterRead = createGlobalAfterReadHook({
37
+ const { collectionAfterOperation, globalAfterRead, globalBeforeOperation } = createReadHooks({
38
38
  schemaCache,
39
39
  excludeValues,
40
40
  adminBasePath,
41
- enrichment
41
+ enrichment,
42
+ instantPreview
42
43
  });
43
44
  const stripStega = createStripStegaHook();
45
+ const unsavedRichText = instantPreview ? [
46
+ createUnsavedRichTextHook(schemaCache)
47
+ ] : [];
48
+ const globalUnsavedRichText = instantPreview ? [
49
+ createGlobalUnsavedRichTextHook(schemaCache)
50
+ ] : [];
44
51
  return {
45
52
  ...config,
53
+ custom: instantPreview ? withSchemaCache(config.custom, schemaCache) : config.custom,
46
54
  collections: config.collections?.map((collection)=>{
47
55
  if (skipCols.has(collection.slug)) return collection;
48
- return {
56
+ const withHooks = {
49
57
  ...collection,
50
58
  hooks: {
51
59
  ...collection.hooks,
52
- beforeOperation: [
53
- ...collection.hooks?.beforeOperation ?? [],
54
- beforeOperation
55
- ],
56
60
  beforeChange: [
57
61
  ...collection.hooks?.beforeChange ?? [],
58
62
  stripStega
59
63
  ],
60
- afterRead: [
61
- ...collection.hooks?.afterRead ?? [],
62
- afterRead
64
+ beforeRead: [
65
+ ...collection.hooks?.beforeRead ?? [],
66
+ ...unsavedRichText
63
67
  ],
64
68
  afterOperation: [
65
69
  ...collection.hooks?.afterOperation ?? [],
66
- afterOperation
70
+ collectionAfterOperation
67
71
  ]
68
72
  }
69
73
  };
74
+ return instantPreview ? withInstantPreviewCollection(withHooks, instantPreviewOptions) : withHooks;
70
75
  }),
71
76
  globals: config.globals?.map((global)=>{
72
77
  if (skipGlobals.has(global.slug)) return global;
73
- return {
78
+ const withHooks = {
74
79
  ...global,
75
80
  hooks: {
76
81
  ...global.hooks,
82
+ beforeOperation: [
83
+ ...global.hooks?.beforeOperation ?? [],
84
+ globalBeforeOperation
85
+ ],
77
86
  beforeRead: [
78
87
  ...global.hooks?.beforeRead ?? [],
79
- globalBeforeRead
88
+ ...globalUnsavedRichText
80
89
  ],
81
90
  beforeChange: [
82
91
  ...global.hooks?.beforeChange ?? [],
@@ -88,6 +97,7 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
88
97
  ]
89
98
  }
90
99
  };
100
+ return instantPreview ? withInstantPreviewGlobal(withHooks, instantPreviewOptions) : withHooks;
91
101
  }),
92
102
  admin: {
93
103
  ...config.admin,
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Plugin } from \"payload\";\n\nimport type { ValueExcludePredicate } from \"./excludeValues.js\";\nimport type { Enrichment } from \"./internal/gate.js\";\n\nimport { defaultExcludeValues } from \"./excludeValues.js\";\nimport { createAfterOperationHook } from \"./internal/afterOperationHook.js\";\nimport { createAfterReadHook } from \"./internal/afterReadHook.js\";\nimport {\n createBeforeOperationHook,\n createGlobalBeforeReadHook,\n} from \"./internal/beforeOperationHook.js\";\nimport { createGlobalAfterReadHook } from \"./internal/globalAfterReadHook.js\";\nimport { createSchemaCache } from \"./internal/schemaCache.js\";\nimport { createStripStegaHook } from \"./internal/stripStegaHook.js\";\n\nexport {\n defaultExcludeValues,\n isHash,\n isIsoDate,\n isSlug,\n isUrl,\n type ValueExcludePredicate,\n} from \"./excludeValues.js\";\n\ndeclare module \"payload\" {\n interface RequestContext {\n visualEditing?: boolean;\n }\n}\n\nconst INTERNAL_COLLECTIONS = [\n \"payload-preferences\",\n \"payload-migrations\",\n \"payload-locked-documents\",\n \"payload-jobs\",\n];\n\nconst BRIDGE_COMPONENT_PATH =\n \"@focus-reactive/payload-plugin-visual-editing/admin#VisualEditingBridgeProvider\";\n\nexport type VisualEditingPluginConfig = {\n skipCollections?: string[];\n skipGlobals?: string[];\n excludeFieldNames?: string[];\n /** Value-shape predicates; any matching value is left un-stega'd. Replaces defaults when set.\n * Omit to use `defaultExcludeValues` (URL / slug / hash / ISO-date). */\n excludeValues?: ValueExcludePredicate[];\n adminBasePath?: string;\n /** `'auto'` (default) enriches any Local API draft read outside the admin.\n * `'explicit'` enriches only reads that pass `context: { visualEditing: true }`. */\n enrichment?: Enrichment;\n};\n\nexport const visualEditingPlugin =\n (pluginConfig: VisualEditingPluginConfig = {}): Plugin =>\n (config) => {\n const skipCols = new Set([...INTERNAL_COLLECTIONS, ...(pluginConfig.skipCollections ?? [])]);\n const skipGlobals = new Set(pluginConfig.skipGlobals);\n const adminBasePath = pluginConfig.adminBasePath ?? \"/admin\";\n const excludeValues = pluginConfig.excludeValues ?? defaultExcludeValues;\n const enrichment = pluginConfig.enrichment ?? \"auto\";\n\n const schemaCache = createSchemaCache({\n excludeFieldNames: pluginConfig.excludeFieldNames,\n });\n const beforeOperation = createBeforeOperationHook();\n const afterRead = createAfterReadHook(adminBasePath, enrichment);\n const afterOperation = createAfterOperationHook({\n schemaCache,\n excludeValues,\n adminBasePath,\n enrichment,\n });\n const globalBeforeRead = createGlobalBeforeReadHook();\n const globalAfterRead = createGlobalAfterReadHook({\n schemaCache,\n excludeValues,\n adminBasePath,\n enrichment,\n });\n const stripStega = createStripStegaHook();\n\n return {\n ...config,\n collections: config.collections?.map((collection) => {\n if (skipCols.has(collection.slug)) return collection;\n return {\n ...collection,\n hooks: {\n ...collection.hooks,\n beforeOperation: [...(collection.hooks?.beforeOperation ?? []), beforeOperation],\n beforeChange: [...(collection.hooks?.beforeChange ?? []), stripStega],\n afterRead: [...(collection.hooks?.afterRead ?? []), afterRead],\n afterOperation: [...(collection.hooks?.afterOperation ?? []), afterOperation],\n },\n };\n }),\n globals: config.globals?.map((global) => {\n if (skipGlobals.has(global.slug)) return global;\n return {\n ...global,\n hooks: {\n ...global.hooks,\n beforeRead: [...(global.hooks?.beforeRead ?? []), globalBeforeRead],\n beforeChange: [...(global.hooks?.beforeChange ?? []), stripStega],\n afterRead: [...(global.hooks?.afterRead ?? []), globalAfterRead],\n },\n };\n }),\n admin: {\n ...config.admin,\n components: {\n ...config.admin?.components,\n providers: [\n ...(config.admin?.components?.providers ?? []),\n {\n path: BRIDGE_COMPONENT_PATH,\n clientProps: { adminBasePath },\n },\n ],\n },\n },\n };\n };\n"],"names":["defaultExcludeValues","createAfterOperationHook","createAfterReadHook","createBeforeOperationHook","createGlobalBeforeReadHook","createGlobalAfterReadHook","createSchemaCache","createStripStegaHook","isHash","isIsoDate","isSlug","isUrl","INTERNAL_COLLECTIONS","BRIDGE_COMPONENT_PATH","visualEditingPlugin","pluginConfig","config","skipCols","Set","skipCollections","skipGlobals","adminBasePath","excludeValues","enrichment","schemaCache","excludeFieldNames","beforeOperation","afterRead","afterOperation","globalBeforeRead","globalAfterRead","stripStega","collections","map","collection","has","slug","hooks","beforeChange","globals","global","beforeRead","admin","components","providers","path","clientProps"],"mappings":"AAKA,SAASA,oBAAoB,QAAQ,qBAAqB;AAC1D,SAASC,wBAAwB,QAAQ,mCAAmC;AAC5E,SAASC,mBAAmB,QAAQ,8BAA8B;AAClE,SACEC,yBAAyB,EACzBC,0BAA0B,QACrB,oCAAoC;AAC3C,SAASC,yBAAyB,QAAQ,oCAAoC;AAC9E,SAASC,iBAAiB,QAAQ,4BAA4B;AAC9D,SAASC,oBAAoB,QAAQ,+BAA+B;AAEpE,SACEP,oBAAoB,EACpBQ,MAAM,EACNC,SAAS,EACTC,MAAM,EACNC,KAAK,QAEA,qBAAqB;AAQ5B,MAAMC,uBAAuB;IAC3B;IACA;IACA;IACA;CACD;AAED,MAAMC,wBACJ;AAeF,OAAO,MAAMC,sBACX,CAACC,eAA0C,CAAC,CAAC,GAC7C,CAACC;QACC,MAAMC,WAAW,IAAIC,IAAI;eAAIN;eAA0BG,aAAaI,eAAe,IAAI,EAAE;SAAE;QAC3F,MAAMC,cAAc,IAAIF,IAAIH,aAAaK,WAAW;QACpD,MAAMC,gBAAgBN,aAAaM,aAAa,IAAI;QACpD,MAAMC,gBAAgBP,aAAaO,aAAa,IAAItB;QACpD,MAAMuB,aAAaR,aAAaQ,UAAU,IAAI;QAE9C,MAAMC,cAAclB,kBAAkB;YACpCmB,mBAAmBV,aAAaU,iBAAiB;QACnD;QACA,MAAMC,kBAAkBvB;QACxB,MAAMwB,YAAYzB,oBAAoBmB,eAAeE;QACrD,MAAMK,iBAAiB3B,yBAAyB;YAC9CuB;YACAF;YACAD;YACAE;QACF;QACA,MAAMM,mBAAmBzB;QACzB,MAAM0B,kBAAkBzB,0BAA0B;YAChDmB;YACAF;YACAD;YACAE;QACF;QACA,MAAMQ,aAAaxB;QAEnB,OAAO;YACL,GAAGS,MAAM;YACTgB,aAAahB,OAAOgB,WAAW,EAAEC,IAAI,CAACC;gBACpC,IAAIjB,SAASkB,GAAG,CAACD,WAAWE,IAAI,GAAG,OAAOF;gBAC1C,OAAO;oBACL,GAAGA,UAAU;oBACbG,OAAO;wBACL,GAAGH,WAAWG,KAAK;wBACnBX,iBAAiB;+BAAKQ,WAAWG,KAAK,EAAEX,mBAAmB,EAAE;4BAAGA;yBAAgB;wBAChFY,cAAc;+BAAKJ,WAAWG,KAAK,EAAEC,gBAAgB,EAAE;4BAAGP;yBAAW;wBACrEJ,WAAW;+BAAKO,WAAWG,KAAK,EAAEV,aAAa,EAAE;4BAAGA;yBAAU;wBAC9DC,gBAAgB;+BAAKM,WAAWG,KAAK,EAAET,kBAAkB,EAAE;4BAAGA;yBAAe;oBAC/E;gBACF;YACF;YACAW,SAASvB,OAAOuB,OAAO,EAAEN,IAAI,CAACO;gBAC5B,IAAIpB,YAAYe,GAAG,CAACK,OAAOJ,IAAI,GAAG,OAAOI;gBACzC,OAAO;oBACL,GAAGA,MAAM;oBACTH,OAAO;wBACL,GAAGG,OAAOH,KAAK;wBACfI,YAAY;+BAAKD,OAAOH,KAAK,EAAEI,cAAc,EAAE;4BAAGZ;yBAAiB;wBACnES,cAAc;+BAAKE,OAAOH,KAAK,EAAEC,gBAAgB,EAAE;4BAAGP;yBAAW;wBACjEJ,WAAW;+BAAKa,OAAOH,KAAK,EAAEV,aAAa,EAAE;4BAAGG;yBAAgB;oBAClE;gBACF;YACF;YACAY,OAAO;gBACL,GAAG1B,OAAO0B,KAAK;gBACfC,YAAY;oBACV,GAAG3B,OAAO0B,KAAK,EAAEC,UAAU;oBAC3BC,WAAW;2BACL5B,OAAO0B,KAAK,EAAEC,YAAYC,aAAa,EAAE;wBAC7C;4BACEC,MAAMhC;4BACNiC,aAAa;gCAAEzB;4BAAc;wBAC/B;qBACD;gBACH;YACF;QACF;IACF,EAAE"}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionConfig, GlobalConfig, Plugin } from \"payload\";\n\nimport type { ValueExcludePredicate } from \"./excludeValues.js\";\nimport type { Enrichment } from \"./server/markedReads.js\";\n\nimport { PACKAGE_NAME } from \"./shared/packageName.js\";\nimport { defaultExcludeValues } from \"./excludeValues.js\";\nimport { createReadHooks } from \"./server/hooks/readHooks.js\";\nimport {\n createGlobalUnsavedRichTextHook,\n createUnsavedRichTextHook,\n} from \"./server/unsavedRichText/hooks.js\";\nimport { createSchemaCache, withSchemaCache } from \"./server/schemaCache.js\";\nimport { createStripStegaHook } from \"./server/hooks/stripStegaHook.js\";\nimport {\n withInstantPreviewCollection,\n withInstantPreviewGlobal,\n} from \"./server/withInstantPreview.js\";\n\nexport {\n defaultExcludeValues,\n isHash,\n isIsoDate,\n isSlug,\n isUrl,\n type ValueExcludePredicate,\n} from \"./excludeValues.js\";\n\nexport { stripMarkers } from \"./stripMarkers.js\";\n\nexport {\n DEFAULT_MAX_UNSAVED_STATE_LENGTH,\n DEFAULT_UNSAVED_READ_TIME_LIMIT_MS,\n readUnsavedRichText,\n type ReadUnsavedRichTextArgs,\n type UnsavedRichTextDepth,\n} from \"./readUnsavedRichText.js\";\nexport { isUnsavedRichTextRead } from \"./server/unsavedRichText/readContext.js\";\nexport type { LiveRichTextField, LiveRichTextRequest } from \"./shared/protocol.js\";\n\ndeclare module \"payload\" {\n interface RequestContext {\n visualEditing?: boolean;\n }\n}\n\nconst INTERNAL_COLLECTIONS = [\n \"payload-preferences\",\n \"payload-migrations\",\n \"payload-locked-documents\",\n \"payload-jobs\",\n];\n\nconst BRIDGE_COMPONENT_PATH = `${PACKAGE_NAME}/admin#VisualEditingBridgeProvider`;\n\nexport type VisualEditingPluginConfig = {\n skipCollections?: string[];\n skipGlobals?: string[];\n excludeFieldNames?: string[];\n /** Value-shape predicates; any matching value is left un-stega'd. Replaces defaults when set.\n * Omit to use `defaultExcludeValues` (URL / slug / hash / ISO-date). */\n excludeValues?: ValueExcludePredicate[];\n adminBasePath?: string;\n /** `'auto'` (default) enriches any Local API draft read outside the admin.\n * `'explicit'` enriches only reads that pass `context: { visualEditing: true }`. */\n enrichment?: Enrichment;\n instantPreview?: boolean;\n};\n\nexport const visualEditingPlugin =\n (pluginConfig: VisualEditingPluginConfig = {}): Plugin =>\n (config) => {\n const skipCols = new Set([...INTERNAL_COLLECTIONS, ...(pluginConfig.skipCollections ?? [])]);\n const skipGlobals = new Set(pluginConfig.skipGlobals);\n const adminBasePath = pluginConfig.adminBasePath ?? \"/admin\";\n const excludeValues = pluginConfig.excludeValues ?? defaultExcludeValues;\n const enrichment = pluginConfig.enrichment ?? \"auto\";\n const instantPreview = pluginConfig.instantPreview ?? false;\n const excludeFieldNames = pluginConfig.excludeFieldNames ?? [];\n const instantPreviewOptions = {\n excludeFieldNames,\n rootLivePreview: config.admin?.livePreview,\n };\n\n const schemaCache = createSchemaCache({ excludeFieldNames });\n const { collectionAfterOperation, globalAfterRead, globalBeforeOperation } = createReadHooks({\n schemaCache,\n excludeValues,\n adminBasePath,\n enrichment,\n instantPreview,\n });\n const stripStega = createStripStegaHook();\n const unsavedRichText = instantPreview ? [createUnsavedRichTextHook(schemaCache)] : [];\n const globalUnsavedRichText = instantPreview\n ? [createGlobalUnsavedRichTextHook(schemaCache)]\n : [];\n\n return {\n ...config,\n custom: instantPreview ? withSchemaCache(config.custom, schemaCache) : config.custom,\n collections: config.collections?.map((collection) => {\n if (skipCols.has(collection.slug)) return collection;\n const withHooks: CollectionConfig = {\n ...collection,\n hooks: {\n ...collection.hooks,\n beforeChange: [...(collection.hooks?.beforeChange ?? []), stripStega],\n beforeRead: [...(collection.hooks?.beforeRead ?? []), ...unsavedRichText],\n afterOperation: [...(collection.hooks?.afterOperation ?? []), collectionAfterOperation],\n },\n };\n return instantPreview\n ? withInstantPreviewCollection(withHooks, instantPreviewOptions)\n : withHooks;\n }),\n globals: config.globals?.map((global) => {\n if (skipGlobals.has(global.slug)) return global;\n const withHooks: GlobalConfig = {\n ...global,\n hooks: {\n ...global.hooks,\n beforeOperation: [...(global.hooks?.beforeOperation ?? []), globalBeforeOperation],\n beforeRead: [...(global.hooks?.beforeRead ?? []), ...globalUnsavedRichText],\n beforeChange: [...(global.hooks?.beforeChange ?? []), stripStega],\n afterRead: [...(global.hooks?.afterRead ?? []), globalAfterRead],\n },\n };\n return instantPreview\n ? withInstantPreviewGlobal(withHooks, instantPreviewOptions)\n : withHooks;\n }),\n admin: {\n ...config.admin,\n components: {\n ...config.admin?.components,\n providers: [\n ...(config.admin?.components?.providers ?? []),\n {\n path: BRIDGE_COMPONENT_PATH,\n clientProps: { adminBasePath },\n },\n ],\n },\n },\n };\n };\n"],"names":["PACKAGE_NAME","defaultExcludeValues","createReadHooks","createGlobalUnsavedRichTextHook","createUnsavedRichTextHook","createSchemaCache","withSchemaCache","createStripStegaHook","withInstantPreviewCollection","withInstantPreviewGlobal","isHash","isIsoDate","isSlug","isUrl","stripMarkers","DEFAULT_MAX_UNSAVED_STATE_LENGTH","DEFAULT_UNSAVED_READ_TIME_LIMIT_MS","readUnsavedRichText","isUnsavedRichTextRead","INTERNAL_COLLECTIONS","BRIDGE_COMPONENT_PATH","visualEditingPlugin","pluginConfig","config","skipCols","Set","skipCollections","skipGlobals","adminBasePath","excludeValues","enrichment","instantPreview","excludeFieldNames","instantPreviewOptions","rootLivePreview","admin","livePreview","schemaCache","collectionAfterOperation","globalAfterRead","globalBeforeOperation","stripStega","unsavedRichText","globalUnsavedRichText","custom","collections","map","collection","has","slug","withHooks","hooks","beforeChange","beforeRead","afterOperation","globals","global","beforeOperation","afterRead","components","providers","path","clientProps"],"mappings":"AAKA,SAASA,YAAY,QAAQ,0BAA0B;AACvD,SAASC,oBAAoB,QAAQ,qBAAqB;AAC1D,SAASC,eAAe,QAAQ,8BAA8B;AAC9D,SACEC,+BAA+B,EAC/BC,yBAAyB,QACpB,oCAAoC;AAC3C,SAASC,iBAAiB,EAAEC,eAAe,QAAQ,0BAA0B;AAC7E,SAASC,oBAAoB,QAAQ,mCAAmC;AACxE,SACEC,4BAA4B,EAC5BC,wBAAwB,QACnB,iCAAiC;AAExC,SACER,oBAAoB,EACpBS,MAAM,EACNC,SAAS,EACTC,MAAM,EACNC,KAAK,QAEA,qBAAqB;AAE5B,SAASC,YAAY,QAAQ,oBAAoB;AAEjD,SACEC,gCAAgC,EAChCC,kCAAkC,EAClCC,mBAAmB,QAGd,2BAA2B;AAClC,SAASC,qBAAqB,QAAQ,0CAA0C;AAShF,MAAMC,uBAAuB;IAC3B;IACA;IACA;IACA;CACD;AAED,MAAMC,wBAAwB,CAAC,EAAEpB,aAAa,kCAAkC,CAAC;AAgBjF,OAAO,MAAMqB,sBACX,CAACC,eAA0C,CAAC,CAAC,GAC7C,CAACC;QACC,MAAMC,WAAW,IAAIC,IAAI;eAAIN;eAA0BG,aAAaI,eAAe,IAAI,EAAE;SAAE;QAC3F,MAAMC,cAAc,IAAIF,IAAIH,aAAaK,WAAW;QACpD,MAAMC,gBAAgBN,aAAaM,aAAa,IAAI;QACpD,MAAMC,gBAAgBP,aAAaO,aAAa,IAAI5B;QACpD,MAAM6B,aAAaR,aAAaQ,UAAU,IAAI;QAC9C,MAAMC,iBAAiBT,aAAaS,cAAc,IAAI;QACtD,MAAMC,oBAAoBV,aAAaU,iBAAiB,IAAI,EAAE;QAC9D,MAAMC,wBAAwB;YAC5BD;YACAE,iBAAiBX,OAAOY,KAAK,EAAEC;QACjC;QAEA,MAAMC,cAAchC,kBAAkB;YAAE2B;QAAkB;QAC1D,MAAM,EAAEM,wBAAwB,EAAEC,eAAe,EAAEC,qBAAqB,EAAE,GAAGtC,gBAAgB;YAC3FmC;YACAR;YACAD;YACAE;YACAC;QACF;QACA,MAAMU,aAAalC;QACnB,MAAMmC,kBAAkBX,iBAAiB;YAAC3B,0BAA0BiC;SAAa,GAAG,EAAE;QACtF,MAAMM,wBAAwBZ,iBAC1B;YAAC5B,gCAAgCkC;SAAa,GAC9C,EAAE;QAEN,OAAO;YACL,GAAGd,MAAM;YACTqB,QAAQb,iBAAiBzB,gBAAgBiB,OAAOqB,MAAM,EAAEP,eAAed,OAAOqB,MAAM;YACpFC,aAAatB,OAAOsB,WAAW,EAAEC,IAAI,CAACC;gBACpC,IAAIvB,SAASwB,GAAG,CAACD,WAAWE,IAAI,GAAG,OAAOF;gBAC1C,MAAMG,YAA8B;oBAClC,GAAGH,UAAU;oBACbI,OAAO;wBACL,GAAGJ,WAAWI,KAAK;wBACnBC,cAAc;+BAAKL,WAAWI,KAAK,EAAEC,gBAAgB,EAAE;4BAAGX;yBAAW;wBACrEY,YAAY;+BAAKN,WAAWI,KAAK,EAAEE,cAAc,EAAE;+BAAMX;yBAAgB;wBACzEY,gBAAgB;+BAAKP,WAAWI,KAAK,EAAEG,kBAAkB,EAAE;4BAAGhB;yBAAyB;oBACzF;gBACF;gBACA,OAAOP,iBACHvB,6BAA6B0C,WAAWjB,yBACxCiB;YACN;YACAK,SAAShC,OAAOgC,OAAO,EAAET,IAAI,CAACU;gBAC5B,IAAI7B,YAAYqB,GAAG,CAACQ,OAAOP,IAAI,GAAG,OAAOO;gBACzC,MAAMN,YAA0B;oBAC9B,GAAGM,MAAM;oBACTL,OAAO;wBACL,GAAGK,OAAOL,KAAK;wBACfM,iBAAiB;+BAAKD,OAAOL,KAAK,EAAEM,mBAAmB,EAAE;4BAAGjB;yBAAsB;wBAClFa,YAAY;+BAAKG,OAAOL,KAAK,EAAEE,cAAc,EAAE;+BAAMV;yBAAsB;wBAC3ES,cAAc;+BAAKI,OAAOL,KAAK,EAAEC,gBAAgB,EAAE;4BAAGX;yBAAW;wBACjEiB,WAAW;+BAAKF,OAAOL,KAAK,EAAEO,aAAa,EAAE;4BAAGnB;yBAAgB;oBAClE;gBACF;gBACA,OAAOR,iBACHtB,yBAAyByC,WAAWjB,yBACpCiB;YACN;YACAf,OAAO;gBACL,GAAGZ,OAAOY,KAAK;gBACfwB,YAAY;oBACV,GAAGpC,OAAOY,KAAK,EAAEwB,UAAU;oBAC3BC,WAAW;2BACLrC,OAAOY,KAAK,EAAEwB,YAAYC,aAAa,EAAE;wBAC7C;4BACEC,MAAMzC;4BACN0C,aAAa;gCAAElC;4BAAc;wBAC/B;qBACD;gBACH;YACF;QACF;IACF,EAAE"}
@@ -0,0 +1,13 @@
1
+ import type { Payload } from "payload";
2
+ import type { PostedRequest } from "./server/unsavedRichText/postedRequest.js";
3
+ import type { UnsavedRichTextDepth } from "./server/unsavedRichText/readAsUser.js";
4
+ export type { UnsavedRichTextDepth } from "./server/unsavedRichText/readAsUser.js";
5
+ export declare const DEFAULT_MAX_UNSAVED_STATE_LENGTH = 1000000;
6
+ export declare const DEFAULT_UNSAVED_READ_TIME_LIMIT_MS = 3000;
7
+ export type ReadUnsavedRichTextArgs = PostedRequest & {
8
+ payload: Payload;
9
+ depth?: UnsavedRichTextDepth;
10
+ maxStateLength?: number;
11
+ timeLimitMs?: number;
12
+ };
13
+ export declare const readUnsavedRichText: <Content = unknown>({ depth, maxStateLength, payload, timeLimitMs, ...posted }: ReadUnsavedRichTextArgs) => Promise<Content | null>;
@@ -0,0 +1,75 @@
1
+ import { createLatestReads } from "./server/unsavedRichText/latestReads.js";
2
+ import { checkAndSignIn, signInAndReadBody } from "./server/unsavedRichText/postedRequest.js";
3
+ import { readAsUser, readKeyOf } from "./server/unsavedRichText/readAsUser.js";
4
+ export const DEFAULT_MAX_UNSAVED_STATE_LENGTH = 1_000_000;
5
+ export const DEFAULT_UNSAVED_READ_TIME_LIMIT_MS = 3000;
6
+ const UNSAVED_READ_FAILURE_MESSAGE = "Reading an unsaved rich text state failed";
7
+ const RUNNING_READ_STALE_AFTER_TIME_LIMITS = 3;
8
+ const latestReadsByPayload = new WeakMap();
9
+ const latestReadsOf = (payload)=>{
10
+ const latestReads = latestReadsByPayload.get(payload) ?? createLatestReads(new Map());
11
+ latestReadsByPayload.set(payload, latestReads);
12
+ return latestReads;
13
+ };
14
+ const deadlineAfter = (timeLimitMs, requestSignal)=>{
15
+ const reached = new AbortController();
16
+ const signal = requestSignal ? AbortSignal.any([
17
+ reached.signal,
18
+ requestSignal
19
+ ]) : reached.signal;
20
+ const timer = setTimeout(()=>reached.abort(), timeLimitMs);
21
+ const nothing = new Promise((resolve)=>{
22
+ if (signal.aborted) resolve(null);
23
+ signal.addEventListener("abort", ()=>resolve(null), {
24
+ once: true
25
+ });
26
+ });
27
+ return {
28
+ nothing,
29
+ signal,
30
+ stop: ()=>clearTimeout(timer)
31
+ };
32
+ };
33
+ const ignoreFailure = ()=>undefined;
34
+ const nullOnFailure = async (work, onFailure = ignoreFailure)=>{
35
+ try {
36
+ return await work();
37
+ } catch (err) {
38
+ onFailure(err);
39
+ return null;
40
+ }
41
+ };
42
+ const readPostedAsUser = async (payload, { headers, request }, options)=>{
43
+ const signedIn = await nullOnFailure(()=>request instanceof Request ? signInAndReadBody(payload, request, options) : checkAndSignIn(payload, request, headers, options));
44
+ if (!signedIn || options.signal.aborted) return null;
45
+ const { unsaved, user } = signedIn;
46
+ const logFailure = (err)=>payload.logger.error({
47
+ err,
48
+ msg: UNSAVED_READ_FAILURE_MESSAGE
49
+ });
50
+ const readOnce = ()=>nullOnFailure(()=>readAsUser(payload, user, unsaved, options.depth), logFailure);
51
+ return latestReadsOf(payload).read(readKeyOf(user, unsaved), readOnce, {
52
+ signal: options.signal,
53
+ staleAfterMs: options.timeLimitMs * RUNNING_READ_STALE_AFTER_TIME_LIMITS
54
+ });
55
+ };
56
+ export const readUnsavedRichText = async ({ depth, maxStateLength = DEFAULT_MAX_UNSAVED_STATE_LENGTH, payload, timeLimitMs = DEFAULT_UNSAVED_READ_TIME_LIMIT_MS, ...posted })=>{
57
+ const requestSignal = posted.request instanceof Request ? posted.request.signal : undefined;
58
+ const { nothing, signal, stop } = deadlineAfter(timeLimitMs, requestSignal);
59
+ const options = {
60
+ depth,
61
+ maxStateLength,
62
+ signal,
63
+ timeLimitMs
64
+ };
65
+ try {
66
+ return await Promise.race([
67
+ readPostedAsUser(payload, posted, options),
68
+ nothing
69
+ ]);
70
+ } finally{
71
+ stop();
72
+ }
73
+ };
74
+
75
+ //# sourceMappingURL=readUnsavedRichText.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/readUnsavedRichText.ts"],"sourcesContent":["import type { Payload } from \"payload\";\n\nimport type { LatestReads } from \"./server/unsavedRichText/latestReads.js\";\nimport type { PostedReadLimits, PostedRequest } from \"./server/unsavedRichText/postedRequest.js\";\nimport type { UnsavedRichTextDepth } from \"./server/unsavedRichText/readAsUser.js\";\n\nimport { createLatestReads } from \"./server/unsavedRichText/latestReads.js\";\nimport { checkAndSignIn, signInAndReadBody } from \"./server/unsavedRichText/postedRequest.js\";\nimport { readAsUser, readKeyOf } from \"./server/unsavedRichText/readAsUser.js\";\n\nexport type { UnsavedRichTextDepth } from \"./server/unsavedRichText/readAsUser.js\";\n\nexport const DEFAULT_MAX_UNSAVED_STATE_LENGTH = 1_000_000;\nexport const DEFAULT_UNSAVED_READ_TIME_LIMIT_MS = 3000;\n\nconst UNSAVED_READ_FAILURE_MESSAGE = \"Reading an unsaved rich text state failed\";\nconst RUNNING_READ_STALE_AFTER_TIME_LIMITS = 3;\n\nexport type ReadUnsavedRichTextArgs = PostedRequest & {\n payload: Payload;\n depth?: UnsavedRichTextDepth;\n maxStateLength?: number;\n timeLimitMs?: number;\n};\n\nconst latestReadsByPayload = new WeakMap<Payload, LatestReads>();\n\nconst latestReadsOf = (payload: Payload): LatestReads => {\n const latestReads = latestReadsByPayload.get(payload) ?? createLatestReads(new Map());\n latestReadsByPayload.set(payload, latestReads);\n return latestReads;\n};\n\nconst deadlineAfter = (timeLimitMs: number, requestSignal: AbortSignal | undefined) => {\n const reached = new AbortController();\n const signal = requestSignal ? AbortSignal.any([reached.signal, requestSignal]) : reached.signal;\n const timer = setTimeout(() => reached.abort(), timeLimitMs);\n const nothing = new Promise<null>((resolve) => {\n if (signal.aborted) resolve(null);\n signal.addEventListener(\"abort\", () => resolve(null), { once: true });\n });\n return { nothing, signal, stop: () => clearTimeout(timer) };\n};\n\ntype ReadOptions = PostedReadLimits & {\n depth: UnsavedRichTextDepth | undefined;\n timeLimitMs: number;\n};\n\nconst ignoreFailure = (): void => undefined;\n\nconst nullOnFailure = async <Value>(\n work: () => Promise<Value>,\n onFailure: (err: unknown) => void = ignoreFailure\n): Promise<Value | null> => {\n try {\n return await work();\n } catch (err) {\n onFailure(err);\n return null;\n }\n};\n\nconst readPostedAsUser = async <Content>(\n payload: Payload,\n { headers, request }: PostedRequest,\n options: ReadOptions\n): Promise<Content | null> => {\n const signedIn = await nullOnFailure(() =>\n request instanceof Request\n ? signInAndReadBody(payload, request, options)\n : checkAndSignIn(payload, request, headers, options)\n );\n if (!signedIn || options.signal.aborted) return null;\n const { unsaved, user } = signedIn;\n const logFailure = (err: unknown) =>\n payload.logger.error({ err, msg: UNSAVED_READ_FAILURE_MESSAGE });\n const readOnce = () =>\n nullOnFailure(() => readAsUser<Content>(payload, user, unsaved, options.depth), logFailure);\n return latestReadsOf(payload).read(readKeyOf(user, unsaved), readOnce, {\n signal: options.signal,\n staleAfterMs: options.timeLimitMs * RUNNING_READ_STALE_AFTER_TIME_LIMITS,\n });\n};\n\nexport const readUnsavedRichText = async <Content = unknown>({\n depth,\n maxStateLength = DEFAULT_MAX_UNSAVED_STATE_LENGTH,\n payload,\n timeLimitMs = DEFAULT_UNSAVED_READ_TIME_LIMIT_MS,\n ...posted\n}: ReadUnsavedRichTextArgs): Promise<Content | null> => {\n const requestSignal = posted.request instanceof Request ? posted.request.signal : undefined;\n const { nothing, signal, stop } = deadlineAfter(timeLimitMs, requestSignal);\n const options = { depth, maxStateLength, signal, timeLimitMs };\n try {\n return await Promise.race([readPostedAsUser<Content>(payload, posted, options), nothing]);\n } finally {\n stop();\n }\n};\n"],"names":["createLatestReads","checkAndSignIn","signInAndReadBody","readAsUser","readKeyOf","DEFAULT_MAX_UNSAVED_STATE_LENGTH","DEFAULT_UNSAVED_READ_TIME_LIMIT_MS","UNSAVED_READ_FAILURE_MESSAGE","RUNNING_READ_STALE_AFTER_TIME_LIMITS","latestReadsByPayload","WeakMap","latestReadsOf","payload","latestReads","get","Map","set","deadlineAfter","timeLimitMs","requestSignal","reached","AbortController","signal","AbortSignal","any","timer","setTimeout","abort","nothing","Promise","resolve","aborted","addEventListener","once","stop","clearTimeout","ignoreFailure","undefined","nullOnFailure","work","onFailure","err","readPostedAsUser","headers","request","options","signedIn","Request","unsaved","user","logFailure","logger","error","msg","readOnce","depth","read","staleAfterMs","readUnsavedRichText","maxStateLength","posted","race"],"mappings":"AAMA,SAASA,iBAAiB,QAAQ,0CAA0C;AAC5E,SAASC,cAAc,EAAEC,iBAAiB,QAAQ,4CAA4C;AAC9F,SAASC,UAAU,EAAEC,SAAS,QAAQ,yCAAyC;AAI/E,OAAO,MAAMC,mCAAmC,UAAU;AAC1D,OAAO,MAAMC,qCAAqC,KAAK;AAEvD,MAAMC,+BAA+B;AACrC,MAAMC,uCAAuC;AAS7C,MAAMC,uBAAuB,IAAIC;AAEjC,MAAMC,gBAAgB,CAACC;IACrB,MAAMC,cAAcJ,qBAAqBK,GAAG,CAACF,YAAYZ,kBAAkB,IAAIe;IAC/EN,qBAAqBO,GAAG,CAACJ,SAASC;IAClC,OAAOA;AACT;AAEA,MAAMI,gBAAgB,CAACC,aAAqBC;IAC1C,MAAMC,UAAU,IAAIC;IACpB,MAAMC,SAASH,gBAAgBI,YAAYC,GAAG,CAAC;QAACJ,QAAQE,MAAM;QAAEH;KAAc,IAAIC,QAAQE,MAAM;IAChG,MAAMG,QAAQC,WAAW,IAAMN,QAAQO,KAAK,IAAIT;IAChD,MAAMU,UAAU,IAAIC,QAAc,CAACC;QACjC,IAAIR,OAAOS,OAAO,EAAED,QAAQ;QAC5BR,OAAOU,gBAAgB,CAAC,SAAS,IAAMF,QAAQ,OAAO;YAAEG,MAAM;QAAK;IACrE;IACA,OAAO;QAAEL;QAASN;QAAQY,MAAM,IAAMC,aAAaV;IAAO;AAC5D;AAOA,MAAMW,gBAAgB,IAAYC;AAElC,MAAMC,gBAAgB,OACpBC,MACAC,YAAoCJ,aAAa;IAEjD,IAAI;QACF,OAAO,MAAMG;IACf,EAAE,OAAOE,KAAK;QACZD,UAAUC;QACV,OAAO;IACT;AACF;AAEA,MAAMC,mBAAmB,OACvB9B,SACA,EAAE+B,OAAO,EAAEC,OAAO,EAAiB,EACnCC;IAEA,MAAMC,WAAW,MAAMR,cAAc,IACnCM,mBAAmBG,UACf7C,kBAAkBU,SAASgC,SAASC,WACpC5C,eAAeW,SAASgC,SAASD,SAASE;IAEhD,IAAI,CAACC,YAAYD,QAAQvB,MAAM,CAACS,OAAO,EAAE,OAAO;IAChD,MAAM,EAAEiB,OAAO,EAAEC,IAAI,EAAE,GAAGH;IAC1B,MAAMI,aAAa,CAACT,MAClB7B,QAAQuC,MAAM,CAACC,KAAK,CAAC;YAAEX;YAAKY,KAAK9C;QAA6B;IAChE,MAAM+C,WAAW,IACfhB,cAAc,IAAMnC,WAAoBS,SAASqC,MAAMD,SAASH,QAAQU,KAAK,GAAGL;IAClF,OAAOvC,cAAcC,SAAS4C,IAAI,CAACpD,UAAU6C,MAAMD,UAAUM,UAAU;QACrEhC,QAAQuB,QAAQvB,MAAM;QACtBmC,cAAcZ,QAAQ3B,WAAW,GAAGV;IACtC;AACF;AAEA,OAAO,MAAMkD,sBAAsB,OAA0B,EAC3DH,KAAK,EACLI,iBAAiBtD,gCAAgC,EACjDO,OAAO,EACPM,cAAcZ,kCAAkC,EAChD,GAAGsD,QACqB;IACxB,MAAMzC,gBAAgByC,OAAOhB,OAAO,YAAYG,UAAUa,OAAOhB,OAAO,CAACtB,MAAM,GAAGe;IAClF,MAAM,EAAET,OAAO,EAAEN,MAAM,EAAEY,IAAI,EAAE,GAAGjB,cAAcC,aAAaC;IAC7D,MAAM0B,UAAU;QAAEU;QAAOI;QAAgBrC;QAAQJ;IAAY;IAC7D,IAAI;QACF,OAAO,MAAMW,QAAQgC,IAAI,CAAC;YAACnB,iBAA0B9B,SAASgD,QAAQf;YAAUjB;SAAQ;IAC1F,SAAU;QACRM;IACF;AACF,EAAE"}
@@ -0,0 +1,14 @@
1
+ import type { CollectionAfterOperationHook, GlobalAfterReadHook, GlobalBeforeOperationHook } from "payload";
2
+ import type { ValueExcludePredicate } from "../../excludeValues.js";
3
+ import type { MarkedReadsOptions } from "../markedReads.js";
4
+ import type { SchemaCache } from "../schemaCache.js";
5
+ export type ReadHooksOptions = MarkedReadsOptions & {
6
+ schemaCache: SchemaCache;
7
+ excludeValues: readonly ValueExcludePredicate[];
8
+ instantPreview: boolean;
9
+ };
10
+ export declare const createReadHooks: (options: ReadHooksOptions) => {
11
+ collectionAfterOperation: CollectionAfterOperationHook;
12
+ globalAfterRead: GlobalAfterReadHook;
13
+ globalBeforeOperation: GlobalBeforeOperationHook;
14
+ };
@@ -0,0 +1,67 @@
1
+ import { isPlainObject } from "../../shared/plainObject.js";
2
+ import { collectionDocumentOf, idOf } from "../../shared/veDocument.js";
3
+ import { localeCodesKeyingValues } from "../localeCodesKeyingValues.js";
4
+ import { createMarkedReads, isCollectionVersionRead } from "../markedReads.js";
5
+ import { markRead } from "../markRead.js";
6
+ const parentIdOf = (parent, version)=>idOf(isPlainObject(parent) ? parent.id : parent) ?? version.id;
7
+ export const createReadHooks = (options)=>{
8
+ const markedReads = createMarkedReads(options);
9
+ const readOf = (req, identity)=>({
10
+ excludeValues: options.excludeValues,
11
+ identity,
12
+ instantPreview: options.instantPreview,
13
+ localeCodesKeyingValues: localeCodesKeyingValues(req),
14
+ schema: options.schemaCache.get(identity.collectionSlug, req.payload)
15
+ });
16
+ const collectionAfterOperation = ({ args, collection, operation, req, result })=>{
17
+ if (!markedReads.isCollectionReadMarked({
18
+ args,
19
+ operation,
20
+ req
21
+ })) return result;
22
+ const isVersionRead = isCollectionVersionRead(operation);
23
+ const markDocument = (doc)=>{
24
+ if (!isPlainObject(doc)) return doc;
25
+ if (!isVersionRead) {
26
+ return markRead(doc, readOf(req, collectionDocumentOf(collection.slug, doc.id)));
27
+ }
28
+ const { version } = doc;
29
+ if (!isPlainObject(version)) return doc;
30
+ const read = readOf(req, collectionDocumentOf(collection.slug, parentIdOf(doc.parent, version)));
31
+ return {
32
+ ...doc,
33
+ version: markRead(version, read)
34
+ };
35
+ };
36
+ if (operation !== "find" && operation !== "findVersions") return markDocument(result);
37
+ if (Array.isArray(result.docs)) result.docs = result.docs.map((doc)=>markDocument(doc));
38
+ return result;
39
+ };
40
+ const globalBeforeOperation = ({ args, global, operation, req })=>{
41
+ markedReads.openGlobalRead({
42
+ args,
43
+ operation,
44
+ req,
45
+ slug: global.slug
46
+ });
47
+ };
48
+ const globalAfterRead = (read)=>{
49
+ const { doc, global, req } = read;
50
+ if (!markedReads.closeGlobalRead({
51
+ ...read,
52
+ slug: global.slug
53
+ })) return doc;
54
+ if (!isPlainObject(doc)) return doc;
55
+ return markRead(doc, readOf(req, {
56
+ collectionSlug: global.slug,
57
+ kind: "global"
58
+ }));
59
+ };
60
+ return {
61
+ collectionAfterOperation,
62
+ globalAfterRead,
63
+ globalBeforeOperation
64
+ };
65
+ };
66
+
67
+ //# sourceMappingURL=readHooks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/server/hooks/readHooks.ts"],"sourcesContent":["import type {\n CollectionAfterOperationHook,\n GlobalAfterReadHook,\n GlobalBeforeOperationHook,\n PayloadRequest,\n} from \"payload\";\n\nimport type { ValueExcludePredicate } from \"../../excludeValues.js\";\nimport type { PlainObject } from \"../../shared/plainObject.js\";\nimport type { VeDocument } from \"../../shared/protocol.js\";\nimport type { MarkedReadsOptions } from \"../markedReads.js\";\nimport type { ReadOfDocument } from \"../markRead.js\";\nimport type { SchemaCache } from \"../schemaCache.js\";\n\nimport { isPlainObject } from \"../../shared/plainObject.js\";\nimport { collectionDocumentOf, idOf } from \"../../shared/veDocument.js\";\nimport { localeCodesKeyingValues } from \"../localeCodesKeyingValues.js\";\nimport { createMarkedReads, isCollectionVersionRead } from \"../markedReads.js\";\nimport { markRead } from \"../markRead.js\";\n\nexport type ReadHooksOptions = MarkedReadsOptions & {\n schemaCache: SchemaCache;\n excludeValues: readonly ValueExcludePredicate[];\n instantPreview: boolean;\n};\n\nconst parentIdOf = (parent: unknown, version: PlainObject): unknown =>\n idOf(isPlainObject(parent) ? parent.id : parent) ?? version.id;\n\nexport const createReadHooks = (options: ReadHooksOptions) => {\n const markedReads = createMarkedReads(options);\n\n const readOf = (req: PayloadRequest, identity: VeDocument): ReadOfDocument => ({\n excludeValues: options.excludeValues,\n identity,\n instantPreview: options.instantPreview,\n localeCodesKeyingValues: localeCodesKeyingValues(req),\n schema: options.schemaCache.get(identity.collectionSlug, req.payload),\n });\n\n const collectionAfterOperation: CollectionAfterOperationHook = ({\n args,\n collection,\n operation,\n req,\n result,\n }) => {\n if (!markedReads.isCollectionReadMarked({ args, operation, req })) return result;\n\n const isVersionRead = isCollectionVersionRead(operation);\n const markDocument = <Value>(doc: Value): Value => {\n if (!isPlainObject(doc)) return doc;\n if (!isVersionRead) {\n return markRead(doc, readOf(req, collectionDocumentOf(collection.slug, doc.id))) as Value;\n }\n const { version } = doc;\n if (!isPlainObject(version)) return doc;\n const read = readOf(\n req,\n collectionDocumentOf(collection.slug, parentIdOf(doc.parent, version))\n );\n return { ...doc, version: markRead(version, read) };\n };\n\n if (operation !== \"find\" && operation !== \"findVersions\") return markDocument(result);\n if (Array.isArray(result.docs)) result.docs = result.docs.map((doc) => markDocument(doc));\n return result;\n };\n\n const globalBeforeOperation: GlobalBeforeOperationHook = ({ args, global, operation, req }) => {\n markedReads.openGlobalRead({ args, operation, req, slug: global.slug });\n };\n\n const globalAfterRead: GlobalAfterReadHook = (read) => {\n const { doc, global, req } = read;\n if (!markedReads.closeGlobalRead({ ...read, slug: global.slug })) return doc;\n if (!isPlainObject(doc)) return doc;\n return markRead(doc, readOf(req, { collectionSlug: global.slug, kind: \"global\" }));\n };\n\n return { collectionAfterOperation, globalAfterRead, globalBeforeOperation };\n};\n"],"names":["isPlainObject","collectionDocumentOf","idOf","localeCodesKeyingValues","createMarkedReads","isCollectionVersionRead","markRead","parentIdOf","parent","version","id","createReadHooks","options","markedReads","readOf","req","identity","excludeValues","instantPreview","schema","schemaCache","get","collectionSlug","payload","collectionAfterOperation","args","collection","operation","result","isCollectionReadMarked","isVersionRead","markDocument","doc","slug","read","Array","isArray","docs","map","globalBeforeOperation","global","openGlobalRead","globalAfterRead","closeGlobalRead","kind"],"mappings":"AAcA,SAASA,aAAa,QAAQ,8BAA8B;AAC5D,SAASC,oBAAoB,EAAEC,IAAI,QAAQ,6BAA6B;AACxE,SAASC,uBAAuB,QAAQ,gCAAgC;AACxE,SAASC,iBAAiB,EAAEC,uBAAuB,QAAQ,oBAAoB;AAC/E,SAASC,QAAQ,QAAQ,iBAAiB;AAQ1C,MAAMC,aAAa,CAACC,QAAiBC,UACnCP,KAAKF,cAAcQ,UAAUA,OAAOE,EAAE,GAAGF,WAAWC,QAAQC,EAAE;AAEhE,OAAO,MAAMC,kBAAkB,CAACC;IAC9B,MAAMC,cAAcT,kBAAkBQ;IAEtC,MAAME,SAAS,CAACC,KAAqBC,WAA0C,CAAA;YAC7EC,eAAeL,QAAQK,aAAa;YACpCD;YACAE,gBAAgBN,QAAQM,cAAc;YACtCf,yBAAyBA,wBAAwBY;YACjDI,QAAQP,QAAQQ,WAAW,CAACC,GAAG,CAACL,SAASM,cAAc,EAAEP,IAAIQ,OAAO;QACtE,CAAA;IAEA,MAAMC,2BAAyD,CAAC,EAC9DC,IAAI,EACJC,UAAU,EACVC,SAAS,EACTZ,GAAG,EACHa,MAAM,EACP;QACC,IAAI,CAACf,YAAYgB,sBAAsB,CAAC;YAAEJ;YAAME;YAAWZ;QAAI,IAAI,OAAOa;QAE1E,MAAME,gBAAgBzB,wBAAwBsB;QAC9C,MAAMI,eAAe,CAAQC;YAC3B,IAAI,CAAChC,cAAcgC,MAAM,OAAOA;YAChC,IAAI,CAACF,eAAe;gBAClB,OAAOxB,SAAS0B,KAAKlB,OAAOC,KAAKd,qBAAqByB,WAAWO,IAAI,EAAED,IAAItB,EAAE;YAC/E;YACA,MAAM,EAAED,OAAO,EAAE,GAAGuB;YACpB,IAAI,CAAChC,cAAcS,UAAU,OAAOuB;YACpC,MAAME,OAAOpB,OACXC,KACAd,qBAAqByB,WAAWO,IAAI,EAAE1B,WAAWyB,IAAIxB,MAAM,EAAEC;YAE/D,OAAO;gBAAE,GAAGuB,GAAG;gBAAEvB,SAASH,SAASG,SAASyB;YAAM;QACpD;QAEA,IAAIP,cAAc,UAAUA,cAAc,gBAAgB,OAAOI,aAAaH;QAC9E,IAAIO,MAAMC,OAAO,CAACR,OAAOS,IAAI,GAAGT,OAAOS,IAAI,GAAGT,OAAOS,IAAI,CAACC,GAAG,CAAC,CAACN,MAAQD,aAAaC;QACpF,OAAOJ;IACT;IAEA,MAAMW,wBAAmD,CAAC,EAAEd,IAAI,EAAEe,MAAM,EAAEb,SAAS,EAAEZ,GAAG,EAAE;QACxFF,YAAY4B,cAAc,CAAC;YAAEhB;YAAME;YAAWZ;YAAKkB,MAAMO,OAAOP,IAAI;QAAC;IACvE;IAEA,MAAMS,kBAAuC,CAACR;QAC5C,MAAM,EAAEF,GAAG,EAAEQ,MAAM,EAAEzB,GAAG,EAAE,GAAGmB;QAC7B,IAAI,CAACrB,YAAY8B,eAAe,CAAC;YAAE,GAAGT,IAAI;YAAED,MAAMO,OAAOP,IAAI;QAAC,IAAI,OAAOD;QACzE,IAAI,CAAChC,cAAcgC,MAAM,OAAOA;QAChC,OAAO1B,SAAS0B,KAAKlB,OAAOC,KAAK;YAAEO,gBAAgBkB,OAAOP,IAAI;YAAEW,MAAM;QAAS;IACjF;IAEA,OAAO;QAAEpB;QAA0BkB;QAAiBH;IAAsB;AAC5E,EAAE"}
@@ -1,18 +1,11 @@
1
- import { vercelStegaSplit } from "@vercel/stega";
2
- import { META_KEY, isPlainObject } from "./shared.js";
3
- // Defense in depth: strip stega from every write so zero-width chars can never
4
- // reach the database, even if the gate ever mis-classifies a read. Idempotent.
5
- export const createStripStegaHook = ()=>{
6
- return ({ data })=>{
7
- stripStega(data);
8
- return data;
9
- };
10
- };
1
+ import { META_KEY } from "../../shared/shared.js";
2
+ import { isPlainObject } from "../../shared/plainObject.js";
3
+ import { withoutMarker } from "../../shared/stegaText.js";
11
4
  const stripStega = (value)=>{
12
5
  if (Array.isArray(value)) {
13
6
  for(let i = 0; i < value.length; i++){
14
7
  const item = value[i];
15
- if (typeof item === "string") value[i] = vercelStegaSplit(item).cleaned;
8
+ if (typeof item === "string") value[i] = withoutMarker(item);
16
9
  else stripStega(item);
17
10
  }
18
11
  return;
@@ -21,9 +14,15 @@ const stripStega = (value)=>{
21
14
  for(const key in value){
22
15
  if (key === META_KEY) continue;
23
16
  const current = value[key];
24
- if (typeof current === "string") value[key] = vercelStegaSplit(current).cleaned;
17
+ if (typeof current === "string") value[key] = withoutMarker(current);
25
18
  else stripStega(current);
26
19
  }
27
20
  };
21
+ export const createStripStegaHook = ()=>{
22
+ return ({ data })=>{
23
+ stripStega(data);
24
+ return data;
25
+ };
26
+ };
28
27
 
29
28
  //# sourceMappingURL=stripStegaHook.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/server/hooks/stripStegaHook.ts"],"sourcesContent":["import type { CollectionBeforeChangeHook, GlobalBeforeChangeHook } from \"payload\";\n\nimport { META_KEY } from \"../../shared/shared.js\";\nimport { isPlainObject } from \"../../shared/plainObject.js\";\nimport { withoutMarker } from \"../../shared/stegaText.js\";\n\nconst stripStega = (value: unknown): void => {\n if (Array.isArray(value)) {\n for (let i = 0; i < value.length; i++) {\n const item = value[i];\n if (typeof item === \"string\") value[i] = withoutMarker(item);\n else stripStega(item);\n }\n return;\n }\n\n if (!isPlainObject(value)) return;\n\n for (const key in value) {\n if (key === META_KEY) continue;\n const current = value[key];\n if (typeof current === \"string\") value[key] = withoutMarker(current);\n else stripStega(current);\n }\n};\n\nexport const createStripStegaHook = (): CollectionBeforeChangeHook & GlobalBeforeChangeHook => {\n return ({ data }: { data: unknown }) => {\n stripStega(data);\n return data;\n };\n};\n"],"names":["META_KEY","isPlainObject","withoutMarker","stripStega","value","Array","isArray","i","length","item","key","current","createStripStegaHook","data"],"mappings":"AAEA,SAASA,QAAQ,QAAQ,yBAAyB;AAClD,SAASC,aAAa,QAAQ,8BAA8B;AAC5D,SAASC,aAAa,QAAQ,4BAA4B;AAE1D,MAAMC,aAAa,CAACC;IAClB,IAAIC,MAAMC,OAAO,CAACF,QAAQ;QACxB,IAAK,IAAIG,IAAI,GAAGA,IAAIH,MAAMI,MAAM,EAAED,IAAK;YACrC,MAAME,OAAOL,KAAK,CAACG,EAAE;YACrB,IAAI,OAAOE,SAAS,UAAUL,KAAK,CAACG,EAAE,GAAGL,cAAcO;iBAClDN,WAAWM;QAClB;QACA;IACF;IAEA,IAAI,CAACR,cAAcG,QAAQ;IAE3B,IAAK,MAAMM,OAAON,MAAO;QACvB,IAAIM,QAAQV,UAAU;QACtB,MAAMW,UAAUP,KAAK,CAACM,IAAI;QAC1B,IAAI,OAAOC,YAAY,UAAUP,KAAK,CAACM,IAAI,GAAGR,cAAcS;aACvDR,WAAWQ;IAClB;AACF;AAEA,OAAO,MAAMC,uBAAuB;IAClC,OAAO,CAAC,EAAEC,IAAI,EAAqB;QACjCV,WAAWU;QACX,OAAOA;IACT;AACF,EAAE"}
@@ -0,0 +1,4 @@
1
+ import type { Payload, PayloadRequest } from "payload";
2
+ export declare const localeCodesKeyingValues: (req: PayloadRequest) => readonly string[];
3
+ export declare const localeOf: (req: PayloadRequest) => string | undefined;
4
+ export declare const isLocaleOf: (payload: Payload, locale: unknown) => locale is string | undefined;
@@ -0,0 +1,15 @@
1
+ const EVERY_LOCALE = "all";
2
+ const NO_LOCALES = [];
3
+ export const localeCodesKeyingValues = (req)=>{
4
+ if (req.locale !== EVERY_LOCALE) return NO_LOCALES;
5
+ const { localization } = req.payload.config;
6
+ return localization ? localization.localeCodes : NO_LOCALES;
7
+ };
8
+ export const localeOf = (req)=>typeof req.locale === "string" && req.locale !== EVERY_LOCALE ? req.locale : undefined;
9
+ export const isLocaleOf = (payload, locale)=>{
10
+ if (locale === undefined) return true;
11
+ const { localization } = payload.config;
12
+ return typeof locale === "string" && localization !== false && localization.localeCodes.includes(locale);
13
+ };
14
+
15
+ //# sourceMappingURL=localeCodesKeyingValues.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/server/localeCodesKeyingValues.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from \"payload\";\n\nconst EVERY_LOCALE = \"all\";\nconst NO_LOCALES: readonly string[] = [];\n\nexport const localeCodesKeyingValues = (req: PayloadRequest): readonly string[] => {\n if (req.locale !== EVERY_LOCALE) return NO_LOCALES;\n const { localization } = req.payload.config;\n return localization ? localization.localeCodes : NO_LOCALES;\n};\n\nexport const localeOf = (req: PayloadRequest): string | undefined =>\n typeof req.locale === \"string\" && req.locale !== EVERY_LOCALE ? req.locale : undefined;\n\nexport const isLocaleOf = (payload: Payload, locale: unknown): locale is string | undefined => {\n if (locale === undefined) return true;\n const { localization } = payload.config;\n return (\n typeof locale === \"string\" &&\n localization !== false &&\n localization.localeCodes.includes(locale)\n );\n};\n"],"names":["EVERY_LOCALE","NO_LOCALES","localeCodesKeyingValues","req","locale","localization","payload","config","localeCodes","localeOf","undefined","isLocaleOf","includes"],"mappings":"AAEA,MAAMA,eAAe;AACrB,MAAMC,aAAgC,EAAE;AAExC,OAAO,MAAMC,0BAA0B,CAACC;IACtC,IAAIA,IAAIC,MAAM,KAAKJ,cAAc,OAAOC;IACxC,MAAM,EAAEI,YAAY,EAAE,GAAGF,IAAIG,OAAO,CAACC,MAAM;IAC3C,OAAOF,eAAeA,aAAaG,WAAW,GAAGP;AACnD,EAAE;AAEF,OAAO,MAAMQ,WAAW,CAACN,MACvB,OAAOA,IAAIC,MAAM,KAAK,YAAYD,IAAIC,MAAM,KAAKJ,eAAeG,IAAIC,MAAM,GAAGM,UAAU;AAEzF,OAAO,MAAMC,aAAa,CAACL,SAAkBF;IAC3C,IAAIA,WAAWM,WAAW,OAAO;IACjC,MAAM,EAAEL,YAAY,EAAE,GAAGC,QAAQC,MAAM;IACvC,OACE,OAAOH,WAAW,YAClBC,iBAAiB,SACjBA,aAAaG,WAAW,CAACI,QAAQ,CAACR;AAEtC,EAAE"}
@@ -0,0 +1,12 @@
1
+ import type { ValueExcludePredicate } from "../excludeValues.js";
2
+ import type { EditableSchema } from "../shared/editableSchema/editableSchema.js";
3
+ import type { PlainObject } from "../shared/plainObject.js";
4
+ import type { VeDocument } from "../shared/protocol.js";
5
+ export type ReadOfDocument = {
6
+ identity: VeDocument;
7
+ schema: EditableSchema | null;
8
+ excludeValues?: readonly ValueExcludePredicate[];
9
+ localeCodesKeyingValues?: readonly string[];
10
+ instantPreview?: boolean;
11
+ };
12
+ export declare const markRead: <Document extends PlainObject>(document: Document, { identity, schema, excludeValues, localeCodesKeyingValues, instantPreview, }: ReadOfDocument) => Document;