@fluidframework/tree 2.80.0 → 2.81.0-374083

package/src/shared-tree/treeCheckout.ts

@@ -50,21 +50,29 @@ import {
 	type TreeNodeSchemaIdentifier,
 	type TreeNodeStoredSchema,
 	LeafNodeStoredSchema,
+	type ChangeAtomId,
+	offsetChangeAtomId,
 	diffHistories,
 	type ChangeMetadata,
 	type ChangeEncodingContext,
 	type ReadOnlyDetachedFieldIndex,
 } from "../core/index.js";
 import {
+	type DetachedRootIds,
+	type DetachedRootLocation,
+	type DetachedRootsLocation,
 	type FieldBatchCodec,
+	type Locator,
 	type TreeCompressionStrategy,
 	allowsRepoSuperset,
 	buildForest,
+	changeAtomFromDetachedNodeId,
 	createNodeIdentifierManager,
 	defaultSchemaPolicy,
 	intoDelta,
 	jsonableTreeFromCursor,
 	makeFieldBatchCodec,
+	nodeIdFromChangeAtom,
 } from "../feature-libraries/index.js";
 import {
 	SquashingTransactionStack,
@@ -78,13 +86,19 @@ import {
 	Breakable,
 	disposeSymbol,
 	getOrCreate,
+	makeArray,
 	type JsonCompatibleReadOnly,
 	type WithBreakable,
 } from "../util/index.js";
 
 import { SharedTreeChangeFamily, hasSchemaChange } from "./sharedTreeChangeFamily.js";
 import type { SharedTreeChange } from "./sharedTreeChangeTypes.js";
-import type { ISharedTreeEditor, SharedTreeEditBuilder } from "./sharedTreeEditBuilder.js";
+import {
+	type IdBasedSharedTreeEditBuilder,
+	type ILocationBasedSharedTreeEditor,
+	type IIdBasedSharedTreeEditor,
+	LocationBasedSharedTreeEditBuilder,
+} from "./sharedTreeEditBuilder.js";
 import type { IDisposable } from "@fluidframework/core-interfaces";
 import {
 	type ImplicitFieldSchema,
@@ -132,8 +146,6 @@ export interface CheckoutEvents {
 	 * can use to filter on changes they care about e.g. local vs remote changes.
 	 *
 	 * @param data - information about the change
-	 * @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: ChangeMetadata, getRevertible?: RevertibleAlphaFactory): void;
 
@@ -236,7 +248,7 @@ export interface ITreeCheckout extends AnchorLocator, ViewableTree, WithBreakabl
 	 * Used to edit the state of the tree. Edits will be immediately applied locally to the tree.
 	 * If there is no transaction currently ongoing, then the edits will be submitted to Fluid immediately as well.
 	 */
-	readonly editor: ISharedTreeEditor;
+	readonly editor: ILocationBasedSharedTreeEditor;
 
 	/**
 	 * A collection of functions for managing transactions.
@@ -294,8 +306,8 @@ export function createTreeCheckout(
 	mintRevisionTag: () => RevisionTag,
 	revisionTagCodec: RevisionTagCodec,
 	args?: {
-		branch?: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>;
-		changeFamily?: ChangeFamily<SharedTreeEditBuilder, SharedTreeChange>;
+		branch?: SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>;
+		changeFamily?: ChangeFamily<IdBasedSharedTreeEditBuilder, SharedTreeChange>;
 		schema?: TreeStoredSchemaRepository;
 		forest?: IEditableForest;
 		fieldBatchCodec?: FieldBatchCodec;
@@ -384,6 +396,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	public disposed = false;
 
 	private editLock: EditLock;
+	private readonly locator: Locator;
 
 	private readonly views = new Set<TreeView<ImplicitFieldSchema>>();
 
@@ -399,7 +412,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	 */
 	private readonly revertibleCommitBranches = new Map<
 		RevisionTag,
-		SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>
+		SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>
 	>();
 
 	/**
@@ -412,10 +425,13 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	public events: Listenable<CheckoutEvents> = this.#events;
 
 	public constructor(
-		branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>,
+		branch: SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>,
 		/** True if and only if this checkout is for a branch which is persisted and shared with other clients. */
 		public readonly isSharedBranch: boolean,
-		private readonly changeFamily: ChangeFamily<SharedTreeEditBuilder, SharedTreeChange>,
+		private readonly changeFamily: ChangeFamily<
+			IdBasedSharedTreeEditBuilder,
+			SharedTreeChange
+		>,
 		public readonly storedSchema: TreeStoredSchemaRepository,
 		public readonly forest: IEditableForest,
 		private readonly mintRevisionTag: () => RevisionTag,
@@ -433,6 +449,31 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	) {
 		this.#transaction = this.createTransactionStack(branch);
 		this.editLock = new EditLock(this.#transaction.activeBranchEditor);
+		this.locator = {
+			locationFromId: (id: ChangeAtomId): DetachedRootLocation => {
+				const rootId = this.removedRoots.getEntry(nodeIdFromChangeAtom(id));
+				return this.removedRoots.toFieldKey(rootId);
+			},
+			idFromLocation: (location: DetachedRootLocation): ChangeAtomId => {
+				const nodeId = this.removedRoots.fromFieldKey(location);
+				return changeAtomFromDetachedNodeId(nodeId);
+			},
+			locationsFromIdRanges: (ids: DetachedRootIds): DetachedRootsLocation => {
+				return ids.flatMap((id) => {
+					return makeArray(id.count, (offset) => {
+						const field = this.locator.locationFromId(offsetChangeAtomId(id.first, offset));
+						return { field, count: 1 };
+					});
+				});
+			},
+			idRangesFromLocations: (ids: DetachedRootsLocation): DetachedRootIds => {
+				return ids.map((id) => {
+					assert(id.count === 1, "Expected count of 1");
+					const first = this.locator.idFromLocation(id.field);
+					return { first, count: id.count };
+				});
+			},
+		};
 		this.registerForBranchEvents();
 	}
 
@@ -453,8 +494,8 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	}
 
 	private createTransactionStack(
-		branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>,
-	): SquashingTransactionStack<SharedTreeEditBuilder, SharedTreeChange> {
+		branch: SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>,
+	): SquashingTransactionStack<IdBasedSharedTreeEditBuilder, SharedTreeChange> {
 		return new SquashingTransactionStack(branch, this.mintRevisionTag, () => {
 			const disposeForks = this.disposeForksAfterTransaction
 				? trackForksForDisposal(this)
@@ -566,6 +607,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 							change: encodedChange,
 						} satisfies SerializedChange;
 					},
+					getRevertible: (onDisposed) => getRevertible?.(onDisposed),
 				};
 
 				this.#events.emit("changed", metadata, getRevertible);
@@ -591,7 +633,9 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		this.#events.emit("afterBatch");
 		this.editLock.unlock();
 		if (event.type === "append") {
-			event.newCommits.forEach((commit) => this.validateCommit(commit));
+			for (const commit of event.newCommits) {
+				this.validateCommit(commit);
+			}
 		}
 	};
 
