Expose staged, types, stagedRecursive and typesRecursive on `…#25779
Expose staged, types, stagedRecursive and typesRecursive on `…#25779daesunp merged 14 commits intomicrosoft:mainfrom
staged, types, stagedRecursive and typesRecursive on `…#25779Conversation
…SchemaFactoryBeta`
docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
Outdated
Show resolved
Hide resolved
| static readonly identifier: <const TCustomMetadata = unknown>(props?: Omit<FieldProps<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlpha<FieldKind.Identifier, LeafSchema<"string", string> & SimpleLeafNodeSchema, TCustomMetadata>; | ||
| static readonly leaves: readonly [LeafSchema<"string", string> & SimpleLeafNodeSchema, LeafSchema<"number", number> & SimpleLeafNodeSchema, LeafSchema<"boolean", boolean> & SimpleLeafNodeSchema, LeafSchema<"null", null> & SimpleLeafNodeSchema, LeafSchema<"handle", IFluidHandle_2<unknown>> & SimpleLeafNodeSchema]; | ||
| readonly leaves: readonly [LeafSchema<"string", string> & SimpleLeafNodeSchema, LeafSchema<"number", number> & SimpleLeafNodeSchema, LeafSchema<"boolean", boolean> & SimpleLeafNodeSchema, LeafSchema<"null", null> & SimpleLeafNodeSchema, LeafSchema<"handle", IFluidHandle_2<unknown>> & SimpleLeafNodeSchema]; | ||
| static readonly identifier: <const TCustomMetadata = unknown>(props?: Omit<FieldProps<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlpha<FieldKind.Identifier, LeafSchema_3<"string", string> & SimpleLeafNodeSchema_2, TCustomMetadata>; |
There was a problem hiding this comment.
There is a block of imports in SchemFactoryAlpha comments with
// These imports prevent a large number of type references in the API reports from showing up as *_2.
Try copying that into schema factory beta and seeing if that cleans up this mess.
There was a problem hiding this comment.
Actually, I think the issue is you removed some of those imports from that block from schema factory alpha. Those unused imports clean up this mess (it is dumb included unused imports fixes things, but that's the world we live in)
There was a problem hiding this comment.
Added back in the removed imports and re-ran npm run build:docs
.changeset/metal-games-love.md
Outdated
| "@fluidframework/tree": minor | ||
| "__section": feature | ||
| --- | ||
| Expose `staged`, `types`, `stagedRecursive` and `typesRecursive` on `SchemaFactoryBeta` |
There was a problem hiding this comment.
See https://github.com/microsoft/FluidFramework/wiki/Changesets#formatting :
The title/heading should not contain code formatting
.changeset/metal-games-love.md
Outdated
| --- | ||
| Expose `staged`, `types`, `stagedRecursive` and `typesRecursive` on `SchemaFactoryBeta` | ||
|
|
||
| These APIs were previously only available on `SchemaFactoryAlpha`, but is now available on `SchemaFactoryBeta`. No newline at end of file |
There was a problem hiding this comment.
| These APIs were previously only available on `SchemaFactoryAlpha`, but is now available on `SchemaFactoryBeta`. | |
| These APIs were previously only available on `SchemaFactoryAlpha`, but are now available on `SchemaFactoryBeta`. |
There was a problem hiding this comment.
Pull Request Overview
This PR promotes the staged, types, stagedRecursive, and typesRecursive APIs from alpha to beta stability level by moving them from SchemaFactoryAlpha to SchemaFactoryBeta, along with related type definitions and documentation updates.
Key changes:
- Move
SchemaStaticsBetainterface and related APIs fromSchemaFactoryAlphatoSchemaFactoryBeta - Update all documentation references from
SchemaStaticsAlphatoSchemaStaticsBeta - Change API stability tags from
@alphato@betafor related types and interfaces
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/dds/tree/src/simple-tree/api/schemaFactoryBeta.ts | Adds SchemaStaticsBeta interface and implements staged, types, stagedRecursive, and typesRecursive methods on SchemaFactoryBeta |
| packages/dds/tree/src/simple-tree/api/schemaFactoryAlpha.ts | Removes SchemaStaticsAlpha interface and related implementations (moved to Beta) |
| packages/dds/tree/src/simple-tree/api/typesUnsafe.ts | Updates API stability tags from @alpha to @beta for unsafe type utilities |
| packages/dds/tree/src/simple-tree/api/index.ts | Updates exports to export SchemaStaticsBeta from schemaFactoryBeta instead of SchemaStaticsAlpha from schemaFactoryAlpha |
| packages/dds/tree/src/simple-tree/index.ts | Updates public exports to expose SchemaStaticsBeta and remove SchemaStaticsAlpha |
| packages/dds/tree/src/index.ts | Updates main package exports for the API level change |
| packages/dds/tree/src/simple-tree/simpleSchema.ts | Updates documentation references from SchemaStaticsAlpha to SchemaStaticsBeta |
| packages/dds/tree/src/simple-tree/core/allowedTypes.ts | Updates documentation references from SchemaStaticsAlpha to SchemaStaticsBeta |
| packages/dds/tree/src/simple-tree/api/tree.ts | Updates documentation references from SchemaStaticsAlpha to SchemaStaticsBeta |
| packages/dds/tree/src/simple-tree/api/incrementalAllowedTypes.ts | Updates documentation reference from SchemaStaticsAlpha to SchemaStaticsBeta |
| packages/dds/tree/src/simple-tree/api/discrepancies.ts | Updates documentation references from SchemaStaticsAlpha to SchemaStaticsBeta |
| packages/dds/tree/src/shared-tree/treeAlpha.ts | Updates documentation reference from SchemaStaticsAlpha to SchemaStaticsBeta |
| docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx | Updates documentation links from SchemaFactoryAlpha to SchemaFactoryBeta |
| packages/framework/fluid-framework/api-report/*.api.md | API report updates reflecting the stability level changes |
| packages/dds/tree/api-report/*.api.md | API report updates reflecting the stability level changes |
| .changeset/metal-games-love.md | Changeset documenting the feature promotion |
docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
Show resolved
Hide resolved
docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
Show resolved
Hide resolved
docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
Show resolved
Hide resolved
docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
Show resolved
Hide resolved
docs/docs/data-structures/tree/schema-evolution/allowed-types-rollout.mdx
Show resolved
Hide resolved
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
|
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output |
microsoft#25779) ## Description This PR promotes SchemaStaticsAlpha to SchemaStaticsBeta, and exposes `staged`, `types`, `stagedRecursive` and `typesRecursive` to be used in beta apps. --------- Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
Description
This PR promotes SchemaStaticsAlpha to SchemaStaticsBeta, and exposes
staged,types,stagedRecursiveandtypesRecursiveto be used in beta apps.