@fluidframework/tree 2.73.0 → 2.74.0-368706

package/lib/shared-tree/treeCheckout.d.ts

@@ -5,12 +5,12 @@
 import type { Listenable } from "@fluidframework/core-interfaces/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
 import { type ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
-import { type Anchor, type AnchorLocator, type AnchorNode, type AnchorSetRootEvents, type ChangeFamily, type CommitMetadata, type DetachedFieldIndex, type IEditableForest, type IForestSubscription, type JsonableTree, type RevisionTag, type RevisionTagCodec, type TreeStoredSchema, TreeStoredSchemaRepository, type TreeStoredSchemaSubscription, type RevertibleAlphaFactory, type GraphCommit } from "../core/index.js";
-import { type FieldBatchCodec, type TreeCompressionStrategyPrivate } from "../feature-libraries/index.js";
+import { type Anchor, type AnchorLocator, type AnchorNode, type AnchorSetRootEvents, type ChangeFamily, type CommitMetadata, type DetachedFieldIndex, type IEditableForest, type IForestSubscription, type JsonableTree, type RevisionTag, type RevisionTagCodec, type TreeStoredSchema, TreeStoredSchemaRepository, type TreeStoredSchemaSubscription, type RevertibleAlphaFactory, type GraphCommit, type ReadOnlyDetachedFieldIndex } from "../core/index.js";
+import { type FieldBatchCodec, type TreeCompressionStrategy } from "../feature-libraries/index.js";
 import { SharedTreeBranch, type SharedTreeBranchChange, type Transactor } from "../shared-tree-core/index.js";
 import { Breakable, disposeSymbol, type WithBreakable } from "../util/index.js";
 import type { SharedTreeChange } from "./sharedTreeChangeTypes.js";
-import type { ISharedTreeEditor, SharedTreeEditBuilder } from "./sharedTreeEditBuilder.js";
+import { type IdBasedSharedTreeEditBuilder, type ILocationBasedSharedTreeEditor } from "./sharedTreeEditBuilder.js";
 import type { IDisposable } from "@fluidframework/core-interfaces";
 import { type ImplicitFieldSchema, type ReadSchema, type TreeView, type TreeViewConfiguration, type UnsafeUnknownSchema, type ViewableTree, type VerboseTree } from "../simple-tree/index.js";
 import { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
@@ -136,7 +136,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.
      */
@@ -180,13 +180,13 @@ export interface ITreeCheckout extends AnchorLocator, ViewableTree, WithBreakabl
  * and functionality required to implement {@link ITreeCheckout}.
  */
 export declare function createTreeCheckout(idCompressor: IIdCompressor, 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;
     removedRoots?: DetachedFieldIndex;
-    chunkCompressionStrategy?: TreeCompressionStrategyPrivate;
+    chunkCompressionStrategy?: TreeCompressionStrategy;
     logger?: ITelemetryLoggerExt;
     breaker?: Breakable;
     disposeForksAfterTransaction?: boolean;
@@ -223,13 +223,14 @@ export declare class TreeCheckout implements ITreeCheckoutFork {
     private readonly mintRevisionTag;
     private readonly revisionTagCodec;
     private readonly idCompressor;
-    removedRoots: DetachedFieldIndex;
+    private readonly _removedRoots;
     /** Optional logger for telemetry. */
     private readonly logger?;
     readonly breaker: Breakable;
     readonly disposeForksAfterTransaction: boolean;
     disposed: boolean;
     private editLock;
+    private readonly locator;
     private readonly views;
     /**
      * Set of revertibles maintained for automatic disposal
@@ -247,11 +248,12 @@ export declare class TreeCheckout implements ITreeCheckoutFork {
      */
     static readonly revertTelemetryEventName = "RevertRevertible";
     events: Listenable<CheckoutEvents>;
-    constructor(branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>, 
+    constructor(branch: SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>, 
     /** True if and only if this checkout is for a branch which is persisted and shared with other clients. */
-    isSharedBranch: boolean, changeFamily: ChangeFamily<SharedTreeEditBuilder, SharedTreeChange>, storedSchema: TreeStoredSchemaRepository, forest: IEditableForest, mintRevisionTag: () => RevisionTag, revisionTagCodec: RevisionTagCodec, idCompressor: IIdCompressor, removedRoots?: DetachedFieldIndex, 
+    isSharedBranch: boolean, changeFamily: ChangeFamily<IdBasedSharedTreeEditBuilder, SharedTreeChange>, storedSchema: TreeStoredSchemaRepository, forest: IEditableForest, mintRevisionTag: () => RevisionTag, revisionTagCodec: RevisionTagCodec, idCompressor: IIdCompressor, _removedRoots?: DetachedFieldIndex, 
     /** Optional logger for telemetry. */
     logger?: ITelemetryLoggerExt | undefined, breaker?: Breakable, disposeForksAfterTransaction?: boolean);
+    get removedRoots(): ReadOnlyDetachedFieldIndex;
     private registerForBranchEvents;
     private unregisterFromBranchEvents;
     private createTransactionStack;
@@ -276,11 +278,11 @@ export declare class TreeCheckout implements ITreeCheckoutFork {
     viewWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(config: TreeViewConfiguration<ReadSchema<TRoot>>): SchematizingSimpleTreeView<TRoot>;
     viewWith<TRoot extends ImplicitFieldSchema>(config: TreeViewConfiguration<TRoot>): TreeView<TRoot>;
     get rootEvents(): Listenable<AnchorSetRootEvents>;
-    get editor(): ISharedTreeEditor;
+    get editor(): ILocationBasedSharedTreeEditor;
     locate(anchor: Anchor): AnchorNode | undefined;
     get transaction(): Transactor;
     branch(): TreeCheckout;
-    switchBranch(branch: SharedTreeBranch<SharedTreeEditBuilder, SharedTreeChange>): void;
+    switchBranch(branch: SharedTreeBranch<IdBasedSharedTreeEditBuilder, SharedTreeChange>): void;
     rebase(checkout: TreeCheckout): void;
     rebaseOnto(checkout: ITreeCheckout): void;
     merge(checkout: TreeCheckout): void;

package/lib/shared-tree/treeCheckout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treeCheckout.d.ts","sourceRoot":"","sources":["../../src/shared-tree/treeCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAgB,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEzF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAEN,KAAK,mBAAmB,EACxB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,UAAU,EAEf,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAEjB,KAAK,cAAc,EAEnB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAEjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EAOjC,KAAK,sBAAsB,EAE3B,KAAK,WAAW,EAQhB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,8BAA8B,EAQnC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAEN,gBAAgB,EAGhB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAe,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG7F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EACN,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAGjB,KAAK,WAAW,EAIhB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAe,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEpF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;OAMG;IACH,WAAW,CAAC,MAAM,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAEpE;;;;;;;;OAQG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAE5E;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IACnD;;;OAGG;IACH,MAAM,IAAI,cAAc,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc,EAAE,WAAW;IAClE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa,EAAE,YAAY,EAAE,aAAa;IAChF;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC;IACpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC;IAEjC,MAAM,IAAI,iBAAiB,CAAC;IAE5B,KAAK,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEzC,KAAK,CAAC,QAAQ,EAAE,iBAAiB,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjE,MAAM,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE1C;;;;;;;;OAQG;IACH,YAAY,CAAC,SAAS,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAE/E;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACzE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,YAAY,EAAE,aAAa,EAC3B,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,CAAC,EAAE;IACN,MAAM,CAAC,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;IACnE,YAAY,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;IACrE,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,wBAAwB,CAAC,EAAE,8BAA8B,CAAC;IAC1D,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,4BAA4B,CAAC,EAAE,OAAO,CAAC;CACvC,GACC,YAAY,CA6Cd;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACvD,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CAGrB;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,iBAAiB;;IAiCpD,0GAA0G;aAC1F,cAAc,EAAE,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY;aACb,YAAY,EAAE,0BAA0B;aACxC,MAAM,EAAE,eAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY;IACtB,YAAY,EAAE,kBAAkB;IAKvC,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;aACR,OAAO,EAAE,SAAS;aAClB,4BAA4B;IAhDtC,QAAQ,UAAS;IAExB,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA4C;IAElE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA8B;IAE1D;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAGrC;IAEJ;;;OAGG;IACH,gBAAuB,wBAAwB,sBAAsB;IAG9D,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAgB;gBAGxD,MAAM,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;IACjE,0GAA0G;IAC1F,cAAc,EAAE,OAAO,EACtB,YAAY,EAAE,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EACpE,YAAY,EAAE,0BAA0B,EACxC,MAAM,EAAE,eAAe,EACtB,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,aAAa,EACrC,YAAY,GAAE,kBAIpB;IACD,qCAAqC;IACpB,MAAM,CAAC,iCAAqB,EAC7B,OAAO,GAAE,SAAyC,EAClD,4BAA4B,UAAO;IAOpD,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,0BAA0B;IAMlC,OAAO,CAAC,sBAAsB;IAyCvB,aAAa,IAAI,WAAW,GAAG,SAAS;IAkB/C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CA+ClC;IAEF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAgB5B;IAGF,OAAO,CAAC,WAAW;IA+BnB,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAgBhC;IAEF,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB;IAmEjB,QAAQ,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB,EACtE,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAC9C,0BAA0B,CAAC,KAAK,CAAC;IAG7B,QAAQ,CAAC,KAAK,SAAS,mBAAmB,EAChD,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,QAAQ,CAAC,KAAK,CAAC;IAiBlB,IAAW,UAAU,IAAI,UAAU,CAAC,mBAAmB,CAAC,CAEvD;IAED,IAAW,MAAM,IAAI,iBAAiB,CAGrC;IAEM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAKrD,IAAW,WAAW,IAAI,UAAU,CAEnC;IAaM,MAAM,IAAI,YAAY;IA2BtB,YAAY,CAClB,MAAM,EAAE,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,GAC/D,IAAI;IAwBA,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAoBpC,UAAU,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOzC,KAAK,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IACnC,KAAK,CAAC,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI;IAuB3D,YAAY,CAAC,SAAS,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAAE,IAAI,GAAG,IAAI;IAW9E,OAAO,IAAI,IAAI;IAKf,CAAC,aAAa,CAAC,IAAI,IAAI;IAcvB,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE;IAiB/E;;;;OAIG;IACI,IAAI,IAAI,IAAI;IAQnB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAoDxB,OAAO,CAAC,sBAAsB;IAsB9B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;;;;;;;OAQG;IACI,aAAa,CACnB,MAAM,EAAE,WAAW,CAAC,gBAAgB,CAAC,EACrC,EAAE,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,GACjD,OAAO;IAWV,iGAAiG;IACjG,OAAO,CAAC,cAAc;CAStB"}
+{"version":3,"file":"treeCheckout.d.ts","sourceRoot":"","sources":["../../src/shared-tree/treeCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAgB,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEzF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAEN,KAAK,mBAAmB,EACxB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,UAAU,EAEf,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAEjB,KAAK,cAAc,EAEnB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAEjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EAOjC,KAAK,sBAAsB,EAE3B,KAAK,WAAW,EAUhB,KAAK,0BAA0B,EAC/B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAIN,KAAK,eAAe,EAEpB,KAAK,uBAAuB,EAU5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAEN,gBAAgB,EAGhB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACN,SAAS,EACT,aAAa,EAGb,KAAK,aAAa,EAClB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EACN,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EAGnC,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EACN,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,YAAY,EAGjB,KAAK,WAAW,EAIhB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAe,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEpF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;OAMG;IACH,WAAW,CAAC,MAAM,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAEpE;;;;;;;;OAQG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;OAOG;IACH,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAE5E;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IACnD;;;OAGG;IACH,MAAM,IAAI,cAAc,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc,EAAE,WAAW;IAClE;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,aAAa,EAAE,YAAY,EAAE,aAAa;IAChF;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC;IACpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,8BAA8B,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC;IAEjC,MAAM,IAAI,iBAAiB,CAAC;IAE5B,KAAK,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEzC,KAAK,CAAC,QAAQ,EAAE,iBAAiB,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjE,MAAM,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE1C;;;;;;;;OAQG;IACH,YAAY,CAAC,SAAS,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAE/E;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACzE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,YAAY,EAAE,aAAa,EAC3B,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,CAAC,EAAE;IACN,MAAM,CAAC,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,gBAAgB,CAAC,CAAC;IAC1E,YAAY,CAAC,EAAE,YAAY,CAAC,4BAA4B,EAAE,gBAAgB,CAAC,CAAC;IAC5E,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,wBAAwB,CAAC,EAAE,uBAAuB,CAAC;IACnD,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,4BAA4B,CAAC,EAAE,OAAO,CAAC;CACvC,GACC,YAAY,CA6Cd;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACvD,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CAGrB;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,iBAAiB;;IAkCpD,0GAA0G;aAC1F,cAAc,EAAE,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY;aAIb,YAAY,EAAE,0BAA0B;aACxC,MAAM,EAAE,eAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAK9B,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;aACR,OAAO,EAAE,SAAS;aAClB,4BAA4B;IApDtC,QAAQ,UAAS;IAExB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAElC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA4C;IAElE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA8B;IAE1D;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAGrC;IAEJ;;;OAGG;IACH,gBAAuB,wBAAwB,sBAAsB;IAG9D,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAgB;gBAGxD,MAAM,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,gBAAgB,CAAC;IACxE,0GAA0G;IAC1F,cAAc,EAAE,OAAO,EACtB,YAAY,EAAE,YAAY,CAC1C,4BAA4B,EAC5B,gBAAgB,CAChB,EACe,YAAY,EAAE,0BAA0B,EACxC,MAAM,EAAE,eAAe,EACtB,eAAe,EAAE,MAAM,WAAW,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,aAAa,EAC3B,aAAa,GAAE,kBAI/B;IACD,qCAAqC;IACpB,MAAM,CAAC,iCAAqB,EAC7B,OAAO,GAAE,SAAyC,EAClD,4BAA4B,UAAO;IAgCpD,IAAW,YAAY,IAAI,0BAA0B,CAEpD;IAED,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,0BAA0B;IAMlC,OAAO,CAAC,sBAAsB;IAyCvB,aAAa,IAAI,WAAW,GAAG,SAAS;IAkB/C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CA+ClC;IAEF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAgB5B;IAGF,OAAO,CAAC,WAAW;IA+BnB,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAgBhC;IAEF,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB;IAmEjB,QAAQ,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB,EACtE,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAC9C,0BAA0B,CAAC,KAAK,CAAC;IAG7B,QAAQ,CAAC,KAAK,SAAS,mBAAmB,EAChD,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,QAAQ,CAAC,KAAK,CAAC;IAiBlB,IAAW,UAAU,IAAI,UAAU,CAAC,mBAAmB,CAAC,CAEvD;IAED,IAAW,MAAM,IAAI,8BAA8B,CAGlD;IAEM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAKrD,IAAW,WAAW,IAAI,UAAU,CAEnC;IAaM,MAAM,IAAI,YAAY;IA2BtB,YAAY,CAClB,MAAM,EAAE,gBAAgB,CAAC,4BAA4B,EAAE,gBAAgB,CAAC,GACtE,IAAI;IAwBA,MAAM,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAoBpC,UAAU,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOzC,KAAK,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IACnC,KAAK,CAAC,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI;IAuB3D,YAAY,CAAC,SAAS,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAAE,IAAI,GAAG,IAAI;IAW9E,OAAO,IAAI,IAAI;IAKf,CAAC,aAAa,CAAC,IAAI,IAAI;IAcvB,eAAe,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE;IAiB/E;;;;OAIG;IACI,IAAI,IAAI,IAAI;IAQnB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAoDxB,OAAO,CAAC,sBAAsB;IAsB9B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;;;;;;;OAQG;IACI,aAAa,CACnB,MAAM,EAAE,WAAW,CAAC,gBAAgB,CAAC,EACrC,EAAE,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,GACjD,OAAO;IAWV,iGAAiG;IACjG,OAAO,CAAC,cAAc;CAStB"}

package/lib/shared-tree/treeCheckout.js

@@ -18,11 +18,12 @@ import { assert, unreachableCase, fail } from "@fluidframework/core-utils/intern
 import { createEmitter } from "@fluid-internal/client-utils";
 import { UsageError, } from "@fluidframework/telemetry-utils/internal";
 import { FluidClientVersion, FormatValidatorNoOp } from "../codec/index.js";
-import { AnchorSet, CommitKind, RevertibleStatus, TreeStoredSchemaRepository, combineVisitors, makeDetachedFieldIndex, rebaseChange, rootFieldKey, tagChange, visitDelta, isAncestor, moveToDetachedField, LeafNodeStoredSchema, diffHistories, } from "../core/index.js";
-import { allowsRepoSuperset, buildForest, createNodeIdentifierManager, defaultSchemaPolicy, intoDelta, jsonableTreeFromCursor, makeFieldBatchCodec, } from "../feature-libraries/index.js";
+import { AnchorSet, CommitKind, RevertibleStatus, TreeStoredSchemaRepository, combineVisitors, makeDetachedFieldIndex, rebaseChange, rootFieldKey, tagChange, visitDelta, isAncestor, moveToDetachedField, LeafNodeStoredSchema, offsetChangeAtomId, diffHistories, } from "../core/index.js";
+import { allowsRepoSuperset, buildForest, changeAtomFromDetachedNodeId, createNodeIdentifierManager, defaultSchemaPolicy, intoDelta, jsonableTreeFromCursor, makeFieldBatchCodec, nodeIdFromChangeAtom, } from "../feature-libraries/index.js";
 import { SquashingTransactionStack, SharedTreeBranch, TransactionResult, onForkTransitive, } from "../shared-tree-core/index.js";
-import { Breakable, disposeSymbol, getOrCreate } from "../util/index.js";
+import { Breakable, disposeSymbol, getOrCreate, makeArray, } from "../util/index.js";
 import { SharedTreeChangeFamily, hasSchemaChange } from "./sharedTreeChangeFamily.js";
+import { LocationBasedSharedTreeEditBuilder, } from "./sharedTreeEditBuilder.js";
 import { customFromCursorStored, } from "../simple-tree/index.js";
 import { getCheckout, SchematizingSimpleTreeView } from "./schematizingTreeView.js";
 /**
@@ -57,7 +58,7 @@ export function createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCod
 export class TreeCheckout {
     constructor(branch, 
     /** True if and only if this checkout is for a branch which is persisted and shared with other clients. */
-    isSharedBranch, changeFamily, storedSchema, forest, mintRevisionTag, revisionTagCodec, idCompressor, removedRoots = makeDetachedFieldIndex("repair", revisionTagCodec, idCompressor), 
+    isSharedBranch, changeFamily, storedSchema, forest, mintRevisionTag, revisionTagCodec, idCompressor, _removedRoots = makeDetachedFieldIndex("repair", revisionTagCodec, idCompressor), 
     /** Optional logger for telemetry. */
     logger, breaker = new Breakable("TreeCheckout"), disposeForksAfterTransaction = true) {
         this.isSharedBranch = isSharedBranch;
@@ -67,7 +68,7 @@ export class TreeCheckout {
         this.mintRevisionTag = mintRevisionTag;
         this.revisionTagCodec = revisionTagCodec;
         this.idCompressor = idCompressor;
-        this.removedRoots = removedRoots;
+        this._removedRoots = _removedRoots;
         this.logger = logger;
         this.breaker = breaker;
         this.disposeForksAfterTransaction = disposeForksAfterTransaction;
@@ -139,12 +140,12 @@ export class TreeCheckout {
             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);
                 });
             });
         };
@@ -164,8 +165,36 @@ export class TreeCheckout {
         _TreeCheckout_validatedCommits.set(this, new WeakMap());
         __classPrivateFieldSet(this, _TreeCheckout_transaction, this.createTransactionStack(branch), "f");
         this.editLock = new EditLock(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEditor);
+        this.locator = {
+            locationFromId: (id) => {
+                const rootId = this.removedRoots.getEntry(nodeIdFromChangeAtom(id));
+                return this.removedRoots.toFieldKey(rootId);
+            },
+            idFromLocation: (location) => {
+                const nodeId = this.removedRoots.fromFieldKey(location);
+                return changeAtomFromDetachedNodeId(nodeId);
+            },
+            locationsFromIdRanges: (ids) => {
+                return ids.flatMap((id) => {
+                    return makeArray(id.count, (offset) => {
+                        const field = this.locator.locationFromId(offsetChangeAtomId(id.first, offset));
+                        return { field, count: 1 };
+                    });
+                });
+            },
+            idRangesFromLocations: (ids) => {
+                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();
     }
+    get removedRoots() {
+        return this._removedRoots;
+    }
     registerForBranchEvents() {
         __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.events.on("afterChange", this.onAfterBranchChange);
         __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranchEvents.on("afterChange", this.onAfterChange);
@@ -180,7 +209,7 @@ export class TreeCheckout {
         return new SquashingTransactionStack(branch, (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);
             const change = this.changeFamily.rebaser.changeRevision(squashedChange, revision);
@@ -189,12 +218,12 @@ export class TreeCheckout {
             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()) {
@@ -236,7 +265,7 @@ export class TreeCheckout {
             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") {
@@ -346,7 +375,7 @@ export class TreeCheckout {
     }
     get editor() {
         this.checkNotDisposed();
-        return this.editLock.editor;
+        return new LocationBasedSharedTreeEditBuilder(this.editLock.editor, this.locator);
     }
     locate(anchor) {
         this.checkNotDisposed();
@@ -362,7 +391,7 @@ export class TreeCheckout {
         const branch = __classPrivateFieldGet(this, _TreeCheckout_transaction, "f").activeBranch.fork();
         const storedSchema = this.storedSchema.clone();
         const forest = this.forest.clone(storedSchema, anchors);
-        const checkout = new TreeCheckout(branch, false, this.changeFamily, storedSchema, forest, this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this.removedRoots.clone(), this.logger, this.breaker, this.disposeForksAfterTransaction);
+        const checkout = new TreeCheckout(branch, false, this.changeFamily, storedSchema, forest, this.mintRevisionTag, this.revisionTagCodec, this.idCompressor, this._removedRoots.clone(), this.logger, this.breaker, this.disposeForksAfterTransaction);
         __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("fork", checkout);
         return checkout;
     }
@@ -430,8 +459,8 @@ export class TreeCheckout {
         this.assertNoUntrackedRoots();
         const trees = [];
         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.
@@ -450,7 +479,7 @@ export class TreeCheckout {
     load() {
         // 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(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.getHead().revision);
+        this._removedRoots.setRevisionsForLoadedData(__classPrivateFieldGet(this, _TreeCheckout_transaction, "f").branch.getHead().revision);
         // The content of the checkout (e.g. the forest) has (maybe) changed, so fire an afterBatch event.
         __classPrivateFieldGet(this, _TreeCheckout_events, "f").emit("afterBatch");
     }
@@ -496,8 +525,8 @@ export class TreeCheckout {
     assertNoUntrackedRoots() {
         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()) {
             return;
@@ -566,6 +595,10 @@ class EditLock {
             get schema() {
                 return editor.schema;
             },
+            buildRoots(unhydrated) {
+                checkLock();
+                return editor.buildRoots(unhydrated);
+            },
             valueField(...fieldArgs) {
                 const valueField = editor.valueField(...fieldArgs);
                 return {
@@ -573,6 +606,10 @@ class EditLock {
                         checkLock();
                         valueField.set(...editArgs);
                     },
+                    attach(...editArgs) {
+                        checkLock();
+                        valueField.attach(...editArgs);
+                    },
                 };
             },
             optionalField(...fieldArgs) {
@@ -582,6 +619,14 @@ class EditLock {
                         checkLock();
                         optionalField.set(...editArgs);
                     },
+                    attach(...editArgs) {
+                        checkLock();
+                        optionalField.attach(...editArgs);
+                    },
+                    clear(...editArgs) {
+                        checkLock();
+                        optionalField.clear(...editArgs);
+                    },
                 };
             },
             sequenceField(...fieldArgs) {
@@ -591,6 +636,10 @@ class EditLock {
                         checkLock();
                         sequenceField.insert(...editArgs);
                     },
+                    attach(...editArgs) {
+                        checkLock();
+                        sequenceField.attach(...editArgs);
+                    },
                     remove(...editArgs) {
                         checkLock();
                         sequenceField.remove(...editArgs);