@fluidframework/tree 2.70.0 → 2.72.0

package/src/core/tree/detachedFieldIndexCodecV1.ts

@@ -14,9 +14,11 @@ import {
 	RevisionTagSchema,
 } from "../rebase/index.js";
 
-import { type FormatV1, version1 } from "./detachedFieldIndexFormatV1.js";
+import type { FormatV1 } from "./detachedFieldIndexFormatV1.js";
 import type { DetachedFieldSummaryData, Major } from "./detachedFieldIndexTypes.js";
 import { makeDetachedFieldIndexCodecFromMajorCodec } from "./detachedFieldIndexCodecCommon.js";
+import { DetachedFieldIndexFormatVersion } from "./detachedFieldIndexFormatCommon.js";
+import { brand } from "../../util/index.js";
 
 class MajorCodec implements IJsonCodec<Major, EncodedRevisionTag> {
 	public constructor(
@@ -74,7 +76,7 @@ export function makeDetachedNodeToFieldCodecV1(
 	return makeDetachedFieldIndexCodecFromMajorCodec(
 		options,
 		majorCodec,
-		version1,
+		brand(DetachedFieldIndexFormatVersion.v1),
 		RevisionTagSchema,
 	);
 }

package/src/core/tree/detachedFieldIndexCodecV2.ts

@@ -9,14 +9,12 @@ import type { IIdCompressor, StableId } from "@fluidframework/id-compressor";
 import type { ICodecOptions, IJsonCodec } from "../../codec/index.js";
 import type { EncodedRevisionTag, RevisionTagCodec, RevisionTag } from "../rebase/index.js";
 
-import {
-	type FormatV2,
-	StableOrFinalRevisionTag,
-	version2,
-} from "./detachedFieldIndexFormatV2.js";
+import { type FormatV2, 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 { brand } from "../../util/index.js";
 
 class MajorCodec implements IJsonCodec<Major> {
 	public constructor(
@@ -66,7 +64,7 @@ export function makeDetachedNodeToFieldCodecV2(
 	return makeDetachedFieldIndexCodecFromMajorCodec(
 		options,
 		majorCodec,
-		version2,
+		brand(DetachedFieldIndexFormatVersion.v2),
 		StableOrFinalRevisionTag,
 	);
 }

package/src/core/tree/detachedFieldIndexCodecs.ts

@@ -4,6 +4,7 @@
  */
 
 import type { IIdCompressor } from "@fluidframework/id-compressor";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 import {
 	type CodecTree,
@@ -16,12 +17,24 @@ import {
 } from "../../codec/index.js";
 import type { RevisionTagCodec } from "../rebase/index.js";
 
-import { version1 } from "./detachedFieldIndexFormatV1.js";
-import { version2 } from "./detachedFieldIndexFormatV2.js";
 import { makeDetachedNodeToFieldCodecV1 } from "./detachedFieldIndexCodecV1.js";
 import { makeDetachedNodeToFieldCodecV2 } from "./detachedFieldIndexCodecV2.js";
 import type { DetachedFieldSummaryData } from "./detachedFieldIndexTypes.js";
-import type { Brand } from "../../util/index.js";
+import { DetachedFieldIndexFormatVersion } from "./detachedFieldIndexFormatCommon.js";
+import { brand } from "../../util/index.js";
+
+/**
+ * Convert a MinimumVersionForCollab to a version for detached field codecs.
+ * @param clientVersion - The MinimumVersionForCollab to convert.
+ * @returns The detached field codec version that corresponds to the provided MinimumVersionForCollab.
+ */
+function clientVersionToDetachedFieldVersion(
+	clientVersion: MinimumVersionForCollab,
+): DetachedFieldIndexFormatVersion {
+	return clientVersion < FluidClientVersion.v2_52
+		? brand(DetachedFieldIndexFormatVersion.v1)
+		: brand(DetachedFieldIndexFormatVersion.v2);
+}
 
 export function makeDetachedFieldIndexCodec(
 	revisionTagCodec: RevisionTagCodec,
@@ -29,9 +42,10 @@ export function makeDetachedFieldIndexCodec(
 	idCompressor: IIdCompressor,
 ): IJsonCodec<DetachedFieldSummaryData> {
 	const family = makeDetachedFieldIndexCodecFamily(revisionTagCodec, options, idCompressor);
-	const writeVersion =
-		options.minVersionForCollab < FluidClientVersion.v2_52 ? version1 : version2;
-	return makeVersionDispatchingCodec(family, { ...options, writeVersion });
+	return makeVersionDispatchingCodec(family, {
+		...options,
+		writeVersion: clientVersionToDetachedFieldVersion(options.minVersionForCollab),
+	});
 }
 
 export function makeDetachedFieldIndexCodecFamily(
@@ -40,14 +54,22 @@ export function makeDetachedFieldIndexCodecFamily(
 	idCompressor: IIdCompressor,
 ): ICodecFamily<DetachedFieldSummaryData> {
 	return makeCodecFamily([
-		[version1, makeDetachedNodeToFieldCodecV1(revisionTagCodec, options, idCompressor)],
-		[version2, makeDetachedNodeToFieldCodecV2(revisionTagCodec, options, idCompressor)],
+		[
+			DetachedFieldIndexFormatVersion.v1,
+			makeDetachedNodeToFieldCodecV1(revisionTagCodec, options, idCompressor),
+		],
+		[
+			DetachedFieldIndexFormatVersion.v2,
+			makeDetachedNodeToFieldCodecV2(revisionTagCodec, options, idCompressor),
+		],
 	]);
 }
 
-export type DetachedFieldIndexFormatVersion = Brand<1 | 2, "DetachedFieldIndexFormatVersion">;
 export function getCodecTreeForDetachedFieldIndexFormat(
-	version: DetachedFieldIndexFormatVersion,
+	clientVersion: MinimumVersionForCollab,
 ): CodecTree {
-	return { name: "DetachedFieldIndex", version };
+	return {
+		name: "DetachedFieldIndex",
+		version: clientVersionToDetachedFieldVersion(clientVersion),
+	};
 }

package/src/core/tree/detachedFieldIndexFormatCommon.ts

@@ -5,10 +5,22 @@
 
 import { type Static, type TSchema, Type } from "@sinclair/typebox";
 
-import { brandedNumberType } from "../../util/index.js";
+import { brandedNumberType, type Brand } from "../../util/index.js";
 
 import type { ForestRootId } from "./detachedFieldIndexTypes.js";
 
+/**
+ * The format version for the detached field index.
+ */
+export const DetachedFieldIndexFormatVersion = {
+	v1: 1,
+	v2: 2,
+} as const;
+export type DetachedFieldIndexFormatVersion = Brand<
+	(typeof DetachedFieldIndexFormatVersion)[keyof typeof DetachedFieldIndexFormatVersion],
+	"DetachedFieldIndexFormatVersion"
+>;
+
 /**
  * The ID of a detached node. Is not globally unique on.
  * A `RevisionTag` + `DetachId` pair is globally unique and eventually consistent across clients.
@@ -54,7 +66,10 @@ export const EncodedRootsForRevision = <Schema extends TSchema>(tRevisionTag: Sc
 	]);
 export type EncodedRootsForRevision = Static<ReturnType<typeof EncodedRootsForRevision>>;
 
-export const Format = <TVersion extends number, TRevisionTagSchema extends TSchema>(
+export const Format = <
+	TVersion extends DetachedFieldIndexFormatVersion,
+	TRevisionTagSchema extends TSchema,
+>(
 	tVersion: TVersion,
 	tRevisionTag: TRevisionTagSchema,
 	// Return type is intentionally derived.

package/src/core/tree/detachedFieldIndexFormatV1.ts

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

package/src/core/tree/detachedFieldIndexFormatV2.ts

@@ -5,13 +5,15 @@
 
 import { Type, type Static } from "@sinclair/typebox";
 
-import { Format } from "./detachedFieldIndexFormatCommon.js";
+import { DetachedFieldIndexFormatVersion, Format } from "./detachedFieldIndexFormatCommon.js";
 import { RevisionTagSchema, StableIdSchema } from "../rebase/index.js";
-
-export const version2 = 2.0;
+import { brand } from "../../util/index.js";
 
 export const StableOrFinalRevisionTag = Type.Union([RevisionTagSchema, StableIdSchema]);
 
-export const FormatV2 = Format(version2, StableOrFinalRevisionTag);
+export const FormatV2 = Format(
+	brand<DetachedFieldIndexFormatVersion>(DetachedFieldIndexFormatVersion.v2),
+	StableOrFinalRevisionTag,
+);
 
 export type FormatV2 = Static<typeof FormatV2>;

package/src/core/tree/index.ts

@@ -119,9 +119,7 @@ export {
 
 export { DetachedFieldIndex } from "./detachedFieldIndex.js";
 
-export {
-	type DetachedFieldIndexFormatVersion,
-	getCodecTreeForDetachedFieldIndexFormat,
-} from "./detachedFieldIndexCodecs.js";
+export { getCodecTreeForDetachedFieldIndexFormat } from "./detachedFieldIndexCodecs.js";
+export { type DetachedFieldIndexFormatVersion } from "./detachedFieldIndexFormatCommon.js";
 
 export { type ForestRootId } from "./detachedFieldIndexTypes.js";

package/src/external-utilities/typeboxValidator.ts

@@ -5,7 +5,7 @@
 
 import type { Static, TSchema } from "@sinclair/typebox";
 // This export is documented as supported in typebox's documentation.
-// eslint-disable-next-line import/no-internal-modules
+// eslint-disable-next-line import-x/no-internal-modules
 import { TypeCompiler } from "@sinclair/typebox/compiler";
 
 import { toFormatValidator, type JsonValidator } from "../codec/index.js";

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";