@fluidframework/tree 2.0.0-dev-rc.5.0.0.271045 → 2.0.0-dev-rc.5.0.0.271717

package/src/simple-tree/toMapTree.ts

@@ -11,7 +11,7 @@ import {
 	type FieldKey,
 	type MapTree,
 	type TreeValue,
-	ValueSchema,
+	type ValueSchema,
 	type SchemaAndPolicy,
 } from "../core/index.js";
 import {
@@ -21,13 +21,13 @@ import {
 	isTreeValue,
 	typeNameSymbol,
 	valueSchemaAllows,
-	NodeKeyManager,
+	type NodeKeyManager,
 	isMapTreeNode,
 } from "../feature-libraries/index.js";
 import { brand, fail, isReadonlyArray, find } from "../util/index.js";
 
 import { nullSchema } from "./leafNodeSchema.js";
-import { InsertableContent } from "./proxies.js";
+import type { InsertableContent } from "./proxies.js";
 import {
 	FieldKind,
 	FieldSchema,
@@ -40,7 +40,7 @@ import {
 	getStoredKey,
 	extractFieldProvider,
 	isConstant,
-	FieldProvider,
+	type FieldProvider,
 } from "./schemaTypes.js";
 import { SchemaValidationErrors, isNodeInSchema } from "../feature-libraries/index.js";
 import { tryGetFlexNode } from "./proxyBinding.js";

package/src/simple-tree/tree.ts

@@ -3,13 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidLoadable, IDisposable } from "@fluidframework/core-interfaces";
+import type { IFluidLoadable, IDisposable } from "@fluidframework/core-interfaces";
 
-import { CommitMetadata } from "../core/index.js";
-import { Listenable } from "../events/index.js";
-import { RevertibleFactory } from "../shared-tree/index.js";
+import type { CommitMetadata } from "../core/index.js";
+import type { Listenable } from "../events/index.js";
+import type { RevertibleFactory } from "../shared-tree/index.js";
 
-import {
+import type {
 	ImplicitFieldSchema,
 	InsertableTreeFieldFromImplicitField,
 	TreeFieldFromImplicitField,
@@ -57,30 +57,10 @@ export interface ITree extends IFluidLoadable {
 	viewWith<TRoot extends ImplicitFieldSchema>(
 		config: TreeViewConfiguration<TRoot>,
 	): TreeView<TRoot>;
-
-	/**
-	 * Returns a {@link TreeView} using the provided schema.
-	 * If the stored schema is view-compatible with the view schema specified by `config`,
-	 * the returned {@link TreeView} will expose the root with a schema-aware API based on the provided view schema.
-	 * See {@link TreeView.compatibility} for information about the compatibility between the view and stored schemas.
-	 *
-	 * @remarks
-	 * If the tree is uninitialized, it will be implicitly initialized by this function.
-	 *
-	 * Note that other clients can modify the document at any time, causing the view to change its compatibility status: see {@link TreeView.events} for how to handle invalidation in these cases.
-	 *
-	 * Only one schematized view may exist for a given ITree at a time.
-	 * If creating a second, the first must be disposed before calling `schematize` again.
-	 * @deprecated Replaced by {@link ITree.viewWith}. Use that method instead. Note that `viewWith` does not implicitly initialize the tree:
-	 * to initialize it, call {@link TreeView.initialize} on the returned view.
-	 */
-	schematize<TRoot extends ImplicitFieldSchema>(
-		config: TreeConfiguration<TRoot>,
-	): TreeView<TRoot>;
 }
 
 /**
- * Options when schematizing a tree.
+ * Options when constructing a tree view.
  * @public
  */
 export interface ITreeConfigurationOptions {
@@ -342,11 +322,6 @@ export interface SchemaCompatibilityStatus {
  * @public
  */
 export interface TreeViewEvents {
-	/**
-	 * A batch of changes has finished processing and the view has been updated.
-	 */
-	afterBatch(): void;
-
 	/**
 	 * Raised whenever {@link TreeView.root} is invalidated.
 	 *

package/src/simple-tree/treeNodeApi.ts

@@ -8,8 +8,8 @@ import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import { Multiplicity, rootFieldKey } from "../core/index.js";
 import {
 	FieldKinds,
-	LazyItem,
-	TreeStatus,
+	type LazyItem,
+	type TreeStatus,
 	isLazy,
 	isTreeValue,
 } from "../feature-libraries/index.js";
@@ -21,13 +21,13 @@ import { tryGetSimpleNodeSchema } from "./schemaCaching.js";
 import {
 	NodeKind,
 	type TreeLeafValue,
-	TreeNodeSchema,
+	type TreeNodeSchema,
 	type ImplicitFieldSchema,
 	FieldSchema,
-	ImplicitAllowedTypes,
-	TreeNodeFromImplicitAllowedTypes,
+	type ImplicitAllowedTypes,
+	type TreeNodeFromImplicitAllowedTypes,
 } from "./schemaTypes.js";
-import { TreeNode } from "./types.js";
+import type { TreeNode } from "./types.js";
 import {
 	booleanSchema,
 	handleSchema,
@@ -36,6 +36,7 @@ import {
 	stringSchema,
 } from "./leafNodeSchema.js";
 import { isFluidHandle } from "@fluidframework/runtime-utils/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * Provides various functions for analyzing {@link TreeNode}s.
@@ -101,11 +102,20 @@ export interface TreeNodeApi {
 	readonly status: (node: TreeNode) => TreeStatus;
 
 	/**
-	 * Returns the {@link FieldKind.Identifier | identifier} of the given node in the most compressed form possible.
+	 * Returns the {@link SchemaFactory.identifier | identifier} of the given node in the most compressed form possible.
 	 * @remarks
-	 * If the node's identifier is a valid `StableNodeKey`, then this will return a unique process-local integer corresponding to that identifier.
-	 * If the node's identifier is any other string, then this will return that string.
-	 * If the node has no identifier (that is, it has no field of an {@link FieldKind.Identifier | identifier} field kind), then this returns undefined.
+	 * If the node's identifier is a valid UUID that was automatically generated by the SharedTree, then this will return a process-unique integer corresponding to that identifier.
+	 * This is useful for performance-sensitive scenarios involving many nodes with identifiers that need to be compactly retained in memory or used for efficient lookup.
+	 *
+	 * If the node's identifier is any other user-provided string, then this will return that string.
+	 *
+	 * If the node has no identifier (that is, it has no {@link SchemaFactory.identifier | identifier} field), then this returns `undefined`.
+	 *
+	 * If the node has more than one identifier, then this will throw an error.
+	 *
+	 * The returned integer must not be serialized or preserved outside of the current process.
+	 * Its lifetime is that of the current in-memory instance of the FF container for this client, and it is not guaranteed to be unique or stable outside of that context.
+	 * The same node's identifier may, for example, be different across multiple sessions for the same client and document, or different across two clients in the same session.
 	 */
 	shortId(node: TreeNode): number | string | undefined;
 }
@@ -188,18 +198,26 @@ export const treeNodeApi: TreeNodeApi = {
 	},
 	shortId(node: TreeNode): number | string | undefined {
 		const flexNode = getFlexNode(node);
+		let shortId: number | string | undefined;
 		for (const field of flexNode.boxedIterator()) {
 			if (field.schema.kind === FieldKinds.identifier) {
+				if (shortId !== undefined) {
+					throw new UsageError(
+						"shortId() may not be called on a node with more than one identifier. Consider converting extraneous identifier fields to string fields.",
+					);
+				}
 				const identifier = field.boxedAt(0);
 				assert(identifier !== undefined, 0x927 /* The identifier must exist */);
 				const identifierValue = identifier.value as string;
 				const localNodeKey =
 					identifier.context.nodeKeyManager.tryLocalizeNodeKey(identifierValue);
-				return localNodeKey !== undefined
-					? extractFromOpaque(localNodeKey)
-					: identifierValue;
+
+				shortId =
+					localNodeKey !== undefined ? extractFromOpaque(localNodeKey) : identifierValue;
 			}
 		}
+
+		return shortId;
 	},
 };
 
@@ -285,7 +303,7 @@ function getViewKeyFromStoredKey(
 }
 
 /**
- * A collection of events that can be raised by a {@link TreeNode}.
+ * A collection of events that can be emitted by a {@link TreeNode}.
  *
  * @privateRemarks
  * TODO: add a way to subscribe to a specific field (for nodeChanged and treeChanged).
@@ -307,7 +325,8 @@ function getViewKeyFromStoredKey(
  */
 export interface TreeChangeEvents {
 	/**
-	 * Emitted by a node when a batch of changes is applied to it, where a change is:
+	 * Emitted by a node after a batch of changes has been applied to the tree, if a change affected the node, where a
+	 * change is:
 	 *
 	 * - For an object node, when the value of one of its properties changes (i.e., the property's value is set
 	 * to something else, including `undefined`).
@@ -317,20 +336,19 @@ export interface TreeChangeEvents {
 	 * - For a map node, when an entry is added, updated, or removed.
 	 *
 	 * @remarks
-	 * This event is not raised when:
+	 * This event is not emitted when:
 	 *
 	 * - Properties of a child node change. Notably, updates to an array node or a map node (like adding or removing
-	 * elements/entries) will raise this event on the array/map node itself, but not on the node that contains the
+	 * elements/entries) will emit this event on the array/map node itself, but not on the node that contains the
 	 * array/map node as one of its properties.
 	 *
 	 * - The node is moved to a different location in the tree or removed from the tree.
-	 * In this case the event is raised on the _parent_ node, not the node itself.
+	 * In this case the event is emitted on the _parent_ node, not the node itself.
 	 *
 	 * For remote edits, this event is not guaranteed to occur in the same order or quantity that it did in
 	 * the client that made the original edit.
-	 * While a batch of edits will as a whole update the tree to the appropriate end state, no guarantees are made about
-	 * how many times this event will be raised during any intermediate states.
-	 * When it is raised, the tree is guaranteed to be in-schema.
+	 *
+	 * When it is emitted, the tree is guaranteed to be in-schema.
 	 *
 	 * @privateRemarks
 	 * This event occurs whenever the apparent contents of the node instance change, regardless of what caused the change.
@@ -341,26 +359,20 @@ export interface TreeChangeEvents {
 	nodeChanged(): void;
 
 	/**
-	 * Emitted by a node when something _may_ have changed anywhere in the subtree rooted at it.
+	 * Emitted by a node after a batch of changes has been applied to the tree, when something changed anywhere in the
+	 * subtree rooted at it.
 	 *
 	 * @remarks
-	 * This event is guaranteed to be emitted whenever the subtree _has_ changed.
-	 * However, it might also be emitted when the subtree has no visible changes compared to before the event firing.
-	 *
-	 * Consumers of this event have the guarantee that they won't miss any changes, but should also handle the scenario
-	 * where the event fires with no visible changes as well.
-	 *
-	 * This event is not raised when the node itself is moved to a different location in the tree or removed from the tree.
-	 * In that case it is raised on the _parent_ node, not the node itself.
+	 * This event is not emitted when the node itself is moved to a different location in the tree or removed from the tree.
+	 * In that case it is emitted on the _parent_ node, not the node itself.
 	 *
 	 * The node itself is part of the subtree, so this event will be emitted even if the only changes are to the properties
 	 * of the node itself.
 	 *
 	 * For remote edits, this event is not guaranteed to occur in the same order or quantity that it did in
 	 * the client that made the original edit.
-	 * While a batch of edits will as a whole update the tree to the appropriate end state, no guarantees are made about
-	 * how many times this event will be raised during any intermediate states.
-	 * When it is raised, the tree is guaranteed to be in-schema.
+	 *
+	 * When it is emitted, the tree is guaranteed to be in-schema.
 	 */
 	treeChanged(): void;
 }

package/src/simple-tree/types.ts

@@ -3,13 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import { ErasedType } from "@fluidframework/core-interfaces";
+import type { ErasedType } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
 
-import { TreeNodeSchema, WithType, type } from "./schemaTypes.js";
+import { NodeKind, type TreeNodeSchema, type WithType, type } from "./schemaTypes.js";
 import {
-	FlexTreeNode,
-	MapTreeNode,
+	type FlexTreeNode,
+	type MapTreeNode,
 	isFlexTreeNode,
 	markEager,
 } from "../feature-libraries/index.js";
@@ -19,6 +19,7 @@ import { UsageError } from "@fluidframework/telemetry-utils/internal";
 import { getFlexSchema } from "./toFlexSchema.js";
 import { fail } from "../util/index.js";
 import { setFlexNode } from "./proxyBinding.js";
+import { tryGetSchema } from "./treeNodeApi.js";
 
 /**
  * Type alias to document which values are un-hydrated.
@@ -32,7 +33,7 @@ import { setFlexNode } from "./proxyBinding.js";
 export type Unhydrated<T> = T;
 
 /**
- * A non-leaf SharedTree node. Includes objects, arrays, and maps.
+ * A non-{@link NodeKind.Leaf|leaf} SharedTree node. Includes objects, arrays, and maps.
  *
  * @remarks
  * Base type which all nodes implement.
@@ -50,11 +51,8 @@ export type Unhydrated<T> = T;
  *
  * Not all node implementations include this in their prototype chain (some hide it with a proxy),
  * and thus cause the default/built in `instanceof` to return false despite our type checking and all other APIs treating them as TreeNodes.
- * This results in the runtime and compile time behavior of `instanceof` differing.
- * TypeScript 5.3 allows altering the compile time behavior of `instanceof`.
- * The runtime behavior can be changed by implementing `Symbol.hasInstance`.
- * One of those approaches could be used to resolve this inconsistency,
- * but for now the type-only export prevents use of `instanceof` avoiding this problem in the public API.
+ * This class provides a custom `Symbol.hasInstance` to fix `instanceof` for this class and all classes extending it.
+ * For now the type-only export prevents use of `instanceof` on this class (but allows it in subclasses like schema classes).
  * @public
  */
 export abstract class TreeNode implements WithType {
@@ -80,7 +78,7 @@ export abstract class TreeNode implements WithType {
 	 * Another option would be to use a symbol (possibly as a private field).
 	 * That approach ran into some strange difficulties causing SchemaFactory to fail to compile, and was not investigated further.
 	 *
-	 * The [type] symbol here provides a lot of the value this private brand does, but is not all of it:
+	 * The [type] symbol provides a lot of the value this private brand does, but is not all of it:
 	 * someone could manually (or via Intellisense auto-implement completion, or in response to a type error)
 	 * make an object literal with the [type] field and pass it off as a node: this private brand prevents that.
 	 */
@@ -93,13 +91,63 @@ export abstract class TreeNode implements WithType {
 	 */
 	public abstract get [type](): string;
 
+	/**
+	 * Provides `instanceof` support for testing if a value is a `TreeNode`.
+	 * @remarks
+	 * For more options, like including leaf values or narrowing to collections of schema, use `is` or `schema` from {@link TreeNodeApi}.
+	 * @privateRemarks
+	 * Due to type-only export, this functionality is not available outside the package.
+	 */
+	public static [Symbol.hasInstance](value: unknown): value is TreeNode;
+
+	/**
+	 * Provides `instanceof` support for all schema classes with public constructors.
+	 * @remarks
+	 * For more options, like including leaf values or narrowing to collections of schema, use `is` or `schema` from {@link TreeNodeApi}.
+	 * @privateRemarks
+	 * Despite type-only export, this functionality is available outside the package since it is inherited by subclasses.
+	 */
+	public static [Symbol.hasInstance]<TSchema extends abstract new (...args: any[]) => TreeNode>(
+		this: TSchema,
+		value: unknown,
+	): value is InstanceType<TSchema>;
+
+	public static [Symbol.hasInstance](this: { prototype: object }, value: unknown): boolean {
+		const schema = tryGetSchema(value);
+
+		if (schema === undefined || schema.kind === NodeKind.Leaf) {
+			return false;
+		}
+
+		assert("prototype" in schema, "expected class based schema");
+		return inPrototypeChain(schema.prototype, this.prototype);
+	}
+
 	protected constructor() {
-		if (!(this instanceof TreeNodeValid)) {
+		if (!inPrototypeChain(Reflect.getPrototypeOf(this), TreeNodeValid.prototype)) {
 			throw new UsageError("TreeNodes must extend schema classes created by SchemaFactory");
 		}
 	}
 }
 
+/**
+ * Check if the prototype derived's prototype chain contains `base`.
+ * @param derived - prototype to check
+ * @param base - prototype to search for
+ * @returns true iff `base` is in the prototype chain starting at `derived`.
+ */
+// eslint-disable-next-line @rushstack/no-new-null
+export function inPrototypeChain(derived: object | null, base: object): boolean {
+	let checking = derived;
+	while (checking !== null) {
+		if (base === checking) {
+			return true;
+		}
+		checking = Reflect.getPrototypeOf(checking);
+	}
+	return false;
+}
+
 /**
  * Class which all {@link TreeNode}s must extend.
  * Since this is not exported, it allows robust detection of attempts to create TreeNodes which do not go through SchemaFactory which is the only place which exposes classes that extend this.

package/src/simple-tree/typesUnsafe.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { InternalFlexListTypes, Unenforced } from "../feature-libraries/index.js";
-import { RestrictiveReadonlyRecord } from "../util/index.js";
+import type { InternalFlexListTypes, Unenforced } from "../feature-libraries/index.js";
+import type { RestrictiveReadonlyRecord } from "../util/index.js";
 
-import {
+import type {
 	AllowedTypes,
 	ApplyKind,
 	FieldKind,
-	type FieldSchema,
+	FieldSchema,
 	ImplicitAllowedTypes,
 	ImplicitFieldSchema,
 	NodeFromSchema,
@@ -19,8 +19,8 @@ import {
 	TreeNodeSchema,
 	WithType,
 } from "./schemaTypes.js";
-import { TreeArrayNodeBase, TreeArrayNode } from "./arrayNode.js";
-import { TreeNode, Unhydrated } from "./types.js";
+import type { TreeArrayNodeBase, TreeArrayNode } from "./arrayNode.js";
+import type { TreeNode, Unhydrated } from "./types.js";
 
 /*
  * TODO:

package/src/treeFactory.ts

@@ -3,21 +3,21 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IChannelAttributes,
 	IChannelFactory,
 	IFluidDataStoreRuntime,
 	IChannelServices,
 } from "@fluidframework/datastore-definitions/internal";
-import { SharedObjectKind } from "@fluidframework/shared-object-base";
+import type { SharedObjectKind } from "@fluidframework/shared-object-base";
 import {
-	ISharedObjectKind,
+	type ISharedObjectKind,
 	createSharedObjectKind,
 } from "@fluidframework/shared-object-base/internal";
 
 import { pkgVersion } from "./packageVersion.js";
-import { SharedTree as SharedTreeImpl, SharedTreeOptions } from "./shared-tree/index.js";
-import { ITree } from "./simple-tree/index.js";
+import { SharedTree as SharedTreeImpl, type SharedTreeOptions } from "./shared-tree/index.js";
+import type { ITree } from "./simple-tree/index.js";
 
 /**
  * A channel factory that creates an {@link ITree}.

package/src/util/brandedMap.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { Invariant } from "./typeCheck.js";
+import type { Invariant } from "./typeCheck.js";
 import { getOrCreate } from "./utils.js";
 
 /**

package/src/util/nestedMap.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { MapGetSet } from "./utils.js";
+import type { MapGetSet } from "./utils.js";
 
 /**
  * A dictionary whose values are keyed off of two objects (key1, key2).

package/src/util/nestedSet.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { NestedMap, getOrDefaultInNestedMap, setInNestedMap } from "./nestedMap.js";
+import { type NestedMap, getOrDefaultInNestedMap, setInNestedMap } from "./nestedMap.js";
 
 export type NestedSet<Key1, Key2> = NestedMap<Key1, Key2, boolean>;
 

package/src/util/typeboxBrand.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { NumberOptions, TUnsafe, Type } from "@sinclair/typebox";
+import { type NumberOptions, type TUnsafe, Type } from "@sinclair/typebox";
 
 /**
  * Create a TypeBox string schema for a branded string type.