@fluidframework/tree 2.81.0-374083 → 2.81.1

package/src/util/rangeMap.ts

@@ -34,8 +34,8 @@ export class RangeMap<K, V> {
 	 * If `offsetValue` is left unspecified, all keys in a block will be given the same value.
 	 */
 	public constructor(
-		public readonly offsetKey: (key: K, offset: number) => K,
-		public readonly subtractKeys: (a: K, b: K) => number,
+		private readonly offsetKey: (key: K, offset: number) => K,
+		private readonly subtractKeys: (a: K, b: K) => number,
 		public readonly offsetValue: (value: V, offset: number) => V = defaultValueOffsetFn,
 	) {
 		this.tree = new BTree(undefined, subtractKeys);
@@ -92,34 +92,6 @@ export class RangeMap<K, V> {
 		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;
-		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;
-			}
-
-			result.push({ offset, length: entry.length, value: entry.value });
-			nextKey = this.offsetKey(entry.start, entry.length);
-			offset += entry.length;
-		}
-
-		const lengthRemaining = length - offset;
-		if (lengthRemaining > 0) {
-			result.push({ offset, length: lengthRemaining, value: undefined });
-		}
-
-		return result;
-	}
-
 	/**
 	 * Retrieves the value for some prefix of the query range.
 	 *
@@ -128,7 +100,7 @@ export class RangeMap<K, V> {
 	 * @returns A RangeQueryResult containing the value associated with `start`,
 	 * and the number of consecutive keys with that same value (at least 1, at most `length`).
 	 */
