@fluidframework/tree 2.63.0-358419 → 2.63.0-359286

package/src/core/tree/detachedFieldIndexCodecs.ts

@@ -6,6 +6,7 @@
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 
 import {
+	type CodecTree,
 	type CodecWriteOptions,
 	FluidClientVersion,
 	type ICodecFamily,
@@ -20,6 +21,7 @@ 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";
 
 export function makeDetachedFieldIndexCodec(
 	revisionTagCodec: RevisionTagCodec,
@@ -42,3 +44,10 @@ export function makeDetachedFieldIndexCodecFamily(
 		[version2, makeDetachedNodeToFieldCodecV2(revisionTagCodec, options, idCompressor)],
 	]);
 }
+
+export type DetachedFieldIndexFormatVersion = Brand<1 | 2, "DetachedFieldIndexFormatVersion">;
+export function getCodecTreeForDetachedFieldIndexFormat(
+	version: DetachedFieldIndexFormatVersion,
+): CodecTree {
+	return { name: "DetachedFieldIndex", version };
+}

package/src/core/tree/index.ts

@@ -118,4 +118,10 @@ export {
 } from "./chunk.js";
 
 export { DetachedFieldIndex } from "./detachedFieldIndex.js";
+
+export {
+	type DetachedFieldIndexFormatVersion,
+	getCodecTreeForDetachedFieldIndexFormat,
+} from "./detachedFieldIndexCodecs.js";
+
 export { type ForestRootId } from "./detachedFieldIndexTypes.js";

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

@@ -7,6 +7,7 @@ import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor";
 
 import {
+	type CodecTree,
 	type FluidClientVersion,
 	type ICodecOptions,
 	type IJsonCodec,
@@ -33,7 +34,7 @@ import {
 
 import { decode } from "./chunkDecoding.js";
 import type { FieldBatch } from "./fieldBatch.js";
-import { EncodedFieldBatch, validVersions } from "./format.js";
+import { EncodedFieldBatch, validVersions, type FieldBatchFormatVersion } from "./format.js";
 import { schemaCompressedEncode } from "./schemaBasedEncode.js";
 import { uncompressedEncode } from "./uncompressedEncode.js";
 
@@ -197,3 +198,7 @@ export function makeFieldBatchCodec(
 		},
 	});
 }
+
+export function getCodecTreeForFieldBatchFormat(version: FieldBatchFormatVersion): CodecTree {
+	return { name: "FieldBatch", version };
+}

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

@@ -13,8 +13,10 @@ import {
 	IdentifierOrIndex,
 	ShapeIndex,
 } from "./formatGeneric.js";
+import type { Brand } from "../../../util/index.js";
 
 export const version = 1;
