@focus-reactive/payload-plugin-visual-editing 1.2.0 → 1.3.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 (232) hide show
  1. package/README.md +265 -31
  2. package/dist/admin/InstantPreviewBroadcaster.js +44 -3
  3. package/dist/admin/InstantPreviewBroadcaster.js.map +1 -1
  4. package/dist/admin/PreviewPageBridge.d.ts +1 -0
  5. package/dist/admin/PreviewPageBridge.js +50 -0
  6. package/dist/admin/PreviewPageBridge.js.map +1 -0
  7. package/dist/admin/VisualEditingBridgeProvider.js +60 -35
  8. package/dist/admin/VisualEditingBridgeProvider.js.map +1 -1
  9. package/dist/admin/expandAndFocus.d.ts +1 -0
  10. package/dist/admin/expandAndFocus.js +122 -99
  11. package/dist/admin/expandAndFocus.js.map +1 -1
  12. package/dist/admin/index.d.ts +1 -0
  13. package/dist/admin/index.js +1 -0
  14. package/dist/admin/index.js.map +1 -1
  15. package/dist/admin/instantPreview/previewGrants.d.ts +14 -0
  16. package/dist/admin/instantPreview/previewGrants.js +62 -0
  17. package/dist/admin/instantPreview/previewGrants.js.map +1 -0
  18. package/dist/admin/instantPreview/usePreviewPage.d.ts +2 -1
  19. package/dist/admin/instantPreview/usePreviewPage.js +12 -3
  20. package/dist/admin/instantPreview/usePreviewPage.js.map +1 -1
  21. package/dist/admin/openField/openForms.d.ts +7 -0
  22. package/dist/admin/openField/openForms.js +40 -0
  23. package/dist/admin/openField/openForms.js.map +1 -1
  24. package/dist/admin/previewPages.d.ts +7 -0
  25. package/dist/admin/previewPages.js +13 -0
  26. package/dist/admin/previewPages.js.map +1 -0
  27. package/dist/client/createOverlay.js +3 -0
  28. package/dist/client/createOverlay.js.map +1 -1
  29. package/dist/client/index.d.ts +6 -6
  30. package/dist/client/index.js +5 -5
  31. package/dist/client/index.js.map +1 -1
  32. package/dist/client/instantPreview/instantPreview.js +1 -1
  33. package/dist/client/instantPreview/instantPreview.js.map +1 -1
  34. package/dist/client/instantPreview/liveFields.d.ts +2 -1
  35. package/dist/client/instantPreview/liveFields.js +32 -5
  36. package/dist/client/instantPreview/liveFields.js.map +1 -1
  37. package/dist/client/instantPreview/liveRichTextOf.d.ts +3 -0
  38. package/dist/client/instantPreview/liveRichTextOf.js +3 -0
  39. package/dist/client/instantPreview/liveRichTextOf.js.map +1 -1
  40. package/dist/client/instantPreview/unsavedRender/baseValues.d.ts +12 -0
  41. package/dist/client/instantPreview/unsavedRender/baseValues.js +130 -0
  42. package/dist/client/instantPreview/unsavedRender/baseValues.js.map +1 -0
  43. package/dist/client/instantPreview/unsavedRender/liveRichText.d.ts +29 -0
  44. package/dist/client/instantPreview/unsavedRender/liveRichText.js +117 -0
  45. package/dist/client/instantPreview/unsavedRender/liveRichText.js.map +1 -0
  46. package/dist/client/instantPreview/unsavedRender/optimisticValue.d.ts +6 -0
  47. package/dist/client/instantPreview/unsavedRender/optimisticValue.js +20 -0
  48. package/dist/client/instantPreview/unsavedRender/optimisticValue.js.map +1 -0
  49. package/dist/client/instantPreview/unsavedRender/renderSources.d.ts +26 -0
  50. package/dist/client/instantPreview/unsavedRender/renderSources.js +77 -0
  51. package/dist/client/instantPreview/unsavedRender/renderSources.js.map +1 -0
  52. package/dist/client/instantPreview/unsavedRender/unsavedRender.d.ts +6 -1
  53. package/dist/client/instantPreview/unsavedRender/unsavedRender.js +116 -17
  54. package/dist/client/instantPreview/unsavedRender/unsavedRender.js.map +1 -1
  55. package/dist/client/instantPreview/unsavedRender/valueSource.d.ts +17 -0
  56. package/dist/client/instantPreview/unsavedRender/valueSource.js +38 -0
  57. package/dist/client/instantPreview/unsavedRender/valueSource.js.map +1 -0
  58. package/dist/client/overlay/constants.d.ts +1 -2
  59. package/dist/client/overlay/constants.js +1 -7
  60. package/dist/client/overlay/constants.js.map +1 -1
  61. package/dist/client/overlay/fieldTracker.d.ts +2 -0
  62. package/dist/client/overlay/fieldTracker.js +140 -42
  63. package/dist/client/overlay/fieldTracker.js.map +1 -1
  64. package/dist/client/overlay/hoverController.js +3 -3
  65. package/dist/client/overlay/hoverController.js.map +1 -1
  66. package/dist/client/overlay/markerCleaner.d.ts +5 -0
  67. package/dist/client/overlay/markerCleaner.js +94 -0
  68. package/dist/client/overlay/markerCleaner.js.map +1 -0
  69. package/dist/client/overlay/markerExtractor.js +1 -1
  70. package/dist/client/overlay/markerExtractor.js.map +1 -1
  71. package/dist/client/overlay/mutationPipeline.d.ts +3 -0
  72. package/dist/client/overlay/mutationPipeline.js +15 -9
  73. package/dist/client/overlay/mutationPipeline.js.map +1 -1
  74. package/dist/client/overlay/pageNodes.d.ts +3 -0
  75. package/dist/client/overlay/pageNodes.js +34 -0
  76. package/dist/client/overlay/pageNodes.js.map +1 -0
  77. package/dist/client/overlayClickHandler.js +3 -2
  78. package/dist/client/overlayClickHandler.js.map +1 -1
  79. package/dist/client/overlayScope.d.ts +14 -0
  80. package/dist/client/overlayScope.js +23 -0
  81. package/dist/client/overlayScope.js.map +1 -0
  82. package/dist/client/previewGrant.d.ts +5 -0
  83. package/dist/client/previewGrant.js +34 -0
  84. package/dist/client/previewGrant.js.map +1 -0
  85. package/dist/client/react/LiveRichText.d.ts +17 -0
  86. package/dist/client/react/LiveRichText.js +32 -0
  87. package/dist/client/react/LiveRichText.js.map +1 -0
  88. package/dist/client/react/UnsavedRenderBoundary.js.map +1 -0
  89. package/dist/client/react/VisualEditingOverlay.js +60 -0
  90. package/dist/client/react/VisualEditingOverlay.js.map +1 -0
  91. package/dist/client/react/VisualEditingProvider.d.ts +21 -0
  92. package/dist/client/react/VisualEditingProvider.js +83 -0
  93. package/dist/client/react/VisualEditingProvider.js.map +1 -0
  94. package/dist/client/react/VisualEditingToggle.d.ts +1 -0
  95. package/dist/client/react/VisualEditingToggle.js +32 -0
  96. package/dist/client/react/VisualEditingToggle.js.map +1 -0
  97. package/dist/client/react/overlayContext.d.ts +2 -0
  98. package/dist/client/react/overlayContext.js +4 -0
  99. package/dist/client/react/overlayContext.js.map +1 -0
  100. package/dist/client/react/useIsomorphicLayoutEffect.js.map +1 -0
  101. package/dist/client/react/useUnsavedRender.d.ts +16 -0
  102. package/dist/client/react/useUnsavedRender.js +89 -0
  103. package/dist/client/react/useUnsavedRender.js.map +1 -0
  104. package/dist/client/saveEvents.d.ts +3 -0
  105. package/dist/client/saveEvents.js +27 -0
  106. package/dist/client/saveEvents.js.map +1 -0
  107. package/dist/client/session.d.ts +40 -0
  108. package/dist/client/session.js +100 -0
  109. package/dist/client/session.js.map +1 -0
  110. package/dist/client/sessionOverlay.d.ts +9 -0
  111. package/dist/client/sessionOverlay.js +74 -0
  112. package/dist/client/sessionOverlay.js.map +1 -0
  113. package/dist/client/toggle.d.ts +7 -0
  114. package/dist/client/toggle.js +158 -0
  115. package/dist/client/toggle.js.map +1 -0
  116. package/dist/client/withVisualEditingPath.d.ts +2 -0
  117. package/dist/client/withVisualEditingPath.js +5 -6
  118. package/dist/client/withVisualEditingPath.js.map +1 -1
  119. package/dist/dom/index.d.ts +6 -0
  120. package/dist/dom/index.js +7 -0
  121. package/dist/dom/index.js.map +1 -0
  122. package/dist/dom/liveRichTextElements.d.ts +8 -0
  123. package/dist/dom/liveRichTextElements.js +69 -0
  124. package/dist/dom/liveRichTextElements.js.map +1 -0
  125. package/dist/dom/mountVisualEditing.d.ts +16 -0
  126. package/dist/dom/mountVisualEditing.js +52 -0
  127. package/dist/dom/mountVisualEditing.js.map +1 -0
  128. package/dist/excludeValues.d.ts +0 -4
  129. package/dist/excludeValues.js +4 -4
  130. package/dist/excludeValues.js.map +1 -1
  131. package/dist/index.d.ts +4 -0
  132. package/dist/index.js +13 -4
  133. package/dist/index.js.map +1 -1
  134. package/dist/readUnsavedRichText.d.ts +16 -2
  135. package/dist/readUnsavedRichText.js +26 -7
  136. package/dist/readUnsavedRichText.js.map +1 -1
  137. package/dist/server/endpoints.d.ts +16 -0
  138. package/dist/server/endpoints.js +136 -0
  139. package/dist/server/endpoints.js.map +1 -0
  140. package/dist/server/markRead.js +3 -3
  141. package/dist/server/markRead.js.map +1 -1
  142. package/dist/server/markedReads.d.ts +1 -1
  143. package/dist/server/markedReads.js +4 -2
  144. package/dist/server/markedReads.js.map +1 -1
  145. package/dist/server/previewGrant.d.ts +9 -0
  146. package/dist/server/previewGrant.js +31 -0
  147. package/dist/server/previewGrant.js.map +1 -0
  148. package/dist/server/unsavedRichText/hooks.js +24 -9
  149. package/dist/server/unsavedRichText/hooks.js.map +1 -1
  150. package/dist/server/unsavedRichText/placeUnsavedState.js +1 -1
  151. package/dist/server/unsavedRichText/placeUnsavedState.js.map +1 -1
  152. package/dist/server/unsavedRichText/postedEditorState.js +3 -31
  153. package/dist/server/unsavedRichText/postedEditorState.js.map +1 -1
  154. package/dist/server/unsavedRichText/postedRequest.d.ts +2 -1
  155. package/dist/server/unsavedRichText/postedRequest.js +14 -4
  156. package/dist/server/unsavedRichText/postedRequest.js.map +1 -1
  157. package/dist/server/unsavedRichText/readAsUser.d.ts +7 -2
  158. package/dist/server/unsavedRichText/readAsUser.js +47 -16
  159. package/dist/server/unsavedRichText/readAsUser.js.map +1 -1
  160. package/dist/server/unsavedRichText/readContext.d.ts +6 -0
  161. package/dist/server/unsavedRichText/readContext.js +5 -0
  162. package/dist/server/unsavedRichText/readContext.js.map +1 -1
  163. package/dist/server/unsavedRichText/savedReferences.d.ts +5 -0
  164. package/dist/server/unsavedRichText/savedReferences.js +61 -0
  165. package/dist/server/unsavedRichText/savedReferences.js.map +1 -0
  166. package/dist/server/withDocumentControls.d.ts +10 -0
  167. package/dist/server/{withInstantPreview.js → withDocumentControls.js} +17 -7
  168. package/dist/server/withDocumentControls.js.map +1 -0
  169. package/dist/shared/buildAdminEditUrl.d.ts +1 -0
  170. package/dist/shared/buildAdminEditUrl.js +5 -1
  171. package/dist/shared/buildAdminEditUrl.js.map +1 -1
  172. package/dist/shared/protocol.d.ts +18 -0
  173. package/dist/shared/protocol.js +6 -0
  174. package/dist/shared/protocol.js.map +1 -1
  175. package/dist/shared/richText/editorStateTree.d.ts +2 -0
  176. package/dist/shared/richText/editorStateTree.js +34 -0
  177. package/dist/shared/richText/editorStateTree.js.map +1 -0
  178. package/dist/{server → shared}/richText/markTextLeaves.js +5 -5
  179. package/dist/shared/richText/markTextLeaves.js.map +1 -0
  180. package/dist/shared/richText/nodeKey.d.ts +3 -2
  181. package/dist/shared/richText/nodeKey.js +15 -6
  182. package/dist/shared/richText/nodeKey.js.map +1 -1
  183. package/dist/shared/richText/references.d.ts +16 -0
  184. package/dist/shared/richText/references.js +85 -0
  185. package/dist/shared/richText/references.js.map +1 -0
  186. package/dist/{server/unsavedRichText → shared/richText}/relatedIds.d.ts +1 -1
  187. package/dist/{server/unsavedRichText → shared/richText}/relatedIds.js +4 -4
  188. package/dist/shared/richText/relatedIds.js.map +1 -0
  189. package/dist/shared/richText/savedNodeFields.d.ts +3 -0
  190. package/dist/{server/unsavedRichText → shared/richText}/savedNodeFields.js +4 -4
  191. package/dist/shared/richText/savedNodeFields.js.map +1 -0
  192. package/dist/shared/shared.d.ts +14 -3
  193. package/dist/shared/shared.js +46 -1
  194. package/dist/shared/shared.js.map +1 -1
  195. package/dist/shared/stegaText.d.ts +2 -1
  196. package/dist/shared/stegaText.js +3 -1
  197. package/dist/shared/stegaText.js.map +1 -1
  198. package/package.json +26 -4
  199. package/dist/client/VisualEditingOverlay.js +0 -39
  200. package/dist/client/VisualEditingOverlay.js.map +0 -1
  201. package/dist/client/VisualEditingProvider.d.ts +0 -25
  202. package/dist/client/VisualEditingProvider.js +0 -68
  203. package/dist/client/VisualEditingProvider.js.map +0 -1
  204. package/dist/client/VisualEditingToggle.d.ts +0 -1
  205. package/dist/client/VisualEditingToggle.js +0 -153
  206. package/dist/client/VisualEditingToggle.js.map +0 -1
  207. package/dist/client/instantPreview/LiveRichText.d.ts +0 -16
  208. package/dist/client/instantPreview/LiveRichText.js +0 -18
  209. package/dist/client/instantPreview/LiveRichText.js.map +0 -1
  210. package/dist/client/instantPreview/unsavedRender/UnsavedRenderBoundary.js.map +0 -1
  211. package/dist/client/instantPreview/unsavedRender/useUnsavedRender.d.ts +0 -10
  212. package/dist/client/instantPreview/unsavedRender/useUnsavedRender.js +0 -118
  213. package/dist/client/instantPreview/unsavedRender/useUnsavedRender.js.map +0 -1
  214. package/dist/client/overlayContext.d.ts +0 -3
  215. package/dist/client/overlayContext.js +0 -5
  216. package/dist/client/overlayContext.js.map +0 -1
  217. package/dist/client/useIsomorphicLayoutEffect.js.map +0 -1
  218. package/dist/client/useVisualEditingOverlay.d.ts +0 -4
  219. package/dist/client/useVisualEditingOverlay.js +0 -33
  220. package/dist/client/useVisualEditingOverlay.js.map +0 -1
  221. package/dist/server/richText/markTextLeaves.js.map +0 -1
  222. package/dist/server/unsavedRichText/relatedIds.js.map +0 -1
  223. package/dist/server/unsavedRichText/savedNodeFields.d.ts +0 -2
  224. package/dist/server/unsavedRichText/savedNodeFields.js.map +0 -1
  225. package/dist/server/withInstantPreview.d.ts +0 -9
  226. package/dist/server/withInstantPreview.js.map +0 -1
  227. /package/dist/client/{instantPreview/unsavedRender → react}/UnsavedRenderBoundary.d.ts +0 -0
  228. /package/dist/client/{instantPreview/unsavedRender → react}/UnsavedRenderBoundary.js +0 -0
  229. /package/dist/client/{VisualEditingOverlay.d.ts → react/VisualEditingOverlay.d.ts} +0 -0
  230. /package/dist/client/{useIsomorphicLayoutEffect.d.ts → react/useIsomorphicLayoutEffect.d.ts} +0 -0
  231. /package/dist/client/{useIsomorphicLayoutEffect.js → react/useIsomorphicLayoutEffect.js} +0 -0
  232. /package/dist/{server → shared}/richText/markTextLeaves.d.ts +0 -0
