@fluidframework/tree 2.10.0 → 2.12.0

package/src/core/schema-stored/format.ts

@@ -14,7 +14,6 @@ export const version = 1 as const;
  * Key (aka Name or Label) for a field which is scoped to a specific TreeNodeStoredSchema.
  *
  * Stable identifier, used when persisting data.
- * @internal
  */
 export type FieldKey = Brand<string, "tree.FieldKey">;
 
@@ -28,7 +27,6 @@ export const FieldKeySchema = brandedStringType<FieldKey>();
  * Also known as "Definition"
  *
  * Stable identifier, used when persisting data.
- * @internal
  */
 export type TreeNodeSchemaIdentifier<TName extends string = string> = Brand<
 	TName,
@@ -40,7 +38,6 @@ export type TreeNodeSchemaIdentifier<TName extends string = string> = Brand<
  * Refers to an exact stable policy (ex: specific version of a policy),
  * for how to handle (ex: edit and merge edits to) fields marked with this kind.
  * Persisted in documents as part of stored schema.
- * @internal
  */
 export type FieldKindIdentifier = Brand<string, "tree.FieldKindIdentifier">;
 export const FieldKindIdentifierSchema = brandedStringType<FieldKindIdentifier>();

package/src/core/schema-stored/schema.ts

@@ -17,7 +17,9 @@ import {
 import type { Multiplicity } from "./multiplicity.js";
 
 /**
- * Schema for what {@link TreeValue} is allowed on a Leaf node.
+ * Schema for what {@link TreeLeafValue} is allowed on a Leaf node.
+ * @privateRemarks
+ * See also {@link TreeValue}.
  * @internal
  */
 export enum ValueSchema {
@@ -51,7 +53,6 @@ export enum ValueSchema {
  * - Constrain the types allowed based on which types guarantee their data will always meet the constraints.
  *
  * Care would need to be taken to make sure this is sound for the schema updating mechanisms.
- * @internal
  */
 export type TreeTypeSet = ReadonlySet<TreeNodeSchemaIdentifier>;
 
@@ -91,12 +92,21 @@ export interface SchemaPolicy {
 	 * If true, new content inserted into the tree should be validated against the stored schema.
 	 */
 	readonly validateSchema: boolean;
+
+	/**
+	 * Whether to allow a document to be opened when a particular stored schema (identified by `identifier`)
+	 * contains optional fields that are not known to the view schema.
+	 *
+	 * @privateRemarks
+	 * Plumbing this in via `SchemaPolicy` avoids needing to walk the view schema representation repeatedly in places
+	 * that need it (schema validation, view vs stored compatibility checks).
+	 */
+	allowUnknownOptionalFields(identifier: TreeNodeSchemaIdentifier): boolean;
 }
 
 /**
  * Schema for a field.
  * Object implementing this interface should never be modified.
- * @internal
  */
 export interface TreeFieldStoredSchema {
 	readonly kind: FieldKindIdentifier;
@@ -136,7 +146,6 @@ export const identifierFieldKindIdentifier = "Identifier";
 
 /**
  * Opaque type erased handle to the encoded representation of the contents of a stored schema.
- * @internal
  */
 export interface ErasedTreeNodeSchemaDataFormat
 	extends ErasedType<"TreeNodeSchemaDataFormat"> {}
@@ -154,7 +163,6 @@ export function toTreeNodeSchemaDataFormat(
 }
 
 /**
- * @internal
  */
 export abstract class TreeNodeStoredSchema {
 	protected _typeCheck!: MakeNominal;
@@ -174,7 +182,6 @@ export abstract class TreeNodeStoredSchema {
 }
 
 /**
- * @internal
  */
 export class ObjectNodeStoredSchema extends TreeNodeStoredSchema {
 	/**
@@ -214,7 +221,6 @@ export class ObjectNodeStoredSchema extends TreeNodeStoredSchema {
 }
 
 /**
- * @internal
  */
 export class MapNodeStoredSchema extends TreeNodeStoredSchema {
 	/**
@@ -241,7 +247,6 @@ export class MapNodeStoredSchema extends TreeNodeStoredSchema {
 }
 
 /**
- * @internal
  */
 export class LeafNodeStoredSchema extends TreeNodeStoredSchema {
 	/**
@@ -330,7 +335,6 @@ export function decodeFieldSchema(schema: FieldSchemaFormat): TreeFieldStoredSch
  * @remarks
  * Note: the owner of this may modify it over time:
  * thus if needing to hand onto a specific version, make a copy.
- * @internal
  */
 export interface TreeStoredSchema extends StoredSchemaCollection {
 	/**
@@ -345,7 +349,6 @@ export interface TreeStoredSchema extends StoredSchemaCollection {
  * @remarks
  * Note: the owner of this may modify it over time:
  * thus if needing to hang onto a specific version, make a copy.
- * @internal
  */
 export interface StoredSchemaCollection {
 	/**

package/src/core/schema-stored/storedSchemaRepository.ts

@@ -5,7 +5,8 @@
 
 import { BTree } from "@tylerbu/sorted-btree-es6";
 
-import { type Listenable, createEmitter } from "../../events/index.js";
+import type { Listenable } from "@fluidframework/core-interfaces/internal";
+import { createEmitter } from "@fluid-internal/client-utils";
 import { compareStrings } from "../../util/index.js";
 
 import type { TreeNodeSchemaIdentifier } from "./format.js";

package/src/core/schema-view/index.ts

@@ -5,7 +5,6 @@
 
 export {
 	type Adapters,
-	Compatibility,
 	type TreeAdapter,
 	AdaptedViewSchema,
 	AllowedUpdateType,

package/src/core/schema-view/view.ts

@@ -9,17 +9,6 @@ import type { TreeNodeSchemaIdentifier, TreeStoredSchema } from "../schema-store
  * APIs for applying `view schema` to documents.
  */
 
-/**
- * How compatible a particular view schema is for some operation on some specific document.
- */
-export enum Compatibility {
-	Incompatible,
-	// For write compatibility this can include compatible schema updates to stored schema.
-	// TODO: separate schema updates from adapters.
-	// RequiresAdapters,
-	Compatible,
-}
-
 /**
  * What kinds of updates to stored schema to permit.
  *

package/src/core/tree/anchorSet.ts

@@ -7,7 +7,8 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 
-import { type Listenable, createEmitter } from "../../events/index.js";
+import type { Listenable } from "@fluidframework/core-interfaces/internal";
+import { createEmitter } from "@fluid-internal/client-utils";
 import {
 	type Brand,
 	type BrandedKey,

package/src/{feature-libraries/chunked-forest → core/tree}/chunk.ts

@@ -5,14 +5,14 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 
+import type { ReferenceCounted } from "../../util/index.js";
+import type { FieldKey } from "../schema-stored/index.js";
+import { rootFieldKey } from "./types.js";
 import {
 	CursorLocationType,
-	type FieldKey,
 	type ITreeCursor,
 	type ITreeCursorSynchronous,
-	rootFieldKey,
-} from "../../core/index.js";
-import type { ReferenceCounted } from "../../util/index.js";
+} from "./cursor.js";
 
 /**
  * Contiguous part of the tree which get stored together in some data format.

package/src/core/tree/detachedFieldIndexCodec.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert, oob } from "@fluidframework/core-utils/internal";
+import { assert } from "@fluidframework/core-utils/internal";
 
 import {
 	type ICodecOptions,
@@ -24,6 +24,7 @@ import type {
 	Major,
 } from "./detachedFieldIndexTypes.js";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
+import { hasSingle } from "../../util/index.js";
 
 class MajorCodec implements IJsonCodec<Major> {
 	public constructor(
@@ -83,8 +84,8 @@ export function makeDetachedNodeToFieldCodec(
 				for (const [minor, detachedField] of innerMap) {
 					rootRanges.push([minor, detachedField.root]);
 				}
-				if (rootRanges.length === 1) {
-					const firstRootRange = rootRanges[0] ?? oob();
+				if (hasSingle(rootRanges)) {
+					const firstRootRange = rootRanges[0];
 					const rootsForRevision: EncodedRootsForRevision = [
 						encodedRevision,
 						firstRootRange[0],

package/src/core/tree/index.ts

@@ -94,6 +94,7 @@ export {
 	type AnnouncedVisitor,
 	announceDelta,
 	applyDelta,
+	createAnnouncedVisitor,
 	combineVisitors,
 	makeDetachedFieldIndex,
 } from "./visitorUtils.js";
@@ -110,5 +111,13 @@ export {
 	emptyDelta,
 } from "./deltaUtil.js";
 
+export {
+	type TreeChunk,
+	dummyRoot,
+	cursorChunk,
+	tryGetChunk,
+	type ChunkedCursor,
+} from "./chunk.js";
+
 export { DetachedFieldIndex } from "./detachedFieldIndex.js";
 export { type ForestRootId } from "./detachedFieldIndexTypes.js";

package/src/core/tree/treeTextFormat.ts

@@ -49,8 +49,6 @@ import type { NodeData } from "./types.js";
  * Only use this type when needed for json compatible maps,
  * but even in those cases consider lists of key value pairs for serialization and using `Map`
  * for runtime.
- *
- * @internal
  */
 export interface FieldMapObject<TChild> {
 	[key: string]: TChild[];
@@ -59,14 +57,12 @@ export interface FieldMapObject<TChild> {
 /**
  * Json comparable tree node, generic over child type.
  * Json compatibility assumes `TChild` is also json compatible.
- * @internal
  */
 export interface GenericTreeNode<TChild> extends GenericFieldsNode<TChild>, NodeData {}
 
 /**
  * Json comparable field collection, generic over child type.
  * Json compatibility assumes `TChild` is also json compatible.
- * @internal
  */
 export interface GenericFieldsNode<TChild> {
 	fields?: FieldMapObject<TChild>;
@@ -79,7 +75,6 @@ export interface GenericFieldsNode<TChild> {
  * {@link @fluidframework/shared-object-base#IFluidSerializer.stringify} must be used instead of `JSON.stringify`.
  *
  * JsonableTrees should not store empty fields.
- * @internal
  */
 export interface JsonableTree extends GenericTreeNode<JsonableTree> {}
 

package/src/core/tree/types.ts

@@ -33,7 +33,6 @@ export type TreeType = TreeNodeSchemaIdentifier;
  * This has to be a FieldKey since different nodes will have different TreeFieldStoredSchema for it.
  * This makes it prone to collisions and suggests
  * that this intention may be better conveyed by metadata on the ITreeSchema.
- * @internal
  */
 export const EmptyKey: FieldKey = brand("");
 
@@ -116,7 +115,6 @@ export interface FieldKind {
 
 /**
  * Value that may be stored on a leaf node.
- * @internal
  */
 export type TreeValue<TSchema extends ValueSchema = ValueSchema> = [
 	{
@@ -131,7 +129,6 @@ export type TreeValue<TSchema extends ValueSchema = ValueSchema> = [
 
 /**
  * Value stored on a node.
- * @internal
  */
 export type Value = undefined | TreeValue;
 
@@ -141,8 +138,6 @@ export type Value = undefined | TreeValue;
  * @privateRemarks A forked version of this type is used in `persistedTreeTextFormat.ts`.
  * Changes to this type might necessitate changes to `EncodedNodeData` or codecs.
  * See persistedTreeTextFormat's module documentation for more details.
- *
- * @internal
  */
 export interface NodeData {
 	/**

package/src/core/tree/visitorUtils.ts

@@ -13,7 +13,7 @@ import type { FieldKey } from "../schema-stored/index.js";
 import type { ProtoNodes, Root } from "./delta.js";
 import { DetachedFieldIndex } from "./detachedFieldIndex.js";
 import type { ForestRootId } from "./detachedFieldIndexTypes.js";
-import type { PlaceIndex, Range } from "./pathTree.js";
+import type { NodeIndex, PlaceIndex, Range } from "./pathTree.js";
 import { type DeltaVisitor, visitDelta } from "./visitDelta.js";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
@@ -133,3 +133,58 @@ export interface AnnouncedVisitor extends DeltaVisitor {
 	): void;
 	afterReplace(newContentSource: FieldKey, newContent: Range, oldContent: FieldKey): void;
 }
+
+/**
+ * Creates an announced visitor with only the provided functions and uses a no op for the rest.
+ * This is provided to make some of the delta visitor definitions cleaner.
+ */
+export function createAnnouncedVisitor(visitorFunctions: {
+	free?: () => void;
+	create?: (content: ProtoNodes, destination: FieldKey) => void;
+	afterCreate?: (content: ProtoNodes, destination: FieldKey) => void;
+	beforeDestroy?: (field: FieldKey, count: number) => void;
+	destroy?: (detachedField: FieldKey, count: number) => void;
+	beforeAttach?: (source: FieldKey, count: number, destination: PlaceIndex) => void;
+	attach?: (source: FieldKey, count: number, destination: PlaceIndex) => void;
+	afterAttach?: (source: FieldKey, destination: Range) => void;
+	beforeDetach?: (source: Range, destination: FieldKey) => void;
+	afterDetach?: (source: PlaceIndex, count: number, destination: FieldKey) => void;
+	detach?: (source: Range, destination: FieldKey) => void;
+	beforeReplace?: (
+		newContent: FieldKey,
+		oldContent: Range,
+		oldContentDestination: FieldKey,
+	) => void;
+	replace?: (
+		newContentSource: FieldKey,
+		range: Range,
+		oldContentDestination: FieldKey,
+	) => void;
+	afterReplace?: (newContentSource: FieldKey, newContent: Range, oldContent: FieldKey) => void;
+	enterNode?: (index: NodeIndex) => void;
+	exitNode?: (index: NodeIndex) => void;
+	enterField?: (key: FieldKey) => void;
+	exitField?: (key: FieldKey) => void;
+}): AnnouncedVisitor {
+	const noOp = (): void => {};
+	return {
+		free: visitorFunctions.free ?? noOp,
+		create: visitorFunctions.create ?? noOp,
+		afterCreate: visitorFunctions.afterCreate ?? noOp,
+		beforeDestroy: visitorFunctions.beforeDestroy ?? noOp,
+		destroy: visitorFunctions.destroy ?? noOp,
+		beforeAttach: visitorFunctions.beforeAttach ?? noOp,
+		attach: visitorFunctions.attach ?? noOp,
+		afterAttach: visitorFunctions.afterAttach ?? noOp,
+		beforeDetach: visitorFunctions.beforeDetach ?? noOp,
+		detach: visitorFunctions.detach ?? noOp,
+		afterDetach: visitorFunctions.afterDetach ?? noOp,
+		beforeReplace: visitorFunctions.beforeReplace ?? noOp,
+		replace: visitorFunctions.replace ?? noOp,
+		afterReplace: visitorFunctions.afterReplace ?? noOp,
+		enterNode: visitorFunctions.enterNode ?? noOp,
+		exitNode: visitorFunctions.exitNode ?? noOp,
+		enterField: visitorFunctions.enterField ?? noOp,
+		exitField: visitorFunctions.exitField ?? noOp,
+	};
+}

package/src/feature-libraries/chunked-forest/basicChunk.ts

@@ -15,12 +15,14 @@ import {
 	type TreeValue,
 	type UpPath,
 	type Value,
+	type ChunkedCursor,
+	type TreeChunk,
+	cursorChunk,
+	dummyRoot,
 } from "../../core/index.js";
 import { ReferenceCountedBase, fail } from "../../util/index.js";
 import { SynchronousCursor, prefixPath } from "../treeCursorUtils.js";
 
-import { type ChunkedCursor, type TreeChunk, cursorChunk, dummyRoot } from "./chunk.js";
-
 /**
  * General purpose one node chunk.
  */

package/src/feature-libraries/chunked-forest/chunkTree.ts

@@ -21,12 +21,13 @@ import {
 	mapCursorFields,
 	Multiplicity,
 	ValueSchema,
+	type TreeChunk,
+	tryGetChunk,
 } from "../../core/index.js";
 import { fail, getOrCreate } from "../../util/index.js";
 import type { FullSchemaPolicy } from "../modular-schema/index.js";
 
 import { BasicChunk } from "./basicChunk.js";
-import { type TreeChunk, tryGetChunk } from "./chunk.js";
 import { SequenceChunk } from "./sequenceChunk.js";
 import { type FieldShape, TreeShape, UniformChunk } from "./uniformChunk.js";
 import { isStableNodeKey } from "../node-key/index.js";

package/src/feature-libraries/chunked-forest/chunkedForest.ts

@@ -4,10 +4,13 @@
  */
 
 import { assert, oob } from "@fluidframework/core-utils/internal";
+import type { Listenable } from "@fluidframework/core-interfaces";
+import { createEmitter } from "@fluid-internal/client-utils";
 
 import {
 	type Anchor,
 	AnchorSet,
+	type AnnouncedVisitor,
 	type DeltaVisitor,
 	type DetachedField,
 	type FieldAnchor,
@@ -24,15 +27,23 @@ import {
 	type TreeStoredSchemaSubscription,
 	type UpPath,
 	aboveRootPlaceholder,
+	combineVisitors,
 	detachedFieldAsKey,
 	mapCursorField,
 	rootFieldKey,
+	type ChunkedCursor,
+	type TreeChunk,
 } from "../../core/index.js";
-import { createEmitter, type Listenable } from "../../events/index.js";
-import { assertValidRange, brand, fail, getOrAddEmptyToMap } from "../../util/index.js";
+import {
+	assertValidRange,
+	brand,
+	fail,
+	getLast,
+	getOrAddEmptyToMap,
+	hasSome,
+} from "../../util/index.js";
 
 import { BasicChunk, BasicChunkCursor, type SiblingsOrKey } from "./basicChunk.js";
-import type { ChunkedCursor, TreeChunk } from "./chunk.js";
 import { type IChunker, basicChunkTree, chunkTree } from "./chunkTree.js";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
@@ -53,6 +64,7 @@ interface StackNode {
 export class ChunkedForest implements IEditableForest {
 	private activeVisitor?: DeltaVisitor;
 
+	private readonly deltaVisitors: Set<() => AnnouncedVisitor> = new Set();
 	readonly #events = createEmitter<ForestEvents>();
 	public readonly events: Listenable<ForestEvents> = this.#events;
 
@@ -83,6 +95,14 @@ export class ChunkedForest implements IEditableForest {
 		this.anchors.forget(anchor);
 	}
 
+	public registerAnnouncedVisitor(visitor: () => AnnouncedVisitor): void {
+		this.deltaVisitors.add(visitor);
+	}
+
+	public deregisterAnnouncedVisitor(visitor: () => AnnouncedVisitor): void {
+		this.deltaVisitors.delete(visitor);
+	}
+
 	public acquireVisitor(): DeltaVisitor {
 		assert(
 			this.activeVisitor === undefined,
@@ -93,15 +113,15 @@ export class ChunkedForest implements IEditableForest {
 			this.roots = this.roots.clone();
 		}
 
-		const visitor = {
+		const forestVisitor = {
 			forest: this,
 			// Current location in the tree, as a non-shared BasicChunk (TODO: support in-place modification of other chunk formats when possible).
 			// Start above root detached sequences.
 			mutableChunkStack: [] as StackNode[],
 			mutableChunk: this.roots as BasicChunk | undefined,
 			getParent(): StackNode {
-				assert(this.mutableChunkStack.length > 0, 0x532 /* invalid access to root's parent */);
-				return this.mutableChunkStack[this.mutableChunkStack.length - 1] ?? oob();
+				assert(hasSome(this.mutableChunkStack), 0x532 /* invalid access to root's parent */);
+				return getLast(this.mutableChunkStack);
 			},
 			free(): void {
 				this.mutableChunk = undefined;
@@ -262,8 +282,15 @@ export class ChunkedForest implements IEditableForest {
 				this.mutableChunk = top.mutableChunk;
 			},
 		};
-		this.activeVisitor = visitor;
-		return visitor;
+
+		const announcedVisitors: AnnouncedVisitor[] = [];
+		this.deltaVisitors.forEach((getVisitor) => announcedVisitors.push(getVisitor()));
+		const combinedVisitor = combineVisitors(
+			[forestVisitor, ...announcedVisitors],
+			announcedVisitors,
+		);
+		this.activeVisitor = combinedVisitor;
+		return combinedVisitor;
 	}
 
 	private nextDetachedFieldIdentifier = 0;

package/src/feature-libraries/chunked-forest/codec/chunkCodecUtilities.ts

@@ -5,10 +5,9 @@
 
 import { assert, oob } from "@fluidframework/core-utils/internal";
 
-import type { TreeValue } from "../../../core/index.js";
+import type { TreeValue, TreeChunk } from "../../../core/index.js";
 import { assertValidIndex } from "../../../util/index.js";
 import { type FluidSerializableReadOnly, assertAllowedValue } from "../../valueUtilities.js";
-import type { TreeChunk } from "../chunk.js";
 
 /**
  * Utilities related to chunk encoding and decoding that do not depend on specific chunk types or formats.

package/src/feature-libraries/chunked-forest/codec/chunkDecoding.ts

@@ -6,10 +6,14 @@
 import { assert, unreachableCase, oob } from "@fluidframework/core-utils/internal";
 
 import { DiscriminatedUnionDispatcher } from "../../../codec/index.js";
-import type { FieldKey, TreeNodeSchemaIdentifier, Value } from "../../../core/index.js";
+import type {
+	FieldKey,
+	TreeNodeSchemaIdentifier,
+	Value,
+	TreeChunk,
+} from "../../../core/index.js";
 import { assertValidIndex } from "../../../util/index.js";
 import { BasicChunk } from "../basicChunk.js";
-import type { TreeChunk } from "../chunk.js";
 import { emptyChunk } from "../emptyChunk.js";
 import { SequenceChunk } from "../sequenceChunk.js";
 

package/src/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.ts

@@ -7,7 +7,7 @@ import { assert } from "@fluidframework/core-utils/internal";
 
 import type { DiscriminatedUnionDispatcher } from "../../../codec/index.js";
 import type { BrandedType } from "../../../util/index.js";
-import type { TreeChunk } from "../chunk.js";
+import type { TreeChunk } from "../../../core/index.js";
 
 import {
 	type ChunkDecoder,

package/src/feature-libraries/chunked-forest/emptyChunk.ts

@@ -10,12 +10,14 @@ import {
 	type FieldUpPath,
 	type PathRootPrefix,
 	type UpPath,
+	type ChunkedCursor,
+	type TreeChunk,
+	cursorChunk,
+	dummyRoot,
 } from "../../core/index.js";
 import { fail } from "../../util/index.js";
 import { prefixFieldPath } from "../treeCursorUtils.js";
 
-import { type ChunkedCursor, type TreeChunk, cursorChunk, dummyRoot } from "./chunk.js";
-
 /**
  * Chunk that is empty.
  *

package/src/feature-libraries/chunked-forest/index.ts

@@ -4,7 +4,7 @@
  */
 
 export { uniformChunk, ChunkShape } from "./uniformChunk.js";
-export { type TreeChunk, dummyRoot } from "./chunk.js";
+export { type TreeChunk, dummyRoot } from "../../core/index.js";
 export {
 	chunkTree,
 	defaultChunkPolicy,

package/src/feature-libraries/chunked-forest/sequenceChunk.ts

@@ -6,7 +6,7 @@
 import { ReferenceCountedBase } from "../../util/index.js";
 
 import { BasicChunkCursor } from "./basicChunk.js";
-import { type ChunkedCursor, type TreeChunk, dummyRoot } from "./chunk.js";
+import { type ChunkedCursor, type TreeChunk, dummyRoot } from "../../core/index.js";
 
 /**
  * General purpose multi-node sequence chunk.

package/src/feature-libraries/chunked-forest/uniformChunk.ts

@@ -14,11 +14,14 @@ import {
 	type TreeValue,
 	type UpPath,
 	type Value,
+	type ChunkedCursor,
+	type TreeChunk,
+	cursorChunk,
+	dummyRoot,
 } from "../../core/index.js";
-import { ReferenceCountedBase, fail } from "../../util/index.js";
+import { ReferenceCountedBase, fail, hasSome } from "../../util/index.js";
 import { SynchronousCursor, prefixFieldPath, prefixPath } from "../treeCursorUtils.js";
 
-import { type ChunkedCursor, type TreeChunk, cursorChunk, dummyRoot } from "./chunk.js";
 import type { SessionSpaceCompressedId, IIdCompressor } from "@fluidframework/id-compressor";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
@@ -517,12 +520,12 @@ class Cursor extends SynchronousCursor implements ChunkedCursor {
 
 	public firstField(): boolean {
 		const fieldsArray = this.nodeInfo(CursorLocationType.Nodes).shape.fieldsArray;
-		if (fieldsArray.length === 0) {
+		if (!hasSome(fieldsArray)) {
 			return false;
 		}
 		this.indexOfField = 0;
 		this.mode = CursorLocationType.Fields;
-		const fields = fieldsArray[0] ?? oob();
+		const fields = fieldsArray[0];
 		this.fieldKey = fields[0];
 		return true;
 	}

package/src/feature-libraries/default-schema/defaultSchema.ts

@@ -13,4 +13,5 @@ import { fieldKinds } from "./defaultFieldKinds.js";
 export const defaultSchemaPolicy: FullSchemaPolicy = {
 	fieldKinds,
 	validateSchema: false,
+	allowUnknownOptionalFields: () => false,
 };

package/src/feature-libraries/default-schema/schemaChecker.ts

@@ -73,7 +73,10 @@ export function isNodeInSchema(
 			uncheckedFieldsFromNode.delete(fieldKey);
 		}
 		// The node has fields that we did not check as part of looking at every field defined in the node's schema
-		if (uncheckedFieldsFromNode.size !== 0) {
+		if (
+			uncheckedFieldsFromNode.size !== 0 &&
+			!schemaAndPolicy.policy.allowUnknownOptionalFields(node.type)
+		) {
 			return SchemaValidationErrors.ObjectNode_FieldNotInSchema;
 		}
 	} else if (schema instanceof MapNodeStoredSchema) {

package/src/feature-libraries/flex-tree/context.ts

@@ -12,7 +12,7 @@ import {
 	anchorSlot,
 	moveToDetachedField,
 } from "../../core/index.js";
-import type { Listenable } from "../../events/index.js";
+import type { Listenable } from "@fluidframework/core-interfaces";
 import { type IDisposable, disposeSymbol } from "../../util/index.js";
 import type { NodeKeyManager } from "../node-key/index.js";