@fluidframework/tree 2.74.0-365691 → 2.74.0

package/src/shared-tree/treeCheckout.ts

@@ -6,7 +6,7 @@
 import { assert, unreachableCase, fail } from "@fluidframework/core-utils/internal";
 import type { IFluidHandle, Listenable } from "@fluidframework/core-interfaces/internal";
 import { createEmitter } from "@fluid-internal/client-utils";
-import type { IIdCompressor } from "@fluidframework/id-compressor";
+import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor";
 import {
 	UsageError,
 	type ITelemetryLoggerExt,
@@ -20,7 +20,6 @@ import {
 	type AnchorSetRootEvents,
 	type ChangeFamily,
 	CommitKind,
-	type CommitMetadata,
 	type DeltaVisitor,
 	type DetachedFieldIndex,
 	type IEditableForest,
@@ -48,6 +47,9 @@ import {
 	type TreeNodeStoredSchema,
 	LeafNodeStoredSchema,
 	diffHistories,
+	type ChangeMetadata,
+	type ChangeEncodingContext,
+	type ReadOnlyDetachedFieldIndex,
 } from "../core/index.js";
 import {
 	type FieldBatchCodec,
@@ -68,7 +70,13 @@ import {
 	type SharedTreeBranchChange,
 	type Transactor,
 } from "../shared-tree-core/index.js";
-import { Breakable, disposeSymbol, getOrCreate, type WithBreakable } from "../util/index.js";
+import {
+	Breakable,
+	disposeSymbol,
+	getOrCreate,
+	type JsonCompatibleReadOnly,
+	type WithBreakable,
+} from "../util/index.js";
 
 import { SharedTreeChangeFamily, hasSchemaChange } from "./sharedTreeChangeFamily.js";
 import type { SharedTreeChange } from "./sharedTreeChangeTypes.js";
@@ -89,6 +97,7 @@ import {
 	type CustomTreeNode,
 } from "../simple-tree/index.js";
 import { getCheckout, SchematizingSimpleTreeView } from "./schematizingTreeView.js";
+import { isStableId } from "@fluidframework/id-compressor/internal";
 
 /**
  * Events for {@link ITreeCheckout}.
@@ -122,7 +131,7 @@ export interface CheckoutEvents {
 	 * @param getRevertible - a function provided that allows users to get a revertible for the change. If not provided,
 	 * this change is not revertible.
 	 */
-	changed(data: CommitMetadata, getRevertible?: RevertibleAlphaFactory): void;
+	changed(data: ChangeMetadata, getRevertible?: RevertibleAlphaFactory): void;
 
 	/**
 	 * Fired when a new branch is created from this checkout.
@@ -406,7 +415,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		private readonly mintRevisionTag: () => RevisionTag,
 		private readonly revisionTagCodec: RevisionTagCodec,
 		private readonly idCompressor: IIdCompressor,
-		public removedRoots: DetachedFieldIndex = makeDetachedFieldIndex(
+		private readonly _removedRoots: DetachedFieldIndex = makeDetachedFieldIndex(
 			"repair",
 			revisionTagCodec,
 			idCompressor,
@@ -421,6 +430,10 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		this.registerForBranchEvents();
 	}
 
+	public get removedRoots(): ReadOnlyDetachedFieldIndex {
+		return this._removedRoots;
+	}
+
 	private registerForBranchEvents(): void {
 		this.#transaction.branch.events.on("afterChange", this.onAfterBranchChange);
 		this.#transaction.activeBranchEvents.on("afterChange", this.onAfterChange);
@@ -441,7 +454,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 			(commits) => {
 				const revision = this.mintRevisionTag();
 				for (const transactionStep of commits) {
-					this.removedRoots.updateMajor(transactionStep.revision, revision);
+					this._removedRoots.updateMajor(transactionStep.revision, revision);
 				}
 
 				const squashedChange = this.changeFamily.rebaser.compose(commits);
@@ -452,12 +465,12 @@ export class TreeCheckout implements ITreeCheckoutFork {
 				const disposeForks = this.disposeForksAfterTransaction
 					? trackForksForDisposal(this)
 					: undefined;
-				// When each transaction is started, take a snapshot of the current state of removed roots
-				const removedRootsSnapshot = this.removedRoots.clone();
+				// When each transaction is started, make a restorable checkpoint of the current state of removed roots
+				const restoreRemovedRoots = this._removedRoots.createCheckpoint();
 				return (result) => {
 					switch (result) {
 						case TransactionResult.Abort:
-							this.removedRoots = removedRootsSnapshot;
+							restoreRemovedRoots();
 							break;
 						case TransactionResult.Commit:
 							if (!this.transaction.isInProgress()) {
@@ -532,7 +545,34 @@ export class TreeCheckout implements ITreeCheckoutFork {
 						};
 
 				let withinEventContext = true;
-				this.#events.emit("changed", { isLocal: true, kind }, getRevertible);
+
+				const metadata: ChangeMetadata = {
+					kind,
+					isLocal: true,
+					getChange: () => {
+						const context: ChangeEncodingContext = {
+							idCompressor: this.idCompressor,
+							originatorId: this.idCompressor.localSessionId,
+							revision,
+						};
+						const encodedChange = this.changeFamily.codecs
+							.resolve(4)
+							.json.encode(change, context);
+
+						assert(
+							commit.parent !== undefined,
+							0xca4 /* Expected applied commit to be parented */,
+						);
+						return {
+							version: 1,
+							revision,
+							originatorId: this.idCompressor.localSessionId,
+							change: encodedChange,
+						} satisfies SerializedChange;
+					},
+				};
+
+				this.#events.emit("changed", metadata, getRevertible);
 				withinEventContext = false;
 			}
 		} else if (this.isRemoteChangeEvent(event)) {
@@ -559,6 +599,28 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		}
 	};
 