@@ -0,0 +1,6 @@
1
+ export { mountVisualEditing, type MountVisualEditingOptions, type VisualEditing, } from "./mountVisualEditing.js";
2
+ export { type RenderRichTextHtml, type RenderRichTextValue, richTextAttributes, } from "./liveRichTextElements.js";
3
+ export { withVisualEditingPath } from "../client/withVisualEditingPath.js";
4
+ export { stripMarkers } from "../stripMarkers.js";
5
+ export { type BuildAdminEditUrl, type BuildAdminEditUrlArgs, defaultBuildAdminEditUrl, } from "../shared/buildAdminEditUrl.js";
6
+ export type { LiveRichTextRequest } from "../shared/protocol.js";
@@ -0,0 +1,7 @@
1
+ export { mountVisualEditing } from "./mountVisualEditing.js";
2
+ export { richTextAttributes } from "./liveRichTextElements.js";
3
+ export { withVisualEditingPath } from "../client/withVisualEditingPath.js";
4
+ export { stripMarkers } from "../stripMarkers.js";
5
+ export { defaultBuildAdminEditUrl } from "../shared/buildAdminEditUrl.js";
6
+
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/dom/index.ts"],"sourcesContent":["export {\n mountVisualEditing,\n type MountVisualEditingOptions,\n type VisualEditing,\n} from \"./mountVisualEditing.js\";\nexport {\n type RenderRichTextHtml,\n type RenderRichTextValue,\n richTextAttributes,\n} from \"./liveRichTextElements.js\";\nexport { withVisualEditingPath } from \"../client/withVisualEditingPath.js\";\nexport { stripMarkers } from \"../stripMarkers.js\";\nexport {\n type BuildAdminEditUrl,\n type BuildAdminEditUrlArgs,\n defaultBuildAdminEditUrl,\n} from \"../shared/buildAdminEditUrl.js\";\nexport type { LiveRichTextRequest } from \"../shared/protocol.js\";\n"],"names":["mountVisualEditing","richTextAttributes","withVisualEditingPath","stripMarkers","defaultBuildAdminEditUrl"],"mappings":"AAAA,SACEA,kBAAkB,QAGb,0BAA0B;AACjC,SAGEC,kBAAkB,QACb,4BAA4B;AACnC,SAASC,qBAAqB,QAAQ,qCAAqC;AAC3E,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SAGEC,wBAAwB,QACnB,iCAAiC"}
@@ -0,0 +1,8 @@
1
+ import type { RenderUnsavedRichText } from "../client/instantPreview/unsavedRender/liveRichText.js";
2
+ import type { RenderSources, RichTextRenders } from "../client/instantPreview/unsavedRender/renderSources.js";
3
+ import type { OverlayScope } from "../client/overlayScope.js";
4
+ export declare const DATA_VE_LIVE_RICH_TEXT_ATTR = "data-ve-live-rich-text";
5
+ export type RenderRichTextHtml = RenderUnsavedRichText<string>;
6
+ export type RenderRichTextValue = (value: unknown, signal: AbortSignal) => string | null | Promise<string | null>;
7
+ export declare const richTextAttributes: (value: unknown) => Record<string, string>;
8
+ export declare function startLiveRichTextElements(root: HTMLElement, scope: OverlayScope, adminOrigin: () => string, sources: RenderSources, renders: RichTextRenders<string>): () => void;
@@ -0,0 +1,69 @@
1
+ import { liveRichTextOf } from "../client/instantPreview/liveRichTextOf.js";
2
+ import { startLiveRichText } from "../client/overlayScope.js";
3
+ import { withVisualEditingPath } from "../client/withVisualEditingPath.js";
4
+ import { isPlainObject } from "../shared/plainObject.js";
5
+ export const DATA_VE_LIVE_RICH_TEXT_ATTR = "data-ve-live-rich-text";
6
+ const stopNothing = ()=>undefined;
7
+ const identityOf = (element)=>{
8
+ try {
9
+ const identity = JSON.parse(element.getAttribute(DATA_VE_LIVE_RICH_TEXT_ATTR) ?? "");
10
+ const isIdentity = isPlainObject(identity) && isPlainObject(identity.field) && typeof identity.shape === "string";
11
+ return isIdentity ? identity : null;
12
+ } catch {
13
+ return null;
14
+ }
15
+ };
16
+ export const richTextAttributes = (value)=>{
17
+ const identity = liveRichTextOf(value);
18
+ return {
19
+ ...withVisualEditingPath(value),
20
+ ...identity && {
21
+ [DATA_VE_LIVE_RICH_TEXT_ATTR]: JSON.stringify(identity)
22
+ }
23
+ };
24
+ };
25
+ const startElement = (element, identity, scope, adminOrigin, sources, renders)=>{
26
+ const saved = {
27
+ node: element.innerHTML,
28
+ shape: identity.shape
29
+ };
30
+ let live = null;
31
+ const local = sources.onThePage(identity, renders, ()=>live?.renderOnThePageAgain());
32
+ let inserted = saved.node;
33
+ const started = startLiveRichText(scope, {
34
+ adminOrigin,
35
+ field: identity.field,
36
+ onChange: (snapshot)=>{
37
+ const shown = started.shownFor(snapshot, saved);
38
+ if (shown.node !== inserted) {
39
+ inserted = shown.node;
40
+ element.innerHTML = shown.node;
41
+ }
42
+ shown.commit();
43
+ },
44
+ optimistic: local?.optimistic,
45
+ render: (request, signal)=>sources.render(renders, request, signal),
46
+ savedShape: identity.shape
47
+ });
48
+ live = started;
49
+ return ()=>{
50
+ started.stop();
51
+ local?.stop();
52
+ };
53
+ };
54
+ export function startLiveRichTextElements(root, scope, adminOrigin, sources, renders) {
55
+ if (!sources.canShow(renders)) return stopNothing;
56
+ const stops = [
57
+ ...root.querySelectorAll(`[${DATA_VE_LIVE_RICH_TEXT_ATTR}]`)
58
+ ].flatMap((element)=>{
59
+ const identity = identityOf(element);
60
+ return identity ? [
61
+ startElement(element, identity, scope, adminOrigin, sources, renders)
62
+ ] : [];
63
+ });
64
+ return ()=>{
65
+ for (const stop of stops)stop();
66
+ };
67
+ }
68
+
69
+ //# sourceMappingURL=liveRichTextElements.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/dom/liveRichTextElements.ts"],"sourcesContent":["import type { LiveRichTextIdentity } from \"../client/instantPreview/liveRichTextOf.js\";\nimport type {\n LiveRichText,\n RenderUnsavedRichText,\n} from \"../client/instantPreview/unsavedRender/liveRichText.js\";\nimport type {\n RenderSources,\n RichTextRenders,\n} from \"../client/instantPreview/unsavedRender/renderSources.js\";\nimport type { OverlayScope } from \"../client/overlayScope.js\";\n\nimport { liveRichTextOf } from \"../client/instantPreview/liveRichTextOf.js\";\nimport { startLiveRichText } from \"../client/overlayScope.js\";\nimport { withVisualEditingPath } from \"../client/withVisualEditingPath.js\";\nimport { isPlainObject } from \"../shared/plainObject.js\";\n\nexport const DATA_VE_LIVE_RICH_TEXT_ATTR = \"data-ve-live-rich-text\";\n\nexport type RenderRichTextHtml = RenderUnsavedRichText<string>;\n\nexport type RenderRichTextValue = (\n value: unknown,\n signal: AbortSignal\n) => string | null | Promise<string | null>;\n\nconst stopNothing = (): void => undefined;\n\nconst identityOf = (element: Element): LiveRichTextIdentity | null => {\n try {\n const identity: unknown = JSON.parse(element.getAttribute(DATA_VE_LIVE_RICH_TEXT_ATTR) ?? \"\");\n const isIdentity =\n isPlainObject(identity) &&\n isPlainObject(identity.field) &&\n typeof identity.shape === \"string\";\n return isIdentity ? (identity as LiveRichTextIdentity) : null;\n } catch {\n return null;\n }\n};\n\nexport const richTextAttributes = (value: unknown): Record<string, string> => {\n const identity = liveRichTextOf(value);\n return {\n ...withVisualEditingPath(value),\n ...(identity && { [DATA_VE_LIVE_RICH_TEXT_ATTR]: JSON.stringify(identity) }),\n };\n};\n\nconst startElement = (\n element: Element,\n identity: LiveRichTextIdentity,\n scope: OverlayScope,\n adminOrigin: () => string,\n sources: RenderSources,\n renders: RichTextRenders<string>\n): (() => void) => {\n const saved = { node: element.innerHTML, shape: identity.shape };\n let live: LiveRichText<string> | null = null;\n const local = sources.onThePage(identity, renders, () => live?.renderOnThePageAgain());\n let inserted = saved.node;\n const started = startLiveRichText<string>(scope, {\n adminOrigin,\n field: identity.field,\n onChange: (snapshot) => {\n const shown = started.shownFor(snapshot, saved);\n if (shown.node !== inserted) {\n inserted = shown.node;\n element.innerHTML = shown.node;\n }\n shown.commit();\n },\n optimistic: local?.optimistic,\n render: (request, signal) => sources.render(renders, request, signal),\n savedShape: identity.shape,\n });\n live = started;\n return () => {\n started.stop();\n local?.stop();\n };\n};\n\nexport function startLiveRichTextElements(\n root: HTMLElement,\n scope: OverlayScope,\n adminOrigin: () => string,\n sources: RenderSources,\n renders: RichTextRenders<string>\n): () => void {\n if (!sources.canShow(renders)) return stopNothing;\n const stops = [...root.querySelectorAll(`[${DATA_VE_LIVE_RICH_TEXT_ATTR}]`)].flatMap(\n (element) => {\n const identity = identityOf(element);\n return identity\n ? [startElement(element, identity, scope, adminOrigin, sources, renders)]\n : [];\n }\n );\n return () => {\n for (const stop of stops) stop();\n };\n}\n"],"names":["liveRichTextOf","startLiveRichText","withVisualEditingPath","isPlainObject","DATA_VE_LIVE_RICH_TEXT_ATTR","stopNothing","undefined","identityOf","element","identity","JSON","parse","getAttribute","isIdentity","field","shape","richTextAttributes","value","stringify","startElement","scope","adminOrigin","sources","renders","saved","node","innerHTML","live","local","onThePage","renderOnThePageAgain","inserted","started","onChange","snapshot","shown","shownFor","commit","optimistic","render","request","signal","savedShape","stop","startLiveRichTextElements","root","canShow","stops","querySelectorAll","flatMap"],"mappings":"AAWA,SAASA,cAAc,QAAQ,6CAA6C;AAC5E,SAASC,iBAAiB,QAAQ,4BAA4B;AAC9D,SAASC,qBAAqB,QAAQ,qCAAqC;AAC3E,SAASC,aAAa,QAAQ,2BAA2B;AAEzD,OAAO,MAAMC,8BAA8B,yBAAyB;AASpE,MAAMC,cAAc,IAAYC;AAEhC,MAAMC,aAAa,CAACC;IAClB,IAAI;QACF,MAAMC,WAAoBC,KAAKC,KAAK,CAACH,QAAQI,YAAY,CAACR,gCAAgC;QAC1F,MAAMS,aACJV,cAAcM,aACdN,cAAcM,SAASK,KAAK,KAC5B,OAAOL,SAASM,KAAK,KAAK;QAC5B,OAAOF,aAAcJ,WAAoC;IAC3D,EAAE,OAAM;QACN,OAAO;IACT;AACF;AAEA,OAAO,MAAMO,qBAAqB,CAACC;IACjC,MAAMR,WAAWT,eAAeiB;IAChC,OAAO;QACL,GAAGf,sBAAsBe,MAAM;QAC/B,GAAIR,YAAY;YAAE,CAACL,4BAA4B,EAAEM,KAAKQ,SAAS,CAACT;QAAU,CAAC;IAC7E;AACF,EAAE;AAEF,MAAMU,eAAe,CACnBX,SACAC,UACAW,OACAC,aACAC,SACAC;IAEA,MAAMC,QAAQ;QAAEC,MAAMjB,QAAQkB,SAAS;QAAEX,OAAON,SAASM,KAAK;IAAC;IAC/D,IAAIY,OAAoC;IACxC,MAAMC,QAAQN,QAAQO,SAAS,CAACpB,UAAUc,SAAS,IAAMI,MAAMG;IAC/D,IAAIC,WAAWP,MAAMC,IAAI;IACzB,MAAMO,UAAU/B,kBAA0BmB,OAAO;QAC/CC;QACAP,OAAOL,SAASK,KAAK;QACrBmB,UAAU,CAACC;YACT,MAAMC,QAAQH,QAAQI,QAAQ,CAACF,UAAUV;YACzC,IAAIW,MAAMV,IAAI,KAAKM,UAAU;gBAC3BA,WAAWI,MAAMV,IAAI;gBACrBjB,QAAQkB,SAAS,GAAGS,MAAMV,IAAI;YAChC;YACAU,MAAME,MAAM;QACd;QACAC,YAAYV,OAAOU;QACnBC,QAAQ,CAACC,SAASC,SAAWnB,QAAQiB,MAAM,CAAChB,SAASiB,SAASC;QAC9DC,YAAYjC,SAASM,KAAK;IAC5B;IACAY,OAAOK;IACP,OAAO;QACLA,QAAQW,IAAI;QACZf,OAAOe;IACT;AACF;AAEA,OAAO,SAASC,0BACdC,IAAiB,EACjBzB,KAAmB,EACnBC,WAAyB,EACzBC,OAAsB,EACtBC,OAAgC;IAEhC,IAAI,CAACD,QAAQwB,OAAO,CAACvB,UAAU,OAAOlB;IACtC,MAAM0C,QAAQ;WAAIF,KAAKG,gBAAgB,CAAC,CAAC,CAAC,EAAE5C,4BAA4B,CAAC,CAAC;KAAE,CAAC6C,OAAO,CAClF,CAACzC;QACC,MAAMC,WAAWF,WAAWC;QAC5B,OAAOC,WACH;YAACU,aAAaX,SAASC,UAAUW,OAAOC,aAAaC,SAASC;SAAS,GACvE,EAAE;IACR;IAEF,OAAO;QACL,KAAK,MAAMoB,QAAQI,MAAOJ;IAC5B;AACF"}
@@ -0,0 +1,16 @@
1
+ import type { SessionOptions } from "../client/session.js";
2
+ import type { RenderRichTextHtml, RenderRichTextValue } from "./liveRichTextElements.js";
3
+ export type MountVisualEditingOptions = SessionOptions & {
4
+ root?: HTMLElement;
5
+ locale?: string;
6
+ toggle?: boolean;
7
+ renderRichText?: RenderRichTextHtml;
8
+ payloadApi?: string;
9
+ renderRichTextValue?: RenderRichTextValue;
10
+ optimistic?: boolean;
11
+ onSave?: () => void;
12
+ };
13
+ export interface VisualEditing {
14
+ destroy(): void;
15
+ }
16
+ export declare function mountVisualEditing({ root, locale, toggle: showsToggle, renderRichText, payloadApi: namedPayloadApi, renderRichTextValue, optimistic, onSave, ...sessionOptions }?: MountVisualEditingOptions): VisualEditing;
@@ -0,0 +1,52 @@
1
+ import { listenToRenderSources } from "../client/instantPreview/unsavedRender/renderSources.js";
2
+ import { savedShapesWithin } from "../client/overlayScope.js";
3
+ import { listenToSaves } from "../client/saveEvents.js";
4
+ import { createPageStore, payloadApiOf, sessionOf } from "../client/session.js";
5
+ import { startSessionOverlay, startSessionToggle } from "../client/sessionOverlay.js";
6
+ import { startLiveRichTextElements } from "./liveRichTextElements.js";
7
+ export function mountVisualEditing({ root = document.body, locale, toggle: showsToggle = true, renderRichText, payloadApi: namedPayloadApi, renderRichTextValue, optimistic = true, onSave, ...sessionOptions } = {}) {
8
+ const payloadApi = payloadApiOf({
9
+ adminOrigin: sessionOptions.adminOrigin,
10
+ payloadApi: namedPayloadApi
11
+ });
12
+ const pageStore = createPageStore();
13
+ pageStore.attach(window);
14
+ const session = ()=>sessionOf({
15
+ available: true,
16
+ ...sessionOptions
17
+ }, pageStore.read());
18
+ const adminOrigin = ()=>session().adminOrigin;
19
+ const scope = {
20
+ locale,
21
+ savedShapes: savedShapesWithin(null)
22
+ };
23
+ const renderSources = session().isInstantPreviewOn ? listenToRenderSources({
24
+ adminOrigin,
25
+ payloadApi,
26
+ rendersOnThePage: optimistic
27
+ }) : null;
28
+ const stopLiveRichTexts = renderSources && startLiveRichTextElements(root, scope, adminOrigin, renderSources, {
29
+ render: renderRichText ?? renderSources.htmlOfPayload,
30
+ renderValue: renderRichTextValue
31
+ });
32
+ const overlay = startSessionOverlay(root, ()=>scope, session);
33
+ const toggle = showsToggle ? startSessionToggle(document, session, pageStore.setMode) : null;
34
+ const followSession = ()=>{
35
+ overlay.sync();
36
+ toggle?.sync();
37
+ };
38
+ const stopFollowing = pageStore.subscribe(followSession);
39
+ const stopListeningToSaves = onSave && session().available ? listenToSaves(adminOrigin, ()=>onSave()) : null;
40
+ return {
41
+ destroy () {
42
+ stopFollowing();
43
+ stopListeningToSaves?.();
44
+ stopLiveRichTexts?.();
45
+ renderSources?.stop();
46
+ overlay.dispose();
47
+ toggle?.dispose();
48
+ }
49
+ };
50
+ }
51
+
52
+ //# sourceMappingURL=mountVisualEditing.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/dom/mountVisualEditing.ts"],"sourcesContent":["import type { OverlayScope } from \"../client/overlayScope.js\";\nimport type { SessionOptions } from \"../client/session.js\";\nimport type { RenderRichTextHtml, RenderRichTextValue } from \"./liveRichTextElements.js\";\n\nimport { listenToRenderSources } from \"../client/instantPreview/unsavedRender/renderSources.js\";\nimport { savedShapesWithin } from \"../client/overlayScope.js\";\nimport { listenToSaves } from \"../client/saveEvents.js\";\nimport { createPageStore, payloadApiOf, sessionOf } from \"../client/session.js\";\nimport { startSessionOverlay, startSessionToggle } from \"../client/sessionOverlay.js\";\nimport { startLiveRichTextElements } from \"./liveRichTextElements.js\";\n\nexport type MountVisualEditingOptions = SessionOptions & {\n root?: HTMLElement;\n locale?: string;\n toggle?: boolean;\n renderRichText?: RenderRichTextHtml;\n payloadApi?: string;\n renderRichTextValue?: RenderRichTextValue;\n optimistic?: boolean;\n onSave?: () => void;\n};\n\nexport interface VisualEditing {\n destroy(): void;\n}\n\nexport function mountVisualEditing({\n root = document.body,\n locale,\n toggle: showsToggle = true,\n renderRichText,\n payloadApi: namedPayloadApi,\n renderRichTextValue,\n optimistic = true,\n onSave,\n ...sessionOptions\n}: MountVisualEditingOptions = {}): VisualEditing {\n const payloadApi = payloadApiOf({\n adminOrigin: sessionOptions.adminOrigin,\n payloadApi: namedPayloadApi,\n });\n const pageStore = createPageStore();\n pageStore.attach(window);\n const session = () => sessionOf({ available: true, ...sessionOptions }, pageStore.read());\n const adminOrigin = () => session().adminOrigin;\n const scope: OverlayScope = { locale, savedShapes: savedShapesWithin(null) };\n\n const renderSources = session().isInstantPreviewOn\n ? listenToRenderSources({ adminOrigin, payloadApi, rendersOnThePage: optimistic })\n : null;\n const stopLiveRichTexts =\n renderSources &&\n startLiveRichTextElements(root, scope, adminOrigin, renderSources, {\n render: renderRichText ?? renderSources.htmlOfPayload,\n renderValue: renderRichTextValue,\n });\n\n const overlay = startSessionOverlay(root, () => scope, session);\n const toggle = showsToggle ? startSessionToggle(document, session, pageStore.setMode) : null;\n const followSession = () => {\n overlay.sync();\n toggle?.sync();\n };\n\n const stopFollowing = pageStore.subscribe(followSession);\n const stopListeningToSaves =\n onSave && session().available ? listenToSaves(adminOrigin, () => onSave()) : null;\n\n return {\n destroy() {\n stopFollowing();\n stopListeningToSaves?.();\n stopLiveRichTexts?.();\n renderSources?.stop();\n overlay.dispose();\n toggle?.dispose();\n },\n };\n}\n"],"names":["listenToRenderSources","savedShapesWithin","listenToSaves","createPageStore","payloadApiOf","sessionOf","startSessionOverlay","startSessionToggle","startLiveRichTextElements","mountVisualEditing","root","document","body","locale","toggle","showsToggle","renderRichText","payloadApi","namedPayloadApi","renderRichTextValue","optimistic","onSave","sessionOptions","adminOrigin","pageStore","attach","window","session","available","read","scope","savedShapes","renderSources","isInstantPreviewOn","rendersOnThePage","stopLiveRichTexts","render","htmlOfPayload","renderValue","overlay","setMode","followSession","sync","stopFollowing","subscribe","stopListeningToSaves","destroy","stop","dispose"],"mappings":"AAIA,SAASA,qBAAqB,QAAQ,0DAA0D;AAChG,SAASC,iBAAiB,QAAQ,4BAA4B;AAC9D,SAASC,aAAa,QAAQ,0BAA0B;AACxD,SAASC,eAAe,EAAEC,YAAY,EAAEC,SAAS,QAAQ,uBAAuB;AAChF,SAASC,mBAAmB,EAAEC,kBAAkB,QAAQ,8BAA8B;AACtF,SAASC,yBAAyB,QAAQ,4BAA4B;AAiBtE,OAAO,SAASC,mBAAmB,EACjCC,OAAOC,SAASC,IAAI,EACpBC,MAAM,EACNC,QAAQC,cAAc,IAAI,EAC1BC,cAAc,EACdC,YAAYC,eAAe,EAC3BC,mBAAmB,EACnBC,aAAa,IAAI,EACjBC,MAAM,EACN,GAAGC,gBACuB,GAAG,CAAC,CAAC;IAC/B,MAAML,aAAab,aAAa;QAC9BmB,aAAaD,eAAeC,WAAW;QACvCN,YAAYC;IACd;IACA,MAAMM,YAAYrB;IAClBqB,UAAUC,MAAM,CAACC;IACjB,MAAMC,UAAU,IAAMtB,UAAU;YAAEuB,WAAW;YAAM,GAAGN,cAAc;QAAC,GAAGE,UAAUK,IAAI;IACtF,MAAMN,cAAc,IAAMI,UAAUJ,WAAW;IAC/C,MAAMO,QAAsB;QAAEjB;QAAQkB,aAAa9B,kBAAkB;IAAM;IAE3E,MAAM+B,gBAAgBL,UAAUM,kBAAkB,GAC9CjC,sBAAsB;QAAEuB;QAAaN;QAAYiB,kBAAkBd;IAAW,KAC9E;IACJ,MAAMe,oBACJH,iBACAxB,0BAA0BE,MAAMoB,OAAOP,aAAaS,eAAe;QACjEI,QAAQpB,kBAAkBgB,cAAcK,aAAa;QACrDC,aAAanB;IACf;IAEF,MAAMoB,UAAUjC,oBAAoBI,MAAM,IAAMoB,OAAOH;IACvD,MAAMb,SAASC,cAAcR,mBAAmBI,UAAUgB,SAASH,UAAUgB,OAAO,IAAI;IACxF,MAAMC,gBAAgB;QACpBF,QAAQG,IAAI;QACZ5B,QAAQ4B;IACV;IAEA,MAAMC,gBAAgBnB,UAAUoB,SAAS,CAACH;IAC1C,MAAMI,uBACJxB,UAAUM,UAAUC,SAAS,GAAG1B,cAAcqB,aAAa,IAAMF,YAAY;IAE/E,OAAO;QACLyB;YACEH;YACAE;YACAV;YACAH,eAAee;YACfR,QAAQS,OAAO;YACflC,QAAQkC;QACV;IACF;AACF"}
@@ -1,10 +1,6 @@
1
1
  export type ValueExcludePredicate = (value: string) => boolean;
