Skip to content

Commit 644581e

Browse files
authored
feat(tree): Update table schema identifier pattern (microsoft#25956)
Updates the `TableSchema` APIs to generate more expressive / more explicit schema identifiers. Previously, table schema would be generated with the following identifier patterns: - Column: `user-scope.Column` - Row: `user-scope.Row` - Table: `user-scope.Table` This pattern makes it difficult to distinguish table schema generated by Fluid Framework APIs from any user-crafted schema. To help differentiate, and to make it possible for code to pattern match on Fluid Framework table nodes in the future, the identifier patterns have been updated as follows: - Column: `com.fluidframework.table<user-scope>.Column` - Row: `com.fluidframework.table<user-scope>.Row` - Table: `com.fluidframework.table<user-scope>.Table` [AB#53661](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/53661)
1 parent 607da53 commit 644581e

File tree

7 files changed

+305
-176
lines changed

7 files changed

+305
-176
lines changed

packages/dds/tree/api-report/tree.alpha.api.md

Lines changed: 35 additions & 35 deletions
Large diffs are not rendered by default.

packages/dds/tree/src/simple-tree/api/schemaFromSimple.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ const factory = new SchemaFactoryAlpha(undefined);
4141
*
4242
* This API bakes in some arbitrary policy choices for how to handle data that is not included in the SimpleTreeSchema API, for example the value of `allowUnknownOptionalFields`.
4343
* If any particular choice is required for such cases, this API should not be used.
44+
*
45+
* @privateRemarks
46+
* TODO: Add the ability for consumers to inject custom policy.
47+
* For example, allow nodes with table schema identifiers to dispatch to `TableSchema` factory APIs.
48+
*
4449
* @alpha
4550
*/
4651
export function generateSchemaFromSimpleSchema(simple: SimpleTreeSchema): TreeSchema {

0 commit comments

Comments
 (0)