@fluid-experimental/tree 0.59.4002 → 1.0.2

package/dist/SharedTree.d.ts

@@ -7,7 +7,7 @@ import { IFluidSerializer, ISharedObjectEvents, SharedObject } from '@fluidframe
 import { ITelemetryLogger, ITelemetryProperties } from '@fluidframework/common-definitions';
 import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
 import { OrderedEditSet } from './EditLog';
-import { EditId, NodeId, StableNodeId } from './Identifiers';
+import { EditId, NodeId, StableNodeId, AttributionId } from './Identifiers';
 import { LogViewer } from './LogViewer';
 import { ReconciliationPath } from './ReconciliationPath';
 import { ChangeInternal, Edit, EditStatus, SharedTreeSummaryBase, WriteFormat, InternalizedChange } from './persisted-types';
@@ -15,15 +15,68 @@ import { NodeIdContext } from './NodeIdUtilities';
 import { RevisionView } from './RevisionView';
 import { Change } from './ChangeTypes';
 import { TransactionInternal } from './TransactionInternal';
+/**
+ * The write format and associated options used to construct a `SharedTree`
+ * @public
+ */
+export declare type SharedTreeArgs<WF extends WriteFormat = WriteFormat> = [writeFormat: WF, options?: SharedTreeOptions<WF>];
+/**
+ * The type of shared tree options for a given write format
+ * @public
+ */
+export declare type SharedTreeOptions<WF extends WriteFormat, HistoryCompatibility extends 'Forwards' | 'None' = 'Forwards'> = Omit<WF extends WriteFormat.v0_0_2 ? SharedTreeOptions_0_0_2 : WF extends WriteFormat.v0_1_1 ? SharedTreeOptions_0_1_1 : never, HistoryCompatibility extends 'Forwards' ? 'summarizeHistory' : never>;
+/**
+ * Configuration options for a SharedTree with write format 0.0.2
+ * @public
+ */
+export interface SharedTreeOptions_0_0_2 {
+    /**
+     * Determines if the history is included in summaries.
+     *
+     * Warning: enabling history summarization incurs a permanent cost in the document. It is not possible to disable history summarization
+     * later once it has been enabled, and thus the history cannot be safely deleted.
+     *
+     * On 0.1.1 documents, due to current code limitations, this parameter is only impactful for newly created documents.
+     * `SharedTree`s which load existing documents will summarize history if and only if the loaded summary included history.
+     *
+     * The technical limitations here relate to clients with mixed versions collaborating.
+     * In the future we may allow modification of whether or not a particular document saves history, but only via a consensus mechanism.
+     * See the skipped test in SharedTreeFuzzTests.ts for more details on this issue.
+     * See docs/Breaking-Change-Migration for more details on the consensus scheme.
+     */
+    summarizeHistory?: boolean;
+}
+/**
+ * Configuration options for a SharedTree with write format 0.1.1
+ * @public
+ */
+export interface SharedTreeOptions_0_1_1 {
+    /**
+     * Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
+     *
+     * Warning: enabling history summarization incurs a permanent cost in the document. It is not possible to disable history summarization
+     * later once it has been enabled, and thus the history cannot be safely deleted.
+     *
+     * On 0.1.1 documents, due to current code limitations, this parameter is only impactful for newly created documents.
+     * `SharedTree`s which load existing documents will summarize history if and only if the loaded summary included history.
+     *
+     * The technical limitations here relate to clients with mixed versions collaborating.
+     * In the future we may allow modification of whether or not a particular document saves history, but only via a consensus mechanism.
+     * See the skipped test in SharedTreeFuzzTests.ts for more details on this issue.
+     * See docs/Breaking-Change-Migration for more details on the consensus scheme.
+     */
+    summarizeHistory?: false | {
+        uploadEditChunks: boolean;
+    };
+    /** a UUID that identifies the user of this tree; all node IDs generated by this tree will be associated with this UUID */
+    attributionId?: AttributionId;
+}
 /**
  * Factory for SharedTree.
  * Includes history in the summary.
  * @public
  */
 export declare class SharedTreeFactory implements IChannelFactory {
-    private readonly writeFormat;
-    private readonly summarizeHistory;
-    private expensiveValidation;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#ISharedObjectFactory."type"}
      */
@@ -32,18 +85,16 @@ export declare class SharedTreeFactory implements IChannelFactory {
      * {@inheritDoc @fluidframework/shared-object-base#ISharedObjectFactory.attributes}
      */
     static Attributes: IChannelAttributes;
+    private readonly args;
     /**
      * Get a factory for SharedTree to register with the data store.
      * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See [the write format
      * documentation](../docs/Write-Format.md) for more information.
-     * @param summarizeHistory - Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
-     * See the [breaking change migration documentation](docs/Breaking-Change-Migration) for more details on this scheme.
-     * @param expensiveValidation - Enables expensive asserts on SharedTree.
+     * @param options - Configuration options for this tree
      * @returns A factory that creates `SharedTree`s and loads them from storage.
      */
-    constructor(writeFormat: WriteFormat, summarizeHistory?: false | {
-        uploadEditChunks: boolean;
-    }, expensiveValidation?: boolean);
+    constructor(...args: SharedTreeArgs<WriteFormat.v0_0_2>);
+    constructor(...args: SharedTreeArgs<WriteFormat.v0_1_1>);
     /**
      * {@inheritDoc @fluidframework/shared-object-base#ISharedObjectFactory."type"}
      */
@@ -61,7 +112,7 @@ export declare class SharedTreeFactory implements IChannelFactory {
      * @param runtime - data store runtime that owns the new SharedTree
      * @param id - optional name for the SharedTree
      */
-    create(runtime: IFluidDataStoreRuntime, id: string, expensiveValidation?: boolean): SharedTree;
+    create(runtime: IFluidDataStoreRuntime, id: string): SharedTree;
     private createSharedTree;
 }
 /**
@@ -141,33 +192,30 @@ export declare type SequencedEditAppliedHandler = (args: SequencedEditAppliedEve
  */
 export declare class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeIdContext {
     private writeFormat;
-    private readonly expensiveValidation;
     /**
      * Create a new SharedTree. It will contain the default value (see initialTree).
      */
     static create(runtime: IFluidDataStoreRuntime, id?: string): SharedTree;
     /**
      * Get a factory for SharedTree to register with the data store.
-     * @param summarizeHistory - Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
-     *
-     * On 0.1.1 documents, due to current code limitations, this parameter is only impactful for newly created documents.
-     * `SharedTree`s which load existing documents will summarize history if and only if the loaded summary included history.
-     *
-     * The technical limitations here relate to clients with mixed versions collaborating.
-     * In the future we may allow modification of whether or not a particular document saves history, but only via a consensus mechanism.
-     * See the skipped test in SharedTreeFuzzTests.ts for more details on this issue.
-     * See docs/Breaking-Change-Migration for more details on the consensus scheme.
      * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in.
      * This format may be updated to a newer (supported) version at runtime if a collaborating shared-tree
      * that was initialized with a newer write version connects to the session. Care must be taken when changing this value,
      * as a staged rollout must of occurred such that all collaborating clients must have the code to read at least the version
      * written.
      * See [the write format documentation](../docs/Write-Format.md) for more information.
+     * @param options - Configuration options for this tree
      * @returns A factory that creates `SharedTree`s and loads them from storage.
      */
-    static getFactory(writeFormat: WriteFormat, summarizeHistory?: false | {
-        uploadEditChunks: boolean;
-    }): SharedTreeFactory;
+    static getFactory(...args: SharedTreeArgs<WriteFormat.v0_0_2>): SharedTreeFactory;
+    static getFactory(...args: SharedTreeArgs<WriteFormat.v0_1_1>): SharedTreeFactory;
+    /**
+     * The UUID used for attribution of nodes created by this SharedTree. All shared trees with a write format of 0.1.1 or
+     * greater have a unique attribution ID which may be configured in the constructor. All other shared trees (i.e. those
+     * with a write format of 0.0.2) use the nil UUID as their attribution ID.
+     * @public
+     */
+    get attributionId(): AttributionId;
     private idCompressor;
     private readonly idNormalizer;
     private interner;
@@ -195,18 +243,22 @@ export declare class SharedTree extends SharedObject<ISharedTreeEvents> implemen
     private readonly processSequencedEditResult;
     private summarizeHistory;
     private uploadEditChunks;
+    private getHistoryPolicy;
     /**
-     * Create a new SharedTreeFactory.
+     * Create a new SharedTree.
      * @param runtime - The runtime the SharedTree will be associated with
      * @param id - Unique ID for the SharedTree
      * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See [the write format
      * documentation](../docs/Write-Format.md) for more information.
-     * @param summarizeHistory - Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
-     * @param expensiveValidation - Enable expensive asserts.
+     * @param options - Configuration options for this tree
+     */
+    constructor(runtime: IFluidDataStoreRuntime, id: string, ...args: SharedTreeArgs<WriteFormat.v0_0_2>);
+    constructor(runtime: IFluidDataStoreRuntime, id: string, ...args: SharedTreeArgs<WriteFormat.v0_1_1>);
+    /**
+     * The write format version currently used by this `SharedTree`. This is always initialized to the write format
+     * passed to the tree's constructor, but it may automatically upgrade over time (e.g. when connected to another
+     * SharedTree with a higher write format, or when loading a summary with a higher write format).
      */
-    constructor(runtime: IFluidDataStoreRuntime, id: string, writeFormat: WriteFormat, summarizeHistory?: false | {
-        uploadEditChunks: boolean;
-    }, expensiveValidation?: boolean);
     getWriteFormat(): WriteFormat;
     /**
      * Re-computes currentIsOldest and emits an event if it has changed.
@@ -268,6 +320,13 @@ export declare class SharedTree extends SharedObject<ISharedTreeEvents> implemen
      * @public
      */
     tryConvertToNodeId(id: StableNodeId): NodeId | undefined;
+    /**
+     * Returns the attribution ID associated with the SharedTree that generated the given node ID. This is generally only useful for clients
+     * with a write format of 0.1.1 or greater since older clients cannot be given an attribution ID and will always use the default
+     * `attributionId` of the tree.
+     * @public
+     */
+    attributeNodeId(id: NodeId): AttributionId;
     /**
      * @returns the edit history of the tree.
      * @public

package/dist/SharedTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SharedTree.d.ts","sourceRoot":"","sources":["../src/SharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAEN,gBAAgB,EAChB,mBAAmB,EAEnB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAA6D,cAAc,EAAE,MAAM,WAAW,CAAC;AACtG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAA2D,MAAM,eAAe,CAAC;AAEtH,OAAO,EAIN,SAAS,EAGT,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAEN,cAAc,EAKd,IAAI,EAGJ,UAAU,EAWV,qBAAqB,EAIrB,WAAW,EAEX,kBAAkB,EAClB,MAAM,mBAAmB,CAAC;AAW3B,OAAO,EAAoB,aAAa,EAA2C,MAAM,mBAAmB,CAAC;AAE7G,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,OAAO,EAA4B,MAAM,EAAc,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAK5D;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,eAAe;IAyBvD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,mBAAmB;IA1B5B;;OAEG;IACH,OAAc,IAAI,SAAgB;IAElC;;OAEG;IACH,OAAc,UAAU,EAAE,kBAAkB,CAI1C;IAEF;;;;;;;;OAQG;gBAEe,WAAW,EAAE,WAAW,EACxB,gBAAgB,GAAE,KAAK,GAAG;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAU,EACxE,mBAAmB,UAAQ;IAGpC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,kBAAkB,CAE1C;IAED;;OAEG;IACU,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC9C,OAAO,CAAC,QAAQ,CAAC;IAMpB;;;;OAIG;IACI,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,mBAAmB,GAAE,OAAe,GAAG,UAAU;IAO5G,OAAO,CAAC,gBAAgB;CAUxB;AAYD;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,+GAA+G;IAC/G,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpC,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC,wFAAwF;IACxF,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,uDAAuD;IACvD,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;CACzC;AAED;;;GAGG;AACH,oBAAY,sBAAsB,GAC/B;IACA;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC;CACnC,GACD;IACA;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC;CAC1D,CAAC;AAEL;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC7D,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,oBAAoB,OAAE;IACzD,CAAC,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,2BAA2B,OAAE;CACvE;AAED;;;GAGG;AACH,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,2BAA2B,KAAK,IAAI,CAAC;AAE/E;;;GAGG;AACH,oBAAY,2BAA2B,GAAG,CAAC,IAAI,EAAE,kCAAkC,KAAK,IAAI,CAAC;AAI7F;;;GAGG;AACH,qBAAa,UAAW,SAAQ,YAAY,CAAC,iBAAiB,CAAE,YAAW,aAAa;IAoHtF,OAAO,CAAC,WAAW;IAEnB,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IArHrC;;OAEG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU;IAI9E;;;;;;;;;;;;;;;;;;OAkBG;WACW,UAAU,CACvB,WAAW,EAAE,WAAW,EACxB,gBAAgB,GAAE,KAAK,GAAG;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAU,GAC7D,iBAAiB;IAQpB,OAAO,CAAC,YAAY,CAAsE;IAC1F,OAAO,CAAC,QAAQ,CAAC,YAAY,CAO3B;IAGF,OAAO,CAAC,QAAQ,CAA8E;IAE9F;;OAEG;IACH,OAAO,CAAC,OAAO,CAA0B;IAEzC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB,CAAmB;IAE3C;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAEhC;IAED,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC5C,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAmB;IAE9D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0B;IACxD,OAAO,CAAC,aAAa,CAA0B;IAE/C,kEAAkE;IAClE,OAAO,CAAC,eAAe,CAAU;IAEjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAGhC;IAEF,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAezC;IAEF,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,gBAAgB,CAAU;IAElC;;;;;;;;OAQG;gBAEF,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACF,WAAW,EAAE,WAAW,EAChC,gBAAgB,GAAE,KAAK,GAAG;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAU,EAC9C,mBAAmB,UAAQ;IAwCtC,cAAc,IAAI,WAAW;IAIpC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAW3B;IAEF;;;OAGG;IACH,OAAO,CAAC,eAAe;IA+BvB;;OAEG;IACH,IAAW,WAAW,IAAI,YAAY,CAErC;IAED;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAIhD;;;;;;OAMG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAItD;;;;;;;OAOG;IACI,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAIrE;;;;;;OAMG;IACI,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAMhD;;;;;;OAMG;IACI,kBAAkB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAI/D;;;OAGG;IACH,IAAW,KAAK,IAAI,cAAc,CAAC,kBAAkB,CAAC,CAErD;IAED,OAAO,CAAC,iBAAiB;IAMzB;;;;OAIG;IACH,OAAO,CAAC,eAAe;YAQT,oBAAoB;IA6ClC;;OAEG;IACI,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAIzE;;;;;OAKG;IACI,qBAAqB,CAAC,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,gBAAgB,CAAA;KAAE,GAAG,MAAM;IAKjF;;;;OAIG;IACI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB;IAMpE;;;OAGG;IACI,WAAW,IAAI,qBAAqB;IAyB3C;;;OAGG;IACH,OAAO,CAAC,eAAe;IA0BvB;;;OAGG;IACI,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAgGxD,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC;;;OAGG;IACH,OAAO,CAAC,+BAA+B;IAkDvC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;;;;;;;;;;;;SAaK;IACE,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAQ9C;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxE;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAuD7D;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAI9B;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAI9B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,oBAAoB;IAqC5B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAiC5B,OAAO,CAAC,0BAA0B;IAiDlC;;;;;;OAMG;IACI,SAAS,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACzD,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;IAa7D;;;;;;;;;OASG;IACI,cAAc,CACpB,KAAK,EAAE,UAAU,EACjB,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EACzC,gBAAgB,CAAC,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,YAAY,GACnD,MAAM,EAAE;IAaX;;;;;;OAMG;IACI,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,cAAc,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;IAa/G;;;;OAIG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc;IAmExD,OAAO,CAAC,gBAAgB;IAgBxB;;;;;OAKG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAYjD;;;;;;OAMG;IACI,aAAa,CAAC,OAAO,EAAE,SAAS,kBAAkB,EAAE,EAAE,MAAM,EAAE,YAAY,GAAG,cAAc,EAAE,GAAG,SAAS;IAIhH;;OAEG;IACH,OAAO,CAAC,YAAY;IAyBpB,OAAO,CAAC,aAAa;IAIrB,oEAAoE;IACpE,OAAO,CAAC,QAAQ;IAQT,UAAU,IAAI,sBAAsB;IAI3C;;;;;;;;;OASG;IACH,SAAS,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI;IA6C3C,OAAO,CAAC,iBAAiB;IAKzB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;CAuB7B"}
+{"version":3,"file":"SharedTree.d.ts","sourceRoot":"","sources":["../src/SharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAEN,gBAAgB,EAChB,mBAAmB,EAEnB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE5F,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAE5E,OAAO,EAA6D,cAAc,EAAE,MAAM,WAAW,CAAC;AACtG,OAAO,EACN,MAAM,EACN,MAAM,EACN,YAAY,EAIZ,aAAa,EACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EAIN,SAAS,EAGT,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAEN,cAAc,EAKd,IAAI,EAGJ,UAAU,EAWV,qBAAqB,EAIrB,WAAW,EAEX,kBAAkB,EAClB,MAAM,mBAAmB,CAAC;AAW3B,OAAO,EAAoB,aAAa,EAA2C,MAAM,mBAAmB,CAAC;AAE7G,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,OAAO,EAA4B,MAAM,EAAc,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAM5D;;;GAGG;AACH,oBAAY,cAAc,CAAC,EAAE,SAAS,WAAW,GAAG,WAAW,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;AAEtH;;;GAGG;AACH,oBAAY,iBAAiB,CAC5B,EAAE,SAAS,WAAW,EACtB,oBAAoB,SAAS,UAAU,GAAG,MAAM,GAAG,UAAU,IAC1D,IAAI,CACP,EAAE,SAAS,WAAW,CAAC,MAAM,GAC1B,uBAAuB,GACvB,EAAE,SAAS,WAAW,CAAC,MAAM,GAC7B,uBAAuB,GACvB,KAAK,EACR,oBAAoB,SAAS,UAAU,GAAG,kBAAkB,GAAG,KAAK,CACpE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,EAAE,KAAK,GAAG;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAE,CAAC;IACzD,0HAA0H;IAC1H,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,eAAe;IACxD;;OAEG;IACH,OAAc,IAAI,SAAgB;IAElC;;OAEG;IACH,OAAc,UAAU,EAAE,kBAAkB,CAI1C;IAEF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiB;IAEtC;;;;;;OAMG;gBACS,GAAG,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC;gBAC3C,GAAG,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC;IAKvD;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,kBAAkB,CAE1C;IAED;;OAEG;IACU,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC9C,OAAO,CAAC,QAAQ,CAAC;IAMpB;;;;OAIG;IACI,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,UAAU;IAMtE,OAAO,CAAC,gBAAgB;CAWxB;AAYD;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,+GAA+G;IAC/G,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpC,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC,wFAAwF;IACxF,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,uDAAuD;IACvD,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;CACzC;AAED;;;GAGG;AACH,oBAAY,sBAAsB,GAC/B;IACA;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC;CACnC,GACD;IACA;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC;CAC1D,CAAC;AAEL;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC7D,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,oBAAoB,OAAE;IACzD,CAAC,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,2BAA2B,OAAE;CACvE;AAED;;;GAGG;AACH,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,2BAA2B,KAAK,IAAI,CAAC;AAE/E;;;GAGG;AACH,oBAAY,2BAA2B,GAAG,CAAC,IAAI,EAAE,kCAAkC,KAAK,IAAI,CAAC;AAI7F;;;GAGG;AACH,qBAAa,UAAW,SAAQ,YAAY,CAAC,iBAAiB,CAAE,YAAW,aAAa;IA8JtF,OAAO,CAAC,WAAW;IA7JpB;;OAEG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU;IAI9E;;;;;;;;;;OAUG;WACW,UAAU,CAAC,GAAG,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,iBAAiB;WAE1E,UAAU,CAAC,GAAG,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,iBAAiB;IAkBxF;;;;;OAKG;IACH,IAAW,aAAa,IAAI,aAAa,CAYxC;IAED,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAO3B;IAGF,OAAO,CAAC,QAAQ,CAA8E;IAE9F;;OAEG;IACH,OAAO,CAAC,OAAO,CAA0B;IAEzC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB,CAAmB;IAE3C;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAEhC;IAED,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC5C,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAmB;IAE9D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0B;IACxD,OAAO,CAAC,aAAa,CAA0B;IAE/C,kEAAkE;IAClE,OAAO,CAAC,eAAe,CAAU;IAEjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAGhC;IAEF,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAezC;IAEF,OAAO,CAAC,gBAAgB,CAAU;IAClC,OAAO,CAAC,gBAAgB,CAAU;IAElC,OAAO,CAAC,gBAAgB;IAkBxB;;;;;;;OAOG;gBACgB,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC;gBAExF,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC;IAiD3G;;;;OAIG;IACI,cAAc,IAAI,WAAW;IAIpC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAW3B;IAEF;;;OAGG;IACH,OAAO,CAAC,eAAe;IA+BvB;;OAEG;IACH,IAAW,WAAW,IAAI,YAAY,CAErC;IAED;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAIhD;;;;;;OAMG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAItD;;;;;;;OAOG;IACI,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAIrE;;;;;;OAMG;IACI,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAMhD;;;;;;OAMG;IACI,kBAAkB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAI/D;;;;;OAKG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa;IAcjD;;;OAGG;IACH,IAAW,KAAK,IAAI,cAAc,CAAC,kBAAkB,CAAC,CAErD;IAED,OAAO,CAAC,iBAAiB;IAMzB;;;;OAIG;IACH,OAAO,CAAC,eAAe;YAQT,oBAAoB;IA6ClC;;OAEG;IACI,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAIzE;;;;;OAKG;IACI,qBAAqB,CAAC,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,gBAAgB,CAAA;KAAE,GAAG,MAAM;IAKjF;;;;OAIG;IACI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB;IAMpE;;;OAGG;IACI,WAAW,IAAI,qBAAqB;IAyB3C;;;OAGG;IACH,OAAO,CAAC,eAAe;IA0BvB;;;OAGG;IACI,WAAW,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;IAmGxD,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC;;;OAGG;IACH,OAAO,CAAC,+BAA+B;IAkDvC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;;;;;;;;;;;;SAaK;IACE,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAQ9C;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxE;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAuD7D;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAI9B;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAI9B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,oBAAoB;IAqC5B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAiC5B,OAAO,CAAC,0BAA0B;IAiDlC;;;;;;OAMG;IACI,SAAS,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACzD,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;IAa7D;;;;;;;;;OASG;IACI,cAAc,CACpB,KAAK,EAAE,UAAU,EACjB,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EACzC,gBAAgB,CAAC,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,YAAY,GACnD,MAAM,EAAE;IAaX;;;;;;OAMG;IACI,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,cAAc,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;IAa/G;;;;OAIG;IACI,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc;IAmExD,OAAO,CAAC,gBAAgB;IAgBxB;;;;;OAKG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAYjD;;;;;;OAMG;IACI,aAAa,CAAC,OAAO,EAAE,SAAS,kBAAkB,EAAE,EAAE,MAAM,EAAE,YAAY,GAAG,cAAc,EAAE,GAAG,SAAS;IAIhH;;OAEG;IACH,OAAO,CAAC,YAAY;IAyBpB,OAAO,CAAC,aAAa;IAIrB,oEAAoE;IACpE,OAAO,CAAC,QAAQ;IAQT,UAAU,IAAI,sBAAsB;IAI3C;;;;;;;;;OASG;IACH,SAAS,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI;IA6C3C,OAAO,CAAC,iBAAiB;IAKzB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;CAuB7B"}

package/dist/SharedTree.js

@@ -27,25 +27,15 @@ const ChangeTypes_1 = require("./ChangeTypes");
 const id_compressor_1 = require("./id-compressor");
 const IdConversion_1 = require("./IdConversion");
 const StringInterner_1 = require("./StringInterner");
+const UuidUtilities_1 = require("./UuidUtilities");
 /**
  * Factory for SharedTree.
  * Includes history in the summary.
  * @public
  */
 class SharedTreeFactory {
-    /**
-     * Get a factory for SharedTree to register with the data store.
-     * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See [the write format
-     * documentation](../docs/Write-Format.md) for more information.
-     * @param summarizeHistory - Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
-     * See the [breaking change migration documentation](docs/Breaking-Change-Migration) for more details on this scheme.
-     * @param expensiveValidation - Enables expensive asserts on SharedTree.
-     * @returns A factory that creates `SharedTree`s and loads them from storage.
-     */
-    constructor(writeFormat, summarizeHistory = false, expensiveValidation = false) {
-        this.writeFormat = writeFormat;
-        this.summarizeHistory = summarizeHistory;
-        this.expensiveValidation = expensiveValidation;
+    constructor(...args) {
+        this.args = args;
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#ISharedObjectFactory."type"}
@@ -72,15 +62,21 @@ class SharedTreeFactory {
      * @param runtime - data store runtime that owns the new SharedTree
      * @param id - optional name for the SharedTree
      */
-    create(runtime, id, expensiveValidation = false) {
-        this.expensiveValidation = expensiveValidation;
+    create(runtime, id) {
         const sharedTree = this.createSharedTree(runtime, id);
         sharedTree.initializeLocal();
         return sharedTree;
     }
     createSharedTree(runtime, id) {
-        const sharedTree = new SharedTree(runtime, id, this.writeFormat, this.summarizeHistory, this.expensiveValidation);
-        return sharedTree;
+        const [writeFormat] = this.args;
+        switch (writeFormat) {
+            case persisted_types_1.WriteFormat.v0_0_2:
+                return new SharedTree(runtime, id, ...this.args);
+            case persisted_types_1.WriteFormat.v0_1_1:
+                return new SharedTree(runtime, id, ...this.args);
+            default:
+                (0, Common_1.fail)('Unknown write format');
+        }
     }
 }
 exports.SharedTreeFactory = SharedTreeFactory;
@@ -110,20 +106,9 @@ const sharedTreeTelemetryProperties = { all: { isSharedTreeEvent: true } };
  * @public
  */
 class SharedTree extends shared_object_base_1.SharedObject {
-    /**
-     * Create a new SharedTreeFactory.
-     * @param runtime - The runtime the SharedTree will be associated with
-     * @param id - Unique ID for the SharedTree
-     * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See [the write format
-     * documentation](../docs/Write-Format.md) for more information.
-     * @param summarizeHistory - Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
-     * @param expensiveValidation - Enable expensive asserts.
-     */
-    constructor(runtime, id, writeFormat, summarizeHistory = false, expensiveValidation = false) {
-        super(id, runtime, SharedTreeFactory.Attributes);
+    constructor(runtime, id, writeFormat, options = {}) {
+        super(id, runtime, SharedTreeFactory.Attributes, 'fluid_sharedTree_');
         this.writeFormat = writeFormat;
-        this.expensiveValidation = expensiveValidation;
-        this.idCompressor = new id_compressor_1.IdCompressor((0, id_compressor_1.createSessionId)(), persisted_types_1.reservedIdCount);
         this.idNormalizer = {
             tree: this,
             get localSessionId() {
@@ -166,8 +151,9 @@ class SharedTree extends shared_object_base_1.SharedObject {
                 }
             }
         };
-        this.summarizeHistory = summarizeHistory === false ? false : true;
-        this.uploadEditChunks = summarizeHistory === false ? false : summarizeHistory.uploadEditChunks;
+        const historyPolicy = this.getHistoryPolicy(options);
+        this.summarizeHistory = historyPolicy.summarizeHistory;
+        this.uploadEditChunks = historyPolicy.uploadEditChunks;
         // This code is somewhat duplicated from OldestClientObserver because it currently depends on the container runtime
         // which SharedTree does not have access to.
         // TODO:#55900: Get rid of copy-pasted OldestClientObserver code
@@ -179,11 +165,12 @@ class SharedTree extends shared_object_base_1.SharedObject {
         runtime.on('disconnected', this.updateOldest);
         this.logger = telemetry_utils_1.ChildLogger.create(runtime.logger, 'SharedTree', sharedTreeTelemetryProperties);
         this.sequencedEditAppliedLogger = telemetry_utils_1.ChildLogger.create(this.logger, 'SequencedEditApplied', sharedTreeTelemetryProperties);
+        const attributionId = options.attributionId;
+        this.idCompressor = new id_compressor_1.IdCompressor((0, id_compressor_1.createSessionId)(), persisted_types_1.reservedIdCount, attributionId);
         const { editLog, cachingLogViewer } = this.initializeNewEditLogFromSummary({
             editChunks: [],
             editIds: [],
-        }, undefined, this.idCompressor, // TODO: Attribution info
-        this.processEditResult, this.processSequencedEditResult, persisted_types_1.WriteFormat.v0_1_1);
+        }, undefined, this.idCompressor, this.processEditResult, this.processSequencedEditResult, persisted_types_1.WriteFormat.v0_1_1);
         this.editLog = editLog;
         this.cachingLogViewer = cachingLogViewer;
         this.encoder_0_0_2 = new SharedTreeEncoder_1.SharedTreeEncoder_0_0_2(this.summarizeHistory);
@@ -195,31 +182,39 @@ class SharedTree extends shared_object_base_1.SharedObject {
     static create(runtime, id) {
         return runtime.createChannel(id, SharedTreeFactory.Type);
     }
-    /**
-     * Get a factory for SharedTree to register with the data store.
-     * @param summarizeHistory - Determines if the history is included in summaries and if edit chunks are uploaded when they are full.
-     *
-     * On 0.1.1 documents, due to current code limitations, this parameter is only impactful for newly created documents.
-     * `SharedTree`s which load existing documents will summarize history if and only if the loaded summary included history.
-     *
-     * The technical limitations here relate to clients with mixed versions collaborating.
-     * In the future we may allow modification of whether or not a particular document saves history, but only via a consensus mechanism.
-     * See the skipped test in SharedTreeFuzzTests.ts for more details on this issue.
-     * See docs/Breaking-Change-Migration for more details on the consensus scheme.
-     * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in.
-     * This format may be updated to a newer (supported) version at runtime if a collaborating shared-tree
-     * that was initialized with a newer write version connects to the session. Care must be taken when changing this value,
-     * as a staged rollout must of occurred such that all collaborating clients must have the code to read at least the version
-     * written.
-     * See [the write format documentation](../docs/Write-Format.md) for more information.
-     * @returns A factory that creates `SharedTree`s and loads them from storage.
-     */
-    static getFactory(writeFormat, summarizeHistory = false) {
+    static getFactory(...args) {
+        const [writeFormat] = args;
         // 	On 0.1.1 documents, due to current code limitations, all clients MUST agree on the value of `summarizeHistory`.
         //  Note that this means staged rollout changing this value should not be attempted.
         //  It is possible to update shared-tree to correctly handle such a staged rollout, but that hasn't been implemented.
         //  See the skipped test in SharedTreeFuzzTests.ts for more details on this issue.
-        return new SharedTreeFactory(writeFormat, summarizeHistory);
+        switch (writeFormat) {
+            case persisted_types_1.WriteFormat.v0_0_2:
+                return new SharedTreeFactory(...args);
+            case persisted_types_1.WriteFormat.v0_1_1:
+                return new SharedTreeFactory(...args);
+            default:
+                (0, Common_1.fail)('Unknown write format');
+        }
+    }
+    /**
+     * The UUID used for attribution of nodes created by this SharedTree. All shared trees with a write format of 0.1.1 or
+     * greater have a unique attribution ID which may be configured in the constructor. All other shared trees (i.e. those
+     * with a write format of 0.0.2) use the nil UUID as their attribution ID.
+     * @public
+     */
+    get attributionId() {
+        switch (this.writeFormat) {
+            case persisted_types_1.WriteFormat.v0_0_2:
+                return UuidUtilities_1.nilUuid;
+            default: {
+                const { attributionId } = this.idCompressor;
+                if (attributionId === persisted_types_1.ghostSessionId) {
+                    return UuidUtilities_1.nilUuid;
+                }
+                return attributionId;
+            }
+        }
     }
     /**
      * Viewer for trees defined by editLog. This allows access to views of the tree at different revisions (various points in time).
@@ -227,6 +222,27 @@ class SharedTree extends shared_object_base_1.SharedObject {
     get logViewer() {
         return this.cachingLogViewer;
     }
+    getHistoryPolicy(options) {
+        var _a;
+        const noCompatOptions = options;
+        if (typeof noCompatOptions.summarizeHistory === 'object') {
+            return {
+                summarizeHistory: true,
+                uploadEditChunks: noCompatOptions.summarizeHistory.uploadEditChunks,
+            };
+        }
+        else {
+            return {
+                summarizeHistory: (_a = noCompatOptions.summarizeHistory) !== null && _a !== void 0 ? _a : false,
+                uploadEditChunks: false,
+            };
+        }
+    }
+    /**
+     * The write format version currently used by this `SharedTree`. This is always initialized to the write format
+     * passed to the tree's constructor, but it may automatically upgrade over time (e.g. when connected to another
+     * SharedTree with a higher write format, or when loading a summary with a higher write format).
+     */
     getWriteFormat() {
         return this.writeFormat;
     }
@@ -323,6 +339,25 @@ class SharedTree extends shared_object_base_1.SharedObject {
     tryConvertToNodeId(id) {
         return this.idCompressor.tryRecompress(id);
     }
+    /**
+     * Returns the attribution ID associated with the SharedTree that generated the given node ID. This is generally only useful for clients
+     * with a write format of 0.1.1 or greater since older clients cannot be given an attribution ID and will always use the default
+     * `attributionId` of the tree.
+     * @public
+     */
+    attributeNodeId(id) {
+        switch (this.writeFormat) {
+            case persisted_types_1.WriteFormat.v0_0_2:
+                return UuidUtilities_1.nilUuid;
+            default: {
+                const attributionId = this.idCompressor.attributeId(id);
+                if (attributionId === persisted_types_1.ghostSessionId) {
+                    return UuidUtilities_1.nilUuid;
+                }
+                return attributionId;
+            }
+        }
+    }
     /**
      * @returns the edit history of the tree.
      * @public
@@ -469,7 +504,7 @@ class SharedTree extends shared_object_base_1.SharedObject {
         let convertedSummary;
         switch (loadedSummaryVersion) {
             case persisted_types_1.WriteFormat.v0_0_2:
-                convertedSummary = this.encoder_0_0_2.decodeSummary(summary);
+                convertedSummary = this.encoder_0_0_2.decodeSummary(summary, this.attributionId);
                 break;
             case persisted_types_1.WriteFormat.v0_1_1: {
                 const typedSummary = summary;
@@ -480,7 +515,7 @@ class SharedTree extends shared_object_base_1.SharedObject {
                     this.uploadEditChunks = loadedSummaryIncludesHistory;
                     this.encoder_0_1_1 = new SharedTreeEncoder_1.SharedTreeEncoder_0_1_1(this.summarizeHistory);
                 }
-                convertedSummary = this.encoder_0_1_1.decodeSummary(summary); // TODO:#461: pass attribution info
+                convertedSummary = this.encoder_0_1_1.decodeSummary(summary, this.attributionId);
                 break;
             }
             default:
@@ -768,7 +803,7 @@ class SharedTree extends shared_object_base_1.SharedObject {
         this.interner = new StringInterner_1.MutableStringInterner([InitialTree_1.initialTree.definition]);
         const oldIdCompressor = this.idCompressor;
         // Create the IdCompressor that will be used after the upgrade
-        const newIdCompressor = new id_compressor_1.IdCompressor((0, id_compressor_1.createSessionId)(), persisted_types_1.reservedIdCount); // TODO: attribution info
+        const newIdCompressor = new id_compressor_1.IdCompressor((0, id_compressor_1.createSessionId)(), persisted_types_1.reservedIdCount, this.attributionId);
         const newContext = (0, NodeIdUtilities_1.getNodeIdContext)(newIdCompressor);
         // Generate all local IDs in the new compressor that were in the old compressor and preserve their UUIDs.
         // This will allow the client to continue to use local IDs that were allocated pre-upgrade
@@ -782,7 +817,7 @@ class SharedTree extends shared_object_base_1.SharedObject {
             }
         };
         // Construct a temporary "ghost" compressor which is used to generate final IDs that will be consistent across all upgrading clients
-        const ghostIdCompressor = new id_compressor_1.IdCompressor(persisted_types_1.ghostSessionId, persisted_types_1.reservedIdCount); // TODO: attribution info
+        const ghostIdCompressor = new id_compressor_1.IdCompressor(persisted_types_1.ghostSessionId, persisted_types_1.reservedIdCount);
         const ghostContext = (0, NodeIdUtilities_1.getNodeIdContext)(ghostIdCompressor);
         if (this.summarizeHistory) {
             // All clients have the full history, and can therefore all "generate" the same final IDs for every ID in the history