2
- /** Absolute (`https:`, `mailto:`, `data:`), protocol-relative (`//cdn`) or root-relative (`/path`) URLs: a marker in an `href` breaks the link. */
3
2
  export declare const isUrl: ValueExcludePredicate;
4
- /** Lowercase words joined by hyphens (`hello-world`). A single word (`hello`) stays editable. */
5
3
  export declare const isSlug: ValueExcludePredicate;
6
- /** Fragment URLs (`#`, `#demo`). A hash followed by digits only (`#1`) is ranking text and stays editable. */
7
4
  export declare const isHash: ValueExcludePredicate;
8
- /** ISO 8601 dates and timestamps (`2024-01-31`, `2024-01-31T10:00:00Z`), not `YYYY` or `YYYY-MM`. */
9
5
  export declare const isIsoDate: ValueExcludePredicate;
10
6
  export declare const defaultExcludeValues: readonly ValueExcludePredicate[];
@@ -1,7 +1,7 @@
1
- /** Absolute (`https:`, `mailto:`, `data:`), protocol-relative (`//cdn`) or root-relative (`/path`) URLs: a marker in an `href` breaks the link. */ export const isUrl = (value)=>/^(?:[a-z][a-z0-9+.-]*:|\/\/|\/)/i.test(value);
2
- /** Lowercase words joined by hyphens (`hello-world`). A single word (`hello`) stays editable. */ export const isSlug = (value)=>/^[a-z0-9]+(-[a-z0-9]+)+$/.test(value);
3
- /** Fragment URLs (`#`, `#demo`). A hash followed by digits only (`#1`) is ranking text and stays editable. */ export const isHash = (value)=>/^#(?!\d+$)/.test(value);
4
- /** ISO 8601 dates and timestamps (`2024-01-31`, `2024-01-31T10:00:00Z`), not `YYYY` or `YYYY-MM`. */ export const isIsoDate = (value)=>/^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:?\d{2})?)?$/.test(value);
1
+ export const isUrl = (value)=>/^(?:[a-z][a-z0-9+.-]*:|\/\/|\/)/i.test(value);
2
+ export const isSlug = (value)=>/^(?=.*[a-z])[a-z0-9]+(-[a-z0-9]+)+$/.test(value);
3
+ export const isHash = (value)=>/^#(?!\d+$)\S*$/.test(value);
4
+ export const isIsoDate = (value)=>/^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:?\d{2})?)?$/.test(value);
5
5
  export const defaultExcludeValues = [
6
6
  isUrl,
7
7
  isSlug,
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/excludeValues.ts"],"sourcesContent":["export type ValueExcludePredicate = (value: string) => boolean;\n\n/** Absolute (`https:`, `mailto:`, `data:`), protocol-relative (`//cdn`) or root-relative (`/path`) URLs: a marker in an `href` breaks the link. */\nexport const isUrl: ValueExcludePredicate = (value) =>\n /^(?:[a-z][a-z0-9+.-]*:|\\/\\/|\\/)/i.test(value);\n\n/** Lowercase words joined by hyphens (`hello-world`). A single word (`hello`) stays editable. */\nexport const isSlug: ValueExcludePredicate = (value) => /^[a-z0-9]+(-[a-z0-9]+)+$/.test(value);\n\n/** Fragment URLs (`#`, `#demo`). A hash followed by digits only (`#1`) is ranking text and stays editable. */\nexport const isHash: ValueExcludePredicate = (value) => /^#(?!\\d+$)/.test(value);\n\n/** ISO 8601 dates and timestamps (`2024-01-31`, `2024-01-31T10:00:00Z`), not `YYYY` or `YYYY-MM`. */\nexport const isIsoDate: ValueExcludePredicate = (value) =>\n /^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:?\\d{2})?)?$/.test(value);\n\nexport const defaultExcludeValues: readonly ValueExcludePredicate[] = [\n isUrl,\n isSlug,\n isHash,\n isIsoDate,\n];\n"],"names":["isUrl","value","test","isSlug","isHash","isIsoDate","defaultExcludeValues"],"mappings":"AAEA,iJAAiJ,GACjJ,OAAO,MAAMA,QAA+B,CAACC,QAC3C,mCAAmCC,IAAI,CAACD,OAAO;AAEjD,+FAA+F,GAC/F,OAAO,MAAME,SAAgC,CAACF,QAAU,2BAA2BC,IAAI,CAACD,OAAO;AAE/F,4GAA4G,GAC5G,OAAO,MAAMG,SAAgC,CAACH,QAAU,aAAaC,IAAI,CAACD,OAAO;AAEjF,mGAAmG,GACnG,OAAO,MAAMI,YAAmC,CAACJ,QAC/C,8EAA8EC,IAAI,CAACD,OAAO;AAE5F,OAAO,MAAMK,uBAAyD;IACpEN;IACAG;IACAC;IACAC;CACD,CAAC"}
1
+ {"version":3,"sources":["../src/excludeValues.ts"],"sourcesContent":["export type ValueExcludePredicate = (value: string) => boolean;\n\nexport const isUrl: ValueExcludePredicate = (value) =>\n /^(?:[a-z][a-z0-9+.-]*:|\\/\\/|\\/)/i.test(value);\n\nexport const isSlug: ValueExcludePredicate = (value) =>\n /^(?=.*[a-z])[a-z0-9]+(-[a-z0-9]+)+$/.test(value);\n\nexport const isHash: ValueExcludePredicate = (value) => /^#(?!\\d+$)\\S*$/.test(value);\n\nexport const isIsoDate: ValueExcludePredicate = (value) =>\n /^\\d{4}-\\d{2}-\\d{2}(?:T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:?\\d{2})?)?$/.test(value);\n\nexport const defaultExcludeValues: readonly ValueExcludePredicate[] = [\n isUrl,\n isSlug,\n isHash,\n isIsoDate,\n];\n"],"names":["isUrl","value","test","isSlug","isHash","isIsoDate","defaultExcludeValues"],"mappings":"AAEA,OAAO,MAAMA,QAA+B,CAACC,QAC3C,mCAAmCC,IAAI,CAACD,OAAO;AAEjD,OAAO,MAAME,SAAgC,CAACF,QAC5C,sCAAsCC,IAAI,CAACD,OAAO;AAEpD,OAAO,MAAMG,SAAgC,CAACH,QAAU,iBAAiBC,IAAI,CAACD,OAAO;AAErF,OAAO,MAAMI,YAAmC,CAACJ,QAC/C,8EAA8EC,IAAI,CAACD,OAAO;AAE5F,OAAO,MAAMK,uBAAyD;IACpEN;IACAG;IACAC;IACAC;CACD,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { Plugin } from "payload";
2
2
  import type { ValueExcludePredicate } from "./excludeValues.js";
3
3
  import type { Enrichment } from "./server/markedReads.js";
4
+ import type { RenderHtml } from "./server/endpoints.js";
4
5
  export { defaultExcludeValues, isHash, isIsoDate, isSlug, isUrl, type ValueExcludePredicate, } from "./excludeValues.js";
5
6
  export { stripMarkers } from "./stripMarkers.js";
6
7
  export { DEFAULT_MAX_UNSAVED_STATE_LENGTH, DEFAULT_UNSAVED_READ_TIME_LIMIT_MS, readUnsavedRichText, type ReadUnsavedRichTextArgs, type UnsavedRichTextDepth, } from "./readUnsavedRichText.js";
@@ -23,5 +24,8 @@ export type VisualEditingPluginConfig = {
23
24
  * `'explicit'` enriches only reads that pass `context: { visualEditing: true }`. */
24
25
  enrichment?: Enrichment;
25
26
  instantPreview?: boolean;
27
+ renderHtml?: RenderHtml;
28
+ readWholeDocument?: boolean;
26
29
  };
30
+ export type { RenderHtml } from "./server/endpoints.js";
27
31
  export declare const visualEditingPlugin: (pluginConfig?: VisualEditingPluginConfig) => Plugin;
package/dist/index.js CHANGED
@@ -4,7 +4,8 @@ import { createReadHooks } from "./server/hooks/readHooks.js";
4
4
  import { createGlobalUnsavedRichTextHook, createUnsavedRichTextHook } from "./server/unsavedRichText/hooks.js";
5
5
  import { createSchemaCache, withSchemaCache } from "./server/schemaCache.js";
6
6
  import { createStripStegaHook } from "./server/hooks/stripStegaHook.js";
7
- import { withInstantPreviewCollection, withInstantPreviewGlobal } from "./server/withInstantPreview.js";
7
+ import { visualEditingEndpoints } from "./server/endpoints.js";
8
+ import { withDocumentControlsCollection, withDocumentControlsGlobal } from "./server/withDocumentControls.js";
8
9
  export { defaultExcludeValues, isHash, isIsoDate, isSlug, isUrl } from "./excludeValues.js";
9
10
  export { stripMarkers } from "./stripMarkers.js";
10
11
  export { DEFAULT_MAX_UNSAVED_STATE_LENGTH, DEFAULT_UNSAVED_READ_TIME_LIMIT_MS, readUnsavedRichText } from "./readUnsavedRichText.js";
@@ -27,8 +28,9 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
27
28
  const enrichment = pluginConfig.enrichment ?? "auto";
28
29
  const instantPreview = pluginConfig.instantPreview ?? false;
29
30
  const excludeFieldNames = pluginConfig.excludeFieldNames ?? [];
30
- const instantPreviewOptions = {
31
+ const documentControlsOptions = {
31
32
  excludeFieldNames,
33
+ instantPreview,
32
34
  rootLivePreview: config.admin?.livePreview
33
35
  };
34
36
  const schemaCache = createSchemaCache({
@@ -50,6 +52,13 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
50
52
  ] : [];
51
53
  return {
52
54
  ...config,
55
+ endpoints: instantPreview ? [
56
+ ...config.endpoints ?? [],
57
+ ...visualEditingEndpoints({
58
+ readWholeDocument: pluginConfig.readWholeDocument,
59
+ renderHtml: pluginConfig.renderHtml
60
+ })
61
+ ] : config.endpoints,
53
62
  custom: instantPreview ? withSchemaCache(config.custom, schemaCache) : config.custom,
54
63
  collections: config.collections?.map((collection)=>{
55
64
  if (skipCols.has(collection.slug)) return collection;
@@ -71,7 +80,7 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
71
80
  ]
72
81
  }
73
82
  };
74
- return instantPreview ? withInstantPreviewCollection(withHooks, instantPreviewOptions) : withHooks;
83
+ return withDocumentControlsCollection(withHooks, documentControlsOptions);
75
84
  }),
76
85
  globals: config.globals?.map((global)=>{
77
86
  if (skipGlobals.has(global.slug)) return global;
@@ -97,7 +106,7 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
97
106
  ]
98
107
  }
99
108
  };
100
- return instantPreview ? withInstantPreviewGlobal(withHooks, instantPreviewOptions) : withHooks;
109
+ return withDocumentControlsGlobal(withHooks, documentControlsOptions);
101
110
  }),
