@fluidframework/tree 2.43.0-343119 → 2.50.0-345060

package/src/simple-tree/api/schemaFactoryAlpha.ts

@@ -10,11 +10,16 @@ import {
 	mapSchema,
 	type ObjectNodeSchema,
 	objectSchema,
+	type RecordNodeCustomizableSchema,
+	type RecordNodeInsertableData,
+	recordSchema,
+	type TreeRecordNode,
 } from "../node-kinds/index.js";
 import {
 	defaultSchemaFactoryObjectOptions,
 	SchemaFactory,
 	schemaStatics,
+	structuralName,
 	type SchemaFactoryObjectOptions,
 	type ScopedSchemaName,
 } from "./schemaFactory.js";
@@ -26,11 +31,19 @@ import type {
 	NodeSchemaOptionsAlpha,
 } from "../schemaTypes.js";
 import type { RestrictiveStringRecord } from "../../util/index.js";
-import type { NodeKind, TreeNodeSchemaClass } from "../core/index.js";
+import type {
+	NodeKind,
+	TreeNodeSchema,
+	TreeNodeSchemaBoth,
+	TreeNodeSchemaClass,
+	TreeNodeSchemaNonClass,
+	WithType,
+} from "../core/index.js";
 import type {
 	ArrayNodeCustomizableSchemaUnsafe,
 	MapNodeCustomizableSchemaUnsafe,
 	System_Unsafe,
+	TreeRecordNodeUnsafe,
 } from "./typesUnsafe.js";
 import type { SimpleObjectNodeSchema } from "../simpleSchema.js";
 
@@ -307,6 +320,260 @@ export class SchemaFactoryAlpha<
 		>;
 	}
 
