Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR renames the asTreeViewAlpha function to asAlpha to allow future APIs that follow the same pattern to share a common API for accessing alpha functionality. This aligns the tree API with a recently introduced container-runtime API pattern.
- Replaces all imports and usages of
asTreeViewAlphawithasAlpha - Moves the function implementation from
simple-tree/api/tree.tsto a newapi.tsfile at the package root - Updates API documentation and exports to reflect the rename
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/service-clients/end-to-end-tests/azure-client/src/test/tree.spec.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/framework/tree-agent/src/test/utils.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/framework/tree-agent/src/test/systemPrompt.spec.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md | Updates API documentation to reflect function name change |
| packages/dds/tree/src/test/shared-tree/undo.spec.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/dds/tree/src/test/shared-tree/treeCheckout.spec.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/dds/tree/src/test/shared-tree/tree.spec.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/dds/tree/src/test/shared-tree/sharedTree.spec.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/dds/tree/src/test/shared-tree/fuzz/fuzzEditGenerators.ts | Updates import and usage of asTreeViewAlpha to asAlpha |
| packages/dds/tree/src/simple-tree/index.ts | Removes export of asTreeViewAlpha |
| packages/dds/tree/src/simple-tree/api/tree.ts | Removes asTreeViewAlpha function implementation and updates documentation |
| packages/dds/tree/src/simple-tree/api/index.ts | Removes export of asTreeViewAlpha |
| packages/dds/tree/src/index.ts | Removes export of asTreeViewAlpha and adds export of asAlpha |
| packages/dds/tree/src/api.ts | New file containing asAlpha function implementation |
| packages/dds/tree/api-report/tree.alpha.api.md | Updates API documentation to reflect function name change |
| .changeset/lazy-comics-cheat.md | Documents the breaking change |
4348b37 to
e33aeed
Compare
| /** | ||
| * Retrieve the {@link TreeViewAlpha | alpha API} for a {@link TreeView}. | ||
| * @alpha | ||
| * @deprecated Use {@link asAlpha} instead. |
There was a problem hiding this comment.
Nit: should we maybe leave a @privateRemarks block noting that package-internal usage is not deprecated, just external?
| --- | ||
| `asTreeViewAlpha` has been deprecated in favor of `asAlpha`. | ||
|
|
||
| Please replace usages with of `asTreeViewAlpha` with `asAlpha` - the function signature remains the same. |
There was a problem hiding this comment.
Do we have any usages elsewhere in the repo that we should migrate in this PR?
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
| "@fluidframework/tree-agent": minor | ||
| "__section": breaking | ||
| --- | ||
| `asTreeViewAlpha` has been deprecated in favor of `asAlpha`. |
There was a problem hiding this comment.
Coming back just for future reference, with a new (to me, at least) reason why we avoid inline code blocks in changeset headings (we missed it this time, oops): it breaks ToC links in the final release notes (probably only if the heading starts with a code block like in this case). All links work except that one.
FYI docs crew @Josmithr @jzaffiro @tylerbutler @CraigMacomber
This will allow future APIs that follow the same pattern to share the same common `asAlpha` API. This also aligns the tree API with the [recently introduced container-runtime API](microsoft#25509).
This will allow future APIs that follow the same pattern to share the same common
asAlphaAPI.This also aligns the tree API with the recently introduced container-runtime API.