102
111
  admin: {
103
112
  ...config.admin,
package/dist/index.js.map CHANGED
@@ -1 +1 @@
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"}
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 { visualEditingEndpoints } from \"./server/endpoints.js\";\nimport type { RenderHtml } from \"./server/endpoints.js\";\nimport {\n withDocumentControlsCollection,\n withDocumentControlsGlobal,\n} from \"./server/withDocumentControls.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 renderHtml?: RenderHtml;\n readWholeDocument?: boolean;\n};\n\nexport type { RenderHtml } from \"./server/endpoints.js\";\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 documentControlsOptions = {\n excludeFieldNames,\n instantPreview,\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 endpoints: instantPreview\n ? [\n ...(config.endpoints ?? []),\n ...visualEditingEndpoints({\n readWholeDocument: pluginConfig.readWholeDocument,\n renderHtml: pluginConfig.renderHtml,\n }),\n ]\n : config.endpoints,\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 withDocumentControlsCollection(withHooks, documentControlsOptions);\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 withDocumentControlsGlobal(withHooks, documentControlsOptions);\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","visualEditingEndpoints","withDocumentControlsCollection","withDocumentControlsGlobal","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","documentControlsOptions","rootLivePreview","admin","livePreview","schemaCache","collectionAfterOperation","globalAfterRead","globalBeforeOperation","stripStega","unsavedRichText","globalUnsavedRichText","endpoints","readWholeDocument","renderHtml","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,SAASC,sBAAsB,QAAQ,wBAAwB;AAE/D,SACEC,8BAA8B,EAC9BC,0BAA0B,QACrB,mCAAmC;AAE1C,SACET,oBAAoB,EACpBU,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,EAAErB,aAAa,kCAAkC,CAAC;AAoBjF,OAAO,MAAMsB,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,IAAI7B;QACpD,MAAM8B,aAAaR,aAAaQ,UAAU,IAAI;QAC9C,MAAMC,iBAAiBT,aAAaS,cAAc,IAAI;QACtD,MAAMC,oBAAoBV,aAAaU,iBAAiB,IAAI,EAAE;QAC9D,MAAMC,0BAA0B;YAC9BD;YACAD;YACAG,iBAAiBX,OAAOY,KAAK,EAAEC;QACjC;QAEA,MAAMC,cAAcjC,kBAAkB;YAAE4B;QAAkB;QAC1D,MAAM,EAAEM,wBAAwB,EAAEC,eAAe,EAAEC,qBAAqB,EAAE,GAAGvC,gBAAgB;YAC3FoC;YACAR;YACAD;YACAE;YACAC;QACF;QACA,MAAMU,aAAanC;QACnB,MAAMoC,kBAAkBX,iBAAiB;YAAC5B,0BAA0BkC;SAAa,GAAG,EAAE;QACtF,MAAMM,wBAAwBZ,iBAC1B;YAAC7B,gCAAgCmC;SAAa,GAC9C,EAAE;QAEN,OAAO;YACL,GAAGd,MAAM;YACTqB,WAAWb,iBACP;mBACMR,OAAOqB,SAAS,IAAI,EAAE;mBACvBrC,uBAAuB;oBACxBsC,mBAAmBvB,aAAauB,iBAAiB;oBACjDC,YAAYxB,aAAawB,UAAU;gBACrC;aACD,GACDvB,OAAOqB,SAAS;YACpBG,QAAQhB,iBAAiB1B,gBAAgBkB,OAAOwB,MAAM,EAAEV,eAAed,OAAOwB,MAAM;YACpFC,aAAazB,OAAOyB,WAAW,EAAEC,IAAI,CAACC;gBACpC,IAAI1B,SAAS2B,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;4BAAGd;yBAAW;wBACrEe,YAAY;+BAAKN,WAAWI,KAAK,EAAEE,cAAc,EAAE;+BAAMd;yBAAgB;wBACzEe,gBAAgB;+BAAKP,WAAWI,KAAK,EAAEG,kBAAkB,EAAE;4BAAGnB;yBAAyB;oBACzF;gBACF;gBACA,OAAO9B,+BAA+B6C,WAAWpB;YACnD;YACAyB,SAASnC,OAAOmC,OAAO,EAAET,IAAI,CAACU;gBAC5B,IAAIhC,YAAYwB,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;4BAAGpB;yBAAsB;wBAClFgB,YAAY;+BAAKG,OAAOL,KAAK,EAAEE,cAAc,EAAE;+BAAMb;yBAAsB;wBAC3EY,cAAc;+BAAKI,OAAOL,KAAK,EAAEC,gBAAgB,EAAE;4BAAGd;yBAAW;wBACjEoB,WAAW;+BAAKF,OAAOL,KAAK,EAAEO,aAAa,EAAE;4BAAGtB;yBAAgB;oBAClE;gBACF;gBACA,OAAO9B,2BAA2B4C,WAAWpB;YAC/C;YACAE,OAAO;gBACL,GAAGZ,OAAOY,KAAK;gBACf2B,YAAY;oBACV,GAAGvC,OAAOY,KAAK,EAAE2B,UAAU;oBAC3BC,WAAW;2BACLxC,OAAOY,KAAK,EAAE2B,YAAYC,aAAa,EAAE;wBAC7C;4BACEC,MAAM5C;4BACN6C,aAAa;gCAAErC;4BAAc;wBAC/B;qBACD;gBACH;YACF;QACF;IACF,EAAE"}
@@ -1,5 +1,5 @@
1
1
  import type { Payload } from "payload";
