Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR moves the getRevertible API from being a second parameter of the changed event callback to being a property on the ChangeMetadata object itself. This change deprecates the old API pattern while maintaining backward compatibility by keeping the second parameter (now deprecated).
Changes:
- Added
getRevertiblemethod toChangeMetadatatype for local changes - Updated all test code to use the new
getRevertible?.()pattern fromChangeMetadata - Updated API reports to reflect the new public API surface
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md | Added getRevertible method to local ChangeMetadata type |
| packages/dds/tree/api-report/tree.alpha.api.md | Added getRevertible method to local ChangeMetadata type |
| packages/dds/tree/src/core/rebase/types.ts | Added comprehensive documentation and implementation for getRevertible method on ChangeMetadata |
| packages/dds/tree/src/shared-tree/treeCheckout.ts | Implemented getRevertible on metadata object; removed outdated parameter documentation |
| packages/dds/tree/src/test/shared-tree/undo.spec.ts | Updated tests to destructure getRevertible from metadata |
| packages/dds/tree/src/test/shared-tree/treeCheckout.spec.ts | Updated tests to use new API pattern with optional chaining; removed unused import |
| packages/dds/tree/src/test/shared-tree/sharedTree.spec.ts | Updated test to restructure conditional logic for new API |
| packages/dds/tree/src/test/shared-tree/fuzz/undoRedo.fuzz.spec.ts | Updated fuzz tests to destructure and use new API pattern |
| .changeset/heavy-canyons-change.md | Documented the API change with migration guide |
Josmithr
reviewed
Jan 14, 2026
Josmithr
approved these changes
Jan 14, 2026
Contributor
Josmithr
left a comment
There was a problem hiding this comment.
Love the change. Love the docs. Ship it! Ship it now!
jenn-le
reviewed
Jan 14, 2026
Josmithr
approved these changes
Jan 14, 2026
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Josmithr
approved these changes
Jan 15, 2026
This was referenced Jan 15, 2026
This file contains hidden or 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
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.
This tweaks the
getRevertibleAPI to be more consistent with other emerging alpha APIs. It also improves the documentation.Alpha API changes only (and none are breaking). See changeset for details.