Skip to content

Conversation

CraigMacomber
Copy link
Contributor

@CraigMacomber CraigMacomber commented Oct 14, 2025

Description

Expose schema metadata in more internal and beta API surfaces.

This is a subset of #25656, but with the public SchemaFactory changes reverted.

Reviewer Guidance

The review process is outlined on this wiki page.

@CraigMacomber CraigMacomber requested a review from a team as a code owner October 14, 2025 19:22
@Copilot Copilot AI review requested due to automatic review settings October 14, 2025 19:22
@CraigMacomber CraigMacomber requested review from a team as code owners October 14, 2025 19:22
@github-actions github-actions bot added area: dds Issues related to distributed data structures area: dds: tree area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct changeset-present public api change Changes to a public API base: main PRs targeted against main branch labels Oct 14, 2025
Copy link
Contributor

@Copilot Copilot AI left a 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 exposes schema metadata APIs more consistently across internal and beta API surfaces, specifically adding support for metadata options in the record method of SchemaFactoryBeta.

  • Adds metadata support to SchemaFactoryBeta.record() method by including options parameter
  • Updates various schema factory implementations to use consistent option handling patterns
  • Refactors schema functions to accept unified options objects instead of separate metadata parameters

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/framework/fluid-framework/api-report/*.api.md Updates API signatures to include metadata parameter for record method
packages/dds/tree/api-report/*.api.md Updates API signatures and type definitions to support metadata
packages/dds/tree/src/simple-tree/node-kinds/record/recordNodeTypes.ts Changes TConstructorExtra from never to undefined
packages/dds/tree/src/simple-tree/node-kinds/record/recordNode.ts Refactors to use nodeOptions instead of separate metadata parameters
packages/dds/tree/src/simple-tree/node-kinds/object/objectNode.ts Updates to use unified nodeOptions parameter
packages/dds/tree/src/simple-tree/node-kinds/map/mapNode.ts Updates to use unified nodeOptions parameter
packages/dds/tree/src/simple-tree/node-kinds/array/arrayNode.ts Updates to use unified nodeOptions parameter
packages/dds/tree/src/simple-tree/api/schemaFactoryBeta.ts Adds options parameter to record method and refactors implementation
packages/dds/tree/src/simple-tree/api/schemaFactoryAlpha.ts Updates to use unified nodeOptions pattern
packages/dds/tree/src/simple-tree/api/schemaFactory.ts Adds debugAssert and updates method signatures
packages/dds/tree/src/test/simple-tree/core/treeNodeSchema.spec.ts Updates test to use empty object instead of false
.changeset/all-glasses-grab.md Documents the changes

Copy link
Contributor

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

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

 ELIFECYCLE  Command failed with exit code 1.

@CraigMacomber CraigMacomber enabled auto-merge (squash) October 14, 2025 23:02
@CraigMacomber CraigMacomber merged commit 6d8c0ca into microsoft:main Oct 14, 2025
38 checks passed
@CraigMacomber CraigMacomber deleted the betaMeta branch October 15, 2025 01:07
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 changeset-present public api change Changes to a public API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants