@fluidframework/tree 2.82.0 → 2.83.0

package/src/feature-libraries/modular-schema/modularChangeCodecV1.ts

@@ -9,7 +9,6 @@ import type { TAnySchema } from "@sinclair/typebox";
 import {
 	type ICodecOptions,
 	type IJsonCodec,
-	type IMultiFormatCodec,
 	type SchemaValidationFunction,
 	extractJsonValidator,
 	withSchemaValidation,
@@ -72,7 +71,7 @@ type ModularChangeCodec = IJsonCodec<
 	ChangeEncodingContext
 >;
 
-type FieldCodec = IMultiFormatCodec<
+type FieldCodec = IJsonCodec<
 	FieldChangeset,
 	JsonCompatibleReadOnly,
 	JsonCompatibleReadOnly,
@@ -132,7 +131,7 @@ export function encodeFieldChangesForJsonI(
 			fieldChange.fieldKind,
 			fieldChangesetCodecs,
 		);
-		const encodedChange = codec.json.encode(fieldChange.change, context);
+		const encodedChange = codec.encode(fieldChange.change, context);
 		if (compiledSchema !== undefined && !compiledSchema.check(encodedChange)) {
 			fail(0xb1f /* Encoded change didn't pass schema validation. */);
 		}
@@ -225,7 +224,7 @@ export function decodeFieldChangesFromJson(
 			},
 		};
 
