@focus-reactive/payload-plugin-visual-editing 1.1.1 → 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.
- package/README.md +600 -96
- package/dist/admin/InstantPreviewBroadcaster.d.ts +3 -0
- package/dist/admin/InstantPreviewBroadcaster.js +105 -0
- package/dist/admin/InstantPreviewBroadcaster.js.map +1 -0
- package/dist/admin/PreviewPageBridge.d.ts +1 -0
- package/dist/admin/PreviewPageBridge.js +50 -0
- package/dist/admin/PreviewPageBridge.js.map +1 -0
- package/dist/admin/VisualEditingBridgeProvider.js +76 -50
- package/dist/admin/VisualEditingBridgeProvider.js.map +1 -1
- package/dist/admin/expandAndFocus.d.ts +1 -1
- package/dist/admin/expandAndFocus.js +138 -157
- package/dist/admin/expandAndFocus.js.map +1 -1
- package/dist/admin/fieldDomId.d.ts +5 -0
- package/dist/admin/fieldDomId.js +11 -0
- package/dist/admin/fieldDomId.js.map +1 -0
- package/dist/admin/index.d.ts +3 -0
- package/dist/admin/index.js +3 -0
- package/dist/admin/index.js.map +1 -1
- package/dist/admin/instantPreview/fieldMessages.d.ts +26 -0
- package/dist/admin/instantPreview/fieldMessages.js +90 -0
- package/dist/admin/instantPreview/fieldMessages.js.map +1 -0
- package/dist/admin/instantPreview/formFields.d.ts +9 -0
- package/dist/admin/instantPreview/formFields.js +54 -0
- package/dist/admin/instantPreview/formFields.js.map +1 -0
- package/dist/admin/instantPreview/previewGrants.d.ts +14 -0
- package/dist/admin/instantPreview/previewGrants.js +62 -0
- package/dist/admin/instantPreview/previewGrants.js.map +1 -0
- package/dist/admin/instantPreview/previewSession.d.ts +18 -0
- package/dist/admin/instantPreview/previewSession.js +157 -0
- package/dist/admin/instantPreview/previewSession.js.map +1 -0
- package/dist/admin/instantPreview/richTextReads.d.ts +29 -0
- package/dist/admin/instantPreview/richTextReads.js +67 -0
- package/dist/admin/instantPreview/richTextReads.js.map +1 -0
- package/dist/admin/instantPreview/unsavedStructures.d.ts +16 -0
- package/dist/admin/instantPreview/unsavedStructures.js +71 -0
- package/dist/admin/instantPreview/unsavedStructures.js.map +1 -0
- package/dist/admin/instantPreview/useEditableSchema.d.ts +7 -0
- package/dist/admin/instantPreview/useEditableSchema.js +30 -0
- package/dist/admin/instantPreview/useEditableSchema.js.map +1 -0
- package/dist/admin/instantPreview/usePreviewPage.d.ts +4 -0
- package/dist/admin/instantPreview/usePreviewPage.js +59 -0
- package/dist/admin/instantPreview/usePreviewPage.js.map +1 -0
- package/dist/admin/instantPreview/usePreviewWindow.d.ts +7 -0
- package/dist/admin/instantPreview/usePreviewWindow.js +46 -0
- package/dist/admin/instantPreview/usePreviewWindow.js.map +1 -0
- package/dist/admin/openField/OpenFormAnnouncer.d.ts +1 -0
- package/dist/admin/openField/OpenFormAnnouncer.js +8 -0
- package/dist/admin/openField/OpenFormAnnouncer.js.map +1 -0
- package/dist/admin/openField/formPathOfKey.d.ts +11 -0
- package/dist/admin/openField/formPathOfKey.js +20 -0
- package/dist/admin/openField/formPathOfKey.js.map +1 -0
- package/dist/admin/openField/openDocument.d.ts +8 -0
- package/dist/admin/openField/openDocument.js +13 -0
- package/dist/admin/openField/openDocument.js.map +1 -0
- package/dist/admin/openField/openForms.d.ts +16 -0
- package/dist/admin/openField/openForms.js +60 -0
- package/dist/admin/openField/openForms.js.map +1 -0
- package/dist/admin/openField/useOpenFormAnnouncement.d.ts +1 -0
- package/dist/admin/openField/useOpenFormAnnouncement.js +29 -0
- package/dist/admin/openField/useOpenFormAnnouncement.js.map +1 -0
- package/dist/admin/parseFieldPath.js +7 -17
- package/dist/admin/parseFieldPath.js.map +1 -1
- package/dist/admin/previewPages.d.ts +7 -0
- package/dist/admin/previewPages.js +13 -0
- package/dist/admin/previewPages.js.map +1 -0
- package/dist/admin/resolveContainerChain.d.ts +3 -2
- package/dist/admin/resolveContainerChain.js +10 -33
- package/dist/admin/resolveContainerChain.js.map +1 -1
- package/dist/client/adminWindow.d.ts +2 -0
- package/dist/client/adminWindow.js +8 -0
- package/dist/client/adminWindow.js.map +1 -0
- package/dist/client/createOverlay.d.ts +17 -0
- package/dist/client/createOverlay.js +33 -0
- package/dist/client/createOverlay.js.map +1 -0
- package/dist/client/index.d.ts +9 -5
- package/dist/client/index.js +7 -5
- package/dist/client/index.js.map +1 -1
- package/dist/client/instantPreview/adminChannel.d.ts +14 -0
- package/dist/client/instantPreview/adminChannel.js +40 -0
- package/dist/client/instantPreview/adminChannel.js.map +1 -0
- package/dist/client/instantPreview/instantPreview.d.ts +8 -0
- package/dist/client/instantPreview/instantPreview.js +49 -0
- package/dist/client/instantPreview/instantPreview.js.map +1 -0
- package/dist/client/instantPreview/liveFields.d.ts +19 -0
- package/dist/client/instantPreview/liveFields.js +185 -0
- package/dist/client/instantPreview/liveFields.js.map +1 -0
- package/dist/client/instantPreview/liveMessages.d.ts +6 -0
- package/dist/client/instantPreview/liveMessages.js +39 -0
- package/dist/client/instantPreview/liveMessages.js.map +1 -0
- package/dist/client/instantPreview/liveRichTextOf.d.ts +9 -0
- package/dist/client/instantPreview/liveRichTextOf.js +26 -0
- package/dist/client/instantPreview/liveRichTextOf.js.map +1 -0
- package/dist/client/instantPreview/pageLoad.d.ts +6 -0
- package/dist/client/instantPreview/pageLoad.js +11 -0
- package/dist/client/instantPreview/pageLoad.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/announcer.d.ts +3 -0
- package/dist/client/instantPreview/unsavedRender/announcer.js +25 -0
- package/dist/client/instantPreview/unsavedRender/announcer.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/baseValues.d.ts +12 -0
- package/dist/client/instantPreview/unsavedRender/baseValues.js +130 -0
- package/dist/client/instantPreview/unsavedRender/baseValues.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/liveRichText.d.ts +29 -0
- package/dist/client/instantPreview/unsavedRender/liveRichText.js +117 -0
- package/dist/client/instantPreview/unsavedRender/liveRichText.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/optimisticValue.d.ts +6 -0
- package/dist/client/instantPreview/unsavedRender/optimisticValue.js +20 -0
- package/dist/client/instantPreview/unsavedRender/optimisticValue.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/renderSources.d.ts +26 -0
- package/dist/client/instantPreview/unsavedRender/renderSources.js +77 -0
- package/dist/client/instantPreview/unsavedRender/renderSources.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/savedShapes.d.ts +6 -0
- package/dist/client/instantPreview/unsavedRender/savedShapes.js +20 -0
- package/dist/client/instantPreview/unsavedRender/savedShapes.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/unsavedRender.d.ts +45 -0
- package/dist/client/instantPreview/unsavedRender/unsavedRender.js +257 -0
- package/dist/client/instantPreview/unsavedRender/unsavedRender.js.map +1 -0
- package/dist/client/instantPreview/unsavedRender/valueSource.d.ts +17 -0
- package/dist/client/instantPreview/unsavedRender/valueSource.js +38 -0
- package/dist/client/instantPreview/unsavedRender/valueSource.js.map +1 -0
- package/dist/client/overlay/constants.d.ts +3 -4
- package/dist/client/overlay/constants.js +5 -19
- package/dist/client/overlay/constants.js.map +1 -1
- package/dist/client/overlay/editBadge.d.ts +2 -8
- package/dist/client/overlay/editBadge.js +0 -8
- package/dist/client/overlay/editBadge.js.map +1 -1
- package/dist/client/overlay/editTargets.d.ts +3 -0
- package/dist/client/overlay/editTargets.js +98 -0
- package/dist/client/overlay/editTargets.js.map +1 -0
- package/dist/client/overlay/fieldTracker.d.ts +22 -0
- package/dist/client/overlay/fieldTracker.js +292 -0
- package/dist/client/overlay/fieldTracker.js.map +1 -0
- package/dist/client/overlay/hoverController.d.ts +0 -5
- package/dist/client/overlay/hoverController.js +3 -19
- package/dist/client/overlay/hoverController.js.map +1 -1
- package/dist/client/overlay/markerCleaner.d.ts +5 -0
- package/dist/client/overlay/markerCleaner.js +94 -0
- package/dist/client/overlay/markerCleaner.js.map +1 -0
- package/dist/client/overlay/markerExtractor.d.ts +4 -3
- package/dist/client/overlay/markerExtractor.js +13 -20
- package/dist/client/overlay/markerExtractor.js.map +1 -1
- package/dist/client/overlay/mutationPipeline.d.ts +5 -2
- package/dist/client/overlay/mutationPipeline.js +57 -35
- package/dist/client/overlay/mutationPipeline.js.map +1 -1
- package/dist/client/overlay/pageNodes.d.ts +3 -0
- package/dist/client/overlay/pageNodes.js +34 -0
- package/dist/client/overlay/pageNodes.js.map +1 -0
- package/dist/client/overlay/targetRegistry.d.ts +5 -11
- package/dist/client/overlay/targetRegistry.js +14 -7
- package/dist/client/overlay/targetRegistry.js.map +1 -1
- package/dist/client/overlay/targetSelector.js +0 -9
- package/dist/client/overlay/targetSelector.js.map +1 -1
- package/dist/client/overlayClickHandler.d.ts +1 -1
- package/dist/client/overlayClickHandler.js +9 -14
- package/dist/client/overlayClickHandler.js.map +1 -1
- package/dist/client/overlayScope.d.ts +14 -0
- package/dist/client/overlayScope.js +23 -0
- package/dist/client/overlayScope.js.map +1 -0
- package/dist/client/previewGrant.d.ts +5 -0
- package/dist/client/previewGrant.js +34 -0
- package/dist/client/previewGrant.js.map +1 -0
- package/dist/client/react/LiveRichText.d.ts +17 -0
- package/dist/client/react/LiveRichText.js +32 -0
- package/dist/client/react/LiveRichText.js.map +1 -0
- package/dist/client/react/UnsavedRenderBoundary.d.ts +19 -0
- package/dist/client/react/UnsavedRenderBoundary.js +28 -0
- package/dist/client/react/UnsavedRenderBoundary.js.map +1 -0
- package/dist/client/react/VisualEditingOverlay.js +60 -0
- package/dist/client/react/VisualEditingOverlay.js.map +1 -0
- package/dist/client/react/VisualEditingProvider.d.ts +21 -0
- package/dist/client/react/VisualEditingProvider.js +83 -0
- package/dist/client/react/VisualEditingProvider.js.map +1 -0
- package/dist/client/react/VisualEditingToggle.d.ts +1 -0
- package/dist/client/react/VisualEditingToggle.js +32 -0
- package/dist/client/react/VisualEditingToggle.js.map +1 -0
- package/dist/client/react/overlayContext.d.ts +2 -0
- package/dist/client/react/overlayContext.js +4 -0
- package/dist/client/react/overlayContext.js.map +1 -0
- package/dist/client/react/useIsomorphicLayoutEffect.d.ts +2 -0
- package/dist/client/react/useIsomorphicLayoutEffect.js +4 -0
- package/dist/client/react/useIsomorphicLayoutEffect.js.map +1 -0
- package/dist/client/react/useUnsavedRender.d.ts +16 -0
- package/dist/client/react/useUnsavedRender.js +89 -0
- package/dist/client/react/useUnsavedRender.js.map +1 -0
- package/dist/client/saveEvents.d.ts +3 -0
- package/dist/client/saveEvents.js +27 -0
- package/dist/client/saveEvents.js.map +1 -0
- package/dist/client/session.d.ts +40 -0
- package/dist/client/session.js +100 -0
- package/dist/client/session.js.map +1 -0
- package/dist/client/sessionOverlay.d.ts +9 -0
- package/dist/client/sessionOverlay.js +74 -0
- package/dist/client/sessionOverlay.js.map +1 -0
- package/dist/client/toggle.d.ts +7 -0
- package/dist/client/toggle.js +158 -0
- package/dist/client/toggle.js.map +1 -0
- package/dist/client/visualEditingMode.d.ts +3 -0
- package/dist/client/visualEditingMode.js +8 -0
- package/dist/client/visualEditingMode.js.map +1 -0
- package/dist/client/withVisualEditingPath.d.ts +5 -1
- package/dist/client/withVisualEditingPath.js +19 -13
- package/dist/client/withVisualEditingPath.js.map +1 -1
- package/dist/dom/index.d.ts +6 -0
- package/dist/dom/index.js +7 -0
- package/dist/dom/index.js.map +1 -0
- package/dist/dom/liveRichTextElements.d.ts +8 -0
- package/dist/dom/liveRichTextElements.js +69 -0
- package/dist/dom/liveRichTextElements.js.map +1 -0
- package/dist/dom/mountVisualEditing.d.ts +16 -0
- package/dist/dom/mountVisualEditing.js +52 -0
- package/dist/dom/mountVisualEditing.js.map +1 -0
- package/dist/excludeValues.js +2 -14
- package/dist/excludeValues.js.map +1 -1
- package/dist/index.d.ts +10 -1
- package/dist/index.js +49 -30
- package/dist/index.js.map +1 -1
- package/dist/readUnsavedRichText.d.ts +27 -0
- package/dist/readUnsavedRichText.js +94 -0
- package/dist/readUnsavedRichText.js.map +1 -0
- package/dist/server/endpoints.d.ts +16 -0
- package/dist/server/endpoints.js +136 -0
- package/dist/server/endpoints.js.map +1 -0
- package/dist/server/hooks/readHooks.d.ts +14 -0
- package/dist/server/hooks/readHooks.js +67 -0
- package/dist/server/hooks/readHooks.js.map +1 -0
- package/dist/{internal → server/hooks}/stripStegaHook.js +11 -12
- package/dist/server/hooks/stripStegaHook.js.map +1 -0
- package/dist/server/localeCodesKeyingValues.d.ts +4 -0
- package/dist/server/localeCodesKeyingValues.js +15 -0
- package/dist/server/localeCodesKeyingValues.js.map +1 -0
- package/dist/server/markRead.d.ts +12 -0
- package/dist/server/markRead.js +220 -0
- package/dist/server/markRead.js.map +1 -0
- package/dist/server/markedReads.d.ts +28 -0
- package/dist/server/markedReads.js +60 -0
- package/dist/server/markedReads.js.map +1 -0
- package/dist/server/previewGrant.d.ts +9 -0
- package/dist/server/previewGrant.js +31 -0
- package/dist/server/previewGrant.js.map +1 -0
- package/dist/server/schemaCache.d.ts +29 -0
- package/dist/server/schemaCache.js +35 -0
- package/dist/server/schemaCache.js.map +1 -0
- package/dist/server/unsavedRichText/hooks.d.ts +4 -0
- package/dist/server/unsavedRichText/hooks.js +57 -0
- package/dist/server/unsavedRichText/hooks.js.map +1 -0
- package/dist/server/unsavedRichText/jsonBody.d.ts +1 -0
- package/dist/server/unsavedRichText/jsonBody.js +47 -0
- package/dist/server/unsavedRichText/jsonBody.js.map +1 -0
- package/dist/server/unsavedRichText/latestReads.d.ts +17 -0
- package/dist/server/unsavedRichText/latestReads.js +70 -0
- package/dist/server/unsavedRichText/latestReads.js.map +1 -0
- package/dist/server/unsavedRichText/placeUnsavedState.d.ts +8 -0
- package/dist/server/unsavedRichText/placeUnsavedState.js +12 -0
- package/dist/server/unsavedRichText/placeUnsavedState.js.map +1 -0
- package/dist/server/unsavedRichText/postedEditorState.d.ts +2 -0
- package/dist/server/unsavedRichText/postedEditorState.js +17 -0
- package/dist/server/unsavedRichText/postedEditorState.js.map +1 -0
- package/dist/server/unsavedRichText/postedRequest.d.ts +37 -0
- package/dist/server/unsavedRichText/postedRequest.js +106 -0
- package/dist/server/unsavedRichText/postedRequest.js.map +1 -0
- package/dist/server/unsavedRichText/readAsUser.d.ts +11 -0
- package/dist/server/unsavedRichText/readAsUser.js +91 -0
- package/dist/server/unsavedRichText/readAsUser.js.map +1 -0
- package/dist/server/unsavedRichText/readContext.d.ts +16 -0
- package/dist/server/unsavedRichText/readContext.js +14 -0
- package/dist/server/unsavedRichText/readContext.js.map +1 -0
- package/dist/server/unsavedRichText/savedReferences.d.ts +5 -0
- package/dist/server/unsavedRichText/savedReferences.js +61 -0
- package/dist/server/unsavedRichText/savedReferences.js.map +1 -0
- package/dist/server/withDocumentControls.d.ts +10 -0
- package/dist/server/withDocumentControls.js +51 -0
- package/dist/server/withDocumentControls.js.map +1 -0
- package/dist/{client → shared}/buildAdminEditUrl.d.ts +3 -2
- package/dist/shared/buildAdminEditUrl.js +14 -0
- package/dist/shared/buildAdminEditUrl.js.map +1 -0
- package/dist/shared/editableSchema/editableSchema.d.ts +26 -0
- package/dist/shared/editableSchema/editableSchema.js +165 -0
- package/dist/shared/editableSchema/editableSchema.js.map +1 -0
- package/dist/shared/editableSchema/schemaOfFields.d.ts +16 -0
- package/dist/shared/editableSchema/schemaOfFields.js +106 -0
- package/dist/shared/editableSchema/schemaOfFields.js.map +1 -0
- package/dist/shared/fieldKey.d.ts +23 -0
- package/dist/shared/fieldKey.js +44 -0
- package/dist/shared/fieldKey.js.map +1 -0
- package/dist/shared/messageSource.d.ts +1 -0
- package/dist/shared/messageSource.js +3 -0
- package/dist/shared/messageSource.js.map +1 -0
- package/dist/shared/packageName.d.ts +1 -0
- package/dist/shared/packageName.js +3 -0
- package/dist/shared/packageName.js.map +1 -0
- package/dist/shared/plainObject.d.ts +2 -0
- package/dist/shared/plainObject.js +3 -0
- package/dist/shared/plainObject.js.map +1 -0
- package/dist/shared/protocol.d.ts +98 -0
- package/dist/shared/protocol.js +32 -0
- package/dist/shared/protocol.js.map +1 -0
- package/dist/shared/richText/blockNodes.d.ts +3 -0
- package/dist/shared/richText/blockNodes.js +35 -0
- package/dist/shared/richText/blockNodes.js.map +1 -0
- package/dist/shared/richText/editorNodes.d.ts +6 -0
- package/dist/shared/richText/editorNodes.js +25 -0
- package/dist/shared/richText/editorNodes.js.map +1 -0
- package/dist/shared/richText/editorStateTree.d.ts +2 -0
- package/dist/shared/richText/editorStateTree.js +34 -0
- package/dist/shared/richText/editorStateTree.js.map +1 -0
- package/dist/shared/richText/markTextLeaves.d.ts +1 -0
- package/dist/shared/richText/markTextLeaves.js +16 -0
- package/dist/shared/richText/markTextLeaves.js.map +1 -0
- package/dist/shared/richText/nodeKey.d.ts +14 -0
- package/dist/shared/richText/nodeKey.js +31 -0
- package/dist/shared/richText/nodeKey.js.map +1 -0
- package/dist/shared/richText/nodeTypes.d.ts +5 -0
- package/dist/shared/richText/nodeTypes.js +20 -0
- package/dist/shared/richText/nodeTypes.js.map +1 -0
- package/dist/shared/richText/references.d.ts +16 -0
- package/dist/shared/richText/references.js +85 -0
- package/dist/shared/richText/references.js.map +1 -0
- package/dist/shared/richText/relatedIds.d.ts +2 -0
- package/dist/shared/richText/relatedIds.js +30 -0
- package/dist/shared/richText/relatedIds.js.map +1 -0
- package/dist/shared/richText/savedNodeFields.d.ts +3 -0
- package/dist/shared/richText/savedNodeFields.js +47 -0
- package/dist/shared/richText/savedNodeFields.js.map +1 -0
- package/dist/shared/richText/shapeOf.d.ts +1 -0
- package/dist/shared/richText/shapeOf.js +24 -0
- package/dist/shared/richText/shapeOf.js.map +1 -0
- package/dist/shared/richText/textLeaves.d.ts +14 -0
- package/dist/shared/richText/textLeaves.js +32 -0
- package/dist/shared/richText/textLeaves.js.map +1 -0
- package/dist/shared/rowWithId.d.ts +2 -0
- package/dist/shared/rowWithId.js +7 -0
- package/dist/shared/rowWithId.js.map +1 -0
- package/dist/shared/shared.d.ts +35 -0
- package/dist/shared/shared.js +83 -0
- package/dist/shared/shared.js.map +1 -0
- package/dist/shared/stegaText.d.ts +3 -0
- package/dist/shared/stegaText.js +8 -0
- package/dist/shared/stegaText.js.map +1 -0
- package/dist/shared/veDocument.d.ts +15 -0
- package/dist/shared/veDocument.js +31 -0
- package/dist/shared/veDocument.js.map +1 -0
- package/dist/stripMarkers.d.ts +1 -0
- package/dist/stripMarkers.js +19 -0
- package/dist/stripMarkers.js.map +1 -0
- package/package.json +31 -10
- package/dist/client/VisualEditingOverlay.js +0 -30
- package/dist/client/VisualEditingOverlay.js.map +0 -1
- package/dist/client/VisualEditingProvider.d.ts +0 -23
- package/dist/client/VisualEditingProvider.js +0 -68
- package/dist/client/VisualEditingProvider.js.map +0 -1
- package/dist/client/VisualEditingToggle.d.ts +0 -1
- package/dist/client/VisualEditingToggle.js +0 -163
- package/dist/client/VisualEditingToggle.js.map +0 -1
- package/dist/client/buildAdminEditUrl.js +0 -9
- package/dist/client/buildAdminEditUrl.js.map +0 -1
- package/dist/client/overlay/createOverlay.d.ts +0 -11
- package/dist/client/overlay/createOverlay.js +0 -99
- package/dist/client/overlay/createOverlay.js.map +0 -1
- package/dist/client/overlay/stegaBookkeeper.d.ts +0 -11
- package/dist/client/overlay/stegaBookkeeper.js +0 -36
- package/dist/client/overlay/stegaBookkeeper.js.map +0 -1
- package/dist/client/overlay/stegaScanner.d.ts +0 -11
- package/dist/client/overlay/stegaScanner.js +0 -54
- package/dist/client/overlay/stegaScanner.js.map +0 -1
- package/dist/client/useVisualEditingOverlay.d.ts +0 -4
- package/dist/client/useVisualEditingOverlay.js +0 -21
- package/dist/client/useVisualEditingOverlay.js.map +0 -1
- package/dist/constants.d.ts +0 -16
- package/dist/constants.js +0 -15
- package/dist/constants.js.map +0 -1
- package/dist/internal/afterOperationHook.d.ts +0 -12
- package/dist/internal/afterOperationHook.js +0 -28
- package/dist/internal/afterOperationHook.js.map +0 -1
- package/dist/internal/afterReadHook.d.ts +0 -3
- package/dist/internal/afterReadHook.js +0 -16
- package/dist/internal/afterReadHook.js.map +0 -1
- package/dist/internal/beforeOperationHook.d.ts +0 -4
- package/dist/internal/beforeOperationHook.js +0 -16
- package/dist/internal/beforeOperationHook.js.map +0 -1
- package/dist/internal/buildFieldSchema.d.ts +0 -3
- package/dist/internal/buildFieldSchema.js +0 -67
- package/dist/internal/buildFieldSchema.js.map +0 -1
- package/dist/internal/encodeStega.d.ts +0 -7
- package/dist/internal/encodeStega.js +0 -171
- package/dist/internal/encodeStega.js.map +0 -1
- package/dist/internal/enrichWithPathMeta.d.ts +0 -4
- package/dist/internal/enrichWithPathMeta.js +0 -76
- package/dist/internal/enrichWithPathMeta.js.map +0 -1
- package/dist/internal/filterEditableFields.d.ts +0 -2
- package/dist/internal/filterEditableFields.js +0 -88
- package/dist/internal/filterEditableFields.js.map +0 -1
- package/dist/internal/gate.d.ts +0 -3
- package/dist/internal/gate.js +0 -16
- package/dist/internal/gate.js.map +0 -1
- package/dist/internal/globalAfterReadHook.d.ts +0 -12
- package/dist/internal/globalAfterReadHook.js +0 -19
- package/dist/internal/globalAfterReadHook.js.map +0 -1
- package/dist/internal/markTerminalUploads.d.ts +0 -13
- package/dist/internal/markTerminalUploads.js +0 -79
- package/dist/internal/markTerminalUploads.js.map +0 -1
- package/dist/internal/schemaCache.d.ts +0 -10
- package/dist/internal/schemaCache.js +0 -29
- package/dist/internal/schemaCache.js.map +0 -1
- package/dist/internal/shared.d.ts +0 -32
- package/dist/internal/shared.js +0 -55
- package/dist/internal/shared.js.map +0 -1
- package/dist/internal/stripStegaHook.js.map +0 -1
- /package/dist/client/{VisualEditingOverlay.d.ts → react/VisualEditingOverlay.d.ts} +0 -0
- /package/dist/{internal → server/hooks}/stripStegaHook.d.ts +0 -0
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { createLatestReads } from "./server/unsavedRichText/latestReads.js";
|
|
2
|
+
import { checkAndSignIn, readUnsaved, 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 readSignedInAsUser = async (payload, signIn, options)=>{
|
|
43
|
+
const signedIn = await nullOnFailure(()=>signIn(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), 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
|
+
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
|
+
const { nothing, signal, stop } = deadlineAfter(timeLimitMs, requestSignal);
|
|
59
|
+
const options = {
|
|
60
|
+
depth,
|
|
61
|
+
maxStateLength,
|
|
62
|
+
readWholeDocument,
|
|
63
|
+
savedReferencesOnly,
|
|
64
|
+
signal,
|
|
65
|
+
timeLimitMs
|
|
66
|
+
};
|
|
67
|
+
try {
|
|
68
|
+
return await Promise.race([
|
|
69
|
+
readSignedInAsUser(payload, signIn, options),
|
|
70
|
+
nothing
|
|
71
|
+
]);
|
|
72
|
+
} finally{
|
|
73
|
+
stop();
|
|
74
|
+
}
|
|
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);
|
|
93
|
+
|
|
94
|
+
//# 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 {\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[];
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { readUnsavedRichTextFor } from "../readUnsavedRichText.js";
|
|
2
|
+
import { readJsonBody } from "./unsavedRichText/jsonBody.js";
|
|
3
|
+
import { isPlainObject } from "../shared/plainObject.js";
|
|
4
|
+
import { VE_PREVIEW_GRANT_PATH, VE_UNSAVED_RICH_TEXT_PATH } from "../shared/protocol.js";
|
|
5
|
+
import { documentAddressOf, isVeDocument, veDocumentOf } from "../shared/veDocument.js";
|
|
6
|
+
import { PREVIEW_GRANT_TTL_MS, readPreviewGrant, signPreviewGrant } from "./previewGrant.js";
|
|
7
|
+
const MAX_BODY_BYTES = 4 * 1024 * 1024;
|
|
8
|
+
export const ENDPOINT_READ_TIME_LIMIT_MS = 8000;
|
|
9
|
+
const BODY_TIME_LIMIT_MS = 10_000;
|
|
10
|
+
const HTML_FORMAT = "html";
|
|
11
|
+
const json = (body, status)=>Response.json(body, {
|
|
12
|
+
headers: {
|
|
13
|
+
"Cache-Control": "no-store"
|
|
14
|
+
},
|
|
15
|
+
status
|
|
16
|
+
});
|
|
17
|
+
const jsonToAnyOrigin = (body, status, req)=>{
|
|
18
|
+
const origin = req.headers.get("Origin");
|
|
19
|
+
const headers = new Headers({
|
|
20
|
+
"Cache-Control": "no-store",
|
|
21
|
+
Vary: "Origin"
|
|
22
|
+
});
|
|
23
|
+
if (origin) headers.set("Access-Control-Allow-Origin", origin);
|
|
24
|
+
return Response.json(body, {
|
|
25
|
+
headers,
|
|
26
|
+
status
|
|
27
|
+
});
|
|
28
|
+
};
|
|
29
|
+
const parsed = (text)=>{
|
|
30
|
+
try {
|
|
31
|
+
return JSON.parse(text);
|
|
32
|
+
} catch {
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
};
|
|
36
|
+
const bodyOf = async (req)=>{
|
|
37
|
+
if (Number(req.headers.get("Content-Length") ?? 0) > MAX_BODY_BYTES) return null;
|
|
38
|
+
if (req.body instanceof ReadableStream) {
|
|
39
|
+
return readJsonBody(req, MAX_BODY_BYTES, AbortSignal.timeout(BODY_TIME_LIMIT_MS));
|
|
40
|
+
}
|
|
41
|
+
const text = req.text ? await req.text() : "";
|
|
42
|
+
return text.length > MAX_BODY_BYTES ? null : parsed(text);
|
|
43
|
+
};
|
|
44
|
+
const grantEndpoint = {
|
|
45
|
+
handler: async (req)=>{
|
|
46
|
+
const { user } = req;
|
|
47
|
+
if (!user) return json({
|
|
48
|
+
grant: null
|
|
49
|
+
}, 401);
|
|
50
|
+
const body = await bodyOf(req);
|
|
51
|
+
if (!isPlainObject(body) || !isVeDocument(body)) return json({
|
|
52
|
+
grant: null
|
|
53
|
+
}, 400);
|
|
54
|
+
const expiresAt = Date.now() + PREVIEW_GRANT_TTL_MS;
|
|
55
|
+
const grant = signPreviewGrant({
|
|
56
|
+
document: documentAddressOf(veDocumentOf(body)),
|
|
57
|
+
expiresAt,
|
|
58
|
+
userCollection: user.collection,
|
|
59
|
+
userId: user.id
|
|
60
|
+
}, req.payload.secret);
|
|
61
|
+
return json({
|
|
62
|
+
expiresAt,
|
|
63
|
+
grant
|
|
64
|
+
}, 200);
|
|
65
|
+
},
|
|
66
|
+
method: "post",
|
|
67
|
+
path: VE_PREVIEW_GRANT_PATH
|
|
68
|
+
};
|
|
69
|
+
const grantedUserOf = async (req, token)=>{
|
|
70
|
+
const grant = readPreviewGrant(token, req.payload.secret, Date.now());
|
|
71
|
+
if (!grant) return null;
|
|
72
|
+
const auth = req.payload.collections[grant.userCollection]?.config.auth;
|
|
73
|
+
if (!auth) return null;
|
|
74
|
+
const user = await req.payload.findByID({
|
|
75
|
+
collection: grant.userCollection,
|
|
76
|
+
depth: auth.depth,
|
|
77
|
+
disableErrors: true,
|
|
78
|
+
id: grant.userId,
|
|
79
|
+
overrideAccess: true
|
|
80
|
+
});
|
|
81
|
+
return user ? {
|
|
82
|
+
document: grant.document,
|
|
83
|
+
user: {
|
|
84
|
+
...user,
|
|
85
|
+
collection: grant.userCollection
|
|
86
|
+
}
|
|
87
|
+
} : null;
|
|
88
|
+
};
|
|
89
|
+
const unsavedRichTextEndpoint = ({ depth, readWholeDocument, renderHtml })=>({
|
|
90
|
+
handler: async (req)=>{
|
|
91
|
+
const body = await bodyOf(req);
|
|
92
|
+
if (!isPlainObject(body)) return jsonToAnyOrigin({
|
|
93
|
+
value: null
|
|
94
|
+
}, 400, req);
|
|
95
|
+
const granted = await grantedUserOf(req, body.grant);
|
|
96
|
+
if (!granted) return jsonToAnyOrigin({
|
|
97
|
+
value: null
|
|
98
|
+
}, 401, req);
|
|
99
|
+
const value = await readUnsavedRichTextFor({
|
|
100
|
+
allows: ({ field })=>documentAddressOf(field) === granted.document,
|
|
101
|
+
depth,
|
|
102
|
+
payload: req.payload,
|
|
103
|
+
readWholeDocument,
|
|
104
|
+
request: body.request,
|
|
105
|
+
timeLimitMs: ENDPOINT_READ_TIME_LIMIT_MS,
|
|
106
|
+
user: granted.user
|
|
107
|
+
});
|
|
108
|
+
if (body.format !== HTML_FORMAT) return jsonToAnyOrigin({
|
|
109
|
+
value
|
|
110
|
+
}, 200, req);
|
|
111
|
+
if (value === null || !renderHtml || !isPlainObject(body.request)) {
|
|
112
|
+
return jsonToAnyOrigin({
|
|
113
|
+
html: null
|
|
114
|
+
}, 200, req);
|
|
115
|
+
}
|
|
116
|
+
const request = body.request;
|
|
117
|
+
req.user = granted.user;
|
|
118
|
+
const html = await renderHtml({
|
|
119
|
+
field: request.field,
|
|
120
|
+
locale: request.locale,
|
|
121
|
+
req,
|
|
122
|
+
value
|
|
123
|
+
});
|
|
124
|
+
return jsonToAnyOrigin({
|
|
125
|
+
html
|
|
126
|
+
}, 200, req);
|
|
127
|
+
},
|
|
128
|
+
method: "post",
|
|
129
|
+
path: VE_UNSAVED_RICH_TEXT_PATH
|
|
130
|
+
});
|
|
131
|
+
export const visualEditingEndpoints = (options)=>[
|
|
132
|
+
grantEndpoint,
|
|
133
|
+
unsavedRichTextEndpoint(options)
|
|
134
|
+
];
|
|
135
|
+
|
|
136
|
+
//# sourceMappingURL=endpoints.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/server/endpoints.ts"],"sourcesContent":["import type { Endpoint, PayloadRequest } from \"payload\";\n\nimport type { LiveRichTextField } from \"../shared/protocol.js\";\nimport type { UnsavedRichTextDepth } from \"./unsavedRichText/readAsUser.js\";\n\nimport { readUnsavedRichTextFor } from \"../readUnsavedRichText.js\";\nimport { readJsonBody } from \"./unsavedRichText/jsonBody.js\";\nimport { isPlainObject } from \"../shared/plainObject.js\";\nimport { VE_PREVIEW_GRANT_PATH, VE_UNSAVED_RICH_TEXT_PATH } from \"../shared/protocol.js\";\nimport { documentAddressOf, isVeDocument, veDocumentOf } from \"../shared/veDocument.js\";\nimport { PREVIEW_GRANT_TTL_MS, readPreviewGrant, signPreviewGrant } from \"./previewGrant.js\";\n\nexport type RenderHtml = (args: {\n value: unknown;\n field: LiveRichTextField;\n locale: string | undefined;\n req: PayloadRequest;\n}) => string | Promise<string>;\n\nexport type UnsavedRichTextEndpointOptions = {\n depth?: UnsavedRichTextDepth;\n readWholeDocument?: boolean;\n renderHtml?: RenderHtml;\n};\n\nconst MAX_BODY_BYTES = 4 * 1024 * 1024;\nexport const ENDPOINT_READ_TIME_LIMIT_MS = 8000;\nconst BODY_TIME_LIMIT_MS = 10_000;\nconst HTML_FORMAT = \"html\";\n\nconst json = (body: unknown, status: number): Response =>\n Response.json(body, { headers: { \"Cache-Control\": \"no-store\" }, status });\n\nconst jsonToAnyOrigin = (body: unknown, status: number, req: PayloadRequest): Response => {\n const origin = req.headers.get(\"Origin\");\n const headers = new Headers({ \"Cache-Control\": \"no-store\", Vary: \"Origin\" });\n if (origin) headers.set(\"Access-Control-Allow-Origin\", origin);\n return Response.json(body, { headers, status });\n};\n\nconst parsed = (text: string): unknown => {\n try {\n return JSON.parse(text);\n } catch {\n return null;\n }\n};\n\nconst bodyOf = async (req: PayloadRequest): Promise<unknown> => {\n if (Number(req.headers.get(\"Content-Length\") ?? 0) > MAX_BODY_BYTES) return null;\n if (req.body instanceof ReadableStream) {\n return readJsonBody(req as Request, MAX_BODY_BYTES, AbortSignal.timeout(BODY_TIME_LIMIT_MS));\n }\n const text = req.text ? await req.text() : \"\";\n return text.length > MAX_BODY_BYTES ? null : parsed(text);\n};\n\nconst grantEndpoint: Endpoint = {\n handler: async (req) => {\n const { user } = req;\n if (!user) return json({ grant: null }, 401);\n const body = await bodyOf(req);\n if (!isPlainObject(body) || !isVeDocument(body)) return json({ grant: null }, 400);\n\n const expiresAt = Date.now() + PREVIEW_GRANT_TTL_MS;\n const grant = signPreviewGrant(\n {\n document: documentAddressOf(veDocumentOf(body)),\n expiresAt,\n userCollection: user.collection,\n userId: user.id,\n },\n req.payload.secret\n );\n return json({ expiresAt, grant }, 200);\n },\n method: \"post\",\n path: VE_PREVIEW_GRANT_PATH,\n};\n\nconst grantedUserOf = async (req: PayloadRequest, token: unknown) => {\n const grant = readPreviewGrant(token, req.payload.secret, Date.now());\n if (!grant) return null;\n const auth = req.payload.collections[grant.userCollection]?.config.auth;\n if (!auth) return null;\n const user = await req.payload.findByID({\n collection: grant.userCollection,\n depth: auth.depth,\n disableErrors: true,\n id: grant.userId,\n overrideAccess: true,\n });\n return user\n ? { document: grant.document, user: { ...user, collection: grant.userCollection } }\n : null;\n};\n\nconst unsavedRichTextEndpoint = ({\n depth,\n readWholeDocument,\n renderHtml,\n}: UnsavedRichTextEndpointOptions): Endpoint => ({\n handler: async (req) => {\n const body = await bodyOf(req);\n if (!isPlainObject(body)) return jsonToAnyOrigin({ value: null }, 400, req);\n\n const granted = await grantedUserOf(req, body.grant);\n if (!granted) return jsonToAnyOrigin({ value: null }, 401, req);\n\n const value = await readUnsavedRichTextFor({\n allows: ({ field }) => documentAddressOf(field) === granted.document,\n depth,\n payload: req.payload,\n readWholeDocument,\n request: body.request,\n timeLimitMs: ENDPOINT_READ_TIME_LIMIT_MS,\n user: granted.user as Parameters<typeof readUnsavedRichTextFor>[0][\"user\"],\n });\n if (body.format !== HTML_FORMAT) return jsonToAnyOrigin({ value }, 200, req);\n if (value === null || !renderHtml || !isPlainObject(body.request)) {\n return jsonToAnyOrigin({ html: null }, 200, req);\n }\n\n const request = body.request as { field: LiveRichTextField; locale?: string };\n req.user = granted.user as PayloadRequest[\"user\"];\n const html = await renderHtml({ field: request.field, locale: request.locale, req, value });\n return jsonToAnyOrigin({ html }, 200, req);\n },\n method: \"post\",\n path: VE_UNSAVED_RICH_TEXT_PATH,\n});\n\nexport const visualEditingEndpoints = (options: UnsavedRichTextEndpointOptions): Endpoint[] => [\n grantEndpoint,\n unsavedRichTextEndpoint(options),\n];\n"],"names":["readUnsavedRichTextFor","readJsonBody","isPlainObject","VE_PREVIEW_GRANT_PATH","VE_UNSAVED_RICH_TEXT_PATH","documentAddressOf","isVeDocument","veDocumentOf","PREVIEW_GRANT_TTL_MS","readPreviewGrant","signPreviewGrant","MAX_BODY_BYTES","ENDPOINT_READ_TIME_LIMIT_MS","BODY_TIME_LIMIT_MS","HTML_FORMAT","json","body","status","Response","headers","jsonToAnyOrigin","req","origin","get","Headers","Vary","set","parsed","text","JSON","parse","bodyOf","Number","ReadableStream","AbortSignal","timeout","length","grantEndpoint","handler","user","grant","expiresAt","Date","now","document","userCollection","collection","userId","id","payload","secret","method","path","grantedUserOf","token","auth","collections","config","findByID","depth","disableErrors","overrideAccess","unsavedRichTextEndpoint","readWholeDocument","renderHtml","value","granted","allows","field","request","timeLimitMs","format","html","locale","visualEditingEndpoints","options"],"mappings":"AAKA,SAASA,sBAAsB,QAAQ,4BAA4B;AACnE,SAASC,YAAY,QAAQ,gCAAgC;AAC7D,SAASC,aAAa,QAAQ,2BAA2B;AACzD,SAASC,qBAAqB,EAAEC,yBAAyB,QAAQ,wBAAwB;AACzF,SAASC,iBAAiB,EAAEC,YAAY,EAAEC,YAAY,QAAQ,0BAA0B;AACxF,SAASC,oBAAoB,EAAEC,gBAAgB,EAAEC,gBAAgB,QAAQ,oBAAoB;AAe7F,MAAMC,iBAAiB,IAAI,OAAO;AAClC,OAAO,MAAMC,8BAA8B,KAAK;AAChD,MAAMC,qBAAqB;AAC3B,MAAMC,cAAc;AAEpB,MAAMC,OAAO,CAACC,MAAeC,SAC3BC,SAASH,IAAI,CAACC,MAAM;QAAEG,SAAS;YAAE,iBAAiB;QAAW;QAAGF;IAAO;AAEzE,MAAMG,kBAAkB,CAACJ,MAAeC,QAAgBI;IACtD,MAAMC,SAASD,IAAIF,OAAO,CAACI,GAAG,CAAC;IAC/B,MAAMJ,UAAU,IAAIK,QAAQ;QAAE,iBAAiB;QAAYC,MAAM;IAAS;IAC1E,IAAIH,QAAQH,QAAQO,GAAG,CAAC,+BAA+BJ;IACvD,OAAOJ,SAASH,IAAI,CAACC,MAAM;QAAEG;QAASF;IAAO;AAC/C;AAEA,MAAMU,SAAS,CAACC;IACd,IAAI;QACF,OAAOC,KAAKC,KAAK,CAACF;IACpB,EAAE,OAAM;QACN,OAAO;IACT;AACF;AAEA,MAAMG,SAAS,OAAOV;IACpB,IAAIW,OAAOX,IAAIF,OAAO,CAACI,GAAG,CAAC,qBAAqB,KAAKZ,gBAAgB,OAAO;IAC5E,IAAIU,IAAIL,IAAI,YAAYiB,gBAAgB;QACtC,OAAOhC,aAAaoB,KAAgBV,gBAAgBuB,YAAYC,OAAO,CAACtB;IAC1E;IACA,MAAMe,OAAOP,IAAIO,IAAI,GAAG,MAAMP,IAAIO,IAAI,KAAK;IAC3C,OAAOA,KAAKQ,MAAM,GAAGzB,iBAAiB,OAAOgB,OAAOC;AACtD;AAEA,MAAMS,gBAA0B;IAC9BC,SAAS,OAAOjB;QACd,MAAM,EAAEkB,IAAI,EAAE,GAAGlB;QACjB,IAAI,CAACkB,MAAM,OAAOxB,KAAK;YAAEyB,OAAO;QAAK,GAAG;QACxC,MAAMxB,OAAO,MAAMe,OAAOV;QAC1B,IAAI,CAACnB,cAAcc,SAAS,CAACV,aAAaU,OAAO,OAAOD,KAAK;YAAEyB,OAAO;QAAK,GAAG;QAE9E,MAAMC,YAAYC,KAAKC,GAAG,KAAKnC;QAC/B,MAAMgC,QAAQ9B,iBACZ;YACEkC,UAAUvC,kBAAkBE,aAAaS;YACzCyB;YACAI,gBAAgBN,KAAKO,UAAU;YAC/BC,QAAQR,KAAKS,EAAE;QACjB,GACA3B,IAAI4B,OAAO,CAACC,MAAM;QAEpB,OAAOnC,KAAK;YAAE0B;YAAWD;QAAM,GAAG;IACpC;IACAW,QAAQ;IACRC,MAAMjD;AACR;AAEA,MAAMkD,gBAAgB,OAAOhC,KAAqBiC;IAChD,MAAMd,QAAQ/B,iBAAiB6C,OAAOjC,IAAI4B,OAAO,CAACC,MAAM,EAAER,KAAKC,GAAG;IAClE,IAAI,CAACH,OAAO,OAAO;IACnB,MAAMe,OAAOlC,IAAI4B,OAAO,CAACO,WAAW,CAAChB,MAAMK,cAAc,CAAC,EAAEY,OAAOF;IACnE,IAAI,CAACA,MAAM,OAAO;IAClB,MAAMhB,OAAO,MAAMlB,IAAI4B,OAAO,CAACS,QAAQ,CAAC;QACtCZ,YAAYN,MAAMK,cAAc;QAChCc,OAAOJ,KAAKI,KAAK;QACjBC,eAAe;QACfZ,IAAIR,MAAMO,MAAM;QAChBc,gBAAgB;IAClB;IACA,OAAOtB,OACH;QAAEK,UAAUJ,MAAMI,QAAQ;QAAEL,MAAM;YAAE,GAAGA,IAAI;YAAEO,YAAYN,MAAMK,cAAc;QAAC;IAAE,IAChF;AACN;AAEA,MAAMiB,0BAA0B,CAAC,EAC/BH,KAAK,EACLI,iBAAiB,EACjBC,UAAU,EACqB,GAAgB,CAAA;QAC/C1B,SAAS,OAAOjB;YACd,MAAML,OAAO,MAAMe,OAAOV;YAC1B,IAAI,CAACnB,cAAcc,OAAO,OAAOI,gBAAgB;gBAAE6C,OAAO;YAAK,GAAG,KAAK5C;YAEvE,MAAM6C,UAAU,MAAMb,cAAchC,KAAKL,KAAKwB,KAAK;YACnD,IAAI,CAAC0B,SAAS,OAAO9C,gBAAgB;gBAAE6C,OAAO;YAAK,GAAG,KAAK5C;YAE3D,MAAM4C,QAAQ,MAAMjE,uBAAuB;gBACzCmE,QAAQ,CAAC,EAAEC,KAAK,EAAE,GAAK/D,kBAAkB+D,WAAWF,QAAQtB,QAAQ;gBACpEe;gBACAV,SAAS5B,IAAI4B,OAAO;gBACpBc;gBACAM,SAASrD,KAAKqD,OAAO;gBACrBC,aAAa1D;gBACb2B,MAAM2B,QAAQ3B,IAAI;YACpB;YACA,IAAIvB,KAAKuD,MAAM,KAAKzD,aAAa,OAAOM,gBAAgB;gBAAE6C;YAAM,GAAG,KAAK5C;YACxE,IAAI4C,UAAU,QAAQ,CAACD,cAAc,CAAC9D,cAAcc,KAAKqD,OAAO,GAAG;gBACjE,OAAOjD,gBAAgB;oBAAEoD,MAAM;gBAAK,GAAG,KAAKnD;YAC9C;YAEA,MAAMgD,UAAUrD,KAAKqD,OAAO;YAC5BhD,IAAIkB,IAAI,GAAG2B,QAAQ3B,IAAI;YACvB,MAAMiC,OAAO,MAAMR,WAAW;gBAAEI,OAAOC,QAAQD,KAAK;gBAAEK,QAAQJ,QAAQI,MAAM;gBAAEpD;gBAAK4C;YAAM;YACzF,OAAO7C,gBAAgB;gBAAEoD;YAAK,GAAG,KAAKnD;QACxC;QACA8B,QAAQ;QACRC,MAAMhD;IACR,CAAA;AAEA,OAAO,MAAMsE,yBAAyB,CAACC,UAAwD;QAC7FtC;QACAyB,wBAAwBa;KACzB,CAAC"}
|
|
@@ -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 {
|
|
2
|
-
import {
|
|
3
|
-
|
|
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] =
|
|
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] =
|
|
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;
|