@fluidframework/tree 2.70.0 → 2.72.0

package/src/shared-tree/sharedTree.ts

@@ -4,9 +4,10 @@
  */
 
 import type { ErasedType, IFluidLoadable } from "@fluidframework/core-interfaces/internal";
-import { assert, fail, unreachableCase } from "@fluidframework/core-utils/internal";
+import { assert, fail } from "@fluidframework/core-utils/internal";
 import type { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
 import type { IIdCompressor, StableId } from "@fluidframework/id-compressor";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 import type {
 	IChannelView,
 	IFluidSerializer,
@@ -26,7 +27,6 @@ import {
 	type ICodecOptions,
 } from "../codec/index.js";
 import {
-	type DetachedFieldIndexFormatVersion,
 	type FieldKey,
 	type GraphCommit,
 	type IEditableForest,
@@ -35,13 +35,12 @@ import {
 	MapNodeStoredSchema,
 	ObjectNodeStoredSchema,
 	RevisionTagCodec,
-	type SchemaFormatVersion,
-	SchemaVersion,
 	type TreeFieldStoredSchema,
 	type TreeNodeStoredSchema,
 	type TreeStoredSchema,
 	TreeStoredSchemaRepository,
 	type TreeStoredSchemaSubscription,
+	type TreeTypeSet,
 	getCodecTreeForDetachedFieldIndexFormat,
 	makeDetachedFieldIndex,
 	moveToDetachedField,
@@ -65,21 +64,21 @@ import {
 	makeSchemaCodec,
 	makeTreeChunker,
 	type IncrementalEncodingPolicy,
-	type FieldBatchFormatVersion,
-	type ForestFormatVersion,
 	type TreeCompressionStrategyPrivate,
 } from "../feature-libraries/index.js";
-// eslint-disable-next-line import/no-internal-modules
+// eslint-disable-next-line import-x/no-internal-modules
 import type { FormatV1 } from "../feature-libraries/schema-index/index.js";
 import {
 	type BranchId,
+	clientVersionToEditManagerFormatVersion,
+	clientVersionToMessageFormatVersion,
 	type ClonableSchemaAndPolicy,
-	type EditManagerFormatVersion,
-	type ExplicitCoreCodecVersions,
 	getCodecTreeForEditManagerFormatWithChange,
 	getCodecTreeForMessageFormatWithChange,
-	type MessageFormatVersion,
+	type SharedTreCoreOptionsInternal,
+	MessageFormatVersion,
 	SharedTreeCore,
+	EditManagerFormatVersion,
 } from "../shared-tree-core/index.js";
 import {
 	type ITree,
@@ -98,6 +97,7 @@ import {
 	FieldKind,
 	type ITreeAlpha,
 	type SimpleObjectFieldSchema,
+	type SimpleAllowedTypeAttributes,
 } from "../simple-tree/index.js";
 
 import { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
@@ -170,98 +170,6 @@ export interface ITreePrivate extends ITreeInternal {
 	readonly kernel: SharedTreeKernel;
 }
 
-/**
- * Has an entry for each codec which writes an explicit version into its data.
- *
- * This is used to map the single API entrypoint controlling the format {@link SharedTreeOptions.formatVersion}
- * to a list of write versions that for each codec that should be used for that format.
- *
- * Note that all explicitly versioned codecs should be using the format version from the data to read encoded data.
- *
- * TODO: Plumb these write versions into forest, schema, detached field index codec creation.
- */
-interface ExplicitCodecVersions extends ExplicitCoreCodecVersions {
-	forest: ForestFormatVersion;
-	schema: SchemaFormatVersion;
-	detachedFieldIndex: DetachedFieldIndexFormatVersion;
-	fieldBatch: FieldBatchFormatVersion;
-}
-
-const formatVersionToTopLevelCodecVersions = new Map<number, ExplicitCodecVersions>([
-	[
-		1,
-		{
-			forest: brand(1),
-			schema: brand(1),
-			detachedFieldIndex: brand(1),
-			editManager: brand(1),
-			message: brand(1),
-			fieldBatch: brand(1),
-		},
-	],
-	[
-		2,
-		{
-			forest: brand(1),
-			schema: brand(1),
-			detachedFieldIndex: brand(1),
-			editManager: brand(2),
-			message: brand(2),
-			fieldBatch: brand(1),
-		},
-	],
-	[
-		3,
-		{
-			forest: brand(1),
-			schema: brand(1),
-			detachedFieldIndex: brand(1),
-			editManager: brand(3),
-			message: brand(3),
-			fieldBatch: brand(1),
-		},
-	],
-	[
-		4,
-		{
-			forest: brand(1),
-			schema: brand(1),
-			detachedFieldIndex: brand(1),
-			editManager: brand(4),
-			message: brand(4),
-			fieldBatch: brand(1),
-		},
-	],
-	[
-		5,
-		{
-			forest: brand(1),
-			schema: brand(2),
-			detachedFieldIndex: brand(1),
-			editManager: brand(4),
-			message: brand(4),
-			fieldBatch: brand(1),
-		},
-	],
-	[
-		100, // SharedTreeFormatVersion.vSharedBranches
-		{
-			forest: brand(1),
-			schema: brand(2),
-			detachedFieldIndex: brand(1),
-			editManager: brand(5),
-			message: brand(5),
-			fieldBatch: brand(1),
-		},
-	],
-]);
-
-function getCodecVersions(formatVersion: number): ExplicitCodecVersions {
-	const versions = formatVersionToTopLevelCodecVersions.get(formatVersion);
-	assert(versions !== undefined, 0x90e /* Unknown format version */);
-	return versions;
-}
-
 /**
  * The type SharedTree's kernel's view must implement so what when its merged with the underling SharedObject's API it fully implements the required tree API surface ({@link ITreePrivate }).
  */
@@ -304,8 +212,13 @@ export class SharedTreeKernel
 		idCompressor: IIdCompressor,
 		optionsParam: SharedTreeOptionsInternal,
 	) {
-		const options = { ...defaultSharedTreeOptions, ...optionsParam };
-		const codecVersions = getCodecVersions(options.formatVersion);
+		const options: Required<SharedTreeOptionsInternal> = {
+			...defaultSharedTreeOptions,
+			...optionsParam,
+		};
+		if (options.minVersionForCollab < FluidClientVersion.v2_0) {
+			throw new UsageError("SharedTree requires minVersionForCollab of at least 2.0.0");
+		}
 		const schema = new TreeStoredSchemaRepository();
 		const forest = buildConfiguredForest(
 			breaker,
@@ -321,7 +234,7 @@ export class SharedTreeKernel
 			idCompressor,
 			options,
 		);
-		const schemaCodec = makeSchemaCodec(options, codecVersions.schema);
+		const schemaCodec = makeSchemaCodec(options);
 		const schemaSummarizer = new SchemaSummarizer(
 			schema,
 			{
@@ -329,7 +242,7 @@ export class SharedTreeKernel
 			},
 			schemaCodec,
 		);
-		const fieldBatchCodec = makeFieldBatchCodec(options, codecVersions.fieldBatch);
+		const fieldBatchCodec = makeFieldBatchCodec(options);
 
 		const encoderContext = {
 			schema: {
@@ -390,7 +303,6 @@ export class SharedTreeKernel
 			[schemaSummarizer, forestSummarizer, removedRootsSummarizer],
 			changeFamily,
 			options,
-			codecVersions,
 			changeFormatVersionForEditManager,
 			changeFormatVersionForMessage,
 			idCompressor,
@@ -619,7 +531,12 @@ export function persistedToSimpleSchema(
 	persisted: JsonCompatible,
 	options: ICodecOptions,
 ): SimpleTreeSchema {
-	const schemaCodec = makeSchemaCodec(options, SchemaVersion.v1);
+	// Any version can be passed down to makeSchemaCodec here.
+	// We only use the decode part, which always dispatches to the correct codec based on the version in the data, not the version passed to `makeSchemaCodec`.
+	const schemaCodec = makeSchemaCodec({
+		...options,
+		minVersionForCollab: FluidClientVersion.v2_0,
+	});
 	const stored = schemaCodec.decode(persisted as FormatV1);
 	return exportSimpleSchema(stored);
 }
@@ -714,11 +631,26 @@ export type SharedTreeFormatVersion = typeof SharedTreeFormatVersion;
  * This is because the format for SharedTree changes are not explicitly versioned.
  */
 export const changeFormatVersionForEditManager = DependentFormatVersion.fromPairs([
-	[brand<EditManagerFormatVersion>(1), brand<SharedTreeChangeFormatVersion>(1)],
-	[brand<EditManagerFormatVersion>(2), brand<SharedTreeChangeFormatVersion>(2)],
-	[brand<EditManagerFormatVersion>(3), brand<SharedTreeChangeFormatVersion>(3)],
-	[brand<EditManagerFormatVersion>(4), brand<SharedTreeChangeFormatVersion>(4)],
-	[brand<EditManagerFormatVersion>(5), brand<SharedTreeChangeFormatVersion>(4)],
+	[
+		brand<EditManagerFormatVersion>(EditManagerFormatVersion.v1),
+		brand<SharedTreeChangeFormatVersion>(1),
+	],
+	[
+		brand<EditManagerFormatVersion>(EditManagerFormatVersion.v2),
+		brand<SharedTreeChangeFormatVersion>(2),
+	],
+	[
+		brand<EditManagerFormatVersion>(EditManagerFormatVersion.v3),
+		brand<SharedTreeChangeFormatVersion>(3),
+	],
+	[
+		brand<EditManagerFormatVersion>(EditManagerFormatVersion.v4),
+		brand<SharedTreeChangeFormatVersion>(4),
+	],
+	[
+		brand<EditManagerFormatVersion>(EditManagerFormatVersion.v5),
+		brand<SharedTreeChangeFormatVersion>(4),
+	],
 ]);
 
 /**
@@ -728,58 +660,61 @@ export const changeFormatVersionForEditManager = DependentFormatVersion.fromPair
  * This is because the format for SharedTree changes are not explicitly versioned.
  */
 export const changeFormatVersionForMessage = DependentFormatVersion.fromPairs([
-	[brand<MessageFormatVersion>(undefined), brand<SharedTreeChangeFormatVersion>(1)],
-	[brand<MessageFormatVersion>(1), brand<SharedTreeChangeFormatVersion>(1)],
-	[brand<MessageFormatVersion>(2), brand<SharedTreeChangeFormatVersion>(2)],
-	[brand<MessageFormatVersion>(3), brand<SharedTreeChangeFormatVersion>(3)],
-	[brand<MessageFormatVersion>(4), brand<SharedTreeChangeFormatVersion>(4)],
-	[brand<MessageFormatVersion>(5), brand<SharedTreeChangeFormatVersion>(4)],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.undefined),
+		brand<SharedTreeChangeFormatVersion>(1),
+	],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.v1),
+		brand<SharedTreeChangeFormatVersion>(1),
+	],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.v2),
+		brand<SharedTreeChangeFormatVersion>(2),
+	],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.v3),
+		brand<SharedTreeChangeFormatVersion>(3),
+	],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.v4),
+		brand<SharedTreeChangeFormatVersion>(4),
+	],
+	[
+		brand<MessageFormatVersion>(MessageFormatVersion.v5),
+		brand<SharedTreeChangeFormatVersion>(4),
+	],
 ]);
 
