[DRAFT] feat(tree): Add Record node kind #24908

Josmithr · 2025-06-24T21:28:42Z

This is a draft proof of concept. The actual changes will likely be split out into separate, smaller PRs.

This reverts commit ef11fe4.

Josmithr · 2025-06-24T21:53:12Z

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

-						true,
-					) as TreeNodeSchema,
+			return this.getStructuralType(fullName, types, () =>
+				this.namedMap(fullName, nameOrAllowedTypes as T, false, true),


Note for reviewers: Removed unneeded cast

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

Josmithr · 2025-06-24T21:56:35Z

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

+	 *
+	 * @privateRemarks
+	 * The name produced at the type level here is not as specific as it could be, however doing type-level sorting and escaping is a real mess.
+	 * There are cases where not having this full type provided will be less than ideal since TypeScript's structural types.


TODO: fix this

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

Josmithr · 2025-06-24T22:03:34Z

packages/dds/tree/src/simple-tree/core/treeNodeSchema.ts

@@ -438,19 +438,23 @@ export enum NodeKind {
 	/**
 	 * A node which serves as a map, storing children under string keys.
 	 */
-	Map,
+	Map = 0,


Note for reviewers: just made the existing values here explicit. In the event that more changes are needed here, this makes it a bit more clear that the values should be preserved.

packages/dds/tree/src/simple-tree/node-kinds/index.ts

Josmithr · 2025-06-24T23:03:04Z

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

@@ -807,6 +836,9 @@ export class SchemaFactoryAlpha<out TScope extends string | undefined = string |
    };
    static readonly optionalRecursive: <const T extends System_Unsafe.ImplicitAllowedTypesUnsafe, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldPropsAlpha_2<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlphaUnsafe_2<FieldKind_2.Optional, T, TCustomMetadata>;
    readonly optionalRecursive: <const T extends System_Unsafe.ImplicitAllowedTypesUnsafe, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldPropsAlpha_2<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlphaUnsafe_2<FieldKind_2.Optional, T, TCustomMetadata>;
+    record<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(allowedTypes: T): TreeNodeSchemaNonClass<ScopedSchemaName<TScope, `Record<${string}>`>, NodeKind.Record, TreeRecordNode<T> & WithType<ScopedSchemaName<TScope, `Record<${string}>`>, NodeKind.Record>, RecordNodeInsertableData<T>, true, T, undefined>;
+    record<const Name extends TName, const T extends ImplicitAllowedTypes>(name: Name, allowedTypes: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Record, TreeRecordNode<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Record>, RecordNodeInsertableData<T>, true, T, undefined>;
+    recordAlpha<const Name extends TName, const T extends ImplicitAnnotatedAllowedTypes, const TCustomMetadata = unknown>(name: Name, allowedTypes: T, options?: NodeSchemaOptionsAlpha<TCustomMetadata>): RecordNodeCustomizableSchema<ScopedSchemaName<TScope, Name>, T, true, TCustomMetadata>;


Note for reviewers: Separate "Alpha" version to parallel the other "Alpha" versions of the APIs that accept additional parameters. The non-"Alpha" versions will likely be promoted to beta sooner than this one.

…Framework into tree/record-nodes

packages/dds/tree/src/simple-tree/node-kinds/record/recordNode.ts

github-actions · 2025-06-25T00:41:18Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 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"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

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

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  231978 links
    1733 destination URLs
    1964 URLs ignored
       0 warnings
       0 errors

Josmithr added 30 commits June 3, 2025 22:46

WIP: Add node kind

d6c563a

WIP: SchemaFactory API (alpha)

2125947

fix: Add missing NodeKind entry for Record

516b4ad

feat: Support toMapTree

73060dd

docs: Add TODOs

3a02f3c

refactor: Remove proxy logic for now

de53121

refactor: Fix schema factory typing

d9a3074

test: schema factory record tests

bc56156

WIP: Proxy

170e1d1

Merge branch 'main' into tree/record-nodes

6f8ccdd

Merge branch 'main' into tree/record-nodes

0d8c96b

WIP

7938878

fix: Build

5b68387

docs: Update API reports

96665a4

docs: Fix TSDoc links

ac9f816

test: Fix tests

c700613

fex: Get and set behavior

7c1c4d6

test: Fix type names

25a1053

fix: Don't allow shadowing

3df50b4

fix: Misc. fixes

b323123

refactor: Return types

3d2cb8c

refactor: Cleanup

15cd1a6

docs

7ac47c3

[WIP] Tests

9c1f311

refactor: Remove unneeded asserts

3366e78

style: Formatting

087aa88

refactor: Update type signature

42894ef

refactor: Reorder properties

dd4fb11

refactor: Rename type and update TODO comment

a3ef62d

improvement: No need for freeze

dda3c3d

Josmithr added 5 commits June 24, 2025 21:44

revert: Unrelated API rename

ef11fe4

style: Formatting

cd82fd5

docs: Update API reports

5359927

refactor: Mark RecordNodeInsertableData as @alpha

471be98

Revert "revert: Unrelated API rename"

cd1face

This reverts commit ef11fe4.