@fluidframework/tree 2.71.0 → 2.72.0

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

@@ -8,7 +8,7 @@ import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor";
 
 import {
 	type CodecTree,
-	type ICodecOptions,
+	type CodecWriteOptions,
 	type IJsonCodec,
 	makeVersionedValidatedCodec,
 } from "../../../codec/index.js";
@@ -19,6 +19,7 @@ import {
 	type TreeChunk,
 } from "../../../core/index.js";
 import {
+	brand,
 	brandedNumberType,
 	type Brand,
 	type JsonCompatibleReadOnly,
@@ -31,7 +32,7 @@ import {
 
 import { decode } from "./chunkDecoding.js";
 import type { FieldBatch } from "./fieldBatch.js";
-import { EncodedFieldBatch, validVersions, type FieldBatchFormatVersion } from "./format.js";
+import { EncodedFieldBatch, validVersions, FieldBatchFormatVersion } from "./format.js";
 import { schemaCompressedEncode } from "./schemaBasedEncode.js";
 import { uncompressedEncode } from "./uncompressedEncode.js";
 import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
@@ -123,17 +124,19 @@ export type FieldBatchCodec = IJsonCodec<
  * @privateRemarks
  * TODO: makeFieldBatchCodec (and makeVersionDispatchingCodec transitively) should bake in this versionToFormat logic and the resulting codec can then support use with FluidClientVersion directly.
  */
-export function fluidVersionToFieldBatchCodecWriteVersion(
-	minVersionForCollab: MinimumVersionForCollab,
-): number {
-	// There is currently on only 1 version.
-	return 1;
+/**
+ * Convert a MinimumVersionForCollab to write version for {@link FieldBatchCodec}.
+ * @param clientVersion - The MinimumVersionForCollab to convert.
+ */
+function clientVersionToFieldBatchVersion(
+	clientVersion: MinimumVersionForCollab,
+): FieldBatchFormatVersion {
+	// Currently, field batch codec only writes in version 1.
+	return brand(FieldBatchFormatVersion.v1);
 }
 
-export function makeFieldBatchCodec(
-	options: ICodecOptions,
-	writeVersion: number,
-): FieldBatchCodec {
+export function makeFieldBatchCodec(options: CodecWriteOptions): FieldBatchCodec {
+	const writeVersion = clientVersionToFieldBatchVersion(options.minVersionForCollab);
 	// Note: it's important that the decode function is schema-agnostic for this strategy/layering to work, since
 	// the schema that an op was encoded in doesn't necessarily match the current schema for the document (e.g. if
 	// decode is being run on a client that just submitted a schema change, but the op is from another client who has
@@ -198,6 +201,8 @@ export function makeFieldBatchCodec(
 	});
 }
 
-export function getCodecTreeForFieldBatchFormat(version: FieldBatchFormatVersion): CodecTree {
-	return { name: "FieldBatch", version };
+export function getCodecTreeForFieldBatchFormat(
+	clientVersion: MinimumVersionForCollab,
+): CodecTree {
+	return { name: "FieldBatch", version: clientVersionToFieldBatchVersion(clientVersion) };
 }

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

@@ -33,8 +33,8 @@ import {
 	type EncodedFieldBatch,
 	type EncodedNestedArrayShape,
 	type EncodedValueShape,
+	FieldBatchFormatVersion,
 	SpecialField,
-	version,
 } from "./format.js";
 import type { IncrementalEncoder } from "./codecs.js";
 
@@ -57,7 +57,7 @@ export function compressedEncode(
 		anyFieldEncoder.encodeField(cursor, context, buffer);
 		batchBuffer.push(buffer);
 	}
-	return updateShapesAndIdentifiersEncoding(version, batchBuffer);
+	return updateShapesAndIdentifiersEncoding(FieldBatchFormatVersion.v1, batchBuffer);
 }
 
 export type BufferFormat = BufferFormatGeneric<EncodedChunkShape>;

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

@@ -15,12 +15,20 @@ import {
 } from "./formatGeneric.js";
 import type { Brand } from "../../../util/index.js";
 
-export const version = 1;
-export type FieldBatchFormatVersion = Brand<1, "FieldBatchFormatVersion">;
+/**
+ * The format version for the field batch.
+ */
+export const FieldBatchFormatVersion = {
+	v1: 1,
+} as const;
+export type FieldBatchFormatVersion = Brand<
+	(typeof FieldBatchFormatVersion)[keyof typeof FieldBatchFormatVersion],
+	"FieldBatchFormatVersion"
+>;
 
 // Compatible versions used for format/version validation.
 // TODO: A proper version update policy will need to be documented.
-export const validVersions = new Set([version]);
+export const validVersions = new Set([FieldBatchFormatVersion.v1]);
 
 /**
  * Top level length is implied from length of data array.
@@ -209,5 +217,8 @@ export type EncodedNodeShape = Static<typeof EncodedNodeShape>;
 export type EncodedAnyShape = Static<typeof EncodedAnyShape>;
 export type EncodedIncrementalChunkShape = Static<typeof EncodedIncrementalChunkShape>;
 
-export const EncodedFieldBatch = EncodedFieldBatchGeneric(version, EncodedChunkShape);
+export const EncodedFieldBatch = EncodedFieldBatchGeneric(
+	FieldBatchFormatVersion.v1,
+	EncodedChunkShape,
+);
 export type EncodedFieldBatch = Static<typeof EncodedFieldBatch>;

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

@@ -3,13 +3,15 @@
  * Licensed under the MIT License.
  */
 
-export { EncodedFieldBatch, type FieldBatchFormatVersion } from "./format.js";
+export {
+	EncodedFieldBatch,
+	type FieldBatchFormatVersion,
+} from "./format.js";
 export type { FieldBatch } from "./fieldBatch.js";
 export {
 	type FieldBatchCodec,
 	makeFieldBatchCodec,
 	type FieldBatchEncodingContext,
-	fluidVersionToFieldBatchCodecWriteVersion,
 	type IncrementalEncoderDecoder,
 	type IncrementalEncoder,
 	type IncrementalDecoder,

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

@@ -12,10 +12,10 @@ import type { FluidSerializableReadOnly } from "../../valueUtilities.js";
 
 import type { FieldBatch } from "./fieldBatch.js";
 import {
+	FieldBatchFormatVersion,
 	type EncodedFieldBatch,
 	type EncodedNestedArrayShape,
 	type EncodedNodeShape,
-	version,
 } from "./format.js";
 import type { ShapeIndex } from "./formatGeneric.js";
 
@@ -30,7 +30,7 @@ import type { ShapeIndex } from "./formatGeneric.js";
 export function uncompressedEncode(batch: FieldBatch): EncodedFieldBatch {
 	const rootFields = batch.map(encodeSequence);
 	return {
-		version,
+		version: FieldBatchFormatVersion.v1,
 		identifiers: [],
 		// A single shape used to encode all fields.
 		shapes: [{ c: anyNodeShape }, { a: anyArray }],

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

@@ -23,7 +23,6 @@ export {
 	type FieldBatchCodec,
 	makeFieldBatchCodec,
 	type FieldBatchEncodingContext,
-	fluidVersionToFieldBatchCodecWriteVersion,
 	type IncrementalEncoderDecoder,
 	type ChunkReferenceId,
 	type IncrementalEncodingPolicy,

package/src/feature-libraries/default-schema/defaultFieldKinds.ts

@@ -107,8 +107,7 @@ export const required = new FieldKindWithEditor(
 		// Which direction is allowed is a subjective policy choice.
 		(other.kind === sequence.identifier ||
 			other.kind === requiredIdentifier ||
-			other.kind === optional.identifier ||
-			other.kind === nodeKey.identifier) &&
+			other.kind === optional.identifier) &&
 		allowsTreeSchemaIdentifierSuperset(types, other.types),
 	new Set(),
 );
@@ -129,28 +128,6 @@ export const sequence = new FieldKindWithEditor(
 	new Set([]),
 );
 
-const nodeKeyIdentifier = "NodeKey";
-
-/**
- * Exactly one identifier.
- *
- * TODO: this is almost the same as identifier, but apparently unused.
- * Confirm if this is truly unused since before the document format was stabilized, and remove if possible.
- * @deprecated Superseded by {@link identifier}.
- */
-export const nodeKey = new FieldKindWithEditor(
-	nodeKeyIdentifier,
-	Multiplicity.Single,
-	noChangeHandler,
-	(types, other) =>
-		(other.kind === sequence.identifier ||
-			other.kind === requiredIdentifier ||
-			other.kind === optional.identifier ||
-			other.kind === nodeKeyIdentifier) &&
-		allowsTreeSchemaIdentifierSuperset(types, other.types),
-	new Set(),
-);
-
 const identifierFieldIdentifier = "Identifier";
 
 /**
@@ -214,7 +191,6 @@ export const fieldKindConfigurations: ReadonlyMap<
 	[
 		brand(1),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
-			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 1 }],
 			[optional.identifier, { kind: optional, formatVersion: 1 }],
 			[sequence.identifier, { kind: sequence, formatVersion: 1 }],
@@ -225,7 +201,6 @@ export const fieldKindConfigurations: ReadonlyMap<
 	[
 		brand(2),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
-			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 2 }],
 			[optional.identifier, { kind: optional, formatVersion: 2 }],
 			[sequence.identifier, { kind: sequence, formatVersion: 1 }],
@@ -236,7 +211,6 @@ export const fieldKindConfigurations: ReadonlyMap<
 	[
 		brand(3),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
-			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 2 }],
 			[optional.identifier, { kind: optional, formatVersion: 2 }],
 			[sequence.identifier, { kind: sequence, formatVersion: 2 }],
@@ -247,7 +221,6 @@ export const fieldKindConfigurations: ReadonlyMap<
 	[
 		brand(4),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
-			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 2 }],
 			[optional.identifier, { kind: optional, formatVersion: 2 }],
 			[sequence.identifier, { kind: sequence, formatVersion: 3 }],
@@ -284,7 +257,7 @@ export function getCodecTreeForModularChangeFormat(
  * code which uses this should be audited for compatibility considerations.
  */
 export const fieldKinds: ReadonlyMap<FieldKindIdentifier, FieldKindWithEditor> = new Map(
-	[required, optional, sequence, nodeKey, identifier, forbidden].map((s) => [s.identifier, s]),
+	[required, optional, sequence, identifier, forbidden].map((s) => [s.identifier, s]),
 );
 
 // Create named Aliases for nicer intellisense.

package/src/feature-libraries/forest-summary/codec.ts

@@ -4,18 +4,19 @@
  */
 
 import { assert, oob } from "@fluidframework/core-utils/internal";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 import {
 	type CodecTree,
-	type ICodecOptions,
+	type CodecWriteOptions,
 	type IJsonCodec,
 	makeVersionedValidatedCodec,
 } from "../../codec/index.js";
 import type { FieldKey, ITreeCursorSynchronous } from "../../core/index.js";
 import type { FieldBatchCodec, FieldBatchEncodingContext } from "../chunked-forest/index.js";
 
-import { Format } from "./format.js";
-import type { Brand } from "../../util/index.js";
+import { Format, ForestFormatVersion } from "./format.js";
+import { brand } from "../../util/index.js";
 
 /**
  * Uses field cursors
@@ -23,15 +24,28 @@ import type { Brand } from "../../util/index.js";
 export type FieldSet = ReadonlyMap<FieldKey, ITreeCursorSynchronous>;
 export type ForestCodec = IJsonCodec<FieldSet, Format, Format, FieldBatchEncodingContext>;
 
+/**
+ * Convert a MinimumVersionForCollab to a ForestFormatVersion.
+ * @param clientVersion - The MinimumVersionForCollab to convert.
+ * @returns The ForestFormatVersion that corresponds to the provided MinimumVersionForCollab.
+ */
+function clientVersionToForestSummaryVersion(
+	clientVersion: MinimumVersionForCollab,
+): ForestFormatVersion {
+	// Currently, forest summary codec only writes in version 1.
+	return brand(ForestFormatVersion.v1);
+}
+
 export function makeForestSummarizerCodec(
-	options: ICodecOptions,
+	options: CodecWriteOptions,
 	fieldBatchCodec: FieldBatchCodec,
 ): ForestCodec {
 	const inner = fieldBatchCodec;
 	// TODO: AB#41865
 	// This needs to be updated to support multiple versions.
 	// The second version will be used to enable incremental summarization.
-	return makeVersionedValidatedCodec(options, new Set([1]), Format, {
+	const writeVersion = clientVersionToForestSummaryVersion(options.minVersionForCollab);
+	return makeVersionedValidatedCodec(options, new Set([ForestFormatVersion.v1]), Format, {
 		encode: (data: FieldSet, context: FieldBatchEncodingContext): Format => {
 			const keys: FieldKey[] = [];
 			const fields: ITreeCursorSynchronous[] = [];
@@ -39,7 +53,7 @@ export function makeForestSummarizerCodec(
 				keys.push(key);
 				fields.push(value);
 			}
-			return { keys, fields: inner.encode(fields, context), version: 1 };
+			return { keys, fields: inner.encode(fields, context), version: writeVersion };
 		},
 		decode: (data: Format, context: FieldBatchEncodingContext): FieldSet => {
 			const out: Map<FieldKey, ITreeCursorSynchronous> = new Map();
@@ -53,7 +67,8 @@ export function makeForestSummarizerCodec(
 	});
 }
 
-export type ForestFormatVersion = Brand<1, "ForestFormatVersion">;
-export function getCodecTreeForForestFormat(version: ForestFormatVersion): CodecTree {
-	return { name: "Forest", version };
+export function getCodecTreeForForestFormat(
+	clientVersion: MinimumVersionForCollab,
+): CodecTree {
+	return { name: "Forest", version: clientVersionToForestSummaryVersion(clientVersion) };
 }

package/src/feature-libraries/forest-summary/forestSummarizer.ts

@@ -33,7 +33,7 @@ import type {
 	SummaryElementStringifier,
 } from "../../shared-tree-core/index.js";
 import { idAllocatorFromMaxId, type JsonCompatible } from "../../util/index.js";
-// eslint-disable-next-line import/no-internal-modules
+// eslint-disable-next-line import-x/no-internal-modules
 import { chunkFieldSingle, defaultChunkPolicy } from "../chunked-forest/chunkTree.js";
 import {
 	defaultIncrementalEncodingPolicy,

package/src/feature-libraries/forest-summary/format.ts

@@ -7,12 +7,22 @@ import { type Static, Type } from "@sinclair/typebox";
 
 import { Versioned } from "../../codec/index.js";
 import { schemaFormatV1 } from "../../core/index.js";
+import type { Brand } from "../../util/index.js";
 
-export const version = 1.0;
+/**
+ * The format version for the forest.
+ */
+export const ForestFormatVersion = {
+	v1: 1,
+} as const;
+export type ForestFormatVersion = Brand<
+	(typeof ForestFormatVersion)[keyof typeof ForestFormatVersion],
+	"ForestFormatVersion"
+>;
 
 export const Format = Type.Object(
 	{
-		version: Type.Literal(version),
+		version: Type.Literal(ForestFormatVersion.v1),
 		keys: Type.Array(schemaFormatV1.FieldKeySchema),
 		fields: Versioned,
 	},

package/src/feature-libraries/forest-summary/index.ts

@@ -4,4 +4,5 @@
  */
 
 export { forestSummaryKey, ForestSummarizer } from "./forestSummarizer.js";
-export { getCodecTreeForForestFormat, type ForestFormatVersion } from "./codec.js";
+export { getCodecTreeForForestFormat } from "./codec.js";
+export { ForestFormatVersion } from "./format.js";

package/src/feature-libraries/index.ts

@@ -33,6 +33,7 @@ export {
 	makeSchemaCodec,
 	makeSchemaCodecs,
 	getCodecTreeForSchemaFormat,
+	clientVersionToSchemaVersion,
 } from "./schema-index/index.js";
 export {
 	stackTreeNodeCursor,
@@ -107,7 +108,6 @@ export {
 	getCodecTreeForFieldBatchFormat,
 	makeTreeChunker,
 	makeFieldBatchCodec,
-	fluidVersionToFieldBatchCodecWriteVersion,
 	type FieldBatchEncodingContext,
 	emptyChunk,
 	combineChunks,
@@ -203,7 +203,6 @@ export {
 	makeSchemaChangeCodecs,
 	EncodedSchemaChange,
 	getCodecTreeForSchemaChangeFormat,
-	type SchemaChangeFormatVersion,
 } from "./schema-edits/index.js";
 
 export { makeMitigatedChangeFamily } from "./mitigatedChangeFamily.js";

package/src/feature-libraries/schema-edits/index.ts

@@ -6,7 +6,6 @@
 export {
 	makeSchemaChangeCodecs,
 	getCodecTreeForSchemaChangeFormat,
-	type SchemaChangeFormatVersion,
 } from "./schemaChangeCodecs.js";
 export type { SchemaChange } from "./schemaChangeTypes.js";
 export { EncodedSchemaChange } from "./schemaChangeFormat.js";

package/src/feature-libraries/schema-edits/schemaChangeCodecs.ts

@@ -4,11 +4,12 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 import {
 	type CodecTree,
+	type CodecWriteOptions,
 	type ICodecFamily,
-	type ICodecOptions,
 	type IJsonCodec,
 	makeCodecFamily,
 	makeVersionDispatchingCodec,
@@ -18,32 +19,31 @@ import { getCodecTreeForSchemaFormat, makeSchemaCodec } from "../schema-index/in
 
 import { EncodedSchemaChange } from "./schemaChangeFormat.js";
 import type { SchemaChange } from "./schemaChangeTypes.js";
-import { SchemaVersion } from "../../core/index.js";
-import type { Brand } from "../../util/index.js";
+import { SchemaFormatVersion } from "../../core/index.js";
+import { brand } from "../../util/index.js";
 
 /**
  * Create a family of schema change codecs.
  * @param options - Specifies common codec options, including which `validator` to use.
  * @returns The composed codec family.
  */
-export function makeSchemaChangeCodecs(options: ICodecOptions): ICodecFamily<SchemaChange> {
+export function makeSchemaChangeCodecs(
+	options: CodecWriteOptions,
+): ICodecFamily<SchemaChange> {
 	return makeCodecFamily([
-		[SchemaVersion.v1, makeSchemaChangeCodecV1(options, SchemaVersion.v1)],
-		[SchemaVersion.v2, makeSchemaChangeCodecV1(options, SchemaVersion.v2)],
+		[SchemaFormatVersion.v1, makeSchemaChangeCodecV1(options, brand(SchemaFormatVersion.v1))],
+		[SchemaFormatVersion.v2, makeSchemaChangeCodecV1(options, brand(SchemaFormatVersion.v2))],
 	]);
 }
 
-export type SchemaChangeFormatVersion = Brand<
-	SchemaVersion.v1 | SchemaVersion.v2,
-	"SchemaChangeFormatVersion"
->;
 export function getCodecTreeForSchemaChangeFormat(
-	version: SchemaChangeFormatVersion,
+	version: SchemaFormatVersion,
+	clientVersion: MinimumVersionForCollab,
 ): CodecTree {
 	return {
 		name: "SchemaChange",
 		version,
-		children: [getCodecTreeForSchemaFormat(version)],
+		children: [getCodecTreeForSchemaFormat(clientVersion)],
 	};
 }
 
@@ -54,8 +54,8 @@ export function getCodecTreeForSchemaChangeFormat(
  * @returns The composed codec.
  */
 export function makeSchemaChangeCodec(
-	options: ICodecOptions,
-	writeVersion: SchemaVersion,
+	options: CodecWriteOptions,
+	writeVersion: SchemaFormatVersion,
 ): IJsonCodec<SchemaChange> {
 	const family = makeSchemaChangeCodecs(options);
 	return makeVersionDispatchingCodec(family, { ...options, writeVersion });
@@ -68,8 +68,8 @@ export function makeSchemaChangeCodec(
  * @returns The composed schema change codec.
  */
 function makeSchemaChangeCodecV1(
-	options: ICodecOptions,
-	schemaWriteVersion: SchemaVersion,
+	options: CodecWriteOptions,
+	schemaWriteVersion: SchemaFormatVersion,
 ): IJsonCodec<SchemaChange, EncodedSchemaChange> {
 	const schemaCodec = makeSchemaCodec(options, schemaWriteVersion);
 	const schemaChangeCodec: IJsonCodec<SchemaChange, EncodedSchemaChange> = {

package/src/feature-libraries/schema-index/codec.ts

@@ -7,6 +7,8 @@ import { fail, unreachableCase } from "@fluidframework/core-utils/internal";
 
 import {
 	type CodecTree,
+	type CodecWriteOptions,
+	FluidClientVersion,
 	type ICodecFamily,
 	type ICodecOptions,
 	type IJsonCodec,
@@ -15,7 +17,7 @@ import {
 	makeVersionedValidatedCodec,
 } from "../../codec/index.js";
 import {
-	SchemaVersion,
+	SchemaFormatVersion,
 	type TreeNodeSchemaIdentifier,
 	type TreeNodeStoredSchema,
 	type TreeStoredSchema,
@@ -31,35 +33,42 @@ import { Format as FormatV2 } from "./formatV2.js";
 import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 /**
- * Convert a MinimumVersionForCollab to a SchemaVersion.
+ * Convert a MinimumVersionForCollab to a SchemaFormatVersion.
  * @param clientVersion - The MinimumVersionForCollab to convert.
- * @returns The SchemaVersion that corresponds to the provided MinimumVersionForCollab.
+ * @returns The SchemaFormatVersion that corresponds to the provided MinimumVersionForCollab.
  */
 export function clientVersionToSchemaVersion(
 	clientVersion: MinimumVersionForCollab,
-): SchemaVersion {
-	// Only one version of the schema codec is currently supported.
-	return SchemaVersion.v1;
+): SchemaFormatVersion {
+	return clientVersion < FluidClientVersion.v2_43
+		? brand(SchemaFormatVersion.v1)
+		: brand(SchemaFormatVersion.v2);
 }
 
-export function getCodecTreeForSchemaFormat(version: SchemaVersion): CodecTree {
-	return { name: "Schema", version };
+export function getCodecTreeForSchemaFormat(
+	clientVersion: MinimumVersionForCollab,
+): CodecTree {
+	return { name: "Schema", version: clientVersionToSchemaVersion(clientVersion) };
 }
 
 /**
  * Create a schema codec.
- * @param options - Specifies common codec options, including which `validator` to use.
- * @param writeVersion - The schema write version.
+ * @param options - Specifies common codec options, including `minVersionForCollab` and which `validator` to use.
+ * @param writeVersionOverride - The schema version to write. If not provided, the version will be derived from `minVersionForCollab`.
  * @returns The composed codec.
  *
  * @privateRemarks We should consider using the Shared Tree format version instead as it may be more valuable for application authors than the schema version.
  */
 export function makeSchemaCodec(
-	options: ICodecOptions,
-	writeVersion: SchemaVersion,
+	options: CodecWriteOptions,
+	writeVersionOverride?: SchemaFormatVersion,
 ): IJsonCodec<TreeStoredSchema> {
 	const family = makeSchemaCodecs(options);
-	return makeVersionDispatchingCodec(family, { ...options, writeVersion });
+	return makeVersionDispatchingCodec(family, {
+		...options,
+		writeVersion:
+			writeVersionOverride ?? clientVersionToSchemaVersion(options.minVersionForCollab),
+	});
 }
 
 /**
@@ -69,8 +78,8 @@ export function makeSchemaCodec(
  */
 export function makeSchemaCodecs(options: ICodecOptions): ICodecFamily<TreeStoredSchema> {
 	return makeCodecFamily([
-		[SchemaVersion.v1, makeSchemaCodecV1(options)],
-		[SchemaVersion.v2, makeSchemaCodecV2(options)],
+		[SchemaFormatVersion.v1, makeSchemaCodecV1(options)],
+		[SchemaFormatVersion.v2, makeSchemaCodecV2(options)],
 	]);
 }
 
@@ -80,11 +89,14 @@ export function makeSchemaCodecs(options: ICodecOptions): ICodecFamily<TreeStore
  * @param version - The schema write version.
  * @returns The encoded schema.
  */
-export function encodeRepo(repo: TreeStoredSchema, version: SchemaVersion): JsonCompatible {
+export function encodeRepo(
+	repo: TreeStoredSchema,
+	version: SchemaFormatVersion,
+): JsonCompatible {
 	switch (version) {
-		case SchemaVersion.v1:
+		case SchemaFormatVersion.v1:
 			return encodeRepoV1(repo) as JsonCompatible;
-		case SchemaVersion.v2:
+		case SchemaFormatVersion.v2:
 			return encodeRepoV2(repo) as JsonCompatible;
 		default:
 			unreachableCase(version);
@@ -95,7 +107,7 @@ function encodeRepoV1(repo: TreeStoredSchema): FormatV1 {
 	const nodeSchema = encodeNodeSchema(repo, (schema) => schema.encodeV1());
 	const rootFieldSchema = encodeFieldSchemaV1(repo.rootFieldSchema);
 	return {
-		version: SchemaVersion.v1,
+		version: SchemaFormatVersion.v1,
 		nodes: nodeSchema,
 		root: rootFieldSchema,
 	};
@@ -105,7 +117,7 @@ function encodeRepoV2(repo: TreeStoredSchema): FormatV2 {
 	const nodeSchema = encodeNodeSchema(repo, (schema) => schema.encodeV2());
 	const rootFieldSchema = encodeFieldSchemaV2(repo.rootFieldSchema);
 	return {
-		version: SchemaVersion.v2,
+		version: SchemaFormatVersion.v2,
 		nodes: nodeSchema,
 		root: rootFieldSchema,
 	};
@@ -169,7 +181,7 @@ function decodeV2(f: FormatV2): TreeStoredSchema {
  * @returns The codec.
  */
 function makeSchemaCodecV1(options: ICodecOptions): IJsonCodec<TreeStoredSchema, FormatV1> {
-	return makeVersionedValidatedCodec(options, new Set([SchemaVersion.v1]), FormatV1, {
+	return makeVersionedValidatedCodec(options, new Set([SchemaFormatVersion.v1]), FormatV1, {
 		encode: (data: TreeStoredSchema) => encodeRepoV1(data),
 		decode: (data: FormatV1) => decodeV1(data),
 	});
@@ -181,7 +193,7 @@ function makeSchemaCodecV1(options: ICodecOptions): IJsonCodec<TreeStoredSchema,
  * @returns The codec.
  */
 function makeSchemaCodecV2(options: ICodecOptions): IJsonCodec<TreeStoredSchema, FormatV2> {
-	return makeVersionedValidatedCodec(options, new Set([SchemaVersion.v2]), FormatV2, {
+	return makeVersionedValidatedCodec(options, new Set([SchemaFormatVersion.v2]), FormatV2, {
 		encode: (data: TreeStoredSchema) => encodeRepoV2(data),
 		decode: (data: FormatV2) => decodeV2(data),
 	});

package/src/feature-libraries/schema-index/formatV1.ts

@@ -5,7 +5,7 @@
 
 import { type ObjectOptions, type Static, Type } from "@sinclair/typebox";
 
-import { SchemaVersion, schemaFormatV1 } from "../../core/index.js";
+import { SchemaFormatVersion, schemaFormatV1 } from "../../core/index.js";
 
 const noAdditionalProps: ObjectOptions = { additionalProperties: false };
 
@@ -21,7 +21,7 @@ const noAdditionalProps: ObjectOptions = { additionalProperties: false };
  */
 export const Format = Type.Object(
 	{
-		version: Type.Literal(SchemaVersion.v1),
+		version: Type.Literal(SchemaFormatVersion.v1),
 		nodes: Type.Record(Type.String(), schemaFormatV1.TreeNodeSchemaDataFormat),
 		root: schemaFormatV1.FieldSchemaFormat,
 	},

package/src/feature-libraries/schema-index/formatV2.ts

@@ -5,7 +5,7 @@
 
 import { type ObjectOptions, type Static, Type } from "@sinclair/typebox";
 
-import { SchemaVersion, schemaFormatV2 } from "../../core/index.js";
+import { SchemaFormatVersion, schemaFormatV2 } from "../../core/index.js";
 
 const noAdditionalProps: ObjectOptions = { additionalProperties: false };
 
@@ -21,7 +21,7 @@ const noAdditionalProps: ObjectOptions = { additionalProperties: false };
  */
 export const Format = Type.Object(
 	{
-		version: Type.Literal(SchemaVersion.v2),
+		version: Type.Literal(SchemaFormatVersion.v2),
 		nodes: Type.Record(Type.String(), schemaFormatV2.TreeNodeSchemaDataFormat),
 		root: schemaFormatV2.FieldSchemaFormat,
 	},

package/src/feature-libraries/schema-index/schemaSummarizer.ts

@@ -17,6 +17,7 @@ import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
 import type { IJsonCodec } from "../../codec/index.js";
 import {
 	type MutableTreeStoredSchema,
+	type SchemaFormatVersion,
 	type TreeStoredSchema,
 	schemaDataIsEmpty,
 } from "../../core/index.js";
@@ -108,7 +109,7 @@ export class SchemaSummarizer implements Summarizable {
  */
 export function encodeTreeSchema(
 	schema: TreeStoredSchema,
-	writeVersion: number,
+	writeVersion: SchemaFormatVersion,
 ): JsonCompatible {
 	return encodeRepo(schema, writeVersion);
 }