+	/**
+	 * Define a structurally typed {@link TreeNodeSchema} for a {@link (TreeRecordNode:interface)}.
+	 *
+	 * @param allowedTypes - The types that may appear in the record.
+	 *
+	 * @remarks
+	 * The identifier for this record is defined as a function of the provided types.
+	 * It is still scoped to this `SchemaFactory`, but multiple calls with the same arguments will return the same
+	 * schema object, providing somewhat structural typing.
+	 * This does not support recursive types.
+	 *
+	 * If using these structurally named records, other types in this schema builder should avoid names of the form `Record<${string}>`.
+	 *
+	 * @example
+	 * The returned schema should be used as a schema directly:
+	 * ```typescript
+	 * const MyRecord = factory.record(factory.number);
+	 * type MyRecord = NodeFromSchema<typeof Record>;
+	 * ```
+	 * Or inline:
+	 * ```typescript
+	 * factory.object("Foo", { myRecord: factory.record(factory.number) });
+	 * ```
+	 *
+	 * @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 will allow assignment between runtime incompatible types at compile time.
+	 * For example, attempts to narrow unions of structural records by name won't work.
+	 * Planned future changes to move to a class based schema system as well as factor function based node construction should mostly avoid these issues,
+	 * though there may still be some problematic cases even after that work is done.
+	 *
+	 * The return value is a class, but its type is intentionally not specific enough to indicate it is a class.
+	 * This prevents callers of this from sub-classing it, which is unlikely to work well (due to the ease of accidentally giving two different calls to this different subclasses)
+	 * when working with structural typing.
+	 *
+	 * {@label STRUCTURAL}
+	 */
+	public record<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(
+		allowedTypes: T,
+	): TreeNodeSchemaNonClass<
+		/* Name */ ScopedSchemaName<TScope, `Record<${string}>`>,
+		/* Kind */ NodeKind.Record,
+		/* TNode */ TreeRecordNode<T> &
+			WithType<ScopedSchemaName<TScope, `Record<${string}>`>, NodeKind.Record>,
+		/* TInsertable */ RecordNodeInsertableData<T>,
+		/* ImplicitlyConstructable */ true,
+		/* Info */ T,
+		/* TConstructorExtra */ undefined
+	>;
+	/**
+	 * Define (and add to this library) a {@link TreeNodeSchemaClass} for a {@link (TreeRecordNode:interface)}.
+	 *
+	 * @param name - Unique identifier for this schema within this factory's scope.
+	 * @param allowedTypes - The types that may appear in the record.
+	 *
+	 * @remarks
+	 * Like TypeScript `Record`s, record nodes have some potential pitfalls.
+	 * For example: TypeScript makes assumptions about built-in keys being present (e.g. `toString`, `hasOwnProperty`, etc.).
+	 * Since these are otherwise valid keys in a record, this can lead to unexpected behavior.
+	 * To prevent inconsistent behavior, these built-ins are hidden by record nodes.
+	 * This means that if you try to call these built-ins (e.g. `toString()`) on a record node, you will get an error.
+	 *
+	 * In most cases, it is probably preferable to use {@link SchemaFactory.(map:2)} instead.
+	 *
+	 * @example
+	 * ```typescript
+	 * class NamedRecord extends factory.record("name", factory.number) {}
+	 * ```
+	 *
+	 * {@label NAMED}
+	 */
+	public record<const Name extends TName, const T extends ImplicitAllowedTypes>(
+		name: Name,
+		allowedTypes: T,
+	): TreeNodeSchemaClass<
+		/* Name */ ScopedSchemaName<TScope, Name>,
+		/* Kind */ NodeKind.Record,
+		/* TNode */ TreeRecordNode<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Record>,
+		/* TInsertable */ RecordNodeInsertableData<T>,
+		/* ImplicitlyConstructable */ true,
+		/* Info */ T,
+		/* TConstructorExtra */ undefined
+	>;
+	/**
+	 * {@link SchemaFactory.array} implementation.
+	 *
+	 * @privateRemarks
+	 * This should return TreeNodeSchemaBoth: see note on "map" implementation for details.
+	 */
+	public record<const T extends ImplicitAllowedTypes>(
+		nameOrAllowedTypes: TName | ((T & TreeNodeSchema) | readonly TreeNodeSchema[]),
+		maybeAllowedTypes?: T,
+	): TreeNodeSchema<
+		/* Name */ ScopedSchemaName<TScope, string>,
+		/* Kind */ NodeKind.Record,
+		/* TNode */ TreeRecordNode<T>,
+		/* TInsertable */ RecordNodeInsertableData<T>,
+		/* ImplicitlyConstructable */ true,
+		/* Info */ T
+	> {
+		if (maybeAllowedTypes === undefined) {
+			const types = nameOrAllowedTypes as (T & TreeNodeSchema) | readonly TreeNodeSchema[];
+			const fullName = structuralName("Record", types);
+			return this.getStructuralType(fullName, types, () =>
+				this.namedRecord(
+					fullName,
+					nameOrAllowedTypes as T,
+					/* customizable */ false,
+					/* implicitlyConstructable */ true,
+				),
+			) as TreeNodeSchemaClass<
+				/* Name */ ScopedSchemaName<TScope, string>,
+				/* Kind */ NodeKind.Record,
+				/* TNode */ TreeRecordNode<T>,
+				/* TInsertable */ RecordNodeInsertableData<T>,
+				/* ImplicitlyConstructable */ true,
+				/* Info */ T,
+				/* TConstructorExtra */ undefined
+			>;
+		}
+		const out: TreeNodeSchemaBoth<
+			/* Name */ ScopedSchemaName<TScope, string>,
+			/* Kind */ NodeKind.Record,
+			/* TNode */ TreeRecordNode<T>,
+			/* TInsertable */ RecordNodeInsertableData<T>,
+			/* ImplicitlyConstructable */ true,
+			/* Info */ T,
+			/* TConstructorExtra */ undefined
+		> = this.namedRecord(
+			nameOrAllowedTypes as TName,
+			maybeAllowedTypes,
+			/* customizable */ true,
+			/* implicitlyConstructable */ true,
+		);
+		return out;
+	}
+
+	/**
+	 * Define a {@link TreeNodeSchema} for a {@link (TreeArrayNode:interface)}.
+	 *
+	 * @param name - Unique identifier for this schema within this factory's scope.
+	 *
+	 * @remarks
+	 * This is not intended to be used directly, use the overload of `array` which takes a name instead.
+	 * This is only public to work around a compiler limitation.
+	 */
+	private namedRecord<
+		Name extends TName | string,
+		const T extends ImplicitAllowedTypes,
+		const ImplicitlyConstructable extends boolean,
+	>(
+		name: Name,
+		allowedTypes: T,
+		customizable: boolean,
+		implicitlyConstructable: ImplicitlyConstructable,
+	): TreeNodeSchemaBoth<
+		/* Name */ ScopedSchemaName<TScope, Name>,
+		/* Kind */ NodeKind.Record,
+		/* TNode */ TreeRecordNode<T> &
+			WithType<ScopedSchemaName<TScope, string>, NodeKind.Record>,
+		/* TInsertable */ RecordNodeInsertableData<T>,
+		/* ImplicitlyConstructable */ ImplicitlyConstructable,
+		/* Info */ T,
+		/* TConstructorExtra */ undefined
+	> {
+		const record = recordSchema({
+			identifier: this.scoped2(name),
+			info: allowedTypes,
+			customizable,
+			implicitlyConstructable,
+		});
+
+		return record as TreeNodeSchemaBoth<
+			/* Name */ ScopedSchemaName<TScope, Name>,
+			/* Kind */ NodeKind.Record,
+			/* TNode */ TreeRecordNode<T> &
+				WithType<ScopedSchemaName<TScope, string>, NodeKind.Record>,
+			/* TInsertable */ RecordNodeInsertableData<T>,
+			/* ImplicitlyConstructable */ ImplicitlyConstructable,
+			/* Info */ T,
+			/* TConstructorExtra */ undefined
+		>;
+	}
+
+	/**
+	 * Define (and add to this library) a {@link TreeNodeSchemaClass} for a {@link (TreeRecordNode:interface)}.
+	 *
+	 * @param name - Unique identifier for this schema within this factory's scope.
+	 * @param allowedTypes - The types that may appear in the record.
+	 * @param options - Additional options for the schema.
+	 *
+	 * @example
+	 * ```typescript
+	 * class NamedRecord extends factory.recordAlpha("name", factory.number) {}
+	 * ```
+	 */
+	public 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> {
+		return recordSchema({
+			identifier: this.scoped2(name),
+			info: allowedTypes,
+			customizable: true,
+			implicitlyConstructable: true,
+			metadata: options?.metadata,
+			persistedMetadata: options?.persistedMetadata,
+		});
+	}
+
+	/**
+	 * {@link SchemaFactoryAlpha.(record:2)} except tweaked to work better for recursive types.
+	 * Use with {@link ValidateRecursiveSchema} for improved type safety.
+	 * @remarks
+	 * This version of `SchemaFactory.record` uses the same workarounds as {@link SchemaFactory.objectRecursive}.
+	 * See {@link ValidateRecursiveSchema} for additional information about using recursive schema.
+	 */
+	// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+	public recordRecursive<
+		Name extends TName,
+		const T extends System_Unsafe.ImplicitAllowedTypesUnsafe,
+	>(name: Name, allowedTypes: T) {
+		const RecordSchema = this.namedRecord(
+			name,
+			allowedTypes as T & ImplicitAllowedTypes,
+			/* customizable */ true,
+			// Setting this to true seems to work ok currently, but not for other node kinds.
+			// Supporting this could be fragile and might break other future changes, so it's being kept as false for now.
+			/* implicitlyConstructable */ false,
+		);
+
+		return RecordSchema as TreeNodeSchemaClass<
+			/* Name */ ScopedSchemaName<TScope, Name>,
+			/* Kind */ NodeKind.Record,
+			/* TNode */ TreeRecordNodeUnsafe<T> &
+				WithType<ScopedSchemaName<TScope, Name>, NodeKind.Record>,
+			/* TInsertable */ {
+				// Ideally this would be
+				// RestrictiveStringRecord<InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T>>,
+				// but doing so breaks recursive types.
+				// Instead we do a less nice version:
+				readonly [P in string]: System_Unsafe.InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T>;
+			},
+			/* ImplicitlyConstructable */ false,
+			/* Info */ T,
+			/* TConstructorExtra */ undefined
+		>;
+	}
+
 	/**
 	 * Create a {@link SchemaFactory} with a {@link SchemaFactory.scope|scope} which is a combination of this factory's scope and the provided name.
 	 * @remarks

package/src/simple-tree/api/schemaFactoryRecursive.ts

@@ -168,7 +168,7 @@ export type ValidateRecursiveSchemaTemplate<T extends TreeNodeSchema> = TreeNode
 	// Name: This validator places no restrictions on the name other than that it's a string (as required by TreeNodeSchemaClass).
 	string,
 	// NodeKind: These are the NodeKinds which currently can be used recursively.
-	NodeKind.Array | NodeKind.Map | NodeKind.Object,
+	NodeKind.Array | NodeKind.Map | NodeKind.Object | NodeKind.Record,
 	// TNode: The produced node API. This is pretty minimal validation: more could be added if similar to how TInsertable works below if needed.
 	TreeNode & WithType<T["identifier"], T["kind"]>,
 	// TInsertable: What can be passed to the constructor. This should be enough to catch most issues with incorrect schema.
@@ -183,6 +183,9 @@ export type ValidateRecursiveSchemaTemplate<T extends TreeNodeSchema> = TreeNode
 		[NodeKind.Map]: T["info"] extends ImplicitAllowedTypes
 			? Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T["info"]>]>
 			: unknown;
+		[NodeKind.Record]: {
+			readonly [P in string]: InsertableTreeNodeFromImplicitAllowedTypes<T>;
+		};
 		[NodeKind.Leaf]: unknown;
 	}[T["kind"]],
 	// ImplicitlyConstructable: recursive types are currently not implicitly constructable.
@@ -192,6 +195,7 @@ export type ValidateRecursiveSchemaTemplate<T extends TreeNodeSchema> = TreeNode
 		[NodeKind.Object]: RestrictiveStringRecord<ImplicitFieldSchema>;
 		[NodeKind.Array]: ImplicitAllowedTypes;
 		[NodeKind.Map]: ImplicitAllowedTypes;
+		[NodeKind.Record]: ImplicitAllowedTypes;
 		[NodeKind.Leaf]: unknown;
 	}[T["kind"]]
 >;

package/src/simple-tree/api/schemaFromSimple.ts

@@ -116,6 +116,12 @@ function generateNode(
 				generateAllowedTypes(schema.allowedTypesIdentifiers, context),
 				{ metadata: schema.metadata },
 			);
+		case NodeKind.Record:
+			return factory.recordAlpha(
+				id,
+				generateAllowedTypes(schema.allowedTypesIdentifiers, context),
+				{ metadata: schema.metadata },
+			);
 		case NodeKind.Leaf:
 			return (
 				SchemaFactoryAlpha.leaves.find((leaf) => leaf.identifier === id) ??

package/src/simple-tree/api/simpleSchemaToJsonSchema.ts

@@ -18,17 +18,24 @@ import type {
 	JsonObjectNodeSchema,
 	JsonTreeSchema,
 	JsonLeafSchemaType,
+	JsonRecordNodeSchema,
 } from "./jsonSchema.js";
 import { FieldKind } from "../schemaTypes.js";
 import type {
 	SimpleArrayNodeSchema,
 	SimpleLeafNodeSchema,
 	SimpleMapNodeSchema,
+	SimpleRecordNodeSchema,
 } from "../simpleSchema.js";
 import { NodeKind, type TreeNodeSchema } from "../core/index.js";
 import type { TreeSchema } from "./configuration.js";
 import type { TreeSchemaEncodingOptions } from "./getJsonSchema.js";
-import { ArrayNodeSchema, MapNodeSchema, ObjectNodeSchema } from "../node-kinds/index.js";
+import {
+	ArrayNodeSchema,
+	isMapNodeSchema,
+	isRecordNodeSchema,
+	ObjectNodeSchema,
+} from "../node-kinds/index.js";
 import { LeafNodeSchema } from "../leafNodeSchema.js";
 
 /**
@@ -88,8 +95,8 @@ function convertNodeSchema(
 ): JsonNodeSchema {
 	if (schema instanceof ArrayNodeSchema) {
 		return convertArrayNodeSchema(schema);
-	} else if (schema instanceof MapNodeSchema) {
-		return convertMapNodeSchema(schema);
+	} else if (isMapNodeSchema(schema) || isRecordNodeSchema(schema)) {
+		return convertRecordLikeNodeSchema(schema);
 	} else if (schema instanceof ObjectNodeSchema) {
 		return convertObjectNodeSchema(schema, options);
 	} else if (schema instanceof LeafNodeSchema) {
@@ -191,15 +198,17 @@ export function convertObjectNodeSchema(
 	return transformedNode;
 }
 
-function convertMapNodeSchema(schema: SimpleMapNodeSchema): JsonMapNodeSchema {
+function convertRecordLikeNodeSchema(
+	schema: SimpleRecordNodeSchema | SimpleMapNodeSchema,
+): JsonMapNodeSchema | JsonRecordNodeSchema {
 	const allowedTypes: JsonSchemaRef[] = [];
 	schema.allowedTypesIdentifiers.forEach((type) => {
 		allowedTypes.push(createSchemaRef(type));
 	});
 
-	const output: Mutable<JsonMapNodeSchema> = {
+	const output = {
 		type: "object",
-		_treeNodeSchemaKind: NodeKind.Map,
+		_treeNodeSchemaKind: schema.kind,
 		patternProperties: {
 			"^.*$": hasSingle(allowedTypes)
 				? allowedTypes[0]
@@ -207,7 +216,7 @@ function convertMapNodeSchema(schema: SimpleMapNodeSchema): JsonMapNodeSchema {
 						anyOf: allowedTypes,
 					},
 		},
-	};
+	} as const;
 
 	copyProperty(schema.metadata, "description", output);
 

package/src/simple-tree/api/treeBeta.ts

@@ -85,8 +85,8 @@ export interface TreeChangeEventsBeta<TNode extends TreeNode = TreeNode>
 	 */
 	nodeChanged: (
 		data: NodeChangedData<TNode> &
-			// For object and Map nodes, make properties specific to them required instead of optional:
-			(TNode extends WithType<string, NodeKind.Map | NodeKind.Object>
+			// Make the properties of object, map, and record nodes required:
+			(TNode extends WithType<string, NodeKind.Map | NodeKind.Object | NodeKind.Record>
 				? Required<Pick<NodeChangedData<TNode>, "changedProperties">>
 				: unknown),
 	) => void;

package/src/simple-tree/api/treeNodeApi.ts

@@ -38,8 +38,8 @@ import {
 	getOrCreateInnerNode,
 } from "../core/index.js";
 import type { TreeChangeEvents } from "./treeChangeEvents.js";
-import { isObjectNodeSchema } from "../node-kinds/index.js";
-import { getTreeNodeForField } from "../getTreeNodeForField.js";
+import { isArrayNodeSchema, isObjectNodeSchema } from "../node-kinds/index.js";
+import { tryGetTreeNodeForField } from "../getTreeNodeForField.js";
 
 /**
  * Provides various functions for analyzing {@link TreeNode}s.
@@ -83,6 +83,9 @@ export interface TreeNodeApi {
 	 * Return the node under which this node resides in the tree (or undefined if this is a root node of the tree).
 	 *
 	 * @throws A {@link @fluidframework/telemetry-utils#UsageError} if the node has been {@link TreeStatus.Deleted | deleted}.
+	 *
+	 * @see {@link (TreeAlpha:interface).child}
+	 * @see {@link (TreeAlpha:interface).children}
 	 */
 	parent(node: TreeNode): TreeNode | undefined;
 
@@ -190,7 +193,7 @@ export const treeNodeApi: TreeNodeApi = {
 						);
 						listener({ changedProperties });
 					});
