-
Notifications
You must be signed in to change notification settings - Fork 549
Add non static overrides for SchemaFactoryAlpha #24801
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 fleshes out SchemaFactoryAlpha
by adding non‐static (instance) overrides for several schema helper properties and updates the alpha API reports and changeset accordingly.
- Expose instance overrides for
leaves
,optional
,required
,optionalRecursive
, andrequiredRecursive
inSchemaFactoryAlpha
. - Update the generated
.api.md
files to include the new instance members and adjust system table schema entries to useFieldSchemaAlpha
. - Add an alpha override for
requiredRecursive
in both static and instance contexts and document it in the changeset.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
File | Description |
---|---|
packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md | Added instance overrides for leaves, optional, required, optionalRecursive, requiredRecursive; updated table schema field to FieldSchemaAlpha . |
packages/dds/tree/src/simple-tree/api/schemaFactoryAlpha.ts | Added JSDoc and instance overrides for leaves , optional , required , optionalRecursive , requiredRecursive . |
packages/dds/tree/api-report/tree.alpha.api.md | Mirrored the instance‐override additions and system table schema update in the tree API report. |
.changeset/whole-days-argue.md | Documented the new instance overrides and requiredRecursive addition. |
Comments suppressed due to low confidence (2)
packages/dds/tree/src/simple-tree/api/schemaFactoryAlpha.ts:183
- New instance override properties (leaves, optional, required, optionalRecursive, requiredRecursive) don’t appear to have accompanying unit tests. Consider adding tests to verify these instance members exist and match the static implementations.
public override readonly leaves = schemaStatics.leaves;
.changeset/whole-days-argue.md:6
- [nitpick] Consider clarifying this change description by replacing “overrides for more instance properties” with something like “instance overrides” to make it clearer that the PR adds non-static versions of several SchemaFactoryAlpha members.
Add overrides for more instance properties in SchemaFactoryAlpha
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.
Left a docs suggestion, but otherwise this looks good to me!
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
Description
Since SchemaFactoryAlpha seems to be sticking around for a while and its APIs are not getting stabilized to public on a short timeline, flesh out its overrides to be a bit more complete and consistent.
Reviewer Guidance
The review process is outlined on this wiki page.