-
Notifications
You must be signed in to change notification settings - Fork 564
feat(tree): Add minVersionForCollaboration option to configuredSharedTreeBeta
#26342
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(tree): Add minVersionForCollaboration option to configuredSharedTreeBeta
#26342
Conversation
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR promotes MinimumVersionForCollab from @legacy @beta to @beta and adds a minVersionForCollab option to configuredSharedTreeBeta, enabling users to specify minimum version requirements for collaboration when creating SharedTree instances.
Changes:
- Promoted
MinimumVersionForCollabandFluidClientVersionfrom alpha/legacy to beta stability level - Added
CodecWriteOptionsBetainterface to exposeminVersionForCollabin beta API surface - Updated
SharedTreeOptionsBetato include the newminVersionForCollaboption - Enhanced documentation for TableSchema APIs with version compatibility guidance
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/runtime/runtime-definitions/src/compatibilityDefinitions.ts | Removed @legacy tag from MinimumVersionForCollab type |
| packages/runtime/runtime-definitions/package.json | Added beta entrypoint configuration and API extractor scripts |
| packages/runtime/runtime-definitions/api-report/*.api.md | Updated API reports to reflect MinimumVersionForCollab promotion |
| packages/runtime/runtime-definitions/api-extractor/*.json | Added and updated API extractor configurations for beta entrypoint |
| packages/framework/fluid-framework/api-report/*.api.md | Added CodecWriteOptionsBeta, FluidClientVersion, and updated SharedTreeOptionsBeta |
| packages/dds/tree/src/codec/codec.ts | Refactored to extract CodecWriteOptionsBeta from CodecWriteOptions and promoted FluidClientVersion to beta |
| packages/dds/tree/src/shared-tree/sharedTree.ts | Updated SharedTreeOptionsBeta to include CodecWriteOptionsBeta |
| packages/dds/tree/src/tableSchema.ts | Enhanced documentation with version compatibility requirements and reorganized orphaned cells explanation |
| packages/dds/tree/src/index.ts, packages/dds/tree/src/codec/index.ts | Exported CodecWriteOptionsBeta type |
| packages/dds/tree/api-report/*.api.md | Updated API reports to reflect beta promotions |
| .changeset/gross-apples-defend.md | Added changeset documenting the feature |
Co-authored-by: Copilot <[email protected]>
…smithr/FluidFramework into tree/promote-minVersionOption
Co-authored-by: Craig Macomber (Microsoft) <[email protected]>
…smithr/FluidFramework into tree/promote-minVersionOption
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Prerequisite for promoting
TableSchemaAPIs to beta.MinimumVersionForCollabThis PR also promotes
MinimumVersionForCollabfrom@legacy @betato@beta. This type is forward looking and intended for eventual use in our public API, so the@legacytag wasn't really appropriate, and its removal is necessary for transitive exposure viatree.