Prototype: Update how shared tree codec versions are generated

Author: agarwal-navin

packages/dds/tree/src/core/index.ts

@@ -104,6 +104,7 @@ export {
 	type ChunkedCursor,
 	type DetachedFieldIndexFormatVersion,
 	getCodecTreeForDetachedFieldIndexFormat,
+	getDetachedFieldIndexCodecVersion,
 } from "./tree/index.js";
 
 export {
@@ -153,6 +154,7 @@ export {
 	type SchemaPolicy,
 	SchemaVersion,
 	type SchemaFormatVersion,
+	getSchemaCodecVersion,
 } from "./schema-stored/index.js";
 
 export {

packages/dds/tree/src/core/schema-stored/index.ts

@@ -25,6 +25,7 @@ export {
 	type SchemaPolicy,
 	SchemaVersion,
 	type SchemaFormatVersion,
+	getSchemaCodecVersion,
 } from "./schema.js";
 export {
 	type TreeStoredSchemaSubscription,

packages/dds/tree/src/core/schema-stored/schema.ts

@@ -29,6 +29,15 @@ import type {
 	TreeNodeSchemaDataFormat as TreeNodeSchemaDataFormatV2,
 } from "./formatV2.js";
 import type { Multiplicity } from "./multiplicity.js";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
+
+export function getSchemaCodecVersion(
+	minVersionForCollab: MinimumVersionForCollab,
+): SchemaFormatVersion {
+	// Currently only two versions exists.
+	// In the future, this function can be expanded to select different versions based on the minimum version required.
+	return brand(SchemaVersion.v2);
+}
 
 /**
  * The format version for the schema.

packages/dds/tree/src/core/tree/detachedFieldIndexCodecs.ts

@@ -21,7 +21,8 @@ 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 { brand, type Brand } from "../../util/index.js";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 export function makeDetachedFieldIndexCodec(
 	revisionTagCodec: RevisionTagCodec,
@@ -51,3 +52,11 @@ export function getCodecTreeForDetachedFieldIndexFormat(
 ): CodecTree {
 	return { name: "DetachedFieldIndex", version };
 }
+
+export function getDetachedFieldIndexCodecVersion(
+	minVersionForCollab: MinimumVersionForCollab,
+): DetachedFieldIndexFormatVersion {
+	// Currently two versions exists.
+	// In the future, this function can be expanded to select different versions based on the minimum version required.
+	return minVersionForCollab < FluidClientVersion.v2_52 ? brand(version1) : brand(version2);
+}

packages/dds/tree/src/core/tree/index.ts

@@ -122,6 +122,7 @@ export { DetachedFieldIndex } from "./detachedFieldIndex.js";
 export {
 	type DetachedFieldIndexFormatVersion,
 	getCodecTreeForDetachedFieldIndexFormat,
+	getDetachedFieldIndexCodecVersion,
 } from "./detachedFieldIndexCodecs.js";
 
 export { type ForestRootId } from "./detachedFieldIndexTypes.js";

packages/dds/tree/src/feature-libraries/chunked-forest/codec/format.ts

@@ -5,6 +5,8 @@
 
 import { type Static, Type } from "@sinclair/typebox";
 
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
+
 import { unionOptions } from "../../../codec/index.js";
 
 import {
@@ -13,7 +15,15 @@ import {
 	IdentifierOrIndex,
 	ShapeIndex,
 } from "./formatGeneric.js";
-import type { Brand } from "../../../util/index.js";
+import { brand, type Brand } from "../../../util/index.js";
+
+export function getFieldBatchCodecVersion(
+	minVersionForCollab: MinimumVersionForCollab,
+): FieldBatchFormatVersion {
+	// Currently only one version exists.
+	// In the future, this function can be expanded to select different versions based on the minimum version required.
+	return brand(version);
+}
 
 export const version = 1;
 export type FieldBatchFormatVersion = Brand<1, "FieldBatchFormatVersion">;

packages/dds/tree/src/feature-libraries/chunked-forest/codec/index.ts

@@ -3,7 +3,11 @@
  * Licensed under the MIT License.
  */
 
-export { EncodedFieldBatch, type FieldBatchFormatVersion } from "./format.js";
+export {
+	EncodedFieldBatch,
+	type FieldBatchFormatVersion,
+	getFieldBatchCodecVersion,
+} from "./format.js";
 export type { FieldBatch } from "./fieldBatch.js";
 export {
 	type FieldBatchCodec,

packages/dds/tree/src/feature-libraries/chunked-forest/index.ts

@@ -28,5 +28,6 @@ export {
 	type ChunkReferenceId,
 	type IncrementalEncodingPolicy,
 	defaultIncrementalEncodingPolicy,
+	getFieldBatchCodecVersion,
 } from "./codec/index.js";
 export { emptyChunk } from "./emptyChunk.js";

packages/dds/tree/src/feature-libraries/forest-summary/codec.ts

@@ -15,7 +15,8 @@ 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 { brand, type Brand } from "../../util/index.js";
+import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 
 /**
  * Uses field cursors
@@ -57,3 +58,11 @@ export type ForestFormatVersion = Brand<1, "ForestFormatVersion">;
 export function getCodecTreeForForestFormat(version: ForestFormatVersion): CodecTree {
 	return { name: "Forest", version };
 }
+
+export function getForestCodecVersion(
+	minVersionForCollab: MinimumVersionForCollab,
+): ForestFormatVersion {
+	// Currently only one version exists.
+	// In the future, this function can be expanded to select different versions based on the minimum version required.
+	return brand(1);
+}

packages/dds/tree/src/feature-libraries/forest-summary/index.ts

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