@fluidframework/tree 2.74.0 → 2.80.0

package/src/feature-libraries/treeTextCursor.ts

@@ -94,13 +94,13 @@ export const adapter: CursorAdapter<JsonableTree> = {
 export function jsonableTreeFromCursor(cursor: ITreeCursor): JsonableTree {
 	assert(cursor.mode === CursorLocationType.Nodes, 0x3ba /* must start at node */);
 	const node: JsonableTree =
-		cursor.value !== undefined
+		cursor.value === undefined
 			? {
 					type: cursor.type,
-					value: cursor.value,
 				}
 			: {
 					type: cursor.type,
+					value: cursor.value,
 				};
 
 	// Normalize object by only including fields that are required.

package/src/feature-libraries/valueUtilities.ts

@@ -21,18 +21,24 @@ export function valueSchemaAllows<TSchema extends ValueSchema>(
 	nodeValue: Value,
 ): nodeValue is TreeValue<TSchema> {
 	switch (schema) {
-		case ValueSchema.String:
+		case ValueSchema.String: {
 			return typeof nodeValue === "string";
-		case ValueSchema.Number:
+		}
+		case ValueSchema.Number: {
 			return typeof nodeValue === "number";
-		case ValueSchema.Boolean:
+		}
+		case ValueSchema.Boolean: {
 			return typeof nodeValue === "boolean";
-		case ValueSchema.FluidHandle:
+		}
+		case ValueSchema.FluidHandle: {
 			return isFluidHandle(nodeValue);
-		case ValueSchema.Null:
+		}
+		case ValueSchema.Null: {
 			return nodeValue === null;
-		default:
+		}
+		default: {
 			unreachableCase(schema);
+		}
 	}
 }
 
@@ -67,9 +73,11 @@ export function isTreeValue(nodeValue: unknown): nodeValue is TreeValue {
 	switch (typeof nodeValue) {
 		case "string":
 		case "number":
-		case "boolean":
+		case "boolean": {
 			return true;
-		default:
+		}
+		default: {
 			return nodeValue === null || isFluidHandle(nodeValue);
+		}
 	}
 }

package/src/index.ts

@@ -249,7 +249,9 @@ export {
 	type SchemaStatics,
 	type ITreeAlpha,
 	type TransactionConstraint,
+	type TransactionConstraintAlpha,
 	type NodeInDocumentConstraint,
+	type NoChangeConstraint,
 	type RunTransactionParams,
 	type VoidTransactionCallbackStatus,
 	type TransactionCallbackStatus,
@@ -311,6 +313,8 @@ export {
 	FluidClientVersion,
 	type FormatValidator,
 	FormatValidatorNoOp,
+	type CodecName,
+	type FormatVersion,
 } from "./codec/index.js";
 export { FormatValidatorBasic } from "./external-utilities/index.js";
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tree";
-export const pkgVersion = "2.74.0";
+export const pkgVersion = "2.80.0";

package/src/shared-tree/schematizingTreeView.ts

@@ -50,7 +50,7 @@ import {
 	type TransactionResult,
 	type TransactionResultExt,
 	type RunTransactionParams,
-	type TransactionConstraint,
+	type TransactionConstraintAlpha,
 	HydratedContext,
 	SimpleContextSlot,
 	areImplicitFieldSchemaEqual,
@@ -61,6 +61,7 @@ import {
 	TreeViewConfigurationAlpha,
 	toInitialSchema,
 	toUpgradeSchema,
+	type TreeBranchAlpha,
 } from "../simple-tree/index.js";
 import {
 	type Breakable,
@@ -72,7 +73,6 @@ import {
 
 import { canInitialize, initialize, initializerFromChunk } from "./schematizeTree.js";
 import type { ITreeCheckout, TreeCheckout } from "./treeCheckout.js";
-import type { TreeBranchAlpha } from "../simple-tree/index.js";
 
 /**
  * Creating multiple tree views from the same checkout is not supported. This slot is used to detect if one already
@@ -296,7 +296,7 @@ export class SchematizingSimpleTreeView<
 	): TransactionResultExt<TSuccessValue, TFailureValue> | TransactionResult {
 		const addConstraints = (
 			constraintsOnRevert: boolean,
-			constraints: readonly TransactionConstraint[] = [],
+			constraints: readonly TransactionConstraintAlpha[] = [],
 		): void => {
 			addConstraintsToTransaction(this.checkout, constraintsOnRevert, constraints);
 		};
@@ -313,9 +313,9 @@ export class SchematizingSimpleTreeView<
 
 		if (rollback === true) {
 			this.checkout.transaction.abort();
-			return value !== undefined
-				? { success: false, value: value as TFailureValue }
-				: { success: false };
+			return value === undefined
+				? { success: false }
+				: { success: false, value: value as TFailureValue };
 		}
 
 		// Validate preconditions on revert after running the transaction callback and was successful.
@@ -325,9 +325,9 @@ export class SchematizingSimpleTreeView<
 		);
 
 		this.checkout.transaction.commit();
-		return value !== undefined
-			? { success: true, value: value as TSuccessValue }
-			: { success: true };
+		return value === undefined
+			? { success: true }
+			: { success: true, value: value as TSuccessValue };
 	}
 
 	private ensureUndisposed(): void {
@@ -559,10 +559,11 @@ export function getCheckout(context: TreeBranch): TreeCheckout {
 export function addConstraintsToTransaction(
 	checkout: ITreeCheckout,
 	constraintsOnRevert: boolean,
-	constraints: readonly TransactionConstraint[] = [],
+	constraints: readonly TransactionConstraintAlpha[] = [],
 ): void {
 	for (const constraint of constraints) {
-		switch (constraint.type) {
+		const constraintType = constraint.type;
+		switch (constraintType) {
 			case "nodeInDocument": {
 				const node = getInnerNode(constraint.node);
 				const nodeStatus = getKernel(constraint.node).getStatus();
@@ -580,8 +581,17 @@ export function addConstraintsToTransaction(
 				}
 				break;
 			}
-			default:
-				unreachableCase(constraint.type);
+			case "noChange": {
+				if (constraintsOnRevert) {
+					checkout.editor.addNoChangeConstraintOnRevert();
+				} else {
+					checkout.editor.addNoChangeConstraint();
+				}
+				break;
+			}
+			default: {
+				unreachableCase(constraintType);
+			}
 		}
 	}
 }

package/src/shared-tree/sharedTree.ts

@@ -41,7 +41,7 @@ import {
 	TreeStoredSchemaRepository,
 	type TreeStoredSchemaSubscription,
 	type TreeTypeSet,
-	getCodecTreeForDetachedFieldIndexFormat,
+	detachedFieldIndexCodecBuilder,
 	makeDetachedFieldIndex,
 	moveToDetachedField,
 } from "../core/index.js";
@@ -57,7 +57,6 @@ import {
 	defaultSchemaPolicy,
 	getCodecTreeForFieldBatchFormat,
 	getCodecTreeForForestFormat,
-	getCodecTreeForSchemaFormat,
 	jsonableTreeFromFieldCursor,
 	makeFieldBatchCodec,
 	makeMitigatedChangeFamily,
@@ -66,7 +65,7 @@ import {
 	type IncrementalEncodingPolicy,
 } from "../feature-libraries/index.js";
 // eslint-disable-next-line import-x/no-internal-modules
-import type { FormatV1 } from "../feature-libraries/schema-index/index.js";
+import { schemaCodecBuilder, type FormatV1 } from "../feature-libraries/schema-index/index.js";
 import {
 	type BranchId,
 	clientVersionToEditManagerFormatVersion,
@@ -366,10 +365,12 @@ export class SharedTreeKernel
 			}
 		});
 		checkout.events.on("beforeBatch", (event) => {
-			if (event.type === "append" && this.sharedObject.isAttached()) {
-				if (checkout.transaction.isInProgress()) {
-					enricher.addTransactionCommits(event.newCommits);
-				}
+			if (
+				event.type === "append" &&
+				this.sharedObject.isAttached() &&
+				checkout.transaction.isInProgress()
+			) {
+				enricher.addTransactionCommits(event.newCommits);
 			}
 		});
 	}
@@ -599,6 +600,10 @@ export const changeFormatVersionForEditManager = DependentFormatVersion.fromPair
 		brand<EditManagerFormatVersion>(EditManagerFormatVersion.vSharedBranches),
 		brand<SharedTreeChangeFormatVersion>(4),
 	],
+	[
+		brand<EditManagerFormatVersion>(EditManagerFormatVersion.v6),
+		brand<SharedTreeChangeFormatVersion>(5),
+	],
 ]);
 
 /**
@@ -620,6 +625,10 @@ export const changeFormatVersionForMessage = DependentFormatVersion.fromPairs([
 		brand<MessageFormatVersion>(MessageFormatVersion.vSharedBranches),
 		brand<SharedTreeChangeFormatVersion>(4),
 	],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.v6),
+		brand<SharedTreeChangeFormatVersion>(5),
+	],
 ]);
 
 function getCodecTreeForEditManagerFormat(clientVersion: MinimumVersionForCollab): CodecTree {
@@ -643,8 +652,8 @@ export function getCodecTreeForSharedTreeFormat(
 ): CodecTree {
 	const children: CodecTree[] = [];
 	children.push(getCodecTreeForForestFormat(clientVersion));
-	children.push(getCodecTreeForSchemaFormat(clientVersion));
-	children.push(getCodecTreeForDetachedFieldIndexFormat(clientVersion));
+	children.push(schemaCodecBuilder.getCodecTree(clientVersion));
+	children.push(detachedFieldIndexCodecBuilder.getCodecTree(clientVersion));
 	children.push(getCodecTreeForEditManagerFormat(clientVersion));
 	children.push(getCodecTreeForMessageFormat(clientVersion));
 	children.push(getCodecTreeForFieldBatchFormat(clientVersion));
@@ -815,6 +824,8 @@ export const defaultSharedTreeOptions: Required<SharedTreeOptionsInternal> = {
 	editManagerFormatSelector: clientVersionToEditManagerFormatVersion,
 	messageFormatSelector: clientVersionToMessageFormatVersion,
 	enableSharedBranches: false,
+	writeVersionOverrides: new Map(),
+	allowPossiblyIncompatibleWriteVersionOverrides: false,
 };
 
 /**
@@ -840,21 +851,26 @@ function exportSimpleFieldSchemaStored(
 ): SimpleFieldSchema<SchemaType.Stored> {
 	let kind: FieldKind;
 	switch (schema.kind) {
-		case FieldKinds.identifier.identifier:
+		case FieldKinds.identifier.identifier: {
 			kind = FieldKind.Identifier;
 			break;
-		case FieldKinds.optional.identifier:
+		}
+		case FieldKinds.optional.identifier: {
 			kind = FieldKind.Optional;
 			break;
-		case FieldKinds.required.identifier:
+		}
+		case FieldKinds.required.identifier: {
 			kind = FieldKind.Required;
 			break;
-		case FieldKinds.forbidden.identifier:
+		}
+		case FieldKinds.forbidden.identifier: {
 			kind = FieldKind.Optional;
 			assert(schema.types.size === 0, 0xa94 /* invalid forbidden field */);
 			break;
-		default:
+		}
+		default: {
 			fail(0xaca /* invalid field kind */);
+		}
 	}
 	return {
 		kind,

package/src/shared-tree/sharedTreeChangeCodecs.ts

@@ -56,7 +56,7 @@ export function makeSharedTreeChangeCodecFamily(
 			EncodedSharedTreeChange,
 			ChangeEncodingContext
 		>,
-	][] = Array.from(dependenciesForChangeFormat.entries()).map(
+	][] = [...dependenciesForChangeFormat.entries()].map(
 		([format, { modularChange, schemaChange }]) => [
 			format,
 			makeSharedTreeChangeCodec(
@@ -74,7 +74,7 @@ interface ChangeFormatDependencies {
 	readonly schemaChange: SchemaFormatVersion;
 }
 
-export type SharedTreeChangeFormatVersion = Brand<3 | 4, "SharedTreeChangeFormatVersion">;
+export type SharedTreeChangeFormatVersion = Brand<3 | 4 | 5, "SharedTreeChangeFormatVersion">;
 
 /**
  * Defines for each SharedTree change format the corresponding dependent formats to use.
@@ -88,6 +88,7 @@ export const dependenciesForChangeFormat: Map<
 > = new Map([
 	[brand(3), { modularChange: brand(3), schemaChange: SchemaFormatVersion.v1 }],
 	[brand(4), { modularChange: brand(4), schemaChange: SchemaFormatVersion.v1 }],
+	[brand(5), { modularChange: brand(5), schemaChange: SchemaFormatVersion.v1 }],
 ]);
 
 export function getCodecTreeForChangeFormat(
@@ -149,15 +150,15 @@ function makeSharedTreeChangeCodec(
 				for (const decodedChange of change.changes) {
 					if (decodedChange.type === "data") {
 						const schemaAndPolicy =
-							updatedSchema !== undefined
-								? {
+							updatedSchema === undefined
+								? context.schema
+								: {
 										policy:
-											context.schema !== undefined
-												? context.schema.policy
-												: defaultSchemaPolicy,
+											context.schema === undefined
+												? defaultSchemaPolicy
+												: context.schema.policy,
 										schema: updatedSchema,
-									}
-								: context.schema;
+									};
 						changes.push({
 							data: modularChangeCodec.encode(decodedChange.innerChange, {
 								originatorId: context.originatorId,

package/src/shared-tree/sharedTreeChangeEnricher.ts

@@ -116,14 +116,16 @@ export class SharedTreeMutableChangeEnricher
 					visitor.free();
 					break;
 				}
-				case "schema":
+				case "schema": {
 					// This enricher doesn't need to maintain schema information.
 					// Note that the refreshers being generated through `updateChangeEnrichments` will be encoded using
 					// the schema that was used in the input context of the data changeset these refreshers are on.
 					// See the encoding logic in SharedTreeCore for details.
 					break;
-				default:
+				}
+				default: {
 					unreachableCase(type);
+				}
 			}
 		}
 	}

package/src/shared-tree/sharedTreeChangeFamily.ts

@@ -13,6 +13,7 @@ import {
 	type ChangeRebaser,
 	type DeltaDetachedNodeId,
 	type RevisionMetadataSource,
+	type RevisionReplacer,
 	type RevisionTag,
 	type RevisionTagCodec,
 	type TaggedChange,
@@ -71,7 +72,11 @@ export class SharedTreeChangeFamily
 			codecOptions,
 			chunkCompressionStrategy,
 		);
-		this.modularChangeFamily = new ModularChangeFamily(fieldKinds, modularChangeCodec);
+		this.modularChangeFamily = new ModularChangeFamily(
+			fieldKinds,
+			modularChangeCodec,
+			codecOptions,
+		);
 		this.codecs = makeSharedTreeChangeCodecFamily(
 			this.modularChangeFamily.codecs,
 			codecOptions,
@@ -127,7 +132,7 @@ export class SharedTreeChangeFamily
 			innerChange: SharedTreeChange["changes"][number],
 		) => SharedTreeChange["changes"][number] = (innerChange) => {
 			switch (innerChange.type) {
-				case "data":
+				case "data": {
 					return {
 						type: "data",
 						innerChange: this.modularChangeFamily.invert(
@@ -136,6 +141,7 @@ export class SharedTreeChangeFamily
 							revision,
 						),
 					};
+				}
 				case "schema": {
 					return {
 						type: "schema",
@@ -148,8 +154,9 @@ export class SharedTreeChangeFamily
 						},
 					};
 				}
-				default:
+				default: {
 					fail(0xacc /* Unknown SharedTree change type. */);
+				}
 			}
 		};
 		return {
@@ -203,25 +210,28 @@ export class SharedTreeChangeFamily
 		};
 	}
 
+	public getRevisions(change: SharedTreeChange): Set<RevisionTag | undefined> {
+		const aggregated: Set<RevisionTag | undefined> = new Set();
+		for (const innerChange of change.changes) {
+			if (innerChange.type === "data") {
+				const innerRevisions = this.modularChangeFamily.rebaser.getRevisions(
+					innerChange.innerChange,
+				);
+				for (const tag of innerRevisions) {
+					aggregated.add(tag);
+				}
+			}
+		}
+		return aggregated;
+	}
+
 	public changeRevision(
 		change: SharedTreeChange,
-		newRevision: RevisionTag | undefined,
-		rollbackOf?: RevisionTag,
+		replacer: RevisionReplacer,
 	): SharedTreeChange {
-		return {
-			changes: change.changes.map((inner) => {
-				return inner.type === "data"
-					? {
-							...inner,
-							innerChange: this.modularChangeFamily.rebaser.changeRevision(
-								inner.innerChange,
-								newRevision,
-								rollbackOf,
-							),
-						}
-					: inner;
-			}),
-		};
+		return mapDataChanges(change, (inner) =>
+			this.modularChangeFamily.rebaser.changeRevision(inner, replacer),
+		);
 	}
 
 	public get rebaser(): ChangeRebaser<SharedTreeChange> {

package/src/shared-tree/sharedTreeEditBuilder.ts

@@ -55,11 +55,15 @@ export class SharedTreeEditBuilder
 		mintRevisionTag: () => RevisionTag,
 		private readonly changeReceiver: (change: TaggedChange<SharedTreeChange>) => void,
 	) {
-		super(modularChangeFamily, mintRevisionTag, (taggedChange) =>
-			changeReceiver({
-				...taggedChange,
-				change: { changes: [{ type: "data", innerChange: taggedChange.change }] },
-			}),
+		super(
+			modularChangeFamily,
+			mintRevisionTag,
+			(taggedChange) =>
+				changeReceiver({
+					...taggedChange,
+					change: { changes: [{ type: "data", innerChange: taggedChange.change }] },
+				}),
+			modularChangeFamily.codecOptions,
 		);
 
 		this.schema = {