-	public getFirst(start: K, length: number): RangeQueryResult<V | undefined> {
+	public getFirst(start: K, length: number): RangeQueryResult<K, V> {
 		{
 			// We first check for an entry with a key less than or equal to `start`.
 			const entry = this.tree.getPairOrNextLower(start);
@@ -142,6 +114,7 @@ export class RangeMap<K, V> {
 				if (overlappingLength > 0) {
 					return {
 						value: this.offsetValue(value, lengthBeforeQuery),
+						start,
 						length: overlappingLength,
 					};
 				}
@@ -157,11 +130,11 @@ export class RangeMap<K, V> {
 
 				const lastQueryKey = this.offsetKey(start, length - 1);
 				if (this.le(entryKey, lastQueryKey)) {
-					return { value: undefined, length: this.subtractKeys(entryKey, start) };
+					return { value: undefined, start, length: this.subtractKeys(entryKey, start) };
 				}
 			}
 
-			return { value: undefined, length };
+			return { value: undefined, start, length };
 		}
 	}
 
@@ -198,22 +171,18 @@ export class RangeMap<K, V> {
 	 *
 	 * @param start - The start of the range to delete (inclusive).
 	 * @param length - The length of the range to delete.
-	 * @returns The number of entries deleted.
 	 */
-	public delete(start: K, length: number): number {
-		let deleteCount = 0;
+	public delete(start: K, length: number): void {
 		const lastDeleteKey = this.offsetKey(start, length - 1);
 		for (const { start: key, length: entryLength, value } of this.getIntersectingEntries(
 			start,
 			length,
 		)) {
-			deleteCount += entryLength;
 			this.tree.delete(key);
 			const lengthBefore = this.subtractKeys(start, key);
 			if (lengthBefore > 0) {
 				// A portion of this entry comes before the deletion range, so we reinsert that portion.
 				this.tree.set(key, { length: lengthBefore, value });
-				deleteCount -= lengthBefore;
 			}
 
 			const lastEntryKey = this.offsetKey(key, entryLength - 1);
@@ -226,10 +195,8 @@ export class RangeMap<K, V> {
 					length: lengthAfter,
 					value: this.offsetValue(value, difference),
 				});
-				deleteCount -= lengthAfter;
 			}
 		}
-		return deleteCount;
 	}
 
 	public clone(): RangeMap<K, V> {
@@ -238,14 +205,6 @@ 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.
 	 */
@@ -261,9 +220,9 @@ export class RangeMap<K, V> {
 
 		// TODO: Is there a good pattern that lets us make `tree` readonly?
 		merged.tree = a.tree.clone();
-		for (const entry of b.entries()) {
+		for (const [key, value] of b.tree.entries()) {
 			// TODO: Handle key collisions
-			merged.set(entry.start, entry.length, entry.value);
+			merged.tree.set(key, value);
 		}
 
 		return merged;
@@ -338,11 +297,17 @@ interface RangeEntry<V> {
 /**
  * Describes the result of a range query, including the value and length of the matching prefix.
  */
-export interface RangeQueryResult<V> {
+export interface RangeQueryResult<K, V> {
+	/**
+	 * The key for the first element in the range.
+	 */
+	readonly start: K;
+
 	/**
 	 * The value of the first key in the query range.
+	 * If no matching range is found, this will be undefined.
 	 */
-	readonly value: V;
+	readonly value: V | undefined;
 
 	/**
 	 * The length of the prefix of the query range which has the same value.
@@ -352,19 +317,8 @@ export interface RangeQueryResult<V> {
 	readonly length: number;
 }
 
-export interface RangeQueryResultFragment<V> extends RangeQueryResult<V> {
-	/**
-	 * The offset from the query key to the key this result is associated with.
-	 * This is useful in the case where a query returns multiple `RangeQueryResults`
-	 * addressing the key range.
-	 */
-	readonly offset: number;
-}
-
-export interface RangeQueryEntry<K, V> {
-	readonly start: K;
+export interface RangeQueryEntry<K, V> extends RangeQueryResult<K, V> {
 	readonly value: V;
-	readonly length: number;
 }
 
 export function newIntegerRangeMap<V>(): RangeMap<number, V> {
@@ -382,11 +336,3 @@ function subtractIntegers(a: number, b: number): 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/readSnapshotBlob.ts

@@ -3,12 +3,14 @@
  * Licensed under the MIT License.
  */
 
+import { bufferToString } from "@fluid-internal/client-utils";
 import type { IFluidHandle } from "@fluidframework/core-interfaces";
 import type { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
-import type { JsonCompatible } from "./utils.js";
-import { bufferToString } from "@fluid-internal/client-utils";
+
 import type { SummaryElementParser } from "../shared-tree-core/index.js";
 
+import type { JsonCompatible } from "./utils.js";
+
 /**
  * Reads and parses a snapshot blob from storage service.
  */

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

@@ -1,38 +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 } 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;
-}
-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;
-    constructor(idBasedEditor: DataEditor<TreeChunk, ChangeAtomId, DetachedRootIds>, locator: Locator);
-    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;AAGH,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,SAAS,EAKd,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;CAClE;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;gBADP,aAAa,EAAE,UAAU,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe,CAAC,EACnE,OAAO,EAAE,OAAO;IAG3B,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;IAgBpF,aAAa,CACnB,KAAK,EAAE,WAAW,GAChB,mBAAmB,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAuBhD,IAAI,CACV,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,WAAW,EAC7B,SAAS,EAAE,MAAM,GACf,IAAI;IAMA,aAAa,CACnB,KAAK,EAAE,WAAW,GAChB,mBAAmB,CAAC,SAAS,EAAE,qBAAqB,CAAC;CAkBxD"}

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

@@ -1,132 +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) {
-        this.idBasedEditor = idBasedEditor;
-        this.locator = locator;
-    }
-    addNodeExistsConstraint(path) {
-        const normal = normalizeUpPath(path, this.locator);
-        this.idBasedEditor.addNodeExistsConstraint(normal);
-    }
-    addNodeExistsConstraintOnRevert(path) {
-        const normal = normalizeUpPath(path, this.locator);
-        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);
-        const lowLevelEditor = this.idBasedEditor.valueField(normal);
-        const locator = this.locator;
-        const editBuilder = {
-            set: (newContent) => {
-                lowLevelEditor.set(newContent);
-            },
-            attach: (newContent) => {
-                const changeAtom = locator.idFromLocation(newContent);
-                lowLevelEditor.attach(changeAtom);
-            },
-        };
-        return editBuilder;
-    }
-    optionalField(field) {
-        const normal = normalizeFieldUpPath(field, this.locator);
-        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);
-                lowLevelEditor.attach(changeAtom, wasEmpty);
-            },
-            clear: (wasEmpty) => {
-                lowLevelEditor.clear(wasEmpty);
-            },
-        };
-        return editBuilder;
-    }
-    move(sourceField, sourceIndex, count, destinationField, destIndex) {
-        const normalSource = normalizeFieldUpPath(sourceField, this.locator);
-        const normalDestination = normalizeFieldUpPath(destinationField, this.locator);
-        this.idBasedEditor.move(normalSource, sourceIndex, count, normalDestination, destIndex);
-    }
-    sequenceField(field) {
-        const normal = normalizeFieldUpPath(field, this.locator);
-        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);
-                lowLevelEditor.attach(index, range);
-            },
-            remove: (index, count) => {
-                lowLevelEditor.remove(index, count);
-            },
-        };
-        return editBuilder;
-    }
-}
-exports.LocationBasedDataEditor = LocationBasedDataEditor;
-function normalizeUpPath(path, locator) {
-    if (path.parent === undefined) {
-        if (path.parentField === index_js_1.rootFieldKey) {
-            return { ...path, parent: undefined, detachedNodeId: undefined };
-        }
-        else {
-            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),
-            parentField: path.parentField,
-            parentIndex: path.parentIndex,
-        };
-    }
-}
-function normalizeFieldUpPath(path, locator) {
-    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), field: path.field };
-    }
-}
-//# 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;AACtE,kDAU6B;AA8B7B;;;GAGG;AACH,MAAa,uBAAuB;IAGnC,YACkB,aAAmE,EACnE,OAAgB;QADhB,kBAAa,GAAb,aAAa,CAAsD;QACnE,YAAO,GAAP,OAAO,CAAS;IAC/B,CAAC;IAEG,uBAAuB,CAAC,IAAY;QAC1C,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,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,CAAC,CAAC;QACnD,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,CAAC,CAAC;QACzD,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,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,CAAC,CAAC;QACzD,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,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,CAAC,CAAC;QACrE,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/E,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,CAAC,CAAC;QACzD,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,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;AAzGD,0DAyGC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,OAAgB;IACtD,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,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,CAAC;YAC7C,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAiB,EAAE,OAAgB;IAChE,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,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAC7E,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\";\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} 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}\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) {}\n\n\tpublic addNodeExistsConstraint(path: UpPath): void {\n\t\tconst normal = normalizeUpPath(path, this.locator);\n\t\tthis.idBasedEditor.addNodeExistsConstraint(normal);\n\t}\n\n\tpublic addNodeExistsConstraintOnRevert(path: UpPath): void {\n\t\tconst normal = normalizeUpPath(path, this.locator);\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);\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\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);\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\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);\n\t\tconst normalDestination = normalizeFieldUpPath(destinationField, this.locator);\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);\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\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(path: UpPath, locator: Locator): 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\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),\n\t\t\tparentField: path.parentField,\n\t\t\tparentIndex: path.parentIndex,\n\t\t};\n\t}\n}\n\nfunction normalizeFieldUpPath(path: FieldUpPath, locator: Locator): 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), field: path.field };\n\t}\n}\n"]}