2
- import type { PostedRequest } from "./server/unsavedRichText/postedRequest.js";
2
+ import type { PostedRequest, SignedIn, Unsaved } from "./server/unsavedRichText/postedRequest.js";
3
3
  import type { UnsavedRichTextDepth } from "./server/unsavedRichText/readAsUser.js";
4
4
  export type { UnsavedRichTextDepth } from "./server/unsavedRichText/readAsUser.js";
5
5
  export declare const DEFAULT_MAX_UNSAVED_STATE_LENGTH = 1000000;
@@ -9,5 +9,19 @@ export type ReadUnsavedRichTextArgs = PostedRequest & {
9
9
  depth?: UnsavedRichTextDepth;
10
10
  maxStateLength?: number;
11
11
  timeLimitMs?: number;
12
+ readWholeDocument?: boolean;
12
13
  };
13
- export declare const readUnsavedRichText: <Content = unknown>({ depth, maxStateLength, payload, timeLimitMs, ...posted }: ReadUnsavedRichTextArgs) => Promise<Content | null>;
14
+ type ReadLimits = {
15
+ depth?: UnsavedRichTextDepth;
16
+ maxStateLength?: number;
17
+ timeLimitMs?: number;
18
+ readWholeDocument?: boolean;
19
+ };
20
+ export type ReadUnsavedRichTextForArgs = ReadLimits & {
21
+ payload: Payload;
22
+ request: unknown;
23
+ user: SignedIn["user"];
24
+ allows: (unsaved: Unsaved) => boolean;
25
+ };
26
+ export declare const readUnsavedRichTextFor: <Content = unknown>({ allows, payload, request, user, ...limits }: ReadUnsavedRichTextForArgs) => Promise<Content | null>;
27
+ export declare const readUnsavedRichText: <Content = unknown>({ depth, maxStateLength, payload, readWholeDocument, timeLimitMs, ...posted }: ReadUnsavedRichTextArgs) => Promise<Content | null>;
@@ -1,5 +1,5 @@
1
1
  import { createLatestReads } from "./server/unsavedRichText/latestReads.js";
