@fluidframework/tree 2.71.0 → 2.73.0

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

@@ -4,9 +4,15 @@
  */
 
 import { fail, unreachableCase } from "@fluidframework/core-utils/internal";
+import {
+	getConfigForMinVersionForCollab,
+	lowestMinVersionForCollab,
+} from "@fluidframework/runtime-utils/internal";
 
 import {
 	type CodecTree,
+	type CodecWriteOptions,
+	FluidClientVersion,
 	type ICodecFamily,
 	type ICodecOptions,
 	type IJsonCodec,
@@ -15,7 +21,7 @@ import {
 	makeVersionedValidatedCodec,
 } from "../../codec/index.js";
 import {
-	SchemaVersion,
+	SchemaFormatVersion,
 	type TreeNodeSchemaIdentifier,
 	type TreeNodeStoredSchema,
 	type TreeStoredSchema,
@@ -31,35 +37,45 @@ 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 brand(
+		getConfigForMinVersionForCollab(clientVersion, {
+			[lowestMinVersionForCollab]: SchemaFormatVersion.v1,
+			[FluidClientVersion.v2_43]: 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 +85,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 +96,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 +114,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 +124,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 +188,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 +200,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);
 }

package/src/feature-libraries/{default-schema/schemaChecker.ts → schemaChecker.ts}

@@ -13,10 +13,10 @@ import {
 	MapNodeStoredSchema,
 	Multiplicity,
 	type SchemaAndPolicy,
-} from "../../core/index.js";
-import { allowsValue } from "../valueUtilities.js";
-import type { MapTreeFieldViewGeneric, MinimalMapTreeNodeView } from "../mapTreeCursor.js";
-import { iterableHasSome, mapIterable } from "../../util/index.js";
+} from "../core/index.js";
+import { allowsValue } from "./valueUtilities.js";
+import type { MapTreeFieldViewGeneric, MinimalMapTreeNodeView } from "./mapTreeCursor.js";
+import { iterableHasSome, mapIterable } from "../util/index.js";
 
 export enum SchemaValidationError {
 	Field_KindNotInSchemaPolicy,

package/src/feature-libraries/sequence-field/sequenceFieldCodecs.ts

@@ -11,7 +11,6 @@ import type {
 } from "../../core/index.js";
 import type { FieldChangeEncodingContext } from "../modular-schema/index.js";
 
-import { makeV1Codec } from "./sequenceFieldCodecV1.js";
 import { makeV2Codec } from "./sequenceFieldCodecV2.js";
 import { makeV3Codec } from "./sequenceFieldCodecV3.js";
 import type { Changeset, MarkList } from "./types.js";
@@ -25,7 +24,6 @@ export const sequenceFieldChangeCodecFactory = (
 	>,
 ): ICodecFamily<MarkList, FieldChangeEncodingContext> =>
 	makeCodecFamily<Changeset, FieldChangeEncodingContext>([
-		[1, makeV1Codec(revisionTagCodec)],
 		[2, makeV2Codec(revisionTagCodec)],
 		[3, makeV3Codec(revisionTagCodec)],
 	]);

package/src/index.ts

@@ -60,7 +60,6 @@ export {
 	type SharedTreeOptionsBeta,
 	type ForestType,
 	type SharedTreeFormatOptions,
-	SharedTreeFormatVersion,
 	Tree,
 	type RunTransaction,
 	type ForestOptions,
@@ -95,6 +94,7 @@ export {
 	type TreeViewEvents,
 	SchemaFactory,
 	SchemaFactoryBeta,
+	type SchemaStaticsBeta,
 	SchemaFactoryAlpha,
 	type ObjectSchemaOptionsAlpha,
 	type ObjectSchemaOptions,
@@ -181,7 +181,6 @@ export {
 	type AllowedTypeMetadata,
 	type AllowedTypesMetadata,
 	type UnannotateAllowedTypesList,
-	type SchemaStaticsAlpha,
 	type AnnotateAllowedTypesList,
 	type AllowedTypesFull,
 	type AllowedTypesFullFromMixed,
@@ -283,6 +282,11 @@ export {
 	type SchemaFactory_base,
 	type NumberKeys,
 	type SimpleAllowedTypeAttributes,
+	encodeSimpleSchema,
+	decodeSimpleSchema,
+	exportCompatibilitySchemaSnapshot,
+	importCompatibilitySchemaSnapshot,
+	checkCompatibility,
 } from "./simple-tree/index.js";
 export {
 	SharedTree,

package/src/packageVersion.ts

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

package/src/shared-tree/independentView.ts

@@ -10,11 +10,15 @@ import {
 	createIdCompressor,
 } from "@fluidframework/id-compressor/internal";
 
-import type { ICodecOptions } from "../codec/index.js";
+import {
+	FluidClientVersion,
+	type CodecWriteOptions,
+	type ICodecOptions,
+} from "../codec/index.js";
 import {
 	type RevisionTag,
 	RevisionTagCodec,
-	SchemaVersion,
+	SchemaFormatVersion,
 	TreeStoredSchemaRepository,
 } from "../core/index.js";
 import {
@@ -26,7 +30,7 @@ import {
 	TreeCompressionStrategy,
 	defaultIncrementalEncodingPolicy,
 } from "../feature-libraries/index.js";
-// eslint-disable-next-line import/no-internal-modules
+// eslint-disable-next-line import-x/no-internal-modules
 import type { Format } from "../feature-libraries/schema-index/formatV1.js";
 import type {
 	TreeViewConfiguration,
@@ -44,6 +48,7 @@ import {
 	type JsonCompatible,
 	Breakable,
 	oneFromIterable,
+	brand,
 } from "../util/index.js";
 import {
 	buildConfiguredForest,
@@ -195,8 +200,14 @@ export function createIndependentTreeAlpha<const TSchema extends ImplicitFieldSc
 	});
 
 	if (options?.content !== undefined) {
-		const schemaCodec = makeSchemaCodec(options, SchemaVersion.v1);
-		const fieldBatchCodec = makeFieldBatchCodec(options, 1);
+		// Any version can be passed down to `makeSchemaCodec` and `makeFieldBatchCodec` here.
+		// We only use the decode part, which always dispatches to the correct codec based on the version in the data, not `minVersionForCollab`.
+		const writeOptions: CodecWriteOptions = {
+			...options,
+			minVersionForCollab: FluidClientVersion.v2_0,
+		};
+		const schemaCodec = makeSchemaCodec(writeOptions, brand(SchemaFormatVersion.v1));
+		const fieldBatchCodec = makeFieldBatchCodec(writeOptions);
 		const newSchema = schemaCodec.decode(options.content.schema as Format);
 
 		const context: FieldBatchEncodingContext = {

package/src/shared-tree/index.ts

@@ -13,7 +13,6 @@ export {
 	type ForestType,
 	type SharedTreeContentSnapshot,
 	type SharedTreeFormatOptions,
-	SharedTreeFormatVersion,
 	buildConfiguredForest,
 	defaultSharedTreeOptions,
 	type ForestOptions,