package/dist/feature-libraries/modular-schema/modularChangeCodecV3.d.ts

@@ -1,15 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type ICodecOptions, type IJsonCodec } from "../../codec/index.js";
-import { type ChangeEncodingContext, type EncodedRevisionTag, type RevisionTag } from "../../core/index.js";
-import { type FieldBatchCodec } from "../chunked-forest/index.js";
-import { TreeCompressionStrategy } from "../treeCompressionUtils.js";
-import type { FieldKindConfiguration } from "./fieldKindConfiguration.js";
-import { type ModularChangeset } from "./modularChangeTypes.js";
-import { EncodedModularChangeset } from "./modularChangeFormatV3.js";
-type ModularChangeCodec = IJsonCodec<ModularChangeset, EncodedModularChangeset, EncodedModularChangeset, ChangeEncodingContext>;
-export declare function makeModularChangeCodecV3(fieldKinds: FieldKindConfiguration, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, fieldsCodec: FieldBatchCodec, codecOptions: ICodecOptions, chunkCompressionStrategy?: TreeCompressionStrategy): ModularChangeCodec;
-export {};
-//# sourceMappingURL=modularChangeCodecV3.d.ts.map

package/dist/feature-libraries/modular-schema/modularChangeCodecV3.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"modularChangeCodecV3.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/modular-schema/modularChangeCodecV3.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,KAAK,aAAa,EAClB,KAAK,UAAU,EAGf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAIN,KAAK,qBAAqB,EAE1B,KAAK,kBAAkB,EAKvB,KAAK,WAAW,EAChB,MAAM,qBAAqB,CAAC;AAY7B,OAAO,EAGN,KAAK,eAAe,EAEpB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAQ1E,OAAO,EAMN,KAAK,gBAAgB,EAKrB,MAAM,yBAAyB,CAAC;AAYjC,OAAO,EACN,uBAAuB,EAGvB,MAAM,4BAA4B,CAAC;AAKpC,KAAK,kBAAkB,GAAG,UAAU,CACnC,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,CACrB,CAAC;AASF,wBAAgB,wBAAwB,CACvC,UAAU,EAAE,sBAAsB,EAClC,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,YAAY,EAAE,aAAa,EAC3B,wBAAwB,GAAE,uBAA4D,GACpF,kBAAkB,CA0jBpB"}