@fluidframework/tree 2.10.0 → 2.11.0

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/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/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";

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/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,12 +27,19 @@ import {
 	type TreeStoredSchemaSubscription,
 	type UpPath,
 	aboveRootPlaceholder,
+	combineVisitors,
 	detachedFieldAsKey,
 	mapCursorField,
 	rootFieldKey,
 } 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";
@@ -53,6 +63,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 +94,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 +112,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 +281,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/uniformChunk.ts

@@ -15,7 +15,7 @@ import {
 	type UpPath,
 	type Value,
 } 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";
@@ -517,12 +517,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/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";
 

package/src/feature-libraries/index.ts

@@ -172,3 +172,12 @@ export {
 } from "./schema-edits/index.js";
 
 export { makeMitigatedChangeFamily } from "./mitigatedChangeFamily.js";
+
+export {
+	type KeyFinder,
+	AnchorTreeIndex,
+	hasElement,
+	type TreeIndex,
+	type TreeIndexKey,
+	type TreeIndexNodes,
+} from "./indexing/index.js";