2
- import { checkAndSignIn, signInAndReadBody } from "./server/unsavedRichText/postedRequest.js";
2
+ import { checkAndSignIn, readUnsaved, signInAndReadBody } from "./server/unsavedRichText/postedRequest.js";
3
3
  import { readAsUser, readKeyOf } from "./server/unsavedRichText/readAsUser.js";
4
4
  export const DEFAULT_MAX_UNSAVED_STATE_LENGTH = 1_000_000;
5
5
  export const DEFAULT_UNSAVED_READ_TIME_LIMIT_MS = 3000;
@@ -39,37 +39,56 @@ const nullOnFailure = async (work, onFailure = ignoreFailure)=>{
39
39
  return null;
40
40
  }
41
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));
42
+ const readSignedInAsUser = async (payload, signIn, options)=>{
43
+ const signedIn = await nullOnFailure(()=>signIn(options));
44
44
  if (!signedIn || options.signal.aborted) return null;
45
45
  const { unsaved, user } = signedIn;
46
46
  const logFailure = (err)=>payload.logger.error({
47
47
  err,
48
48
  msg: UNSAVED_READ_FAILURE_MESSAGE
49
49
  });
50
- const readOnce = ()=>nullOnFailure(()=>readAsUser(payload, user, unsaved, options.depth), logFailure);
50
+ const readOnce = ()=>nullOnFailure(()=>readAsUser(payload, user, unsaved, options), logFailure);
51
51
  return latestReadsOf(payload).read(readKeyOf(user, unsaved), readOnce, {
52
52
  signal: options.signal,
53
53
  staleAfterMs: options.timeLimitMs * RUNNING_READ_STALE_AFTER_TIME_LIMITS
54
54
  });
55
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;
56
+ const signInFromPosted = (payload, { headers, request })=>(options)=>request instanceof Request ? signInAndReadBody(payload, request, options) : checkAndSignIn(payload, request, headers, options);
57
+ const readWithinLimits = async (payload, signIn, { depth, maxStateLength = DEFAULT_MAX_UNSAVED_STATE_LENGTH, readWholeDocument = false, savedReferencesOnly, timeLimitMs = DEFAULT_UNSAVED_READ_TIME_LIMIT_MS }, requestSignal)=>{
58
58
  const { nothing, signal, stop } = deadlineAfter(timeLimitMs, requestSignal);
59
59
  const options = {
60
60
  depth,
61
61
  maxStateLength,
62
+ readWholeDocument,
63
+ savedReferencesOnly,
62
64
  signal,
63
65
  timeLimitMs
64
66
  };
65
67
  try {
66
68
  return await Promise.race([
67
- readPostedAsUser(payload, posted, options),
69
+ readSignedInAsUser(payload, signIn, options),
68
70
  nothing
69
71
  ]);
70
72
  } finally{
71
73
  stop();
72
74
  }
73
75
  };
76
+ export const readUnsavedRichTextFor = ({ allows, payload, request, user, ...limits })=>readWithinLimits(payload, async ({ maxStateLength })=>{
77
+ const unsaved = readUnsaved(payload, request, maxStateLength);
78
+ return unsaved && allows(unsaved) ? {
79
+ unsaved,
80
+ user
81
+ } : null;
82
+ }, {
83
+ ...limits,
84
+ savedReferencesOnly: true
85
+ }, undefined);
86
+ export const readUnsavedRichText = ({ depth, maxStateLength, payload, readWholeDocument, timeLimitMs, ...posted })=>readWithinLimits(payload, signInFromPosted(payload, posted), {
87
+ depth,
88
+ maxStateLength,
89
+ readWholeDocument,
90
+ savedReferencesOnly: false,
91
+ timeLimitMs
92
+ }, posted.request instanceof Request ? posted.request.signal : undefined);
74
93
 
75
94
  //# sourceMappingURL=readUnsavedRichText.js.map
@@ -1 +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"}
1
+ {"version":3,"sources":["../src/readUnsavedRichText.ts"],"sourcesContent":["import type { Payload } from \"payload\";\n\nimport type { LatestReads } from \"./server/unsavedRichText/latestReads.js\";\nimport type {\n PostedReadLimits,\n PostedRequest,\n SignedIn,\n Unsaved,\n} from \"./server/unsavedRichText/postedRequest.js\";\nimport type {\n ReadAsUserOptions,\n UnsavedRichTextDepth,\n} from \"./server/unsavedRichText/readAsUser.js\";\n\nimport { createLatestReads } from \"./server/unsavedRichText/latestReads.js\";\nimport {\n checkAndSignIn,\n readUnsaved,\n signInAndReadBody,\n} 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 readWholeDocument?: boolean;\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 ReadAsUserOptions & {\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\ntype SignIn = (options: ReadOptions) => Promise<SignedIn | null>;\n\nconst readSignedInAsUser = async <Content>(\n payload: Payload,\n signIn: SignIn,\n options: ReadOptions\n): Promise<Content | null> => {\n const signedIn = await nullOnFailure(() => signIn(options));\n if (!signedIn || options.signal.aborted) return null;\n\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), 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\nconst signInFromPosted =\n (payload: Payload, { headers, request }: PostedRequest): SignIn =>\n (options) =>\n request instanceof Request\n ? signInAndReadBody(payload, request, options)\n : checkAndSignIn(payload, request, headers, options);\n\ntype ReadLimits = {\n depth?: UnsavedRichTextDepth;\n maxStateLength?: number;\n timeLimitMs?: number;\n readWholeDocument?: boolean;\n};\n\ntype ReadRules = ReadLimits & { savedReferencesOnly: boolean };\n\nconst readWithinLimits = async <Content>(\n payload: Payload,\n signIn: SignIn,\n {\n depth,\n maxStateLength = DEFAULT_MAX_UNSAVED_STATE_LENGTH,\n readWholeDocument = false,\n savedReferencesOnly,\n timeLimitMs = DEFAULT_UNSAVED_READ_TIME_LIMIT_MS,\n }: ReadRules,\n requestSignal: AbortSignal | undefined\n): Promise<Content | null> => {\n const { nothing, signal, stop } = deadlineAfter(timeLimitMs, requestSignal);\n const options = {\n depth,\n maxStateLength,\n readWholeDocument,\n savedReferencesOnly,\n signal,\n timeLimitMs,\n };\n try {\n return await Promise.race([readSignedInAsUser<Content>(payload, signIn, options), nothing]);\n } finally {\n stop();\n }\n};\n\nexport type ReadUnsavedRichTextForArgs = ReadLimits & {\n payload: Payload;\n request: unknown;\n user: SignedIn[\"user\"];\n allows: (unsaved: Unsaved) => boolean;\n};\n\nexport const readUnsavedRichTextFor = <Content = unknown>({\n allows,\n payload,\n request,\n user,\n ...limits\n}: ReadUnsavedRichTextForArgs): Promise<Content | null> =>\n readWithinLimits<Content>(\n payload,\n async ({ maxStateLength }) => {\n const unsaved = readUnsaved(payload, request, maxStateLength);\n return unsaved && allows(unsaved) ? { unsaved, user } : null;\n },\n { ...limits, savedReferencesOnly: true },\n undefined\n );\n\nexport const readUnsavedRichText = <Content = unknown>({\n depth,\n maxStateLength,\n payload,\n readWholeDocument,\n timeLimitMs,\n ...posted\n}: ReadUnsavedRichTextArgs): Promise<Content | null> =>\n readWithinLimits<Content>(\n payload,\n signInFromPosted(payload, posted),\n { depth, maxStateLength, readWholeDocument, savedReferencesOnly: false, timeLimitMs },\n posted.request instanceof Request ? posted.request.signal : undefined\n );\n"],"names":["createLatestReads","checkAndSignIn","readUnsaved","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","readSignedInAsUser","signIn","options","signedIn","unsaved","user","logFailure","logger","error","msg","readOnce","read","staleAfterMs","signInFromPosted","headers","request","Request","readWithinLimits","depth","maxStateLength","readWholeDocument","savedReferencesOnly","race","readUnsavedRichTextFor","allows","limits","readUnsavedRichText","posted"],"mappings":"AAcA,SAASA,iBAAiB,QAAQ,0CAA0C;AAC5E,SACEC,cAAc,EACdC,WAAW,EACXC,iBAAiB,QACZ,4CAA4C;AACnD,SAASC,UAAU,EAAEC,SAAS,QAAQ,yCAAyC;AAI/E,OAAO,MAAMC,mCAAmC,UAAU;AAC1D,OAAO,MAAMC,qCAAqC,KAAK;AAEvD,MAAMC,+BAA+B;AACrC,MAAMC,uCAAuC;AAU7C,MAAMC,uBAAuB,IAAIC;AAEjC,MAAMC,gBAAgB,CAACC;IACrB,MAAMC,cAAcJ,qBAAqBK,GAAG,CAACF,YAAYb,kBAAkB,IAAIgB;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;AAIA,MAAMC,qBAAqB,OACzB9B,SACA+B,QACAC;IAEA,MAAMC,WAAW,MAAMP,cAAc,IAAMK,OAAOC;IAClD,IAAI,CAACC,YAAYD,QAAQtB,MAAM,CAACS,OAAO,EAAE,OAAO;IAEhD,MAAM,EAAEe,OAAO,EAAEC,IAAI,EAAE,GAAGF;IAC1B,MAAMG,aAAa,CAACP,MAClB7B,QAAQqC,MAAM,CAACC,KAAK,CAAC;YAAET;YAAKU,KAAK5C;QAA6B;IAChE,MAAM6C,WAAW,IACfd,cAAc,IAAMnC,WAAoBS,SAASmC,MAAMD,SAASF,UAAUI;IAC5E,OAAOrC,cAAcC,SAASyC,IAAI,CAACjD,UAAU2C,MAAMD,UAAUM,UAAU;QACrE9B,QAAQsB,QAAQtB,MAAM;QACtBgC,cAAcV,QAAQ1B,WAAW,GAAGV;IACtC;AACF;AAEA,MAAM+C,mBACJ,CAAC3C,SAAkB,EAAE4C,OAAO,EAAEC,OAAO,EAAiB,GACtD,CAACb,UACCa,mBAAmBC,UACfxD,kBAAkBU,SAAS6C,SAASb,WACpC5C,eAAeY,SAAS6C,SAASD,SAASZ;AAWlD,MAAMe,mBAAmB,OACvB/C,SACA+B,QACA,EACEiB,KAAK,EACLC,iBAAiBxD,gCAAgC,EACjDyD,oBAAoB,KAAK,EACzBC,mBAAmB,EACnB7C,cAAcZ,kCAAkC,EACtC,EACZa;IAEA,MAAM,EAAES,OAAO,EAAEN,MAAM,EAAEY,IAAI,EAAE,GAAGjB,cAAcC,aAAaC;IAC7D,MAAMyB,UAAU;QACdgB;QACAC;QACAC;QACAC;QACAzC;QACAJ;IACF;IACA,IAAI;QACF,OAAO,MAAMW,QAAQmC,IAAI,CAAC;YAACtB,mBAA4B9B,SAAS+B,QAAQC;YAAUhB;SAAQ;IAC5F,SAAU;QACRM;IACF;AACF;AASA,OAAO,MAAM+B,yBAAyB,CAAoB,EACxDC,MAAM,EACNtD,OAAO,EACP6C,OAAO,EACPV,IAAI,EACJ,GAAGoB,QACwB,GAC3BR,iBACE/C,SACA,OAAO,EAAEiD,cAAc,EAAE;QACvB,MAAMf,UAAU7C,YAAYW,SAAS6C,SAASI;QAC9C,OAAOf,WAAWoB,OAAOpB,WAAW;YAAEA;YAASC;QAAK,IAAI;IAC1D,GACA;QAAE,GAAGoB,MAAM;QAAEJ,qBAAqB;IAAK,GACvC1B,WACA;AAEJ,OAAO,MAAM+B,sBAAsB,CAAoB,EACrDR,KAAK,EACLC,cAAc,EACdjD,OAAO,EACPkD,iBAAiB,EACjB5C,WAAW,EACX,GAAGmD,QACqB,GACxBV,iBACE/C,SACA2C,iBAAiB3C,SAASyD,SAC1B;QAAET;QAAOC;QAAgBC;QAAmBC,qBAAqB;QAAO7C;IAAY,GACpFmD,OAAOZ,OAAO,YAAYC,UAAUW,OAAOZ,OAAO,CAACnC,MAAM,GAAGe,WAC5D"}
@@ -0,0 +1,16 @@
1
+ import type { Endpoint, PayloadRequest } from "payload";
2
+ import type { LiveRichTextField } from "../shared/protocol.js";
3
+ import type { UnsavedRichTextDepth } from "./unsavedRichText/readAsUser.js";
4
+ export type RenderHtml = (args: {
5
+ value: unknown;
6
+ field: LiveRichTextField;
7
+ locale: string | undefined;
8
+ req: PayloadRequest;
9
+ }) => string | Promise<string>;
10
+ export type UnsavedRichTextEndpointOptions = {
11
+ depth?: UnsavedRichTextDepth;
12
+ readWholeDocument?: boolean;
13
+ renderHtml?: RenderHtml;
14
+ };
15
+ export declare const ENDPOINT_READ_TIME_LIMIT_MS = 8000;
16
+ export declare const visualEditingEndpoints: (options: UnsavedRichTextEndpointOptions) => Endpoint[];