+export type FieldBatchFormatVersion = Brand<1, "FieldBatchFormatVersion">;
 
 // Compatible versions used for format/version validation.
 // TODO: A proper version update policy will need to be documented.

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

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-export { EncodedFieldBatch } from "./format.js";
+export { EncodedFieldBatch, type FieldBatchFormatVersion } from "./format.js";
 export type { FieldBatch } from "./fieldBatch.js";
 export {
 	type FieldBatchCodec,
@@ -14,4 +14,5 @@ export {
 	type IncrementalEncoder,
 	type IncrementalDecoder,
 	type ChunkReferenceId,
+	getCodecTreeForFieldBatchFormat,
 } from "./codecs.js";

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

@@ -16,6 +16,8 @@ export {
 export { buildChunkedForest } from "./chunkedForest.js";
 export {
 	EncodedFieldBatch,
+	type FieldBatchFormatVersion,
+	getCodecTreeForFieldBatchFormat,
 	type FieldBatch,
 	type FieldBatchCodec,
 	makeFieldBatchCodec,

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

@@ -32,6 +32,8 @@ import {
 import { sequenceFieldChangeHandler } from "../sequence-field/index.js";
 
 import { noChangeCodecFamily } from "./noChangeCodecs.js";
+import type { CodecTree } from "../../codec/index.js";
+import { brand, type Brand } from "../../util/index.js";
 
 /**
  * ChangeHandler that only handles no-op / identity changes.
@@ -205,9 +207,12 @@ export const forbidden = new FieldKindWithEditor(
 	new Set(),
 );
 
-export const fieldKindConfigurations: ReadonlyMap<number, FieldKindConfiguration> = new Map([
+export const fieldKindConfigurations: ReadonlyMap<
+	ModularChangeFormatVersion,
+	FieldKindConfiguration
+> = new Map([
 	[
-		1,
+		brand(1),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
 			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 1 }],
@@ -218,7 +223,7 @@ export const fieldKindConfigurations: ReadonlyMap<number, FieldKindConfiguration
 		]),
 	],
 	[
-		2,
+		brand(2),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
 			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 2 }],
@@ -229,7 +234,7 @@ export const fieldKindConfigurations: ReadonlyMap<number, FieldKindConfiguration
 		]),
 	],
 	[
-		3,
+		brand(3),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
 			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 2 }],
@@ -240,7 +245,7 @@ export const fieldKindConfigurations: ReadonlyMap<number, FieldKindConfiguration
 		]),
 	],
 	[
-		4,
+		brand(4),
 		new Map<FieldKindIdentifier, FieldKindConfigurationEntry>([
 			[nodeKey.identifier, { kind: nodeKey, formatVersion: 1 }],
 			[required.identifier, { kind: required, formatVersion: 2 }],
@@ -252,6 +257,25 @@ export const fieldKindConfigurations: ReadonlyMap<number, FieldKindConfiguration
 	],
 ]);
 
+export type ModularChangeFormatVersion = Brand<1 | 2 | 3 | 4, "ModularChangeFormatVersion">;
+export function getCodecTreeForModularChangeFormat(
+	version: ModularChangeFormatVersion,
+): CodecTree {
+	const dependencies =
+		fieldKindConfigurations.get(version) ?? fail("Unknown modular change format");
+	const children: CodecTree[] = Array.from(dependencies.entries()).map(
+		([key, { formatVersion }]) => ({
+			name: `FieldKind:${key}`,
+			version: formatVersion,
+		}),
+	);
+	return {
+		name: "ModularChange",
+		version,
+		children,
+	};
+}
+
 /**
  * All supported field kinds.
  *

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

@@ -12,6 +12,8 @@ export {
 	type Forbidden,
 	fieldKinds,
 	fieldKindConfigurations,
+	getCodecTreeForModularChangeFormat,
+	type ModularChangeFormatVersion,
 } from "./defaultFieldKinds.js";
 
 export {

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

@@ -6,6 +6,7 @@
 import { assert, oob } from "@fluidframework/core-utils/internal";
 
 import {
+	type CodecTree,
 	type ICodecOptions,
 	type IJsonCodec,
 	makeVersionedValidatedCodec,
@@ -14,6 +15,7 @@ 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";
 
 /**
  * Uses field cursors
@@ -50,3 +52,8 @@ export function makeForestSummarizerCodec(
 		},
 	});
 }
+
+export type ForestFormatVersion = Brand<1, "ForestFormatVersion">;
+export function getCodecTreeForForestFormat(version: ForestFormatVersion): CodecTree {
+	return { name: "Forest", version };
+}

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

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

package/src/feature-libraries/index.ts

@@ -9,7 +9,11 @@ export {
 } from "./editableTreeBinder.js";
 export { allowsValue, assertAllowedValue, isTreeValue } from "./valueUtilities.js";
 
-export { ForestSummarizer } from "./forest-summary/index.js";
+export {
+	ForestSummarizer,
+	getCodecTreeForForestFormat,
+	type ForestFormatVersion,
+} from "./forest-summary/index.js";
 export {
 	cursorForMapTreeField,
 	cursorForMapTreeNode,
@@ -28,6 +32,7 @@ export {
 	encodeTreeSchema,
 	makeSchemaCodec,
 	makeSchemaCodecs,
+	getCodecTreeForSchemaFormat,
 } from "./schema-index/index.js";
 export {
 	stackTreeNodeCursor,
@@ -98,6 +103,8 @@ export {
 	defaultChunkPolicy,
 	type FieldBatch,
 	type FieldBatchCodec,
+	type FieldBatchFormatVersion,
+	getCodecTreeForFieldBatchFormat,
 	makeTreeChunker,
 	makeFieldBatchCodec,
 	fluidVersionToFieldBatchCodecWriteVersion,
@@ -139,6 +146,8 @@ export {
 	isNodeInSchema,
 	isFieldInSchema,
 	throwOutOfSchema,
+	getCodecTreeForModularChangeFormat,
+	type ModularChangeFormatVersion,
 } from "./default-schema/index.js";
 
 export {
@@ -190,6 +199,8 @@ export {
 	type SchemaChange,
 	makeSchemaChangeCodecs,
 	EncodedSchemaChange,
+	getCodecTreeForSchemaChangeFormat,
+	type SchemaChangeFormatVersion,
 } from "./schema-edits/index.js";
 
 export { makeMitigatedChangeFamily } from "./mitigatedChangeFamily.js";

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

@@ -504,7 +504,7 @@ export class ModularChangeFamily
 		}
 
 		for (const [field, fieldChange2] of change2) {
-			if (change1 === undefined || !change1.has(field)) {
+			if (!change1?.has(field)) {
 				composedFields.set(field, fieldChange2);
 			}
 		}

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

@@ -3,6 +3,10 @@
  * Licensed under the MIT License.
  */
 
-export { makeSchemaChangeCodecs } from "./schemaChangeCodecs.js";
+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

@@ -6,6 +6,7 @@
 import { assert } from "@fluidframework/core-utils/internal";
 
 import {
+	type CodecTree,
 	type ICodecFamily,
 	type ICodecOptions,
 	type IJsonCodec,
@@ -13,11 +14,12 @@ import {
 	makeVersionDispatchingCodec,
 	withSchemaValidation,
 } from "../../codec/index.js";
-import { makeSchemaCodec } from "../schema-index/index.js";
+import { getCodecTreeForSchemaFormat, makeSchemaCodec } from "../schema-index/index.js";
 
 import { EncodedSchemaChange } from "./schemaChangeFormat.js";
 import type { SchemaChange } from "./schemaChangeTypes.js";
 import { SchemaVersion } from "../../core/index.js";
+import type { Brand } from "../../util/index.js";
 
 /**
  * Create a family of schema change codecs.
@@ -31,6 +33,20 @@ export function makeSchemaChangeCodecs(options: ICodecOptions): ICodecFamily<Sch
 	]);
 }
 
+export type SchemaChangeFormatVersion = Brand<
+	SchemaVersion.v1 | SchemaVersion.v2,
+	"SchemaChangeFormatVersion"
+>;
+export function getCodecTreeForSchemaChangeFormat(
+	version: SchemaChangeFormatVersion,
+): CodecTree {
+	return {
+		name: "SchemaChange",
+		version,
+		children: [getCodecTreeForSchemaFormat(version)],
+	};
+}
+
 /**
  * Create a schema change codec.
  * @param options - Specifies common codec options, including which `validator` to use.

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

@@ -6,6 +6,7 @@
 import { fail, unreachableCase } from "@fluidframework/core-utils/internal";
 
 import {
+	type CodecTree,
 	type FluidClientVersion,
 	type ICodecFamily,
 	type ICodecOptions,
@@ -41,6 +42,10 @@ export function clientVersionToSchemaVersion(
 	return SchemaVersion.v1;
 }
 
+export function getCodecTreeForSchemaFormat(version: SchemaVersion): CodecTree {
+	return { name: "Schema", version };
+}
+
 /**
  * Create a schema codec.
  * @param options - Specifies common codec options, including which `validator` to use.

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

@@ -8,6 +8,7 @@ export {
 	makeSchemaCodec,
 	makeSchemaCodecs,
 	clientVersionToSchemaVersion,
+	getCodecTreeForSchemaFormat,
 } from "./codec.js";
 export { Format as FormatV1 } from "./formatV1.js";
 export { Format as FormatV2 } from "./formatV2.js";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tree";
-export const pkgVersion = "2.63.0-358419";
+export const pkgVersion = "2.63.0-359286";

package/src/serializableDomainSchema.ts

@@ -7,13 +7,14 @@ import type { IFluidHandle } from "@fluidframework/core-interfaces";
 
 import {
 	SchemaFactory,
+	SchemaFactoryAlpha,
 	type FixRecursiveArraySchema,
 	type TreeNodeFromImplicitAllowedTypes,
 	type ValidateRecursiveSchema,
 } from "./simple-tree/index.js";
 import type { JsonCompatible } from "./util/index.js";
 
-const sf = new SchemaFactory("com.fluidframework.serializable");
+const sf = new SchemaFactoryAlpha("com.fluidframework.serializable");
 
 /**
  * Utilities for storing {@link FluidSerializableAsTree.Data|Fluid Serializable data} in {@link TreeNode}s.
@@ -23,14 +24,14 @@ const sf = new SchemaFactory("com.fluidframework.serializable");
  * Schema which replicate the Fluid Serializable data model with {@link TreeNode}s.
  *
  * Fluid Serializable data can be imported from the {@link FluidSerializableAsTree.Data|Fluid Serializable format} into this format using {@link (TreeAlpha:interface).importConcise} with the {@link FluidSerializableAsTree.(Tree:variable)} schema.
- * @internal
+ * @alpha
  */
 export namespace FluidSerializableAsTree {
 	/**
 	 * Data which can be serialized by Fluid.
 	 * @remarks
 	 * Can be encoded as a {@link FluidSerializableAsTree.(Tree:type)} using {@link (TreeAlpha:interface).importConcise}.
-	 * @internal
+	 * @alpha
 	 */
 	export type Data = JsonCompatible<IFluidHandle>;
 
@@ -40,7 +41,7 @@ export namespace FluidSerializableAsTree {
 	 * ```typescript
 	 * const tree = TreeAlpha.importConcise(FluidSerializableAsTree.Tree, { example: { nested: true }, value: 5 });
 	 * ```
-	 * @internal
+	 * @alpha
 	 */
 	export const Tree = [
 		() => FluidSerializableObject,
@@ -49,15 +50,15 @@ export namespace FluidSerializableAsTree {
 	] as const;
 
 	/**
-	 * @internal
+	 * @alpha
 	 */
 	export type Tree = TreeNodeFromImplicitAllowedTypes<typeof Tree>;
 
 	/**
 	 * Do not use. Exists only as a workaround for {@link https://github.com/microsoft/TypeScript/issues/59550} and {@link https://github.com/microsoft/rushstack/issues/4429}.
-	 * @system @internal
+	 * @system @alpha
 	 */
-	export const _APIExtractorWorkaroundObjectBase = sf.mapRecursive("object", Tree);
+	export const _APIExtractorWorkaroundObjectBase = sf.recordRecursive("object", Tree);
 
 	/**
 	 * Arbitrary Fluid Serializable object as a {@link TreeNode}.
@@ -74,7 +75,7 @@ export namespace FluidSerializableAsTree {
 	 * ```
 	 * @privateRemarks
 	 * Due to https://github.com/microsoft/TypeScript/issues/61270 this can't be named `Object`.
-	 * @sealed @internal
+	 * @sealed @alpha
 	 */
 	export class FluidSerializableObject extends _APIExtractorWorkaroundObjectBase {}
 	{
@@ -86,7 +87,7 @@ export namespace FluidSerializableAsTree {
 	 * @privateRemarks
 	 * In the past this this had to reference the base type (_APIExtractorWorkaroundArrayBase).
 	 * Testing for this in examples/utils/import-testing now shows it has to reference FluidSerializableAsTree.Array instead.
-	 * @system @internal
+	 * @system @alpha
 	 */
 	export declare type _RecursiveArrayWorkaroundJsonArray = FixRecursiveArraySchema<
 		typeof Array
@@ -94,7 +95,7 @@ export namespace FluidSerializableAsTree {
 
 	/**
 	 * Do not use. Exists only as a workaround for {@link https://github.com/microsoft/TypeScript/issues/59550} and {@link https://github.com/microsoft/rushstack/issues/4429}.
-	 * @system @internal
+	 * @system @alpha
 	 */
 	export const _APIExtractorWorkaroundArrayBase = sf.arrayRecursive("array", Tree);
 
@@ -113,7 +114,7 @@ export namespace FluidSerializableAsTree {
 	 * assert(Tree.is(inner, FluidSerializableAsTree.Array));
 	 * const leaf = inner[0];
 	 * ```
-	 * @sealed @internal
+	 * @sealed @alpha
 	 */
 	export class Array extends _APIExtractorWorkaroundArrayBase {}
 	{

package/src/shared-tree/index.ts

@@ -24,6 +24,7 @@ export {
 	exportSimpleSchema,
 	type SharedTreeKernelView,
 	persistedToSimpleSchema,
+	getCodecTreeForSharedTreeFormat,
 } from "./sharedTree.js";
 
 export {
@@ -60,3 +61,8 @@ export {
 } from "./independentView.js";
 
 export type { SharedTreeChange } from "./sharedTreeChangeTypes.js";
+
+export {
+	getCodecTreeForChangeFormat,
+	type SharedTreeChangeFormatVersion,
+} from "./sharedTreeChangeCodecs.js";