feat(tree): Promote TableSchema APIs to beta#26339
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request promotes the TableSchema APIs from alpha to beta status, marking them as more stable for use.
Changes:
- Updated all JSDoc tags from
@alphato@betafor TableSchema and System_TableSchema namespaces - Removed alpha-stage warning from the main TableSchema namespace documentation
- Relocated orphaned cells documentation from TableSchema to System_TableSchema namespace
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/framework/fluid-framework/api-report/fluid-framework.legacy.beta.api.md | Added TableSchema and System_TableSchema namespaces to beta API surface |
| packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md | Added TableSchema and System_TableSchema namespaces to beta API surface |
| packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md | Updated namespace tags from @Alpha to @beta and removed @Sealed tag from createRowSchema |
| packages/dds/tree/api-report/tree.legacy.beta.api.md | Added TableSchema and System_TableSchema namespaces to beta API surface |
| packages/dds/tree/api-report/tree.beta.api.md | Added TableSchema and System_TableSchema namespaces to beta API surface |
| packages/dds/tree/api-report/tree.alpha.api.md | Updated namespace tags from @Alpha to @beta and removed @Sealed tag from createRowSchema |
| packages/dds/tree/src/tableSchema.ts | Updated JSDoc tags from @Alpha to @beta, reorganized documentation by moving orphaned cells info to System_TableSchema |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| /** | ||
| * Factory for creating row schema. | ||
| * @sealed @alpha | ||
| * @system @beta |
There was a problem hiding this comment.
Note for reviewers: the @sealed tag here was wrong. It should have been @system
packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md
Show resolved
Hide resolved
CraigMacomber
left a comment
There was a problem hiding this comment.
Seems like this should have a changeset
| // This is effectively a work-around that allows columns and rows to invoke table methods | ||
| // without having to pass the table as a parameter to their construction, which isn't possible. | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| (Table as any)[tableSchemaSymbol] = true; |
There was a problem hiding this comment.
Note for reviewers: this symbol was being set, but was not read anywhere. The associated behaviors were removed a while back, and this appears to have been missed at that time.
packages/dds/tree/src/tableSchema.ts
Outdated
| * A private symbol put on table schema to help identify them. | ||
| */ | ||
| const tableSchemaSymbol: unique symbol = Symbol("tableNode"); | ||
| const baseSchemaScope = "com.fluidframework.tableV2"; |
There was a problem hiding this comment.
Not necessarily for this this PR, but somewhere somehow, we should track all the scopes we have used at various points in time to avoid accidently reusing table someday. I imagine apps will have similar issues, so we should probably come up with something nice. Maybe a snapshot-based test setup, or a way to consume scopes so using them again will error.
Starting up a simple list of them in a DEV.md might be a good way to track them for now until we have a better system.
Co-authored-by: Craig Macomber (Microsoft) <42876482+CraigMacomber@users.noreply.github.com>
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Promotes
TableSchemaAPIs from alpha to beta.For docs on these APIs, see here: https://fluidframework.com/docs/api/fluid-framework/tableschema-namespace