Expose SchemaFactoryAlpha as an alpha API

[Abe27342]

Description

Exposes SchemaFactoryAlpha and associated additional options on object and objectRecursive to tree's alpha API surface. This lights up the feature implemented in #23192, so I have also added a changeset with some user-facing guidance on that feature.

Copilot reviewed 5 out of 14 changed files in this pull request and generated no comments.

Files not reviewed (9)

• packages/dds/tree/api-report/tree.legacy.public.api.md: Evaluated as low risk
• packages/dds/tree/src/index.ts: Evaluated as low risk
• packages/dds/tree/api-report/tree.beta.api.md: Evaluated as low risk
• packages/dds/tree/api-report/tree.legacy.alpha.api.md: Evaluated as low risk
• packages/dds/tree/api-report/tree.alpha.api.md: Evaluated as low risk
• packages/dds/tree/api-report/tree.public.api.md: Evaluated as low risk
• .changeset/moody-pandas-fall.md: Evaluated as low risk
• packages/dds/tree/src/test/shared-tree/schematizingTreeView.spec.ts: Evaluated as low risk
• packages/dds/tree/src/simple-tree/index.ts: Evaluated as low risk

Comments suppressed due to low confidence (1)

packages/dds/tree/src/simple-tree/api/schemaFactoryAlpha.ts:90

• The method object is being called within objectRecursive but it is not clear if object supports the same options parameter. Ensure that object method can handle SchemaFactoryObjectOptions correctly.

return this.object(

[Josmithr]

Nit: Question about the documentation on the property below. The first line reads:

Opt in to viewing documents which have unknown optional fields for this object's identifier, i.e. optional fields
in the document schema which are not present in this object schema declaration.

I'm not sure what "identifier" means in this context. Should this instead just say something like:

Allow nodes typed with this object node schema to contain optional fields that are not present in the schema declaration.

?

[Abe27342]

I like that way of putting it. identifier refers to the schema's identifier, but it's not particularly necessary to mention that here.

[Josmithr]

Left a few suggestions but otherwise looks great to me! And lines up very well with unrelated schema factory functionality I'm working on.

You mentioned that API-Extractor was complaining about these changes earlier, but no longer seems to be? Let me know if I can help investigate anything there. But assuming it continues to be stable, looks good to me!

[Abe27342]

Left a few suggestions but otherwise looks great to me! And lines up very well with unrelated schema factory functionality I'm working on.

You mentioned that API-Extractor was complaining about these changes earlier, but no longer seems to be? Let me know if I can help investigate anything there. But assuming it continues to be stable, looks good to me!

Yeah, I'm not totally sure it was actually an API-extractor issue, it just surfaced that way. I think the original problem I was seeing was typescript emitting 'any' which down the line caused problems, but it's plausible that when I last tried this I had missed something subtle (previous PR had a lot of changes) and when reimplementing this from a fresh state I didn't make the same mistake.

[github-actions]

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output

> [email protected] 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"


> [email protected] serve
> docusaurus serve --no-open

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

> [email protected] check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170138 links
    1596 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors