-
Notifications
You must be signed in to change notification settings - Fork 557
More consistently handle schema metadata APIs #25685
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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 |
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output
|
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.