@fluidframework/tree 2.116.0-416006 → 2.116.0

package/dist/shared-tree/sharedTree.d.ts

@@ -5,9 +5,8 @@
 import type { ErasedType, IFluidLoadable } from "@fluidframework/core-interfaces/internal";
 import type { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
-import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
+import type { OldestSupportedClientVersion } from "@fluidframework/runtime-definitions/internal";
 import type { IChannelView, IFluidSerializer, SharedKernel } from "@fluidframework/shared-object-base/internal";
-import { type TelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 import { type CodecTree, type CodecWriteOptions, type CodecWriteOptionsBeta, type ICodecOptions } from "../codec/index.js";
 import { type GraphCommit, type IEditableForest, type JsonableTree, type TreeStoredSchema, TreeStoredSchemaRepository, type TreeStoredSchemaSubscription } from "../core/index.js";
 import { TreeCompressionStrategy, type IncrementalEncodingPolicy } from "../feature-libraries/index.js";
@@ -79,7 +78,6 @@ export type SharedTreeKernelView = Omit<ITreePrivate, keyof (IChannelView & IFlu
  * TODO: detail compatibility requirements.
  */
 export declare class SharedTreeKernel extends SharedTreeCore<SharedTreeEditBuilder, SharedTreeChange, SharedTreeChangeProcessingContext> implements SharedKernel {
-    private readonly logger;
     readonly checkout: TreeCheckout;
     get storedSchema(): TreeStoredSchemaRepository;
     private readonly checkouts;
@@ -91,7 +89,7 @@ export declare class SharedTreeKernel extends SharedTreeCore<SharedTreeEditBuild
      * Different users will have access to different subsets of this API, see {@link ITree}, {@link ITreeAlpha} and {@link ITreeInternal} which this {@link ITreePrivate} extends.
      */
     readonly view: SharedTreeKernelView;
-    constructor(breaker: Breakable, sharedObject: IChannelView & IFluidLoadable, serializer: IFluidSerializer, submitLocalMessage: (content: unknown, localOpMetadata?: unknown) => void, lastSequenceNumber: () => number | undefined, initialSequenceNumber: number, logger: TelemetryLoggerExt | undefined, idCompressor: IIdCompressor, optionsParam: SharedTreeOptionsInternal);
+    constructor(breaker: Breakable, sharedObject: IChannelView & IFluidLoadable, serializer: IFluidSerializer, submitLocalMessage: (content: unknown, localOpMetadata?: unknown) => void, lastSequenceNumber: () => number | undefined, initialSequenceNumber: number, idCompressor: IIdCompressor, optionsParam: SharedTreeOptionsInternal);
     private registerCheckout;
     exportVerbose(): VerboseTree | undefined;
     exportSimpleSchema(): SimpleTreeSchema;
@@ -135,7 +133,7 @@ export declare const changeFormatVersionForEditManager: import("../codec/codec.j
  * This is because the format for SharedTree changes are not explicitly versioned.
  */
 export declare const changeFormatVersionForMessage: import("../codec/codec.js").MappedDependentFormatVersion<MessageFormatVersion, SharedTreeChangeFormatVersion>;
-export declare function getCodecTreeForSharedTreeFormat(clientVersion: MinimumVersionForCollab): CodecTree;
+export declare function getCodecTreeForSharedTreeFormat(clientVersion: OldestSupportedClientVersion): CodecTree;
 /**
  * Configuration options for SharedTree.
  * @beta @input
@@ -215,6 +213,33 @@ export interface SharedTreeOptions extends SharedTreeOptionsBeta, Partial<CodecW
      * lifetime of the client, which increases memory usage over time and should be used with care.
      */
     readonly retainHistory?: boolean;
+    /**
+     * When `true`, validates that commits being submitted for the first time can be applied without errors to a view.
+     * In the event that a commit cannot be applied, SharedTree will throw an error and will enter a "broken" state, preventing the offending commit (and any further commits) from being submitted.
+     *
+     * This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code:
+     * when the additional validation is enabled, a client will error instead of potentially corrupting the document.
+     *
+     * @defaultValue `false`
+     *
+     * @remarks
+     * This validation is more expensive than {@link SharedTreeOptions.validateRebasedCommitsBeforeResubmission} because it is likely to be performed more often.
+     * We recommend {@link ForestOptions.forest|configuring SharedTree} with the {@link ForestTypeOptimized|optimized forest implementation} to reduce its performance impact.
+     */
+    readonly validateCommitsOnFirstSubmission?: boolean;
+    /**
+     * When `true`, validates that the commits being resubmitted can be applied without errors to a view.
+     * In the event that a commit cannot be applied, SharedTree will throw an error and will enter a "broken" state, preventing the offending commit (and any further commits) from being submitted.
+     *
+     * This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code:
+     * when the additional validation is enabled, a client will error instead of potentially corrupting the document.
+     *
+     * @defaultValue `false`
+     *
+     * @remarks
+     * We recommend {@link ForestOptions.forest|configuring SharedTree} with the {@link ForestTypeOptimized|optimized forest implementation} to reduce the performance impact of this validation.
+     */
+    readonly validateRebasedCommitsBeforeResubmission?: boolean;
 }
 export interface SharedTreeOptionsInternal extends SharedTreeOptions, Partial<SharedTreeCoreOptionsInternal> {
 }

package/dist/shared-tree/sharedTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAE3F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAY,MAAM,+BAA+B,CAAC;AAC7E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8CAA8C,CAAC;AAC5F,OAAO,KAAK,EACX,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,KAAK,kBAAkB,EAAc,MAAM,0CAA0C,CAAC;AAE/F,OAAO,EACN,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAI1B,KAAK,aAAa,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEN,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,YAAY,EAOjB,KAAK,gBAAgB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EAKjC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAMN,uBAAuB,EAYvB,KAAK,yBAAyB,EAC9B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACN,KAAK,QAAQ,EACb,KAAK,uBAAuB,EAI5B,KAAK,6BAA6B,EAClC,oBAAoB,EACpB,cAAc,EACd,wBAAwB,EAExB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACN,KAAK,mBAAmB,EAExB,KAAK,UAAU,EAEf,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAIhB,KAAK,UAAU,EAGf,KAAK,UAAU,EACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,SAAS,EAEd,KAAK,cAAc,EAEnB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAEN,6BAA6B,EAC7B,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,6BAA6B,CAAC;AAErF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,mBAAmB,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACxE;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY,EAAE,UAAU;CAAG;AAElE;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IAClD;;;;;;OAMG;IACH,eAAe,IAAI,yBAAyB,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,CAAC,CAAC;AAE7F;;;;GAIG;AACH,qBACa,gBACZ,SAAQ,cAAc,CACrB,qBAAqB,EACrB,gBAAgB,EAChB,iCAAiC,CAElC,YAAW,YAAY;IAyBtB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAvBxB,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,IAAW,YAAY,IAAI,0BAA0B,CAEpD;IAED,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0C;IAEpE;;;;;;OAMG;IACH,SAAgB,IAAI,EAAE,oBAAoB,CAAC;gBAG1C,OAAO,EAAE,SAAS,EAClB,YAAY,EAAE,YAAY,GAAG,cAAc,EAC3C,UAAU,EAAE,gBAAgB,EAC5B,kBAAkB,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC,EAAE,OAAO,KAAK,IAAI,EACzE,kBAAkB,EAAE,MAAM,MAAM,GAAG,SAAS,EAC5C,qBAAqB,EAAE,MAAM,EACZ,MAAM,EAAE,kBAAkB,GAAG,SAAS,EACvD,YAAY,EAAE,aAAa,EAC3B,YAAY,EAAE,yBAAyB;IAwIxC,OAAO,CAAC,gBAAgB;IAIjB,aAAa,IAAI,WAAW,GAAG,SAAS;IAIxC,kBAAkB,IAAI,gBAAgB;IAKtC,eAAe,IAAI,yBAAyB;IAe5C,QAAQ,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB,EACtE,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAC9C,0BAA0B,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAG3D,QAAQ,CAAC,KAAK,SAAS,mBAAmB,EAChD,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,0BAA0B,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC;IAS/C,cAAc,CAAC,KAAK,SAAS,mBAAmB,EACtD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,QAAQ,CAAC,KAAK,CAAC;IAelB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,cAAc;IAQA,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/D,SAAS,IAAI,IAAI;IAajB,cAAc,CAC7B,GAAG,IAAI,EAAE,UAAU,CAClB,cAAc,CACb,qBAAqB,EACrB,gBAAgB,EAChB,iCAAiC,CACjC,CAAC,gBAAgB,CAAC,CACnB,GACC,IAAI;cAUY,YAAY,CAC9B,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,WAAW,CAAC,gBAAgB,CAAC,EACrC,eAAe,EAAE,uBAAuB,EACxC,UAAU,EAAE,OAAO,GACjB,IAAI;IAkBA,YAAY,IAAI,IAAI;CAC3B;AAED,wBAAgB,kBAAkB,CACjC,YAAY,EAAE,gBAAgB,GAC5B,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CASrC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CACtC,SAAS,EAAE,cAAc,EACzB,OAAO,EAAE,aAAa,GACpB,gBAAgB,CAIlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,iCAAiC,mHAQ5C,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,+GAQxC,CAAC;AAoBH,wBAAgB,+BAA+B,CAC9C,aAAa,EAAE,uBAAuB,GACpC,SAAS,CAaX;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAC3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CAAC,mCAAmC,CAAC,EAAE,OAAO,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,iBAChB,SAAQ,qBAAqB,EAC5B,OAAO,CAAC,iBAAiB,CAAC,EAC1B,OAAO,CAAC,uBAAuB,CAAC;IACjC;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IACxC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IAEtD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,yBAChB,SAAQ,iBAAiB,EACxB,OAAO,CAAC,6BAA6B,CAAC;CAAG;AAE3C;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;OAGG;IACH,cAAc,EAAE,uBAAuB,CAAC;CACxC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU,CAAC,YAAY,CAAC;CAAG;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,YAG/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,YAY/B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,YAepC,CAAC;AAaF;;GAEG;AACH,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,4BAA4B,EACpC,YAAY,EAAE,aAAa,EAC3B,yBAAyB,EAAE,yBAAyB,GAClD,eAAe,CAOjB;AAED,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,yBAAyB,CAWxE,CAAC"}
+{"version":3,"file":"sharedTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAE3F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAY,MAAM,+BAA+B,CAAC;AAC7E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAC;AACjG,OAAO,KAAK,EACX,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,MAAM,6CAA6C,CAAC;AAGrD,OAAO,EACN,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAI1B,KAAK,aAAa,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEN,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,YAAY,EAOjB,KAAK,gBAAgB,EACrB,0BAA0B,EAC1B,KAAK,4BAA4B,EAKjC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAMN,uBAAuB,EAYvB,KAAK,yBAAyB,EAC9B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACN,KAAK,QAAQ,EACb,KAAK,uBAAuB,EAI5B,KAAK,6BAA6B,EAClC,oBAAoB,EACpB,cAAc,EACd,wBAAwB,EAExB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACN,KAAK,mBAAmB,EAExB,KAAK,UAAU,EAEf,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EACb,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAIhB,KAAK,UAAU,EAGf,KAAK,UAAU,EACf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,SAAS,EAEd,KAAK,cAAc,EAEnB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAEN,6BAA6B,EAC7B,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,6BAA6B,CAAC;AAErF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,mBAAmB,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACxE;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY,EAAE,UAAU;CAAG;AAElE;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IAClD;;;;;;OAMG;IACH,eAAe,IAAI,yBAAyB,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,CAAC,CAAC;AAE7F;;;;GAIG;AACH,qBACa,gBACZ,SAAQ,cAAc,CACrB,qBAAqB,EACrB,gBAAgB,EAChB,iCAAiC,CAElC,YAAW,YAAY;IAEvB,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,IAAW,YAAY,IAAI,0BAA0B,CAEpD;IAED,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0C;IAEpE;;;;;;OAMG;IACH,SAAgB,IAAI,EAAE,oBAAoB,CAAC;gBAG1C,OAAO,EAAE,SAAS,EAClB,YAAY,EAAE,YAAY,GAAG,cAAc,EAC3C,UAAU,EAAE,gBAAgB,EAC5B,kBAAkB,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC,EAAE,OAAO,KAAK,IAAI,EACzE,kBAAkB,EAAE,MAAM,MAAM,GAAG,SAAS,EAC5C,qBAAqB,EAAE,MAAM,EAC7B,YAAY,EAAE,aAAa,EAC3B,YAAY,EAAE,yBAAyB;IAqIxC,OAAO,CAAC,gBAAgB;IAIjB,aAAa,IAAI,WAAW,GAAG,SAAS;IAIxC,kBAAkB,IAAI,gBAAgB;IAKtC,eAAe,IAAI,yBAAyB;IAe5C,QAAQ,CAAC,KAAK,SAAS,mBAAmB,GAAG,mBAAmB,EACtE,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAC9C,0BAA0B,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAG3D,QAAQ,CAAC,KAAK,SAAS,mBAAmB,EAChD,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,0BAA0B,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC;IAS/C,cAAc,CAAC,KAAK,SAAS,mBAAmB,EACtD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAClC,QAAQ,CAAC,KAAK,CAAC;IAelB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,cAAc;IAQA,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/D,SAAS,IAAI,IAAI;IAajB,cAAc,CAC7B,GAAG,IAAI,EAAE,UAAU,CAClB,cAAc,CACb,qBAAqB,EACrB,gBAAgB,EAChB,iCAAiC,CACjC,CAAC,gBAAgB,CAAC,CACnB,GACC,IAAI;cAUY,YAAY,CAC9B,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,WAAW,CAAC,gBAAgB,CAAC,EACrC,eAAe,EAAE,uBAAuB,EACxC,UAAU,EAAE,OAAO,GACjB,IAAI;IAkBA,YAAY,IAAI,IAAI;CAC3B;AAED,wBAAgB,kBAAkB,CACjC,YAAY,EAAE,gBAAgB,GAC5B,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CASrC;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CACtC,SAAS,EAAE,cAAc,EACzB,OAAO,EAAE,aAAa,GACpB,gBAAgB,CAIlB;AAED;;;;;GAKG;AACH,eAAO,MAAM,iCAAiC,mHAQ5C,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,+GAQxC,CAAC;AAsBH,wBAAgB,+BAA+B,CAC9C,aAAa,EAAE,4BAA4B,GACzC,SAAS,CAaX;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAC3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,QAAQ,CAAC,mCAAmC,CAAC,EAAE,OAAO,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,iBAChB,SAAQ,qBAAqB,EAC5B,OAAO,CAAC,iBAAiB,CAAC,EAC1B,OAAO,CAAC,uBAAuB,CAAC;IACjC;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IACxC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IAEtD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAEpD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,wCAAwC,CAAC,EAAE,OAAO,CAAC;CAC5D;AAED,MAAM,WAAW,yBAChB,SAAQ,iBAAiB,EACxB,OAAO,CAAC,6BAA6B,CAAC;CAAG;AAE3C;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;OAGG;IACH,cAAc,EAAE,uBAAuB,CAAC;CACxC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU,CAAC,YAAY,CAAC;CAAG;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,YAG/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,YAa/B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,YAgBpC,CAAC;AAaF;;GAEG;AACH,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,4BAA4B,EACpC,YAAY,EAAE,aAAa,EAC3B,yBAAyB,EAAE,yBAAyB,GAClD,eAAe,CAOjB;AAED,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,yBAAyB,CAaxE,CAAC"}

package/dist/shared-tree/sharedTree.js

@@ -35,7 +35,7 @@ let SharedTreeKernel = (() => {
         get storedSchema() {
             return this.checkout.storedSchema;
         }
-        constructor(breaker, sharedObject, serializer, submitLocalMessage, lastSequenceNumber, initialSequenceNumber, logger, idCompressor, optionsParam) {
+        constructor(breaker, sharedObject, serializer, submitLocalMessage, lastSequenceNumber, initialSequenceNumber, idCompressor, optionsParam) {
             const options = {
                 ...exports.defaultSharedTreeOptions,
                 ...optionsParam,
@@ -65,7 +65,7 @@ let SharedTreeKernel = (() => {
             const decoderContext = index_js_3.FieldBatchDecodingContext.forSummary({
                 idCompressor,
                 healing: options.healUnresolvableIdentifiersOnDecode === true
-                    ? { sharedObjectId: sharedObject.id, logger }
+                    ? { sharedObjectId: sharedObject.id, logger: breaker.logger }
                     : undefined,
             });
             const forestSummarizer = new index_js_3.ForestSummarizer(forest, encoderContext, decoderContext, options, idCompressor, initialSequenceNumber, options.shouldEncodeIncrementally);
@@ -90,8 +90,8 @@ let SharedTreeKernel = (() => {
                 // programmatically reload the SharedTree container.
                 throw error;
             });
-            super(breaker, sharedObject, serializer, submitLocalMessage, logger, [schemaSummarizer, forestSummarizer, removedRootsSummarizer], changeFamily, options, exports.changeFormatVersionForEditManager, exports.changeFormatVersionForMessage, idCompressor, schema, index_js_3.defaultSchemaPolicy);
-            this.logger = (tslib_1.__runInitializers(this, _instanceExtraInitializers), logger);
+            super(breaker, sharedObject, serializer, submitLocalMessage, [schemaSummarizer, forestSummarizer, removedRootsSummarizer], changeFamily, options, exports.changeFormatVersionForEditManager, exports.changeFormatVersionForMessage, idCompressor, schema, index_js_3.defaultSchemaPolicy);
+            this.checkout = tslib_1.__runInitializers(this, _instanceExtraInitializers);
             this.checkouts = new Map();
             this.checkout = (0, treeCheckout_js_1.createTreeCheckout)(idCompressor, this.mintRevisionTag, revisionTagCodec, {
                 branch: this.getLocalBranch(),
@@ -101,8 +101,6 @@ let SharedTreeKernel = (() => {
                 fieldBatchCodec,
                 removedRoots,
                 chunkCompressionStrategy: options.treeEncodeType,
-                logger,
-                breaker: this.breaker,
             });
             this.registerSharedBranchForEditing("main", this.checkout);
             this.registerCheckout("main", this.checkout);
@@ -304,7 +302,7 @@ exports.ForestTypeReference = toForestType((breaker, schema, idCompressor) => (0
  * The "ChunkedForest" forest type.
  * @beta
  */
-exports.ForestTypeOptimized = toForestType((breaker, schema, idCompressor, shouldEncodeIncrementally) => (0, index_js_3.buildChunkedForest)((0, index_js_3.makeTreeChunker)(schema, index_js_3.defaultSchemaPolicy, shouldEncodeIncrementally), undefined, idCompressor));
+exports.ForestTypeOptimized = toForestType((breaker, schema, idCompressor, shouldEncodeIncrementally) => (0, index_js_3.buildChunkedForest)((0, index_js_3.makeTreeChunker)(schema, index_js_3.defaultSchemaPolicy, shouldEncodeIncrementally), undefined, idCompressor, breaker));
 /**
  * Slow implementation of forest intended only for debugging.
  * @remarks
@@ -316,7 +314,7 @@ exports.ForestTypeOptimized = toForestType((breaker, schema, idCompressor, shoul
  * This exercises the optimized forest while asserting that its contents stay consistent with the reference implementation.
  * @beta
  */
-exports.ForestTypeExpensiveDebug = toForestType((breaker, schema, idCompressor, shouldEncodeIncrementally) => new index_js_3.ComparisonForest((0, index_js_3.buildChunkedForest)((0, index_js_3.makeTreeChunker)(schema, index_js_3.defaultSchemaPolicy, shouldEncodeIncrementally), undefined, idCompressor), (0, index_js_3.buildForest)(breaker, schema, undefined, true)));
+exports.ForestTypeExpensiveDebug = toForestType((breaker, schema, idCompressor, shouldEncodeIncrementally) => new index_js_3.ComparisonForest((0, index_js_3.buildChunkedForest)((0, index_js_3.makeTreeChunker)(schema, index_js_3.defaultSchemaPolicy, shouldEncodeIncrementally), undefined, idCompressor, breaker), (0, index_js_3.buildForest)(breaker, schema, undefined, true)));
 function toForestType(factory) {
     return factory;
 }
@@ -338,6 +336,8 @@ exports.defaultSharedTreeOptions = {
     writeVersionOverrides: new Map(),
     allowPossiblyIncompatibleWriteVersionOverrides: false,
     retainHistory: false,
+    validateCommitsOnFirstSubmission: false,
+    validateRebasedCommitsBeforeResubmission: false,
 };
 /**
  * Build the allowed types for a Stored Schema.

package/dist/shared-tree/sharedTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTree.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAGH,kEAAmE;AASnE,uEAA+F;AAE/F,gDAQ2B;AAC3B,+CAkB0B;AAC1B,4DAmBuC;AACvC,4DAAmE;AACnE,2DAWsC;AACtC,sDAiBiC;AACjC,+CAK0B;AAG1B,2EAGqC;AAErC,2EAAqE;AAGrE,uDAA0E;AA2D1E;;;;GAIG;IAEU,gBAAgB;4BAD5B,wBAAa;;;;sBAEL,yBAAc;;;6CAAtB,SAAQ,WAIP;QAID,IAAW,YAAY;YACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACnC,CAAC;QAaD,YACC,OAAkB,EAClB,YAA2C,EAC3C,UAA4B,EAC5B,kBAAyE,EACzE,kBAA4C,EAC5C,qBAA6B,EACZ,MAAsC,EACvD,YAA2B,EAC3B,YAAuC;YAEvC,MAAM,OAAO,GAAwC;gBACpD,GAAG,gCAAwB;gBAC3B,GAAG,YAAY;aACf,CAAC;YACF,IAAI,OAAO,CAAC,mBAAmB,GAAG,6BAAkB,CAAC,IAAI,EAAE,CAAC;gBAC3D,MAAM,IAAI,qBAAU,CAAC,2DAA2D,CAAC,CAAC;YACnF,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,qCAA0B,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,qBAAqB,CACnC,OAAO,EACP,OAAO,CAAC,MAAM,EACd,MAAM,EACN,YAAY,EACZ,OAAO,CAAC,yBAAyB,CACjC,CAAC;YACF,MAAM,YAAY,GAAG,IAAA,iCAAsB,EAAC,QAAQ,CAAC,CAAC;YACtD,MAAM,WAAW,GAAG,6BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAC5C,MAAM,EACN;gBACC,aAAa,EAAE,kBAAkB;aACjC,EACD,WAAW,EACX,OAAO,CAAC,mBAAmB,CAC3B,CAAC;YACF,MAAM,eAAe,GAAG,iCAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE9D,MAAM,cAAc,GAA8B;gBACjD,MAAM,EAAE;oBACP,MAAM;oBACN,MAAM,EAAE,8BAAmB;iBAC3B;gBACD,UAAU,EAAE,OAAO,CAAC,cAAc;gBAClC,YAAY;gBACZ,gEAAgE;gBAChE,yDAAyD;gBACzD,SAAS,EAAE,IAAI;aACf,CAAC;YACF,MAAM,cAAc,GAAG,oCAAyB,CAAC,UAAU,CAAC;gBAC3D,YAAY;gBACZ,OAAO,EACN,OAAO,CAAC,mCAAmC,KAAK,IAAI;oBACnD,CAAC,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE;oBAC7C,CAAC,CAAC,SAAS;aACb,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAC5C,MAAM,EACN,cAAc,EACd,cAAc,EACd,OAAO,EACP,YAAY,EACZ,qBAAqB,EACrB,OAAO,CAAC,yBAAyB,CACjC,CAAC;YACF,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,YAAY,CAAC,CAAC;YAC5D,MAAM,sBAAsB,GAAG,IAAI,uCAA4B,CAC9D,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,OAAO,CACP,CAAC;YACF,MAAM,iBAAiB,GAAG,IAAI,kDAAsB,CACnD,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,OAAO,CAAC,cAAc,EACtB,YAAY,CACZ,CAAC;YACF,MAAM,YAAY,GAAG,IAAA,oCAAyB,EAC7C,iBAAiB,EACjB,kDAAsB,CAAC,WAAW,EAClC,CAAC,KAAc,EAAE,EAAE;gBAClB,4CAA4C;gBAC5C,oFAAoF;gBACpF,4BAA4B;gBAC5B,4FAA4F;gBAC5F,0FAA0F;gBAC1F,iGAAiG;gBACjG,2EAA2E;gBAC3E,2FAA2F;gBAC3F,wFAAwF;gBACxF,sFAAsF;gBACtF,uFAAuF;gBACvF,0BAA0B;gBAC1B,kFAAkF;gBAClF,gFAAgF;gBAChF,oDAAoD;gBACpD,MAAM,KAAK,CAAC;YACb,CAAC,CACD,CAAC;YACF,KAAK,CACJ,OAAO,EACP,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,MAAM,EACN,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAC5D,YAAY,EACZ,OAAO,EACP,yCAAiC,EACjC,qCAA6B,EAC7B,YAAY,EACZ,MAAM,EACN,8BAAmB,CACnB,CAAC;YA5Ge,WAAM,IA/BZ,2DAAgB,EA+BV,MAAM,EAAgC;YAlBvC,cAAS,GAAgC,IAAI,GAAG,EAAE,CAAC;YAgInE,IAAI,CAAC,QAAQ,GAAG,IAAA,oCAAkB,EAAC,YAAY,EAAE,IAAI,CAAC,eAAe,EAAE,gBAAgB,EAAE;gBACxF,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE;gBAC7B,YAAY;gBACZ,MAAM;gBACN,MAAM;gBACN,eAAe;gBACf,YAAY;gBACZ,wBAAwB,EAAE,OAAO,CAAC,cAAc;gBAChD,MAAM;gBACN,OAAO,EAAE,IAAI,CAAC,OAAO;aACrB,CAAC,CAAC;YAEH,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3D,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAE7C,IAAI,CAAC,IAAI,GAAG;gBACX,eAAe,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE;gBAC7C,kBAAkB,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,EAAE;gBACnD,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;gBACzC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;gBAClC,oBAAoB,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;gBACpD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;gBACtD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;gBACxD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;gBACtD,MAAM,EAAE,IAAI;aACZ,CAAC;QACH,CAAC;QAEO,gBAAgB,CAAC,QAAkB,EAAE,QAAsB;YAClE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;QAEM,aAAa;YACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;QACtC,CAAC;QAEM,kBAAkB;YACxB,OAAO,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;QAGM,eAAe;YACrB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACtE,IAAI,CAAC;gBACJ,IAAA,8BAAmB,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAClD,OAAO;oBACN,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;oBACjC,IAAI,EAAE,IAAA,sCAA2B,EAAC,MAAM,CAAC;oBACzC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;iBACxC,CAAC;YACH,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,IAAI,EAAE,CAAC;YACf,CAAC;QACF,CAAC;QAYM,QAAQ,CACd,MAAgD;YAEhD,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CACR,CAAC;QAC9B,CAAC;QAOM,cAAc,CACpB,QAAgB,EAChB,MAAgD;YAEhD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,QAAoB,CAAC,CAAC;YAC3E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,qBAAU,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,QAAQ,CAC7C,MAAM,CAC6D,CAAC;QACtE,CAAC;QAEO,WAAW,CAAC,QAAkB;YACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACtE,CAAC;QAEO,cAAc,CAAC,QAAkB;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,8BAA8B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC1C,OAAO,QAAQ,CAAC;QACjB,CAAC;QAEe,KAAK,CAAC,QAAQ,CAAC,QAAgC;YAC9D,MAAM,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;QAEe,SAAS;YACxB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChD,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oBACnC,6DAA6D;oBAC7D,2HAA2H;oBAC3H,MAAM,IAAI,qBAAU,CACnB,qGAAqG,CACrG,CAAC;gBACH,CAAC;YACF,CAAC;YACD,KAAK,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC;QAEe,cAAc,CAC7B,GAAG,IAMF;YAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChD,IAAA,iBAAM,EACL,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAC/B,KAAK,CAAC,+DAA+D,CACrE,CAAC;YACH,CAAC;YACD,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC;QAEkB,YAAY,CAC9B,QAAkB,EAClB,MAAqC,EACrC,eAAwC,EACxC,UAAmB;YAEnB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC5C,IAAA,iBAAM,EACL,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAC/B,KAAK,CAAC,+DAA+D,CACrE,CAAC;YACF,IAAI,UAAU,EAAE,CAAC;gBAChB,OAAO,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;YAC1E,CAAC;YAED,gFAAgF;YAChF,6IAA6I;YAC7I,6IAA6I;YAC7I,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,CACnC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,CAAC,CACjE,CAAC;QACH,CAAC;QAEM,YAAY,KAAU,CAAC;;;;;uCAzH7B,wBAAa;QACd,8MAAO,eAAe,6DAYrB;QAlMF,qLA+SC;;;QA/SY,+DAAgB;;;;AAAhB,4CAAgB;AAiT7B,SAAgB,kBAAkB,CACjC,YAA8B;IAE9B,OAAO;QACN,IAAI,EAAE,6BAA6B,CAAC,YAAY,CAAC,eAAe,CAAC;QACjE,WAAW,EAAE,IAAI,GAAG,CACnB,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE;YAClD,OAAO,CAAC,GAAG,EAAE,4BAA4B,CAAC,MAAM,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CACF;KACD,CAAC;AACH,CAAC;AAXD,gDAWC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,uBAAuB,CACtC,SAAyB,EACzB,OAAsB;IAEtB,MAAM,WAAW,GAAG,6BAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7C,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAPD,0DAOC;AAED;;;;;GAKG;AACU,QAAA,iCAAiC,GAAG,iCAAsB,CAAC,SAAS,CAG/E;IACD,CAAC,mCAAwB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC/D,CAAC,mCAAwB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC/D,CAAC,mCAAwB,CAAC,eAAe,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC5E,CAAC,mCAAwB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;CAC/D,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,6BAA6B,GAAG,iCAAsB,CAAC,SAAS,CAG3E;IACD,CAAC,+BAAoB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC3D,CAAC,+BAAoB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC3D,CAAC,+BAAoB,CAAC,eAAe,EAAE,yDAA6B,CAAC,EAAE,CAAC;IACxE,CAAC,+BAAoB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;CAC3D,CAAC,CAAC;AAEH,SAAS,gCAAgC,CAAC,aAAsC;IAC/E,MAAM,kBAAkB,GAAG,IAAA,sCAA2B,GAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;IAC7F,MAAM,MAAM,GAAG,yCAAiC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC5E,MAAM,eAAe,GAAG,IAAA,uDAA2B,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3E,OAAO,IAAA,qDAA0C,EAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,4BAA4B,CAAC,aAAsC;IAC3E,MAAM,cAAc,GAAG,IAAA,kCAAuB,GAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;IACrF,IAAA,iBAAM,EACL,cAAc,KAAK,SAAS,EAC5B,KAAK,CAAC,0DAA0D,CAChE,CAAC;IACF,MAAM,MAAM,GAAG,qCAA6B,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACpE,MAAM,eAAe,GAAG,IAAA,uDAA2B,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3E,OAAO,IAAA,iDAAsC,EAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AAC/E,CAAC;AAED,SAAgB,+BAA+B,CAC9C,aAAsC;IAEtC,MAAM,QAAQ,GAAgB,EAAE,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,6BAAkB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,IAAI,CAAC,6BAAkB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,IAAI,CAAC,yCAA8B,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC1E,QAAQ,CAAC,IAAI,CAAC,gCAAgC,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,QAAQ,CAAC,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,CAAC,CAAC;IAC3D,QAAQ,CAAC,IAAI,CAAC,iCAAsB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAClE,OAAO;QACN,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,SAAS,EAAE,iDAAiD;QACrE,QAAQ;KACR,CAAC;AACH,CAAC;AAfD,0EAeC;AAiID;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,YAAY,CAC9C,CAAC,OAAkB,EAAE,MAAoC,EAAE,YAA2B,EAAE,EAAE,CACzF,IAAA,sBAAW,EAAC,OAAO,EAAE,MAAM,CAAC,CAC7B,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,mBAAmB,GAAG,YAAY,CAC9C,CACC,OAAkB,EAClB,MAAoC,EACpC,YAA2B,EAC3B,yBAAoD,EACnD,EAAE,CACH,IAAA,6BAAkB,EACjB,IAAA,0BAAe,EAAC,MAAM,EAAE,8BAAmB,EAAE,yBAAyB,CAAC,EACvE,SAAS,EACT,YAAY,CACZ,CACF,CAAC;AAEF;;;;;;;;;;GAUG;AACU,QAAA,wBAAwB,GAAG,YAAY,CACnD,CACC,OAAkB,EAClB,MAAoC,EACpC,YAA2B,EAC3B,yBAAoD,EACnD,EAAE,CACH,IAAI,2BAAgB,CACnB,IAAA,6BAAkB,EACjB,IAAA,0BAAe,EAAC,MAAM,EAAE,8BAAmB,EAAE,yBAAyB,CAAC,EACvE,SAAS,EACT,YAAY,CACZ,EACD,IAAA,sBAAW,EAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAC7C,CACF,CAAC;AASF,SAAS,YAAY,CAAC,OAAsB;IAC3C,OAAO,OAAgC,CAAC;AACzC,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CACpC,OAAkB,EAClB,OAAmB,EACnB,MAAoC,EACpC,YAA2B,EAC3B,yBAAoD;IAEpD,OAAQ,OAAoC,CAC3C,OAAO,EACP,MAAM,EACN,YAAY,EACZ,yBAAyB,CACzB,CAAC;AACH,CAAC;AAbD,sDAaC;AAEY,QAAA,wBAAwB,GAAwC;IAC5E,aAAa,EAAE,8BAAmB;IAClC,mBAAmB,EAAE,6BAAkB,CAAC,IAAI;IAC5C,MAAM,EAAE,2BAAmB;IAC3B,cAAc,EAAE,kCAAuB,CAAC,UAAU;IAClD,yBAAyB,EAAE,2CAAgC;IAC3D,oBAAoB,EAAE,KAAK;IAC3B,mCAAmC,EAAE,KAAK;IAC1C,qBAAqB,EAAE,IAAI,GAAG,EAAE;IAChC,8CAA8C,EAAE,KAAK;IACrD,aAAa,EAAE,KAAK;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,+CAA+C,CACvD,KAAkB;IAElB,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA0D,CAAC;IAC3F,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,6CAA6C;QAC7C,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,gBAAgB,CAAC;AACzB,CAAC;AAED,SAAS,6BAA6B,CACrC,MAA6B;IAE7B,IAAI,IAAe,CAAC;IACpB,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,qBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;YACvC,IAAI,GAAG,oBAAS,CAAC,UAAU,CAAC;YAC5B,MAAM;QACP,CAAC;QACD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACrC,IAAI,GAAG,oBAAS,CAAC,QAAQ,CAAC;YAC1B,MAAM;QACP,CAAC;QACD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACrC,IAAI,GAAG,oBAAS,CAAC,QAAQ,CAAC;YAC1B,MAAM;QACP,CAAC;QACD,KAAK,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;YACtC,IAAI,GAAG,oBAAS,CAAC,QAAQ,CAAC;YAC1B,IAAA,iBAAM,EAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;YACrE,MAAM;QACP,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,IAAA,eAAI,EAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IACD,OAAO;QACN,IAAI;QACJ,kBAAkB,EAAE,+CAA+C,CAAC,MAAM,CAAC,KAAK,CAAC;QACjF,QAAQ,EAAE,EAAE;QACZ,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;KAC3C,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,4BAA4B,CACpC,MAA4B;IAE5B,MAAM,UAAU,GAAG,IAAA,iCAAsB,EAAC,MAAM,CAAC,CAAC;IAClD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,KAAK;YACpB,kBAAkB,EAAE,+CAA+C,CAAC,UAAU,CAAC;YAC/E,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,YAAY,iCAAsB,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAwD,CAAC;QAC/E,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC1D,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,GAAG,6BAA6B,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,MAAM;YACrB,MAAM;YACN,0BAA0B,EAAE,SAAS;YACrC,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,YAAY,8BAAmB,EAAE,CAAC;QAC3C,IAAA,iBAAM,EACL,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,EACxD,KAAK,CAAC,wBAAwB,CAC9B,CAAC;QACF,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,GAAG;YAClB,kBAAkB,EAAE,+CAA+C,CAClE,MAAM,CAAC,SAAS,CAAC,KAAK,CACtB;YACD,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,YAAY,+BAAoB,EAAE,CAAC;QAC5C,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,IAAI;YACnB,QAAQ,EAAE,MAAM,CAAC,SAAS;YAC1B,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAA,eAAI,EAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;AACvC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ErasedType, IFluidLoadable } from \"@fluidframework/core-interfaces/internal\";\nimport { assert, fail } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IIdCompressor, StableId } from \"@fluidframework/id-compressor\";\nimport type { MinimumVersionForCollab } from \"@fluidframework/runtime-definitions/internal\";\nimport type {\n\tIChannelView,\n\tIFluidSerializer,\n\tSharedKernel,\n} from \"@fluidframework/shared-object-base/internal\";\nimport { type TelemetryLoggerExt, UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\ttype CodecTree,\n\ttype CodecWriteOptions,\n\ttype CodecWriteOptionsBeta,\n\tDependentFormatVersion,\n\tFluidClientVersion,\n\tFormatValidatorNoOp,\n\ttype ICodecOptions,\n} from \"../codec/index.js\";\nimport {\n\ttype FieldKey,\n\ttype GraphCommit,\n\ttype IEditableForest,\n\ttype JsonableTree,\n\tLeafNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\tRevisionTagCodec,\n\ttype TreeFieldStoredSchema,\n\ttype TreeNodeStoredSchema,\n\ttype TreeStoredSchema,\n\tTreeStoredSchemaRepository,\n\ttype TreeStoredSchemaSubscription,\n\ttype TreeTypeSet,\n\tdetachedFieldIndexCodecBuilder,\n\tmakeDetachedFieldIndex,\n\tmoveToDetachedField,\n} from \"../core/index.js\";\nimport {\n\tDetachedFieldIndexSummarizer,\n\tFieldBatchDecodingContext,\n\tFieldKinds,\n\tForestSummarizer,\n\tSchemaSummarizer,\n\tTreeCompressionStrategy,\n\tbuildChunkedForest,\n\tbuildForest,\n\tComparisonForest,\n\tdefaultIncrementalEncodingPolicy,\n\tdefaultSchemaPolicy,\n\tfieldBatchCodecBuilder,\n\tforestCodecBuilder,\n\tjsonableTreeFromFieldCursor,\n\tmakeMitigatedChangeFamily,\n\tmakeTreeChunker,\n\ttype FieldBatchEncodingContext,\n\ttype IncrementalEncodingPolicy,\n} from \"../feature-libraries/index.js\";\nimport { schemaCodecBuilder } from \"../feature-libraries/index.js\";\nimport {\n\ttype BranchId,\n\ttype ClonableSchemaAndPolicy,\n\tgetCodecTreeForEditManagerFormatWithChange,\n\tgetCodecTreeForMessageFormatWithChange,\n\tmakeMessageCodecBuilder,\n\ttype SharedTreeCoreOptionsInternal,\n\tMessageFormatVersion,\n\tSharedTreeCore,\n\tEditManagerFormatVersion,\n\tmakeEditManagerCodecBuilder,\n} from \"../shared-tree-core/index.js\";\nimport {\n\ttype ImplicitFieldSchema,\n\tNodeKind,\n\ttype ReadSchema,\n\ttype SimpleFieldSchema,\n\ttype SimpleTreeSchema,\n\ttype TreeView,\n\ttype TreeViewConfiguration,\n\ttype UnsafeUnknownSchema,\n\ttype VerboseTree,\n\ttryStoredSchemaAsArray,\n\ttype SimpleNodeSchema,\n\tFieldKind,\n\ttype ITreeAlpha,\n\ttype SimpleObjectFieldSchema,\n\ttype SimpleAllowedTypeAttributes,\n\ttype SchemaType,\n} from \"../simple-tree/index.js\";\nimport {\n\ttype Breakable,\n\tbreakingClass,\n\ttype JsonCompatible,\n\tthrowIfBroken,\n} from \"../util/index.js\";\n\nimport type { SchematizingSimpleTreeView } from \"./schematizingTreeView.js\";\nimport {\n\tgetCodecTreeForChangeFormat,\n\tSharedTreeChangeFormatVersion,\n} from \"./sharedTreeChangeCodecs.js\";\nimport type { SharedTreeChangeProcessingContext } from \"./sharedTreeChangeFamily.js\";\nimport { SharedTreeChangeFamily } from \"./sharedTreeChangeFamily.js\";\nimport type { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\nimport type { SharedTreeEditBuilder } from \"./sharedTreeEditBuilder.js\";\nimport { type TreeCheckout, createTreeCheckout } from \"./treeCheckout.js\";\n\n/**\n * Copy of data from an {@link ITreePrivate} at some point in time.\n * @remarks\n * This is unrelated to Fluids concept of \"snapshots\".\n */\nexport interface SharedTreeContentSnapshot {\n\t/**\n\t * The schema stored in the document.\n\t *\n\t * @remarks\n\t * Edits to the schema can mutate the schema stored of the tree which took this snapshot (but this snapshot will remain the same)\n\t * This is mainly useful for debugging cases where schematize reports an incompatible view schema.\n\t */\n\treadonly schema: TreeStoredSchema;\n\t/**\n\t * All {@link TreeStatus.InDocument} content.\n\t */\n\treadonly tree: JsonableTree[];\n\t/**\n\t * All {@link TreeStatus.Removed} content.\n\t */\n\treadonly removed: [string | number | undefined, number, JsonableTree][];\n}\n\n/**\n * {@link ITree} extended with some non-public APIs.\n * @internal\n */\nexport interface ITreeInternal extends IChannelView, ITreeAlpha {}\n\n/**\n * {@link ITreeInternal} extended with some non-exported APIs.\n * @remarks\n * This allows access to the tree content using the internal data model used at the storage and \"flex\" layers,\n * and should only be needed for testing and debugging this package's internals.\n */\nexport interface ITreePrivate extends ITreeInternal {\n\t/**\n\t * Provides a copy of the current content of the tree.\n\t * This can be useful for inspecting the tree when no suitable view schema is available.\n\t * This is only intended for use in testing and exceptional code paths: it is not performant.\n\t *\n\t * This does not include everything that is included in a tree summary, since information about how to merge future edits is omitted.\n\t */\n\tcontentSnapshot(): SharedTreeContentSnapshot;\n\n\t/**\n\t * Access to internals for testing.\n\t */\n\treadonly kernel: SharedTreeKernel;\n}\n\n/**\n * The type SharedTree's kernel's view must implement so what when its merged with the underling SharedObject's API it fully implements the required tree API surface ({@link ITreePrivate }).\n */\nexport type SharedTreeKernelView = Omit<ITreePrivate, keyof (IChannelView & IFluidLoadable)>;\n\n/**\n * SharedTreeCore, configured with a good set of indexes and field kinds which will maintain compatibility over time.\n *\n * TODO: detail compatibility requirements.\n */\n@breakingClass\nexport class SharedTreeKernel\n\textends SharedTreeCore<\n\t\tSharedTreeEditBuilder,\n\t\tSharedTreeChange,\n\t\tSharedTreeChangeProcessingContext\n\t>\n\timplements SharedKernel\n{\n\tpublic readonly checkout: TreeCheckout;\n\tpublic get storedSchema(): TreeStoredSchemaRepository {\n\t\treturn this.checkout.storedSchema;\n\t}\n\n\tprivate readonly checkouts: Map<BranchId, TreeCheckout> = new Map();\n\n\t/**\n\t * The app-facing API for SharedTree implemented by this Kernel.\n\t * @remarks\n\t * This is the API grafted onto the ISharedObject which apps can access.\n\t * It includes both the APIs used for internal testing, and public facing APIs (both stable and unstable).\n\t * Different users will have access to different subsets of this API, see {@link ITree}, {@link ITreeAlpha} and {@link ITreeInternal} which this {@link ITreePrivate} extends.\n\t */\n\tpublic readonly view: SharedTreeKernelView;\n\n\tpublic constructor(\n\t\tbreaker: Breakable,\n\t\tsharedObject: IChannelView & IFluidLoadable,\n\t\tserializer: IFluidSerializer,\n\t\tsubmitLocalMessage: (content: unknown, localOpMetadata?: unknown) => void,\n\t\tlastSequenceNumber: () => number | undefined,\n\t\tinitialSequenceNumber: number,\n\t\tprivate readonly logger: TelemetryLoggerExt | undefined,\n\t\tidCompressor: IIdCompressor,\n\t\toptionsParam: SharedTreeOptionsInternal,\n\t) {\n\t\tconst options: Required<SharedTreeOptionsInternal> = {\n\t\t\t...defaultSharedTreeOptions,\n\t\t\t...optionsParam,\n\t\t};\n\t\tif (options.minVersionForCollab < FluidClientVersion.v2_0) {\n\t\t\tthrow new UsageError(\"SharedTree requires minVersionForCollab of at least 2.0.0\");\n\t\t}\n\t\tconst schema = new TreeStoredSchemaRepository();\n\t\tconst forest = buildConfiguredForest(\n\t\t\tbreaker,\n\t\t\toptions.forest,\n\t\t\tschema,\n\t\t\tidCompressor,\n\t\t\toptions.shouldEncodeIncrementally,\n\t\t);\n\t\tconst removedRoots = makeDetachedFieldIndex(\"repair\");\n\t\tconst schemaCodec = schemaCodecBuilder.build(options);\n\t\tconst schemaSummarizer = new SchemaSummarizer(\n\t\t\tschema,\n\t\t\t{\n\t\t\t\tgetCurrentSeq: lastSequenceNumber,\n\t\t\t},\n\t\t\tschemaCodec,\n\t\t\toptions.minVersionForCollab,\n\t\t);\n\t\tconst fieldBatchCodec = fieldBatchCodecBuilder.build(options);\n\n\t\tconst encoderContext: FieldBatchEncodingContext = {\n\t\t\tschema: {\n\t\t\t\tschema,\n\t\t\t\tpolicy: defaultSchemaPolicy,\n\t\t\t},\n\t\t\tencodeType: options.treeEncodeType,\n\t\t\tidCompressor,\n\t\t\t// ForestSummarizer is the only consumer of this context, and it\n\t\t\t// only invokes the codec in summary encode / load paths.\n\t\t\tisSummary: true,\n\t\t};\n\t\tconst decoderContext = FieldBatchDecodingContext.forSummary({\n\t\t\tidCompressor,\n\t\t\thealing:\n\t\t\t\toptions.healUnresolvableIdentifiersOnDecode === true\n\t\t\t\t\t? { sharedObjectId: sharedObject.id, logger }\n\t\t\t\t\t: undefined,\n\t\t});\n\t\tconst forestSummarizer = new ForestSummarizer(\n\t\t\tforest,\n\t\t\tencoderContext,\n\t\t\tdecoderContext,\n\t\t\toptions,\n\t\t\tidCompressor,\n\t\t\tinitialSequenceNumber,\n\t\t\toptions.shouldEncodeIncrementally,\n\t\t);\n\t\tconst revisionTagCodec = new RevisionTagCodec(idCompressor);\n\t\tconst removedRootsSummarizer = new DetachedFieldIndexSummarizer(\n\t\t\tremovedRoots,\n\t\t\trevisionTagCodec,\n\t\t\tidCompressor,\n\t\t\toptions,\n\t\t);\n\t\tconst innerChangeFamily = new SharedTreeChangeFamily(\n\t\t\trevisionTagCodec,\n\t\t\tfieldBatchCodec,\n\t\t\toptions,\n\t\t\toptions.treeEncodeType,\n\t\t\tidCompressor,\n\t\t);\n\t\tconst changeFamily = makeMitigatedChangeFamily(\n\t\t\tinnerChangeFamily,\n\t\t\tSharedTreeChangeFamily.emptyChange,\n\t\t\t(error: unknown) => {\n\t\t\t\t// TODO:6344 Add telemetry for these errors.\n\t\t\t\t// Rethrowing the error has a different effect depending on the context in which the\n\t\t\t\t// ChangeFamily was invoked:\n\t\t\t\t// - If the ChangeFamily was invoked as part of incoming op processing, rethrowing the error\n\t\t\t\t// will cause the runtime to disconnect the client, log a severe error, and not reconnect.\n\t\t\t\t// This will not cause the host application to crash because it is not on the stack at that time.\n\t\t\t\t// TODO: let the host application know that the client is now disconnected.\n\t\t\t\t// - If the ChangeFamily was invoked as part of dealing with a local change, rethrowing the\n\t\t\t\t// error will cause the host application to crash. This is not ideal, but is better than\n\t\t\t\t// letting the application either send an invalid change to the server or allowing the\n\t\t\t\t// application to continue working when its local branches contain edits that cannot be\n\t\t\t\t// reflected in its views.\n\t\t\t\t// The best course of action for a host application in such a state is to restart.\n\t\t\t\t// TODO: let the host application know about this situation and provide a way to\n\t\t\t\t// programmatically reload the SharedTree container.\n\t\t\t\tthrow error;\n\t\t\t},\n\t\t);\n\t\tsuper(\n\t\t\tbreaker,\n\t\t\tsharedObject,\n\t\t\tserializer,\n\t\t\tsubmitLocalMessage,\n\t\t\tlogger,\n\t\t\t[schemaSummarizer, forestSummarizer, removedRootsSummarizer],\n\t\t\tchangeFamily,\n\t\t\toptions,\n\t\t\tchangeFormatVersionForEditManager,\n\t\t\tchangeFormatVersionForMessage,\n\t\t\tidCompressor,\n\t\t\tschema,\n\t\t\tdefaultSchemaPolicy,\n\t\t);\n\n\t\tthis.checkout = createTreeCheckout(idCompressor, this.mintRevisionTag, revisionTagCodec, {\n\t\t\tbranch: this.getLocalBranch(),\n\t\t\tchangeFamily,\n\t\t\tschema,\n\t\t\tforest,\n\t\t\tfieldBatchCodec,\n\t\t\tremovedRoots,\n\t\t\tchunkCompressionStrategy: options.treeEncodeType,\n\t\t\tlogger,\n\t\t\tbreaker: this.breaker,\n\t\t});\n\n\t\tthis.registerSharedBranchForEditing(\"main\", this.checkout);\n\t\tthis.registerCheckout(\"main\", this.checkout);\n\n\t\tthis.view = {\n\t\t\tcontentSnapshot: () => this.contentSnapshot(),\n\t\t\texportSimpleSchema: () => this.exportSimpleSchema(),\n\t\t\texportVerbose: () => this.exportVerbose(),\n\t\t\tviewWith: this.viewWith.bind(this),\n\t\t\tviewSharedBranchWith: this.viewBranchWith.bind(this),\n\t\t\tcreateSharedBranch: this.createSharedBranch.bind(this),\n\t\t\tgetSharedBranchName: this.getSharedBranchName.bind(this),\n\t\t\tgetSharedBranchIds: this.getSharedBranchIds.bind(this),\n\t\t\tkernel: this,\n\t\t};\n\t}\n\n\tprivate registerCheckout(branchId: BranchId, checkout: TreeCheckout): void {\n\t\tthis.checkouts.set(branchId, checkout);\n\t}\n\n\tpublic exportVerbose(): VerboseTree | undefined {\n\t\treturn this.checkout.exportVerbose();\n\t}\n\n\tpublic exportSimpleSchema(): SimpleTreeSchema {\n\t\treturn exportSimpleSchema(this.storedSchema);\n\t}\n\n\t@throwIfBroken\n\tpublic contentSnapshot(): SharedTreeContentSnapshot {\n\t\tconst cursor = this.checkout.forest.allocateCursor(\"contentSnapshot\");\n\t\ttry {\n\t\t\tmoveToDetachedField(this.checkout.forest, cursor);\n\t\t\treturn {\n\t\t\t\tschema: this.storedSchema.clone(),\n\t\t\t\ttree: jsonableTreeFromFieldCursor(cursor),\n\t\t\t\tremoved: this.checkout.getRemovedRoots(),\n\t\t\t};\n\t\t} finally {\n\t\t\tcursor.free();\n\t\t}\n\t}\n\n\t// For the new TreeViewAlpha API\n\tpublic viewWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(\n\t\tconfig: TreeViewConfiguration<ReadSchema<TRoot>>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>>;\n\n\t// For the old TreeView API\n\tpublic viewWith<TRoot extends ImplicitFieldSchema>(\n\t\tconfig: TreeViewConfiguration<TRoot>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<TRoot>;\n\n\tpublic viewWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(\n\t\tconfig: TreeViewConfiguration<ReadSchema<TRoot>>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>> {\n\t\treturn this.checkout.viewWith(config) as SchematizingSimpleTreeView<TRoot> &\n\t\t\tTreeView<ReadSchema<TRoot>>;\n\t}\n\n\tpublic viewBranchWith<TRoot extends ImplicitFieldSchema>(\n\t\tbranchId: string,\n\t\tconfig: TreeViewConfiguration<TRoot>,\n\t): TreeView<TRoot>;\n\n\tpublic viewBranchWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(\n\t\tbranchId: string,\n\t\tconfig: TreeViewConfiguration<ReadSchema<TRoot>>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>> {\n\t\tconst compressedId = this.idCompressor.tryRecompress(branchId as StableId);\n\t\tif (compressedId === undefined) {\n\t\t\tthrow new UsageError(`No branch found with id: ${branchId}`);\n\t\t}\n\t\treturn this.getCheckout(compressedId).viewWith(\n\t\t\tconfig,\n\t\t) as SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>>;\n\t}\n\n\tprivate getCheckout(branchId: BranchId): TreeCheckout {\n\t\treturn this.checkouts.get(branchId) ?? this.checkoutBranch(branchId);\n\t}\n\n\tprivate checkoutBranch(branchId: BranchId): TreeCheckout {\n\t\tconst checkout = this.checkout.fork();\n\t\tcheckout.switchBranch(this.getSharedBranch(branchId));\n\t\tthis.registerSharedBranchForEditing(branchId, checkout);\n\t\tthis.registerCheckout(branchId, checkout);\n\t\treturn checkout;\n\t}\n\n\tpublic override async loadCore(services: IChannelStorageService): Promise<void> {\n\t\tawait super.loadCore(services);\n\t\tthis.checkout.load();\n\t}\n\n\tpublic override didAttach(): void {\n\t\tfor (const checkout of this.checkouts.values()) {\n\t\t\tif (checkout.transaction.size > 0) {\n\t\t\t\t// Attaching during a transaction is not currently supported.\n\t\t\t\t// At least part of of the system is known to not handle this case correctly - commit enrichment - and there may be others.\n\t\t\t\tthrow new UsageError(\n\t\t\t\t\t\"Cannot attach while a transaction is in progress. Commit or abort the transaction before attaching.\",\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t\tsuper.didAttach();\n\t}\n\n\tpublic override applyStashedOp(\n\t\t...args: Parameters<\n\t\t\tSharedTreeCore<\n\t\t\t\tSharedTreeEditBuilder,\n\t\t\t\tSharedTreeChange,\n\t\t\t\tSharedTreeChangeProcessingContext\n\t\t\t>[\"applyStashedOp\"]\n\t\t>\n\t): void {\n\t\tfor (const checkout of this.checkouts.values()) {\n\t\t\tassert(\n\t\t\t\tcheckout.transaction.size === 0,\n\t\t\t\t0x674 /* Unexpected transaction is open while applying stashed ops */,\n\t\t\t);\n\t\t}\n\t\tsuper.applyStashedOp(...args);\n\t}\n\n\tprotected override submitCommit(\n\t\tbranchId: BranchId,\n\t\tcommit: GraphCommit<SharedTreeChange>,\n\t\tschemaAndPolicy: ClonableSchemaAndPolicy,\n\t\tisResubmit: boolean,\n\t): void {\n\t\tconst checkout = this.getCheckout(branchId);\n\t\tassert(\n\t\t\tcheckout.transaction.size === 0,\n\t\t\t0xaa6 /* Cannot submit a commit while a transaction is in progress */,\n\t\t);\n\t\tif (isResubmit) {\n\t\t\treturn super.submitCommit(branchId, commit, schemaAndPolicy, isResubmit);\n\t\t}\n\n\t\t// Refrain from submitting new commits until they are validated by the checkout.\n\t\t// This is not a strict requirement for correctness in our system, but in the event that there is a bug when applying commits to the checkout\n\t\t// that causes a crash (e.g. in the forest), this will at least prevent this client from sending the problematic commit to any other clients.\n\t\tcheckout.onCommitValid(commit, () =>\n\t\t\tsuper.submitCommit(branchId, commit, schemaAndPolicy, isResubmit),\n\t\t);\n\t}\n\n\tpublic onDisconnect(): void {}\n}\n\nexport function exportSimpleSchema(\n\tstoredSchema: TreeStoredSchema,\n): SimpleTreeSchema<SchemaType.Stored> {\n\treturn {\n\t\troot: exportSimpleFieldSchemaStored(storedSchema.rootFieldSchema),\n\t\tdefinitions: new Map(\n\t\t\t[...storedSchema.nodeSchema].map(([key, schema]) => {\n\t\t\t\treturn [key, exportSimpleNodeSchemaStored(schema)];\n\t\t\t}),\n\t\t),\n\t};\n}\n\n/**\n * A way to parse schema in the persisted format from {@link extractPersistedSchema}.\n * @remarks\n * This behaves identically to {@link ITreeAlpha.exportSimpleSchema},\n * except that it gets the schema from the caller instead of from an existing tree.\n *\n * This can be useful for inspecting the contents of persisted schema,\n * such as those generated by {@link extractPersistedSchema} for use in testing.\n * Since that data format is otherwise unspecified,\n * this provides a way to inspect its contents with documented semantics.\n * @alpha\n */\nexport function persistedToSimpleSchema(\n\tpersisted: JsonCompatible,\n\toptions: ICodecOptions,\n): SimpleTreeSchema {\n\tconst schemaCodec = schemaCodecBuilder.buildDecoder(options);\n\tconst stored = schemaCodec.decode(persisted);\n\treturn exportSimpleSchema(stored);\n}\n\n/**\n * Defines for each EditManagerFormatVersion the SharedTreeChangeFormatVersion to use.\n * This is an arbitrary mapping that is injected in the EditManger codec.\n * Once an entry is defined and used in production, it cannot be changed.\n * This is because the format for SharedTree changes are not explicitly versioned.\n */\nexport const changeFormatVersionForEditManager = DependentFormatVersion.fromPairs<\n\tEditManagerFormatVersion,\n\tSharedTreeChangeFormatVersion\n>([\n\t[EditManagerFormatVersion.v3, SharedTreeChangeFormatVersion.v3],\n\t[EditManagerFormatVersion.v4, SharedTreeChangeFormatVersion.v4],\n\t[EditManagerFormatVersion.vSharedBranches, SharedTreeChangeFormatVersion.v4],\n\t[EditManagerFormatVersion.v6, SharedTreeChangeFormatVersion.v5],\n]);\n\n/**\n * Defines for each MessageFormatVersion the SharedTreeChangeFormatVersion to use.\n * This is an arbitrary mapping that is injected in the message codec.\n * Once an entry is defined and used in production, it cannot be changed.\n * This is because the format for SharedTree changes are not explicitly versioned.\n */\nexport const changeFormatVersionForMessage = DependentFormatVersion.fromPairs<\n\tMessageFormatVersion,\n\tSharedTreeChangeFormatVersion\n>([\n\t[MessageFormatVersion.v3, SharedTreeChangeFormatVersion.v3],\n\t[MessageFormatVersion.v4, SharedTreeChangeFormatVersion.v4],\n\t[MessageFormatVersion.vSharedBranches, SharedTreeChangeFormatVersion.v4],\n\t[MessageFormatVersion.v6, SharedTreeChangeFormatVersion.v5],\n]);\n\nfunction getCodecTreeForEditManagerFormat(clientVersion: MinimumVersionForCollab): CodecTree {\n\tconst editManagerVersion = makeEditManagerCodecBuilder().getCodecTree(clientVersion).version;\n\tconst change = changeFormatVersionForEditManager.lookup(editManagerVersion);\n\tconst changeCodecTree = getCodecTreeForChangeFormat(change, clientVersion);\n\treturn getCodecTreeForEditManagerFormatWithChange(clientVersion, changeCodecTree);\n}\n\nfunction getCodecTreeForMessageFormat(clientVersion: MinimumVersionForCollab): CodecTree {\n\tconst messageVersion = makeMessageCodecBuilder().getCodecTree(clientVersion).version;\n\tassert(\n\t\tmessageVersion !== undefined,\n\t\t0xce3 /* Deprecated 'undefined' version shouldn't be selected */,\n\t);\n\tconst change = changeFormatVersionForMessage.lookup(messageVersion);\n\tconst changeCodecTree = getCodecTreeForChangeFormat(change, clientVersion);\n\treturn getCodecTreeForMessageFormatWithChange(clientVersion, changeCodecTree);\n}\n\nexport function getCodecTreeForSharedTreeFormat(\n\tclientVersion: MinimumVersionForCollab,\n): CodecTree {\n\tconst children: CodecTree[] = [];\n\tchildren.push(forestCodecBuilder.getCodecTree(clientVersion));\n\tchildren.push(schemaCodecBuilder.getCodecTree(clientVersion));\n\tchildren.push(detachedFieldIndexCodecBuilder.getCodecTree(clientVersion));\n\tchildren.push(getCodecTreeForEditManagerFormat(clientVersion));\n\tchildren.push(getCodecTreeForMessageFormat(clientVersion));\n\tchildren.push(fieldBatchCodecBuilder.getCodecTree(clientVersion));\n\treturn {\n\t\tname: \"SharedTree\",\n\t\tversion: undefined, // SharedTree does not have a version of its own.\n\t\tchildren,\n\t};\n}\n\n/**\n * Configuration options for SharedTree.\n * @beta @input\n */\nexport interface SharedTreeOptionsBeta extends ForestOptions, Partial<CodecWriteOptionsBeta> {\n\t/**\n\t * When `true`, when an improperly encoded identifier is encountered in a summary,\n\t * a new identifier will be generated instead of throwing an error.\n\t *\n\t * @defaultValue `false`\n\t *\n\t * @remarks\n\t * The intended use is recovering documents whose attach summary was persisted\n\t * with unresolvable node identifiers (a SharedTree-attaches-to-already-attached-container\n\t * scenario). Without this flag enabled, a client opening such a document will throw at summary load time.\n\t * With this flag enabled, unresolvable identifiers are replaced at decode time with stable UUIDs\n\t * derived deterministically from the data store id and the unresolvable op-space integer,\n\t * so every reader of the same blob (other than the originator) agrees on the resulting in-memory id.\n\t * Healed identifiers are written back out at the next summary in their stable UUID form,\n\t * so the inconsistency does not need to be re-healed on every load.\n\t *\n\t * When this flag is enabled, each time an unresolvable identifier is healed a\n\t * `HealUnresolvableIdentifierOnDecode` telemetry event is emitted (at\n\t * {@link @fluidframework/core-interfaces#LogLevelConst.info | LogLevel.info}) through the shared\n\t * object's logger, allowing applications to detect which documents actually required healing.\n\t *\n\t * Off by default because enabling it for documents that are not actually corrupt\n\t * would mask genuine bugs that otherwise surface as decode failures.\n\t *\n\t * This mitigation is also not perfect as the client that originated the non-finalized\n\t * will not apply the same \"healing\" and will continue to use the original identifier.\n\t * The difference in identifiers between the originating client and subsequent clients that load\n\t * the document is not ideal but generally benign to Fluid. However, it may have application-level\n\t * consequences (e.g. if the application stores the identifiers elsewhere, either in other parts of\n\t * Fluid data or externally). Applications should consider whether this risk is acceptable before\n\t * enabling this option.\n\t *\n\t * @privateRemarks\n\t * \"Unresolvable\" in the public-facing remarks corresponds to non-finalized short IDs persisted without\n\t * any corresponding context for their originating session. See id-compressor internal documentation\n\t * for more details.\n\t *\n\t * Internally this boolean is translated into {@link IdentifierHealingConfig} once the shared-object\n\t * id is known (in `SharedTreeCore`'s constructor) and threaded through the codec contexts as a\n\t * single `healing?` field from there on. The presence/absence of that config is the heal-on/heal-off\n\t * discriminator inside the codec layer.\n\t */\n\treadonly healUnresolvableIdentifiersOnDecode?: boolean;\n}\n\n/**\n * Configuration options for SharedTree with alpha features.\n * @alpha @input\n */\nexport interface SharedTreeOptions\n\textends SharedTreeOptionsBeta,\n\t\tPartial<CodecWriteOptions>,\n\t\tPartial<SharedTreeFormatOptions> {\n\t/**\n\t * Experimental feature flag to enable shared branches.\n\t * This feature is not yet complete and should not be used in production.\n\t * Defaults to false.\n\t */\n\treadonly enableSharedBranches?: boolean;\n\t/**\n\t * Returns whether a node / field should be incrementally encoded.\n\t * @remarks\n\t * See {@link IncrementalEncodingPolicy}.\n\t */\n\tshouldEncodeIncrementally?: IncrementalEncodingPolicy;\n\n\t/**\n\t * When `true`, prevents trunk commits from being trimmed/evicted, even after they fall outside\n\t * the collaboration window.\n\t *\n\t * @defaultValue `false`\n\t *\n\t * @remarks\n\t * By default, SharedTree evicts trunk commits once all peers have acknowledged them (i.e. once they\n\t * are outside the collaboration window), and they are not otherwise retained (e.g. by revertibles or\n\t * local branches), to bound memory usage. Enabling this flag retains the full trunk history for the\n\t * lifetime of the client, which increases memory usage over time and should be used with care.\n\t */\n\treadonly retainHistory?: boolean;\n}\n\nexport interface SharedTreeOptionsInternal\n\textends SharedTreeOptions,\n\t\tPartial<SharedTreeCoreOptionsInternal> {}\n\n/**\n * Configuration options for SharedTree's internal tree storage.\n * @beta @input\n */\nexport interface ForestOptions {\n\t/**\n\t * The {@link ForestType} indicating which forest type should be created for the SharedTree.\n\t */\n\treadonly forest?: ForestType;\n}\n\n/**\n * Options for configuring the persisted format SharedTree uses.\n * @alpha @input\n */\nexport interface SharedTreeFormatOptions {\n\t/**\n\t * See {@link TreeCompressionStrategy}.\n\t * default: TreeCompressionStrategy.Compressed\n\t */\n\ttreeEncodeType: TreeCompressionStrategy;\n}\n\n/**\n * Used to distinguish between different forest types.\n * @remarks\n * The \"Forest\" is the internal data structure used to store all the trees (the main tree and any removed ones) for a given view or branch.\n * ForestTypes should all have the same behavior, but may differ in performance and debuggability.\n *\n * Current options are {@link ForestTypeReference}, {@link ForestTypeOptimized} and {@link ForestTypeExpensiveDebug}.\n * @privateRemarks\n * Implement using {@link toForestType}.\n * Consume using {@link buildConfiguredForest}.\n * @sealed @beta\n */\nexport interface ForestType extends ErasedType<\"ForestType\"> {}\n\n/**\n * Reference implementation of forest.\n * @remarks\n * A simple implementation with minimal complexity and moderate debuggability, validation and performance.\n * @privateRemarks\n * The \"ObjectForest\" forest type.\n * @beta\n */\nexport const ForestTypeReference = toForestType(\n\t(breaker: Breakable, schema: TreeStoredSchemaSubscription, idCompressor: IIdCompressor) =>\n\t\tbuildForest(breaker, schema),\n);\n\n/**\n * Optimized implementation of forest.\n * @remarks\n * A complex optimized forest implementation, which has minimal validation and debuggability to optimize for performance.\n * Uses an internal representation optimized for size designed to scale to larger datasets with reduced overhead.\n * @privateRemarks\n * The \"ChunkedForest\" forest type.\n * @beta\n */\nexport const ForestTypeOptimized = toForestType(\n\t(\n\t\tbreaker: Breakable,\n\t\tschema: TreeStoredSchemaSubscription,\n\t\tidCompressor: IIdCompressor,\n\t\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n\t) =>\n\t\tbuildChunkedForest(\n\t\t\tmakeTreeChunker(schema, defaultSchemaPolicy, shouldEncodeIncrementally),\n\t\t\tundefined,\n\t\t\tidCompressor,\n\t\t),\n);\n\n/**\n * Slow implementation of forest intended only for debugging.\n * @remarks\n * Includes validation with scales poorly.\n * May be asymptotically slower than {@link ForestTypeReference}, and may perform very badly with larger data sizes.\n * @privateRemarks\n * A {@link ComparisonForest} which uses the \"ChunkedForest\" forest type as its main forest and validates every delta\n * against a reference \"ObjectForest\" (with expensive asserts enabled for schema validation).\n * This exercises the optimized forest while asserting that its contents stay consistent with the reference implementation.\n * @beta\n */\nexport const ForestTypeExpensiveDebug = toForestType(\n\t(\n\t\tbreaker: Breakable,\n\t\tschema: TreeStoredSchemaSubscription,\n\t\tidCompressor: IIdCompressor,\n\t\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n\t) =>\n\t\tnew ComparisonForest(\n\t\t\tbuildChunkedForest(\n\t\t\t\tmakeTreeChunker(schema, defaultSchemaPolicy, shouldEncodeIncrementally),\n\t\t\t\tundefined,\n\t\t\t\tidCompressor,\n\t\t\t),\n\t\t\tbuildForest(breaker, schema, undefined, true),\n\t\t),\n);\n\ntype ForestFactory = (\n\tbreaker: Breakable,\n\tschema: TreeStoredSchemaSubscription,\n\tidCompressor: IIdCompressor,\n\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n) => IEditableForest;\n\nfunction toForestType(factory: ForestFactory): ForestType {\n\treturn factory as unknown as ForestType;\n}\n\n/**\n * Build and return a forest of the requested type.\n */\nexport function buildConfiguredForest(\n\tbreaker: Breakable,\n\tfactory: ForestType,\n\tschema: TreeStoredSchemaSubscription,\n\tidCompressor: IIdCompressor,\n\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n): IEditableForest {\n\treturn (factory as unknown as ForestFactory)(\n\t\tbreaker,\n\t\tschema,\n\t\tidCompressor,\n\t\tshouldEncodeIncrementally,\n\t);\n}\n\nexport const defaultSharedTreeOptions: Required<SharedTreeOptionsInternal> = {\n\tjsonValidator: FormatValidatorNoOp,\n\tminVersionForCollab: FluidClientVersion.v2_0,\n\tforest: ForestTypeReference,\n\ttreeEncodeType: TreeCompressionStrategy.Compressed,\n\tshouldEncodeIncrementally: defaultIncrementalEncodingPolicy,\n\tenableSharedBranches: false,\n\thealUnresolvableIdentifiersOnDecode: false,\n\twriteVersionOverrides: new Map(),\n\tallowPossiblyIncompatibleWriteVersionOverrides: false,\n\tretainHistory: false,\n};\n\n/**\n * Build the allowed types for a Stored Schema.\n *\n * @remarks Staged upgrades do not apply to stored schemas, so we omit the {@link SimpleAllowedTypeAttributes.isStaged | staging flag } when building {@link SimpleAllowedTypeAttributes}.\n * @param types - The types to create allowed types for.\n * @returns The allowed types.\n */\nfunction buildSimpleAllowedTypeAttributesForStoredSchema(\n\ttypes: TreeTypeSet,\n): ReadonlyMap<string, SimpleAllowedTypeAttributes<SchemaType.Stored>> {\n\tconst allowedTypesInfo = new Map<string, SimpleAllowedTypeAttributes<SchemaType.Stored>>();\n\tfor (const type of types) {\n\t\t// Stored schemas do not have staged upgrades\n\t\tallowedTypesInfo.set(type, { isStaged: undefined });\n\t}\n\treturn allowedTypesInfo;\n}\n\nfunction exportSimpleFieldSchemaStored(\n\tschema: TreeFieldStoredSchema,\n): SimpleFieldSchema<SchemaType.Stored> {\n\tlet kind: FieldKind;\n\tswitch (schema.kind) {\n\t\tcase FieldKinds.identifier.identifier: {\n\t\t\tkind = FieldKind.Identifier;\n\t\t\tbreak;\n\t\t}\n\t\tcase FieldKinds.optional.identifier: {\n\t\t\tkind = FieldKind.Optional;\n\t\t\tbreak;\n\t\t}\n\t\tcase FieldKinds.required.identifier: {\n\t\t\tkind = FieldKind.Required;\n\t\t\tbreak;\n\t\t}\n\t\tcase FieldKinds.forbidden.identifier: {\n\t\t\tkind = FieldKind.Optional;\n\t\t\tassert(schema.types.size === 0, 0xa94 /* invalid forbidden field */);\n\t\t\tbreak;\n\t\t}\n\t\tdefault: {\n\t\t\tfail(0xaca /* invalid field kind */);\n\t\t}\n\t}\n\treturn {\n\t\tkind,\n\t\tsimpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(schema.types),\n\t\tmetadata: {},\n\t\tpersistedMetadata: schema.persistedMetadata,\n\t};\n}\n\n/**\n * Export a {@link SimpleNodeSchema} from a {@link TreeNodeStoredSchema}.\n * @privateRemarks\n * TODO: Persist node metadata once schema FormatV2 is supported.\n * Note on SimpleNodeSchema construction: In the persisted format `persistedMetadata` is just called `metadata` whereas the `metadata`\n * field on SimpleNodeSchema is not persisted.\n */\nfunction exportSimpleNodeSchemaStored(\n\tschema: TreeNodeStoredSchema,\n): SimpleNodeSchema<SchemaType.Stored> {\n\tconst arrayTypes = tryStoredSchemaAsArray(schema);\n\tif (arrayTypes !== undefined) {\n\t\treturn {\n\t\t\tkind: NodeKind.Array,\n\t\t\tsimpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(arrayTypes),\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\tconst fields = new Map<FieldKey, SimpleObjectFieldSchema<SchemaType.Stored>>();\n\t\tfor (const [storedKey, field] of schema.objectNodeFields) {\n\t\t\tfields.set(storedKey, { ...exportSimpleFieldSchemaStored(field), storedKey });\n\t\t}\n\t\treturn {\n\t\t\tkind: NodeKind.Object,\n\t\t\tfields,\n\t\t\tallowUnknownOptionalFields: undefined,\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tif (schema instanceof MapNodeStoredSchema) {\n\t\tassert(\n\t\t\tschema.mapFields.kind === FieldKinds.optional.identifier,\n\t\t\t0xa95 /* Invalid map schema */,\n\t\t);\n\t\treturn {\n\t\t\tkind: NodeKind.Map,\n\t\t\tsimpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(\n\t\t\t\tschema.mapFields.types,\n\t\t\t),\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\treturn {\n\t\t\tkind: NodeKind.Leaf,\n\t\t\tleafKind: schema.leafValue,\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tfail(0xacb /* invalid schema kind */);\n}\n"]}
+{"version":3,"file":"sharedTree.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAGH,kEAAmE;AASnE,uEAAsE;AAEtE,gDAQ2B;AAC3B,+CAkB0B;AAC1B,4DAmBuC;AACvC,4DAAmE;AACnE,2DAWsC;AACtC,sDAiBiC;AACjC,+CAK0B;AAG1B,2EAGqC;AAErC,2EAAqE;AAGrE,uDAA0E;AA2D1E;;;;GAIG;IAEU,gBAAgB;4BAD5B,wBAAa;;;;sBAEL,yBAAc;;;6CAAtB,SAAQ,WAIP;QAID,IAAW,YAAY;YACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACnC,CAAC;QAaD,YACC,OAAkB,EAClB,YAA2C,EAC3C,UAA4B,EAC5B,kBAAyE,EACzE,kBAA4C,EAC5C,qBAA6B,EAC7B,YAA2B,EAC3B,YAAuC;YAEvC,MAAM,OAAO,GAAwC;gBACpD,GAAG,gCAAwB;gBAC3B,GAAG,YAAY;aACf,CAAC;YACF,IAAI,OAAO,CAAC,mBAAmB,GAAG,6BAAkB,CAAC,IAAI,EAAE,CAAC;gBAC3D,MAAM,IAAI,qBAAU,CAAC,2DAA2D,CAAC,CAAC;YACnF,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,qCAA0B,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,qBAAqB,CACnC,OAAO,EACP,OAAO,CAAC,MAAM,EACd,MAAM,EACN,YAAY,EACZ,OAAO,CAAC,yBAAyB,CACjC,CAAC;YACF,MAAM,YAAY,GAAG,IAAA,iCAAsB,EAAC,QAAQ,CAAC,CAAC;YACtD,MAAM,WAAW,GAAG,6BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtD,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAC5C,MAAM,EACN;gBACC,aAAa,EAAE,kBAAkB;aACjC,EACD,WAAW,EACX,OAAO,CAAC,mBAAmB,CAC3B,CAAC;YACF,MAAM,eAAe,GAAG,iCAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE9D,MAAM,cAAc,GAA8B;gBACjD,MAAM,EAAE;oBACP,MAAM;oBACN,MAAM,EAAE,8BAAmB;iBAC3B;gBACD,UAAU,EAAE,OAAO,CAAC,cAAc;gBAClC,YAAY;gBACZ,gEAAgE;gBAChE,yDAAyD;gBACzD,SAAS,EAAE,IAAI;aACf,CAAC;YACF,MAAM,cAAc,GAAG,oCAAyB,CAAC,UAAU,CAAC;gBAC3D,YAAY;gBACZ,OAAO,EACN,OAAO,CAAC,mCAAmC,KAAK,IAAI;oBACnD,CAAC,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;oBAC7D,CAAC,CAAC,SAAS;aACb,CAAC,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAC5C,MAAM,EACN,cAAc,EACd,cAAc,EACd,OAAO,EACP,YAAY,EACZ,qBAAqB,EACrB,OAAO,CAAC,yBAAyB,CACjC,CAAC;YACF,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,YAAY,CAAC,CAAC;YAC5D,MAAM,sBAAsB,GAAG,IAAI,uCAA4B,CAC9D,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,OAAO,CACP,CAAC;YACF,MAAM,iBAAiB,GAAG,IAAI,kDAAsB,CACnD,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,OAAO,CAAC,cAAc,EACtB,YAAY,CACZ,CAAC;YACF,MAAM,YAAY,GAAG,IAAA,oCAAyB,EAC7C,iBAAiB,EACjB,kDAAsB,CAAC,WAAW,EAClC,CAAC,KAAc,EAAE,EAAE;gBAClB,4CAA4C;gBAC5C,oFAAoF;gBACpF,4BAA4B;gBAC5B,4FAA4F;gBAC5F,0FAA0F;gBAC1F,iGAAiG;gBACjG,2EAA2E;gBAC3E,2FAA2F;gBAC3F,wFAAwF;gBACxF,sFAAsF;gBACtF,uFAAuF;gBACvF,0BAA0B;gBAC1B,kFAAkF;gBAClF,gFAAgF;gBAChF,oDAAoD;gBACpD,MAAM,KAAK,CAAC;YACb,CAAC,CACD,CAAC;YACF,KAAK,CACJ,OAAO,EACP,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAC5D,YAAY,EACZ,OAAO,EACP,yCAAiC,EACjC,qCAA6B,EAC7B,YAAY,EACZ,MAAM,EACN,8BAAmB,CACnB,CAAC;YAjIa,aAAQ,GARZ,2DAAgB,CAQW;YAKtB,cAAS,GAAgC,IAAI,GAAG,EAAE,CAAC;YA8HnE,IAAI,CAAC,QAAQ,GAAG,IAAA,oCAAkB,EAAC,YAAY,EAAE,IAAI,CAAC,eAAe,EAAE,gBAAgB,EAAE;gBACxF,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE;gBAC7B,YAAY;gBACZ,MAAM;gBACN,MAAM;gBACN,eAAe;gBACf,YAAY;gBACZ,wBAAwB,EAAE,OAAO,CAAC,cAAc;aAChD,CAAC,CAAC;YAEH,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3D,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAE7C,IAAI,CAAC,IAAI,GAAG;gBACX,eAAe,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE;gBAC7C,kBAAkB,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,EAAE;gBACnD,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;gBACzC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;gBAClC,oBAAoB,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;gBACpD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;gBACtD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;gBACxD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;gBACtD,MAAM,EAAE,IAAI;aACZ,CAAC;QACH,CAAC;QAEO,gBAAgB,CAAC,QAAkB,EAAE,QAAsB;YAClE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;QAEM,aAAa;YACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;QACtC,CAAC;QAEM,kBAAkB;YACxB,OAAO,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;QAGM,eAAe;YACrB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACtE,IAAI,CAAC;gBACJ,IAAA,8BAAmB,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAClD,OAAO;oBACN,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;oBACjC,IAAI,EAAE,IAAA,sCAA2B,EAAC,MAAM,CAAC;oBACzC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;iBACxC,CAAC;YACH,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,IAAI,EAAE,CAAC;YACf,CAAC;QACF,CAAC;QAYM,QAAQ,CACd,MAAgD;YAEhD,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CACR,CAAC;QAC9B,CAAC;QAOM,cAAc,CACpB,QAAgB,EAChB,MAAgD;YAEhD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,QAAoB,CAAC,CAAC;YAC3E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,qBAAU,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,QAAQ,CAC7C,MAAM,CAC6D,CAAC;QACtE,CAAC;QAEO,WAAW,CAAC,QAAkB;YACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACtE,CAAC;QAEO,cAAc,CAAC,QAAkB;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,8BAA8B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC1C,OAAO,QAAQ,CAAC;QACjB,CAAC;QAEe,KAAK,CAAC,QAAQ,CAAC,QAAgC;YAC9D,MAAM,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;QAEe,SAAS;YACxB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChD,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oBACnC,6DAA6D;oBAC7D,2HAA2H;oBAC3H,MAAM,IAAI,qBAAU,CACnB,qGAAqG,CACrG,CAAC;gBACH,CAAC;YACF,CAAC;YACD,KAAK,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC;QAEe,cAAc,CAC7B,GAAG,IAMF;YAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChD,IAAA,iBAAM,EACL,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAC/B,KAAK,CAAC,+DAA+D,CACrE,CAAC;YACH,CAAC;YACD,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC;QAEkB,YAAY,CAC9B,QAAkB,EAClB,MAAqC,EACrC,eAAwC,EACxC,UAAmB;YAEnB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC5C,IAAA,iBAAM,EACL,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAC/B,KAAK,CAAC,+DAA+D,CACrE,CAAC;YACF,IAAI,UAAU,EAAE,CAAC;gBAChB,OAAO,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;YAC1E,CAAC;YAED,gFAAgF;YAChF,6IAA6I;YAC7I,6IAA6I;YAC7I,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,CACnC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,CAAC,CACjE,CAAC;QACH,CAAC;QAEM,YAAY,KAAU,CAAC;;;;;uCAzH7B,wBAAa;QACd,8MAAO,eAAe,6DAYrB;QA9LF,qLA2SC;;;QA3SY,+DAAgB;;;;AAAhB,4CAAgB;AA6S7B,SAAgB,kBAAkB,CACjC,YAA8B;IAE9B,OAAO;QACN,IAAI,EAAE,6BAA6B,CAAC,YAAY,CAAC,eAAe,CAAC;QACjE,WAAW,EAAE,IAAI,GAAG,CACnB,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE;YAClD,OAAO,CAAC,GAAG,EAAE,4BAA4B,CAAC,MAAM,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC,CACF;KACD,CAAC;AACH,CAAC;AAXD,gDAWC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,uBAAuB,CACtC,SAAyB,EACzB,OAAsB;IAEtB,MAAM,WAAW,GAAG,6BAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7C,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAPD,0DAOC;AAED;;;;;GAKG;AACU,QAAA,iCAAiC,GAAG,iCAAsB,CAAC,SAAS,CAG/E;IACD,CAAC,mCAAwB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC/D,CAAC,mCAAwB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC/D,CAAC,mCAAwB,CAAC,eAAe,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC5E,CAAC,mCAAwB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;CAC/D,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,6BAA6B,GAAG,iCAAsB,CAAC,SAAS,CAG3E;IACD,CAAC,+BAAoB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC3D,CAAC,+BAAoB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;IAC3D,CAAC,+BAAoB,CAAC,eAAe,EAAE,yDAA6B,CAAC,EAAE,CAAC;IACxE,CAAC,+BAAoB,CAAC,EAAE,EAAE,yDAA6B,CAAC,EAAE,CAAC;CAC3D,CAAC,CAAC;AAEH,SAAS,gCAAgC,CACxC,aAA2C;IAE3C,MAAM,kBAAkB,GAAG,IAAA,sCAA2B,GAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;IAC7F,MAAM,MAAM,GAAG,yCAAiC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC5E,MAAM,eAAe,GAAG,IAAA,uDAA2B,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3E,OAAO,IAAA,qDAA0C,EAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,4BAA4B,CAAC,aAA2C;IAChF,MAAM,cAAc,GAAG,IAAA,kCAAuB,GAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;IACrF,IAAA,iBAAM,EACL,cAAc,KAAK,SAAS,EAC5B,KAAK,CAAC,0DAA0D,CAChE,CAAC;IACF,MAAM,MAAM,GAAG,qCAA6B,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACpE,MAAM,eAAe,GAAG,IAAA,uDAA2B,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3E,OAAO,IAAA,iDAAsC,EAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AAC/E,CAAC;AAED,SAAgB,+BAA+B,CAC9C,aAA2C;IAE3C,MAAM,QAAQ,GAAgB,EAAE,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,6BAAkB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,IAAI,CAAC,6BAAkB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,IAAI,CAAC,yCAA8B,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAC1E,QAAQ,CAAC,IAAI,CAAC,gCAAgC,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,QAAQ,CAAC,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,CAAC,CAAC;IAC3D,QAAQ,CAAC,IAAI,CAAC,iCAAsB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;IAClE,OAAO;QACN,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE,SAAS,EAAE,iDAAiD;QACrE,QAAQ;KACR,CAAC;AACH,CAAC;AAfD,0EAeC;AA8JD;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,YAAY,CAC9C,CAAC,OAAkB,EAAE,MAAoC,EAAE,YAA2B,EAAE,EAAE,CACzF,IAAA,sBAAW,EAAC,OAAO,EAAE,MAAM,CAAC,CAC7B,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,mBAAmB,GAAG,YAAY,CAC9C,CACC,OAAkB,EAClB,MAAoC,EACpC,YAA2B,EAC3B,yBAAoD,EACnD,EAAE,CACH,IAAA,6BAAkB,EACjB,IAAA,0BAAe,EAAC,MAAM,EAAE,8BAAmB,EAAE,yBAAyB,CAAC,EACvE,SAAS,EACT,YAAY,EACZ,OAAO,CACP,CACF,CAAC;AAEF;;;;;;;;;;GAUG;AACU,QAAA,wBAAwB,GAAG,YAAY,CACnD,CACC,OAAkB,EAClB,MAAoC,EACpC,YAA2B,EAC3B,yBAAoD,EACnD,EAAE,CACH,IAAI,2BAAgB,CACnB,IAAA,6BAAkB,EACjB,IAAA,0BAAe,EAAC,MAAM,EAAE,8BAAmB,EAAE,yBAAyB,CAAC,EACvE,SAAS,EACT,YAAY,EACZ,OAAO,CACP,EACD,IAAA,sBAAW,EAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAC7C,CACF,CAAC;AASF,SAAS,YAAY,CAAC,OAAsB;IAC3C,OAAO,OAAgC,CAAC;AACzC,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CACpC,OAAkB,EAClB,OAAmB,EACnB,MAAoC,EACpC,YAA2B,EAC3B,yBAAoD;IAEpD,OAAQ,OAAoC,CAC3C,OAAO,EACP,MAAM,EACN,YAAY,EACZ,yBAAyB,CACzB,CAAC;AACH,CAAC;AAbD,sDAaC;AAEY,QAAA,wBAAwB,GAAwC;IAC5E,aAAa,EAAE,8BAAmB;IAClC,mBAAmB,EAAE,6BAAkB,CAAC,IAAI;IAC5C,MAAM,EAAE,2BAAmB;IAC3B,cAAc,EAAE,kCAAuB,CAAC,UAAU;IAClD,yBAAyB,EAAE,2CAAgC;IAC3D,oBAAoB,EAAE,KAAK;IAC3B,mCAAmC,EAAE,KAAK;IAC1C,qBAAqB,EAAE,IAAI,GAAG,EAAE;IAChC,8CAA8C,EAAE,KAAK;IACrD,aAAa,EAAE,KAAK;IACpB,gCAAgC,EAAE,KAAK;IACvC,wCAAwC,EAAE,KAAK;CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,+CAA+C,CACvD,KAAkB;IAElB,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA0D,CAAC;IAC3F,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,6CAA6C;QAC7C,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,gBAAgB,CAAC;AACzB,CAAC;AAED,SAAS,6BAA6B,CACrC,MAA6B;IAE7B,IAAI,IAAe,CAAC;IACpB,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,qBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;YACvC,IAAI,GAAG,oBAAS,CAAC,UAAU,CAAC;YAC5B,MAAM;QACP,CAAC;QACD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACrC,IAAI,GAAG,oBAAS,CAAC,QAAQ,CAAC;YAC1B,MAAM;QACP,CAAC;QACD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YACrC,IAAI,GAAG,oBAAS,CAAC,QAAQ,CAAC;YAC1B,MAAM;QACP,CAAC;QACD,KAAK,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;YACtC,IAAI,GAAG,oBAAS,CAAC,QAAQ,CAAC;YAC1B,IAAA,iBAAM,EAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;YACrE,MAAM;QACP,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,IAAA,eAAI,EAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IACD,OAAO;QACN,IAAI;QACJ,kBAAkB,EAAE,+CAA+C,CAAC,MAAM,CAAC,KAAK,CAAC;QACjF,QAAQ,EAAE,EAAE;QACZ,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;KAC3C,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,4BAA4B,CACpC,MAA4B;IAE5B,MAAM,UAAU,GAAG,IAAA,iCAAsB,EAAC,MAAM,CAAC,CAAC;IAClD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,KAAK;YACpB,kBAAkB,EAAE,+CAA+C,CAAC,UAAU,CAAC;YAC/E,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,YAAY,iCAAsB,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAwD,CAAC;QAC/E,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC1D,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,GAAG,6BAA6B,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,MAAM;YACrB,MAAM;YACN,0BAA0B,EAAE,SAAS;YACrC,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,YAAY,8BAAmB,EAAE,CAAC;QAC3C,IAAA,iBAAM,EACL,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,EACxD,KAAK,CAAC,wBAAwB,CAC9B,CAAC;QACF,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,GAAG;YAClB,kBAAkB,EAAE,+CAA+C,CAClE,MAAM,CAAC,SAAS,CAAC,KAAK,CACtB;YACD,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,YAAY,+BAAoB,EAAE,CAAC;QAC5C,OAAO;YACN,IAAI,EAAE,mBAAQ,CAAC,IAAI;YACnB,QAAQ,EAAE,MAAM,CAAC,SAAS;YAC1B,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,MAAM,CAAC,QAAQ;SAClC,CAAC;IACH,CAAC;IACD,IAAA,eAAI,EAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;AACvC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ErasedType, IFluidLoadable } from \"@fluidframework/core-interfaces/internal\";\nimport { assert, fail } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IIdCompressor, StableId } from \"@fluidframework/id-compressor\";\nimport type { OldestSupportedClientVersion } from \"@fluidframework/runtime-definitions/internal\";\nimport type {\n\tIChannelView,\n\tIFluidSerializer,\n\tSharedKernel,\n} from \"@fluidframework/shared-object-base/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\ttype CodecTree,\n\ttype CodecWriteOptions,\n\ttype CodecWriteOptionsBeta,\n\tDependentFormatVersion,\n\tFluidClientVersion,\n\tFormatValidatorNoOp,\n\ttype ICodecOptions,\n} from \"../codec/index.js\";\nimport {\n\ttype FieldKey,\n\ttype GraphCommit,\n\ttype IEditableForest,\n\ttype JsonableTree,\n\tLeafNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\tRevisionTagCodec,\n\ttype TreeFieldStoredSchema,\n\ttype TreeNodeStoredSchema,\n\ttype TreeStoredSchema,\n\tTreeStoredSchemaRepository,\n\ttype TreeStoredSchemaSubscription,\n\ttype TreeTypeSet,\n\tdetachedFieldIndexCodecBuilder,\n\tmakeDetachedFieldIndex,\n\tmoveToDetachedField,\n} from \"../core/index.js\";\nimport {\n\tDetachedFieldIndexSummarizer,\n\tFieldBatchDecodingContext,\n\tFieldKinds,\n\tForestSummarizer,\n\tSchemaSummarizer,\n\tTreeCompressionStrategy,\n\tbuildChunkedForest,\n\tbuildForest,\n\tComparisonForest,\n\tdefaultIncrementalEncodingPolicy,\n\tdefaultSchemaPolicy,\n\tfieldBatchCodecBuilder,\n\tforestCodecBuilder,\n\tjsonableTreeFromFieldCursor,\n\tmakeMitigatedChangeFamily,\n\tmakeTreeChunker,\n\ttype FieldBatchEncodingContext,\n\ttype IncrementalEncodingPolicy,\n} from \"../feature-libraries/index.js\";\nimport { schemaCodecBuilder } from \"../feature-libraries/index.js\";\nimport {\n\ttype BranchId,\n\ttype ClonableSchemaAndPolicy,\n\tgetCodecTreeForEditManagerFormatWithChange,\n\tgetCodecTreeForMessageFormatWithChange,\n\tmakeMessageCodecBuilder,\n\ttype SharedTreeCoreOptionsInternal,\n\tMessageFormatVersion,\n\tSharedTreeCore,\n\tEditManagerFormatVersion,\n\tmakeEditManagerCodecBuilder,\n} from \"../shared-tree-core/index.js\";\nimport {\n\ttype ImplicitFieldSchema,\n\tNodeKind,\n\ttype ReadSchema,\n\ttype SimpleFieldSchema,\n\ttype SimpleTreeSchema,\n\ttype TreeView,\n\ttype TreeViewConfiguration,\n\ttype UnsafeUnknownSchema,\n\ttype VerboseTree,\n\ttryStoredSchemaAsArray,\n\ttype SimpleNodeSchema,\n\tFieldKind,\n\ttype ITreeAlpha,\n\ttype SimpleObjectFieldSchema,\n\ttype SimpleAllowedTypeAttributes,\n\ttype SchemaType,\n} from \"../simple-tree/index.js\";\nimport {\n\ttype Breakable,\n\tbreakingClass,\n\ttype JsonCompatible,\n\tthrowIfBroken,\n} from \"../util/index.js\";\n\nimport type { SchematizingSimpleTreeView } from \"./schematizingTreeView.js\";\nimport {\n\tgetCodecTreeForChangeFormat,\n\tSharedTreeChangeFormatVersion,\n} from \"./sharedTreeChangeCodecs.js\";\nimport type { SharedTreeChangeProcessingContext } from \"./sharedTreeChangeFamily.js\";\nimport { SharedTreeChangeFamily } from \"./sharedTreeChangeFamily.js\";\nimport type { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\nimport type { SharedTreeEditBuilder } from \"./sharedTreeEditBuilder.js\";\nimport { type TreeCheckout, createTreeCheckout } from \"./treeCheckout.js\";\n\n/**\n * Copy of data from an {@link ITreePrivate} at some point in time.\n * @remarks\n * This is unrelated to Fluids concept of \"snapshots\".\n */\nexport interface SharedTreeContentSnapshot {\n\t/**\n\t * The schema stored in the document.\n\t *\n\t * @remarks\n\t * Edits to the schema can mutate the schema stored of the tree which took this snapshot (but this snapshot will remain the same)\n\t * This is mainly useful for debugging cases where schematize reports an incompatible view schema.\n\t */\n\treadonly schema: TreeStoredSchema;\n\t/**\n\t * All {@link TreeStatus.InDocument} content.\n\t */\n\treadonly tree: JsonableTree[];\n\t/**\n\t * All {@link TreeStatus.Removed} content.\n\t */\n\treadonly removed: [string | number | undefined, number, JsonableTree][];\n}\n\n/**\n * {@link ITree} extended with some non-public APIs.\n * @internal\n */\nexport interface ITreeInternal extends IChannelView, ITreeAlpha {}\n\n/**\n * {@link ITreeInternal} extended with some non-exported APIs.\n * @remarks\n * This allows access to the tree content using the internal data model used at the storage and \"flex\" layers,\n * and should only be needed for testing and debugging this package's internals.\n */\nexport interface ITreePrivate extends ITreeInternal {\n\t/**\n\t * Provides a copy of the current content of the tree.\n\t * This can be useful for inspecting the tree when no suitable view schema is available.\n\t * This is only intended for use in testing and exceptional code paths: it is not performant.\n\t *\n\t * This does not include everything that is included in a tree summary, since information about how to merge future edits is omitted.\n\t */\n\tcontentSnapshot(): SharedTreeContentSnapshot;\n\n\t/**\n\t * Access to internals for testing.\n\t */\n\treadonly kernel: SharedTreeKernel;\n}\n\n/**\n * The type SharedTree's kernel's view must implement so what when its merged with the underling SharedObject's API it fully implements the required tree API surface ({@link ITreePrivate }).\n */\nexport type SharedTreeKernelView = Omit<ITreePrivate, keyof (IChannelView & IFluidLoadable)>;\n\n/**\n * SharedTreeCore, configured with a good set of indexes and field kinds which will maintain compatibility over time.\n *\n * TODO: detail compatibility requirements.\n */\n@breakingClass\nexport class SharedTreeKernel\n\textends SharedTreeCore<\n\t\tSharedTreeEditBuilder,\n\t\tSharedTreeChange,\n\t\tSharedTreeChangeProcessingContext\n\t>\n\timplements SharedKernel\n{\n\tpublic readonly checkout: TreeCheckout;\n\tpublic get storedSchema(): TreeStoredSchemaRepository {\n\t\treturn this.checkout.storedSchema;\n\t}\n\n\tprivate readonly checkouts: Map<BranchId, TreeCheckout> = new Map();\n\n\t/**\n\t * The app-facing API for SharedTree implemented by this Kernel.\n\t * @remarks\n\t * This is the API grafted onto the ISharedObject which apps can access.\n\t * It includes both the APIs used for internal testing, and public facing APIs (both stable and unstable).\n\t * Different users will have access to different subsets of this API, see {@link ITree}, {@link ITreeAlpha} and {@link ITreeInternal} which this {@link ITreePrivate} extends.\n\t */\n\tpublic readonly view: SharedTreeKernelView;\n\n\tpublic constructor(\n\t\tbreaker: Breakable,\n\t\tsharedObject: IChannelView & IFluidLoadable,\n\t\tserializer: IFluidSerializer,\n\t\tsubmitLocalMessage: (content: unknown, localOpMetadata?: unknown) => void,\n\t\tlastSequenceNumber: () => number | undefined,\n\t\tinitialSequenceNumber: number,\n\t\tidCompressor: IIdCompressor,\n\t\toptionsParam: SharedTreeOptionsInternal,\n\t) {\n\t\tconst options: Required<SharedTreeOptionsInternal> = {\n\t\t\t...defaultSharedTreeOptions,\n\t\t\t...optionsParam,\n\t\t};\n\t\tif (options.minVersionForCollab < FluidClientVersion.v2_0) {\n\t\t\tthrow new UsageError(\"SharedTree requires minVersionForCollab of at least 2.0.0\");\n\t\t}\n\t\tconst schema = new TreeStoredSchemaRepository();\n\t\tconst forest = buildConfiguredForest(\n\t\t\tbreaker,\n\t\t\toptions.forest,\n\t\t\tschema,\n\t\t\tidCompressor,\n\t\t\toptions.shouldEncodeIncrementally,\n\t\t);\n\t\tconst removedRoots = makeDetachedFieldIndex(\"repair\");\n\t\tconst schemaCodec = schemaCodecBuilder.build(options);\n\t\tconst schemaSummarizer = new SchemaSummarizer(\n\t\t\tschema,\n\t\t\t{\n\t\t\t\tgetCurrentSeq: lastSequenceNumber,\n\t\t\t},\n\t\t\tschemaCodec,\n\t\t\toptions.minVersionForCollab,\n\t\t);\n\t\tconst fieldBatchCodec = fieldBatchCodecBuilder.build(options);\n\n\t\tconst encoderContext: FieldBatchEncodingContext = {\n\t\t\tschema: {\n\t\t\t\tschema,\n\t\t\t\tpolicy: defaultSchemaPolicy,\n\t\t\t},\n\t\t\tencodeType: options.treeEncodeType,\n\t\t\tidCompressor,\n\t\t\t// ForestSummarizer is the only consumer of this context, and it\n\t\t\t// only invokes the codec in summary encode / load paths.\n\t\t\tisSummary: true,\n\t\t};\n\t\tconst decoderContext = FieldBatchDecodingContext.forSummary({\n\t\t\tidCompressor,\n\t\t\thealing:\n\t\t\t\toptions.healUnresolvableIdentifiersOnDecode === true\n\t\t\t\t\t? { sharedObjectId: sharedObject.id, logger: breaker.logger }\n\t\t\t\t\t: undefined,\n\t\t});\n\t\tconst forestSummarizer = new ForestSummarizer(\n\t\t\tforest,\n\t\t\tencoderContext,\n\t\t\tdecoderContext,\n\t\t\toptions,\n\t\t\tidCompressor,\n\t\t\tinitialSequenceNumber,\n\t\t\toptions.shouldEncodeIncrementally,\n\t\t);\n\t\tconst revisionTagCodec = new RevisionTagCodec(idCompressor);\n\t\tconst removedRootsSummarizer = new DetachedFieldIndexSummarizer(\n\t\t\tremovedRoots,\n\t\t\trevisionTagCodec,\n\t\t\tidCompressor,\n\t\t\toptions,\n\t\t);\n\t\tconst innerChangeFamily = new SharedTreeChangeFamily(\n\t\t\trevisionTagCodec,\n\t\t\tfieldBatchCodec,\n\t\t\toptions,\n\t\t\toptions.treeEncodeType,\n\t\t\tidCompressor,\n\t\t);\n\t\tconst changeFamily = makeMitigatedChangeFamily(\n\t\t\tinnerChangeFamily,\n\t\t\tSharedTreeChangeFamily.emptyChange,\n\t\t\t(error: unknown) => {\n\t\t\t\t// TODO:6344 Add telemetry for these errors.\n\t\t\t\t// Rethrowing the error has a different effect depending on the context in which the\n\t\t\t\t// ChangeFamily was invoked:\n\t\t\t\t// - If the ChangeFamily was invoked as part of incoming op processing, rethrowing the error\n\t\t\t\t// will cause the runtime to disconnect the client, log a severe error, and not reconnect.\n\t\t\t\t// This will not cause the host application to crash because it is not on the stack at that time.\n\t\t\t\t// TODO: let the host application know that the client is now disconnected.\n\t\t\t\t// - If the ChangeFamily was invoked as part of dealing with a local change, rethrowing the\n\t\t\t\t// error will cause the host application to crash. This is not ideal, but is better than\n\t\t\t\t// letting the application either send an invalid change to the server or allowing the\n\t\t\t\t// application to continue working when its local branches contain edits that cannot be\n\t\t\t\t// reflected in its views.\n\t\t\t\t// The best course of action for a host application in such a state is to restart.\n\t\t\t\t// TODO: let the host application know about this situation and provide a way to\n\t\t\t\t// programmatically reload the SharedTree container.\n\t\t\t\tthrow error;\n\t\t\t},\n\t\t);\n\t\tsuper(\n\t\t\tbreaker,\n\t\t\tsharedObject,\n\t\t\tserializer,\n\t\t\tsubmitLocalMessage,\n\t\t\t[schemaSummarizer, forestSummarizer, removedRootsSummarizer],\n\t\t\tchangeFamily,\n\t\t\toptions,\n\t\t\tchangeFormatVersionForEditManager,\n\t\t\tchangeFormatVersionForMessage,\n\t\t\tidCompressor,\n\t\t\tschema,\n\t\t\tdefaultSchemaPolicy,\n\t\t);\n\n\t\tthis.checkout = createTreeCheckout(idCompressor, this.mintRevisionTag, revisionTagCodec, {\n\t\t\tbranch: this.getLocalBranch(),\n\t\t\tchangeFamily,\n\t\t\tschema,\n\t\t\tforest,\n\t\t\tfieldBatchCodec,\n\t\t\tremovedRoots,\n\t\t\tchunkCompressionStrategy: options.treeEncodeType,\n\t\t});\n\n\t\tthis.registerSharedBranchForEditing(\"main\", this.checkout);\n\t\tthis.registerCheckout(\"main\", this.checkout);\n\n\t\tthis.view = {\n\t\t\tcontentSnapshot: () => this.contentSnapshot(),\n\t\t\texportSimpleSchema: () => this.exportSimpleSchema(),\n\t\t\texportVerbose: () => this.exportVerbose(),\n\t\t\tviewWith: this.viewWith.bind(this),\n\t\t\tviewSharedBranchWith: this.viewBranchWith.bind(this),\n\t\t\tcreateSharedBranch: this.createSharedBranch.bind(this),\n\t\t\tgetSharedBranchName: this.getSharedBranchName.bind(this),\n\t\t\tgetSharedBranchIds: this.getSharedBranchIds.bind(this),\n\t\t\tkernel: this,\n\t\t};\n\t}\n\n\tprivate registerCheckout(branchId: BranchId, checkout: TreeCheckout): void {\n\t\tthis.checkouts.set(branchId, checkout);\n\t}\n\n\tpublic exportVerbose(): VerboseTree | undefined {\n\t\treturn this.checkout.exportVerbose();\n\t}\n\n\tpublic exportSimpleSchema(): SimpleTreeSchema {\n\t\treturn exportSimpleSchema(this.storedSchema);\n\t}\n\n\t@throwIfBroken\n\tpublic contentSnapshot(): SharedTreeContentSnapshot {\n\t\tconst cursor = this.checkout.forest.allocateCursor(\"contentSnapshot\");\n\t\ttry {\n\t\t\tmoveToDetachedField(this.checkout.forest, cursor);\n\t\t\treturn {\n\t\t\t\tschema: this.storedSchema.clone(),\n\t\t\t\ttree: jsonableTreeFromFieldCursor(cursor),\n\t\t\t\tremoved: this.checkout.getRemovedRoots(),\n\t\t\t};\n\t\t} finally {\n\t\t\tcursor.free();\n\t\t}\n\t}\n\n\t// For the new TreeViewAlpha API\n\tpublic viewWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(\n\t\tconfig: TreeViewConfiguration<ReadSchema<TRoot>>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>>;\n\n\t// For the old TreeView API\n\tpublic viewWith<TRoot extends ImplicitFieldSchema>(\n\t\tconfig: TreeViewConfiguration<TRoot>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<TRoot>;\n\n\tpublic viewWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(\n\t\tconfig: TreeViewConfiguration<ReadSchema<TRoot>>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>> {\n\t\treturn this.checkout.viewWith(config) as SchematizingSimpleTreeView<TRoot> &\n\t\t\tTreeView<ReadSchema<TRoot>>;\n\t}\n\n\tpublic viewBranchWith<TRoot extends ImplicitFieldSchema>(\n\t\tbranchId: string,\n\t\tconfig: TreeViewConfiguration<TRoot>,\n\t): TreeView<TRoot>;\n\n\tpublic viewBranchWith<TRoot extends ImplicitFieldSchema | UnsafeUnknownSchema>(\n\t\tbranchId: string,\n\t\tconfig: TreeViewConfiguration<ReadSchema<TRoot>>,\n\t): SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>> {\n\t\tconst compressedId = this.idCompressor.tryRecompress(branchId as StableId);\n\t\tif (compressedId === undefined) {\n\t\t\tthrow new UsageError(`No branch found with id: ${branchId}`);\n\t\t}\n\t\treturn this.getCheckout(compressedId).viewWith(\n\t\t\tconfig,\n\t\t) as SchematizingSimpleTreeView<TRoot> & TreeView<ReadSchema<TRoot>>;\n\t}\n\n\tprivate getCheckout(branchId: BranchId): TreeCheckout {\n\t\treturn this.checkouts.get(branchId) ?? this.checkoutBranch(branchId);\n\t}\n\n\tprivate checkoutBranch(branchId: BranchId): TreeCheckout {\n\t\tconst checkout = this.checkout.fork();\n\t\tcheckout.switchBranch(this.getSharedBranch(branchId));\n\t\tthis.registerSharedBranchForEditing(branchId, checkout);\n\t\tthis.registerCheckout(branchId, checkout);\n\t\treturn checkout;\n\t}\n\n\tpublic override async loadCore(services: IChannelStorageService): Promise<void> {\n\t\tawait super.loadCore(services);\n\t\tthis.checkout.load();\n\t}\n\n\tpublic override didAttach(): void {\n\t\tfor (const checkout of this.checkouts.values()) {\n\t\t\tif (checkout.transaction.size > 0) {\n\t\t\t\t// Attaching during a transaction is not currently supported.\n\t\t\t\t// At least part of of the system is known to not handle this case correctly - commit enrichment - and there may be others.\n\t\t\t\tthrow new UsageError(\n\t\t\t\t\t\"Cannot attach while a transaction is in progress. Commit or abort the transaction before attaching.\",\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t\tsuper.didAttach();\n\t}\n\n\tpublic override applyStashedOp(\n\t\t...args: Parameters<\n\t\t\tSharedTreeCore<\n\t\t\t\tSharedTreeEditBuilder,\n\t\t\t\tSharedTreeChange,\n\t\t\t\tSharedTreeChangeProcessingContext\n\t\t\t>[\"applyStashedOp\"]\n\t\t>\n\t): void {\n\t\tfor (const checkout of this.checkouts.values()) {\n\t\t\tassert(\n\t\t\t\tcheckout.transaction.size === 0,\n\t\t\t\t0x674 /* Unexpected transaction is open while applying stashed ops */,\n\t\t\t);\n\t\t}\n\t\tsuper.applyStashedOp(...args);\n\t}\n\n\tprotected override submitCommit(\n\t\tbranchId: BranchId,\n\t\tcommit: GraphCommit<SharedTreeChange>,\n\t\tschemaAndPolicy: ClonableSchemaAndPolicy,\n\t\tisResubmit: boolean,\n\t): void {\n\t\tconst checkout = this.getCheckout(branchId);\n\t\tassert(\n\t\t\tcheckout.transaction.size === 0,\n\t\t\t0xaa6 /* Cannot submit a commit while a transaction is in progress */,\n\t\t);\n\t\tif (isResubmit) {\n\t\t\treturn super.submitCommit(branchId, commit, schemaAndPolicy, isResubmit);\n\t\t}\n\n\t\t// Refrain from submitting new commits until they are validated by the checkout.\n\t\t// This is not a strict requirement for correctness in our system, but in the event that there is a bug when applying commits to the checkout\n\t\t// that causes a crash (e.g. in the forest), this will at least prevent this client from sending the problematic commit to any other clients.\n\t\tcheckout.onCommitValid(commit, () =>\n\t\t\tsuper.submitCommit(branchId, commit, schemaAndPolicy, isResubmit),\n\t\t);\n\t}\n\n\tpublic onDisconnect(): void {}\n}\n\nexport function exportSimpleSchema(\n\tstoredSchema: TreeStoredSchema,\n): SimpleTreeSchema<SchemaType.Stored> {\n\treturn {\n\t\troot: exportSimpleFieldSchemaStored(storedSchema.rootFieldSchema),\n\t\tdefinitions: new Map(\n\t\t\t[...storedSchema.nodeSchema].map(([key, schema]) => {\n\t\t\t\treturn [key, exportSimpleNodeSchemaStored(schema)];\n\t\t\t}),\n\t\t),\n\t};\n}\n\n/**\n * A way to parse schema in the persisted format from {@link extractPersistedSchema}.\n * @remarks\n * This behaves identically to {@link ITreeAlpha.exportSimpleSchema},\n * except that it gets the schema from the caller instead of from an existing tree.\n *\n * This can be useful for inspecting the contents of persisted schema,\n * such as those generated by {@link extractPersistedSchema} for use in testing.\n * Since that data format is otherwise unspecified,\n * this provides a way to inspect its contents with documented semantics.\n * @alpha\n */\nexport function persistedToSimpleSchema(\n\tpersisted: JsonCompatible,\n\toptions: ICodecOptions,\n): SimpleTreeSchema {\n\tconst schemaCodec = schemaCodecBuilder.buildDecoder(options);\n\tconst stored = schemaCodec.decode(persisted);\n\treturn exportSimpleSchema(stored);\n}\n\n/**\n * Defines for each EditManagerFormatVersion the SharedTreeChangeFormatVersion to use.\n * This is an arbitrary mapping that is injected in the EditManger codec.\n * Once an entry is defined and used in production, it cannot be changed.\n * This is because the format for SharedTree changes are not explicitly versioned.\n */\nexport const changeFormatVersionForEditManager = DependentFormatVersion.fromPairs<\n\tEditManagerFormatVersion,\n\tSharedTreeChangeFormatVersion\n>([\n\t[EditManagerFormatVersion.v3, SharedTreeChangeFormatVersion.v3],\n\t[EditManagerFormatVersion.v4, SharedTreeChangeFormatVersion.v4],\n\t[EditManagerFormatVersion.vSharedBranches, SharedTreeChangeFormatVersion.v4],\n\t[EditManagerFormatVersion.v6, SharedTreeChangeFormatVersion.v5],\n]);\n\n/**\n * Defines for each MessageFormatVersion the SharedTreeChangeFormatVersion to use.\n * This is an arbitrary mapping that is injected in the message codec.\n * Once an entry is defined and used in production, it cannot be changed.\n * This is because the format for SharedTree changes are not explicitly versioned.\n */\nexport const changeFormatVersionForMessage = DependentFormatVersion.fromPairs<\n\tMessageFormatVersion,\n\tSharedTreeChangeFormatVersion\n>([\n\t[MessageFormatVersion.v3, SharedTreeChangeFormatVersion.v3],\n\t[MessageFormatVersion.v4, SharedTreeChangeFormatVersion.v4],\n\t[MessageFormatVersion.vSharedBranches, SharedTreeChangeFormatVersion.v4],\n\t[MessageFormatVersion.v6, SharedTreeChangeFormatVersion.v5],\n]);\n\nfunction getCodecTreeForEditManagerFormat(\n\tclientVersion: OldestSupportedClientVersion,\n): CodecTree {\n\tconst editManagerVersion = makeEditManagerCodecBuilder().getCodecTree(clientVersion).version;\n\tconst change = changeFormatVersionForEditManager.lookup(editManagerVersion);\n\tconst changeCodecTree = getCodecTreeForChangeFormat(change, clientVersion);\n\treturn getCodecTreeForEditManagerFormatWithChange(clientVersion, changeCodecTree);\n}\n\nfunction getCodecTreeForMessageFormat(clientVersion: OldestSupportedClientVersion): CodecTree {\n\tconst messageVersion = makeMessageCodecBuilder().getCodecTree(clientVersion).version;\n\tassert(\n\t\tmessageVersion !== undefined,\n\t\t0xce3 /* Deprecated 'undefined' version shouldn't be selected */,\n\t);\n\tconst change = changeFormatVersionForMessage.lookup(messageVersion);\n\tconst changeCodecTree = getCodecTreeForChangeFormat(change, clientVersion);\n\treturn getCodecTreeForMessageFormatWithChange(clientVersion, changeCodecTree);\n}\n\nexport function getCodecTreeForSharedTreeFormat(\n\tclientVersion: OldestSupportedClientVersion,\n): CodecTree {\n\tconst children: CodecTree[] = [];\n\tchildren.push(forestCodecBuilder.getCodecTree(clientVersion));\n\tchildren.push(schemaCodecBuilder.getCodecTree(clientVersion));\n\tchildren.push(detachedFieldIndexCodecBuilder.getCodecTree(clientVersion));\n\tchildren.push(getCodecTreeForEditManagerFormat(clientVersion));\n\tchildren.push(getCodecTreeForMessageFormat(clientVersion));\n\tchildren.push(fieldBatchCodecBuilder.getCodecTree(clientVersion));\n\treturn {\n\t\tname: \"SharedTree\",\n\t\tversion: undefined, // SharedTree does not have a version of its own.\n\t\tchildren,\n\t};\n}\n\n/**\n * Configuration options for SharedTree.\n * @beta @input\n */\nexport interface SharedTreeOptionsBeta extends ForestOptions, Partial<CodecWriteOptionsBeta> {\n\t/**\n\t * When `true`, when an improperly encoded identifier is encountered in a summary,\n\t * a new identifier will be generated instead of throwing an error.\n\t *\n\t * @defaultValue `false`\n\t *\n\t * @remarks\n\t * The intended use is recovering documents whose attach summary was persisted\n\t * with unresolvable node identifiers (a SharedTree-attaches-to-already-attached-container\n\t * scenario). Without this flag enabled, a client opening such a document will throw at summary load time.\n\t * With this flag enabled, unresolvable identifiers are replaced at decode time with stable UUIDs\n\t * derived deterministically from the data store id and the unresolvable op-space integer,\n\t * so every reader of the same blob (other than the originator) agrees on the resulting in-memory id.\n\t * Healed identifiers are written back out at the next summary in their stable UUID form,\n\t * so the inconsistency does not need to be re-healed on every load.\n\t *\n\t * When this flag is enabled, each time an unresolvable identifier is healed a\n\t * `HealUnresolvableIdentifierOnDecode` telemetry event is emitted (at\n\t * {@link @fluidframework/core-interfaces#LogLevelConst.info | LogLevel.info}) through the shared\n\t * object's logger, allowing applications to detect which documents actually required healing.\n\t *\n\t * Off by default because enabling it for documents that are not actually corrupt\n\t * would mask genuine bugs that otherwise surface as decode failures.\n\t *\n\t * This mitigation is also not perfect as the client that originated the non-finalized\n\t * will not apply the same \"healing\" and will continue to use the original identifier.\n\t * The difference in identifiers between the originating client and subsequent clients that load\n\t * the document is not ideal but generally benign to Fluid. However, it may have application-level\n\t * consequences (e.g. if the application stores the identifiers elsewhere, either in other parts of\n\t * Fluid data or externally). Applications should consider whether this risk is acceptable before\n\t * enabling this option.\n\t *\n\t * @privateRemarks\n\t * \"Unresolvable\" in the public-facing remarks corresponds to non-finalized short IDs persisted without\n\t * any corresponding context for their originating session. See id-compressor internal documentation\n\t * for more details.\n\t *\n\t * Internally this boolean is translated into {@link IdentifierHealingConfig} once the shared-object\n\t * id is known (in `SharedTreeCore`'s constructor) and threaded through the codec contexts as a\n\t * single `healing?` field from there on. The presence/absence of that config is the heal-on/heal-off\n\t * discriminator inside the codec layer.\n\t */\n\treadonly healUnresolvableIdentifiersOnDecode?: boolean;\n}\n\n/**\n * Configuration options for SharedTree with alpha features.\n * @alpha @input\n */\nexport interface SharedTreeOptions\n\textends SharedTreeOptionsBeta,\n\t\tPartial<CodecWriteOptions>,\n\t\tPartial<SharedTreeFormatOptions> {\n\t/**\n\t * Experimental feature flag to enable shared branches.\n\t * This feature is not yet complete and should not be used in production.\n\t * Defaults to false.\n\t */\n\treadonly enableSharedBranches?: boolean;\n\t/**\n\t * Returns whether a node / field should be incrementally encoded.\n\t * @remarks\n\t * See {@link IncrementalEncodingPolicy}.\n\t */\n\tshouldEncodeIncrementally?: IncrementalEncodingPolicy;\n\n\t/**\n\t * When `true`, prevents trunk commits from being trimmed/evicted, even after they fall outside\n\t * the collaboration window.\n\t *\n\t * @defaultValue `false`\n\t *\n\t * @remarks\n\t * By default, SharedTree evicts trunk commits once all peers have acknowledged them (i.e. once they\n\t * are outside the collaboration window), and they are not otherwise retained (e.g. by revertibles or\n\t * local branches), to bound memory usage. Enabling this flag retains the full trunk history for the\n\t * lifetime of the client, which increases memory usage over time and should be used with care.\n\t */\n\treadonly retainHistory?: boolean;\n\n\t/**\n\t * When `true`, validates that commits being submitted for the first time can be applied without errors to a view.\n\t * In the event that a commit cannot be applied, SharedTree will throw an error and will enter a \"broken\" state, preventing the offending commit (and any further commits) from being submitted.\n\t *\n\t * This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code:\n\t * when the additional validation is enabled, a client will error instead of potentially corrupting the document.\n\t *\n\t * @defaultValue `false`\n\t *\n\t * @remarks\n\t * This validation is more expensive than {@link SharedTreeOptions.validateRebasedCommitsBeforeResubmission} because it is likely to be performed more often.\n\t * We recommend {@link ForestOptions.forest|configuring SharedTree} with the {@link ForestTypeOptimized|optimized forest implementation} to reduce its performance impact.\n\t */\n\treadonly validateCommitsOnFirstSubmission?: boolean;\n\n\t/**\n\t * When `true`, validates that the commits being resubmitted can be applied without errors to a view.\n\t * In the event that a commit cannot be applied, SharedTree will throw an error and will enter a \"broken\" state, preventing the offending commit (and any further commits) from being submitted.\n\t *\n\t * This can be enabled (at the cost of performance) to improve safety against document corruption in the event of a bug in the SharedTree code:\n\t * when the additional validation is enabled, a client will error instead of potentially corrupting the document.\n\t *\n\t * @defaultValue `false`\n\t *\n\t * @remarks\n\t * We recommend {@link ForestOptions.forest|configuring SharedTree} with the {@link ForestTypeOptimized|optimized forest implementation} to reduce the performance impact of this validation.\n\t */\n\treadonly validateRebasedCommitsBeforeResubmission?: boolean;\n}\n\nexport interface SharedTreeOptionsInternal\n\textends SharedTreeOptions,\n\t\tPartial<SharedTreeCoreOptionsInternal> {}\n\n/**\n * Configuration options for SharedTree's internal tree storage.\n * @beta @input\n */\nexport interface ForestOptions {\n\t/**\n\t * The {@link ForestType} indicating which forest type should be created for the SharedTree.\n\t */\n\treadonly forest?: ForestType;\n}\n\n/**\n * Options for configuring the persisted format SharedTree uses.\n * @alpha @input\n */\nexport interface SharedTreeFormatOptions {\n\t/**\n\t * See {@link TreeCompressionStrategy}.\n\t * default: TreeCompressionStrategy.Compressed\n\t */\n\ttreeEncodeType: TreeCompressionStrategy;\n}\n\n/**\n * Used to distinguish between different forest types.\n * @remarks\n * The \"Forest\" is the internal data structure used to store all the trees (the main tree and any removed ones) for a given view or branch.\n * ForestTypes should all have the same behavior, but may differ in performance and debuggability.\n *\n * Current options are {@link ForestTypeReference}, {@link ForestTypeOptimized} and {@link ForestTypeExpensiveDebug}.\n * @privateRemarks\n * Implement using {@link toForestType}.\n * Consume using {@link buildConfiguredForest}.\n * @sealed @beta\n */\nexport interface ForestType extends ErasedType<\"ForestType\"> {}\n\n/**\n * Reference implementation of forest.\n * @remarks\n * A simple implementation with minimal complexity and moderate debuggability, validation and performance.\n * @privateRemarks\n * The \"ObjectForest\" forest type.\n * @beta\n */\nexport const ForestTypeReference = toForestType(\n\t(breaker: Breakable, schema: TreeStoredSchemaSubscription, idCompressor: IIdCompressor) =>\n\t\tbuildForest(breaker, schema),\n);\n\n/**\n * Optimized implementation of forest.\n * @remarks\n * A complex optimized forest implementation, which has minimal validation and debuggability to optimize for performance.\n * Uses an internal representation optimized for size designed to scale to larger datasets with reduced overhead.\n * @privateRemarks\n * The \"ChunkedForest\" forest type.\n * @beta\n */\nexport const ForestTypeOptimized = toForestType(\n\t(\n\t\tbreaker: Breakable,\n\t\tschema: TreeStoredSchemaSubscription,\n\t\tidCompressor: IIdCompressor,\n\t\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n\t) =>\n\t\tbuildChunkedForest(\n\t\t\tmakeTreeChunker(schema, defaultSchemaPolicy, shouldEncodeIncrementally),\n\t\t\tundefined,\n\t\t\tidCompressor,\n\t\t\tbreaker,\n\t\t),\n);\n\n/**\n * Slow implementation of forest intended only for debugging.\n * @remarks\n * Includes validation with scales poorly.\n * May be asymptotically slower than {@link ForestTypeReference}, and may perform very badly with larger data sizes.\n * @privateRemarks\n * A {@link ComparisonForest} which uses the \"ChunkedForest\" forest type as its main forest and validates every delta\n * against a reference \"ObjectForest\" (with expensive asserts enabled for schema validation).\n * This exercises the optimized forest while asserting that its contents stay consistent with the reference implementation.\n * @beta\n */\nexport const ForestTypeExpensiveDebug = toForestType(\n\t(\n\t\tbreaker: Breakable,\n\t\tschema: TreeStoredSchemaSubscription,\n\t\tidCompressor: IIdCompressor,\n\t\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n\t) =>\n\t\tnew ComparisonForest(\n\t\t\tbuildChunkedForest(\n\t\t\t\tmakeTreeChunker(schema, defaultSchemaPolicy, shouldEncodeIncrementally),\n\t\t\t\tundefined,\n\t\t\t\tidCompressor,\n\t\t\t\tbreaker,\n\t\t\t),\n\t\t\tbuildForest(breaker, schema, undefined, true),\n\t\t),\n);\n\ntype ForestFactory = (\n\tbreaker: Breakable,\n\tschema: TreeStoredSchemaSubscription,\n\tidCompressor: IIdCompressor,\n\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n) => IEditableForest;\n\nfunction toForestType(factory: ForestFactory): ForestType {\n\treturn factory as unknown as ForestType;\n}\n\n/**\n * Build and return a forest of the requested type.\n */\nexport function buildConfiguredForest(\n\tbreaker: Breakable,\n\tfactory: ForestType,\n\tschema: TreeStoredSchemaSubscription,\n\tidCompressor: IIdCompressor,\n\tshouldEncodeIncrementally: IncrementalEncodingPolicy,\n): IEditableForest {\n\treturn (factory as unknown as ForestFactory)(\n\t\tbreaker,\n\t\tschema,\n\t\tidCompressor,\n\t\tshouldEncodeIncrementally,\n\t);\n}\n\nexport const defaultSharedTreeOptions: Required<SharedTreeOptionsInternal> = {\n\tjsonValidator: FormatValidatorNoOp,\n\tminVersionForCollab: FluidClientVersion.v2_0,\n\tforest: ForestTypeReference,\n\ttreeEncodeType: TreeCompressionStrategy.Compressed,\n\tshouldEncodeIncrementally: defaultIncrementalEncodingPolicy,\n\tenableSharedBranches: false,\n\thealUnresolvableIdentifiersOnDecode: false,\n\twriteVersionOverrides: new Map(),\n\tallowPossiblyIncompatibleWriteVersionOverrides: false,\n\tretainHistory: false,\n\tvalidateCommitsOnFirstSubmission: false,\n\tvalidateRebasedCommitsBeforeResubmission: false,\n};\n\n/**\n * Build the allowed types for a Stored Schema.\n *\n * @remarks Staged upgrades do not apply to stored schemas, so we omit the {@link SimpleAllowedTypeAttributes.isStaged | staging flag } when building {@link SimpleAllowedTypeAttributes}.\n * @param types - The types to create allowed types for.\n * @returns The allowed types.\n */\nfunction buildSimpleAllowedTypeAttributesForStoredSchema(\n\ttypes: TreeTypeSet,\n): ReadonlyMap<string, SimpleAllowedTypeAttributes<SchemaType.Stored>> {\n\tconst allowedTypesInfo = new Map<string, SimpleAllowedTypeAttributes<SchemaType.Stored>>();\n\tfor (const type of types) {\n\t\t// Stored schemas do not have staged upgrades\n\t\tallowedTypesInfo.set(type, { isStaged: undefined });\n\t}\n\treturn allowedTypesInfo;\n}\n\nfunction exportSimpleFieldSchemaStored(\n\tschema: TreeFieldStoredSchema,\n): SimpleFieldSchema<SchemaType.Stored> {\n\tlet kind: FieldKind;\n\tswitch (schema.kind) {\n\t\tcase FieldKinds.identifier.identifier: {\n\t\t\tkind = FieldKind.Identifier;\n\t\t\tbreak;\n\t\t}\n\t\tcase FieldKinds.optional.identifier: {\n\t\t\tkind = FieldKind.Optional;\n\t\t\tbreak;\n\t\t}\n\t\tcase FieldKinds.required.identifier: {\n\t\t\tkind = FieldKind.Required;\n\t\t\tbreak;\n\t\t}\n\t\tcase FieldKinds.forbidden.identifier: {\n\t\t\tkind = FieldKind.Optional;\n\t\t\tassert(schema.types.size === 0, 0xa94 /* invalid forbidden field */);\n\t\t\tbreak;\n\t\t}\n\t\tdefault: {\n\t\t\tfail(0xaca /* invalid field kind */);\n\t\t}\n\t}\n\treturn {\n\t\tkind,\n\t\tsimpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(schema.types),\n\t\tmetadata: {},\n\t\tpersistedMetadata: schema.persistedMetadata,\n\t};\n}\n\n/**\n * Export a {@link SimpleNodeSchema} from a {@link TreeNodeStoredSchema}.\n * @privateRemarks\n * TODO: Persist node metadata once schema FormatV2 is supported.\n * Note on SimpleNodeSchema construction: In the persisted format `persistedMetadata` is just called `metadata` whereas the `metadata`\n * field on SimpleNodeSchema is not persisted.\n */\nfunction exportSimpleNodeSchemaStored(\n\tschema: TreeNodeStoredSchema,\n): SimpleNodeSchema<SchemaType.Stored> {\n\tconst arrayTypes = tryStoredSchemaAsArray(schema);\n\tif (arrayTypes !== undefined) {\n\t\treturn {\n\t\t\tkind: NodeKind.Array,\n\t\t\tsimpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(arrayTypes),\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\tconst fields = new Map<FieldKey, SimpleObjectFieldSchema<SchemaType.Stored>>();\n\t\tfor (const [storedKey, field] of schema.objectNodeFields) {\n\t\t\tfields.set(storedKey, { ...exportSimpleFieldSchemaStored(field), storedKey });\n\t\t}\n\t\treturn {\n\t\t\tkind: NodeKind.Object,\n\t\t\tfields,\n\t\t\tallowUnknownOptionalFields: undefined,\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tif (schema instanceof MapNodeStoredSchema) {\n\t\tassert(\n\t\t\tschema.mapFields.kind === FieldKinds.optional.identifier,\n\t\t\t0xa95 /* Invalid map schema */,\n\t\t);\n\t\treturn {\n\t\t\tkind: NodeKind.Map,\n\t\t\tsimpleAllowedTypes: buildSimpleAllowedTypeAttributesForStoredSchema(\n\t\t\t\tschema.mapFields.types,\n\t\t\t),\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\treturn {\n\t\t\tkind: NodeKind.Leaf,\n\t\t\tleafKind: schema.leafValue,\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: schema.metadata,\n\t\t};\n\t}\n\tfail(0xacb /* invalid schema kind */);\n}\n"]}

package/dist/shared-tree/sharedTreeChangeCodecs.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import type { MinimumVersionForCollab } from "@fluidframework/runtime-definitions/internal";
+import type { OldestSupportedClientVersion } from "@fluidframework/runtime-definitions/internal";
 import { type CodecTree, type CodecWriteOptions, type ICodecFamily } from "../codec/index.js";
 import type { ChangeEncodingContext, ChangeDecodingContext } from "../core/index.js";
 import { ModularChangeFormatVersion, type ModularChangeset } from "../feature-libraries/index.js";
@@ -30,6 +30,6 @@ export type SharedTreeChangeFormatVersion = Values<typeof SharedTreeChangeFormat
  * SchemaFormatVersion (used by SchemaChangeFormat) is not included here since it is explicitly versioned.
  */
 export declare const dependenciesForChangeFormat: Map<SharedTreeChangeFormatVersion, ChangeFormatDependencies>;
-export declare function getCodecTreeForChangeFormat(version: SharedTreeChangeFormatVersion, clientVersion: MinimumVersionForCollab): CodecTree;
+export declare function getCodecTreeForChangeFormat(version: SharedTreeChangeFormatVersion, clientVersion: OldestSupportedClientVersion): CodecTree;
 export {};
 //# sourceMappingURL=sharedTreeChangeCodecs.d.ts.map

package/dist/shared-tree/sharedTreeChangeCodecs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTreeChangeCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8CAA8C,CAAC;AAE5F,OAAO,EACN,KAAK,SAAS,EACd,KAAK,iBAAiB,EAGtB,KAAK,YAAY,EAIjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACX,qBAAqB,EACrB,qBAAqB,EAErB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,0BAA0B,EAC1B,KAAK,gBAAgB,EAKrB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAIN,KAAK,MAAM,EACX,MAAM,kBAAkB,CAAC;AAM1B,OAAO,KAAK,EAAE,gBAAgB,EAAyB,MAAM,4BAA4B,CAAC;AAE1F,wBAAgB,+BAA+B,CAC9C,wBAAwB,EAAE,YAAY,CACrC,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,CACrB,EACD,OAAO,EAAE,iBAAiB,GACxB,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,EAAE,qBAAqB,CAAC,CAc9E;AAED,UAAU,wBAAwB;IACjC,QAAQ,CAAC,aAAa,EAAE,0BAA0B,CAAC;CACnD;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;CAqBxC,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEzF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,8DAsBtC,CAAC;AAEH,wBAAgB,2BAA2B,CAC1C,OAAO,EAAE,6BAA6B,EACtC,aAAa,EAAE,uBAAuB,GACpC,SAAS,CAWX"}
+{"version":3,"file":"sharedTreeChangeCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAC;AAEjG,OAAO,EACN,KAAK,SAAS,EACd,KAAK,iBAAiB,EAGtB,KAAK,YAAY,EAIjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACX,qBAAqB,EACrB,qBAAqB,EAErB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,0BAA0B,EAC1B,KAAK,gBAAgB,EAKrB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAIN,KAAK,MAAM,EACX,MAAM,kBAAkB,CAAC;AAM1B,OAAO,KAAK,EAAE,gBAAgB,EAAyB,MAAM,4BAA4B,CAAC;AAE1F,wBAAgB,+BAA+B,CAC9C,wBAAwB,EAAE,YAAY,CACrC,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,CACrB,EACD,OAAO,EAAE,iBAAiB,GACxB,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,EAAE,qBAAqB,CAAC,CAc9E;AAED,UAAU,wBAAwB;IACjC,QAAQ,CAAC,aAAa,EAAE,0BAA0B,CAAC;CACnD;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;CAqBxC,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEzF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,8DAsBtC,CAAC;AAEH,wBAAgB,2BAA2B,CAC1C,OAAO,EAAE,6BAA6B,EACtC,aAAa,EAAE,4BAA4B,GACzC,SAAS,CAWX"}

package/dist/shared-tree/sharedTreeChangeCodecs.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTreeChangeCodecs.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA2D;AAG3D,gDAS2B;AAM3B,4DAOuC;AACvC,+CAK0B;AAE1B,2EAGqC;AAGrC,SAAgB,+BAA+B,CAC9C,wBAIC,EACD,OAA0B;IAE1B,MAAM,QAAQ,GAQR,CAAC,GAAG,mCAA2B,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;QACrF,MAAM;QACN,yBAAyB,CAAC,wBAAwB,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;KACnF,CAAC,CAAC;IACH,OAAO,IAAA,0BAAe,EAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AArBD,0EAqBC;AAMD;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAA,qBAAU,EAAC,+BAA+B,EAAE;IACxF;;;;OAIG;IACH,EAAE,EAAE,CAAC;IACL;;;;;;;OAOG;IACH,EAAE,EAAE,CAAC;IACL;;;OAGG;IACH,EAAE,EAAE,CAAC;CACL,CAAC,CAAC;AAGH;;;;;;;GAOG;AACU,QAAA,2BAA2B,GAAG,IAAI,GAAG,CAGhD;IACD;QACC,qCAA6B,CAAC,EAAE;QAChC;YACC,aAAa,EAAE,qCAA0B,CAAC,EAAE;SAC5C;KACD;IACD;QACC,qCAA6B,CAAC,EAAE;QAChC;YACC,aAAa,EAAE,qCAA0B,CAAC,EAAE;SAC5C;KACD;IACD;QACC,qCAA6B,CAAC,EAAE;QAChC;YACC,aAAa,EAAE,qCAA0B,CAAC,EAAE;SAC5C;KACD;CACD,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CAC1C,OAAsC,EACtC,aAAsC;IAEtC,MAAM,EAAE,aAAa,EAAE,GACtB,mCAA2B,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAA,eAAI,EAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACrF,OAAO;QACN,IAAI,EAAE,kBAAkB;QACxB,OAAO;QACP,QAAQ,EAAE;YACT,IAAA,6CAAkC,EAAC,aAAa,CAAC;YACjD,6BAAkB,CAAC,YAAY,CAAC,aAAa,CAAC;SAC9C;KACD,CAAC;AACH,CAAC;AAdD,kEAcC;AAED,SAAS,yBAAyB,CACjC,kBAKC,EACD,YAA+B;IAO/B,MAAM,iBAAiB,GAAG,IAAA,gCAAqB,EAAC,YAAY,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,IAAI,uCAA4B,CAIrD;QACD,IAAI,CAAC,OAAO,EAAE,OAAO;YACpB,OAAO;gBACN,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;aACxD,CAAC;QACH,CAAC;QACD,MAAM,CAAC,OAAO;YACb,OAAO;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC;aAC9C,CAAC;QACH,CAAC;KACD,CAAC,CAAC;IAEH,OAAO,IAAA,+BAAoB,EAC1B,IAAA,mDAAuB,EAAC,iBAAiB,CAAC,aAAa,CAAC,EACxD;QACC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,aAA2C,CAAC;YAChD,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC5C,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBACnC,MAAM,eAAe,GACpB,aAAa,KAAK,SAAS;wBAC1B,CAAC,CAAC,OAAO,CAAC,MAAM;wBAChB,CAAC,CAAC;4BACA,MAAM,EACL,OAAO,CAAC,MAAM,KAAK,SAAS;gCAC3B,CAAC,CAAC,8BAAmB;gCACrB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM;4BACzB,MAAM,EAAE,aAAa;yBACrB,CAAC;oBACL,OAAO,CAAC,IAAI,CAAC;wBACZ,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE;4BAC1D,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,MAAM,EAAE,eAAe;4BACvB,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;yBAC5B,CAAC;qBACF,CAAC,CAAC;gBACJ,CAAC;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5C,OAAO,CAAC,IAAI,CAAC;wBACZ,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC;qBAC3D,CAAC,CAAC;oBACH,aAAa,GAAG,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;gBACtD,CAAC;YACF,CAAC;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE;YAClC,MAAM,OAAO,GAAyC,EAAE,CAAC;YACzD,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE,CAAC;gBACvC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,EAAE,OAAO,EAAE,CAAC;QACpB,CAAC;KACD,EACD,YAAY,CAAC,aAAa,CAC1B,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { fail } from \"@fluidframework/core-utils/internal\";\nimport type { MinimumVersionForCollab } from \"@fluidframework/runtime-definitions/internal\";\n\nimport {\n\ttype CodecTree,\n\ttype CodecWriteOptions,\n\tDiscriminatedUnionDispatcher,\n\ttype FormatVersion,\n\ttype ICodecFamily,\n\ttype IJsonCodec,\n\tmakeCodecFamily,\n\twithSchemaValidation,\n} from \"../codec/index.js\";\nimport type {\n\tChangeEncodingContext,\n\tChangeDecodingContext,\n\tTreeStoredSchema,\n} from \"../core/index.js\";\nimport {\n\tModularChangeFormatVersion,\n\ttype ModularChangeset,\n\tdefaultSchemaPolicy,\n\tgetCodecTreeForModularChangeFormat,\n\tmakeSchemaChangeCodec,\n\tschemaCodecBuilder,\n} from \"../feature-libraries/index.js\";\nimport {\n\tstrictEnum,\n\ttype JsonCompatibleReadOnly,\n\ttype Mutable,\n\ttype Values,\n} from \"../util/index.js\";\n\nimport {\n\tEncodedSharedTreeChange,\n\ttype EncodedSharedTreeInnerChange,\n} from \"./sharedTreeChangeFormat.js\";\nimport type { SharedTreeChange, SharedTreeInnerChange } from \"./sharedTreeChangeTypes.js\";\n\nexport function makeSharedTreeChangeCodecFamily(\n\tmodularChangeCodecFamily: ICodecFamily<\n\t\tModularChangeset,\n\t\tChangeEncodingContext,\n\t\tChangeDecodingContext\n\t>,\n\toptions: CodecWriteOptions,\n): ICodecFamily<SharedTreeChange, ChangeEncodingContext, ChangeDecodingContext> {\n\tconst versions: [\n\t\tFormatVersion,\n\t\tIJsonCodec<\n\t\t\tSharedTreeChange,\n\t\t\tEncodedSharedTreeChange,\n\t\t\tEncodedSharedTreeChange,\n\t\t\tChangeEncodingContext\n\t\t>,\n\t][] = [...dependenciesForChangeFormat.entries()].map(([format, { modularChange }]) => [\n\t\tformat,\n\t\tmakeSharedTreeChangeCodec(modularChangeCodecFamily.resolve(modularChange), options),\n\t]);\n\treturn makeCodecFamily(versions);\n}\n\ninterface ChangeFormatDependencies {\n\treadonly modularChange: ModularChangeFormatVersion;\n}\n\n/**\n * The format version for `SharedTreeChange`.\n */\nexport const SharedTreeChangeFormatVersion = strictEnum(\"SharedTreeChangeFormatVersion\", {\n\t/**\n\t * Introduced prior to 2.0 and used beyond.\n\t * Reading capability must be maintained for backwards compatibility.\n\t * Writing capability needs to be maintained so long as {@link lowestMinVersionForCollab} is less than 2.2.0.\n\t */\n\tv3: 3,\n\t/**\n\t * Introduced in 2.2.0.\n\t * Was inadvertently made usable for writing in 2.43.0 (through configuredSharedTree) and remains available.\n\t * Reading capability must be maintained for backwards compatibility.\n\t * Writing capability could be dropped in favor of {@link SharedTreeChangeFormatVersion.v3},\n\t * but doing so would make the pattern of writable versions more complex and gain little\n\t * because the logic for this format is shared with {@link SharedTreeChangeFormatVersion.v3}.\n\t */\n\tv4: 4,\n\t/**\n\t * Introduced and made available for writing in 2.80.0\n\t * Adds support for \"no change\" constraints.\n\t */\n\tv5: 5,\n});\nexport type SharedTreeChangeFormatVersion = Values<typeof SharedTreeChangeFormatVersion>;\n\n/**\n * Defines for each SharedTree change format the corresponding dependent formats to use.\n * This is an arbitrary mapping that is injected in the SharedTree change codec.\n * Once an entry is defined and used in production, it cannot be changed.\n * This is because the format for the dependent formats are not explicitly versioned.\n * @remarks\n * SchemaFormatVersion (used by SchemaChangeFormat) is not included here since it is explicitly versioned.\n */\nexport const dependenciesForChangeFormat = new Map<\n\tSharedTreeChangeFormatVersion,\n\tChangeFormatDependencies\n>([\n\t[\n\t\tSharedTreeChangeFormatVersion.v3,\n\t\t{\n\t\t\tmodularChange: ModularChangeFormatVersion.v3,\n\t\t},\n\t],\n\t[\n\t\tSharedTreeChangeFormatVersion.v4,\n\t\t{\n\t\t\tmodularChange: ModularChangeFormatVersion.v4,\n\t\t},\n\t],\n\t[\n\t\tSharedTreeChangeFormatVersion.v5,\n\t\t{\n\t\t\tmodularChange: ModularChangeFormatVersion.v5,\n\t\t},\n\t],\n]);\n\nexport function getCodecTreeForChangeFormat(\n\tversion: SharedTreeChangeFormatVersion,\n\tclientVersion: MinimumVersionForCollab,\n): CodecTree {\n\tconst { modularChange } =\n\t\tdependenciesForChangeFormat.get(version) ?? fail(0xc78 /* Unknown change format */);\n\treturn {\n\t\tname: \"SharedTreeChange\",\n\t\tversion,\n\t\tchildren: [\n\t\t\tgetCodecTreeForModularChangeFormat(modularChange),\n\t\t\tschemaCodecBuilder.getCodecTree(clientVersion),\n\t\t],\n\t};\n}\n\nfunction makeSharedTreeChangeCodec(\n\tmodularChangeCodec: IJsonCodec<\n\t\tModularChangeset,\n\t\tJsonCompatibleReadOnly,\n\t\tJsonCompatibleReadOnly,\n\t\tChangeEncodingContext\n\t>,\n\tcodecOptions: CodecWriteOptions,\n): IJsonCodec<\n\tSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tChangeEncodingContext\n> {\n\tconst schemaChangeCodec = makeSchemaChangeCodec(codecOptions);\n\tconst decoderLibrary = new DiscriminatedUnionDispatcher<\n\t\tEncodedSharedTreeInnerChange,\n\t\t[context: ChangeEncodingContext],\n\t\tSharedTreeInnerChange\n\t>({\n\t\tdata(encoded, context): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"data\",\n\t\t\t\tinnerChange: modularChangeCodec.decode(encoded, context),\n\t\t\t};\n\t\t},\n\t\tschema(encoded): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"schema\",\n\t\t\t\tinnerChange: schemaChangeCodec.decode(encoded),\n\t\t\t};\n\t\t},\n\t});\n\n\treturn withSchemaValidation(\n\t\tEncodedSharedTreeChange(schemaChangeCodec.encodedSchema),\n\t\t{\n\t\t\tencode: (change, context) => {\n\t\t\t\tconst changes: EncodedSharedTreeInnerChange[] = [];\n\t\t\t\tlet updatedSchema: TreeStoredSchema | undefined;\n\t\t\t\tfor (const decodedChange of change.changes) {\n\t\t\t\t\tif (decodedChange.type === \"data\") {\n\t\t\t\t\t\tconst schemaAndPolicy =\n\t\t\t\t\t\t\tupdatedSchema === undefined\n\t\t\t\t\t\t\t\t? context.schema\n\t\t\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\t\t\tpolicy:\n\t\t\t\t\t\t\t\t\t\t\tcontext.schema === undefined\n\t\t\t\t\t\t\t\t\t\t\t\t? defaultSchemaPolicy\n\t\t\t\t\t\t\t\t\t\t\t\t: context.schema.policy,\n\t\t\t\t\t\t\t\t\t\tschema: updatedSchema,\n\t\t\t\t\t\t\t\t\t};\n\t\t\t\t\t\tchanges.push({\n\t\t\t\t\t\t\tdata: modularChangeCodec.encode(decodedChange.innerChange, {\n\t\t\t\t\t\t\t\toriginatorId: context.originatorId,\n\t\t\t\t\t\t\t\tschema: schemaAndPolicy,\n\t\t\t\t\t\t\t\tidCompressor: context.idCompressor,\n\t\t\t\t\t\t\t\trevision: context.revision,\n\t\t\t\t\t\t\t\tisSummary: context.isSummary,\n\t\t\t\t\t\t\t}),\n\t\t\t\t\t\t});\n\t\t\t\t\t} else if (decodedChange.type === \"schema\") {\n\t\t\t\t\t\tchanges.push({\n\t\t\t\t\t\t\tschema: schemaChangeCodec.encode(decodedChange.innerChange),\n\t\t\t\t\t\t});\n\t\t\t\t\t\tupdatedSchema = decodedChange.innerChange.schema.new;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn changes;\n\t\t\t},\n\t\t\tdecode: (encodedChange, context) => {\n\t\t\t\tconst changes: Mutable<SharedTreeChange[\"changes\"]> = [];\n\t\t\t\tfor (const subChange of encodedChange) {\n\t\t\t\t\tchanges.push(decoderLibrary.dispatch(subChange, context));\n\t\t\t\t}\n\t\t\t\treturn { changes };\n\t\t\t},\n\t\t},\n\t\tcodecOptions.jsonValidator,\n\t);\n}\n"]}
+{"version":3,"file":"sharedTreeChangeCodecs.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA2D;AAG3D,gDAS2B;AAM3B,4DAOuC;AACvC,+CAK0B;AAE1B,2EAGqC;AAGrC,SAAgB,+BAA+B,CAC9C,wBAIC,EACD,OAA0B;IAE1B,MAAM,QAAQ,GAQR,CAAC,GAAG,mCAA2B,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;QACrF,MAAM;QACN,yBAAyB,CAAC,wBAAwB,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;KACnF,CAAC,CAAC;IACH,OAAO,IAAA,0BAAe,EAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AArBD,0EAqBC;AAMD;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAA,qBAAU,EAAC,+BAA+B,EAAE;IACxF;;;;OAIG;IACH,EAAE,EAAE,CAAC;IACL;;;;;;;OAOG;IACH,EAAE,EAAE,CAAC;IACL;;;OAGG;IACH,EAAE,EAAE,CAAC;CACL,CAAC,CAAC;AAGH;;;;;;;GAOG;AACU,QAAA,2BAA2B,GAAG,IAAI,GAAG,CAGhD;IACD;QACC,qCAA6B,CAAC,EAAE;QAChC;YACC,aAAa,EAAE,qCAA0B,CAAC,EAAE;SAC5C;KACD;IACD;QACC,qCAA6B,CAAC,EAAE;QAChC;YACC,aAAa,EAAE,qCAA0B,CAAC,EAAE;SAC5C;KACD;IACD;QACC,qCAA6B,CAAC,EAAE;QAChC;YACC,aAAa,EAAE,qCAA0B,CAAC,EAAE;SAC5C;KACD;CACD,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CAC1C,OAAsC,EACtC,aAA2C;IAE3C,MAAM,EAAE,aAAa,EAAE,GACtB,mCAA2B,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAA,eAAI,EAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACrF,OAAO;QACN,IAAI,EAAE,kBAAkB;QACxB,OAAO;QACP,QAAQ,EAAE;YACT,IAAA,6CAAkC,EAAC,aAAa,CAAC;YACjD,6BAAkB,CAAC,YAAY,CAAC,aAAa,CAAC;SAC9C;KACD,CAAC;AACH,CAAC;AAdD,kEAcC;AAED,SAAS,yBAAyB,CACjC,kBAKC,EACD,YAA+B;IAO/B,MAAM,iBAAiB,GAAG,IAAA,gCAAqB,EAAC,YAAY,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,IAAI,uCAA4B,CAIrD;QACD,IAAI,CAAC,OAAO,EAAE,OAAO;YACpB,OAAO;gBACN,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;aACxD,CAAC;QACH,CAAC;QACD,MAAM,CAAC,OAAO;YACb,OAAO;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC;aAC9C,CAAC;QACH,CAAC;KACD,CAAC,CAAC;IAEH,OAAO,IAAA,+BAAoB,EAC1B,IAAA,mDAAuB,EAAC,iBAAiB,CAAC,aAAa,CAAC,EACxD;QACC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,aAA2C,CAAC;YAChD,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC5C,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBACnC,MAAM,eAAe,GACpB,aAAa,KAAK,SAAS;wBAC1B,CAAC,CAAC,OAAO,CAAC,MAAM;wBAChB,CAAC,CAAC;4BACA,MAAM,EACL,OAAO,CAAC,MAAM,KAAK,SAAS;gCAC3B,CAAC,CAAC,8BAAmB;gCACrB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM;4BACzB,MAAM,EAAE,aAAa;yBACrB,CAAC;oBACL,OAAO,CAAC,IAAI,CAAC;wBACZ,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE;4BAC1D,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,MAAM,EAAE,eAAe;4BACvB,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;yBAC5B,CAAC;qBACF,CAAC,CAAC;gBACJ,CAAC;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5C,OAAO,CAAC,IAAI,CAAC;wBACZ,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC;qBAC3D,CAAC,CAAC;oBACH,aAAa,GAAG,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;gBACtD,CAAC;YACF,CAAC;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE;YAClC,MAAM,OAAO,GAAyC,EAAE,CAAC;YACzD,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE,CAAC;gBACvC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,EAAE,OAAO,EAAE,CAAC;QACpB,CAAC;KACD,EACD,YAAY,CAAC,aAAa,CAC1B,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { fail } from \"@fluidframework/core-utils/internal\";\nimport type { OldestSupportedClientVersion } from \"@fluidframework/runtime-definitions/internal\";\n\nimport {\n\ttype CodecTree,\n\ttype CodecWriteOptions,\n\tDiscriminatedUnionDispatcher,\n\ttype FormatVersion,\n\ttype ICodecFamily,\n\ttype IJsonCodec,\n\tmakeCodecFamily,\n\twithSchemaValidation,\n} from \"../codec/index.js\";\nimport type {\n\tChangeEncodingContext,\n\tChangeDecodingContext,\n\tTreeStoredSchema,\n} from \"../core/index.js\";\nimport {\n\tModularChangeFormatVersion,\n\ttype ModularChangeset,\n\tdefaultSchemaPolicy,\n\tgetCodecTreeForModularChangeFormat,\n\tmakeSchemaChangeCodec,\n\tschemaCodecBuilder,\n} from \"../feature-libraries/index.js\";\nimport {\n\tstrictEnum,\n\ttype JsonCompatibleReadOnly,\n\ttype Mutable,\n\ttype Values,\n} from \"../util/index.js\";\n\nimport {\n\tEncodedSharedTreeChange,\n\ttype EncodedSharedTreeInnerChange,\n} from \"./sharedTreeChangeFormat.js\";\nimport type { SharedTreeChange, SharedTreeInnerChange } from \"./sharedTreeChangeTypes.js\";\n\nexport function makeSharedTreeChangeCodecFamily(\n\tmodularChangeCodecFamily: ICodecFamily<\n\t\tModularChangeset,\n\t\tChangeEncodingContext,\n\t\tChangeDecodingContext\n\t>,\n\toptions: CodecWriteOptions,\n): ICodecFamily<SharedTreeChange, ChangeEncodingContext, ChangeDecodingContext> {\n\tconst versions: [\n\t\tFormatVersion,\n\t\tIJsonCodec<\n\t\t\tSharedTreeChange,\n\t\t\tEncodedSharedTreeChange,\n\t\t\tEncodedSharedTreeChange,\n\t\t\tChangeEncodingContext\n\t\t>,\n\t][] = [...dependenciesForChangeFormat.entries()].map(([format, { modularChange }]) => [\n\t\tformat,\n\t\tmakeSharedTreeChangeCodec(modularChangeCodecFamily.resolve(modularChange), options),\n\t]);\n\treturn makeCodecFamily(versions);\n}\n\ninterface ChangeFormatDependencies {\n\treadonly modularChange: ModularChangeFormatVersion;\n}\n\n/**\n * The format version for `SharedTreeChange`.\n */\nexport const SharedTreeChangeFormatVersion = strictEnum(\"SharedTreeChangeFormatVersion\", {\n\t/**\n\t * Introduced prior to 2.0 and used beyond.\n\t * Reading capability must be maintained for backwards compatibility.\n\t * Writing capability needs to be maintained so long as {@link lowestMinVersionForCollab} is less than 2.2.0.\n\t */\n\tv3: 3,\n\t/**\n\t * Introduced in 2.2.0.\n\t * Was inadvertently made usable for writing in 2.43.0 (through configuredSharedTree) and remains available.\n\t * Reading capability must be maintained for backwards compatibility.\n\t * Writing capability could be dropped in favor of {@link SharedTreeChangeFormatVersion.v3},\n\t * but doing so would make the pattern of writable versions more complex and gain little\n\t * because the logic for this format is shared with {@link SharedTreeChangeFormatVersion.v3}.\n\t */\n\tv4: 4,\n\t/**\n\t * Introduced and made available for writing in 2.80.0\n\t * Adds support for \"no change\" constraints.\n\t */\n\tv5: 5,\n});\nexport type SharedTreeChangeFormatVersion = Values<typeof SharedTreeChangeFormatVersion>;\n\n/**\n * Defines for each SharedTree change format the corresponding dependent formats to use.\n * This is an arbitrary mapping that is injected in the SharedTree change codec.\n * Once an entry is defined and used in production, it cannot be changed.\n * This is because the format for the dependent formats are not explicitly versioned.\n * @remarks\n * SchemaFormatVersion (used by SchemaChangeFormat) is not included here since it is explicitly versioned.\n */\nexport const dependenciesForChangeFormat = new Map<\n\tSharedTreeChangeFormatVersion,\n\tChangeFormatDependencies\n>([\n\t[\n\t\tSharedTreeChangeFormatVersion.v3,\n\t\t{\n\t\t\tmodularChange: ModularChangeFormatVersion.v3,\n\t\t},\n\t],\n\t[\n\t\tSharedTreeChangeFormatVersion.v4,\n\t\t{\n\t\t\tmodularChange: ModularChangeFormatVersion.v4,\n\t\t},\n\t],\n\t[\n\t\tSharedTreeChangeFormatVersion.v5,\n\t\t{\n\t\t\tmodularChange: ModularChangeFormatVersion.v5,\n\t\t},\n\t],\n]);\n\nexport function getCodecTreeForChangeFormat(\n\tversion: SharedTreeChangeFormatVersion,\n\tclientVersion: OldestSupportedClientVersion,\n): CodecTree {\n\tconst { modularChange } =\n\t\tdependenciesForChangeFormat.get(version) ?? fail(0xc78 /* Unknown change format */);\n\treturn {\n\t\tname: \"SharedTreeChange\",\n\t\tversion,\n\t\tchildren: [\n\t\t\tgetCodecTreeForModularChangeFormat(modularChange),\n\t\t\tschemaCodecBuilder.getCodecTree(clientVersion),\n\t\t],\n\t};\n}\n\nfunction makeSharedTreeChangeCodec(\n\tmodularChangeCodec: IJsonCodec<\n\t\tModularChangeset,\n\t\tJsonCompatibleReadOnly,\n\t\tJsonCompatibleReadOnly,\n\t\tChangeEncodingContext\n\t>,\n\tcodecOptions: CodecWriteOptions,\n): IJsonCodec<\n\tSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tChangeEncodingContext\n> {\n\tconst schemaChangeCodec = makeSchemaChangeCodec(codecOptions);\n\tconst decoderLibrary = new DiscriminatedUnionDispatcher<\n\t\tEncodedSharedTreeInnerChange,\n\t\t[context: ChangeEncodingContext],\n\t\tSharedTreeInnerChange\n\t>({\n\t\tdata(encoded, context): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"data\",\n\t\t\t\tinnerChange: modularChangeCodec.decode(encoded, context),\n\t\t\t};\n\t\t},\n\t\tschema(encoded): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"schema\",\n\t\t\t\tinnerChange: schemaChangeCodec.decode(encoded),\n\t\t\t};\n\t\t},\n\t});\n\n\treturn withSchemaValidation(\n\t\tEncodedSharedTreeChange(schemaChangeCodec.encodedSchema),\n\t\t{\n\t\t\tencode: (change, context) => {\n\t\t\t\tconst changes: EncodedSharedTreeInnerChange[] = [];\n\t\t\t\tlet updatedSchema: TreeStoredSchema | undefined;\n\t\t\t\tfor (const decodedChange of change.changes) {\n\t\t\t\t\tif (decodedChange.type === \"data\") {\n\t\t\t\t\t\tconst schemaAndPolicy =\n\t\t\t\t\t\t\tupdatedSchema === undefined\n\t\t\t\t\t\t\t\t? context.schema\n\t\t\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\t\t\tpolicy:\n\t\t\t\t\t\t\t\t\t\t\tcontext.schema === undefined\n\t\t\t\t\t\t\t\t\t\t\t\t? defaultSchemaPolicy\n\t\t\t\t\t\t\t\t\t\t\t\t: context.schema.policy,\n\t\t\t\t\t\t\t\t\t\tschema: updatedSchema,\n\t\t\t\t\t\t\t\t\t};\n\t\t\t\t\t\tchanges.push({\n\t\t\t\t\t\t\tdata: modularChangeCodec.encode(decodedChange.innerChange, {\n\t\t\t\t\t\t\t\toriginatorId: context.originatorId,\n\t\t\t\t\t\t\t\tschema: schemaAndPolicy,\n\t\t\t\t\t\t\t\tidCompressor: context.idCompressor,\n\t\t\t\t\t\t\t\trevision: context.revision,\n\t\t\t\t\t\t\t\tisSummary: context.isSummary,\n\t\t\t\t\t\t\t}),\n\t\t\t\t\t\t});\n\t\t\t\t\t} else if (decodedChange.type === \"schema\") {\n\t\t\t\t\t\tchanges.push({\n\t\t\t\t\t\t\tschema: schemaChangeCodec.encode(decodedChange.innerChange),\n\t\t\t\t\t\t});\n\t\t\t\t\t\tupdatedSchema = decodedChange.innerChange.schema.new;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn changes;\n\t\t\t},\n\t\t\tdecode: (encodedChange, context) => {\n\t\t\t\tconst changes: Mutable<SharedTreeChange[\"changes\"]> = [];\n\t\t\t\tfor (const subChange of encodedChange) {\n\t\t\t\t\tchanges.push(decoderLibrary.dispatch(subChange, context));\n\t\t\t\t}\n\t\t\t\treturn { changes };\n\t\t\t},\n\t\t},\n\t\tcodecOptions.jsonValidator,\n\t);\n}\n"]}

package/dist/shared-tree/sharedTreeChangeEnricher.d.ts

@@ -14,6 +14,10 @@ interface OwnedState {
     readonly forest: IEditableForest;
     readonly removedRoots: DetachedFieldIndex;
 }
+/**
+ * A helper for enriching `SharedTreeChange`s.
+ * It lazily forks the borrowed state (which it does not mutate) and lazily applies {@link enqueueChange|changes} to the forked state when {@link enrich|commit enrichment} requires access to detached root data.
+ */
 export declare class SharedTreeChangeEnricher {
     private readonly schema;
     private readonly idCompressor?;
@@ -40,10 +44,30 @@ export declare class SharedTreeChangeEnricher {
      * @param onApplyChange - Optional callback invoked whenever a change is applied to the owned state.
      */
     constructor(borrowedForest: IForestSubscription, borrowedRemovedRoots: ReadOnlyDetachedFieldIndex, schema: TreeStoredSchemaRepository, idCompressor?: IIdCompressor | undefined, onEnrichCommit?: (() => void) | undefined, onRefresherAdded?: (() => void) | undefined, onForkState?: (() => void) | undefined, onApplyChange?: (() => void) | undefined);
+    /**
+     * Enriches a change.
+     * @param change - The change to enrich (not mutated)
+     * @returns An enriched copy of the given `change`.
+     * @remarks
+     * Invoking this method will flush {@link enqueueChange|queued} changes if the enrichment process requires reading detached roots from the forest.
+     */
     enrich(change: SharedTreeChange): SharedTreeChange;
     private getDetachedRoot;
+    /**
+     * Enqueues a change to be applied before reading detached root data during the next {@link enrich|enrichment}.
+     * @param change - The change to apply or a function that returns the change to apply.
+     * If a function is provided, it will be invoked during a future call to {@link enrich} (if at all).
+     */
     enqueueChange(change: TaggedChange<SharedTreeChange> | (() => TaggedChange<SharedTreeChange>)): void;
-    private purgeChangeQueue;
+    /**
+     * Flushes all {@link enqueueChange|queued} changes by applying the data changes to a forked forest and detached field index.
+     * @remarks
+     * This validates that the data changes are valid.
+     */
+    purgeChangeQueue(): void;
+    /**
+     * Dispose of this object and its resources.
+     */
     [disposeSymbol](): void;
 }
 export {};

package/dist/shared-tree/sharedTreeChangeEnricher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTreeChangeEnricher.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeEnricher.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EAEN,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAG/B,MAAM,kBAAkB,CAAC;AAS1B,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,UAAU,aAAa;IACtB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,YAAY,EAAE,0BAA0B,CAAC;CAClD;AAED,UAAU,UAAU;IACnB,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;CAC1C;AAED,qBAAa,wBAAwB;IAuBnC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IA3BhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgD;IAC5E,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAC3C,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAE7B;;;;;;;;;;;OAWG;gBAEF,cAAc,EAAE,mBAAmB,EACnC,oBAAoB,EAAE,0BAA0B,EAC/B,MAAM,EAAE,0BAA0B,EAClC,YAAY,CAAC,2BAAe,EAC5B,cAAc,CAAC,SAAQ,IAAI,aAAA,EAC3B,gBAAgB,CAAC,SAAQ,IAAI,aAAA,EAC7B,WAAW,CAAC,SAAQ,IAAI,aAAA,EACxB,aAAa,CAAC,SAAQ,IAAI,aAAA;IAQrC,MAAM,CAAC,MAAM,EAAE,gBAAgB,GAAG,gBAAgB;IAUzD,OAAO,CAAC,eAAe;IAkBhB,aAAa,CACnB,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,YAAY,CAAC,gBAAgB,CAAC,CAAC,GAC7E,IAAI;IAIP,OAAO,CAAC,gBAAgB;IAwCjB,CAAC,aAAa,CAAC,IAAI,IAAI;CAG9B"}
+{"version":3,"file":"sharedTreeChangeEnricher.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeEnricher.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EAEN,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAG/B,MAAM,kBAAkB,CAAC;AAS1B,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,UAAU,aAAa;IACtB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,YAAY,EAAE,0BAA0B,CAAC;CAClD;AAED,UAAU,UAAU;IACnB,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;CAC1C;AAED;;;GAGG;AACH,qBAAa,wBAAwB;IAuBnC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IA3BhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgD;IAC5E,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAC3C,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAE7B;;;;;;;;;;;OAWG;gBAEF,cAAc,EAAE,mBAAmB,EACnC,oBAAoB,EAAE,0BAA0B,EAC/B,MAAM,EAAE,0BAA0B,EAClC,YAAY,CAAC,2BAAe,EAC5B,cAAc,CAAC,SAAQ,IAAI,aAAA,EAC3B,gBAAgB,CAAC,SAAQ,IAAI,aAAA,EAC7B,WAAW,CAAC,SAAQ,IAAI,aAAA,EACxB,aAAa,CAAC,SAAQ,IAAI,aAAA;IAQ5C;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,EAAE,gBAAgB,GAAG,gBAAgB;IAUzD,OAAO,CAAC,eAAe;IAkBvB;;;;OAIG;IACI,aAAa,CACnB,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,YAAY,CAAC,gBAAgB,CAAC,CAAC,GAC7E,IAAI;IAIP;;;;OAIG;IACI,gBAAgB,IAAI,IAAI;IAwC/B;;OAEG;IACI,CAAC,aAAa,CAAC,IAAI,IAAI;CAG9B"}

package/dist/shared-tree/sharedTreeChangeEnricher.js

@@ -10,6 +10,10 @@ const index_js_1 = require("../core/index.js");
 const index_js_2 = require("../feature-libraries/index.js");
 const index_js_3 = require("../util/index.js");
 const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
+/**
+ * A helper for enriching `SharedTreeChange`s.
+ * It lazily forks the borrowed state (which it does not mutate) and lazily applies {@link enqueueChange|changes} to the forked state when {@link enrich|commit enrichment} requires access to detached root data.
+ */
 class SharedTreeChangeEnricher {
     /**
      * @param borrowedForest - The state based on which to enrich changes.
@@ -39,6 +43,13 @@ class SharedTreeChangeEnricher {
             removedRoots: borrowedRemovedRoots,
         };
     }
+    /**
+     * Enriches a change.
+     * @param change - The change to enrich (not mutated)
+     * @returns An enriched copy of the given `change`.
+     * @remarks
+     * Invoking this method will flush {@link enqueueChange|queued} changes if the enrichment process requires reading detached roots from the forest.
+     */
     enrich(change) {
         this.onEnrichCommit?.();
         return (0, sharedTreeChangeFamily_js_1.updateRefreshers)(change, (id) => this.getDetachedRoot(id), index_js_2.relevantRemovedRoots, index_js_2.updateRefreshers);
@@ -60,9 +71,19 @@ class SharedTreeChangeEnricher {
         }
         return undefined;
     }
+    /**
+     * Enqueues a change to be applied before reading detached root data during the next {@link enrich|enrichment}.
+     * @param change - The change to apply or a function that returns the change to apply.
+     * If a function is provided, it will be invoked during a future call to {@link enrich} (if at all).
+     */
     enqueueChange(change) {
         this.changeQueue.push(typeof change === "function" ? change : () => change);
     }
+    /**
+     * Flushes all {@link enqueueChange|queued} changes by applying the data changes to a forked forest and detached field index.
+     * @remarks
+     * This validates that the data changes are valid.
+     */
     purgeChangeQueue() {
         if (this.changeQueue.length === 0) {
             return;
@@ -102,6 +123,9 @@ class SharedTreeChangeEnricher {
         }
         this.changeQueue.length = 0;
     }
+    /**
+     * Dispose of this object and its resources.
+     */
     [index_js_3.disposeSymbol]() {
         // TODO: in the future, forest and/or its AnchorSet may require disposal.
     }