tree: Reduce tree stable/public API surface using InternalTypes #21482
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
github-actions
bot
added
area: dds
github-actions
bot
added
the
area: dev experience
Josmithr
reviewed
Jun 18, 2024
Josmithr
approved these changes
Jun 18, 2024
Co-authored-by: Joshua Smithrud <[email protected]>
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.
Description
Move several types into InternalTypes
The stable public API surface for Tree has been reduced.
Breaking Changes
Several types have been moved into InternalTypes, indicating that they are not fully stable nor intended to be referenced by users of Tree.
NodeBuilderData
FieldHasDefault
TreeNodeSchemaNonClass
TreeArrayNodeBase
ScopedSchemaName
DefaultProvider
typeNameSymbol
InsertableObjectFromSchemaRecord
ObjectFromSchemaRecord
FieldHasDefaultUnsafe
ObjectFromSchemaRecordUnsafe
TreeObjectNodeUnsafe
TreeFieldFromImplicitFieldUnsafe
TreeNodeFromImplicitAllowedTypesUnsafe
InsertableTreeNodeFromImplicitAllowedTypesUnsafe
TreeArrayNodeUnsafe
TreeMapNodeUnsafe
InsertableObjectFromSchemaRecordUnsafe
InsertableTreeFieldFromImplicitFieldUnsafe
InsertableTypedNodeUnsafe
NodeBuilderDataUnsafe
NodeFromSchemaUnsafe
FlexList
TreeApi
Additionally a few more types which could not be moved due to technically limitations have been documented that they should be treated similarly.
Also to reduce confusion
typewas renamed totypeNameSymbol, and is now only type exported.Tree.isshould be used to get type information fromTreeNodesinstead.Reviewer Guidance
The review process is outlined on this wiki page.