@fluid-experimental/tree 2.81.1 → 2.83.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/tree",
-  "version": "2.81.1",
+  "version": "2.83.0",
   "description": "Distributed tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -27,19 +27,19 @@
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.81.1",
-    "@fluidframework/container-definitions": "~2.81.1",
-    "@fluidframework/core-interfaces": "~2.81.1",
-    "@fluidframework/core-utils": "~2.81.1",
-    "@fluidframework/datastore-definitions": "~2.81.1",
-    "@fluidframework/driver-definitions": "~2.81.1",
-    "@fluidframework/id-compressor": "~2.81.1",
-    "@fluidframework/runtime-definitions": "~2.81.1",
-    "@fluidframework/runtime-utils": "~2.81.1",
-    "@fluidframework/shared-object-base": "~2.81.1",
-    "@fluidframework/telemetry-utils": "~2.81.1",
-    "@fluidframework/tree": "~2.81.1",
-    "@tylerbu/sorted-btree-es6": "^1.8.0",
+    "@fluid-internal/client-utils": "~2.83.0",
+    "@fluidframework/container-definitions": "~2.83.0",
+    "@fluidframework/core-interfaces": "~2.83.0",
+    "@fluidframework/core-utils": "~2.83.0",
+    "@fluidframework/datastore-definitions": "~2.83.0",
+    "@fluidframework/driver-definitions": "~2.83.0",
+    "@fluidframework/id-compressor": "~2.83.0",
+    "@fluidframework/runtime-definitions": "~2.83.0",
+    "@fluidframework/runtime-utils": "~2.83.0",
+    "@fluidframework/shared-object-base": "~2.83.0",
+    "@fluidframework/telemetry-utils": "~2.83.0",
+    "@fluidframework/tree": "~2.83.0",
+    "@tylerbu/sorted-btree-es6": "^2.1.1",
     "buffer": "^6.0.3",
     "denque": "^1.5.1",
     "lru-cache": "^6.0.0",
@@ -48,20 +48,20 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.81.1",
-    "@fluid-private/stochastic-test-utils": "~2.81.1",
-    "@fluid-private/test-drivers": "~2.81.1",
+    "@fluid-internal/mocha-test-setup": "~2.83.0",
+    "@fluid-private/stochastic-test-utils": "~2.83.0",
+    "@fluid-private/test-drivers": "~2.83.0",
     "@fluid-tools/benchmark": "^0.52.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.63.0",
-    "@fluidframework/container-definitions": "~2.81.1",
-    "@fluidframework/container-loader": "~2.81.1",
-    "@fluidframework/container-runtime": "~2.81.1",
-    "@fluidframework/eslint-config-fluid": "~2.81.1",
-    "@fluidframework/runtime-utils": "~2.81.1",
-    "@fluidframework/test-runtime-utils": "~2.81.1",
-    "@fluidframework/test-utils": "~2.81.1",
-    "@fluidframework/undo-redo": "~2.81.1",
+    "@fluidframework/container-definitions": "~2.83.0",
+    "@fluidframework/container-loader": "~2.83.0",
+    "@fluidframework/container-runtime": "~2.83.0",
+    "@fluidframework/eslint-config-fluid": "~2.83.0",
+    "@fluidframework/runtime-utils": "~2.83.0",
+    "@fluidframework/test-runtime-utils": "~2.83.0",
+    "@fluidframework/test-utils": "~2.83.0",
+    "@fluidframework/undo-redo": "~2.83.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/chai": "^4.0.0",
     "@types/lru-cache": "^5.1.0",

package/src/ChangeTypes.ts