-function getCodecTreeForEditManagerFormat(version: EditManagerFormatVersion): CodecTree {
-	const change = changeFormatVersionForEditManager.lookup(version);
-	const changeCodecTree = getCodecTreeForChangeFormat(change);
-	return getCodecTreeForEditManagerFormatWithChange(version, changeCodecTree);
+function getCodecTreeForEditManagerFormat(clientVersion: MinimumVersionForCollab): CodecTree {
+	const change = changeFormatVersionForEditManager.lookup(
+		clientVersionToEditManagerFormatVersion(clientVersion),
+	);
+	const changeCodecTree = getCodecTreeForChangeFormat(change, clientVersion);
+	return getCodecTreeForEditManagerFormatWithChange(clientVersion, changeCodecTree);
 }
 
-function getCodecTreeForMessageFormat(version: MessageFormatVersion): CodecTree {
-	const change = changeFormatVersionForMessage.lookup(version);
-	const changeCodecTree = getCodecTreeForChangeFormat(change);
-	return getCodecTreeForMessageFormatWithChange(version, changeCodecTree);
+function getCodecTreeForMessageFormat(clientVersion: MinimumVersionForCollab): CodecTree {
+	const change = changeFormatVersionForMessage.lookup(
+		clientVersionToMessageFormatVersion(clientVersion),
+	);
+	const changeCodecTree = getCodecTreeForChangeFormat(change, clientVersion);
+	return getCodecTreeForMessageFormatWithChange(clientVersion, changeCodecTree);
 }
 
 export function getCodecTreeForSharedTreeFormat(
-	version: SharedTreeFormatVersion[keyof SharedTreeFormatVersion],
+	clientVersion: MinimumVersionForCollab,
 ): CodecTree {
 	const children: CodecTree[] = [];
-	const childCodecs = getCodecVersions(version);
-	for (const name of Object.keys(childCodecs) as (keyof ExplicitCodecVersions)[]) {
-		switch (name) {
-			case "editManager":
-				children.push(getCodecTreeForEditManagerFormat(childCodecs.editManager));
-				break;
-			case "message":
-				children.push(getCodecTreeForMessageFormat(childCodecs.message));
-				break;
-			case "forest":
-				children.push(getCodecTreeForForestFormat(childCodecs.forest));
-				break;
-			case "schema":
-				children.push(getCodecTreeForSchemaFormat(childCodecs.schema));
-				break;
-			case "detachedFieldIndex":
-				children.push(getCodecTreeForDetachedFieldIndexFormat(childCodecs.detachedFieldIndex));
-				break;
-			case "fieldBatch":
-				children.push(getCodecTreeForFieldBatchFormat(childCodecs.fieldBatch));
-				break;
-			default:
-				unreachableCase(name);
-		}
-	}
+	children.push(getCodecTreeForForestFormat(clientVersion));
+	children.push(getCodecTreeForSchemaFormat(clientVersion));
+	children.push(getCodecTreeForDetachedFieldIndexFormat(clientVersion));
+	children.push(getCodecTreeForEditManagerFormat(clientVersion));
+	children.push(getCodecTreeForMessageFormat(clientVersion));
+	children.push(getCodecTreeForFieldBatchFormat(clientVersion));
 	return {
 		name: "SharedTree",
-		version,
+		version: undefined, // SharedTree does not have a version of its own.
 		children,
 	};
 }
@@ -794,12 +729,21 @@ export type SharedTreeOptionsBeta = ForestOptions;
  * Configuration options for SharedTree.
  * @alpha @input
  */
-export type SharedTreeOptions = Partial<CodecWriteOptions> &
-	Partial<SharedTreeFormatOptions> &
-	SharedTreeOptionsBeta;
+export interface SharedTreeOptions
+	extends Partial<CodecWriteOptions>,
+		Partial<SharedTreeFormatOptions>,
+		SharedTreeOptionsBeta {
+	/**
+	 * Experimental feature flag to enable shared branches.
+	 * This feature is not yet complete and should not be used in production.
+	 * Defaults to false.
+	 */
+	readonly enableSharedBranches?: boolean;
+}
 
 export interface SharedTreeOptionsInternal
-	extends Omit<SharedTreeOptions, "treeEncodeType">,
+	extends Partial<SharedTreCoreOptionsInternal>,
+		Partial<ForestOptions>,
 		Partial<SharedTreeFormatOptionsInternal> {
 	disposeForksAfterTransaction?: boolean;
 	/**
@@ -809,6 +753,7 @@ export interface SharedTreeOptionsInternal
 	 */
 	shouldEncodeIncrementally?: IncrementalEncodingPolicy;
 }
+
 /**
  * Configuration options for SharedTree's internal tree storage.
  * @beta @input
@@ -830,18 +775,6 @@ export interface SharedTreeFormatOptions {
 	 * default: TreeCompressionStrategy.Compressed
 	 */
 	treeEncodeType: TreeCompressionStrategy;
-	/**
-	 * The format version SharedTree should use to persist documents.
-	 *
-	 * This option has compatibility implications for applications using SharedTree.
-	 * Each version documents a required minimum version of \@fluidframework/tree.
-	 * If this minimum version fails to be met, the SharedTree may fail to load.
-	 * To be safe, application authors should verify that they have saturated this version
-	 * of \@fluidframework/tree in their ecosystem before changing the format version.
-	 *
-	 * This option defaults to SharedTreeFormatVersion.v2.
-	 */
-	formatVersion: SharedTreeFormatVersion[keyof SharedTreeFormatVersion];
 }
 
 export interface SharedTreeFormatOptionsInternal
@@ -947,11 +880,30 @@ export const defaultSharedTreeOptions: Required<SharedTreeOptionsInternal> = {
 	minVersionForCollab: FluidClientVersion.v2_0,
 	forest: ForestTypeReference,
 	treeEncodeType: TreeCompressionStrategy.Compressed,
-	formatVersion: SharedTreeFormatVersion.v3,
 	disposeForksAfterTransaction: true,
 	shouldEncodeIncrementally: defaultIncrementalEncodingPolicy,
+	editManagerFormatSelector: clientVersionToEditManagerFormatVersion,
+	messageFormatSelector: clientVersionToMessageFormatVersion,
 };
 
+/**
+ * Build the allowed types for a Stored Schema.
+ *
+ * @remarks Staged upgrades do not apply to stored schemas, so we omit the {@link SimpleAllowedTypeAttributes.isStaged | staging flag } when building {@link SimpleAllowedTypeAttributes}.
+ * @param types - The types to create allowed types for.
+ * @returns The allowed types.
+ */
+function buildSimpleAllowedTypeAttributesForStoredSchema(
+	types: TreeTypeSet,
+): ReadonlyMap<string, SimpleAllowedTypeAttributes> {
+	const allowedTypesInfo = new Map<string, SimpleAllowedTypeAttributes>();
+	for (const type of types) {
+		// Stored schemas do not have staged upgrades
+		allowedTypesInfo.set(type, { isStaged: undefined });
+	}
+	return allowedTypesInfo;
+}
+
 function exportSimpleFieldSchemaStored(schema: TreeFieldStoredSchema): SimpleFieldSchema {
 	let kind: FieldKind;
 	switch (schema.kind) {
@@ -973,7 +925,7 @@ function exportSimpleFieldSchemaStored(schema: TreeFieldStoredSchema): SimpleFie
 	}
 	return {
 		kind,
-		allowedTypesIdentifiers: schema.types,
+		simpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(schema.types),
 		metadata: {},
 		persistedMetadata: schema.persistedMetadata,
 	};
@@ -983,13 +935,15 @@ function exportSimpleFieldSchemaStored(schema: TreeFieldStoredSchema): SimpleFie
  * Export a {@link SimpleNodeSchema} from a {@link TreeNodeStoredSchema}.
  * @privateRemarks
  * TODO: Persist node metadata once schema FormatV2 is supported.
+ * Note on SimpleNodeSchema construction: In the persisted format `persistedMetadata` is just called `metadata` whereas the `metadata`
+ * field on SimpleNodeSchema is not persisted.
  */
 function exportSimpleNodeSchemaStored(schema: TreeNodeStoredSchema): SimpleNodeSchema {
 	const arrayTypes = tryStoredSchemaAsArray(schema);
 	if (arrayTypes !== undefined) {
 		return {
 			kind: NodeKind.Array,
-			allowedTypesIdentifiers: arrayTypes,
+			simpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(arrayTypes),
 			metadata: {},
 			persistedMetadata: schema.metadata,
 		};
@@ -999,7 +953,13 @@ function exportSimpleNodeSchemaStored(schema: TreeNodeStoredSchema): SimpleNodeS
 		for (const [storedKey, field] of schema.objectNodeFields) {
 			fields.set(storedKey, { ...exportSimpleFieldSchemaStored(field), storedKey });
 		}
-		return { kind: NodeKind.Object, fields, metadata: {}, persistedMetadata: schema.metadata };
+		return {
+			kind: NodeKind.Object,
+			fields,
+			allowUnknownOptionalFields: undefined,
+			metadata: {},
+			persistedMetadata: schema.metadata,
+		};
 	}
 	if (schema instanceof MapNodeStoredSchema) {
 		assert(
@@ -1008,7 +968,9 @@ function exportSimpleNodeSchemaStored(schema: TreeNodeStoredSchema): SimpleNodeS
 		);
 		return {
 			kind: NodeKind.Map,
-			allowedTypesIdentifiers: schema.mapFields.types,
+			simpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(
+				schema.mapFields.types,
+			),
 			metadata: {},
 			persistedMetadata: schema.metadata,
 		};

package/src/shared-tree/sharedTreeChangeCodecs.ts

@@ -4,8 +4,10 @@
  */
 
 import { fail } from "@fluidframework/core-utils/internal";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 import {
 	type CodecTree,
+	type CodecWriteOptions,
 	DiscriminatedUnionDispatcher,
 	type FormatVersion,
 	type ICodecFamily,
@@ -14,12 +16,15 @@ import {
 	makeCodecFamily,
 	withSchemaValidation,
 } from "../codec/index.js";
-import type { ChangeEncodingContext, TreeStoredSchema } from "../core/index.js";
+import {
+	type ChangeEncodingContext,
+	SchemaFormatVersion,
+	type TreeStoredSchema,
+} from "../core/index.js";
 import {
 	type ModularChangeFormatVersion,
 	type ModularChangeset,
 	type SchemaChange,
-	type SchemaChangeFormatVersion,
 	defaultSchemaPolicy,
 	getCodecTreeForModularChangeFormat,
 	getCodecTreeForSchemaChangeFormat,
@@ -40,7 +45,7 @@ import type { SharedTreeChange, SharedTreeInnerChange } from "./sharedTreeChange
 
 export function makeSharedTreeChangeCodecFamily(
 	modularChangeCodecFamily: ICodecFamily<ModularChangeset, ChangeEncodingContext>,
-	options: ICodecOptions,
+	options: CodecWriteOptions,
 ): ICodecFamily<SharedTreeChange, ChangeEncodingContext> {
 	const schemaChangeCodecs = makeSchemaChangeCodecs(options);
 	const versions: [
@@ -66,7 +71,7 @@ export function makeSharedTreeChangeCodecFamily(
 
 interface ChangeFormatDependencies {
 	readonly modularChange: ModularChangeFormatVersion;
-	readonly schemaChange: SchemaChangeFormatVersion;
+	readonly schemaChange: SchemaFormatVersion;
 }
 
 export type SharedTreeChangeFormatVersion = Brand<
@@ -84,14 +89,15 @@ export const dependenciesForChangeFormat: Map<
 	SharedTreeChangeFormatVersion,
 	ChangeFormatDependencies
 > = new Map([
-	[brand(1), { modularChange: brand(1), schemaChange: brand(1) }],
-	[brand(2), { modularChange: brand(2), schemaChange: brand(1) }],
-	[brand(3), { modularChange: brand(3), schemaChange: brand(1) }],
-	[brand(4), { modularChange: brand(4), schemaChange: brand(1) }],
+	[brand(1), { modularChange: brand(1), schemaChange: brand(SchemaFormatVersion.v1) }],
+	[brand(2), { modularChange: brand(2), schemaChange: brand(SchemaFormatVersion.v1) }],
+	[brand(3), { modularChange: brand(3), schemaChange: brand(SchemaFormatVersion.v1) }],
+	[brand(4), { modularChange: brand(4), schemaChange: brand(SchemaFormatVersion.v1) }],
 ]);
 
 export function getCodecTreeForChangeFormat(
 	version: SharedTreeChangeFormatVersion,
+	clientVersion: MinimumVersionForCollab,
 ): CodecTree {
 	const { modularChange, schemaChange } =
 		dependenciesForChangeFormat.get(version) ?? fail(0xc78 /* Unknown change format */);
@@ -100,7 +106,7 @@ export function getCodecTreeForChangeFormat(
 		version,
 		children: [
 			getCodecTreeForModularChangeFormat(modularChange),
-			getCodecTreeForSchemaChangeFormat(schemaChange),
+			getCodecTreeForSchemaChangeFormat(schemaChange, clientVersion),
 		],
 	};
 }

package/src/shared-tree/sharedTreeChangeFamily.ts

@@ -6,7 +6,7 @@
 import { assert, fail } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
-import type { ICodecFamily, ICodecOptions } from "../codec/index.js";
+import type { CodecWriteOptions, ICodecFamily } from "../codec/index.js";
 import {
 	type ChangeEncodingContext,
 	type ChangeFamily,
@@ -60,7 +60,7 @@ export class SharedTreeChangeFamily
 	public constructor(
 		revisionTagCodec: RevisionTagCodec,
 		fieldBatchCodec: FieldBatchCodec,
-		codecOptions: ICodecOptions,
+		codecOptions: CodecWriteOptions,
 		chunkCompressionStrategy?: TreeCompressionStrategyPrivate,
 		private readonly idCompressor?: IIdCompressor,
 	) {

package/src/shared-tree/treeAlpha.ts

@@ -78,7 +78,6 @@ import {
 	TreeCompressionStrategy,
 	type FieldBatch,
 	type FieldBatchEncodingContext,
-	fluidVersionToFieldBatchCodecWriteVersion,
 	type LocalNodeIdentifier,
 	type FlexTreeSequenceField,
 	type FlexTreeNode,
@@ -291,7 +290,7 @@ export interface TreeAlpha {
 	 * @remarks
 	 * This currently does not support input containing
 	 * {@link ObjectSchemaOptions.allowUnknownOptionalFields| unknown optional fields} but does support
-	 * {@link SchemaStaticsAlpha.staged | staged} allowed types.
+	 * {@link SchemaStaticsBeta.staged | staged} allowed types.
 	 * Non-empty default values for fields are currently not supported (must be provided in the input).
 	 * The content will be validated against the schema and an error will be thrown if out of schema.
 	 */
@@ -845,8 +844,10 @@ export const TreeAlpha: TreeAlpha = {
 		options: { idCompressor?: IIdCompressor } & Pick<CodecWriteOptions, "minVersionForCollab">,
 	): JsonCompatible<IFluidHandle> {
 		const schema = tryGetSchema(node) ?? fail(0xacf /* invalid input */);
-		const format = fluidVersionToFieldBatchCodecWriteVersion(options.minVersionForCollab);
-		const codec = makeFieldBatchCodec({ jsonValidator: FormatValidatorNoOp }, format);
+		const codec = makeFieldBatchCodec({
+			jsonValidator: FormatValidatorNoOp,
+			minVersionForCollab: options.minVersionForCollab,
+		});
 		const cursor = borrowFieldCursorFromTreeNodeOrValue(node);
 		const batch: FieldBatch = [cursor];
 		// If none provided, create a compressor which will not compress anything.
@@ -873,7 +874,7 @@ export const TreeAlpha: TreeAlpha = {
 		compressedData: JsonCompatible<IFluidHandle>,
 		options: {
 			idCompressor?: IIdCompressor;
-		} & ICodecOptions,
+		} & CodecWriteOptions,
 	): Unhydrated<TreeFieldFromImplicitField<TSchema>> {
 		const config = new TreeViewConfigurationAlpha({ schema });
 		const content: ViewContent = {

package/src/shared-tree/treeCheckout.ts

@@ -300,13 +300,11 @@ export function createTreeCheckout(
 		jsonValidator: FormatValidatorNoOp,
 		minVersionForCollab: FluidClientVersion.v2_0,
 	};
-	const defaultFieldBatchVersion = 1;
 	const changeFamily =
 		args?.changeFamily ??
 		new SharedTreeChangeFamily(
 			revisionTagCodec,
-			args?.fieldBatchCodec ??
-				makeFieldBatchCodec(defaultCodecOptions, defaultFieldBatchVersion),
+			args?.fieldBatchCodec ?? makeFieldBatchCodec(defaultCodecOptions),
 			defaultCodecOptions,
 			args?.chunkCompressionStrategy,
 			idCompressor,