@fluidframework/tree 2.90.0-378676 → 2.91.0

package/src/util/rangeMap.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 { BTree } from "@tylerbu/sorted-btree-es6";
 
 /**
@@ -29,7 +29,7 @@ export class RangeMap<K, V> {
 	 * When writing to a range of keys starting with `start`, the value of the nth key is interpreted to be
 	 * `offsetValue(firstValue, n - 1)`.
 	 * The same logic should be used when interpreting the values for keys after the first in a
-	 * `RangeQueryResult` or `RangeQueryEntry`.
+	 * `RangeQueryResult` or `RangeMapEntry`.
 	 *
 	 * If `offsetValue` is left unspecified, all keys in a block will be given the same value.
 	 */
@@ -44,8 +44,8 @@ export class RangeMap<K, V> {
 	/**
 	 * Retrieves all entries from the RangeMap.
 	 */
-	public entries(): RangeQueryEntry<K, V>[] {
-		const entries: RangeQueryEntry<K, V>[] = [];
+	public entries(): RangeMapEntry<K, V>[] {
+		const entries: RangeMapEntry<K, V>[] = [];
 		for (const [start, entry] of this.tree.entries()) {
 			entries.push({ start, length: entry.length, value: entry.value });
 		}
@@ -62,62 +62,22 @@ export class RangeMap<K, V> {
 	 *
 	 * @param start - The first key in the range being queried
 	 * @param length - The length of the query range
-	 * @returns A list of entries, each describing the value for some subrange of the query.
-	 * The entries are in the same order as the keys, and there is an entry for every key with a non `undefined` value.
+	 * @returns A list of fragments, each describing the value for a subrange of the query.
+	 * The fragments are in the same order as the keys.
+	 * The key for each fragment is `start` offset by `fragment.offset`.
 	 */
-	public getAll(start: K, length: number): RangeQueryEntry<K, V>[] {
-		const entries = this.getIntersectingEntries(start, length);
-		if (entries.length === 0) {
-			return entries;
-		}
-
-		const firstEntry = entries[0] ?? oob();
-		const lengthBefore = this.subtractKeys(start, firstEntry.start);
-		if (lengthBefore > 0) {
-			entries[0] = {
-				start,
-				length: firstEntry.length - lengthBefore,
-				value: this.offsetValue(firstEntry.value, lengthBefore),
-			};
-		}
-
-		const lastEntry = entries[entries.length - 1] ?? oob();
-		const lastEntryKey = this.offsetKey(lastEntry.start, lastEntry.length - 1);
-		const lastQueryKey = this.offsetKey(start, length - 1);
-		const lengthAfter = this.subtractKeys(lastEntryKey, lastQueryKey);
-		if (lengthAfter > 0) {
-			entries[entries.length - 1] = { ...lastEntry, length: lastEntry.length - lengthAfter };
-		}
-
-		return entries;
-	}
-
-	// XXX: Merge with getAll
-	/**
-	 * Like getAll, but includes entries where the value is undefined.
-	 */
-	public getAll2(start: K, length: number): RangeQueryResultFragment<V | undefined>[] {
-		let nextKey = start;
+	public getAll(start: K, length: number): RangeQueryResultFragment<V | undefined>[] {
 		let offset = 0;
-		const result: RangeQueryResultFragment<V | undefined>[] = [];
-		for (const entry of this.getAll(start, length)) {
-			const lengthBefore = this.subtractKeys(entry.start, nextKey);
-			if (lengthBefore > 0) {
-				result.push({ offset, length: lengthBefore, value: undefined });
-				offset += lengthBefore;
-			}
+		const results: RangeQueryResultFragment<V | undefined>[] = [];
 
-			result.push({ offset, length: entry.length, value: entry.value });
-			nextKey = this.offsetKey(entry.start, entry.length);
-			offset += entry.length;
+		while (offset < length) {
+			const key = this.offsetKey(start, offset);
+			const result = this.getFirst(key, length - offset);
+			results.push({ offset, value: result.value, length: result.length });
+			offset += result.length;
 		}
 
-		const lengthRemaining = length - offset;
-		if (lengthRemaining > 0) {
-			result.push({ offset, length: lengthRemaining, value: undefined });
-		}
-
-		return result;
+		return results;
 	}
 
 	/**
@@ -238,19 +198,16 @@ export class RangeMap<K, V> {
 		return cloned;
 	}
 
-	public mapEntries(mapKey: (key: K) => K, mapValue: (value: V) => V): RangeMap<K, V> {
-		const result = new RangeMap<K, V>(this.offsetKey, this.subtractKeys, this.offsetValue);
-		for (const entry of this.entries()) {
-			result.set(mapKey(entry.start), entry.length, mapValue(entry.value));
-		}
-		return result;
-	}
-
 	/**
 	 * Returns a new map which contains the entries from both input maps.
-	 * Whenever both maps contain entires for the same keys, the value from map `b` is used in the returned map.
+	 * Whenever both maps contain entries for the same keys, the value is determined by calling `mergeFunc`.
+	 * By default, `mergeFunc` chooses the value from `b`.
 	 */
-	public static union<K, V>(a: RangeMap<K, V>, b: RangeMap<K, V>): RangeMap<K, V> {
+	public static union<K, V>(
+		a: RangeMap<K, V>,
+		b: RangeMap<K, V>,
+		mergeFunc: (key: K, valueA: V, valueB: V) => V = (_k, _a, valB) => valB,
+	): RangeMap<K, V> {
 		assert(
 			a.offsetKey === b.offsetKey &&
 				a.subtractKeys === b.subtractKeys &&
@@ -259,15 +216,22 @@ export class RangeMap<K, V> {
 		);
 
 		const merged = a.clone();
-		for (const entry of b.entries()) {
-			merged.set(entry.start, entry.length, entry.value);
+		for (const entryB of b.entries()) {
+			for (const entryA of a.getAll(entryB.start, entryB.length)) {
+				const key = b.offsetKey(entryB.start, entryA.offset);
+				const valueB = b.offsetValue(entryB.value, entryA.offset);
+				const mergedValue =
+					entryA.value === undefined ? valueB : mergeFunc(key, entryA.value, valueB);
+
+				merged.set(key, entryA.length, mergedValue);
+			}
 		}
 
 		return merged;
 	}
 
-	private getIntersectingEntries(start: K, length: number): RangeQueryEntry<K, V>[] {
-		const entries: RangeQueryEntry<K, V>[] = [];
+	private getIntersectingEntries(start: K, length: number): RangeMapEntry<K, V>[] {
+		const entries: RangeMapEntry<K, V>[] = [];
 		const lastQueryKey = this.offsetKey(start, length - 1);
 		{
 			const entry = this.tree.getPairOrNextLower(start);
@@ -358,7 +322,7 @@ export interface RangeQueryResultFragment<V> extends RangeQueryResult<V> {
 	readonly offset: number;
 }
 
-export interface RangeQueryEntry<K, V> {
+export interface RangeMapEntry<K, V> {
 	readonly start: K;
 	readonly value: V;
 	readonly length: number;
@@ -379,11 +343,3 @@ function subtractIntegers<K extends number>(a: K, b: K): number {
 function defaultValueOffsetFn<T>(value: T, offset: number): T {
 	return value;
 }
-
-export function areAdjacentIntegerRanges(
-	firstStart: number,
-	firstLength: number,
-	secondStart: number,
-): boolean {
-	return firstStart + firstLength === secondStart;
-}

package/src/util/typeCheck.ts

@@ -84,6 +84,7 @@ export type { EnforceTypeCheckTests } from "./typeCheckTests.js";
  * See: {@link https://dev.azure.com/intentional/intent/_wiki/wikis/NP%20Platform/7146/Nominal-vs-Structural-Types}
  * @sealed @public
  */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Intentionally empty; used as a nominal type brand.
 export interface MakeNominal {}
 
 /**

package/src/util/typeUtils.ts

@@ -191,13 +191,10 @@ export type PopUnion<
  * This implementation is inspired to those, but slightly different in implementation.
  * @system @beta
  */
-export type UnionToTuple<
-	Union,
-	A extends unknown[] = [],
-	First = PopUnion<Union>,
-> = IsUnion<Union> extends true
-	? UnionToTuple<Exclude<Union, First>, [First, ...A]>
-	: [Union, ...A];
+export type UnionToTuple<Union, A extends unknown[] = [], First = PopUnion<Union>> =
+	IsUnion<Union> extends true
+		? UnionToTuple<Exclude<Union, First>, [First, ...A]>
+		: [Union, ...A];
 
 /**
  * This is unsafe, meaning that the returned value might not match its type.

package/dist/beta.d.ts

@@ -1,149 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
- */
-
-export {
-	// #region Unrestricted APIs
-	InternalTypes,
-	// #endregion
-	 
-	// #region @public APIs
-	AllowedTypes, 
-	CommitKind, 
-	CommitMetadata, 
-	FieldKind, 
-	FieldProps, 
-	FieldSchema, 
-	FieldSchemaMetadata, 
-	ITree, 
-	ITreeConfigurationOptions, 
-	ITreeViewConfiguration, 
-	ImplicitAllowedTypes, 
-	ImplicitFieldSchema, 
-	Input, 
-	InsertableTreeFieldFromImplicitField, 
-	InsertableTreeNodeFromAllowedTypes, 
-	InsertableTreeNodeFromImplicitAllowedTypes, 
-	InsertableTypedNode, 
-	InternalTreeNode, 
-	IsListener, 
-	IsUnion, 
-	IterableTreeArrayContent, 
-	LazyItem, 
-	LeafSchema, 
-	Listenable, 
-	Listeners, 
-	MakeNominal, 
-	MapNodeInsertableData, 
-	NodeFromSchema, 
-	NodeInDocumentConstraint, 
-	NodeKind, 
-	NodeSchemaMetadata, 
-	NodeSchemaOptions, 
-	NumberKeys, 
-	ObjectFromSchemaRecord, 
-	Off, 
-	ReadonlyArrayNode, 
-	RestrictiveReadonlyRecord, 
-	RestrictiveStringRecord, 
-	Revertible, 
-	RevertibleFactory, 
-	RevertibleStatus, 
-	RunTransaction, 
-	SchemaCompatibilityStatus, 
-	SchemaFactory, 
-	SchemaFactory_base, 
-	SchemaStatics, 
-	SimpleNodeSchemaBase, 
-	System_Unsafe, 
-	TransactionConstraint, 
-	Tree, 
-	TreeArrayNode, 
-	TreeChangeEvents, 
-	TreeFieldFromImplicitField, 
-	TreeLeafValue, 
-	TreeMapNode, 
-	TreeNode, 
-	TreeNodeApi, 
-	TreeNodeFromImplicitAllowedTypes, 
-	TreeNodeSchema, 
-	TreeNodeSchemaClass, 
-	TreeNodeSchemaCore, 
-	TreeNodeSchemaNonClass, 
-	TreeObjectNode, 
-	TreeStatus, 
-	TreeView, 
-	TreeViewConfiguration, 
-	TreeViewEvents, 
-	Unenforced, 
-	Unhydrated, 
-	UnionToIntersection, 
-	ValidateRecursiveSchema, 
-	ValidateRecursiveSchemaTemplate, 
-	ViewableTree, 
-	WithType, 
-	rollback, 
-	typeSchemaSymbol,
-	// #endregion
- 
-	// #region @beta APIs
-	AllowedTypeMetadata, 
-	AllowedTypesFull, 
-	AllowedTypesFullEvaluated, 
-	AllowedTypesFullFromMixed, 
-	AllowedTypesFullFromMixedUnsafe, 
-	AllowedTypesMetadata, 
-	AnnotateAllowedTypesList, 
-	AnnotateAllowedTypesListUnsafe, 
-	AnnotatedAllowedType, 
-	AnnotatedAllowedTypeUnsafe, 
-	AnnotatedAllowedTypes, 
-	AnnotatedAllowedTypesUnsafe, 
-	CodecWriteOptionsBeta, 
-	ConciseTree, 
-	ExtensibleUnionNode, 
-	FixRecursiveArraySchema, 
-	FluidSerializableAsTree, 
-	ForestOptions, 
-	ForestType, 
-	ForestTypeExpensiveDebug, 
-	ForestTypeOptimized, 
-	ForestTypeReference, 
-	JsonCompatible, 
-	JsonCompatibleObject, 
-	KeyEncodingOptions, 
-	NodeChangedData, 
-	ObjectSchemaOptions, 
-	PopUnion, 
-	RecordNodeInsertableData, 
-	SchemaFactoryBeta, 
-	SchemaStaticsBeta, 
-	SchemaUpgrade, 
-	SharedTreeOptionsBeta, 
-	System_TableSchema, 
-	TableSchema, 
-	TreeBeta, 
-	TreeBranch, 
-	TreeChangeEventsBeta, 
-	TreeEncodingOptions, 
-	TreeRecordNode, 
-	TreeRecordNodeUnsafe, 
-	TreeViewBeta, 
-	UnannotateAllowedTypeUnsafe, 
-	UnannotateAllowedTypesList, 
-	UnannotateAllowedTypesListUnsafe, 
-	UnionToTuple, 
-	adaptEnum, 
-	asBeta, 
-	configuredSharedTreeBeta, 
-	createIndependentTreeBeta, 
-	enumFromStrings, 
-	singletonSchema
-	// #endregion
-} from "./index.js";

package/dist/core/schema-view/index.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export { type Adapters, type TreeAdapter, AdaptedViewSchema, } from "./view.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/core/schema-view/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/schema-view/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,iBAAiB,GACjB,MAAM,WAAW,CAAC"}

package/dist/core/schema-view/index.js

@@ -1,10 +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.AdaptedViewSchema = void 0;
-var view_js_1 = require("./view.js");
-Object.defineProperty(exports, "AdaptedViewSchema", { enumerable: true, get: function () { return view_js_1.AdaptedViewSchema; } });
-//# sourceMappingURL=index.js.map

package/dist/core/schema-view/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/schema-view/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAImB;AADlB,4GAAA,iBAAiB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\ttype Adapters,\n\ttype TreeAdapter,\n\tAdaptedViewSchema,\n} from \"./view.js\";\n"]}

package/dist/core/schema-view/view.d.ts

@@ -1,31 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { TreeNodeSchemaIdentifier, TreeStoredSchema } from "../schema-stored/index.js";
-/**
- * APIs for applying `view schema` to documents.
- */
-export interface TreeAdapter {
-    readonly output: TreeNodeSchemaIdentifier;
-    readonly input: TreeNodeSchemaIdentifier;
-}
-/**
- * Minimal selection of adapters (nothing for general out of schema, field level adjustments etc.).
- * Would be used with schematize and have actual conversion/update functionality.
- *
- * TODO: Support more kinds of adapters
- * TODO: support efficient lookup of adapters
- */
-export interface Adapters {
-    readonly tree?: readonly TreeAdapter[];
-}
-/**
- * A collection of View information for schema, including policy.
- */
-export declare class AdaptedViewSchema {
-    readonly adapters: Adapters;
-    readonly adaptedForViewSchema: TreeStoredSchema;
-    constructor(adapters: Adapters, adaptedForViewSchema: TreeStoredSchema);
-}
-//# sourceMappingURL=view.d.ts.map

package/dist/core/schema-view/view.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../../src/core/schema-view/view.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE5F;;GAEG;AAEH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,wBAAwB,CAAC;CAGzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,iBAAiB;aAEZ,QAAQ,EAAE,QAAQ;aAClB,oBAAoB,EAAE,gBAAgB;gBADtC,QAAQ,EAAE,QAAQ,EAClB,oBAAoB,EAAE,gBAAgB;CAEvD"}

package/dist/core/schema-view/view.js

@@ -1,18 +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.AdaptedViewSchema = void 0;
-/**
- * A collection of View information for schema, including policy.
- */
-class AdaptedViewSchema {
-    constructor(adapters, adaptedForViewSchema) {
-        this.adapters = adapters;
-        this.adaptedForViewSchema = adaptedForViewSchema;
-    }
-}
-exports.AdaptedViewSchema = AdaptedViewSchema;
-//# sourceMappingURL=view.js.map

package/dist/core/schema-view/view.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/core/schema-view/view.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA0BH;;GAEG;AACH,MAAa,iBAAiB;IAC7B,YACiB,QAAkB,EAClB,oBAAsC;QADtC,aAAQ,GAAR,QAAQ,CAAU;QAClB,yBAAoB,GAApB,oBAAoB,CAAkB;IACpD,CAAC;CACJ;AALD,8CAKC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TreeNodeSchemaIdentifier, TreeStoredSchema } from \"../schema-stored/index.js\";\n\n/**\n * APIs for applying `view schema` to documents.\n */\n\nexport interface TreeAdapter {\n\treadonly output: TreeNodeSchemaIdentifier;\n\treadonly input: TreeNodeSchemaIdentifier;\n\n\t// TODO: include actual adapter functionality, not just what types it converts\n}\n\n/**\n * Minimal selection of adapters (nothing for general out of schema, field level adjustments etc.).\n * Would be used with schematize and have actual conversion/update functionality.\n *\n * TODO: Support more kinds of adapters\n * TODO: support efficient lookup of adapters\n */\nexport interface Adapters {\n\treadonly tree?: readonly TreeAdapter[];\n}\n\n/**\n * A collection of View information for schema, including policy.\n */\nexport class AdaptedViewSchema {\n\tpublic constructor(\n\t\tpublic readonly adapters: Adapters,\n\t\tpublic readonly adaptedForViewSchema: TreeStoredSchema,\n\t) {}\n}\n"]}

package/dist/feature-libraries/default-schema/locationBasedEditBuilder.d.ts

@@ -1,40 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type ChangeAtomId, type FieldKey, type FieldUpPath, type UpPath, type TreeChunk, type EditorOptions } from "../../core/index.js";
-import type { DetachedRootIds, DataEditor, OptionalFieldEditor, RequiredFieldEditor, SequenceFieldEditor } from "./defaultEditBuilder.js";
-export type DetachedRootLocation = FieldKey;
-export type DetachedRootsLocation = readonly DetachedRootRangeLocation[];
-export interface DetachedRootRangeLocation {
-    readonly field: FieldKey;
-    readonly count: number;
-}
-export interface Locator {
-    locationFromId(id: ChangeAtomId): DetachedRootLocation;
-    idFromLocation(id: DetachedRootLocation): ChangeAtomId;
-    locationsFromIdRanges(id: DetachedRootIds): DetachedRootsLocation;
-    idRangesFromLocations(id: DetachedRootsLocation): DetachedRootIds;
-    isAttachable(id: ChangeAtomId): boolean | undefined;
-}
-export type ILocationBasedDataEditor = DataEditor<TreeChunk, DetachedRootLocation, DetachedRootsLocation>;
-/**
- * Implementation of {@link DataEditor} based on the default set of supported field kinds.
- * @sealed
- */
-export declare class LocationBasedDataEditor implements DataEditor<TreeChunk, DetachedRootLocation, DetachedRootsLocation> {
-    private readonly idBasedEditor;
-    private readonly locator;
-    private readonly options;
-    constructor(idBasedEditor: DataEditor<TreeChunk, ChangeAtomId, DetachedRootIds>, locator: Locator, options: EditorOptions);
-    addNodeExistsConstraint(path: UpPath): void;
-    addNodeExistsConstraintOnRevert(path: UpPath): void;
-    addNoChangeConstraint(): void;
-    addNoChangeConstraintOnRevert(): void;
-    buildRoots(content: TreeChunk): DetachedRootsLocation;
-    valueField(field: FieldUpPath): RequiredFieldEditor<TreeChunk, DetachedRootLocation>;
-    optionalField(field: FieldUpPath): OptionalFieldEditor<TreeChunk, DetachedRootLocation>;
-    move(sourceField: FieldUpPath, sourceIndex: number, count: number, destinationField: FieldUpPath, destIndex: number): void;
-    sequenceField(field: FieldUpPath): SequenceFieldEditor<TreeChunk, DetachedRootsLocation>;
-}
-//# sourceMappingURL=locationBasedEditBuilder.d.ts.map

package/dist/feature-libraries/default-schema/locationBasedEditBuilder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"locationBasedEditBuilder.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/locationBasedEditBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,SAAS,EAMd,KAAK,aAAa,EAClB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EACX,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAC5C,MAAM,MAAM,qBAAqB,GAAG,SAAS,yBAAyB,EAAE,CAAC;AACzE,MAAM,WAAW,yBAAyB;IACzC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,OAAO;IACvB,cAAc,CAAC,EAAE,EAAE,YAAY,GAAG,oBAAoB,CAAC;IACvD,cAAc,CAAC,EAAE,EAAE,oBAAoB,GAAG,YAAY,CAAC;IACvD,qBAAqB,CAAC,EAAE,EAAE,eAAe,GAAG,qBAAqB,CAAC;IAClE,qBAAqB,CAAC,EAAE,EAAE,qBAAqB,GAAG,eAAe,CAAC;IAClE,YAAY,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,CAAC;CACpD;AAED,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAChD,SAAS,EACT,oBAAoB,EACpB,qBAAqB,CACrB,CAAC;AAEF;;;GAGG;AACH,qBAAa,uBACZ,YAAW,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,qBAAqB,CAAC;IAG5E,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAFP,aAAa,EAAE,UAAU,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe,CAAC,EACnE,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,aAAa;IAGjC,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3C,+BAA+B,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKnD,qBAAqB,IAAI,IAAI;IAI7B,6BAA6B,IAAI,IAAI;IAIrC,UAAU,CAAC,OAAO,EAAE,SAAS,GAAG,qBAAqB;IAMrD,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,mBAAmB,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAiBpF,aAAa,CACnB,KAAK,EAAE,WAAW,GAChB,mBAAmB,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAwBhD,IAAI,CACV,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,WAAW,EAC7B,SAAS,EAAE,MAAM,GACf,IAAI;IAUA,aAAa,CACnB,KAAK,EAAE,WAAW,GAChB,mBAAmB,CAAC,SAAS,EAAE,qBAAqB,CAAC;CAmBxD"}

package/dist/feature-libraries/default-schema/locationBasedEditBuilder.js

@@ -1,153 +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.LocationBasedDataEditor = void 0;
-const internal_1 = require("@fluidframework/telemetry-utils/internal");
-const index_js_1 = require("../../core/index.js");
-/**
- * Implementation of {@link DataEditor} based on the default set of supported field kinds.
- * @sealed
- */
-class LocationBasedDataEditor {
-    constructor(idBasedEditor, locator, options) {
-        this.idBasedEditor = idBasedEditor;
-        this.locator = locator;
-        this.options = options;
-    }
-    addNodeExistsConstraint(path) {
-        const normal = normalizeUpPath(path, this.locator, this.options);
-        this.idBasedEditor.addNodeExistsConstraint(normal);
-    }
-    addNodeExistsConstraintOnRevert(path) {
-        const normal = normalizeUpPath(path, this.locator, this.options);
-        this.idBasedEditor.addNodeExistsConstraintOnRevert(normal);
-    }
-    addNoChangeConstraint() {
-        this.idBasedEditor.addNoChangeConstraint();
-    }
-    addNoChangeConstraintOnRevert() {
-        this.idBasedEditor.addNoChangeConstraintOnRevert();
-    }
-    buildRoots(content) {
-        const roots = this.idBasedEditor.buildRoots(content);
-        const locations = this.locator.locationsFromIdRanges(roots);
-        return locations;
-    }
-    valueField(field) {
-        const normal = normalizeFieldUpPath(field, this.locator, this.options);
-        const lowLevelEditor = this.idBasedEditor.valueField(normal);
-        const locator = this.locator;
-        const editBuilder = {
-            set: (newContent) => {
-                lowLevelEditor.set(newContent);
-            },
-            attach: (newContent) => {
-                const changeAtom = locator.idFromLocation(newContent);
-                validateIsAttachable(changeAtom, locator);
-                lowLevelEditor.attach(changeAtom);
-            },
-        };
-        return editBuilder;
-    }
-    optionalField(field) {
-        const normal = normalizeFieldUpPath(field, this.locator, this.options);
-        const lowLevelEditor = this.idBasedEditor.optionalField(normal);
-        const locator = this.locator;
-        const editBuilder = {
-            set: (newContent, wasEmpty) => {
-                lowLevelEditor.set(newContent, wasEmpty);
-            },
-            attach: (newContent, wasEmpty) => {
-                if (newContent === undefined) {
-                    editBuilder.clear(wasEmpty);
-                    return;
-                }
-                const changeAtom = locator.idFromLocation(newContent);
-                validateIsAttachable(changeAtom, locator);
-                lowLevelEditor.attach(changeAtom, wasEmpty);
-            },
-            clear: (wasEmpty) => {
-                lowLevelEditor.clear(wasEmpty);
-            },
-        };
-        return editBuilder;
-    }
-    move(sourceField, sourceIndex, count, destinationField, destIndex) {
-        const normalSource = normalizeFieldUpPath(sourceField, this.locator, this.options);
-        const normalDestination = normalizeFieldUpPath(destinationField, this.locator, this.options);
-        this.idBasedEditor.move(normalSource, sourceIndex, count, normalDestination, destIndex);
-    }
-    sequenceField(field) {
-        const normal = normalizeFieldUpPath(field, this.locator, this.options);
-        const lowLevelEditor = this.idBasedEditor.sequenceField(normal);
-        const locator = this.locator;
-        const editBuilder = {
-            insert: (index, content) => {
-                lowLevelEditor.insert(index, content);
-            },
-            attach: (index, newContent) => {
-                const range = locator.idRangesFromLocations(newContent);
-                validateAreAttachable(range, locator);
-                lowLevelEditor.attach(index, range);
-            },
-            remove: (index, count) => {
-                lowLevelEditor.remove(index, count);
-            },
-        };
-        return editBuilder;
-    }
-}
-exports.LocationBasedDataEditor = LocationBasedDataEditor;
-function normalizeUpPath(path, locator, options) {
-    if (path.parent === undefined) {
-        if (path.parentField === index_js_1.rootFieldKey) {
-            return { ...path, parent: undefined, detachedNodeId: undefined };
-        }
-        else {
-            if (options.enableDetachedRootEditing !== true) {
-                throw new internal_1.UsageError(`Edits and constraints on detached trees require a minimum version for collaboration >= TBD.`);
-            }
-            const nodeId = locator.idFromLocation(path.parentField);
-            const detachedNodeId = (0, index_js_1.makeDetachedNodeId)(nodeId.revision, nodeId.localId);
-            return { ...path, parent: undefined, detachedNodeId };
-        }
-    }
-    else {
-        return {
-            parent: normalizeUpPath(path.parent, locator, options),
-            parentField: path.parentField,
-            parentIndex: path.parentIndex,
-        };
-    }
-}
-function normalizeFieldUpPath(path, locator, options) {
-    if (path.parent === undefined) {
-        if (path.field === index_js_1.rootFieldKey) {
-            return { parent: undefined, field: index_js_1.rootFieldKey };
-        }
-        else {
-            throw new internal_1.UsageError("Editing only allowed on the root field or on fields under nodes with TreeStatus.InDocument or TreeStatus.Removed status");
-        }
-    }
-    else {
-        return { parent: normalizeUpPath(path.parent, locator, options), field: path.field };
-    }
-}
-function validateAreAttachable(nodeIds, locator) {
-    for (const idRange of nodeIds) {
-        const baseAtom = idRange.first;
-        for (let idOffset = 0; idOffset < idRange.count; idOffset++) {
-            validateIsAttachable((0, index_js_1.offsetChangeAtomId)(baseAtom, idOffset), locator);
-        }
-    }
-}
-function validateIsAttachable(nodeId, locator) {
-    const isAttachable = locator.isAttachable(nodeId);
-    if (!(isAttachable ?? false)) {
-        throw new internal_1.UsageError(`Nodes that may have been detached from a required field can only be re-attached by reverting the detach.`);
-    }
-}
-//# sourceMappingURL=locationBasedEditBuilder.js.map

package/dist/feature-libraries/default-schema/locationBasedEditBuilder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"locationBasedEditBuilder.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/locationBasedEditBuilder.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAAsE;AAEtE,kDAY6B;AA+B7B;;;GAGG;AACH,MAAa,uBAAuB;IAGnC,YACkB,aAAmE,EACnE,OAAgB,EAChB,OAAsB;QAFtB,kBAAa,GAAb,aAAa,CAAsD;QACnE,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAe;IACrC,CAAC;IAEG,uBAAuB,CAAC,IAAY;QAC1C,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAEM,+BAA+B,CAAC,IAAY;QAClD,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;IAEM,qBAAqB;QAC3B,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;IAC5C,CAAC;IAEM,6BAA6B;QACnC,IAAI,CAAC,aAAa,CAAC,6BAA6B,EAAE,CAAC;IACpD,CAAC;IAEM,UAAU,CAAC,OAAkB;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC5D,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,UAAU,CAAC,KAAkB;QACnC,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvE,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,MAAM,WAAW,GAAG;YACnB,GAAG,EAAE,CAAC,UAAqB,EAAQ,EAAE;gBACpC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC;YACD,MAAM,EAAE,CAAC,UAAgC,EAAQ,EAAE;gBAClD,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBACtD,oBAAoB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC1C,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACnC,CAAC;SACD,CAAC;QACF,OAAO,WAAW,CAAC;IACpB,CAAC;IAEM,aAAa,CACnB,KAAkB;QAElB,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvE,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,MAAM,WAAW,GAAG;YACnB,GAAG,EAAE,CAAC,UAAiC,EAAE,QAAiB,EAAQ,EAAE;gBACnE,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC1C,CAAC;YACD,MAAM,EAAE,CAAC,UAA4C,EAAE,QAAiB,EAAQ,EAAE;gBACjF,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC9B,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAC5B,OAAO;gBACR,CAAC;gBACD,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBACtD,oBAAoB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC1C,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC7C,CAAC;YACD,KAAK,EAAE,CAAC,QAAiB,EAAQ,EAAE;gBAClC,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC;SACD,CAAC;QACF,OAAO,WAAW,CAAC;IACpB,CAAC;IAEM,IAAI,CACV,WAAwB,EACxB,WAAmB,EACnB,KAAa,EACb,gBAA6B,EAC7B,SAAiB;QAEjB,MAAM,YAAY,GAAG,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnF,MAAM,iBAAiB,GAAG,oBAAoB,CAC7C,gBAAgB,EAChB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,OAAO,CACZ,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;IACzF,CAAC;IAEM,aAAa,CACnB,KAAkB;QAElB,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvE,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,MAAM,WAAW,GAAG;YACnB,MAAM,EAAE,CAAC,KAAa,EAAE,OAAkB,EAAQ,EAAE;gBACnD,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACvC,CAAC;YACD,MAAM,EAAE,CAAC,KAAa,EAAE,UAAiC,EAAQ,EAAE;gBAClE,MAAM,KAAK,GAAG,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;gBACxD,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBACtC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC;YACD,MAAM,EAAE,CAAC,KAAa,EAAE,KAAa,EAAQ,EAAE;gBAC9C,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC;SACD,CAAC;QACF,OAAO,WAAW,CAAC;IACpB,CAAC;CACD;AAjHD,0DAiHC;AAED,SAAS,eAAe,CACvB,IAAY,EACZ,OAAgB,EAChB,OAAsB;IAEtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,WAAW,KAAK,uBAAY,EAAE,CAAC;YACvC,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;QAClE,CAAC;aAAM,CAAC;YACP,IAAI,OAAO,CAAC,yBAAyB,KAAK,IAAI,EAAE,CAAC;gBAChD,MAAM,IAAI,qBAAU,CACnB,6FAA6F,CAC7F,CAAC;YACH,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxD,MAAM,cAAc,GAAG,IAAA,6BAAkB,EAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YAC3E,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC;QACvD,CAAC;IACF,CAAC;SAAM,CAAC;QACP,OAAO;YACN,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;YACtD,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAC5B,IAAiB,EACjB,OAAgB,EAChB,OAAsB;IAEtB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,KAAK,KAAK,uBAAY,EAAE,CAAC;YACjC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,uBAAY,EAAE,CAAC;QACnD,CAAC;aAAM,CAAC;YACP,MAAM,IAAI,qBAAU,CACnB,yHAAyH,CACzH,CAAC;QACH,CAAC;IACF,CAAC;SAAM,CAAC;QACP,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IACtF,CAAC;AACF,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAwB,EAAE,OAAgB;IACxE,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;QAC/B,KAAK,IAAI,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC;YAC7D,oBAAoB,CAAC,IAAA,6BAAkB,EAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAoB,EAAE,OAAgB;IACnE,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,qBAAU,CACnB,0GAA0G,CAC1G,CAAC;IACH,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\ttype ChangeAtomId,\n\ttype FieldKey,\n\ttype FieldUpPath,\n\ttype UpPath,\n\ttype TreeChunk,\n\ttype NormalizedUpPath,\n\ttype NormalizedFieldUpPath,\n\trootFieldKey,\n\tmakeDetachedNodeId,\n\toffsetChangeAtomId,\n\ttype EditorOptions,\n} from \"../../core/index.js\";\n\nimport type {\n\tDetachedRootIds,\n\tDataEditor,\n\tOptionalFieldEditor,\n\tRequiredFieldEditor,\n\tSequenceFieldEditor,\n} from \"./defaultEditBuilder.js\";\n\nexport type DetachedRootLocation = FieldKey;\nexport type DetachedRootsLocation = readonly DetachedRootRangeLocation[];\nexport interface DetachedRootRangeLocation {\n\treadonly field: FieldKey;\n\treadonly count: number;\n}\n\nexport interface Locator {\n\tlocationFromId(id: ChangeAtomId): DetachedRootLocation;\n\tidFromLocation(id: DetachedRootLocation): ChangeAtomId;\n\tlocationsFromIdRanges(id: DetachedRootIds): DetachedRootsLocation;\n\tidRangesFromLocations(id: DetachedRootsLocation): DetachedRootIds;\n\tisAttachable(id: ChangeAtomId): boolean | undefined;\n}\n\nexport type ILocationBasedDataEditor = DataEditor<\n\tTreeChunk,\n\tDetachedRootLocation,\n\tDetachedRootsLocation\n>;\n\n/**\n * Implementation of {@link DataEditor} based on the default set of supported field kinds.\n * @sealed\n */\nexport class LocationBasedDataEditor\n\timplements DataEditor<TreeChunk, DetachedRootLocation, DetachedRootsLocation>\n{\n\tpublic constructor(\n\t\tprivate readonly idBasedEditor: DataEditor<TreeChunk, ChangeAtomId, DetachedRootIds>,\n\t\tprivate readonly locator: Locator,\n\t\tprivate readonly options: EditorOptions,\n\t) {}\n\n\tpublic addNodeExistsConstraint(path: UpPath): void {\n\t\tconst normal = normalizeUpPath(path, this.locator, this.options);\n\t\tthis.idBasedEditor.addNodeExistsConstraint(normal);\n\t}\n\n\tpublic addNodeExistsConstraintOnRevert(path: UpPath): void {\n\t\tconst normal = normalizeUpPath(path, this.locator, this.options);\n\t\tthis.idBasedEditor.addNodeExistsConstraintOnRevert(normal);\n\t}\n\n\tpublic addNoChangeConstraint(): void {\n\t\tthis.idBasedEditor.addNoChangeConstraint();\n\t}\n\n\tpublic addNoChangeConstraintOnRevert(): void {\n\t\tthis.idBasedEditor.addNoChangeConstraintOnRevert();\n\t}\n\n\tpublic buildRoots(content: TreeChunk): DetachedRootsLocation {\n\t\tconst roots = this.idBasedEditor.buildRoots(content);\n\t\tconst locations = this.locator.locationsFromIdRanges(roots);\n\t\treturn locations;\n\t}\n\n\tpublic valueField(field: FieldUpPath): RequiredFieldEditor<TreeChunk, DetachedRootLocation> {\n\t\tconst normal = normalizeFieldUpPath(field, this.locator, this.options);\n\t\tconst lowLevelEditor = this.idBasedEditor.valueField(normal);\n\t\tconst locator = this.locator;\n\t\tconst editBuilder = {\n\t\t\tset: (newContent: TreeChunk): void => {\n\t\t\t\tlowLevelEditor.set(newContent);\n\t\t\t},\n\t\t\tattach: (newContent: DetachedRootLocation): void => {\n\t\t\t\tconst changeAtom = locator.idFromLocation(newContent);\n\t\t\t\tvalidateIsAttachable(changeAtom, locator);\n\t\t\t\tlowLevelEditor.attach(changeAtom);\n\t\t\t},\n\t\t};\n\t\treturn editBuilder;\n\t}\n\n\tpublic optionalField(\n\t\tfield: FieldUpPath,\n\t): OptionalFieldEditor<TreeChunk, DetachedRootLocation> {\n\t\tconst normal = normalizeFieldUpPath(field, this.locator, this.options);\n\t\tconst lowLevelEditor = this.idBasedEditor.optionalField(normal);\n\t\tconst locator = this.locator;\n\t\tconst editBuilder = {\n\t\t\tset: (newContent: TreeChunk | undefined, wasEmpty: boolean): void => {\n\t\t\t\tlowLevelEditor.set(newContent, wasEmpty);\n\t\t\t},\n\t\t\tattach: (newContent: DetachedRootLocation | undefined, wasEmpty: boolean): void => {\n\t\t\t\tif (newContent === undefined) {\n\t\t\t\t\teditBuilder.clear(wasEmpty);\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tconst changeAtom = locator.idFromLocation(newContent);\n\t\t\t\tvalidateIsAttachable(changeAtom, locator);\n\t\t\t\tlowLevelEditor.attach(changeAtom, wasEmpty);\n\t\t\t},\n\t\t\tclear: (wasEmpty: boolean): void => {\n\t\t\t\tlowLevelEditor.clear(wasEmpty);\n\t\t\t},\n\t\t};\n\t\treturn editBuilder;\n\t}\n\n\tpublic move(\n\t\tsourceField: FieldUpPath,\n\t\tsourceIndex: number,\n\t\tcount: number,\n\t\tdestinationField: FieldUpPath,\n\t\tdestIndex: number,\n\t): void {\n\t\tconst normalSource = normalizeFieldUpPath(sourceField, this.locator, this.options);\n\t\tconst normalDestination = normalizeFieldUpPath(\n\t\t\tdestinationField,\n\t\t\tthis.locator,\n\t\t\tthis.options,\n\t\t);\n\t\tthis.idBasedEditor.move(normalSource, sourceIndex, count, normalDestination, destIndex);\n\t}\n\n\tpublic sequenceField(\n\t\tfield: FieldUpPath,\n\t): SequenceFieldEditor<TreeChunk, DetachedRootsLocation> {\n\t\tconst normal = normalizeFieldUpPath(field, this.locator, this.options);\n\t\tconst lowLevelEditor = this.idBasedEditor.sequenceField(normal);\n\t\tconst locator = this.locator;\n\t\tconst editBuilder = {\n\t\t\tinsert: (index: number, content: TreeChunk): void => {\n\t\t\t\tlowLevelEditor.insert(index, content);\n\t\t\t},\n\t\t\tattach: (index: number, newContent: DetachedRootsLocation): void => {\n\t\t\t\tconst range = locator.idRangesFromLocations(newContent);\n\t\t\t\tvalidateAreAttachable(range, locator);\n\t\t\t\tlowLevelEditor.attach(index, range);\n\t\t\t},\n\t\t\tremove: (index: number, count: number): void => {\n\t\t\t\tlowLevelEditor.remove(index, count);\n\t\t\t},\n\t\t};\n\t\treturn editBuilder;\n\t}\n}\n\nfunction normalizeUpPath(\n\tpath: UpPath,\n\tlocator: Locator,\n\toptions: EditorOptions,\n): NormalizedUpPath {\n\tif (path.parent === undefined) {\n\t\tif (path.parentField === rootFieldKey) {\n\t\t\treturn { ...path, parent: undefined, detachedNodeId: undefined };\n\t\t} else {\n\t\t\tif (options.enableDetachedRootEditing !== true) {\n\t\t\t\tthrow new UsageError(\n\t\t\t\t\t`Edits and constraints on detached trees require a minimum version for collaboration >= TBD.`,\n\t\t\t\t);\n\t\t\t}\n\t\t\tconst nodeId = locator.idFromLocation(path.parentField);\n\t\t\tconst detachedNodeId = makeDetachedNodeId(nodeId.revision, nodeId.localId);\n\t\t\treturn { ...path, parent: undefined, detachedNodeId };\n\t\t}\n\t} else {\n\t\treturn {\n\t\t\tparent: normalizeUpPath(path.parent, locator, options),\n\t\t\tparentField: path.parentField,\n\t\t\tparentIndex: path.parentIndex,\n\t\t};\n\t}\n}\n\nfunction normalizeFieldUpPath(\n\tpath: FieldUpPath,\n\tlocator: Locator,\n\toptions: EditorOptions,\n): NormalizedFieldUpPath {\n\tif (path.parent === undefined) {\n\t\tif (path.field === rootFieldKey) {\n\t\t\treturn { parent: undefined, field: rootFieldKey };\n\t\t} else {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"Editing only allowed on the root field or on fields under nodes with TreeStatus.InDocument or TreeStatus.Removed status\",\n\t\t\t);\n\t\t}\n\t} else {\n\t\treturn { parent: normalizeUpPath(path.parent, locator, options), field: path.field };\n\t}\n}\n\nfunction validateAreAttachable(nodeIds: DetachedRootIds, locator: Locator): void {\n\tfor (const idRange of nodeIds) {\n\t\tconst baseAtom = idRange.first;\n\t\tfor (let idOffset = 0; idOffset < idRange.count; idOffset++) {\n\t\t\tvalidateIsAttachable(offsetChangeAtomId(baseAtom, idOffset), locator);\n\t\t}\n\t}\n}\n\nfunction validateIsAttachable(nodeId: ChangeAtomId, locator: Locator): void {\n\tconst isAttachable = locator.isAttachable(nodeId);\n\tif (!(isAttachable ?? false)) {\n\t\tthrow new UsageError(\n\t\t\t`Nodes that may have been detached from a required field can only be re-attached by reverting the detach.`,\n\t\t);\n\t}\n}\n"]}