@fluidframework/tree 2.81.0-374083 → 2.81.1

package/src/core/tree/detachedFieldIndexCodecCommon.ts

@@ -3,6 +3,8 @@
  * Licensed under the MIT License.
  */
 
+import type { Static, TSchema } from "@sinclair/typebox";
+
 import type { IJsonCodec } from "../../codec/index.js";
 import { hasSingle } from "../../util/index.js";
 
@@ -17,7 +19,6 @@ import type {
 	DetachedFieldSummaryData,
 	Major,
 } from "./detachedFieldIndexTypes.js";
-import type { Static, TSchema } from "@sinclair/typebox";
 
 // Return type is intentionally derived.
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type

package/src/core/tree/detachedFieldIndexCodecV1.ts

@@ -7,6 +7,7 @@ import { assert } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
 import type { CodecAndSchema, IJsonCodec } from "../../codec/index.js";
+import { brand } from "../../util/index.js";
 import {
 	type EncodedRevisionTag,
 	type RevisionTagCodec,
@@ -14,10 +15,9 @@ import {
 	RevisionTagSchema,
 } from "../rebase/index.js";
 
-import type { DetachedFieldSummaryData, Major } from "./detachedFieldIndexTypes.js";
 import { makeDetachedFieldIndexCodecFromMajorCodec } from "./detachedFieldIndexCodecCommon.js";
 import { DetachedFieldIndexFormatVersion } from "./detachedFieldIndexFormatCommon.js";
-import { brand } from "../../util/index.js";
+import type { DetachedFieldSummaryData, Major } from "./detachedFieldIndexTypes.js";
 
 class MajorCodec implements IJsonCodec<Major, EncodedRevisionTag> {
 	public constructor(

package/src/core/tree/detachedFieldIndexCodecV2.ts

@@ -5,15 +5,15 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor, StableId } from "@fluidframework/id-compressor";
+import { isStableId } from "@fluidframework/id-compressor/internal";
 
 import type { CodecAndSchema, IJsonCodec } from "../../codec/index.js";
 import type { EncodedRevisionTag, RevisionTagCodec, RevisionTag } from "../rebase/index.js";
 
-import { StableOrFinalRevisionTag } from "./detachedFieldIndexFormatV2.js";
-import type { DetachedFieldSummaryData, Major } from "./detachedFieldIndexTypes.js";
 import { makeDetachedFieldIndexCodecFromMajorCodec } from "./detachedFieldIndexCodecCommon.js";
-import { isStableId } from "@fluidframework/id-compressor/internal";
 import { DetachedFieldIndexFormatVersion } from "./detachedFieldIndexFormatCommon.js";
+import { StableOrFinalRevisionTag } from "./detachedFieldIndexFormatV2.js";
+import type { DetachedFieldSummaryData, Major } from "./detachedFieldIndexTypes.js";
 
 class MajorCodec implements IJsonCodec<Major> {
 	public constructor(

package/src/core/tree/detachedFieldIndexFormatV1.ts

@@ -5,9 +5,10 @@
 
 import type { Static } from "@sinclair/typebox";
 
-import { DetachedFieldIndexFormatVersion, Format } from "./detachedFieldIndexFormatCommon.js";
-import { RevisionTagSchema } from "../rebase/index.js";
 import { brand } from "../../util/index.js";
+import { RevisionTagSchema } from "../rebase/index.js";
+
+import { DetachedFieldIndexFormatVersion, Format } from "./detachedFieldIndexFormatCommon.js";
 
 export const FormatV1 = Format(
 	brand<DetachedFieldIndexFormatVersion>(DetachedFieldIndexFormatVersion.v1),

package/src/core/tree/detachedFieldIndexFormatV2.ts

@@ -5,9 +5,10 @@
 
 import { Type, type Static } from "@sinclair/typebox";
 
-import { DetachedFieldIndexFormatVersion, Format } from "./detachedFieldIndexFormatCommon.js";
-import { RevisionTagSchema, StableIdSchema } from "../rebase/index.js";
 import { brand } from "../../util/index.js";
+import { RevisionTagSchema, StableIdSchema } from "../rebase/index.js";
+
+import { DetachedFieldIndexFormatVersion, Format } from "./detachedFieldIndexFormatCommon.js";
 
 export const StableOrFinalRevisionTag = Type.Union([RevisionTagSchema, StableIdSchema]);
 

package/src/core/tree/index.ts

@@ -59,9 +59,8 @@ export {
 	type NodeIndex,
 	compareUpPaths,
 	compareFieldUpPaths,
-	isDetachedUpPathRoot,
+	isDetachedUpPathRoot as isDetachedUpPath,
 	getDetachedFieldContainingPath,
-	getDetachedFieldContainingFieldPath,
 	type UpPathDefault,
 } from "./pathTree.js";
 export {

package/src/core/tree/pathTree.ts

@@ -126,7 +126,7 @@ export interface FieldUpPath<TUpPath = UpPath> {
  */
 export function isDetachedUpPathRoot<T>(
 	path: UpPath<T> | NormalizedUpPath,
-): path is NormalizedUpPathRoot & { readonly detachedNodeId: DetachedNodeId } {
+): path is NormalizedUpPathRoot {
 	return (path as NormalizedUpPathRoot).detachedNodeId !== undefined;
 }
 
@@ -219,8 +219,8 @@ export function clonePath(path: UpPath | undefined): UpPath | undefined {
  * Gets the elements of the given `path`, ordered from root-most to child-most.
  * @remarks These elements are unchanged and therefore still point "up".
  */
-export function topDownPath<T extends UpPath<T>>(path: T | undefined): T[] {
-	const out: T[] = [];
+export function topDownPath(path: UpPath | undefined): UpPath[] {
+	const out: UpPath[] = [];
 	let curr = path;
 	while (curr !== undefined) {
 		out.push(curr);
@@ -262,7 +262,7 @@ export function compareFieldUpPaths(a: FieldUpPath, b: FieldUpPath): boolean {
 }
 
 /**
- * Returns the field key for the root field.
+ * Checks whether or not a given path is parented under the root field.
  * @param path - the path you want to check.
  * @returns the {@link DetachedField} which contains the path.
  */
@@ -277,15 +277,3 @@ export function getDetachedFieldContainingPath(path: UpPath): DetachedField {
 	}
 	return keyAsDetachedField(path.parentField);
 }
-
-/**
- * Returns the field key for the root field.
- * @param path - the path you want to check.
- * @returns the {@link DetachedField} which contains the path.
- */
-export function getDetachedFieldContainingFieldPath(path: FieldUpPath): DetachedField {
-	if (path.parent === undefined) {
-		return keyAsDetachedField(path.field);
-	}
-	return getDetachedFieldContainingPath(path.parent);
-}

package/src/core/tree/visitDelta.ts

@@ -6,17 +6,16 @@
 import { assert } from "@fluidframework/core-utils/internal";
 
 import { type NestedMap, setInNestedMap, tryGetFromNestedMap } from "../../util/index.js";
-
+import type { RevisionTag } from "../rebase/index.js";
 import type { FieldKey } from "../schema-stored/index.js";
 
+import type { TreeChunk } from "./chunk.js";
 import { mapCursorField, type ITreeCursorSynchronous } from "./cursor.js";
 import type * as Delta from "./delta.js";
 import { areDetachedNodeIdsEqual, offsetDetachId } from "./deltaUtil.js";
 import type { DetachedFieldIndex } from "./detachedFieldIndex.js";
 import type { ForestRootId, Major, Minor } from "./detachedFieldIndexTypes.js";
 import type { NodeIndex, PlaceIndex, Range } from "./pathTree.js";
-import type { RevisionTag } from "../rebase/index.js";
-import type { TreeChunk } from "./chunk.js";
 
 /**
  * Implementation notes:

package/src/core/tree/visitorUtils.ts

@@ -174,6 +174,8 @@ export interface AnnouncedVisitor extends DeltaVisitor {
 	): void;
 }
 
+const noOp = (): void => {};
+
 /**
  * Creates an announced visitor with only the provided functions and uses a no op for the rest.
  * This is provided to make some of the delta visitor definitions cleaner.
@@ -181,7 +183,6 @@ export interface AnnouncedVisitor extends DeltaVisitor {
 export function createAnnouncedVisitor(
 	visitorFunctions: Partial<AnnouncedVisitor>,
 ): AnnouncedVisitor {
-	const noOp = (): void => {};
 	return {
 		type: "Announced",
 		free: visitorFunctions.free ?? noOp,

package/src/feature-libraries/changeAtomIdBTree.ts

@@ -3,13 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import {
-	subtractChangeAtomIds,
-	type ChangeAtomId,
-	type ChangesetLocalId,
-	type RevisionTag,
-} from "../core/index.js";
-import type { RangeQueryResult, TupleBTree } from "../util/index.js";
+import type { ChangeAtomId, ChangesetLocalId, RevisionTag } from "../core/index.js";
+import type { TupleBTree } from "../util/index.js";
 
 /**
  * A BTree which uses ChangeAtomId flattened into a tuple as the key.
@@ -32,25 +27,6 @@ export function setInChangeAtomIdMap<T>(
 	map: ChangeAtomIdBTree<T>,
 	id: ChangeAtomId,
 	value: T,
-): boolean {
-	return map.set([id.revision, id.localId], value);
-}
-
-export function rangeQueryChangeAtomIdMap<T>(
-	map: ChangeAtomIdBTree<T>,
-	id: ChangeAtomId,
-	count: number,
-): RangeQueryResult<T | undefined> {
-	const pair = map.getPairOrNextHigher([id.revision, id.localId]);
-	if (pair === undefined) {
-		return { value: undefined, length: count };
-	}
-
-	const [[revision, localId], value] = pair;
-	const lengthBefore = subtractChangeAtomIds({ revision, localId }, id);
-	if (lengthBefore === 0) {
-		return { value, length: 1 };
-	}
-
-	return { value: undefined, length: Math.min(lengthBefore, count) };
+): void {
+	map.set([id.revision, id.localId], value);
 }

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

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert, oob, fail, debugAssert } from "@fluidframework/core-utils/internal";
+import { assert, oob, fail } from "@fluidframework/core-utils/internal";
 
 import {
 	CursorLocationType,
@@ -51,12 +51,6 @@ export class BasicChunk extends ReferenceCountedBase implements TreeChunk {
 		public value?: TreeValue,
 	) {
 		super();
-		debugAssert(() => {
-			for (const field of fields.values()) {
-				if (field.length === 0) return "field must have at least one child";
-			}
-			return true;
-		});
 	}
 
 	public clone(): BasicChunk {

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

@@ -29,9 +29,9 @@ import { getOrCreate } from "../../util/index.js";
 import { isStableNodeIdentifier } from "../node-identifier/index.js";
 
 import { BasicChunk } from "./basicChunk.js";
+import type { IncrementalEncodingPolicy } from "./codec/index.js";
 import { SequenceChunk } from "./sequenceChunk.js";
 import { type FieldShape, TreeShape, UniformChunk } from "./uniformChunk.js";
-import type { IncrementalEncodingPolicy } from "./codec/index.js";
 
 export interface Disposable {
 	/**
@@ -436,12 +436,7 @@ function newBasicChunkTree(
 ): BasicChunk {
 	return new BasicChunk(
 		cursor.type,
-		new Map(
-			mapCursorFields(cursor, () => {
-				debugAssert(() => cursor.getFieldLength() > 0 || "field must have at least one child");
-				return [cursor.getFieldKey(), chunkField(cursor, policy)];
-			}),
-		),
+		new Map(mapCursorFields(cursor, () => [cursor.getFieldKey(), chunkField(cursor, policy)])),
 		cursor.value,
 	);
 }

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

@@ -37,6 +37,7 @@ import {
 	decode as genericDecode,
 	readStreamIdentifier,
 } from "./chunkDecodingGeneric.js";
+import type { IncrementalDecoder } from "./codecs.js";
 import {
 	type EncodedAnyShape,
 	type EncodedChunkShape,
@@ -49,7 +50,6 @@ import {
 	FieldBatchFormatVersion,
 	SpecialField,
 } from "./format.js";
-import type { IncrementalDecoder } from "./codecs.js";
 
 export interface IdDecodingContext {
 	idCompressor: IIdCompressor;

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

@@ -16,8 +16,8 @@ import {
 	readStream,
 } from "./chunkCodecUtilities.js";
 import type { IdDecodingContext } from "./chunkDecoding.js";
-import type { EncodedFieldBatchGeneric, IdentifierOrIndex } from "./formatGeneric.js";
 import type { IncrementalDecoder } from "./codecs.js";
+import type { EncodedFieldBatchGeneric, IdentifierOrIndex } from "./formatGeneric.js";
 
 /**
  * General purpose shape based tree decoder which gets its support for specific shapes from the caller.

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

@@ -14,8 +14,8 @@ import {
 	type DeduplicationTable,
 	jsonMinimizingFilter,
 } from "./chunkCodecUtilities.js";
-import type { EncodedFieldBatchGeneric } from "./formatGeneric.js";
 import type { FieldBatchFormatVersion } from "./format.js";
+import type { EncodedFieldBatchGeneric } from "./formatGeneric.js";
 
 /**
  * An identifier which can be compressed using {@link Counter}.

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

@@ -5,6 +5,7 @@
 
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 import {
 	getConfigForMinVersionForCollab,
 	lowestMinVersionForCollab,
@@ -41,10 +42,9 @@ import {
 	EncodedFieldBatchV1,
 	EncodedFieldBatchV2,
 } from "./format.js";
-import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 import type { IncrementalEncodingPolicy } from "./incrementalEncodingPolicy.js";
-import { uncompressedEncodeV1, uncompressedEncodeV2 } from "./uncompressedEncode.js";
 import { schemaCompressedEncodeV1, schemaCompressedEncodeV2 } from "./schemaBasedEncode.js";
+import { uncompressedEncodeV1, uncompressedEncodeV2 } from "./uncompressedEncode.js";
 
 /**
  * Reference ID for a chunk that is incrementally encoded.

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

@@ -26,6 +26,7 @@ import {
 	Shape as ShapeGeneric,
 	updateShapesAndIdentifiersEncoding,
 } from "./chunkEncodingGeneric.js";
+import type { IncrementalEncoder } from "./codecs.js";
 import type { FieldBatch } from "./fieldBatch.js";
 import {
 	type EncodedAnyShape,
@@ -36,7 +37,6 @@ import {
 	FieldBatchFormatVersion,
 	SpecialField,
 } from "./format.js";
-import type { IncrementalEncoder } from "./codecs.js";
 
 /**
  * Encode data from `FieldBatch` into an `EncodedFieldBatch`.

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

@@ -6,6 +6,7 @@
 import { type Static, Type } from "@sinclair/typebox";
 
 import { unionOptions } from "../../../codec/index.js";
+import { strictEnum, type Values } from "../../../util/index.js";
 
 import {
 	Count,
@@ -13,7 +14,6 @@ import {
 	IdentifierOrIndex,
 	ShapeIndex,
 } from "./formatGeneric.js";
-import { strictEnum, type Values } from "../../../util/index.js";
 
 /**
  * The format version for the field batch.

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

@@ -4,6 +4,7 @@
  */
 
 import { type Static, type TSchema, Type } from "@sinclair/typebox";
+
 import type { FieldBatchFormatVersion } from "./format.js";
 
 /**

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

@@ -18,7 +18,9 @@ import {
 	identifierFieldKindIdentifier,
 	type SchemaPolicy,
 } from "../../../core/index.js";
+import { brand, oneFromIterable } from "../../../util/index.js";
 
+import type { IncrementalEncoder } from "./codecs.js";
 import {
 	EncoderContext,
 	type FieldEncoder,
@@ -39,10 +41,8 @@ import {
 	FieldBatchFormatVersion,
 	SpecialField,
 } from "./format.js";
-import type { IncrementalEncoder } from "./codecs.js";
-import { NodeShapeBasedEncoder } from "./nodeEncoder.js";
 import { defaultIncrementalEncodingPolicy } from "./incrementalEncodingPolicy.js";
-import { brand, oneFromIterable } from "../../../util/index.js";
+import { NodeShapeBasedEncoder } from "./nodeEncoder.js";
 
 /**
  * Encode data from `fieldBatch` in into an `EncodedChunk` using {@link FieldBatchFormatVersion.v1}.