+	/**
+	 * Applies the given serialized change (as was produced via a `"changed"` event of another checkout) to this checkout.
+	 */
+	public applySerializedChange(serializedChange: JsonCompatibleReadOnly): void {
+		if (!isSerializedChange(serializedChange)) {
+			throw new UsageError(`Cannot apply change. Invalid serialized change format.`);
+		}
+		const { revision, originatorId, change } = serializedChange;
+		if (originatorId !== this.idCompressor.localSessionId) {
+			throw new UsageError(
+				`Cannot apply change. A serialized changed must be applied to the same SharedTree as it was created from.`,
+			);
+		}
+		const context: ChangeEncodingContext = {
+			idCompressor: this.idCompressor,
+			originatorId: this.idCompressor.localSessionId,
+			revision,
+		};
+		const decodedChange = this.changeFamily.codecs.resolve(4).json.decode(change, context);
+		this.applyChange(decodedChange, revision);
+	}
+
 	// Revision is the revision of the commit, if any, which caused this change.
 	private applyChange(change: SharedTreeChange, revision?: RevisionTag): void {
 		// Conflicts due to schema will be empty and thus are not applied.
@@ -566,7 +628,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 			if (innerChange.type === "data") {
 				const delta = intoDelta(tagChange(innerChange.innerChange, revision));
 				this.withCombinedVisitor((visitor) => {
-					visitDelta(delta, visitor, this.removedRoots, revision);
+					visitDelta(delta, visitor, this._removedRoots, revision);
 				});
 			} else if (innerChange.type === "schema") {
 				// Schema changes from a current to a new schema are expected to be backwards compatible.
@@ -597,14 +659,14 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		this.withCombinedVisitor((visitor) => {
 			revisions.forEach((revision) => {
 				// get all the roots last created or used by the revision
-				const roots = this.removedRoots.getRootsLastTouchedByRevision(revision);
+				const roots = this._removedRoots.getRootsLastTouchedByRevision(revision);
 
 				// get the detached field for the root and delete it from the removed roots
 				for (const root of roots) {
-					visitor.destroy(this.removedRoots.toFieldKey(root), 1);
+					visitor.destroy(this._removedRoots.toFieldKey(root), 1);
 				}
 
-				this.removedRoots.deleteRootsLastTouchedByRevision(revision);
+				this._removedRoots.deleteRootsLastTouchedByRevision(revision);
 			});
 		});
 	};
@@ -774,7 +836,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 			this.mintRevisionTag,
 			this.revisionTagCodec,
 			this.idCompressor,
-			this.removedRoots.clone(),
+			this._removedRoots.clone(),
 			this.logger,
 			this.breaker,
 			this.disposeForksAfterTransaction,
@@ -894,8 +956,8 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		this.assertNoUntrackedRoots();
 		const trees: [string | number | undefined, number, JsonableTree][] = [];
 		const cursor = this.forest.allocateCursor("getRemovedRoots");
-		for (const { id, root } of this.removedRoots.entries()) {
-			const parentField = this.removedRoots.toFieldKey(root);
+		for (const { id, root } of this._removedRoots.entries()) {
+			const parentField = this._removedRoots.toFieldKey(root);
 			this.forest.moveCursorToPath({ parent: undefined, parentField, parentIndex: 0 }, cursor);
 			const tree = jsonableTreeFromCursor(cursor);
 			// This method is used for tree consistency comparison.
@@ -915,7 +977,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	public load(): void {
 		// Set the tip revision as the latest relevant revision for any removed roots that are loaded from a summary - this allows them to be garbage collected later.
 		// When a load happens, the head of the trunk and the head of the local/main branch must be the same (this is enforced by SharedTree).
-		this.removedRoots.setRevisionsForLoadedData(this.#transaction.branch.getHead().revision);
+		this._removedRoots.setRevisionsForLoadedData(this.#transaction.branch.getHead().revision);
 		// The content of the checkout (e.g. the forest) has (maybe) changed, so fire an afterBatch event.
 		this.#events.emit("afterBatch");
 	}
@@ -987,8 +1049,8 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	private assertNoUntrackedRoots(): void {
 		const cursor = this.forest.getCursorAboveDetachedFields();
 		const rootFields = new Set([rootFieldKey]);
-		for (const { root } of this.removedRoots.entries()) {
-			rootFields.add(this.removedRoots.toFieldKey(root));
+		for (const { root } of this._removedRoots.entries()) {
+			rootFields.add(this._removedRoots.toFieldKey(root));
 		}
 
 		if (!cursor.firstField()) {
@@ -1205,3 +1267,24 @@ function verboseFromCursor(
 		fields: fields as CustomTreeNode<IFluidHandle>,
 	};
 }
+
+interface SerializedChange {
+	version: 1;
+	revision: RevisionTag;
+	change: JsonCompatibleReadOnly;
+	originatorId: SessionId;
+}
+
+function isSerializedChange(value: unknown): value is SerializedChange {
+	if (typeof value !== "object" || value === null) {
+		return false;
+	}
+	const change = value as Partial<SerializedChange>;
+	return (
+		change.version === 1 &&
+		(change.revision === "root" || typeof change.revision === "number") &&
+		typeof change.originatorId === "string" &&
+		isStableId(change.originatorId) &&
+		change.change !== undefined
+	);
+}

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

@@ -29,11 +29,11 @@ import type {
 	RevisionTag,
 	SchemaAndPolicy,
 } from "../core/index.js";
-import { brand, type JsonCompatibleReadOnly } from "../util/index.js";
+import { brand, unbrand, type JsonCompatibleReadOnly } from "../util/index.js";
 
 import type { SummaryData } from "./editManager.js";
 import { makeV1CodecWithVersion } from "./editManagerCodecsV1toV4.js";
-import { makeV5CodecWithVersion } from "./editManagerCodecsV5.js";
+import { makeSharedBranchesCodecWithVersion } from "./editManagerCodecsVSharedBranches.js";
 import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
 import {
 	EditManagerFormatVersion,
@@ -70,7 +70,7 @@ export function clientVersionToEditManagerFormatVersion(
 export function editManagerFormatVersionSelectorForSharedBranches(
 	clientVersion: MinimumVersionForCollab,
 ): EditManagerFormatVersion {
-	return brand(EditManagerFormatVersion.v5);
+	return brand(EditManagerFormatVersion.vSharedBranches);
 }
 
 export interface EditManagerCodecOptions {
@@ -134,22 +134,24 @@ export function makeEditManagerCodecs<TChangeset>(
 		>,
 	][] = Array.from(editManagerFormatVersions, (version) => {
 		switch (version) {
-			case EditManagerFormatVersion.v1:
-			case EditManagerFormatVersion.v2:
+			case unbrand(EditManagerFormatVersion.v1):
+			case unbrand(EditManagerFormatVersion.v2):
 				return [version, makeDiscontinuedCodecVersion(options, version, "2.73.0")];
-			case EditManagerFormatVersion.v3:
-			case EditManagerFormatVersion.v4: {
+			case unbrand(EditManagerFormatVersion.v3):
+			case unbrand(EditManagerFormatVersion.v4): {
 				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
 					version,
 					makeV1CodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
-			case EditManagerFormatVersion.v5: {
+			case unbrand(EditManagerFormatVersion.v5):
+				return [version, makeDiscontinuedCodecVersion(options, version, "2.74.0")];
+			case unbrand(EditManagerFormatVersion.vSharedBranches): {
 				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
 					version,
-					makeV5CodecWithVersion(changeCodec, revisionTagCodec, options, version),
+					makeSharedBranchesCodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
 			default:

package/src/shared-tree-core/{editManagerCodecsV5.ts → editManagerCodecsVSharedBranches.ts}

@@ -25,7 +25,7 @@ import {
 } from "../util/index.js";
 
 import type { SharedBranchSummaryData, SummaryData } from "./editManager.js";
-import { EncodedEditManager } from "./editManagerFormatV5.js";
+import { EncodedEditManager } from "./editManagerFormatVSharedBranches.js";
 import { decodeSharedBranch, encodeSharedBranch } from "./editManagerCodecsCommons.js";
 import type { EncodedSharedBranch } from "./editManagerFormatCommons.js";
 import type { BranchId } from "./branch.js";
@@ -35,7 +35,7 @@ export interface EditManagerEncodingContext {
 	readonly schema?: SchemaAndPolicy;
 }
 
-export function makeV5CodecWithVersion<TChangeset>(
+export function makeSharedBranchesCodecWithVersion<TChangeset>(
 	changeCodec: IMultiFormatCodec<
 		TChangeset,
 		JsonCompatibleReadOnly,
@@ -78,7 +78,7 @@ export function makeV5CodecWithVersion<TChangeset>(
 				);
 				assert(
 					data.originator !== undefined,
-					0xc65 /* Cannot encode V5 summary without originator */,
+					0xca5 /* Cannot encode vSharedBranches summary without originator */,
 				);
 				const json: Mutable<EncodedEditManager<TChangeset>> = {
 					main: mainBranch,

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

@@ -12,7 +12,7 @@ import {
 	RevisionTagSchema,
 	SessionIdSchema,
 } from "../core/index.js";
-import { type Brand, brandedNumberType } from "../util/index.js";
+import { type Brand, brandedNumberType, strictEnum, type Values } from "../util/index.js";
 import type { EncodedBranchId } from "./branch.js";
 
 /**
@@ -123,7 +123,7 @@ export const EncodedSharedBranch = <ChangeSchema extends TSchema>(tChange: Chang
 /**
  * The format version for the EditManager.
  */
-export const EditManagerFormatVersion = {
+export const EditManagerFormatVersion = strictEnum("editManager.FormatVersion", {
 	/**
 	 * Introduced and retired prior to 2.0.
 	 * Reading and writing capability removed in 2.73.0.
@@ -136,34 +136,40 @@ export const EditManagerFormatVersion = {
 	v2: 2,
 	/**
 	 * Introduced prior to 2.0 and used beyond.
-	 * Reading capability is currently maintained for backwards compatibility, but it could be removed in the future.
-	 * Writing capability needs to be maintained.
+	 * Reading capability must be maintained for backwards compatibility.
+	 * Writing capability needs to be maintained so long as {@link lowestMinVersionForCollab} is less than 2.2.0.
 	 */
 	v3: 3,
 	/**
-	 * Was inadvertently released in 2.43.0 (through usages of configuredSharedTree) and remains available.
+	 * Introduced in 2.2.0.
+	 * Was inadvertently made usable for writing in 2.43.0 (through configuredSharedTree) and remains available.
 	 * Reading capability must be maintained for backwards compatibility.
-	 * Writing capability needs to be maintained.
-	 * @privateRemarks TODO: stop writing this version.
+	 * Writing capability could be dropped in favor of {@link EditManagerFormatVersion.v3},
+	 * but doing so would make the pattern of writable versions more complex and gain little
+	 * because most of the logic for this format is shared with {@link EditManagerFormatVersion.v3}.
 	 */
 	v4: 4,
+	/**
+	 * This version number was used internally for testing shared branches.
+	 * This format was never made stable.
+	 * This version number is kept here solely to avoid reusing the number: it is not supported for either reading or writing.
+	 * @deprecated Use {@link EditManagerFormatVersion.vSharedBranches} for testing shared branches.
+	 */
+	v5: 5,
 	/**
 	 * Not yet released.
 	 * Only used for testing shared branches.
 	 */
-	v5: 5,
-} as const;
-export type EditManagerFormatVersion = Brand<
-	(typeof EditManagerFormatVersion)[keyof typeof EditManagerFormatVersion],
-	"EditManagerFormatVersion"
->;
+	vSharedBranches: "shared-branches|v0.1",
+});
+export type EditManagerFormatVersion = Values<typeof EditManagerFormatVersion>;
 export const supportedEditManagerFormatVersions: ReadonlySet<EditManagerFormatVersion> =
 	new Set([
 		EditManagerFormatVersion.v3,
 		EditManagerFormatVersion.v4,
-		EditManagerFormatVersion.v5,
-	] as EditManagerFormatVersion[]);
+		EditManagerFormatVersion.vSharedBranches,
+	]);
 export const editManagerFormatVersions: ReadonlySet<EditManagerFormatVersion> = new Set(
-	Object.values(EditManagerFormatVersion) as EditManagerFormatVersion[],
+	Object.values(EditManagerFormatVersion),
 );
 /* eslint-enable @typescript-eslint/explicit-function-return-type */

package/src/shared-tree-core/{editManagerFormatV5.ts → editManagerFormatVSharedBranches.ts}

@@ -15,7 +15,7 @@ const noAdditionalProps: ObjectOptions = { additionalProperties: false };
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
 
 export interface EncodedEditManager<TChangeset> {
-	readonly version: typeof EditManagerFormatVersion.v5;
+	readonly version: typeof EditManagerFormatVersion.vSharedBranches;
 	readonly originator: SessionId;
 	readonly main: EncodedSharedBranch<TChangeset>;
 	readonly branches?: readonly EncodedSharedBranch<TChangeset>[];
@@ -24,7 +24,7 @@ export interface EncodedEditManager<TChangeset> {
 export const EncodedEditManager = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>
 	Type.Object(
 		{
-			version: Type.Union([Type.Literal(EditManagerFormatVersion.v5)]),
+			version: Type.Literal(EditManagerFormatVersion.vSharedBranches),
 			originator: SessionIdSchema,
 			main: EncodedSharedBranch(tChange),
 			branches: Type.Optional(Type.Array(EncodedSharedBranch(tChange))),

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

@@ -9,10 +9,10 @@ import type { IChannelStorageService } from "@fluidframework/datastore-definitio
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 import type {
 	IExperimentalIncrementalSummaryContext,
-	ISummaryTreeWithStats,
 	ITelemetryContext,
+	MinimumVersionForCollab,
 } from "@fluidframework/runtime-definitions/internal";
-import { createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
+import type { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
 
 import type { IJsonCodec } from "../codec/index.js";
 import type { ChangeFamily, ChangeFamilyEditor, SchemaAndPolicy } from "../core/index.js";
@@ -24,16 +24,52 @@ import type {
 	Summarizable,
 	SummaryElementParser,
 	SummaryElementStringifier,
-} from "./sharedTreeCore.js";
+} from "./summaryTypes.js";
+import { VersionedSummarizer } from "./versionedSummarizer.js";
 
-const stringKey = "String";
+export const stringKey = "String";
 
 /**
- * Provides methods for summarizing and loading an `EditManager`
+ * The versions for the edit manager summary format.
  */
-export class EditManagerSummarizer<TChangeset> implements Summarizable {
-	public readonly key = "EditManager";
+export const enum EditManagerSummaryFormatVersion {
+	/**
+	 * This version represents summary format before summary versioning was introduced.
+	 */
+	v1 = 1,
+	/**
+	 * This version adds metadata to the summary. This is backward compatible with version 1.
+	 */
+	v2 = 2,
+	/**
+	 * The latest version of the summary. Must be updated when a new version is added.
+	 */
+	vLatest = v2,
+}
+
+const supportedVersions = new Set<EditManagerSummaryFormatVersion>([
+	EditManagerSummaryFormatVersion.v1,
+	EditManagerSummaryFormatVersion.v2,
+]);
+
+/**
+ * Returns the summary version to use as per the given minimum version for collab.
+ */
+function minVersionToEditManagerSummaryFormatVersion(
+	version: MinimumVersionForCollab,
+): EditManagerSummaryFormatVersion {
+	// Currently, version 2 is written which adds metadata blob to the summary.
+	return EditManagerSummaryFormatVersion.v2;
+}
 
+/**
+ * Provides methods for summarizing and loading an `EditManager`
+ */
+export class EditManagerSummarizer<TChangeset>
+	extends VersionedSummarizer<EditManagerSummaryFormatVersion>
+	implements Summarizable
+{
+	public static readonly key = "EditManager";
 	public constructor(
 		private readonly editManager: EditManager<
 			ChangeFamilyEditor,
@@ -47,30 +83,36 @@ export class EditManagerSummarizer<TChangeset> implements Summarizable {
 			EditManagerEncodingContext
 		>,
 		private readonly idCompressor: IIdCompressor,
+		minVersionForCollab: MinimumVersionForCollab,
 		private readonly schemaAndPolicy?: SchemaAndPolicy,
-	) {}
+	) {
+		super(
+			EditManagerSummarizer.key,
+			minVersionToEditManagerSummaryFormatVersion(minVersionForCollab),
+			supportedVersions,
+			true /* supportPreVersioningFormat */,
+		);
+	}
 
-	public summarize(props: {
+	protected summarizeInternal(props: {
 		stringify: SummaryElementStringifier;
 		fullTree?: boolean;
 		trackState?: boolean;
 		telemetryContext?: ITelemetryContext;
 		incrementalSummaryContext?: IExperimentalIncrementalSummaryContext;
-	}): ISummaryTreeWithStats {
-		return this.summarizeCore(props.stringify);
-	}
-
-	private summarizeCore(stringify: SummaryElementStringifier): ISummaryTreeWithStats {
+		builder: SummaryTreeBuilder;
+	}): void {
+		const { stringify, builder } = props;
 		const context: EditManagerEncodingContext =
 			this.schemaAndPolicy !== undefined
 				? { schema: this.schemaAndPolicy, idCompressor: this.idCompressor }
 				: { idCompressor: this.idCompressor };
 		const jsonCompatible = this.codec.encode(this.editManager.getSummaryData(), context);
 		const dataString = stringify(jsonCompatible);
-		return createSingleBlobSummary(stringKey, dataString);
+		builder.addBlob(stringKey, dataString);
 	}
 
-	public async load(
+	protected async loadInternal(
 		services: IChannelStorageService,
 		parse: SummaryElementParser,
 	): Promise<void> {

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

@@ -23,12 +23,18 @@ export {
 
 export {
 	SharedTreeCore,
-	type Summarizable,
-	type SummaryElementParser,
-	type SummaryElementStringifier,
 	type ClonableSchemaAndPolicy,
 	type SharedTreeCoreOptionsInternal,
 } from "./sharedTreeCore.js";
+export {
+	SharedTreeSummaryFormatVersion,
+	type SharedTreeSummarizableMetadata,
+	type Summarizable,
+	type SummaryElementParser,
+	type SummaryElementStringifier,
+	summarizablesMetadataKey,
+} from "./summaryTypes.js";
+export { VersionedSummarizer } from "./versionedSummarizer.js";
 
 export type { ResubmitMachine } from "./resubmitMachine.js";
 export { DefaultResubmitMachine } from "./defaultResubmitMachine.js";
@@ -65,10 +71,13 @@ export type {
 	EncodedCommit,
 } from "./editManagerFormatCommons.js";
 
+export type { DecodedMessage } from "./messageTypes.js";
 export {
 	getCodecTreeForMessageFormatWithChange,
 	clientVersionToMessageFormatVersion,
 	messageFormatVersionSelectorForSharedBranches,
+	makeMessageCodec,
+	type MessageEncodingContext,
 } from "./messageCodecs.js";
 export {
 	MessageFormatVersion,

package/src/shared-tree-core/{messageCodecV5.ts → messageCodecVSharedBranches.ts}

@@ -14,14 +14,14 @@ import type {
 } from "../core/index.js";
 import type { JsonCompatibleReadOnly } from "../util/index.js";
 
-import { Message } from "./messageFormatV5.js";
+import { Message } from "./messageFormatVSharedBranches.js";
 import type { DecodedMessage } from "./messageTypes.js";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import type { MessageEncodingContext } from "./messageCodecs.js";
 import { decodeBranchId, encodeBranchId } from "./branchIdCodec.js";
 import type { MessageFormatVersion } from "./messageFormat.js";
 
-export function makeV5CodecWithVersion<TChangeset>(
+export function makeSharedBranchesCodecWithVersion<TChangeset>(
 	changeCodec: ChangeFamilyCodec<TChangeset>,
 	revisionTagCodec: IJsonCodec<
 		RevisionTag,
@@ -30,7 +30,7 @@ export function makeV5CodecWithVersion<TChangeset>(
 		ChangeEncodingContext
 	>,
 	options: ICodecOptions,
-	version: typeof MessageFormatVersion.v5,
+	version: typeof MessageFormatVersion.vSharedBranches,
 ): IJsonCodec<
 	DecodedMessage<TChangeset>,
 	JsonCompatibleReadOnly,

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

@@ -29,12 +29,12 @@ import type {
 	RevisionTag,
 	SchemaAndPolicy,
 } from "../core/index.js";
-import { brand, type JsonCompatibleReadOnly } from "../util/index.js";
+import { brand, unbrand, type JsonCompatibleReadOnly } from "../util/index.js";
 
 import type { DecodedMessage } from "./messageTypes.js";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 import { makeV1ToV4CodecWithVersion } from "./messageCodecV1ToV4.js";
-import { makeV5CodecWithVersion } from "./messageCodecV5.js";
+import { makeSharedBranchesCodecWithVersion } from "./messageCodecVSharedBranches.js";
 import { MessageFormatVersion, messageFormatVersions } from "./messageFormat.js";
 
 export interface MessageEncodingContext {
@@ -79,7 +79,7 @@ function messageFormatVersionFromOptions(
 export function messageFormatVersionSelectorForSharedBranches(
 	clientVersion: MinimumVersionForCollab,
 ): MessageFormatVersion {
-	return brand(MessageFormatVersion.v5);
+	return brand(MessageFormatVersion.vSharedBranches);
 }
 
 export function makeMessageCodec<TChangeset>(
@@ -132,18 +132,18 @@ export function makeMessageCodecs<TChangeset>(
 		>,
 	][] = Array.from(messageFormatVersions).map((version) => {
 		switch (version) {
-			case MessageFormatVersion.undefined:
-			case MessageFormatVersion.v1:
-			case MessageFormatVersion.v2: {
+			case unbrand(MessageFormatVersion.undefined):
+			case unbrand(MessageFormatVersion.v1):
+			case unbrand(MessageFormatVersion.v2): {
 				const versionOrUndefined =
-					version === MessageFormatVersion.undefined ? undefined : version;
+					version === unbrand(MessageFormatVersion.undefined) ? undefined : version;
 				return [
 					versionOrUndefined,
 					makeDiscontinuedCodecVersion(options, versionOrUndefined, "2.73.0"),
 				];
 			}
-			case MessageFormatVersion.v3:
-			case MessageFormatVersion.v4: {
+			case unbrand(MessageFormatVersion.v3):
+			case unbrand(MessageFormatVersion.v4): {
 				const changeCodec = changeCodecs.resolve(
 					dependentChangeFormatVersion.lookup(version),
 				).json;
@@ -152,13 +152,15 @@ export function makeMessageCodecs<TChangeset>(
 					makeV1ToV4CodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
-			case MessageFormatVersion.v5: {
+			case unbrand(MessageFormatVersion.v5):
+				return [version, makeDiscontinuedCodecVersion(options, version, "2.74.0")];
+			case unbrand(MessageFormatVersion.vSharedBranches): {
 				const changeCodec = changeCodecs.resolve(
 					dependentChangeFormatVersion.lookup(version),
 				).json;
 				return [
 					version,
-					makeV5CodecWithVersion(changeCodec, revisionTagCodec, options, version),
+					makeSharedBranchesCodecWithVersion(changeCodec, revisionTagCodec, options, version),
 				];
 			}
 			default: