Skip to content

Conversation

@agarwal-navin
Copy link
Contributor

@agarwal-navin agarwal-navin commented Nov 25, 2025

The APIs neede to enable incremental summary have been tagged as @ alpha so that they can be used by applications.
The list of APIs that are marked @ alpha:

  • configuredSharedTreeAlpha - This is a new API which is similar to configuredSharedTreeBeta but has a couple more options exposed for configuring incremental summaries.
  • SharedTreeOptionsAlpha - Extension of SharedTreeOptionsBeta that includes options to enable incremental summarization.
  • IncrementalEncodingPolicy - Policy type to determine whether a node / field should be incrementally encoded.
  • incrementalEncodingPolicyForAllowedTypes - This function returns an IncrementalEncodingPolicy which will determine if AllowedTypes are opted into incremental summarization.
  • incrementalSummaryHint - This is a symbol that should be put in the metadata property of AllowedTypes to opt-in these types to be incrementally summarized.

AB#54252
AB#46028

@agarwal-navin agarwal-navin requested a review from a team as a code owner November 25, 2025 00:29
@github-actions github-actions bot added area: dds Issues related to distributed data structures area: dds: tree public api change Changes to a public API base: main PRs targeted against main branch labels Nov 25, 2025
@agarwal-navin agarwal-navin changed the title (tree) Tag the incremental summary APIs as @alpha (tree) Tag incremental summary APIs as @alpha Nov 25, 2025
@github-actions github-actions bot added the area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct label Nov 25, 2025
}

export interface SharedTreeOptionsInternal
extends Partial<SharedTreeOptions>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should be a Partial. If SharedTreeOptionsPublic or Beta or Alpha has a required parameter, then SharedTreeOptionsInternal needs to supply that as well to be compatible.

@github-actions
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  249533 links
    1776 destination URLs
    2013 URLs ignored
       0 warnings
       0 errors


@agarwal-navin agarwal-navin merged commit f59f711 into microsoft:main Nov 26, 2025
37 checks passed
@agarwal-navin agarwal-navin deleted the incrSummaryAlphaAPIs branch November 26, 2025 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: dds: tree area: dds Issues related to distributed data structures area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch public api change Changes to a public API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants