@fluidframework/tree 2.1.0-276985 → 2.1.0-281041

package/src/util/breakable.ts

@@ -0,0 +1,214 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert } from "@fluidframework/core-utils/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
+/**
+ * An object which can enter a "broken" state where trying to use it is a UsageError.
+ */
+export class Breakable {
+	private brokenBy?: Error;
+
+	public constructor(private readonly name: string) {}
+
+	/**
+	 * Throws if the object is in the broken state.
+	 * @remarks
+	 * Can use {@link throwIfBroken} to apply this to a method.
+	 */
+	public use(): void {
+		if (this.brokenBy !== undefined) {
+			throw new UsageError(
+				`Invalid use of ${this.name} after it was put into an invalid state by another error.\nOriginal Error:\n${this.brokenBy}`,
+			);
+		}
+	}
+
+	/**
+	 * Puts this object into the broken state, and throws an error.
+	 *
+	 * @throws If already broken by a different error, throws a UsageError, otherwise throws `brokenBy`.
+	 */
+	public break(brokenBy: Error): never {
+		// If already broken by this error, let it bubble up without rethrowing a modified version.
+		// This prevents internal errors like asserts getting rethrown as different errors when wrapped with multiple call to `{@link Breakable.run}` or `{@link breakingMethod}`.
+		if (this.brokenBy !== brokenBy) {
+			this.use();
+			this.brokenBy = brokenBy;
+		}
+		throw brokenBy;
+	}
+
+	/**
+	 * {@link Breakable.break}, except tolerates `unknown` to be more easily used by catch blocks.
+	 * @privateRemarks
+	 * If there is a use-case, this should be made public.
+	 */
+	private rethrowCaught(brokenBy: unknown): never {
+		if (brokenBy instanceof Error) {
+			this.break(brokenBy);
+		}
+		this.break(
+			new Error(`Non-error thrown breaking ${this.name}. Thrown value: "${brokenBy}"`),
+		);
+	}
+
+	/**
+	 * Runs code which should break the object if it throws.
+	 * @remarks
+	 * This also throws if already broken like {@link Breakable.use}.
+	 * Any exceptions this catches are re-thrown.
+	 * Can use {@link breakingMethod} to apply this to a method.
+	 */
+	public run<TResult>(breaker: () => TResult): TResult {
+		this.use();
+		try {
+			return breaker();
+		} catch (error: unknown) {
+			this.rethrowCaught(error);
+		}
+	}
+
+	/**
+	 * Clears the existing broken state.
+	 * @remarks
+	 * This is rarely safe to to: it is only ok when all objects using this breaker are known to not have been left in an invalid state.
+	 * This is pretty much only safe in tests which just were checking a specific error was thrown, and which know that error closepath is actually exception safe.
+	 */
+	public clearError(): void {
+		assert(this.brokenBy !== undefined, "No error to clear");
+		this.brokenBy = undefined;
+	}
+}
+
+/**
+ * Marks an object as being able to be in a broken state (unknown/unspecified/broken state due to unhandled exception).
+ * @remarks
+ * See decorators {@link breakingMethod} and {@link throwIfBroken} for ease of use.
+ */
+export interface WithBreakable {
+	readonly breaker: Breakable;
+}
+
+/**
+ * Decorator for methods which should break the object when they throw.
+ * @remarks
+ * This also throws if already broken like {@link throwIfBroken}.
+ * See {@link Breakable.run} for details.
+ *
+ * This should be used on methods which modify data that could result in an unsupported/broken state if an exception is thrown while modifying.
+ * It is ok for breakingMethods to call each-other.
+ * @privateRemarks
+ * Explicitly capturing the full `Target` type is necessary to make this work with generic methods with unknown numbers of type parameters.
+ */
+export function breakingMethod<
+	Target extends ((...args: any[]) => unknown) & ((this: This, ...args: Args) => Return),
+	This extends WithBreakable,
+	Args extends never[],
+	Return,
+>(target: Target, context?: ClassMethodDecoratorContext<This, Target>): Target {
+	function replacementMethod(this: This, ...args: Args): Return {
+		if (this.breaker === undefined) {
+			// This case is necessary for when wrapping methods which are invoked inside the constructor of the base class before `breaker` is set.
+			// Since the constructor throwing does not return an object, failing to put it into a broken state is not too bad.
+			// However when more than just the constructed object should be broken, this can result in missing a break.
+			return target.call(this, ...args);
+		}
+		return this.breaker.run(() => {
+			return target.call(this, ...args);
+		});
+	}
+	markBreaker(replacementMethod);
+	nameFunctionFrom(replacementMethod, target);
+	return replacementMethod as Target;
+}
+
+/**
+ * Decorator for methods which should throw if the object is in a broken state.
+ * @remarks
+ * This should be used on methods which read data that could be invalid when the object is broken.
+ * @privateRemarks
+ * Explicitly capturing the full `Target` type is necessary to make this work with generic methods with unknown numbers of type parameters.
+ */
+export function throwIfBroken<
+	Target extends ((...args: any[]) => unknown) & ((this: This, ...args: Args) => Return),
+	This extends WithBreakable,
+	Args extends never[],
+	Return,
+>(target: Target, context: ClassMethodDecoratorContext<This, Target>): Target {
+	function replacementMethod(this: This, ...args: Args): Return {
+		this.breaker.use();
+		return target.call(this, ...args);
+	}
+	markBreaker(replacementMethod);
+	nameFunctionFrom(replacementMethod, target);
+	return replacementMethod as Target;
+}
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+type PossiblyNamedFunction = Function & { displayName?: undefined | string };
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+function nameFunctionFrom(toName: Function, nameFrom: Function): void {
+	(toName as PossiblyNamedFunction).displayName =
+		(nameFrom as PossiblyNamedFunction).displayName ?? nameFrom.name;
+}
+
+const isBreakerSymbol: unique symbol = Symbol("isBreaker");
+
+// Accepting any function like value is desired and safe here as this does not call the provided function.
+// eslint-disable-next-line @typescript-eslint/ban-types
+function markBreaker(f: Function): void {
+	(f as unknown as Record<typeof isBreakerSymbol, true>)[isBreakerSymbol] = true;
+}
+
+// Accepting any function like value is desired and safe here as this does not call the provided function.
+// eslint-disable-next-line @typescript-eslint/ban-types
+function isBreaker(f: Function): boolean {
+	return isBreakerSymbol in (f as unknown as Record<typeof isBreakerSymbol, true>);
+}
+
+/**
+ * Decorator for classes which should break when their methods throw.
+ * @remarks
+ * Applies {@link breakingMethod} to all methods declared directly by class or its base classes.
+ * Does not include those on derived classes.
+ * Does not include getters or setters, or value properties.
+ * Methods already marked as {@link breakingMethod} or {@link throwIfBroken} are unaffected.
+ */
+export function breakingClass<Target extends abstract new (...args: any[]) => WithBreakable>(
+	target: Target,
+	context: ClassDecoratorContext<Target>,
+): Target {
+	abstract class DecoratedBreakable extends target {}
+
+	// Keep track of what keys we have seen,
+	// since we visit most derived properties first and need to avoid wrapping base properties overriding more derived ones.
+	const overriddenKeys: Set<string | symbol> = new Set();
+
+	let prototype: object | null = target.prototype;
+	while (prototype !== null) {
+		for (const key of Reflect.ownKeys(prototype)) {
+			if (!overriddenKeys.has(key)) {
+				overriddenKeys.add(key);
+				const descriptor = Reflect.getOwnPropertyDescriptor(prototype, key);
+				if (descriptor !== undefined) {
+					// Method
+					if (typeof descriptor.value === "function") {
+						if (!isBreaker(descriptor.value)) {
+							// This does not affect the original class, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor
+							descriptor.value = breakingMethod(descriptor.value);
+							Object.defineProperty(DecoratedBreakable.prototype, key, descriptor);
+						}
+					}
+				}
+			}
+		}
+		prototype = Reflect.getPrototypeOf(prototype);
+	}
+
+	return DecoratedBreakable;
+}

package/src/util/index.ts

@@ -29,6 +29,7 @@ export {
 	setInNestedMap,
 	tryAddToNestedMap,
 	tryGetFromNestedMap,
+	mapNestedMap,
 	nestedMapToFlatList,
 	nestedMapFromFlatList,
 } from "./nestedMap.js";
@@ -67,6 +68,7 @@ export {
 	JsonCompatibleReadOnlySchema,
 	makeArray,
 	mapIterable,
+	filterIterable,
 	type Mutable,
 	type Populated,
 	type RecursiveReadonly,
@@ -125,3 +127,11 @@ export {
 	type IdAllocationState,
 	fakeIdAllocator,
 } from "./idAllocator.js";
+
+export {
+	Breakable,
+	type WithBreakable,
+	breakingMethod,
+	throwIfBroken,
+	breakingClass,
+} from "./breakable.js";

package/src/util/nestedMap.ts

@@ -16,6 +16,13 @@ import type { MapGetSet } from "./utils.js";
  */
 export type NestedMap<Key1, Key2, Value> = Map<Key1, Map<Key2, Value>>;
 
+/**
+ * A read-only version of {@link NestedMap}.
+ *
+ * @internal
+ */
+export type ReadonlyNestedMap<Key1, Key2, Value> = ReadonlyMap<Key1, ReadonlyMap<Key2, Value>>;
+
 /**
  * If (key1, key2) already has a value in the map, it is returned, otherwise value is added under (key1, key2) and undefined is returned.
  *
@@ -51,7 +58,7 @@ export function tryAddToNestedMap<Key1, Key2, Value>(
  * @internal
  */
 export function populateNestedMap<Key1, Key2, Value>(
-	source: ReadonlyMap<Key1, ReadonlyMap<Key2, Value>>,
+	source: ReadonlyNestedMap<Key1, Key2, Value>,
 	destination: NestedMap<Key1, Key2, Value>,
 	override: boolean,
 ): void {
@@ -187,7 +194,7 @@ export function deleteFromNestedMap<Key1, Key2, Value>(
  * Converts a nested map to a flat list of triplets.
  */
 export function nestedMapToFlatList<Key1, Key2, Value>(
-	map: NestedMap<Key1, Key2, Value>,
+	map: ReadonlyNestedMap<Key1, Key2, Value>,
 ): [Key1, Key2, Value][] {
 	const list: [Key1, Key2, Value][] = [];
 	map.forEach((innerMap, key1) => {
@@ -212,7 +219,7 @@ export function nestedMapFromFlatList<Key1, Key2, Value>(
 }
 
 export function forEachInNestedMap<Key1, Key2, Value>(
-	map: NestedMap<Key1, Key2, Value>,
+	map: ReadonlyNestedMap<Key1, Key2, Value>,
 	delegate: (value: Value, key1: Key1, key2: Key2) => void,
 ): void {
 	map.forEach((innerMap, keyFirst) => {
@@ -222,6 +229,29 @@ export function forEachInNestedMap<Key1, Key2, Value>(
 	});
 }
 
+/**
+ * Maps the `input` map values using the provided `delegate`.
+ *
+ * @param input - The `NestedMap` whose contents are being mapped.
+ * @param delegate - The delegate to use for mapping values,
+ * @returns A new `NestedMap` with the same keys as `input`, but with the values produced by `delegate`.
+ */
+export function mapNestedMap<Key1, Key2, ValueIn, ValueOut = ValueIn>(
+	input: ReadonlyNestedMap<Key1, Key2, ValueIn>,
+	delegate: (value: ValueIn, key1: Key1, key2: Key2) => ValueOut,
+): NestedMap<Key1, Key2, ValueOut> {
+	const output = new Map<Key1, Map<Key2, ValueOut>>();
+	input.forEach((inputInnerMap, keyFirst) => {
+		const outputInnerMap = new Map<Key2, ValueOut>();
+		inputInnerMap.forEach((val, keySecond) => {
+			const mappedValue = delegate(val, keyFirst, keySecond);
+			outputInnerMap.set(keySecond, mappedValue);
+		});
+		output.set(keyFirst, outputInnerMap);
+	});
+	return output;
+}
+
 /**
  * Map with two keys; same semantics as NestedMap, but maintains a size count for the entire collection.
  * Note: undefined is not supported as a value, and will cause incorrect behavior.

package/src/util/utils.ts

@@ -174,6 +174,23 @@ export function* mapIterable<T, U>(
 	}
 }
 
+/**
+ * Filter one iterable into another
+ * @param iterable - the iterable to filter
+ * @param filter - the predicate function to run on each element of the iterable
+ * @returns a new iterable including only the elements that passed the filter predicate
+ */
+export function* filterIterable<T>(
+	iterable: Iterable<T>,
+	filter: (t: T) => boolean,
+): IterableIterator<T> {
+	for (const t of iterable) {
+		if (filter(t)) {
+			yield t;
+		}
+	}
+}
+
 /**
  * Finds the first element in the given iterable that satisfies a predicate.
  * @param iterable - The iterable to search for an eligible element

package/dist/feature-libraries/node-key/nodeKeyIndex.d.ts

@@ -1,41 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type FieldKey } from "../../core/index.js";
-import type { FlexTreeContext, FlexTreeObjectNode } from "../flex-tree/index.js";
-import { type FlexTreeSchema } from "../typed-schema/index.js";
-import { type LocalNodeKey } from "./nodeKey.js";
-/**
- * The node key index records nodes with {@link LocalNodeKey}s and allows them to be looked up by key.
- */
-export declare class NodeKeyIndex implements ReadonlyMap<LocalNodeKey, FlexTreeObjectNode> {
-    readonly fieldKey: FieldKey;
-    private readonly nodes;
-    constructor(fieldKey: FieldKey, keys?: Iterable<[LocalNodeKey, FlexTreeObjectNode]>);
-    /**
-     * Returns true if the given schema contains the node key type, otherwise false
-     */
-    static hasNodeKeyTreeSchema(schema: FlexTreeSchema): boolean;
-    /**
-     * Search the tree for all nodes with keys, and record them in this index for lookup.
-     * This should be called each time the tree changes; each call to scan forgets all existing keys.
-     * @param context - the flex tree context in which to search for node keys
-     */
-    scanKeys(context: FlexTreeContext): void;
-    /**
-     * Create a copy of this index which can be mutated without affecting this one.
-     */
-    clone(context: FlexTreeContext): NodeKeyIndex;
-    forEach(callbackfn: (value: FlexTreeObjectNode, key: LocalNodeKey, map: ReadonlyMap<LocalNodeKey, FlexTreeObjectNode>) => void, thisArg?: unknown): void;
-    get(key: LocalNodeKey): FlexTreeObjectNode | undefined;
-    has(key: LocalNodeKey): boolean;
-    get size(): number;
-    entries(): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]>;
-    keys(): IterableIterator<LocalNodeKey>;
-    values(): IterableIterator<FlexTreeObjectNode>;
-    [Symbol.iterator](): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]>;
-    private findKeys;
-    private findKeysInField;
-}
-//# sourceMappingURL=nodeKeyIndex.d.ts.map

package/dist/feature-libraries/node-key/nodeKeyIndex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeyIndex.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKeyIndex.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,KAAK,QAAQ,EAAe,MAAM,qBAAqB,CAAC;AACjE,OAAO,KAAK,EACX,eAAe,EAGf,kBAAkB,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,KAAK,cAAc,EAGnB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,KAAK,YAAY,EAAyB,MAAM,cAAc,CAAC;AAExE;;GAEG;AACH,qBAAa,YAAa,YAAW,WAAW,CAAC,YAAY,EAAE,kBAAkB,CAAC;aAKhE,QAAQ,EAAE,QAAQ;IAHnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;gBAG7C,QAAQ,EAAE,QAAQ,EAClC,IAAI,GAAE,QAAQ,CAAC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAM;IAKxD;;OAEG;WACW,oBAAoB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO;IASnE;;;;OAIG;IAEI,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAa/C;;OAEG;IACI,KAAK,CAAC,OAAO,EAAE,eAAe,GAAG,YAAY;IAO7C,OAAO,CACb,UAAU,EAAE,CACX,KAAK,EAAE,kBAAkB,EACzB,GAAG,EAAE,YAAY,EACjB,GAAG,EAAE,WAAW,CAAC,YAAY,EAAE,kBAAkB,CAAC,KAC9C,IAAI,EACT,OAAO,CAAC,EAAE,OAAO,GACf,IAAI;IAGA,GAAG,CAAC,GAAG,EAAE,YAAY,GAAG,kBAAkB,GAAG,SAAS;IAGtD,GAAG,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO;IAGtC,IAAW,IAAI,IAAI,MAAM,CAExB;IACM,OAAO,IAAI,gBAAgB,CAAC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAG/D,IAAI,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAGtC,MAAM,IAAI,gBAAgB,CAAC,kBAAkB,CAAC;IAG9C,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAKhF,OAAO,CAAE,QAAQ;IAcjB,OAAO,CAAE,eAAe;CAOxB"}

package/dist/feature-libraries/node-key/nodeKeyIndex.js

@@ -1,101 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeKeyIndex = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const index_js_1 = require("../../core/index.js");
-const index_js_2 = require("../typed-schema/index.js");
-const nodeKey_js_1 = require("./nodeKey.js");
-/**
- * The node key index records nodes with {@link LocalNodeKey}s and allows them to be looked up by key.
- */
-class NodeKeyIndex {
-    constructor(fieldKey, keys = []) {
-        this.fieldKey = fieldKey;
-        this.nodes = new Map(keys);
-    }
-    /**
-     * Returns true if the given schema contains the node key type, otherwise false
-     */
-    static hasNodeKeyTreeSchema(schema) {
-        // TODO: make TreeStoredSchema contain ViewSchema and compare by reference to nodeKeyTreeSchema.
-        const treeSchema = schema.nodeSchema.get(nodeKey_js_1.nodeKeyTreeIdentifier);
-        if (!(treeSchema instanceof index_js_2.LeafNodeSchema)) {
-            return false;
-        }
-        return treeSchema.leafValue === index_js_1.ValueSchema.String;
-    }
-    /**
-     * Search the tree for all nodes with keys, and record them in this index for lookup.
-     * This should be called each time the tree changes; each call to scan forgets all existing keys.
-     * @param context - the flex tree context in which to search for node keys
-     */
-    // TODO: This can be optimized by responding to deltas/changes to the tree, rather than rescanning the whole tree every time
-    scanKeys(context) {
-        this.nodes.clear();
-        if (NodeKeyIndex.hasNodeKeyTreeSchema(context.schema)) {
-            for (const [id, node] of this.findKeysInField(context.root)) {
-                // TODO:
-                // This invariant (that there is only one node with a given key) is not enforced by tree, so it should not assert.
-                // Multiple nodes (including deleted ones), might occur with the same key.
-                (0, internal_1.assert)(!this.nodes.has(id), 0x6e1 /* Encountered duplicate node key */);
-                this.nodes.set(id, node);
-            }
-        }
-    }
-    /**
-     * Create a copy of this index which can be mutated without affecting this one.
-     */
-    clone(context) {
-        const indexClone = new NodeKeyIndex(this.fieldKey);
-        indexClone.scanKeys(context);
-        return indexClone;
-    }
-    // #region ReadonlyMap interface
-    forEach(callbackfn, thisArg) {
-        return this.nodes.forEach(callbackfn, thisArg);
-    }
-    get(key) {
-        return this.nodes.get(key);
-    }
-    has(key) {
-        return this.nodes.has(key);
-    }
-    get size() {
-        return this.nodes.size;
-    }
-    entries() {
-        return this.nodes.entries();
-    }
-    keys() {
-        return this.nodes.keys();
-    }
-    values() {
-        return this.nodes.values();
-    }
-    [Symbol.iterator]() {
-        return this.nodes[Symbol.iterator]();
-    }
-    // #endregion ReadonlyMap interface
-    *findKeys(node) {
-        if ((0, index_js_2.schemaIsObjectNode)(node.schema)) {
-            const key = node.localNodeKey;
-            if (key !== undefined) {
-                yield [key, node];
-            }
-        }
-        for (const f of node.boxedIterator()) {
-            yield* this.findKeysInField(f);
-        }
-    }
-    *findKeysInField(f) {
-        for (const child of f.boxedIterator()) {
-            yield* this.findKeys(child);
-        }
-    }
-}
-exports.NodeKeyIndex = NodeKeyIndex;
-//# sourceMappingURL=nodeKeyIndex.js.map

package/dist/feature-libraries/node-key/nodeKeyIndex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeyIndex.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKeyIndex.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,kDAAiE;AAOjE,uDAIkC;AAElC,6CAAwE;AAExE;;GAEG;AACH,MAAa,YAAY;IAIxB,YACiB,QAAkB,EAClC,OAAqD,EAAE;QADvC,aAAQ,GAAR,QAAQ,CAAU;QAGlC,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAAsB;QACxD,gGAAgG;QAChG,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,kCAAqB,CAAC,CAAC;QAChE,IAAI,CAAC,CAAC,UAAU,YAAY,yBAAc,CAAC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,UAAU,CAAC,SAAS,KAAK,sBAAW,CAAC,MAAM,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,4HAA4H;IACrH,QAAQ,CAAC,OAAwB;QACvC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,YAAY,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7D,QAAQ;gBACR,kHAAkH;gBAClH,0EAA0E;gBAC1E,IAAA,iBAAM,EAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBACxE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YAC1B,CAAC;QACF,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAwB;QACpC,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnD,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7B,OAAO,UAAU,CAAC;IACnB,CAAC;IAED,gCAAgC;IACzB,OAAO,CACb,UAIS,EACT,OAAiB;QAEjB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IACM,GAAG,CAAC,GAAiB;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACM,GAAG,CAAC,GAAiB;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACD,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACxB,CAAC;IACM,OAAO;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IACM,IAAI;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IACM,MAAM;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IACM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACtC,CAAC;IACD,mCAAmC;IAE3B,CAAC,QAAQ,CAChB,IAAkB;QAElB,IAAI,IAAA,6BAAkB,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,GAAG,GAAI,IAA2B,CAAC,YAAY,CAAC;YACtD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,EAAE,IAA0B,CAAC,CAAC;YACzC,CAAC;QACF,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACtC,KAAK,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAEO,CAAC,eAAe,CACvB,CAAgB;QAEhB,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC;YACvC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;CACD;AA1GD,oCA0GC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport { type FieldKey, ValueSchema } from \"../../core/index.js\";\nimport type {\n\tFlexTreeContext,\n\tFlexTreeField,\n\tFlexTreeNode,\n\tFlexTreeObjectNode,\n} from \"../flex-tree/index.js\";\nimport {\n\ttype FlexTreeSchema,\n\tLeafNodeSchema,\n\tschemaIsObjectNode,\n} from \"../typed-schema/index.js\";\n\nimport { type LocalNodeKey, nodeKeyTreeIdentifier } from \"./nodeKey.js\";\n\n/**\n * The node key index records nodes with {@link LocalNodeKey}s and allows them to be looked up by key.\n */\nexport class NodeKeyIndex implements ReadonlyMap<LocalNodeKey, FlexTreeObjectNode> {\n\t// TODO: The data structure that holds the nodes can likely be optimized to better support cloning\n\tprivate readonly nodes: Map<LocalNodeKey, FlexTreeObjectNode>;\n\n\tpublic constructor(\n\t\tpublic readonly fieldKey: FieldKey,\n\t\tkeys: Iterable<[LocalNodeKey, FlexTreeObjectNode]> = [],\n\t) {\n\t\tthis.nodes = new Map(keys);\n\t}\n\n\t/**\n\t * Returns true if the given schema contains the node key type, otherwise false\n\t */\n\tpublic static hasNodeKeyTreeSchema(schema: FlexTreeSchema): boolean {\n\t\t// TODO: make TreeStoredSchema contain ViewSchema and compare by reference to nodeKeyTreeSchema.\n\t\tconst treeSchema = schema.nodeSchema.get(nodeKeyTreeIdentifier);\n\t\tif (!(treeSchema instanceof LeafNodeSchema)) {\n\t\t\treturn false;\n\t\t}\n\t\treturn treeSchema.leafValue === ValueSchema.String;\n\t}\n\n\t/**\n\t * Search the tree for all nodes with keys, and record them in this index for lookup.\n\t * This should be called each time the tree changes; each call to scan forgets all existing keys.\n\t * @param context - the flex tree context in which to search for node keys\n\t */\n\t// TODO: This can be optimized by responding to deltas/changes to the tree, rather than rescanning the whole tree every time\n\tpublic scanKeys(context: FlexTreeContext): void {\n\t\tthis.nodes.clear();\n\t\tif (NodeKeyIndex.hasNodeKeyTreeSchema(context.schema)) {\n\t\t\tfor (const [id, node] of this.findKeysInField(context.root)) {\n\t\t\t\t// TODO:\n\t\t\t\t// This invariant (that there is only one node with a given key) is not enforced by tree, so it should not assert.\n\t\t\t\t// Multiple nodes (including deleted ones), might occur with the same key.\n\t\t\t\tassert(!this.nodes.has(id), 0x6e1 /* Encountered duplicate node key */);\n\t\t\t\tthis.nodes.set(id, node);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Create a copy of this index which can be mutated without affecting this one.\n\t */\n\tpublic clone(context: FlexTreeContext): NodeKeyIndex {\n\t\tconst indexClone = new NodeKeyIndex(this.fieldKey);\n\t\tindexClone.scanKeys(context);\n\t\treturn indexClone;\n\t}\n\n\t// #region ReadonlyMap interface\n\tpublic forEach(\n\t\tcallbackfn: (\n\t\t\tvalue: FlexTreeObjectNode,\n\t\t\tkey: LocalNodeKey,\n\t\t\tmap: ReadonlyMap<LocalNodeKey, FlexTreeObjectNode>,\n\t\t) => void,\n\t\tthisArg?: unknown,\n\t): void {\n\t\treturn this.nodes.forEach(callbackfn, thisArg);\n\t}\n\tpublic get(key: LocalNodeKey): FlexTreeObjectNode | undefined {\n\t\treturn this.nodes.get(key);\n\t}\n\tpublic has(key: LocalNodeKey): boolean {\n\t\treturn this.nodes.has(key);\n\t}\n\tpublic get size(): number {\n\t\treturn this.nodes.size;\n\t}\n\tpublic entries(): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]> {\n\t\treturn this.nodes.entries();\n\t}\n\tpublic keys(): IterableIterator<LocalNodeKey> {\n\t\treturn this.nodes.keys();\n\t}\n\tpublic values(): IterableIterator<FlexTreeObjectNode> {\n\t\treturn this.nodes.values();\n\t}\n\tpublic [Symbol.iterator](): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]> {\n\t\treturn this.nodes[Symbol.iterator]();\n\t}\n\t// #endregion ReadonlyMap interface\n\n\tprivate *findKeys(\n\t\tnode: FlexTreeNode,\n\t): Iterable<[key: LocalNodeKey, node: FlexTreeObjectNode]> {\n\t\tif (schemaIsObjectNode(node.schema)) {\n\t\t\tconst key = (node as FlexTreeObjectNode).localNodeKey;\n\t\t\tif (key !== undefined) {\n\t\t\t\tyield [key, node as FlexTreeObjectNode];\n\t\t\t}\n\t\t}\n\t\tfor (const f of node.boxedIterator()) {\n\t\t\tyield* this.findKeysInField(f);\n\t\t}\n\t}\n\n\tprivate *findKeysInField(\n\t\tf: FlexTreeField,\n\t): Iterable<[key: LocalNodeKey, node: FlexTreeObjectNode]> {\n\t\tfor (const child of f.boxedIterator()) {\n\t\t\tyield* this.findKeys(child);\n\t\t}\n\t}\n}\n"]}

package/lib/feature-libraries/node-key/nodeKeyIndex.d.ts

@@ -1,41 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type FieldKey } from "../../core/index.js";
-import type { FlexTreeContext, FlexTreeObjectNode } from "../flex-tree/index.js";
-import { type FlexTreeSchema } from "../typed-schema/index.js";
-import { type LocalNodeKey } from "./nodeKey.js";
-/**
- * The node key index records nodes with {@link LocalNodeKey}s and allows them to be looked up by key.
- */
-export declare class NodeKeyIndex implements ReadonlyMap<LocalNodeKey, FlexTreeObjectNode> {
-    readonly fieldKey: FieldKey;
-    private readonly nodes;
-    constructor(fieldKey: FieldKey, keys?: Iterable<[LocalNodeKey, FlexTreeObjectNode]>);
-    /**
-     * Returns true if the given schema contains the node key type, otherwise false
-     */
-    static hasNodeKeyTreeSchema(schema: FlexTreeSchema): boolean;
-    /**
-     * Search the tree for all nodes with keys, and record them in this index for lookup.
-     * This should be called each time the tree changes; each call to scan forgets all existing keys.
-     * @param context - the flex tree context in which to search for node keys
-     */
-    scanKeys(context: FlexTreeContext): void;
-    /**
-     * Create a copy of this index which can be mutated without affecting this one.
-     */
-    clone(context: FlexTreeContext): NodeKeyIndex;
-    forEach(callbackfn: (value: FlexTreeObjectNode, key: LocalNodeKey, map: ReadonlyMap<LocalNodeKey, FlexTreeObjectNode>) => void, thisArg?: unknown): void;
-    get(key: LocalNodeKey): FlexTreeObjectNode | undefined;
-    has(key: LocalNodeKey): boolean;
-    get size(): number;
-    entries(): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]>;
-    keys(): IterableIterator<LocalNodeKey>;
-    values(): IterableIterator<FlexTreeObjectNode>;
-    [Symbol.iterator](): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]>;
-    private findKeys;
-    private findKeysInField;
-}
-//# sourceMappingURL=nodeKeyIndex.d.ts.map

package/lib/feature-libraries/node-key/nodeKeyIndex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeyIndex.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKeyIndex.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,KAAK,QAAQ,EAAe,MAAM,qBAAqB,CAAC;AACjE,OAAO,KAAK,EACX,eAAe,EAGf,kBAAkB,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,KAAK,cAAc,EAGnB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,KAAK,YAAY,EAAyB,MAAM,cAAc,CAAC;AAExE;;GAEG;AACH,qBAAa,YAAa,YAAW,WAAW,CAAC,YAAY,EAAE,kBAAkB,CAAC;aAKhE,QAAQ,EAAE,QAAQ;IAHnC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;gBAG7C,QAAQ,EAAE,QAAQ,EAClC,IAAI,GAAE,QAAQ,CAAC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAM;IAKxD;;OAEG;WACW,oBAAoB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO;IASnE;;;;OAIG;IAEI,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAa/C;;OAEG;IACI,KAAK,CAAC,OAAO,EAAE,eAAe,GAAG,YAAY;IAO7C,OAAO,CACb,UAAU,EAAE,CACX,KAAK,EAAE,kBAAkB,EACzB,GAAG,EAAE,YAAY,EACjB,GAAG,EAAE,WAAW,CAAC,YAAY,EAAE,kBAAkB,CAAC,KAC9C,IAAI,EACT,OAAO,CAAC,EAAE,OAAO,GACf,IAAI;IAGA,GAAG,CAAC,GAAG,EAAE,YAAY,GAAG,kBAAkB,GAAG,SAAS;IAGtD,GAAG,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO;IAGtC,IAAW,IAAI,IAAI,MAAM,CAExB;IACM,OAAO,IAAI,gBAAgB,CAAC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAG/D,IAAI,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAGtC,MAAM,IAAI,gBAAgB,CAAC,kBAAkB,CAAC;IAG9C,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAKhF,OAAO,CAAE,QAAQ;IAcjB,OAAO,CAAE,eAAe;CAOxB"}

package/lib/feature-libraries/node-key/nodeKeyIndex.js

@@ -1,97 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert } from "@fluidframework/core-utils/internal";
-import { ValueSchema } from "../../core/index.js";
-import { LeafNodeSchema, schemaIsObjectNode, } from "../typed-schema/index.js";
-import { nodeKeyTreeIdentifier } from "./nodeKey.js";
-/**
- * The node key index records nodes with {@link LocalNodeKey}s and allows them to be looked up by key.
- */
-export class NodeKeyIndex {
-    constructor(fieldKey, keys = []) {
-        this.fieldKey = fieldKey;
-        this.nodes = new Map(keys);
-    }
-    /**
-     * Returns true if the given schema contains the node key type, otherwise false
-     */
-    static hasNodeKeyTreeSchema(schema) {
-        // TODO: make TreeStoredSchema contain ViewSchema and compare by reference to nodeKeyTreeSchema.
-        const treeSchema = schema.nodeSchema.get(nodeKeyTreeIdentifier);
-        if (!(treeSchema instanceof LeafNodeSchema)) {
-            return false;
-        }
-        return treeSchema.leafValue === ValueSchema.String;
-    }
-    /**
-     * Search the tree for all nodes with keys, and record them in this index for lookup.
-     * This should be called each time the tree changes; each call to scan forgets all existing keys.
-     * @param context - the flex tree context in which to search for node keys
-     */
-    // TODO: This can be optimized by responding to deltas/changes to the tree, rather than rescanning the whole tree every time
-    scanKeys(context) {
-        this.nodes.clear();
-        if (NodeKeyIndex.hasNodeKeyTreeSchema(context.schema)) {
-            for (const [id, node] of this.findKeysInField(context.root)) {
-                // TODO:
-                // This invariant (that there is only one node with a given key) is not enforced by tree, so it should not assert.
-                // Multiple nodes (including deleted ones), might occur with the same key.
-                assert(!this.nodes.has(id), 0x6e1 /* Encountered duplicate node key */);
-                this.nodes.set(id, node);
-            }
-        }
-    }
-    /**
-     * Create a copy of this index which can be mutated without affecting this one.
-     */
-    clone(context) {
-        const indexClone = new NodeKeyIndex(this.fieldKey);
-        indexClone.scanKeys(context);
-        return indexClone;
-    }
-    // #region ReadonlyMap interface
-    forEach(callbackfn, thisArg) {
-        return this.nodes.forEach(callbackfn, thisArg);
-    }
-    get(key) {
-        return this.nodes.get(key);
-    }
-    has(key) {
-        return this.nodes.has(key);
-    }
-    get size() {
-        return this.nodes.size;
-    }
-    entries() {
-        return this.nodes.entries();
-    }
-    keys() {
-        return this.nodes.keys();
-    }
-    values() {
-        return this.nodes.values();
-    }
-    [Symbol.iterator]() {
-        return this.nodes[Symbol.iterator]();
-    }
-    // #endregion ReadonlyMap interface
-    *findKeys(node) {
-        if (schemaIsObjectNode(node.schema)) {
-            const key = node.localNodeKey;
-            if (key !== undefined) {
-                yield [key, node];
-            }
-        }
-        for (const f of node.boxedIterator()) {
-            yield* this.findKeysInField(f);
-        }
-    }
-    *findKeysInField(f) {
-        for (const child of f.boxedIterator()) {
-            yield* this.findKeys(child);
-        }
-    }
-}
-//# sourceMappingURL=nodeKeyIndex.js.map

package/lib/feature-libraries/node-key/nodeKeyIndex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeyIndex.js","sourceRoot":"","sources":["../../../src/feature-libraries/node-key/nodeKeyIndex.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAiB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAOjE,OAAO,EAEN,cAAc,EACd,kBAAkB,GAClB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAqB,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAExE;;GAEG;AACH,MAAM,OAAO,YAAY;IAIxB,YACiB,QAAkB,EAClC,OAAqD,EAAE;QADvC,aAAQ,GAAR,QAAQ,CAAU;QAGlC,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAAsB;QACxD,gGAAgG;QAChG,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAChE,IAAI,CAAC,CAAC,UAAU,YAAY,cAAc,CAAC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,UAAU,CAAC,SAAS,KAAK,WAAW,CAAC,MAAM,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,4HAA4H;IACrH,QAAQ,CAAC,OAAwB;QACvC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,YAAY,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7D,QAAQ;gBACR,kHAAkH;gBAClH,0EAA0E;gBAC1E,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBACxE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YAC1B,CAAC;QACF,CAAC;IACF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAwB;QACpC,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnD,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7B,OAAO,UAAU,CAAC;IACnB,CAAC;IAED,gCAAgC;IACzB,OAAO,CACb,UAIS,EACT,OAAiB;QAEjB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IACM,GAAG,CAAC,GAAiB;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACM,GAAG,CAAC,GAAiB;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACD,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACxB,CAAC;IACM,OAAO;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IACM,IAAI;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IACM,MAAM;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IACM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACtC,CAAC;IACD,mCAAmC;IAE3B,CAAC,QAAQ,CAChB,IAAkB;QAElB,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,GAAG,GAAI,IAA2B,CAAC,YAAY,CAAC;YACtD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,EAAE,IAA0B,CAAC,CAAC;YACzC,CAAC;QACF,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACtC,KAAK,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAEO,CAAC,eAAe,CACvB,CAAgB;QAEhB,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC;YACvC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport { type FieldKey, ValueSchema } from \"../../core/index.js\";\nimport type {\n\tFlexTreeContext,\n\tFlexTreeField,\n\tFlexTreeNode,\n\tFlexTreeObjectNode,\n} from \"../flex-tree/index.js\";\nimport {\n\ttype FlexTreeSchema,\n\tLeafNodeSchema,\n\tschemaIsObjectNode,\n} from \"../typed-schema/index.js\";\n\nimport { type LocalNodeKey, nodeKeyTreeIdentifier } from \"./nodeKey.js\";\n\n/**\n * The node key index records nodes with {@link LocalNodeKey}s and allows them to be looked up by key.\n */\nexport class NodeKeyIndex implements ReadonlyMap<LocalNodeKey, FlexTreeObjectNode> {\n\t// TODO: The data structure that holds the nodes can likely be optimized to better support cloning\n\tprivate readonly nodes: Map<LocalNodeKey, FlexTreeObjectNode>;\n\n\tpublic constructor(\n\t\tpublic readonly fieldKey: FieldKey,\n\t\tkeys: Iterable<[LocalNodeKey, FlexTreeObjectNode]> = [],\n\t) {\n\t\tthis.nodes = new Map(keys);\n\t}\n\n\t/**\n\t * Returns true if the given schema contains the node key type, otherwise false\n\t */\n\tpublic static hasNodeKeyTreeSchema(schema: FlexTreeSchema): boolean {\n\t\t// TODO: make TreeStoredSchema contain ViewSchema and compare by reference to nodeKeyTreeSchema.\n\t\tconst treeSchema = schema.nodeSchema.get(nodeKeyTreeIdentifier);\n\t\tif (!(treeSchema instanceof LeafNodeSchema)) {\n\t\t\treturn false;\n\t\t}\n\t\treturn treeSchema.leafValue === ValueSchema.String;\n\t}\n\n\t/**\n\t * Search the tree for all nodes with keys, and record them in this index for lookup.\n\t * This should be called each time the tree changes; each call to scan forgets all existing keys.\n\t * @param context - the flex tree context in which to search for node keys\n\t */\n\t// TODO: This can be optimized by responding to deltas/changes to the tree, rather than rescanning the whole tree every time\n\tpublic scanKeys(context: FlexTreeContext): void {\n\t\tthis.nodes.clear();\n\t\tif (NodeKeyIndex.hasNodeKeyTreeSchema(context.schema)) {\n\t\t\tfor (const [id, node] of this.findKeysInField(context.root)) {\n\t\t\t\t// TODO:\n\t\t\t\t// This invariant (that there is only one node with a given key) is not enforced by tree, so it should not assert.\n\t\t\t\t// Multiple nodes (including deleted ones), might occur with the same key.\n\t\t\t\tassert(!this.nodes.has(id), 0x6e1 /* Encountered duplicate node key */);\n\t\t\t\tthis.nodes.set(id, node);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Create a copy of this index which can be mutated without affecting this one.\n\t */\n\tpublic clone(context: FlexTreeContext): NodeKeyIndex {\n\t\tconst indexClone = new NodeKeyIndex(this.fieldKey);\n\t\tindexClone.scanKeys(context);\n\t\treturn indexClone;\n\t}\n\n\t// #region ReadonlyMap interface\n\tpublic forEach(\n\t\tcallbackfn: (\n\t\t\tvalue: FlexTreeObjectNode,\n\t\t\tkey: LocalNodeKey,\n\t\t\tmap: ReadonlyMap<LocalNodeKey, FlexTreeObjectNode>,\n\t\t) => void,\n\t\tthisArg?: unknown,\n\t): void {\n\t\treturn this.nodes.forEach(callbackfn, thisArg);\n\t}\n\tpublic get(key: LocalNodeKey): FlexTreeObjectNode | undefined {\n\t\treturn this.nodes.get(key);\n\t}\n\tpublic has(key: LocalNodeKey): boolean {\n\t\treturn this.nodes.has(key);\n\t}\n\tpublic get size(): number {\n\t\treturn this.nodes.size;\n\t}\n\tpublic entries(): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]> {\n\t\treturn this.nodes.entries();\n\t}\n\tpublic keys(): IterableIterator<LocalNodeKey> {\n\t\treturn this.nodes.keys();\n\t}\n\tpublic values(): IterableIterator<FlexTreeObjectNode> {\n\t\treturn this.nodes.values();\n\t}\n\tpublic [Symbol.iterator](): IterableIterator<[LocalNodeKey, FlexTreeObjectNode]> {\n\t\treturn this.nodes[Symbol.iterator]();\n\t}\n\t// #endregion ReadonlyMap interface\n\n\tprivate *findKeys(\n\t\tnode: FlexTreeNode,\n\t): Iterable<[key: LocalNodeKey, node: FlexTreeObjectNode]> {\n\t\tif (schemaIsObjectNode(node.schema)) {\n\t\t\tconst key = (node as FlexTreeObjectNode).localNodeKey;\n\t\t\tif (key !== undefined) {\n\t\t\t\tyield [key, node as FlexTreeObjectNode];\n\t\t\t}\n\t\t}\n\t\tfor (const f of node.boxedIterator()) {\n\t\t\tyield* this.findKeysInField(f);\n\t\t}\n\t}\n\n\tprivate *findKeysInField(\n\t\tf: FlexTreeField,\n\t): Iterable<[key: LocalNodeKey, node: FlexTreeObjectNode]> {\n\t\tfor (const child of f.boxedIterator()) {\n\t\t\tyield* this.findKeys(child);\n\t\t}\n\t}\n}\n"]}