-		const fieldChangeset = codec.json.decode(field.change, fieldContext);
+		const fieldChangeset = codec.decode(field.change, fieldContext);
 
 		const crossFieldKeys = getChangeHandler(fieldKinds, field.fieldKind).getCrossFieldKeys(
 			fieldChangeset,
@@ -597,8 +596,8 @@ export function getFieldChangesetCodecs(
 		const codec = kind.changeHandler.codecsFactory(revisionTagCodec).resolve(formatVersion);
 		return {
 			codec,
-			compiledSchema: codec.json.encodedSchema
-				? extractJsonValidator(codecOptions.jsonValidator).compile(codec.json.encodedSchema)
+			compiledSchema: codec.encodedSchema
+				? extractJsonValidator(codecOptions.jsonValidator).compile(codec.encodedSchema)
 				: undefined,
 		};
 	};

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

@@ -125,8 +125,9 @@ function decodeV2(f: FormatV2): TreeStoredSchema {
 /**
  * Creates a codec which performs synchronous monolithic encoding of schema content.
  */
-export const schemaCodecBuilder = ClientVersionDispatchingCodecBuilder.build("Schema", {
-	[lowestMinVersionForCollab]: {
+export const schemaCodecBuilder = ClientVersionDispatchingCodecBuilder.build("Schema", [
+	{
+		minVersionForCollab: lowestMinVersionForCollab,
 		formatVersion: SchemaFormatVersion.v1,
 		codec: {
 			encode: (data: TreeStoredSchema) => encodeRepoV1(data),
@@ -134,7 +135,8 @@ export const schemaCodecBuilder = ClientVersionDispatchingCodecBuilder.build("Sc
 			schema: FormatV1,
 		},
 	},
-	[FluidClientVersion.v2_43]: {
+	{
+		minVersionForCollab: FluidClientVersion.v2_43,
 		formatVersion: SchemaFormatVersion.v2,
 		codec: {
 			encode: (data: TreeStoredSchema) => encodeRepoV2(data),
@@ -142,4 +144,4 @@ export const schemaCodecBuilder = ClientVersionDispatchingCodecBuilder.build("Sc
 			schema: FormatV2,
 		},
 	},
-});
+]);

package/src/index.ts

@@ -296,13 +296,13 @@ export {
 	exportCompatibilitySchemaSnapshot,
 	importCompatibilitySchemaSnapshot,
 	checkCompatibility,
-	checkSchemaCompatibilitySnapshots,
+	snapshotSchemaCompatibility,
 	type SnapshotFileSystem,
 	incrementalSummaryHint,
 	incrementalEncodingPolicyForAllowedTypes,
 	eraseSchemaDetails,
 	eraseSchemaDetailsSubclassable,
-	type SchemaCompatibilitySnapshotsOptions,
+	type SnapshotSchemaCompatibilityOptions,
 	type ArrayPlaceAnchor,
 	createArrayInsertionAnchor,
 } from "./simple-tree/index.js";
@@ -371,4 +371,4 @@ export { TableSchema, type System_TableSchema } from "./tableSchema.js";
 export { asAlpha, asBeta } from "./api.js";
 
 export { TextAsTree, FormattedTextAsTree } from "./text/index.js";
-export { ExtensibleSchemaUnion } from "./extensibleSchemaUnion.js";
+export { ExtensibleUnionNode } from "./extensibleUnionNode.js";

package/src/packageVersion.ts

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

package/src/shared-tree/sharedTreeChangeCodecs.ts

@@ -61,8 +61,8 @@ export function makeSharedTreeChangeCodecFamily(
 		([format, { modularChange, schemaChange }]) => [
 			format,
 			makeSharedTreeChangeCodec(
-				modularChangeCodecFamily.resolve(modularChange).json,
-				schemaChangeCodecs.resolve(schemaChange).json,
+				modularChangeCodecFamily.resolve(modularChange),
+				schemaChangeCodecs.resolve(schemaChange),
 				options,
 			),
 		],

package/src/shared-tree/tree.ts

@@ -28,7 +28,7 @@ import type { ITreeCheckout } from "./treeCheckout.js";
  * Provides various functions for interacting with {@link TreeNode}s.
  * @remarks
  * This type should only be used via the {@link (Tree:variable)} export.
- * @system @sealed @public
+ * @sealed @public
  */
 export interface Tree extends TreeNodeApi {
 	/**

package/src/shared-tree/treeAlpha.ts

@@ -226,7 +226,7 @@ export interface TreeIdentifierUtils {
  * There should be a way to provide a source for defaulted identifiers for unhydrated node creation, either via these APIs or some way to add them to its output later.
  * If an option were added to these APIs, it could also be used to enable unknown optional fields.
  *
- * @system @sealed @alpha
+ * @sealed @alpha
  */
 export interface TreeAlpha {
 	/**

package/src/shared-tree/treeCheckout.ts

@@ -597,9 +597,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 							originatorId: this.idCompressor.localSessionId,
 							revision,
 						};
-						const encodedChange = this.changeFamily.codecs
-							.resolve(4)
-							.json.encode(change, context);
+						const encodedChange = this.changeFamily.codecs.resolve(4).encode(change, context);
 
 						assert(
 							commit.parent !== undefined,
@@ -666,7 +664,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 			originatorId: this.idCompressor.localSessionId,
 			revision,
 		};
-		const decodedChange = this.changeFamily.codecs.resolve(4).json.decode(change, context);
+		const decodedChange = this.changeFamily.codecs.resolve(4).decode(change, context);
 		this.applyChange(decodedChange, revision);
 	}
 

package/src/shared-tree-core/editManagerCodecsCommons.ts

@@ -6,7 +6,7 @@
 import { assert } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor";
 
-import type { IJsonCodec, IMultiFormatCodec } from "../codec/index.js";
+import type { IJsonCodec } from "../codec/index.js";
 import type {
 	ChangeEncodingContext,
 	EncodedRevisionTag,
@@ -32,7 +32,7 @@ export interface EditManagerEncodingContext {
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function encodeCommit<TChangeset, T extends Commit<TChangeset>>(
-	changeCodec: IMultiFormatCodec<
+	changeCodec: IJsonCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
 		JsonCompatibleReadOnly,
@@ -54,13 +54,13 @@ function encodeCommit<TChangeset, T extends Commit<TChangeset>>(
 			idCompressor: context.idCompressor,
 			revision: undefined,
 		}),
-		change: changeCodec.json.encode(commit.change, { ...context, revision: commit.revision }),
+		change: changeCodec.encode(commit.change, { ...context, revision: commit.revision }),
 	};
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function decodeCommit<TChangeset, T extends EncodedCommit<JsonCompatibleReadOnly>>(
-	changeCodec: IMultiFormatCodec<
+	changeCodec: IJsonCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
 		JsonCompatibleReadOnly,
@@ -84,12 +84,12 @@ function decodeCommit<TChangeset, T extends EncodedCommit<JsonCompatibleReadOnly
 	return {
 		...commit,
 		revision,
-		change: changeCodec.json.decode(commit.change, { ...context, revision }),
+		change: changeCodec.decode(commit.change, { ...context, revision }),
 	};
 }
 
 export function encodeSharedBranch<TChangeset>(
-	changeCodec: IMultiFormatCodec<
+	changeCodec: IJsonCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
 		JsonCompatibleReadOnly,
@@ -160,7 +160,7 @@ export function encodeSharedBranch<TChangeset>(
 }
 
 export function decodeSharedBranch<TChangeset>(
-	changeCodec: IMultiFormatCodec<
+	changeCodec: IJsonCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
 		JsonCompatibleReadOnly,

package/src/shared-tree-core/editManagerCodecsV1toV4.ts

@@ -5,12 +5,7 @@
 
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
-import {
-	type ICodecOptions,
-	type IJsonCodec,
-	type IMultiFormatCodec,
-	withSchemaValidation,
-} from "../codec/index.js";
+import { type ICodecOptions, type IJsonCodec, withSchemaValidation } from "../codec/index.js";
 import type {
 	ChangeEncodingContext,
 	EncodedRevisionTag,
@@ -29,7 +24,7 @@ export interface EditManagerEncodingContext {
 }
 
 export function makeV1CodecWithVersion<TChangeset>(
-	changeCodec: IMultiFormatCodec<
+	changeCodec: IJsonCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
 		JsonCompatibleReadOnly,
@@ -49,9 +44,7 @@ export function makeV1CodecWithVersion<TChangeset>(
 	JsonCompatibleReadOnly,
 	EditManagerEncodingContext
 > {
-	const format = EncodedEditManager(
-		changeCodec.json.encodedSchema ?? JsonCompatibleReadOnlySchema,
-	);
+	const format = EncodedEditManager(changeCodec.encodedSchema ?? JsonCompatibleReadOnlySchema);
 
 	const codec: IJsonCodec<
 		SummaryData<TChangeset>,

package/src/shared-tree-core/editManagerCodecsVSharedBranches.ts

@@ -6,12 +6,7 @@
 import { assert } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
-import {
-	type ICodecOptions,
-	type IJsonCodec,
-	type IMultiFormatCodec,
-	withSchemaValidation,
-} from "../codec/index.js";
+import { type ICodecOptions, type IJsonCodec, withSchemaValidation } from "../codec/index.js";
 import type {
 	ChangeEncodingContext,
 	EncodedRevisionTag,
@@ -36,7 +31,7 @@ export interface EditManagerEncodingContext {
 }
 
 export function makeSharedBranchesCodecWithVersion<TChangeset>(
-	changeCodec: IMultiFormatCodec<
+	changeCodec: IJsonCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
 		JsonCompatibleReadOnly,
@@ -56,9 +51,7 @@ export function makeSharedBranchesCodecWithVersion<TChangeset>(
 	JsonCompatibleReadOnly,
 	EditManagerEncodingContext
 > {
-	const format = EncodedEditManager(
-		changeCodec.json.encodedSchema ?? JsonCompatibleReadOnlySchema,
-	);
+	const format = EncodedEditManager(changeCodec.encodedSchema ?? JsonCompatibleReadOnlySchema);
 
 	const codec: IJsonCodec<
 		SummaryData<TChangeset>,

package/src/shared-tree-core/messageCodecs.ts

@@ -146,9 +146,7 @@ export function makeMessageCodecs<TChangeset>(
 			case unbrand(MessageFormatVersion.v3):
 			case unbrand(MessageFormatVersion.v4):
 			case unbrand(MessageFormatVersion.v6): {
-				const changeCodec = changeCodecs.resolve(
-					dependentChangeFormatVersion.lookup(version),
-				).json;
+				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
 					version,
 					makeV1ToV4CodecWithVersion(changeCodec, revisionTagCodec, options, version),
@@ -158,9 +156,7 @@ export function makeMessageCodecs<TChangeset>(
 				return [version, makeDiscontinuedCodecVersion(options, version, "2.74.0")];
 			}
 			case unbrand(MessageFormatVersion.vSharedBranches): {
-				const changeCodec = changeCodecs.resolve(
-					dependentChangeFormatVersion.lookup(version),
-				).json;
+				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
 					version,
 					makeSharedBranchesCodecWithVersion(changeCodec, revisionTagCodec, options, version),

package/src/simple-tree/api/index.ts

@@ -181,7 +181,7 @@ export {
 	exportCompatibilitySchemaSnapshot,
 	importCompatibilitySchemaSnapshot,
 	checkCompatibility,
-	checkSchemaCompatibilitySnapshots,
+	snapshotSchemaCompatibility,
 	type SnapshotFileSystem,
-	type SchemaCompatibilitySnapshotsOptions,
+	type SnapshotSchemaCompatibilityOptions,
 } from "./snapshotCompatibilityChecker.js";