feat: add fluid-controlled map interfaces#26788
Merged
jenn-le merged 14 commits intomicrosoft:mainfrom Apr 2, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Introduces Fluid-controlled map-like interfaces (to decouple public APIs from TypeScript lib Map/ReadonlyMap changes) and updates existing map/indexing interfaces to extend the new types.
Changes:
- Added
FluidMapLegacy(@public),FluidReadonlyMap(@Alpha), andFluidMap(@Alpha) in@fluidframework/core-interfaces. - Updated
IDirectory,ISharedMap, andTreeIndexto extendFluidMapLegacy/FluidReadonlyMapinstead of built-inMap/ReadonlyMap. - Re-exported the new types across relevant packages and updated API reports + changeset.
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/framework/fluid-framework/src/index.ts | Re-exports FluidMapLegacy from the framework entrypoint. |
| packages/framework/fluid-framework/api-report/fluid-framework.public.api.md | API report updated to include FluidMapLegacy. |
| packages/framework/fluid-framework/api-report/fluid-framework.legacy.public.api.md | API report updated; IDirectory now extends FluidMapLegacy. |
| packages/framework/fluid-framework/api-report/fluid-framework.legacy.beta.api.md | API report updated; IDirectory/ISharedMap now extend FluidMapLegacy. |
| packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md | API report updated to include FluidMapLegacy. |
| packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md | API report updated; adds FluidReadonlyMap and updates TreeIndex to extend it. |
| packages/dds/tree/src/index.ts | Re-exports FluidReadonlyMap for tree consumers. |
| packages/dds/tree/src/feature-libraries/indexing/types.ts | Updates TreeIndex to extend FluidReadonlyMap. |
| packages/dds/tree/api-report/tree.alpha.api.md | API report updated; TreeIndex now extends FluidReadonlyMap. |
| packages/dds/map/src/interfaces.ts | Updates IDirectory/ISharedMap to extend FluidMapLegacy. |
| packages/dds/map/src/index.ts | Re-exports FluidMapLegacy from @fluidframework/map. |
| packages/dds/map/api-report/map.public.api.md | API report updated to include FluidMapLegacy. |
| packages/dds/map/api-report/map.legacy.public.api.md | API report updated; IDirectory now extends FluidMapLegacy. |
| packages/dds/map/api-report/map.legacy.beta.api.md | API report updated; IDirectory/ISharedMap now extend FluidMapLegacy. |
| packages/dds/map/api-report/map.beta.api.md | API report updated to include FluidMapLegacy. |
| packages/common/core-interfaces/src/index.ts | Exports FluidMap, FluidMapLegacy, and FluidReadonlyMap. |
| packages/common/core-interfaces/src/fluidMap.ts | Adds the new Fluid-controlled map interface definitions. |
| packages/common/core-interfaces/api-report/core-interfaces.public.api.md | API report updated to include FluidMapLegacy. |
| packages/common/core-interfaces/api-report/core-interfaces.legacy.public.api.md | API report updated to include FluidMapLegacy. |
| packages/common/core-interfaces/api-report/core-interfaces.legacy.beta.api.md | API report updated to include FluidMapLegacy. |
| packages/common/core-interfaces/api-report/core-interfaces.legacy.alpha.api.md | API report updated to include FluidMap/FluidReadonlyMap/FluidMapLegacy. |
| packages/common/core-interfaces/api-report/core-interfaces.beta.api.md | API report updated to include FluidMapLegacy. |
| .changeset/bright-bananas-yell.md | Adds release notes for the new interfaces and interface inheritance changes. |
ChumpChief
reviewed
Mar 19, 2026
Contributor
ChumpChief
left a comment
There was a problem hiding this comment.
Thanks for picking this up, it will be nice to stabilize this type :)
noencke
reviewed
Mar 20, 2026
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
alexvy86
added a commit
that referenced
this pull request
Apr 6, 2026
Reverts #26788 because I suspect it broke the Loop integration pipeline.
agarwal-navin
pushed a commit
to agarwal-navin/FluidFramework
that referenced
this pull request
Apr 13, 2026
Adds fluid-controlled map interfaces, `FluidMap` and `FluidReadonlyMap` for extension by interfaces that want APIs that behave closely to TypeScript maps. These are provided to reduce the risk of changes to the built in map breaking downstream customers. `TreeIndex` is changed to use `FluidReadonlyMap` and `TreeMapNodeAlpha` is added which extends `FluidReadonlyMap` instead of `ReadonlyMap`.
agarwal-navin
pushed a commit
to agarwal-navin/FluidFramework
that referenced
this pull request
Apr 13, 2026
Reverts microsoft#26788 because I suspect it broke the Loop integration pipeline.
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.
Adds fluid-controlled map interfaces,
FluidMapandFluidReadonlyMapfor extension by interfaces that want APIs that behave closely to TypeScript maps. These are provided to reduce the risk of changes to the built in map breaking downstream customers.TreeIndexis changed to useFluidReadonlyMapandTreeMapNodeAlphais added which extendsFluidReadonlyMapinstead ofReadonlyMap.