-				} else if (nodeSchema.kind === NodeKind.Array) {
+				} else if (isArrayNodeSchema(nodeSchema)) {
 					return kernel.events.on("childrenChangedAfterBatch", () => {
 						listener({ changedProperties: undefined });
 					});
@@ -316,7 +319,7 @@ export function getIdentifierFromNode(
 			const key = identifierFieldKeys[0] ?? oob();
 			const identifierField = flexNode.tryGetField(key);
 			assert(identifierField !== undefined, 0xbb5 /* missing identifier field */);
-			const identifierValue = getTreeNodeForField(identifierField);
+			const identifierValue = tryGetTreeNodeForField(identifierField);
 			assert(typeof identifierValue === "string", 0xbb6 /* identifier not a string */);
 
 			const context = flexNode.context;

package/src/simple-tree/api/typesUnsafe.ts

@@ -527,3 +527,18 @@ export interface MapNodeCustomizableSchemaUnsafe<
 			TCustomMetadata
 		>,
 		SimpleMapNodeSchema<TCustomMetadata> {}
+
+/**
+ * {@link Unenforced} version of {@link TreeRecordNode}.
+ * @remarks
+ * Do not use this type directly: it's only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.
+ * @system @sealed @alpha
+ */
+export interface TreeRecordNodeUnsafe<
+	TAllowedTypes extends System_Unsafe.ImplicitAllowedTypesUnsafe,
+> extends Record<string, System_Unsafe.TreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>>,
+		TreeNode {
+	[Symbol.iterator](): IterableIterator<
+		[string, System_Unsafe.TreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>]
+	>;
+}

package/src/simple-tree/api/viewSchemaToSimpleSchema.ts

@@ -13,10 +13,16 @@ import type {
 	SimpleNodeSchema,
 	SimpleObjectFieldSchema,
 	SimpleObjectNodeSchema,
+	SimpleRecordNodeSchema,
 	SimpleTreeSchema,
 } from "../simpleSchema.js";
 import { NodeKind } from "../core/index.js";
-import { ArrayNodeSchema, MapNodeSchema, ObjectNodeSchema } from "../node-kinds/index.js";
+import {
+	ArrayNodeSchema,
+	MapNodeSchema,
+	ObjectNodeSchema,
+	RecordNodeSchema,
+} from "../node-kinds/index.js";
 import { walkFieldSchema } from "../walkFieldSchema.js";
 import { LeafNodeSchema } from "../leafNodeSchema.js";
 
@@ -49,7 +55,8 @@ export function toSimpleTreeSchema(
 				nodeSchema instanceof ArrayNodeSchema ||
 					nodeSchema instanceof MapNodeSchema ||
 					nodeSchema instanceof LeafNodeSchema ||
-					nodeSchema instanceof ObjectNodeSchema,
+					nodeSchema instanceof ObjectNodeSchema ||
+					nodeSchema instanceof RecordNodeSchema,
 				0xb60 /* Invalid schema */,
 			);
 			const outSchema = copySchemaObjects ? copySimpleNodeSchema(nodeSchema) : nodeSchema;
@@ -82,7 +89,8 @@ function copySimpleNodeSchema(schema: SimpleNodeSchema): SimpleNodeSchema {
 			return copySimpleLeafSchema(schema);
 		case NodeKind.Array:
 		case NodeKind.Map:
-			return copySimpleMapOrArraySchema(schema);
+		case NodeKind.Record:
+			return copySimpleSchemaWithAllowedTypes(schema);
 		case NodeKind.Object:
 			return copySimpleObjectSchema(schema);
 		default:
@@ -99,9 +107,9 @@ function copySimpleLeafSchema(schema: SimpleLeafNodeSchema): SimpleLeafNodeSchem
 	};
 }
 
-function copySimpleMapOrArraySchema(
-	schema: SimpleMapNodeSchema | SimpleArrayNodeSchema,
-): SimpleMapNodeSchema | SimpleArrayNodeSchema {
+function copySimpleSchemaWithAllowedTypes(
+	schema: SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleRecordNodeSchema,
+): SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleRecordNodeSchema {
 	return {
 		kind: schema.kind,
 		allowedTypesIdentifiers: schema.allowedTypesIdentifiers,

package/src/simple-tree/core/context.ts

@@ -10,7 +10,7 @@ import type {
 } from "../../feature-libraries/index.js";
 import { brand } from "../../util/index.js";
 
-import type { TreeNodeSchema } from "./treeNodeSchema.js";
+import type { NormalizedAnnotatedAllowedTypes, TreeNodeSchema } from "./treeNodeSchema.js";
 import { walkAllowedTypes } from "./walkSchema.js";
 
 /**
@@ -52,7 +52,7 @@ export class Context {
 	 * Since this walks the schema, it must not be invoked during schema declaration or schema forward references could fail to be resolved.
 	 */
 	public constructor(
-		rootSchema: Iterable<TreeNodeSchema>,
+		rootSchema: NormalizedAnnotatedAllowedTypes,
 		public readonly flexContext: FlexTreeContext,
 	) {
 		const schema: Map<TreeNodeSchemaIdentifier, TreeNodeSchema> = new Map();
@@ -71,7 +71,7 @@ export class Context {
  */
 export class HydratedContext extends Context {
 	public constructor(
-		rootSchema: Iterable<TreeNodeSchema>,
+		rootSchema: NormalizedAnnotatedAllowedTypes,
 		public override readonly flexContext: FlexTreeHydratedContext,
 	) {
 		super(rootSchema, flexContext);

package/src/simple-tree/core/getOrCreateNode.ts

@@ -4,6 +4,8 @@
  */
 
 import type { TreeValue } from "../../core/index.js";
+import { isFlexTreeNode, type FlexTreeUnknownUnboxed } from "../../feature-libraries/index.js";
+import type { TreeLeafValue } from "../schemaTypes.js";
 
 import type { TreeNode } from "./treeNode.js";
 import {
@@ -34,3 +36,15 @@ export function getOrCreateNodeFromInnerNode(flexNode: InnerNode): TreeNode | Tr
 
 	return createTreeNodeFromInner(flexNode);
 }
+
+/**
+ * Returns the TreeNode or TreeValue for the provided {@link FlexTreeUnknownUnboxed}.
+ * This will allocate a new one if needed, and otherwise return one from cache.
+ * @remarks
+ * This supports both hydrated and unhydrated nodes.
+ */
+export function getOrCreateNodeFromInnerUnboxedNode(
+	flexTree: FlexTreeUnknownUnboxed,
+): TreeNode | TreeLeafValue {
+	return isFlexTreeNode(flexTree) ? getOrCreateNodeFromInnerNode(flexTree) : flexTree;
+}

package/src/simple-tree/core/index.ts

@@ -31,11 +31,18 @@ export {
 	type TreeNodeSchemaNonClass,
 	type TreeNodeSchemaCore,
 	type TreeNodeSchemaBoth,
+	type AnnotatedAllowedType,
+	type NormalizedAnnotatedAllowedTypes,
+	isAnnotatedAllowedTypes,
 } from "./treeNodeSchema.js";
 export { walkAllowedTypes, type SchemaVisitor } from "./walkSchema.js";
 export { Context, HydratedContext, SimpleContextSlot } from "./context.js";
-export { getOrCreateNodeFromInnerNode } from "./getOrCreateNode.js";
 export {
+	getOrCreateNodeFromInnerNode,
+	getOrCreateNodeFromInnerUnboxedNode,
+} from "./getOrCreateNode.js";
+export {
+	UnhydratedFlexTreeField,
 	UnhydratedFlexTreeNode,
 	UnhydratedSequenceField,
 	UnhydratedContext,

package/src/simple-tree/core/treeNodeKernel.ts

@@ -372,7 +372,7 @@ export function splitInnerNodeType(
 ): asserts innerNode is UnhydratedFlexTreeNode | HydratedFlexTreeNode {
 	assert(
 		innerNode instanceof UnhydratedFlexTreeNode || innerNode.isHydrated(),
-		"Invalid inner node type",
+		0xbc8 /* Invalid inner node type */,
 	);
 }