@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
|
@@ -1,9 +1,13 @@
|
|
|
1
|
-
import { DATA_VE_COLLECTION_ATTR, DATA_VE_DOC_ID_ATTR, DATA_VE_KIND_ATTR, DATA_VE_PATH_ATTR } from "../
|
|
1
|
+
import { DATA_VE_COLLECTION_ATTR, DATA_VE_DOC_ID_ATTR, DATA_VE_KEY_ATTR, DATA_VE_KIND_ATTR, DATA_VE_LOCALE_ATTR, DATA_VE_PATH_ATTR } from "../shared/protocol.js";
|
|
2
|
+
import type { VeIdentity } from "../shared/shared.js";
|
|
2
3
|
type Attrs = Partial<{
|
|
3
4
|
[DATA_VE_PATH_ATTR]: string;
|
|
4
5
|
[DATA_VE_DOC_ID_ATTR]: string;
|
|
5
6
|
[DATA_VE_COLLECTION_ATTR]: string;
|
|
6
7
|
[DATA_VE_KIND_ATTR]: string;
|
|
8
|
+
[DATA_VE_LOCALE_ATTR]: string;
|
|
9
|
+
[DATA_VE_KEY_ATTR]: string;
|
|
7
10
|
}>;
|
|
11
|
+
export declare const identityAttrsOf: ({ collectionSlug, docId, key, kind, locale, path, }: VeIdentity) => Attrs;
|
|
8
12
|
export declare const withVisualEditingPath: (value: unknown) => Attrs;
|
|
9
13
|
export {};
|
|
@@ -1,17 +1,23 @@
|
|
|
1
|
-
import { DATA_VE_COLLECTION_ATTR, DATA_VE_DOC_ID_ATTR, DATA_VE_KIND_ATTR, DATA_VE_PATH_ATTR } from "../
|
|
2
|
-
import { isMetaInfo } from "../
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
...
|
|
12
|
-
[
|
|
1
|
+
import { DATA_VE_COLLECTION_ATTR, DATA_VE_DOC_ID_ATTR, DATA_VE_KEY_ATTR, DATA_VE_KIND_ATTR, DATA_VE_LOCALE_ATTR, DATA_VE_PATH_ATTR } from "../shared/protocol.js";
|
|
2
|
+
import { isMetaInfo, META_KEY, veIdentityOf } from "../shared/shared.js";
|
|
3
|
+
import { isPlainObject } from "../shared/plainObject.js";
|
|
4
|
+
export const identityAttrsOf = ({ collectionSlug, docId, key, kind, locale, path })=>({
|
|
5
|
+
[DATA_VE_PATH_ATTR]: path,
|
|
6
|
+
[DATA_VE_COLLECTION_ATTR]: collectionSlug,
|
|
7
|
+
[DATA_VE_KIND_ATTR]: kind,
|
|
8
|
+
...docId !== undefined && {
|
|
9
|
+
[DATA_VE_DOC_ID_ATTR]: docId
|
|
10
|
+
},
|
|
11
|
+
...locale !== undefined && {
|
|
12
|
+
[DATA_VE_LOCALE_ATTR]: locale
|
|
13
|
+
},
|
|
14
|
+
...key !== undefined && {
|
|
15
|
+
[DATA_VE_KEY_ATTR]: key
|
|
13
16
|
}
|
|
14
|
-
};
|
|
17
|
+
});
|
|
18
|
+
export const withVisualEditingPath = (value)=>{
|
|
19
|
+
const meta = isPlainObject(value) ? value[META_KEY] : undefined;
|
|
20
|
+
return isMetaInfo(meta) ? identityAttrsOf(veIdentityOf(meta)) : {};
|
|
15
21
|
};
|
|
16
22
|
|
|
17
23
|
//# sourceMappingURL=withVisualEditingPath.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/withVisualEditingPath.ts"],"sourcesContent":["import {\n DATA_VE_COLLECTION_ATTR,\n DATA_VE_DOC_ID_ATTR,\n DATA_VE_KIND_ATTR,\n DATA_VE_PATH_ATTR,\n} from \"../
|
|
1
|
+
{"version":3,"sources":["../../src/client/withVisualEditingPath.ts"],"sourcesContent":["import {\n DATA_VE_COLLECTION_ATTR,\n DATA_VE_DOC_ID_ATTR,\n DATA_VE_KEY_ATTR,\n DATA_VE_KIND_ATTR,\n DATA_VE_LOCALE_ATTR,\n DATA_VE_PATH_ATTR,\n} from \"../shared/protocol.js\";\nimport type { VeIdentity } from \"../shared/shared.js\";\n\nimport { isMetaInfo, META_KEY, veIdentityOf } from \"../shared/shared.js\";\nimport { isPlainObject } from \"../shared/plainObject.js\";\n\ntype Attrs = Partial<{\n [DATA_VE_PATH_ATTR]: string;\n [DATA_VE_DOC_ID_ATTR]: string;\n [DATA_VE_COLLECTION_ATTR]: string;\n [DATA_VE_KIND_ATTR]: string;\n [DATA_VE_LOCALE_ATTR]: string;\n [DATA_VE_KEY_ATTR]: string;\n}>;\n\nexport const identityAttrsOf = ({\n collectionSlug,\n docId,\n key,\n kind,\n locale,\n path,\n}: VeIdentity): Attrs => ({\n [DATA_VE_PATH_ATTR]: path,\n [DATA_VE_COLLECTION_ATTR]: collectionSlug,\n [DATA_VE_KIND_ATTR]: kind,\n ...(docId !== undefined && { [DATA_VE_DOC_ID_ATTR]: docId }),\n ...(locale !== undefined && { [DATA_VE_LOCALE_ATTR]: locale }),\n ...(key !== undefined && { [DATA_VE_KEY_ATTR]: key }),\n});\n\nexport const withVisualEditingPath = (value: unknown): Attrs => {\n const meta = isPlainObject(value) ? value[META_KEY] : undefined;\n return isMetaInfo(meta) ? identityAttrsOf(veIdentityOf(meta)) : {};\n};\n"],"names":["DATA_VE_COLLECTION_ATTR","DATA_VE_DOC_ID_ATTR","DATA_VE_KEY_ATTR","DATA_VE_KIND_ATTR","DATA_VE_LOCALE_ATTR","DATA_VE_PATH_ATTR","isMetaInfo","META_KEY","veIdentityOf","isPlainObject","identityAttrsOf","collectionSlug","docId","key","kind","locale","path","undefined","withVisualEditingPath","value","meta"],"mappings":"AAAA,SACEA,uBAAuB,EACvBC,mBAAmB,EACnBC,gBAAgB,EAChBC,iBAAiB,EACjBC,mBAAmB,EACnBC,iBAAiB,QACZ,wBAAwB;AAG/B,SAASC,UAAU,EAAEC,QAAQ,EAAEC,YAAY,QAAQ,sBAAsB;AACzE,SAASC,aAAa,QAAQ,2BAA2B;AAWzD,OAAO,MAAMC,kBAAkB,CAAC,EAC9BC,cAAc,EACdC,KAAK,EACLC,GAAG,EACHC,IAAI,EACJC,MAAM,EACNC,IAAI,EACO,GAAa,CAAA;QACxB,CAACX,kBAAkB,EAAEW;QACrB,CAAChB,wBAAwB,EAAEW;QAC3B,CAACR,kBAAkB,EAAEW;QACrB,GAAIF,UAAUK,aAAa;YAAE,CAAChB,oBAAoB,EAAEW;QAAM,CAAC;QAC3D,GAAIG,WAAWE,aAAa;YAAE,CAACb,oBAAoB,EAAEW;QAAO,CAAC;QAC7D,GAAIF,QAAQI,aAAa;YAAE,CAACf,iBAAiB,EAAEW;QAAI,CAAC;IACtD,CAAA,EAAG;AAEH,OAAO,MAAMK,wBAAwB,CAACC;IACpC,MAAMC,OAAOX,cAAcU,SAASA,KAAK,CAACZ,SAAS,GAAGU;IACtD,OAAOX,WAAWc,QAAQV,gBAAgBF,aAAaY,SAAS,CAAC;AACnE,EAAE"}
|
|
@@ -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"}
|
package/dist/excludeValues.js
CHANGED
|
@@ -1,18 +1,6 @@
|
|
|
1
|
-
// URL-like: absolute URLs with any scheme (`https://`, `mailto:`, `tel:`, `data:`, `file://`),
|
|
2
|
-
// protocol-relative (`//cdn`), or root-relative (`/path`). Encoding stega into URLs corrupts
|
|
3
|
-
// them when the string lands in an `href` — the zero-width chars percent-encode into garbage.
|
|
4
1
|
export const isUrl = (value)=>/^(?:[a-z][a-z0-9+.-]*:|\/\/|\/)/i.test(value);
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
// — matches `state-of-the-art` too; users who want those editable can override via the
|
|
8
|
-
// excludeValues config.
|
|
9
|
-
export const isSlug = (value)=>/^[a-z0-9]+(-[a-z0-9]+)+$/.test(value);
|
|
10
|
-
// Hash-prefixed fragment URLs (`#`, `#demo`, `#section-1`). The `(?!\d+$)` carves out
|
|
11
|
-
// `#<number>` ranking text (`#1`, `#42`) so it stays editable. `#1a` or `#1 seed` still
|
|
12
|
-
// match — the rule is "hash followed by a purely numeric tail is NOT a fragment."
|
|
13
|
-
export const isHash = (value)=>/^#(?!\d+$)/.test(value);
|
|
14
|
-
// Strict ISO 8601 timestamps. Matches `YYYY-MM-DD` and the full `YYYY-MM-DDThh:mm:ss(.fff)?(Z|+hh:mm)?`
|
|
15
|
-
// shape. Does not match `YYYY` or `YYYY-MM` — those are too easily confused with regular content.
|
|
2
|
+
export const isSlug = (value)=>/^(?=.*[a-z])[a-z0-9]+(-[a-z0-9]+)+$/.test(value);
|
|
3
|
+
export const isHash = (value)=>/^#(?!\d+$)\S*$/.test(value);
|
|
16
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);
|
|
17
5
|
export const defaultExcludeValues = [
|
|
18
6
|
isUrl,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/excludeValues.ts"],"sourcesContent":["export type ValueExcludePredicate = (value: string) => boolean;\n\
|
|
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,7 +1,12 @@
|
|
|
1
1
|
import type { Plugin } from "payload";
|
|
2
2
|
import type { ValueExcludePredicate } from "./excludeValues.js";
|
|
3
|
-
import type { Enrichment } from "./
|
|
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";
|
|
6
|
+
export { stripMarkers } from "./stripMarkers.js";
|
|
7
|
+
export { DEFAULT_MAX_UNSAVED_STATE_LENGTH, DEFAULT_UNSAVED_READ_TIME_LIMIT_MS, readUnsavedRichText, type ReadUnsavedRichTextArgs, type UnsavedRichTextDepth, } from "./readUnsavedRichText.js";
|
|
8
|
+
export { isUnsavedRichTextRead } from "./server/unsavedRichText/readContext.js";
|
|
9
|
+
export type { LiveRichTextField, LiveRichTextRequest } from "./shared/protocol.js";
|
|
5
10
|
declare module "payload" {
|
|
6
11
|
interface RequestContext {
|
|
7
12
|
visualEditing?: boolean;
|
|
@@ -18,5 +23,9 @@ export type VisualEditingPluginConfig = {
|
|
|
18
23
|
/** `'auto'` (default) enriches any Local API draft read outside the admin.
|
|
19
24
|
* `'explicit'` enriches only reads that pass `context: { visualEditing: true }`. */
|
|
20
25
|
enrichment?: Enrichment;
|
|
26
|
+
instantPreview?: boolean;
|
|
27
|
+
renderHtml?: RenderHtml;
|
|
28
|
+
readWholeDocument?: boolean;
|
|
21
29
|
};
|
|
30
|
+
export type { RenderHtml } from "./server/endpoints.js";
|
|
22
31
|
export declare const visualEditingPlugin: (pluginConfig?: VisualEditingPluginConfig) => Plugin;
|
package/dist/index.js
CHANGED
|
@@ -1,18 +1,22 @@
|
|
|
1
|
+
import { PACKAGE_NAME } from "./shared/packageName.js";
|
|
1
2
|
import { defaultExcludeValues } from "./excludeValues.js";
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
3
|
+
import { createReadHooks } from "./server/hooks/readHooks.js";
|
|
4
|
+
import { createGlobalUnsavedRichTextHook, createUnsavedRichTextHook } from "./server/unsavedRichText/hooks.js";
|
|
5
|
+
import { createSchemaCache, withSchemaCache } from "./server/schemaCache.js";
|
|
6
|
+
import { createStripStegaHook } from "./server/hooks/stripStegaHook.js";
|
|
7
|
+
import { visualEditingEndpoints } from "./server/endpoints.js";
|
|
8
|
+
import { withDocumentControlsCollection, withDocumentControlsGlobal } from "./server/withDocumentControls.js";
|
|
8
9
|
export { defaultExcludeValues, isHash, isIsoDate, isSlug, isUrl } from "./excludeValues.js";
|
|
10
|
+
export { stripMarkers } from "./stripMarkers.js";
|
|
11
|
+
export { DEFAULT_MAX_UNSAVED_STATE_LENGTH, DEFAULT_UNSAVED_READ_TIME_LIMIT_MS, readUnsavedRichText } from "./readUnsavedRichText.js";
|
|
12
|
+
export { isUnsavedRichTextRead } from "./server/unsavedRichText/readContext.js";
|
|
9
13
|
const INTERNAL_COLLECTIONS = [
|
|
10
14
|
"payload-preferences",
|
|
11
15
|
"payload-migrations",
|
|
12
16
|
"payload-locked-documents",
|
|
13
17
|
"payload-jobs"
|
|
14
18
|
];
|
|
15
|
-
const BRIDGE_COMPONENT_PATH =
|
|
19
|
+
const BRIDGE_COMPONENT_PATH = `${PACKAGE_NAME}/admin#VisualEditingBridgeProvider`;
|
|
16
20
|
export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
|
|
17
21
|
const skipCols = new Set([
|
|
18
22
|
...INTERNAL_COLLECTIONS,
|
|
@@ -22,61 +26,75 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
|
|
|
22
26
|
const adminBasePath = pluginConfig.adminBasePath ?? "/admin";
|
|
23
27
|
const excludeValues = pluginConfig.excludeValues ?? defaultExcludeValues;
|
|
24
28
|
const enrichment = pluginConfig.enrichment ?? "auto";
|
|
29
|
+
const instantPreview = pluginConfig.instantPreview ?? false;
|
|
30
|
+
const excludeFieldNames = pluginConfig.excludeFieldNames ?? [];
|
|
31
|
+
const documentControlsOptions = {
|
|
32
|
+
excludeFieldNames,
|
|
33
|
+
instantPreview,
|
|
34
|
+
rootLivePreview: config.admin?.livePreview
|
|
35
|
+
};
|
|
25
36
|
const schemaCache = createSchemaCache({
|
|
26
|
-
excludeFieldNames
|
|
27
|
-
});
|
|
28
|
-
const beforeOperation = createBeforeOperationHook();
|
|
29
|
-
const afterRead = createAfterReadHook(adminBasePath, enrichment);
|
|
30
|
-
const afterOperation = createAfterOperationHook({
|
|
31
|
-
schemaCache,
|
|
32
|
-
excludeValues,
|
|
33
|
-
adminBasePath,
|
|
34
|
-
enrichment
|
|
37
|
+
excludeFieldNames
|
|
35
38
|
});
|
|
36
|
-
const
|
|
37
|
-
const globalAfterRead = createGlobalAfterReadHook({
|
|
39
|
+
const { collectionAfterOperation, globalAfterRead, globalBeforeOperation } = createReadHooks({
|
|
38
40
|
schemaCache,
|
|
39
41
|
excludeValues,
|
|
40
42
|
adminBasePath,
|
|
41
|
-
enrichment
|
|
43
|
+
enrichment,
|
|
44
|
+
instantPreview
|
|
42
45
|
});
|
|
43
46
|
const stripStega = createStripStegaHook();
|
|
47
|
+
const unsavedRichText = instantPreview ? [
|
|
48
|
+
createUnsavedRichTextHook(schemaCache)
|
|
49
|
+
] : [];
|
|
50
|
+
const globalUnsavedRichText = instantPreview ? [
|
|
51
|
+
createGlobalUnsavedRichTextHook(schemaCache)
|
|
52
|
+
] : [];
|
|
44
53
|
return {
|
|
45
54
|
...config,
|
|
55
|
+
endpoints: instantPreview ? [
|
|
56
|
+
...config.endpoints ?? [],
|
|
57
|
+
...visualEditingEndpoints({
|
|
58
|
+
readWholeDocument: pluginConfig.readWholeDocument,
|
|
59
|
+
renderHtml: pluginConfig.renderHtml
|
|
60
|
+
})
|
|
61
|
+
] : config.endpoints,
|
|
62
|
+
custom: instantPreview ? withSchemaCache(config.custom, schemaCache) : config.custom,
|
|
46
63
|
collections: config.collections?.map((collection)=>{
|
|
47
64
|
if (skipCols.has(collection.slug)) return collection;
|
|
48
|
-
|
|
65
|
+
const withHooks = {
|
|
49
66
|
...collection,
|
|
50
67
|
hooks: {
|
|
51
68
|
...collection.hooks,
|
|
52
|
-
beforeOperation: [
|
|
53
|
-
...collection.hooks?.beforeOperation ?? [],
|
|
54
|
-
beforeOperation
|
|
55
|
-
],
|
|
56
69
|
beforeChange: [
|
|
57
70
|
...collection.hooks?.beforeChange ?? [],
|
|
58
71
|
stripStega
|
|
59
72
|
],
|
|
60
|
-
|
|
61
|
-
...collection.hooks?.
|
|
62
|
-
|
|
73
|
+
beforeRead: [
|
|
74
|
+
...collection.hooks?.beforeRead ?? [],
|
|
75
|
+
...unsavedRichText
|
|
63
76
|
],
|
|
64
77
|
afterOperation: [
|
|
65
78
|
...collection.hooks?.afterOperation ?? [],
|
|
66
|
-
|
|
79
|
+
collectionAfterOperation
|
|
67
80
|
]
|
|
68
81
|
}
|
|
69
82
|
};
|
|
83
|
+
return withDocumentControlsCollection(withHooks, documentControlsOptions);
|
|
70
84
|
}),
|
|
71
85
|
globals: config.globals?.map((global)=>{
|
|
72
86
|
if (skipGlobals.has(global.slug)) return global;
|
|
73
|
-
|
|
87
|
+
const withHooks = {
|
|
74
88
|
...global,
|
|
75
89
|
hooks: {
|
|
76
90
|
...global.hooks,
|
|
91
|
+
beforeOperation: [
|
|
92
|
+
...global.hooks?.beforeOperation ?? [],
|
|
93
|
+
globalBeforeOperation
|
|
94
|
+
],
|
|
77
95
|
beforeRead: [
|
|
78
96
|
...global.hooks?.beforeRead ?? [],
|
|
79
|
-
|
|
97
|
+
...globalUnsavedRichText
|
|
80
98
|
],
|
|
81
99
|
beforeChange: [
|
|
82
100
|
...global.hooks?.beforeChange ?? [],
|
|
@@ -88,6 +106,7 @@ export const visualEditingPlugin = (pluginConfig = {})=>(config)=>{
|
|
|
88
106
|
]
|
|
89
107
|
}
|
|
90
108
|
};
|
|
109
|
+
return withDocumentControlsGlobal(withHooks, documentControlsOptions);
|
|
91
110
|
}),
|
|
92
111
|
admin: {
|
|
93
112
|
...config.admin,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Plugin } from \"payload\";\n\nimport type { ValueExcludePredicate } from \"./excludeValues.js\";\nimport type { Enrichment } from \"./
|
|
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"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { Payload } from "payload";
|
|
2
|
+
import type { PostedRequest, SignedIn, Unsaved } from "./server/unsavedRichText/postedRequest.js";
|
|
3
|
+
import type { UnsavedRichTextDepth } from "./server/unsavedRichText/readAsUser.js";
|
|
4
|
+
export type { UnsavedRichTextDepth } from "./server/unsavedRichText/readAsUser.js";
|
|
5
|
+
export declare const DEFAULT_MAX_UNSAVED_STATE_LENGTH = 1000000;
|
|
6
|
+
export declare const DEFAULT_UNSAVED_READ_TIME_LIMIT_MS = 3000;
|
|
7
|
+
export type ReadUnsavedRichTextArgs = PostedRequest & {
|
|
8
|
+
payload: Payload;
|
|
9
|
+
depth?: UnsavedRichTextDepth;
|
|
10
|
+
maxStateLength?: number;
|
|
11
|
+
timeLimitMs?: number;
|
|
12
|
+
readWholeDocument?: boolean;
|
|
13
|
+
};
|
|
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>;
|