chore(live-preview): strongly types message events #10148
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacobsfletch
changed the title
|
🚀 This is included in version v3.12.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Live Preview message events were typed with the generic
MessageEventinterface without passing any of the Live Preview specific properties, leading to unknown types upon use. To fix this, there is a newLivePreviewMessageEventwhich properly extends the underlyingMessageEventinterface, providing much needed type safety to these functions. In the same vein, theUpdatedDocumenttype was not being properly shared across packages, leading to multiple independent definitions of this type. This type is now exported frompayloaditself and renamed toDocumentEventfor improved semantics. Same with theFieldSchemaJSONtype. This PR also adjusts where globally scoped variables are set, putting them within the shared_payloadLivePreviewnamespace instead of setting them individually at the top-level.