@@ -653,7 +697,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		// When the branch is trimmed, we can garbage collect any repair data whose latest relevant revision is one of the
 		// trimmed revisions.
 		this.withCombinedVisitor((visitor) => {
-			revisions.forEach((revision) => {
+			for (const revision of revisions) {
 				// get all the roots last created or used by the revision
 				const roots = this._removedRoots.getRootsLastTouchedByRevision(revision);
 
@@ -663,7 +707,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 				}
 
 				this._removedRoots.deleteRootsLastTouchedByRevision(revision);
-			});
+			}
 		});
 	};
 
@@ -789,9 +833,9 @@ export class TreeCheckout implements ITreeCheckoutFork {
 		return this.forest.anchors.events;
 	}
 
-	public get editor(): ISharedTreeEditor {
+	public get editor(): ILocationBasedSharedTreeEditor {
 		this.checkNotDisposed();
-		return this.editLock.editor;
+		return new LocationBasedSharedTreeEditBuilder(this.editLock.editor, this.locator);
 	}
 
 	public locate(anchor: Anchor): AnchorNode | undefined {
@@ -812,18 +856,19 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	 * To avoid updating observers of the view state with intermediate results during a transaction,
 	 * use {@link ITreeCheckout#branch} and {@link ISharedTreeFork#merge}.
 	 */
-	#transaction: SquashingTransactionStack<SharedTreeEditBuilder, SharedTreeChange>;
+	#transaction: SquashingTransactionStack<IdBasedSharedTreeEditBuilder, SharedTreeChange>;
 
 	public branch(): TreeCheckout {
 		this.checkNotDisposed(
 			"The parent branch has already been disposed and can no longer create new branches.",
 		);
+		this.editLock.checkUnlocked("Branching");
+
 		// Branching after an unfinished transaction would expose the application to a state where its invariants may be violated.
 		if (this.transaction.isInProgress()) {
 			throw new UsageError("A view cannot be forked while it has a pending transaction.");
 		}
 
-		this.editLock.checkUnlocked("Branching");
 		const anchors = new AnchorSet();
 		const branch = this.#transaction.activeBranch.fork();
 		const storedSchema = this.storedSchema.clone();
@@ -847,7 +892,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	}
 
 	public switchBranch(
-		branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>,
+		branch: SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>,
 	): void {
 		// TODO: Dispose old branch, if necessary
 		assert(
@@ -1126,7 +1171,9 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	private validateCommit(commit: GraphCommit<SharedTreeChange>): void {
 		const validated = getOrCreate(this.#validatedCommits, commit, () => []);
 		if (validated !== true) {
-			validated.forEach((fn) => fn(commit));
+			for (const fn of validated) {
+				fn(commit);
+			}
 			this.#validatedCommits.set(commit, true);
 		}
 	}
@@ -1142,19 +1189,23 @@ class EditLock {
 	 * Edits the tree by calling the methods of the editor passed into the {@link EditLock} constructor.
 	 * @remarks Edits will throw an error if the lock is currently locked.
 	 */
-	public readonly editor: ISharedTreeEditor;
+	public readonly editor: IIdBasedSharedTreeEditor;
 	private locked = false;
 
 	/**
 	 * @param editor - an editor which will be used to create a new editor that is monitored to determine if any changes are happening to the tree.
 	 * Use {@link EditLock.editor} in place of the original editor to ensure that changes are monitored.
 	 */
-	public constructor(editor: ISharedTreeEditor) {
+	public constructor(editor: IIdBasedSharedTreeEditor) {
 		const checkLock = (): void => this.checkUnlocked("Editing the tree");
 		this.editor = {
 			get schema() {
 				return editor.schema;
 			},
+			buildRoots(unhydrated) {
+				checkLock();
+				return editor.buildRoots(unhydrated);
+			},
 			valueField(...fieldArgs) {
 				const valueField = editor.valueField(...fieldArgs);
 				return {
@@ -1162,6 +1213,10 @@ class EditLock {
 						checkLock();
 						valueField.set(...editArgs);
 					},
+					attach(...editArgs) {
+						checkLock();
+						valueField.attach(...editArgs);
+					},
 				};
 			},
 			optionalField(...fieldArgs) {
@@ -1171,6 +1226,14 @@ class EditLock {
 						checkLock();
 						optionalField.set(...editArgs);
 					},
+					attach(...editArgs) {
+						checkLock();
+						optionalField.attach(...editArgs);
+					},
+					clear(...editArgs) {
+						checkLock();
+						optionalField.clear(...editArgs);
+					},
 				};
 			},
 			sequenceField(...fieldArgs) {
@@ -1180,6 +1243,10 @@ class EditLock {
 						checkLock();
 						sequenceField.insert(...editArgs);
 					},
+					attach(...editArgs) {
+						checkLock();
+						sequenceField.attach(...editArgs);
+					},
 					remove(...editArgs) {
 						checkLock();
 						sequenceField.remove(...editArgs);
@@ -1260,8 +1327,12 @@ function trackForksForDisposal(checkout: TreeCheckout): () => void {
 	let disposed = false;
 	return () => {
 		assert(!disposed, 0xaa9 /* Forks may only be disposed once */);
-		forks.forEach((fork) => fork.dispose());
-		onDisposeUnSubscribes.forEach((unsubscribe) => unsubscribe());
+		for (const fork of forks) {
+			fork.dispose();
+		}
+		for (const unsubscribe of onDisposeUnSubscribes) {
+			unsubscribe();
+		}
 		onForkUnSubscribe();
 		disposed = true;
 	};

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

@@ -22,6 +22,7 @@ import {
 	rebaseBranch,
 	tagRollbackInverse,
 	type RebaseStatsWithDuration,
+	type EditorOptions,
 } from "../core/index.js";
 import { hasSome, defineLazyCachedProperty } from "../util/index.js";
 import type {
@@ -129,9 +130,12 @@ export class SharedTreeBranch<TEditor extends ChangeFamilyEditor, TChange> {
 		private readonly telemetryEventBatcher?: TelemetryEventBatcher<
 			keyof RebaseStatsWithDuration
 		>,
+		private readonly editorOptions?: EditorOptions,
 	) {
-		this.editor = this.changeFamily.buildEditor(mintRevisionTag, (change) =>
-			this.apply(change),
+		this.editor = this.changeFamily.buildEditor(
+			mintRevisionTag,
+			(change) => this.apply(change),
+			this.editorOptions,
 		);
 		this.unsubscribeBranchTrimmer = branchTrimmer?.on("ancestryTrimmed", (commit) => {
 			this.#events.emit("ancestryTrimmed", commit);
@@ -201,6 +205,8 @@ export class SharedTreeBranch<TEditor extends ChangeFamilyEditor, TChange> {
 			this.changeFamily,
 			mintRevisionTag,
 			this.branchTrimmer,
+			undefined,
+			this.editorOptions,
 		);
 		this.#events.emit("fork", fork);
 		return fork;
@@ -400,5 +406,9 @@ export function onForkTransitive<T extends { events: Listenable<{ fork(t: T): vo
 			onFork(fork);
 		}),
 	);
-	return () => offs.forEach((off) => off());
+	return () => {
+		for (const off of offs) {
+			off();
+		}
+	};
 }

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

@@ -18,6 +18,7 @@ import {
 	mintCommit,
 	type RebaseStatsWithDuration,
 	tagChange,
+	type EditorOptions,
 } from "../core/index.js";
 import { type Mutable, brand, getOrCreate, mapIterable } from "../util/index.js";
 
@@ -123,6 +124,7 @@ export class EditManager<
 		public readonly localSessionId: SessionId,
 		private readonly mintRevisionTag: () => RevisionTag,
 		private readonly onSharedBranchCreated?: (branchId: BranchId) => void,
+		editorOptions?: EditorOptions,
 		logger?: ITelemetryLoggerExt,
 	) {
 		this.trunkBase = {
@@ -147,9 +149,10 @@ export class EditManager<
 			mintRevisionTag,
 			this._events,
 			this.telemetryEventBatcher,
+			editorOptions,
 		);
 
-		this.createAndAddSharedBranch("main", undefined, undefined, mainTrunk);
+		this.createAndAddSharedBranch("main", undefined, undefined, mainTrunk, editorOptions);
 	}
 
 	public getLocalBranch(branchId: BranchId): SharedTreeBranch<TEditor, TChangeset> {
@@ -480,8 +483,15 @@ export class EditManager<
 		sessionId: SessionId | undefined,
 		parent: SharedBranch<TEditor, TChangeset> | undefined,
 		branch: SharedTreeBranch<TEditor, TChangeset>,
+		editorOptions?: EditorOptions,
 	): SharedBranch<TEditor, TChangeset> {
-		const sharedBranch = this.createSharedBranch(branchId, sessionId, parent, branch);
+		const sharedBranch = this.createSharedBranch(
+			branchId,
+			sessionId,
+			parent,
+			branch,
+			editorOptions,
+		);
 		this.addSharedBranch(branchId, sharedBranch);
 		return sharedBranch;
 	}
@@ -512,6 +522,7 @@ export class EditManager<
 		sessionId: SessionId | undefined,
 		parent: SharedBranch<TEditor, TChangeset> | undefined,
 		branch: SharedTreeBranch<TEditor, TChangeset>,
+		editorOptions?: EditorOptions,
 	): SharedBranch<TEditor, TChangeset> {
 		const sharedBranch = new SharedBranch(
 			parent,
@@ -523,6 +534,7 @@ export class EditManager<
 			this.mintRevisionTag,
 			this._events,
 			this.telemetryEventBatcher,
+			editorOptions,
 		);
 
 		return sharedBranch;
@@ -695,6 +707,7 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 		private readonly mintRevisionTag: () => RevisionTag,
 		branchTrimmer: Listenable<BranchTrimmingEvents>,
 		telemetryEventBatcher: TelemetryEventBatcher<keyof RebaseStatsWithDuration> | undefined,
+		editorOptions?: EditorOptions,
 	) {
 		this.localBranch = new SharedTreeBranch(
 			this.trunk.getHead(),
@@ -702,6 +715,7 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 			mintRevisionTag,
 			branchTrimmer,
 			telemetryEventBatcher,
+			editorOptions,
 		);
 
 		this.sequenceIdToCommit.set(baseCommitSequenceId, this.trunk.getHead());
@@ -1090,27 +1104,27 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 		const parentTrunkBase =
 			trunkRevisionCache.get(data.base ?? rootRevision) ??
 			fail(0xc61 /* Expected base revision to be in trunk cache */);
-		this.trunk.setHead(
-			data.trunk.reduce((base, c) => {
-				const sequenceId: SequenceId =
-					c.indexInBatch === undefined
-						? {
-								sequenceNumber: c.sequenceNumber,
-							}
-						: {
-								sequenceNumber: c.sequenceNumber,
-								indexInBatch: c.indexInBatch,
-							};
-				const commit = mintCommit(base, c);
-				this.sequenceIdToCommit.set(sequenceId, commit);
-				this.commitMetadata.set(c.revision, {
-					sequenceId,
-					sessionId: c.sessionId,
-				});
-				trunkRevisionCache.set(c.revision, commit);
-				return commit;
-			}, parentTrunkBase),
-		);
+		let trunkHead = parentTrunkBase;
+		for (const c of data.trunk) {
+			const sequenceId: SequenceId =
+				c.indexInBatch === undefined
+					? {
+							sequenceNumber: c.sequenceNumber,
+						}
+					: {
+							sequenceNumber: c.sequenceNumber,
+							indexInBatch: c.indexInBatch,
+						};
+			const commit = mintCommit(trunkHead, c);
+			this.sequenceIdToCommit.set(sequenceId, commit);
+			this.commitMetadata.set(c.revision, {
+				sequenceId,
+				sessionId: c.sessionId,
+			});
+			trunkRevisionCache.set(c.revision, commit);
+			trunkHead = commit;
+		}
+		this.trunk.setHead(trunkHead);
 
 		this.localBranch.setHead(this.trunk.getHead());
 
@@ -1119,13 +1133,13 @@ class SharedBranch<TEditor extends ChangeFamilyEditor, TChangeset> {
 				trunkRevisionCache.get(branch.base) ??
 				fail(0xad7 /* Expected summary branch to be based off of a revision in the trunk */);
 
+			let branchHead = commit;
+			for (const c of branch.commits) {
+				branchHead = mintCommit(branchHead, c);
+			}
 			this.peerLocalBranches.set(
 				sessionId,
-				new SharedTreeBranch(
-					branch.commits.reduce(mintCommit, commit),
-					this.changeFamily,
-					this.mintRevisionTag,
-				),
+				new SharedTreeBranch(branchHead, this.changeFamily, this.mintRevisionTag),
 			);
 		}
 	}

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

@@ -74,6 +74,15 @@ export function editManagerFormatVersionSelectorForSharedBranches(
 	return brand(EditManagerFormatVersion.vSharedBranches);
 }
 
+/**
+ * Returns the version that should be used for testing shared branches.
+ */
+export function editManagerFormatVersionSelectorForDetachedRootEditing(
+	clientVersion: MinimumVersionForCollab,
+): EditManagerFormatVersion {
+	return brand(EditManagerFormatVersion.vDetachedRoots);
+}
+
 export interface EditManagerCodecOptions {
 	readonly editManagerFormatSelector?: (
 		minVersionForCollab: MinimumVersionForCollab,
@@ -141,7 +150,8 @@ export function makeEditManagerCodecs<TChangeset>(
 			}
 			case unbrand(EditManagerFormatVersion.v3):
 			case unbrand(EditManagerFormatVersion.v4):
-			case unbrand(EditManagerFormatVersion.v6): {
+			case unbrand(EditManagerFormatVersion.v6):
+			case unbrand(EditManagerFormatVersion.vDetachedRoots): {
 				const changeCodec = changeCodecs.resolve(dependentChangeFormatVersion.lookup(version));
 				return [
 					version,

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

@@ -166,6 +166,11 @@ export const EditManagerFormatVersion = strictEnum("editManager.FormatVersion",
 	 * Only used for testing shared branches.
 	 */
 	vSharedBranches: "shared-branches|v0.1",
+	/**
+	 * Not yet released.
+	 * Only used for testing detached roots.
+	 */
+	vDetachedRoots: "detached-roots|v0.1",
 });
 export type EditManagerFormatVersion = Values<typeof EditManagerFormatVersion>;
 export const supportedEditManagerFormatVersions: ReadonlySet<EditManagerFormatVersion> =
@@ -174,6 +179,7 @@ export const supportedEditManagerFormatVersions: ReadonlySet<EditManagerFormatVe
 		EditManagerFormatVersion.v4,
 		EditManagerFormatVersion.v6,
 		EditManagerFormatVersion.vSharedBranches,
+		EditManagerFormatVersion.vDetachedRoots,
 	]);
 export const editManagerFormatVersions: ReadonlySet<EditManagerFormatVersion> = new Set(
 	Object.values(EditManagerFormatVersion),

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

@@ -27,7 +27,8 @@ export interface EncodedEditManager<TChangeset> {
 		| typeof EditManagerFormatVersion.v2
 		| typeof EditManagerFormatVersion.v3
 		| typeof EditManagerFormatVersion.v4
-		| typeof EditManagerFormatVersion.v6;
+		| typeof EditManagerFormatVersion.v6
+		| typeof EditManagerFormatVersion.vDetachedRoots;
 }
 
 export const EncodedEditManager = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>
@@ -39,6 +40,7 @@ export const EncodedEditManager = <ChangeSchema extends TSchema>(tChange: Change
 				Type.Literal(EditManagerFormatVersion.v3),
 				Type.Literal(EditManagerFormatVersion.v4),
 				Type.Literal(EditManagerFormatVersion.v6),
+				Type.Literal(EditManagerFormatVersion.vDetachedRoots),
 			]),
 			trunk: Type.Array(SequencedCommit(tChange)),
 			branches: Type.Array(Type.Tuple([SessionIdSchema, SummarySessionBranch(tChange)])),

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

@@ -51,6 +51,7 @@ export {
 	type EditManagerCodecOptions,
 	clientVersionToEditManagerFormatVersion,
 	editManagerFormatVersionSelectorForSharedBranches,
+	editManagerFormatVersionSelectorForDetachedRootEditing,
 } from "./editManagerCodecs.js";
 export {
 	EditManagerFormatVersion,
@@ -76,6 +77,7 @@ export {
 	getCodecTreeForMessageFormatWithChange,
 	clientVersionToMessageFormatVersion,
 	messageFormatVersionSelectorForSharedBranches,
+	messageFormatVersionSelectorForDetachedRootEditing,
 	makeMessageCodec,
 	type MessageEncodingContext,
 } from "./messageCodecs.js";

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

@@ -34,7 +34,8 @@ export function makeV1ToV4CodecWithVersion<TChangeset>(
 		| typeof MessageFormatVersion.v2
 		| typeof MessageFormatVersion.v3
 		| typeof MessageFormatVersion.v4
-		| typeof MessageFormatVersion.v6,
+		| typeof MessageFormatVersion.v6
+		| typeof MessageFormatVersion.vDetachedRoots,
 ): IJsonCodec<
 	DecodedMessage<TChangeset>,
 	JsonCompatibleReadOnly,

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

@@ -83,6 +83,15 @@ export function messageFormatVersionSelectorForSharedBranches(
 	return brand(MessageFormatVersion.vSharedBranches);
 }
 
+/**
+ * Returns the version that should be used for testing detached root editing.
+ */
+export function messageFormatVersionSelectorForDetachedRootEditing(
+	clientVersion: MinimumVersionForCollab,
+): MessageFormatVersion {
+	return brand(MessageFormatVersion.vDetachedRoots);
+}
+
 export function makeMessageCodec<TChangeset>(
 	changeCodecs: ICodecFamily<TChangeset, ChangeEncodingContext>,
 	dependentChangeFormatVersion: DependentFormatVersion<MessageFormatVersion>,
@@ -145,7 +154,8 @@ export function makeMessageCodecs<TChangeset>(
 			}
 			case unbrand(MessageFormatVersion.v3):
 			case unbrand(MessageFormatVersion.v4):
-			case unbrand(MessageFormatVersion.v6): {
+			case unbrand(MessageFormatVersion.v6):
+			case unbrand(MessageFormatVersion.vDetachedRoots): {
 				const changeCodec = changeCodecs.resolve(
 					dependentChangeFormatVersion.lookup(version),
 				).json;

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

@@ -57,6 +57,11 @@ export const MessageFormatVersion = strictEnum("MessageFormatVersion", {
 	 * Only used for testing shared branches.
 	 */
 	vSharedBranches: "shared-branches|v0.1",
+	/**
+	 * Not yet released.
+	 * Only used for testing detached roots.
+	 */
+	vDetachedRoots: "detached-roots|v0.1",
 });
 export type MessageFormatVersion = Values<typeof MessageFormatVersion>;
 export const supportedMessageFormatVersions: ReadonlySet<MessageFormatVersion> = new Set([
@@ -64,6 +69,7 @@ export const supportedMessageFormatVersions: ReadonlySet<MessageFormatVersion> =
 	MessageFormatVersion.v4,
 	MessageFormatVersion.v6,
 	MessageFormatVersion.vSharedBranches,
+	MessageFormatVersion.vDetachedRoots,
 ]);
 export const messageFormatVersions: ReadonlySet<MessageFormatVersion> = new Set(
 	Object.values(MessageFormatVersion),

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

@@ -38,7 +38,8 @@ export interface Message {
 		| typeof MessageFormatVersion.v2
 		| typeof MessageFormatVersion.v3
 		| typeof MessageFormatVersion.v4
-		| typeof MessageFormatVersion.v6;
+		| typeof MessageFormatVersion.v6
+		| typeof MessageFormatVersion.vDetachedRoots;
 }
 
 // Return type is intentionally derived.
@@ -55,6 +56,7 @@ export const Message = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>
 				Type.Literal(MessageFormatVersion.v3),
 				Type.Literal(MessageFormatVersion.v4),
 				Type.Literal(MessageFormatVersion.v6),
+				Type.Literal(MessageFormatVersion.vDetachedRoots),
 			]),
 		),
 	});

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

@@ -80,7 +80,9 @@ export interface ClonableSchemaAndPolicy extends SchemaAndPolicy {
 export interface SharedTreeCoreOptionsInternal
 	extends CodecWriteOptions,
 		EditManagerCodecOptions,
-		MessageCodecOptions {}
+		MessageCodecOptions {
+	canMakeDetachedRootEdits: boolean;
+}
 
 /**
  * Generic shared tree, which needs to be configured with indexes, field kinds and other configuration.
@@ -176,6 +178,7 @@ export class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange>
 			localSessionId,
 			this.mintRevisionTag,
 			(branchId) => this.registerSharedBranch(branchId),
+			options,
 			rebaseLogger,
 		);