@fluidframework/tree 2.41.0-338401 → 2.42.0

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

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import type { NodeKind, TreeNodeSchemaClass } from "./treeNodeSchema.js";
 import type { TreeNode } from "./treeNode.js";
+import type { NodeKind, TreeNodeSchemaClass } from "./treeNodeSchema.js";
 
 /**
  * The type of a {@link TreeNode}.

package/src/simple-tree/createContext.ts

@@ -5,6 +5,7 @@
 
 import { defaultSchemaPolicy } from "../feature-libraries/index.js";
 import { getOrCreate } from "../util/index.js";
+
 import { Context, UnhydratedContext } from "./core/index.js";
 import { normalizeFieldSchema, type ImplicitFieldSchema } from "./schemaTypes.js";
 import { toStoredSchema } from "./toStoredSchema.js";

package/src/simple-tree/getTreeNodeForField.ts

@@ -4,6 +4,7 @@
  */
 
 import { fail } from "@fluidframework/core-utils/internal";
+
 import type { TreeValue } from "../core/index.js";
 import {
 	FieldKinds,
@@ -12,6 +13,7 @@ import {
 	type FlexTreeRequiredField,
 	type FlexTreeOptionalField,
 } from "../feature-libraries/index.js";
+
 import { type TreeNode, getOrCreateNodeFromInnerNode } from "./core/index.js";
 
 /**

package/src/simple-tree/index.ts

@@ -22,6 +22,7 @@ export {
 	HydratedContext,
 	SimpleContextSlot,
 	getOrCreateInnerNode,
+	getOrCreateNodeFromInnerNode,
 	getKernel,
 } from "./core/index.js";
 export {
@@ -43,13 +44,8 @@ export {
 	adaptEnum,
 	enumFromStrings,
 	singletonSchema,
-	test_RecursiveObject,
-	test_RecursiveObject_base,
-	test_RecursiveObjectPojoMode,
 	treeNodeApi,
 	type TreeNodeApi,
-	cursorFromInsertable,
-	createFromInsertable,
 	type NodeChangedData,
 	TreeBeta,
 	type TreeChangeEventsBeta,
@@ -119,12 +115,12 @@ export {
 	type HandleConverter,
 	allowUnused,
 	type FieldSchemaAlphaUnsafe,
+	getIdentifierFromNode,
 	type TreeSchema,
 	type ValidateRecursiveSchemaTemplate,
 	type FixRecursiveRecursionLimit,
 	schemaStatics,
 	type TreeChangeEvents,
-	createFromMapTree,
 } from "./api/index.js";
 export type {
 	SimpleTreeSchema,
@@ -188,37 +184,34 @@ export {
 } from "./schemaTypes.js";
 export { getTreeNodeForField } from "./getTreeNodeForField.js";
 export {
-	TreeArrayNode,
+	type ArrayNodeCustomizableSchema,
+	type ArrayNodePojoEmulationSchema,
+	ArrayNodeSchema,
+	isArrayNodeSchema,
 	IterableTreeArrayContent,
 	type ReadonlyArrayNode,
-} from "./arrayNode.js";
-export type {
-	ArrayNodeCustomizableSchema,
-	ArrayNodePojoEmulationSchema,
-} from "./arrayNodeTypes.js";
-export { ArrayNodeSchema, isArrayNodeSchema } from "./arrayNodeTypes.js";
-export type {
-	MapNodeCustomizableSchema,
-	MapNodePojoEmulationSchema,
-} from "./mapNodeTypes.js";
-export { MapNodeSchema, isMapNodeSchema } from "./mapNodeTypes.js";
-export {
+	TreeArrayNode,
+	type MapNodeCustomizableSchema,
+	type MapNodePojoEmulationSchema,
+	MapNodeSchema,
+	isMapNodeSchema,
+	type TreeMapNode,
+	type MapNodeInsertableData,
 	type FieldHasDefault,
 	type InsertableObjectFromSchemaRecord,
 	type ObjectFromSchemaRecord,
+	ObjectNodeSchema,
 	type InsertableObjectFromAnnotatedSchemaRecord,
 	type TreeObjectNode,
 	setField,
 	createUnknownOptionalFieldPolicy,
-} from "./objectNode.js";
-export { ObjectNodeSchema } from "./objectNodeTypes.js";
-export type { TreeMapNode, MapNodeInsertableData } from "./mapNode.js";
+} from "./node-kinds/index.js";
 export {
-	mapTreeFromNodeData,
+	unhydratedFlexTreeFromInsertable,
 	type InsertableContent,
 	type FactoryContent,
 	type FactoryContentObject,
-} from "./toMapTree.js";
+} from "./unhydratedFlexTreeFromInsertable.js";
 export {
 	prepareForInsertion,
 	prepareForInsertionContextless,

package/src/simple-tree/leafNodeSchema.ts

@@ -11,6 +11,7 @@ import {
 	isFlexTreeNode,
 	valueSchemaAllows,
 } from "../feature-libraries/index.js";
+
 import { NodeKind, type TreeNodeSchema, type TreeNodeSchemaNonClass } from "./core/index.js";
 import type { NodeSchemaMetadata, TreeLeafValue } from "./schemaTypes.js";
 import type { SimpleLeafNodeSchema } from "./simpleSchema.js";

package/src/simple-tree/{arrayNode.ts → node-kinds/array/arrayNode.ts}

@@ -6,12 +6,13 @@
 import { Lazy, oob, fail } from "@fluidframework/core-utils/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
-import { EmptyKey, type ExclusiveMapTree } from "../core/index.js";
+import { EmptyKey } from "../../../core/index.js";
 import {
+	type FlexibleFieldContent,
 	type FlexTreeNode,
 	type FlexTreeSequenceField,
 	isFlexTreeNode,
-} from "../feature-libraries/index.js";
+} from "../../../feature-libraries/index.js";
 import {
 	normalizeAllowedTypes,
 	unannotateImplicitAllowedTypes,
@@ -22,7 +23,7 @@ import {
 	type TreeLeafValue,
 	type TreeNodeFromImplicitAllowedTypes,
 	type UnannotateImplicitAllowedTypes,
-} from "./schemaTypes.js";
+} from "../../schemaTypes.js";
 import {
 	type WithType,
 	// eslint-disable-next-line import/no-deprecated
@@ -37,17 +38,18 @@ import {
 	getSimpleNodeSchemaFromInnerNode,
 	getOrCreateInnerNode,
 	type TreeNodeSchemaClass,
-} from "./core/index.js";
-import { type InsertableContent, mapTreeFromNodeData } from "./toMapTree.js";
-import { prepareArrayContentForInsertion } from "./prepareForInsertion.js";
-import {
 	getKernel,
-	UnhydratedFlexTreeNode,
-	UnhydratedTreeSequenceField,
-} from "./core/index.js";
-import { TreeNodeValid, type MostDerivedData } from "./treeNodeValid.js";
-import { getUnhydratedContext } from "./createContext.js";
-import type { System_Unsafe } from "./api/index.js";
+	type UnhydratedFlexTreeNode,
+	UnhydratedSequenceField,
+} from "../../core/index.js";
+import {
+	type InsertableContent,
+	unhydratedFlexTreeFromInsertable,
+} from "../../unhydratedFlexTreeFromInsertable.js";
+import { prepareArrayContentForInsertion } from "../../prepareForInsertion.js";
+import { TreeNodeValid, type MostDerivedData } from "../../treeNodeValid.js";
+import { getUnhydratedContext } from "../../createContext.js";
+import type { System_Unsafe } from "../../api/index.js";
 import type {
 	ArrayNodeCustomizableSchema,
 	ArrayNodePojoEmulationSchema,
@@ -852,7 +854,7 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
 		super(input ?? []);
 	}
 
-	#mapTreesFromFieldData(value: Insertable<T>): ExclusiveMapTree[] {
+	#mapTreesFromFieldData(value: Insertable<T>): FlexibleFieldContent {
 		const sequenceField = getSequenceField(this);
 		const content = value as readonly (
 			| InsertableContent
@@ -1014,7 +1016,7 @@ abstract class CustomArrayNodeBase<const T extends ImplicitAllowedTypes>
 
 		const movedCount = sourceEnd - sourceStart;
 		if (!destinationField.context.isHydrated()) {
-			if (!(sourceField instanceof UnhydratedTreeSequenceField)) {
+			if (!(sourceField instanceof UnhydratedSequenceField)) {
 				throw new UsageError(
 					"Cannot move elements from a hydrated array to an unhydrated array.",
 				);
@@ -1139,10 +1141,7 @@ export function arraySchema<
 			instance: TreeNodeValid<T2>,
 			input: T2,
 		): UnhydratedFlexTreeNode {
-			return UnhydratedFlexTreeNode.getOrCreate(
-				unhydratedContext,
-				mapTreeFromNodeData(input as object, this as unknown as ImplicitAllowedTypes),
-			);
+			return unhydratedFlexTreeFromInsertable(input as object, this as typeof Schema);
 		}
 
 		public static get allowedTypesIdentifiers(): ReadonlySet<string> {

package/src/simple-tree/{arrayNodeTypes.ts → node-kinds/array/arrayNodeTypes.ts}

@@ -8,16 +8,16 @@ import type {
 	ImplicitAnnotatedAllowedTypes,
 	InsertableTreeNodeFromImplicitAllowedTypes,
 	UnannotateImplicitAllowedTypes,
-} from "./schemaTypes.js";
+} from "../../schemaTypes.js";
 import {
 	NodeKind,
 	type TreeNodeSchemaClass,
 	type TreeNodeSchema,
 	type TreeNodeSchemaNonClass,
 	type WithType,
-} from "./core/index.js";
+} from "../../core/index.js";
 
-import type { SimpleArrayNodeSchema } from "./simpleSchema.js";
+import type { SimpleArrayNodeSchema } from "../../simpleSchema.js";
 
 /**
  * A schema for customizable {@link (TreeArrayNode:interface)}s.

package/src/simple-tree/node-kinds/array/index.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export {
+	arraySchema,
+	asIndex,
+	IterableTreeArrayContent,
+	TreeArrayNode,
+	type ReadonlyArrayNode,
+} from "./arrayNode.js";
+export {
+	type ArrayNodeCustomizableSchema,
+	type ArrayNodePojoEmulationSchema,
+	ArrayNodeSchema,
+	isArrayNodeSchema,
+} from "./arrayNodeTypes.js";

package/src/simple-tree/node-kinds/index.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export {
+	type ArrayNodeCustomizableSchema,
+	type ArrayNodePojoEmulationSchema,
+	ArrayNodeSchema,
+	arraySchema,
+	asIndex,
+	isArrayNodeSchema,
+	IterableTreeArrayContent,
+	TreeArrayNode,
+	type ReadonlyArrayNode,
+} from "./array/index.js";
+
+export {
+	isMapNodeSchema,
+	type MapNodeCustomizableSchema,
+	type MapNodeInsertableData,
+	type MapNodePojoEmulationSchema,
+	MapNodeSchema,
+	mapSchema,
+	type TreeMapNode,
+} from "./map/index.js";
+
+export {
+	createUnknownOptionalFieldPolicy,
+	type FieldHasDefault,
+	type InsertableObjectFromAnnotatedSchemaRecord,
+	type InsertableObjectFromSchemaRecord,
+	isObjectNodeSchema,
+	type ObjectFromSchemaRecord,
+	ObjectNodeSchema,
+	objectSchema,
+	setField,
+	type TreeObjectNode,
+} from "./object/index.js";

package/src/simple-tree/node-kinds/map/index.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export {
+	type MapNodeInsertableData,
+	mapSchema,
+	type TreeMapNode,
+} from "./mapNode.js";
+export {
+	isMapNodeSchema,
+	type MapNodeCustomizableSchema,
+	type MapNodePojoEmulationSchema,
+	MapNodeSchema,
+} from "./mapNodeTypes.js";

package/src/simple-tree/{mapNode.ts → node-kinds/map/mapNode.ts}

@@ -5,11 +5,12 @@
 
 import { Lazy } from "@fluidframework/core-utils/internal";
 import type {
+	FlexibleNodeContent,
 	FlexTreeNode,
 	FlexTreeOptionalField,
 	OptionalFieldEditBuilder,
-} from "../feature-libraries/index.js";
-import { getTreeNodeForField } from "./getTreeNodeForField.js";
+} from "../../../feature-libraries/index.js";
+import { getTreeNodeForField } from "../../getTreeNodeForField.js";
 import {
 	createFieldSchema,
 	FieldKind,
@@ -21,7 +22,7 @@ import {
 	type NodeSchemaMetadata,
 	type TreeNodeFromImplicitAllowedTypes,
 	type UnannotateImplicitAllowedTypes,
-} from "./schemaTypes.js";
+} from "../../schemaTypes.js";
 import {
 	getKernel,
 	type InnerNode,
@@ -32,20 +33,19 @@ import {
 	type TreeNode,
 	typeSchemaSymbol,
 	type Context,
-	UnhydratedFlexTreeNode,
 	getOrCreateInnerNode,
 	type InternalTreeNode,
-} from "./core/index.js";
+	type UnhydratedFlexTreeNode,
+} from "../../core/index.js";
 import {
-	mapTreeFromNodeData,
+	unhydratedFlexTreeFromInsertable,
 	type FactoryContent,
 	type InsertableContent,
-} from "./toMapTree.js";
-import { prepareForInsertion } from "./prepareForInsertion.js";
-import { brand, count, type RestrictiveStringRecord } from "../util/index.js";
-import { TreeNodeValid, type MostDerivedData } from "./treeNodeValid.js";
-import type { ExclusiveMapTree } from "../core/index.js";
-import { getUnhydratedContext } from "./createContext.js";
+} from "../../unhydratedFlexTreeFromInsertable.js";
+import { prepareForInsertion } from "../../prepareForInsertion.js";
+import { brand, count, type RestrictiveStringRecord } from "../../../util/index.js";
+import { TreeNodeValid, type MostDerivedData } from "../../treeNodeValid.js";
+import { getUnhydratedContext } from "../../createContext.js";
 import type { MapNodeCustomizableSchema, MapNodePojoEmulationSchema } from "./mapNodeTypes.js";
 
 /**
@@ -158,7 +158,7 @@ abstract class CustomMapNodeBase<const T extends ImplicitAllowedTypes> extends T
 		return getOrCreateInnerNode(this);
 	}
 
-	private editor(key: string): OptionalFieldEditBuilder<ExclusiveMapTree> {
+	private editor(key: string): OptionalFieldEditBuilder<FlexibleNodeContent> {
 		const field = this.innerNode.getBoxed(brand(key)) as FlexTreeOptionalField;
 		return field.editor;
 	}
@@ -271,10 +271,7 @@ export function mapSchema<
 			instance: TreeNodeValid<T2>,
 			input: T2,
 		): UnhydratedFlexTreeNode {
-			return UnhydratedFlexTreeNode.getOrCreate(
-				unhydratedContext,
-				mapTreeFromNodeData(input as FactoryContent, this as unknown as ImplicitAllowedTypes),
-			);
+			return unhydratedFlexTreeFromInsertable(input as FactoryContent, this as typeof Schema);
 		}
 
 		public static get allowedTypesIdentifiers(): ReadonlySet<string> {

package/src/simple-tree/{mapNodeTypes.ts → node-kinds/map/mapNodeTypes.ts}

@@ -7,16 +7,16 @@ import type { MapNodeInsertableData, TreeMapNode } from "./mapNode.js";
 import type {
 	ImplicitAnnotatedAllowedTypes,
 	UnannotateImplicitAllowedTypes,
-} from "./schemaTypes.js";
+} from "../../schemaTypes.js";
 import {
 	NodeKind,
 	type TreeNodeSchemaClass,
 	type TreeNodeSchema,
 	type TreeNodeSchemaNonClass,
 	type WithType,
-} from "./core/index.js";
+} from "../../core/index.js";
 
-import type { SimpleMapNodeSchema } from "./simpleSchema.js";
+import type { SimpleMapNodeSchema } from "../../simpleSchema.js";
 
 /**
  * A schema for customizable {@link (TreeMapNode:interface)}s.

package/src/simple-tree/node-kinds/object/index.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export {
+	createUnknownOptionalFieldPolicy,
+	type FieldHasDefault,
+	type InsertableObjectFromAnnotatedSchemaRecord,
+	type InsertableObjectFromSchemaRecord,
+	type ObjectFromSchemaRecord,
+	objectSchema,
+	setField,
+	type TreeObjectNode,
+} from "./objectNode.js";
+export { isObjectNodeSchema, ObjectNodeSchema } from "./objectNodeTypes.js";

package/src/simple-tree/{objectNode.ts → node-kinds/object/objectNode.ts}

@@ -6,32 +6,16 @@
 import { assert, Lazy, fail, debugAssert } from "@fluidframework/core-utils/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
-import type { FieldKey, SchemaPolicy } from "../core/index.js";
+import type { FieldKey, SchemaPolicy } from "../../../core/index.js";
 import {
 	FieldKinds,
 	type FlexTreeField,
 	type FlexTreeNode,
 	type FlexTreeOptionalField,
 	type FlexTreeRequiredField,
-} from "../feature-libraries/index.js";
-import { getTreeNodeForField } from "./getTreeNodeForField.js";
-import {
-	type ImplicitFieldSchema,
-	getStoredKey,
-	getExplicitStoredKey,
-	type TreeFieldFromImplicitField,
-	type InsertableTreeFieldFromImplicitField,
-	type FieldSchema,
-	normalizeFieldSchema,
-	type ImplicitAllowedTypes,
-	FieldKind,
-	type NodeSchemaMetadata,
-	type FieldSchemaAlpha,
-	ObjectFieldSchema,
-	type ImplicitAnnotatedFieldSchema,
-	unannotateSchemaRecord,
-	type UnannotateSchemaRecord,
-} from "./schemaTypes.js";
+} from "../../../feature-libraries/index.js";
+import type { RestrictiveStringRecord, FlattenKeys } from "../../../util/index.js";
+
 import {
 	type TreeNodeSchema,
 	NodeKind,
@@ -42,20 +26,39 @@ import {
 	type InternalTreeNode,
 	type TreeNode,
 	type Context,
-	UnhydratedFlexTreeNode,
+	type UnhydratedFlexTreeNode,
 	getOrCreateInnerNode,
-} from "./core/index.js";
-import { mapTreeFromNodeData, type InsertableContent } from "./toMapTree.js";
-import { prepareForInsertion } from "./prepareForInsertion.js";
-import type { RestrictiveStringRecord, FlattenKeys } from "../util/index.js";
+} from "../../core/index.js";
+import { getUnhydratedContext } from "../../createContext.js";
+import { getTreeNodeForField } from "../../getTreeNodeForField.js";
 import {
 	isObjectNodeSchema,
 	type ObjectNodeSchema,
 	type ObjectNodeSchemaInternalData,
 } from "./objectNodeTypes.js";
-import { TreeNodeValid, type MostDerivedData } from "./treeNodeValid.js";
-import { getUnhydratedContext } from "./createContext.js";
-import type { SimpleObjectFieldSchema } from "./simpleSchema.js";
+import { prepareForInsertion } from "../../prepareForInsertion.js";
+import {
+	type ImplicitFieldSchema,
+	getStoredKey,
+	getExplicitStoredKey,
+	type TreeFieldFromImplicitField,
+	type InsertableTreeFieldFromImplicitField,
+	type FieldSchema,
+	normalizeFieldSchema,
+	FieldKind,
+	type NodeSchemaMetadata,
+	type FieldSchemaAlpha,
+	ObjectFieldSchema,
+	type ImplicitAnnotatedFieldSchema,
+	unannotateSchemaRecord,
+	type UnannotateSchemaRecord,
+} from "../../schemaTypes.js";
+import type { SimpleObjectFieldSchema } from "../../simpleSchema.js";
+import {
+	unhydratedFlexTreeFromInsertable,
+	type InsertableContent,
+} from "../../unhydratedFlexTreeFromInsertable.js";
+import { TreeNodeValid, type MostDerivedData } from "../../treeNodeValid.js";
 
 /**
  * Generates the properties for an ObjectNode from its field schema object.
@@ -230,19 +233,6 @@ function createProxyHandler(
 					return getTreeNodeForField(field);
 				}
 
-				// TODO: this special case logic should move to the inner node (who's schema claims it has an identifier), rather than here, after we already read undefined out of a required field.
-				// Check if the user is trying to read an identifier field of an unhydrated node, but the identifier is not present.
-				// This means the identifier is an "auto-generated identifier", because otherwise it would have been supplied by the user at construction time and would have been successfully read just above.
-				// In this case, it is categorically impossible to provide an identifier (auto-generated identifiers can't be created until hydration/insertion time), so we emit an error.
-				if (
-					fieldInfo.schema.kind === FieldKind.Identifier &&
-					flexNode instanceof UnhydratedFlexTreeNode
-				) {
-					throw new UsageError(
-						"An automatically generated node identifier may not be queried until the node is inserted into the tree",
-					);
-				}
-
 				return undefined;
 			}
 
@@ -466,10 +456,7 @@ export function objectSchema<
 			instance: TreeNodeValid<T2>,
 			input: T2,
 		): UnhydratedFlexTreeNode {
-			return UnhydratedFlexTreeNode.getOrCreate(
-				unhydratedContext,
-				mapTreeFromNodeData(input as object, this as unknown as ImplicitAllowedTypes),
-			);
+			return unhydratedFlexTreeFromInsertable(input as object, this as Output);
 		}
 
 		protected static override constructorCached: MostDerivedData | undefined = undefined;

package/src/simple-tree/{objectNodeTypes.ts → node-kinds/object/objectNodeTypes.ts}

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { RestrictiveStringRecord } from "../util/index.js";
+import type { RestrictiveStringRecord } from "../../../util/index.js";
 import type {
 	TreeObjectNode,
 	SimpleKeyMap,
@@ -13,10 +13,10 @@ import type {
 	FieldSchemaAlpha,
 	ImplicitAnnotatedFieldSchema,
 	UnannotateSchemaRecord,
-} from "./schemaTypes.js";
-import { NodeKind, type TreeNodeSchemaClass, type TreeNodeSchema } from "./core/index.js";
-import type { FieldKey } from "../core/index.js";
-import type { SimpleObjectFieldSchema, SimpleObjectNodeSchema } from "./simpleSchema.js";
+} from "../../schemaTypes.js";
+import { NodeKind, type TreeNodeSchemaClass, type TreeNodeSchema } from "../../core/index.js";
+import type { FieldKey } from "../../../core/index.js";
+import type { SimpleObjectFieldSchema, SimpleObjectNodeSchema } from "../../simpleSchema.js";
 
 /**
  * A schema for {@link TreeObjectNode}s.