@@ -246,12 +246,16 @@ export const Change = {
 	/** Helpers for making high-level composite operations */
 
 	/**
-	 * @returns a change that deletes the supplied part of the tree.
+	 * Deletes a range of nodes from the tree.
+	 *
+	 * @returns A change that deletes the supplied part of the tree.
 	 */
 	delete: (stableRange: StableRange): Change => Change.detach(stableRange),
 
 	/**
-	 * @returns changes that insert 'nodes' into the specified location in the tree.
+	 * Inserts nodes into the tree at the specified location.
+	 *
+	 * @returns The changes that insert 'nodes' into the specified location in the tree.
 	 */
 	insertTree: (nodes: BuildNode | TreeNodeSequence<BuildNode>, destination: StablePlace): Change[] => {
 		const build = Change.build(nodes, 0);
@@ -259,7 +263,9 @@ export const Change = {
 	},
 
 	/**
-	 * @returns changes that moves the specified content to a new location in the tree.
+	 * Moves nodes from one location to another in the tree.
+	 *
+	 * @returns The changes that moves the specified content to a new location in the tree.
 	 */
 	move: (source: StableRange, destination: StablePlace): Change[] => {
 		const detach = Change.detach(source, 0);
@@ -348,6 +354,8 @@ export interface StableRange {
  */
 export const StablePlace = {
 	/**
+	 * Creates a stable place representing the location directly before a node.
+	 *
 	 * @returns The location directly before `node`.
 	 */
 	before: (node: NodeData<NodeId> | NodeId): StablePlace => ({
@@ -355,6 +363,8 @@ export const StablePlace = {
 		referenceSibling: getNodeId(node),
 	}),
 	/**
+	 * Creates a stable place representing the location directly after a node.
+	 *
 	 * @returns The location directly after `node`.
 	 */
 	after: (node: NodeData<NodeId> | NodeId): StablePlace => ({
@@ -362,6 +372,8 @@ export const StablePlace = {
 		referenceSibling: getNodeId(node),
 	}),
 	/**
+	 * Creates a stable place representing the location at the start of a trait.
+	 *
 	 * @returns The location at the start of `trait`.
 	 */
 	atStartOf: (trait: TraitLocation): StablePlace => ({
@@ -369,6 +381,8 @@ export const StablePlace = {
 		referenceTrait: trait,
 	}),
 	/**
+	 * Creates a stable place representing the location at the end of a trait.
+	 *
 	 * @returns The location at the end of `trait`.
 	 */
 	atEndOf: (trait: TraitLocation): StablePlace => ({
@@ -407,7 +421,9 @@ export const StableRange = {
 		},
 	}),
 	/**
-	 * @returns a `StableRange` which contains only the provided `node`.
+	 * Creates a `StableRange` which contains only the provided `node`.
+	 *
+	 * @remarks
 	 * Both the start and end `StablePlace` objects used to anchor this `StableRange` are in terms of the passed in node.
 	 */
 	only: (node: NodeData<NodeId> | NodeId): StableRange => ({
@@ -415,7 +431,9 @@ export const StableRange = {
 		end: StablePlace.after(node),
 	}),
 	/**
-	 * @returns a `StableRange` which contains everything in the trait.
+	 * Creates a `StableRange` which contains everything in the trait.
+	 *
+	 * @remarks
 	 * This is anchored using the provided `trait`, and is independent of the actual contents of the trait:
 	 * it does not use sibling anchoring.
 	 */

package/src/Checkout.ts

@@ -142,7 +142,9 @@ export abstract class Checkout extends EventEmitterWithErrorHandling<ICheckoutEv
 	}
 
 	/**
-	 * @returns the current view of the tree, including the result of changes applied so far during an edit.
+	 * Gets the current view of the tree, including the result of changes applied so far during an edit.
+	 *
+	 * @remarks
 	 * Note that any external edits (from other clients) will not added to view while there is a `currentEdit`.
 	 */
 	public get currentView(): TreeView {
@@ -150,7 +152,7 @@ export abstract class Checkout extends EventEmitterWithErrorHandling<ICheckoutEv
 	}
 
 	/**
-	 * @returns true iff there is an open edit.
+	 * Whether there is currently an open edit operation.
 	 */
 	public hasOpenEdit(): boolean {
 		return this.currentEdit !== undefined;
@@ -371,7 +373,9 @@ export abstract class Checkout extends EventEmitterWithErrorHandling<ICheckoutEv
 	}
 
 	/**
-	 * @returns the {@link EditStatus} of the current edit.
+	 * Gets the {@link EditStatus} of the current edit.
+	 *
+	 * @remarks
 	 * Has no side effects.
 	 * Can only be called if an edit is open.
 	 */

package/src/Common.ts

@@ -5,6 +5,8 @@
 
 import { ITelemetryBaseEvent, ITelemetryBaseProperties } from '@fluidframework/core-interfaces';
 import { BTree } from '@tylerbu/sorted-btree-es6';
+// eslint-disable-next-line import-x/no-internal-modules
+import { diffAgainst } from '@tylerbu/sorted-btree-es6/extended/diffAgainst';
 
 const defaultFailMessage = 'Assertion failed';
 
@@ -354,6 +356,8 @@ export function setPropertyIfDefined<TDst, P extends keyof TDst>(
 }
 
 /**
+ * Returns an object indicating that iteration should break due to finding a difference.
+ *
  * @example
  *
  * ```typescript
@@ -380,7 +384,7 @@ export function compareBtrees<K, V>(
 	treeB: BTree<K, V>,
 	compare: (valA: V, valB: V) => boolean
 ): boolean {
-	const diff = treeA.diffAgainst(treeB, breakOnDifference, breakOnDifference, (_, valA, valB) => {
+	const diff = diffAgainst(treeA, treeB, breakOnDifference, breakOnDifference, (_, valA, valB) => {
 		if (!compare(valA, valB)) {
 			return { break: true };
 		}
@@ -506,9 +510,8 @@ export type RecursiveMutable<T> = {
 };
 
 /** Type that produces a writeable map from a readonly map. */
-export type MutableMap<T extends ReadonlyMap<unknown, unknown>> = T extends ReadonlyMap<infer K, infer V>
-	? Map<K, V>
-	: never;
+export type MutableMap<T extends ReadonlyMap<unknown, unknown>> =
+	T extends ReadonlyMap<infer K, infer V> ? Map<K, V> : never;
 
 /** Type that includes the property K: V on T */
 export type With<T, K extends keyof never, V> = T & { [key in K]: V };

package/src/Forest.ts

@@ -5,6 +5,8 @@
 
 import { assert } from '@fluidframework/core-utils/internal';
 import { BTree } from '@tylerbu/sorted-btree-es6';
+// eslint-disable-next-line import-x/no-internal-modules
+import { diffAgainst } from '@tylerbu/sorted-btree-es6/extended/diffAgainst';
 
 import { compareBtrees, compareFiniteNumbers, copyPropertyIfDefined, fail } from './Common.js';
 import { NodeId, TraitLabel } from './Identifiers.js';
@@ -481,7 +483,8 @@ export class Forest {
 		const changed: NodeId[] = [];
 		const removed: NodeId[] = [];
 		const added: NodeId[] = [];
-		this.nodes.diffAgainst(
+		diffAgainst(
+			this.nodes,
 			forest.nodes,
 			(id) => {
 				removed.push(id);

package/src/LogViewer.ts

@@ -478,6 +478,7 @@ export class CachingLogViewer extends TypedEventEmitter<ICachingLogViewerEvents>
 		let cached;
 		let reconciliationPath: ReconciliationPath = [];
 		if (
+			// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- TODO: ADO#58517 Code owners should verify if this code change is safe and make it if so or update this comment otherwise
 			this.cachedEditResult !== undefined &&
 			this.cachedEditResult.editId === edit.id &&
 			this.cachedEditResult.result.before === prevView

package/src/id-compressor/AppendOnlySortedMap.ts

@@ -22,42 +22,42 @@ export class AppendOnlySortedMap<K, V> {
 	public constructor(protected readonly comparator: (a: K, b: K) => number) {}
 
 	/**
-	 * @returns the number of entries in this map
+	 * Gets the number of entries in this map
 	 */
 	public get size(): number {
 		return this.elements.length / 2;
 	}
 
 	/**
-	 * @returns the min key in the map.
+	 * Gets the min key in the map.
 	 */
 	public minKey(): K | undefined {
 		return this.elements[0] as K | undefined;
 	}
 
 	/**
-	 * @returns the max key in the map.
+	 * Gets the max key in the map.
 	 */
 	public maxKey(): K | undefined {
 		return this.elements[this.elements.length - 2] as K | undefined;
 	}
 
 	/**
-	 * @returns the min value in the map.
+	 * Gets the min value in the map.
 	 */
 	public minValue(): V | undefined {
 		return this.elements[1] as V | undefined;
 	}
 
 	/**
-	 * @returns the min value in the map.
+	 * Gets the max value in the map.
 	 */
 	public maxValue(): V | undefined {
 		return this.elements[this.elements.length - 1] as V | undefined;
 	}
 
 	/**
-	 * @returns the min key in the map.
+	 * Gets the first entry in the map.
 	 */
 	public first(): [K, V] | undefined {
 		const { elements } = this;
@@ -69,7 +69,7 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @returns the max key in the map.
+	 * Gets the last entry in the map.
 	 */
 	public last(): [K, V] | undefined {
 		const { elements } = this;
@@ -94,7 +94,7 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @returns an iterable of the entries in the map.
+	 * Gets an iterable of the entries in the map.
 	 */
 	public *entries(): IterableIterator<readonly [K, V]> {
 		const { elements } = this;
@@ -104,7 +104,7 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @returns an iterable of the keys in the map.
+	 * Gets an iterable of the keys in the map.
 	 */
 	public *keys(): IterableIterator<K> {
 		const { elements } = this;
@@ -114,7 +114,7 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @returns an iterable of the values in the map.
+	 * Gets an iterable of the values in the map.
 	 */
 	public *values(): IterableIterator<V> {
 		const { elements } = this;
@@ -124,7 +124,7 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @returns an iterable of the entries in the map, reversed.
+	 * Gets an iterable of the entries in the map, reversed.
 	 */
 	public *entriesReversed(): IterableIterator<readonly [K, V]> {
 		const { elements } = this;
@@ -135,8 +135,8 @@ export class AppendOnlySortedMap<K, V> {
 
 	/**
 	 * Adds a new key/value pair to the map. `key` must be \> to all keys in the map.
-	 * @param key - the key to add.
-	 * @param value - the value to add.
+	 * @param key - The key to add.
+	 * @param value - The value to add.
 	 */
 	public append(key: K, value: V): void {
 		const { elements } = this;
@@ -149,8 +149,8 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @param key - the key to lookup.
-	 * @returns the value associated with `key` if such an entry exists, and undefined otherwise.
+	 * Gets the value associated with `key` if such an entry exists, and `undefined` otherwise.
+	 * @param key - The key to lookup.
 	 */
 	public get(key: K): V | undefined {
 		const index = AppendOnlySortedMap.keyIndexOf(this.elements, key, this.comparator);
@@ -161,18 +161,18 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * @param key - the key to lookup.
-	 * @returns the entry associated with `key` if such an entry exists, the entry associated with the next lower key if such an entry
-	 * exists, and undefined otherwise.
+	 * Gets the entry associated with `key` if such an entry exists, the entry associated with the next lower key if
+	 * such an entry exists, and `undefined` otherwise.
+	 * @param key - The key to lookup.
 	 */
 	public getPairOrNextLower(key: K): readonly [K, V] | undefined {
 		return this.getPairOrNextLowerBy(key, this.comparator);
 	}
 
 	/**
-	 * @param key - the key to lookup.
-	 * @returns the entry associated with `key` if such an entry exists, the entry associated with the next higher key if such an entry
-	 * exists, and undefined otherwise.
+	 * Gets the entry associated with `key` if such an entry exists, the entry associated with the next higher key if
+	 * such an entry exists, and `undefined` otherwise.
+	 * @param key - The key to lookup.
 	 */
 	public getPairOrNextHigher(key: K): readonly [K, V] | undefined {
 		return this.getPairOrNextHigherBy(key, this.comparator);

package/src/id-compressor/IdCompressor.ts

@@ -7,6 +7,8 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 import { assert } from '@fluidframework/core-utils/internal';
 import { ITelemetryLoggerExt, createChildLogger } from '@fluidframework/telemetry-utils/internal';
 import { BTree } from '@tylerbu/sorted-btree-es6';
+// eslint-disable-next-line import-x/no-internal-modules
+import { diffAgainst } from '@tylerbu/sorted-btree-es6/extended/diffAgainst';
 
 import {
 	Mutable,
@@ -1416,7 +1418,8 @@ export class IdCompressor {
 			return true;
 		};
 
-		const diff = this.clustersAndOverridesInversion.diffAgainst(
+		const diff = diffAgainst(
+			this.clustersAndOverridesInversion,
 			other.clustersAndOverridesInversion,
 			missingInOne,
 			missingInOne,

package/api-extractor-lint.json

@@ -1,4 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json"
-}