@fluidframework/tree 2.117.0 → 3.0.0

package/lib/shared-tree/history.js.map

@@ -1 +1 @@
-{"version":3,"file":"history.js","sourceRoot":"","sources":["../../src/shared-tree/history.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAI7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAyB,MAAM,8BAA8B,CAAC;AAO1F;;GAEG;AACH,MAAM,4BAA4B;IAOjC,YACkB,MAAqC,EACrC,YAA2B;QAD3B,WAAM,GAAN,MAAM,CAA+B;QACrC,iBAAY,GAAZ,YAAY,CAAe;QAE5C,MAAM,CACL,MAAM,CAAC,QAAQ,KAAK,MAAM,EAC1B,KAAK,CAAC,mDAAmD,CACzD,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC1D,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;IACnC,CAAC;IAEM,SAAS;QACf,uEAAuE;QACvE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;YACpD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;YAC/B,IAAI,CAAC,WAAW;gBACf,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,MAAM;oBACjD,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC;wBACA,KAAK,EAAE,MAAM;wBACb,MAAM,EAAE,IAAI,4BAA4B,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC;qBACnE,CAAC;QACN,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC;IACjC,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAOpC,YACkB,MAIhB,EACgB,YAA2B;QAL3B,WAAM,GAAN,MAAM,CAItB;QACgB,iBAAY,GAAZ,YAAY,CAAe;QAE5C,IAAI,CAAC,aAAa,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAEM,OAAO;QACb,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;IACjC,CAAC;IAEM,OAAO;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAClE,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IIdCompressor } from \"@fluidframework/id-compressor\";\n\nimport type { GraphCommit, CustomMetadataTree } from \"../core/index.js\";\nimport { flattenCustomMetadata } from \"../core/index.js\";\nimport { BranchCommitCounter, type SharedTreeBranch } from \"../shared-tree-core/index.js\";\nimport type { TreeBranchCommitMetadata, TreeBranchHistory } from \"../simple-tree/index.js\";\nimport type { JsonCompatibleReadOnlyObject } from \"../util/index.js\";\n\nimport type { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\nimport type { SharedTreeEditBuilder } from \"./sharedTreeEditBuilder.js\";\n\n/**\n * A lazily constructed implementation of {@link TreeBranchCommitMetadata} that wraps a {@link GraphCommit}.\n */\nclass LazyTreeBranchCommitMetadata implements TreeBranchCommitMetadata {\n\tpublic readonly revision: string;\n\tprivate parentCache?: {\n\t\treadonly prior: GraphCommit<SharedTreeChange>;\n\t\treadonly cached: TreeBranchCommitMetadata;\n\t};\n\n\tpublic constructor(\n\t\tprivate readonly commit: GraphCommit<SharedTreeChange>,\n\t\tprivate readonly idCompressor: IIdCompressor,\n\t) {\n\t\tassert(\n\t\t\tcommit.revision !== \"root\",\n\t\t\t0xd34 /* Cannot construct metadata for the root commit */,\n\t\t);\n\t\tthis.revision = idCompressor.decompress(commit.revision);\n\t}\n\n\tpublic get custom(): JsonCompatibleReadOnlyObject | undefined {\n\t\treturn flattenCustomMetadata(this.commit.customMetadata);\n\t}\n\n\tpublic get customTree(): CustomMetadataTree | undefined {\n\t\treturn this.commit.customMetadata;\n\t}\n\n\tpublic getParent(): TreeBranchCommitMetadata | undefined {\n\t\t// The parent of the commit may change over time due to trunk trimming.\n\t\tif (this.commit.parent !== this.parentCache?.prior) {\n\t\t\tconst { parent } = this.commit;\n\t\t\tthis.parentCache =\n\t\t\t\tparent === undefined || parent.revision === \"root\"\n\t\t\t\t\t? undefined\n\t\t\t\t\t: {\n\t\t\t\t\t\t\tprior: parent,\n\t\t\t\t\t\t\tcached: new LazyTreeBranchCommitMetadata(parent, this.idCompressor),\n\t\t\t\t\t\t};\n\t\t}\n\t\treturn this.parentCache?.cached;\n\t}\n}\n\n/**\n * A default implementation of {@link TreeBranchHistory} that wraps a {@link SharedTreeBranch}.\n */\nexport class DefaultTreeBranchHistory implements TreeBranchHistory {\n\tprivate readonly commitCounter: BranchCommitCounter<\n\t\tSharedTreeEditBuilder,\n\t\tSharedTreeChange,\n\t\tunknown\n\t>;\n\n\tpublic constructor(\n\t\tprivate readonly branch: SharedTreeBranch<\n\t\t\tSharedTreeEditBuilder,\n\t\t\tSharedTreeChange,\n\t\t\tunknown\n\t\t>,\n\t\tprivate readonly idCompressor: IIdCompressor,\n\t) {\n\t\tthis.commitCounter = new BranchCommitCounter(branch);\n\t}\n\n\tpublic dispose(): void {\n\t\tthis.commitCounter.dispose();\n\t}\n\n\tpublic get length(): number {\n\t\treturn this.commitCounter.count;\n\t}\n\n\tpublic getHead(): TreeBranchCommitMetadata | undefined {\n\t\tconst head = this.branch.getHead();\n\t\tif (head.revision === \"root\") {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn new LazyTreeBranchCommitMetadata(head, this.idCompressor);\n\t}\n}\n"]}
+{"version":3,"file":"history.js","sourceRoot":"","sources":["../../src/shared-tree/history.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAI7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAyB,MAAM,8BAA8B,CAAC;AAW1F;;GAEG;AACH,MAAM,4BAA4B;IAef;IACA;IAflB;;OAEG;IACc,QAAQ,CAIvB;IACM,WAAW,CAGjB;IAEF,YACkB,MAAqC,EACrC,YAA2B;QAD3B,WAAM,GAAN,MAAM,CAA+B;QACrC,iBAAY,GAAZ,YAAY,CAAe;QAE5C,MAAM,CACL,MAAM,CAAC,QAAQ,KAAK,MAAM,EAC1B,KAAK,CAAC,mDAAmD,CACzD,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG;YACf,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,cAAc,EAAE,MAAM,CAAC,cAAc;SACrC,CAAC;IACH,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACrC,CAAC;IAEM,SAAS;QACf,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC;YACxB,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QACpC,IAAI,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;YACxC,IAAI,CAAC,WAAW,GAAG;gBAClB,KAAK,EAAE,MAAM;gBACb,MAAM,EACL,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU;oBACxC,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,IAAI,4BAA4B,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC;aAC/D,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC;IACjC,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAQlB;IAKA;IAZD,aAAa,CAI5B;IAEF,YACkB,MAIhB,EACgB,YAA2B;QAL3B,WAAM,GAAN,MAAM,CAItB;QACgB,iBAAY,GAAZ,YAAY,CAAe;QAE5C,IAAI,CAAC,aAAa,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAEM,OAAO;QACb,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;IACjC,CAAC;IAEM,OAAO;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAClE,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IIdCompressor, SessionSpaceCompressedId } from \"@fluidframework/id-compressor\";\n\nimport type { GraphCommit, CustomMetadataTree } from \"../core/index.js\";\nimport { flattenCustomMetadata } from \"../core/index.js\";\nimport { BranchCommitCounter, type SharedTreeBranch } from \"../shared-tree-core/index.js\";\nimport type {\n\tCommitRevision,\n\tTreeBranchCommitMetadata,\n\tTreeBranchHistory,\n} from \"../simple-tree/index.js\";\nimport type { JsonCompatibleReadOnlyObject } from \"../util/index.js\";\n\nimport type { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\nimport type { SharedTreeEditBuilder } from \"./sharedTreeEditBuilder.js\";\n\n/**\n * A lazily constructed implementation of {@link TreeBranchCommitMetadata} that wraps a {@link GraphCommit}.\n */\nclass LazyTreeBranchCommitMetadata implements TreeBranchCommitMetadata {\n\t/**\n\t * Holds a copy of data that may become inaccessible when the commit is trimmed.\n\t */\n\tprivate readonly snapshot: {\n\t\treadonly revision: SessionSpaceCompressedId;\n\t\treadonly parent: GraphCommit<SharedTreeChange> | undefined;\n\t\treadonly customMetadata: CustomMetadataTree | undefined;\n\t};\n\tprivate parentCache?: {\n\t\treadonly prior: GraphCommit<SharedTreeChange> | undefined;\n\t\treadonly cached: TreeBranchCommitMetadata | undefined;\n\t};\n\n\tpublic constructor(\n\t\tprivate readonly commit: GraphCommit<SharedTreeChange>,\n\t\tprivate readonly idCompressor: IIdCompressor,\n\t) {\n\t\tassert(\n\t\t\tcommit.revision !== \"root\",\n\t\t\t0xd33 /* Cannot construct metadata for the root commit */,\n\t\t);\n\t\tthis.snapshot = {\n\t\t\trevision: commit.revision,\n\t\t\tparent: commit.parent,\n\t\t\tcustomMetadata: commit.customMetadata,\n\t\t};\n\t}\n\n\tpublic get revision(): CommitRevision {\n\t\treturn this.idCompressor.decompress(this.snapshot.revision);\n\t}\n\n\tpublic get custom(): JsonCompatibleReadOnlyObject | undefined {\n\t\treturn flattenCustomMetadata(this.snapshot.customMetadata);\n\t}\n\n\tpublic get customTree(): CustomMetadataTree | undefined {\n\t\treturn this.snapshot.customMetadata;\n\t}\n\n\tpublic getParent(): TreeBranchCommitMetadata | undefined {\n\t\tif (this.commit.wasTrimmed) {\n\t\t\tdelete this.parentCache;\n\t\t\treturn undefined;\n\t\t}\n\t\tconst parent = this.snapshot.parent;\n\t\tif (parent !== this.parentCache?.prior) {\n\t\t\tthis.parentCache = {\n\t\t\t\tprior: parent,\n\t\t\t\tcached:\n\t\t\t\t\tparent === undefined || parent.wasTrimmed\n\t\t\t\t\t\t? undefined\n\t\t\t\t\t\t: new LazyTreeBranchCommitMetadata(parent, this.idCompressor),\n\t\t\t};\n\t\t}\n\t\treturn this.parentCache?.cached;\n\t}\n}\n\n/**\n * A default implementation of {@link TreeBranchHistory} that wraps a {@link SharedTreeBranch}.\n */\nexport class DefaultTreeBranchHistory implements TreeBranchHistory {\n\tprivate readonly commitCounter: BranchCommitCounter<\n\t\tSharedTreeEditBuilder,\n\t\tSharedTreeChange,\n\t\tunknown\n\t>;\n\n\tpublic constructor(\n\t\tprivate readonly branch: SharedTreeBranch<\n\t\t\tSharedTreeEditBuilder,\n\t\t\tSharedTreeChange,\n\t\t\tunknown\n\t\t>,\n\t\tprivate readonly idCompressor: IIdCompressor,\n\t) {\n\t\tthis.commitCounter = new BranchCommitCounter(branch);\n\t}\n\n\tpublic dispose(): void {\n\t\tthis.commitCounter.dispose();\n\t}\n\n\tpublic get length(): number {\n\t\treturn this.commitCounter.count;\n\t}\n\n\tpublic getHead(): TreeBranchCommitMetadata | undefined {\n\t\tconst head = this.branch.getHead();\n\t\tif (head.revision === \"root\") {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn new LazyTreeBranchCommitMetadata(head, this.idCompressor);\n\t}\n}\n"]}

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

@@ -5,7 +5,7 @@
 import type { IFluidHandle, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { type IIdCompressor } from "@fluidframework/id-compressor/internal";
 import type { CodecWriteOptions, ICodecOptions } from "../codec/index.js";
-import type { TreeViewConfiguration, ImplicitFieldSchema, TreeViewAlpha, ITreeAlpha, ViewableTree } from "../simple-tree/index.js";
+import type { TreeViewConfiguration, ImplicitFieldSchema, TreeViewAlpha, TreeViewBeta, ITreeAlpha, ViewableTree } from "../simple-tree/index.js";
 import { type JsonCompatible } from "../util/index.js";
 import { type ForestOptions } from "./sharedTree.js";
 /**
@@ -22,7 +22,7 @@ export interface IndependentViewTelemetryOptions {
     readonly logger?: ITelemetryBaseLogger | undefined;
 }
 /**
- * {@link independentView} options.
+ * {@link createIndependentTreeViewAlpha} options.
  * @alpha @input
  */
 export interface IndependentViewOptions extends ForestOptions, Partial<CodecWriteOptions>, IndependentViewTelemetryOptions {
@@ -58,12 +58,36 @@ export type CreateIndependentTreeAlphaOptions = ForestOptions & IndependentViewT
  * Create an uninitialized {@link TreeView} that is not tied to any {@link ITree} instance.
  *
  * @remarks
- * Such a view can never experience collaboration or be persisted to to a Fluid Container.
+ * Such a view can never experience collaboration or be persisted to a Fluid Container.
  *
  * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.
+ *
+ * @param config - The configuration for the tree view.
+ * @param options - Options for the independent tree view.
+ * @returns An uninitialized, non-collaborative tree view.
+ * @alpha
+ */
+export declare function createIndependentTreeViewAlpha<const TSchema extends ImplicitFieldSchema>(config: TreeViewConfiguration<TSchema>, options?: IndependentViewOptions): TreeViewAlpha<TSchema>;
+/**
+ * {@inheritDoc createIndependentTreeViewAlpha}
+ * @deprecated Use {@link createIndependentTreeViewAlpha} instead.
  * @alpha
  */
 export declare function independentView<const TSchema extends ImplicitFieldSchema>(config: TreeViewConfiguration<TSchema>, options?: IndependentViewOptions): TreeViewAlpha<TSchema>;
+/**
+ * Creates an uninitialized tree view that is not tied to any {@link ITree} instance.
+ *
+ * @remarks
+ * Such a view can never experience collaboration or be persisted to a Fluid Container.
+ *
+ * This can be useful for testing and for use cases such as working on local files instead of documents stored in a Fluid service.
+ *
+ * @param config - The configuration for the tree view.
+ * @param options - Options for the independent tree's forest.
+ * @returns An uninitialized, non-collaborative tree view.
+ * @beta
+ */
+export declare function createIndependentTreeView<const TSchema extends ImplicitFieldSchema>(config: TreeViewConfiguration<TSchema>, options?: ForestOptions): TreeViewBeta<TSchema>;
 /**
  * Create an initialized {@link TreeView} that is not tied to any {@link ITree} instance.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"independentView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/independentView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAE1F,OAAO,EACN,KAAK,aAAa,EAElB,MAAM,wCAAwC,CAAC;AAGhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAc1E,OAAO,KAAK,EACX,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,YAAY,EAKZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEN,KAAK,cAAc,EAGnB,MAAM,kBAAkB,CAAC;AAI1B,OAAO,EAIN,KAAK,aAAa,EAClB,MAAM,iBAAiB,CAAC;AAGzB;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,sBAChB,SAAQ,aAAa,EACpB,OAAO,CAAC,iBAAiB,CAAC,EAC1B,+BAA+B;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,aAAa,GAC5D,+BAA+B,GAC/B,CACG,CAAC,sBAAsB,GAAG;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;CACf,CAAC,GACF,CAAC,aAAa,GAAG;IACjB;;;OAGG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC;CACpB,CAAC,CACJ,CAAC;AAEH;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACxE,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACtC,OAAO,CAAC,EAAE,sBAAsB,GAC9B,aAAa,CAAC,OAAO,CAAC,CAExB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACnF,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACtC,OAAO,EAAE,aAAa,GAAG,aAAa,GAAG,+BAA+B,EACxE,OAAO,EAAE,WAAW,GAClB,aAAa,CAAC,OAAO,CAAC,CAIxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EAClF,OAAO,CAAC,EAAE,aAAa,GACrB,YAAY,CAEd;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACnF,OAAO,CAAC,EAAE,iCAAiC,GACzC,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,eAAe,GAAG,oBAAoB,CAAC,CA6EzE;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC;CACrC"}
+{"version":3,"file":"independentView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/independentView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAE1F,OAAO,EACN,KAAK,aAAa,EAElB,MAAM,wCAAwC,CAAC;AAGhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAc1E,OAAO,KAAK,EACX,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,YAAY,EACZ,UAAU,EACV,YAAY,EAKZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEN,KAAK,cAAc,EAGnB,MAAM,kBAAkB,CAAC;AAI1B,OAAO,EAIN,KAAK,aAAa,EAClB,MAAM,iBAAiB,CAAC;AAGzB;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,sBAChB,SAAQ,aAAa,EACpB,OAAO,CAAC,iBAAiB,CAAC,EAC1B,+BAA+B;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,aAAa,GAC5D,+BAA+B,GAC/B,CACG,CAAC,sBAAsB,GAAG;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;CACf,CAAC,GACF,CAAC,aAAa,GAAG;IACjB;;;OAGG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC;CACpB,CAAC,CACJ,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACvF,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACtC,OAAO,CAAC,EAAE,sBAAsB,GAC9B,aAAa,CAAC,OAAO,CAAC,CAExB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACxE,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACtC,OAAO,CAAC,EAAE,sBAAsB,GAC9B,aAAa,CAAC,OAAO,CAAC,CAExB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EAClF,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACtC,OAAO,CAAC,EAAE,aAAa,GACrB,YAAY,CAAC,OAAO,CAAC,CAEvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACnF,MAAM,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACtC,OAAO,EAAE,aAAa,GAAG,aAAa,GAAG,+BAA+B,EACxE,OAAO,EAAE,WAAW,GAClB,aAAa,CAAC,OAAO,CAAC,CAIxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EAClF,OAAO,CAAC,EAAE,aAAa,GACrB,YAAY,CAEd;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EACnF,OAAO,CAAC,EAAE,iCAAiC,GACzC,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,eAAe,GAAG,oBAAoB,CAAC,CA6EzE;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC;CACrC"}

package/lib/shared-tree/independentView.js

@@ -16,14 +16,42 @@ import { createTreeCheckout } from "./treeCheckout.js";
  * Create an uninitialized {@link TreeView} that is not tied to any {@link ITree} instance.
  *
  * @remarks
- * Such a view can never experience collaboration or be persisted to to a Fluid Container.
+ * Such a view can never experience collaboration or be persisted to a Fluid Container.
  *
  * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.
+ *
+ * @param config - The configuration for the tree view.
+ * @param options - Options for the independent tree view.
+ * @returns An uninitialized, non-collaborative tree view.
  * @alpha
  */
-export function independentView(config, options) {
+export function createIndependentTreeViewAlpha(config, options) {
     return createIndependentTreeAlpha(options).viewWith(config);
 }
+/**
+ * {@inheritDoc createIndependentTreeViewAlpha}
+ * @deprecated Use {@link createIndependentTreeViewAlpha} instead.
+ * @alpha
+ */
+export function independentView(config, options) {
+    return createIndependentTreeViewAlpha(config, options);
+}
+/**
+ * Creates an uninitialized tree view that is not tied to any {@link ITree} instance.
+ *
+ * @remarks
+ * Such a view can never experience collaboration or be persisted to a Fluid Container.
+ *
+ * This can be useful for testing and for use cases such as working on local files instead of documents stored in a Fluid service.
+ *
+ * @param config - The configuration for the tree view.
+ * @param options - Options for the independent tree's forest.
+ * @returns An uninitialized, non-collaborative tree view.
+ * @beta
+ */
+export function createIndependentTreeView(config, options) {
+    return createIndependentTreeBeta(options).viewWith(config);
+}
 /**
  * Create an initialized {@link TreeView} that is not tied to any {@link ITree} instance.
  *

package/lib/shared-tree/independentView.js.map

@@ -1 +1 @@
-{"version":3,"file":"independentView.js","sourceRoot":"","sources":["../../src/shared-tree/independentView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAEN,kBAAkB,GAClB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAG7E,OAAO,EAEN,gBAAgB,EAChB,0BAA0B,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,2BAA2B,EAC3B,sBAAsB,EACtB,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,aAAa,GACb,MAAM,+BAA+B,CAAC;AAYvC,OAAO,EAGN,SAAS,EACT,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EACN,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,GAElB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AA2DvD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC9B,MAAsC,EACtC,OAAgC;IAEhC,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAA2B,CAAC;AACvF,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,0BAA0B,CACzC,MAAsC,EACtC,OAAwE,EACxE,OAAoB;IAEpB,OAAO,0BAA0B,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,CAClE,MAAM,CACoB,CAAC;AAC7B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,yBAAyB,CACxC,OAAuB;IAEvB,OAAO,0BAA0B,CAAU,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,0BAA0B,CACzC,OAA2C;IAE3C,MAAM,MAAM,GAAG,iBAAiB,CAAC;QAChC,MAAM,EAAE,OAAO,EAAE,MAAM;QACvB,SAAS,EAAE,iBAAiB;KAC5B,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACzD,MAAM,YAAY,GACjB,OAAO,EAAE,YAAY,IAAI,OAAO,EAAE,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,CAAC;IACjF,MAAM,eAAe,GAAG,GAAgB,EAAE,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;IAC/E,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAE5D,iIAAiI;IACjI,MAAM,gBAAgB,GAAG,IAAI,0BAA0B,EAAE,CAAC;IAE1D,MAAM,MAAM,GAAG,qBAAqB,CACnC,OAAO,EACP,OAAO,EAAE,MAAM,IAAI,wBAAwB,CAAC,MAAM,EAClD,gBAAgB,EAChB,YAAY,EACZ,gCAAgC,CAChC,CAAC;IAEF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE;QACpF,MAAM;QACN,MAAM,EAAE,gBAAgB;QACxB,YAAY,EAAE,OAAO;KACrB,CAAC,CAAC;IAEH,IAAI,OAAO,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,kBAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,eAAe,GAAG,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE7D,8EAA8E;QAC9E,6EAA6E;QAC7E,MAAM,OAAO,GAAG,yBAAyB,CAAC,UAAU,CAAC;YACpD,YAAY;YACZ,OAAO,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CAC1C,OAAO,CAAC,OAAO,CAAC,IAA8B,EAC9C,OAAO,CACP,CAAC;QACF,MAAM,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAElF,MAAM,WAAW,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAEnF,UAAU,CACT,QAAQ,EACR,SAAS,EACT,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE,CACnC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CACtD,CACD,CAAC;IACH,CAAC;IAED,OAAO;QACN,QAAQ,CACP,MAAoC;YAEpC,MAAM,GAAG,GAA2B,IAAI,0BAA0B,CACjE,QAAQ,EACR,MAA6E,EAC7E,2BAA2B,CAAC,YAAY,CAAC,CACzC,CAAC;YACF,OAAO,GAAiC,CAAC;QAC1C,CAAC;QAED,aAAa;YACZ,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC;QACjC,CAAC;QAED,kBAAkB;YACjB,OAAO,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAClD,CAAC;KACD,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidHandle, ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\ttype IIdCompressor,\n\tcreateIdCompressor,\n} from \"@fluidframework/id-compressor/internal\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\n\nimport type { CodecWriteOptions, ICodecOptions } from \"../codec/index.js\";\nimport {\n\ttype RevisionTag,\n\tRevisionTagCodec,\n\tTreeStoredSchemaRepository,\n} from \"../core/index.js\";\nimport {\n\tcreateNodeIdentifierManager,\n\tfieldBatchCodecBuilder,\n\tFieldBatchDecodingContext,\n\tdefaultIncrementalEncodingPolicy,\n\tschemaCodecBuilder,\n\tcombineChunks,\n} from \"../feature-libraries/index.js\";\nimport type {\n\tTreeViewConfiguration,\n\tImplicitFieldSchema,\n\tTreeViewAlpha,\n\tITreeAlpha,\n\tViewableTree,\n\tTreeView,\n\tReadSchema,\n\tVerboseTree,\n\tSimpleTreeSchema,\n} from \"../simple-tree/index.js\";\nimport {\n\ttype JsonCompatibleReadOnly,\n\ttype JsonCompatible,\n\tBreakable,\n\toneFromIterable,\n} from \"../util/index.js\";\n\nimport { initialize, initializerFromChunk } from \"./schematizeTree.js\";\nimport { SchematizingSimpleTreeView } from \"./schematizingTreeView.js\";\nimport {\n\tbuildConfiguredForest,\n\tdefaultSharedTreeOptions,\n\texportSimpleSchema,\n\ttype ForestOptions,\n} from \"./sharedTree.js\";\nimport { createTreeCheckout } from \"./treeCheckout.js\";\n\n/**\n * Options for supplying a telemetry logger to an independent tree view.\n * @remarks\n * Events emitted by the independent tree are tagged with the `independentView` namespace.\n * If no logger is provided, telemetry events are dropped.\n * @alpha @input\n */\nexport interface IndependentViewTelemetryOptions {\n\t/**\n\t * Optional logger for telemetry.\n\t */\n\treadonly logger?: ITelemetryBaseLogger | undefined;\n}\n\n/**\n * {@link independentView} options.\n * @alpha @input\n */\nexport interface IndependentViewOptions\n\textends ForestOptions,\n\t\tPartial<CodecWriteOptions>,\n\t\tIndependentViewTelemetryOptions {\n\t/**\n\t * Optional ID compressor for generating and compressing identifiers.\n\t * If not provided, a new one will be created.\n\t */\n\tidCompressor?: IIdCompressor | undefined;\n}\n\n/**\n * {@link createIndependentTreeAlpha} options.\n * @alpha\n */\nexport type CreateIndependentTreeAlphaOptions = ForestOptions &\n\tIndependentViewTelemetryOptions &\n\t(\n\t\t| (IndependentViewOptions & {\n\t\t\t\t/**\n\t\t\t\t * Optional content for initializing the tree.\n\t\t\t\t * If not provided, the tree will be uninitialized.\n\t\t\t\t */\n\t\t\t\tcontent?: never;\n\t\t  })\n\t\t| (ICodecOptions & {\n\t\t\t\t/**\n\t\t\t\t * Content for initializing the tree.\n\t\t\t\t * The content includes the idCompressor, so idCompressor should not be provided at the top level.\n\t\t\t\t */\n\t\t\t\tcontent: ViewContent;\n\t\t\t\t/**\n\t\t\t\t * Should not be provided when content is specified.\n\t\t\t\t * The idCompressor will be obtained from the content.\n\t\t\t\t */\n\t\t\t\tidCompressor?: never;\n\t\t  })\n\t);\n\n/**\n * Create an uninitialized {@link TreeView} that is not tied to any {@link ITree} instance.\n *\n * @remarks\n * Such a view can never experience collaboration or be persisted to to a Fluid Container.\n *\n * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.\n * @alpha\n */\nexport function independentView<const TSchema extends ImplicitFieldSchema>(\n\tconfig: TreeViewConfiguration<TSchema>,\n\toptions?: IndependentViewOptions,\n): TreeViewAlpha<TSchema> {\n\treturn createIndependentTreeAlpha(options).viewWith(config) as TreeViewAlpha<TSchema>;\n}\n\n/**\n * Create an initialized {@link TreeView} that is not tied to any {@link ITree} instance.\n *\n * @remarks\n * Such a view can never experience collaboration or be persisted to to a Fluid Container.\n *\n * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.\n * @privateRemarks\n * TODO: Providing an API which generates a {@link ViewableTree} extended with export options from {@link ITreeAlpha} and maybe even branching APIs would likely be better that just exposing a {@link TreeViewAlpha}.\n * @alpha\n */\nexport function independentInitializedView<const TSchema extends ImplicitFieldSchema>(\n\tconfig: TreeViewConfiguration<TSchema>,\n\toptions: ForestOptions & ICodecOptions & IndependentViewTelemetryOptions,\n\tcontent: ViewContent,\n): TreeViewAlpha<TSchema> {\n\treturn createIndependentTreeAlpha({ ...options, content }).viewWith(\n\t\tconfig,\n\t) as TreeViewAlpha<TSchema>;\n}\n\n/**\n * Create a {@link ViewableTree} that is not tied to any Fluid runtimes or services.\n *\n * @remarks\n * Such a tree can never experience collaboration or be persisted to to a Fluid Container.\n *\n * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.\n *\n * @example\n * ```typescript\n * const tree = createIndependentTreeBeta();\n *\n * const stagedConfig = new TreeViewConfiguration({\n * \tschema: SchemaFactoryAlpha.types([\n * \t\tSchemaFactory.number,\n * \t\tSchemaFactoryAlpha.staged(SchemaFactory.string),\n * \t]),\n * });\n * const afterConfig = new TreeViewConfigurationAlpha({\n * \tschema: [SchemaFactory.number, SchemaFactory.string],\n * });\n *\n * // Initialize tree\n * {\n * \tconst view = tree.viewWith(stagedConfig);\n * \tview.initialize(1);\n * \tview.dispose();\n * }\n *\n * // Do schema upgrade\n * {\n * \tconst view = tree.viewWith(afterConfig);\n * \tview.upgradeSchema();\n * \tview.root = \"A\";\n * \tview.dispose();\n * }\n *\n * // Can still view tree with staged schema\n * {\n * \tconst view = tree.viewWith(stagedConfig);\n * \tassert.equal(view.root, \"A\");\n * \tview.dispose();\n * }\n * ```\n * @privateRemarks\n * Before stabilizing this as public, consider if we can instead just expose a better way to create regular Fluid service based SharedTrees for tests.\n * Something like https://github.com/microsoft/FluidFramework/pull/25422 might be a better long term stable/public solution.\n * @beta\n */\nexport function createIndependentTreeBeta<const TSchema extends ImplicitFieldSchema>(\n\toptions?: ForestOptions,\n): ViewableTree {\n\treturn createIndependentTreeAlpha<TSchema>(options);\n}\n\n/**\n * Alpha extensions to {@link createIndependentTreeBeta}.\n *\n * @param options - Configuration options for the independent tree.\n * This can be used to create an uninitialized tree, or `content` can be provided to create an initialized tree.\n * If content is provided, the idCompressor is a required part of it: otherwise it is optional and provided at the top level.\n *\n * @privateRemarks\n * TODO: Support more of {@link ITreeAlpha}, including branching APIs to allow for merges.\n * TODO: Better unify this logic with SharedTreeKernel and SharedTreeCore.\n *\n * Before further stabilizing: consider better ways to handle initialized vs uninitialized trees.\n * Perhaps it would be better to not allow initialize here at all, but expose the ability to load compressed tree content and stored schema via ITree or TreeView?\n * If keeping the option here, maybe a separate function of overload would be better? Or maybe flatten ViewContent inline to deduplicate the idCompressor options?\n * @alpha\n */\nexport function createIndependentTreeAlpha<const TSchema extends ImplicitFieldSchema>(\n\toptions?: CreateIndependentTreeAlphaOptions,\n): ViewableTree & Pick<ITreeAlpha, \"exportVerbose\" | \"exportSimpleSchema\"> {\n\tconst logger = createChildLogger({\n\t\tlogger: options?.logger,\n\t\tnamespace: \"independentView\",\n\t});\n\tconst breaker = new Breakable(\"independentView\", logger);\n\tconst idCompressor: IIdCompressor =\n\t\toptions?.idCompressor ?? options?.content?.idCompressor ?? createIdCompressor();\n\tconst mintRevisionTag = (): RevisionTag => idCompressor.generateCompressedId();\n\tconst revisionTagCodec = new RevisionTagCodec(idCompressor);\n\n\t// To ensure the forest is in schema when constructed, start it with an empty schema and set the schema repository content later.\n\tconst schemaRepository = new TreeStoredSchemaRepository();\n\n\tconst forest = buildConfiguredForest(\n\t\tbreaker,\n\t\toptions?.forest ?? defaultSharedTreeOptions.forest,\n\t\tschemaRepository,\n\t\tidCompressor,\n\t\tdefaultIncrementalEncodingPolicy,\n\t);\n\n\tconst checkout = createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, {\n\t\tforest,\n\t\tschema: schemaRepository,\n\t\tcodecOptions: options,\n\t});\n\n\tif (options?.content !== undefined) {\n\t\tconst schemaCodec = schemaCodecBuilder.buildDecoder(options);\n\t\tconst fieldBatchCodec = fieldBatchCodecBuilder.buildDecoder(options);\n\t\tconst newSchema = schemaCodec.decode(options.content.schema);\n\n\t\t// TreeAlpha.exportCompressed encodes this payload in originatorless-safe form\n\t\t// (finalized compressed ids or strings), so summary-style decode is correct.\n\t\tconst context = FieldBatchDecodingContext.forSummary({\n\t\t\tidCompressor,\n\t\t\thealing: undefined,\n\t\t});\n\t\tconst fieldCursors = fieldBatchCodec.decode(\n\t\t\toptions.content.tree as JsonCompatibleReadOnly,\n\t\t\tcontext,\n\t\t);\n\t\tassert(fieldCursors.length === 1, 0xa5b /* must have exactly 1 field in batch */);\n\n\t\tconst fieldCursor = oneFromIterable(fieldCursors);\n\t\tassert(fieldCursor !== undefined, 0xc94 /* expected exactly one field in batch */);\n\n\t\tinitialize(\n\t\t\tcheckout,\n\t\t\tnewSchema,\n\t\t\tinitializerFromChunk(checkout, () =>\n\t\t\t\tcombineChunks(checkout.forest.chunkField(fieldCursor)),\n\t\t\t),\n\t\t);\n\t}\n\n\treturn {\n\t\tviewWith<TRoot extends ImplicitFieldSchema>(\n\t\t\tconfig: TreeViewConfiguration<TRoot>,\n\t\t): TreeView<TRoot> {\n\t\t\tconst out: TreeViewAlpha<TSchema> = new SchematizingSimpleTreeView<TSchema>(\n\t\t\t\tcheckout,\n\t\t\t\tconfig as TreeViewConfiguration as TreeViewConfiguration<ReadSchema<TSchema>>,\n\t\t\t\tcreateNodeIdentifierManager(idCompressor),\n\t\t\t);\n\t\t\treturn out as unknown as TreeView<TRoot>;\n\t\t},\n\n\t\texportVerbose(): VerboseTree | undefined {\n\t\t\treturn checkout.exportVerbose();\n\t\t},\n\n\t\texportSimpleSchema(): SimpleTreeSchema {\n\t\t\treturn exportSimpleSchema(checkout.storedSchema);\n\t\t},\n\t};\n}\n\n/**\n * The portion of SharedTree data typically persisted by the container.\n * Usable with {@link independentInitializedView} to create a {@link TreeView}\n * without loading a container.\n * @alpha\n */\nexport interface ViewContent {\n\t/**\n\t * Compressed tree from {@link (TreeAlpha:interface).exportCompressed}.\n\t * @remarks\n\t * This is an owning reference:\n\t * consumers of this content might modify this data in place (for example when applying edits) to avoid copying.\n\t */\n\treadonly tree: JsonCompatible<IFluidHandle>;\n\t/**\n\t * Persisted schema from {@link extractPersistedSchema}.\n\t */\n\treadonly schema: JsonCompatible;\n\t/**\n\t * IIdCompressor which will be used to decompress any compressed identifiers in `tree`\n\t * as well as for any other identifiers added to the view.\n\t */\n\treadonly idCompressor: IIdCompressor;\n}\n"]}
+{"version":3,"file":"independentView.js","sourceRoot":"","sources":["../../src/shared-tree/independentView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAEN,kBAAkB,GAClB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAG7E,OAAO,EAEN,gBAAgB,EAChB,0BAA0B,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,2BAA2B,EAC3B,sBAAsB,EACtB,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,aAAa,GACb,MAAM,+BAA+B,CAAC;AAavC,OAAO,EAGN,SAAS,EACT,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EACN,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,GAElB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AA2DvD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,8BAA8B,CAC7C,MAAsC,EACtC,OAAgC;IAEhC,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAA2B,CAAC;AACvF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC9B,MAAsC,EACtC,OAAgC;IAEhC,OAAO,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,yBAAyB,CACxC,MAAsC,EACtC,OAAuB;IAEvB,OAAO,yBAAyB,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAA0B,CAAC;AACrF,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,0BAA0B,CACzC,MAAsC,EACtC,OAAwE,EACxE,OAAoB;IAEpB,OAAO,0BAA0B,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,CAClE,MAAM,CACoB,CAAC;AAC7B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,yBAAyB,CACxC,OAAuB;IAEvB,OAAO,0BAA0B,CAAU,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,0BAA0B,CACzC,OAA2C;IAE3C,MAAM,MAAM,GAAG,iBAAiB,CAAC;QAChC,MAAM,EAAE,OAAO,EAAE,MAAM;QACvB,SAAS,EAAE,iBAAiB;KAC5B,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACzD,MAAM,YAAY,GACjB,OAAO,EAAE,YAAY,IAAI,OAAO,EAAE,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,CAAC;IACjF,MAAM,eAAe,GAAG,GAAgB,EAAE,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;IAC/E,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAE5D,iIAAiI;IACjI,MAAM,gBAAgB,GAAG,IAAI,0BAA0B,EAAE,CAAC;IAE1D,MAAM,MAAM,GAAG,qBAAqB,CACnC,OAAO,EACP,OAAO,EAAE,MAAM,IAAI,wBAAwB,CAAC,MAAM,EAClD,gBAAgB,EAChB,YAAY,EACZ,gCAAgC,CAChC,CAAC;IAEF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE;QACpF,MAAM;QACN,MAAM,EAAE,gBAAgB;QACxB,YAAY,EAAE,OAAO;KACrB,CAAC,CAAC;IAEH,IAAI,OAAO,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,kBAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,eAAe,GAAG,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE7D,8EAA8E;QAC9E,6EAA6E;QAC7E,MAAM,OAAO,GAAG,yBAAyB,CAAC,UAAU,CAAC;YACpD,YAAY;YACZ,OAAO,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CAC1C,OAAO,CAAC,OAAO,CAAC,IAA8B,EAC9C,OAAO,CACP,CAAC;QACF,MAAM,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAElF,MAAM,WAAW,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAEnF,UAAU,CACT,QAAQ,EACR,SAAS,EACT,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE,CACnC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CACtD,CACD,CAAC;IACH,CAAC;IAED,OAAO;QACN,QAAQ,CACP,MAAoC;YAEpC,MAAM,GAAG,GAA2B,IAAI,0BAA0B,CACjE,QAAQ,EACR,MAA6E,EAC7E,2BAA2B,CAAC,YAAY,CAAC,CACzC,CAAC;YACF,OAAO,GAAiC,CAAC;QAC1C,CAAC;QAED,aAAa;YACZ,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC;QACjC,CAAC;QAED,kBAAkB;YACjB,OAAO,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAClD,CAAC;KACD,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IFluidHandle, ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\ttype IIdCompressor,\n\tcreateIdCompressor,\n} from \"@fluidframework/id-compressor/internal\";\nimport { createChildLogger } from \"@fluidframework/telemetry-utils/internal\";\n\nimport type { CodecWriteOptions, ICodecOptions } from \"../codec/index.js\";\nimport {\n\ttype RevisionTag,\n\tRevisionTagCodec,\n\tTreeStoredSchemaRepository,\n} from \"../core/index.js\";\nimport {\n\tcreateNodeIdentifierManager,\n\tfieldBatchCodecBuilder,\n\tFieldBatchDecodingContext,\n\tdefaultIncrementalEncodingPolicy,\n\tschemaCodecBuilder,\n\tcombineChunks,\n} from \"../feature-libraries/index.js\";\nimport type {\n\tTreeViewConfiguration,\n\tImplicitFieldSchema,\n\tTreeViewAlpha,\n\tTreeViewBeta,\n\tITreeAlpha,\n\tViewableTree,\n\tTreeView,\n\tReadSchema,\n\tVerboseTree,\n\tSimpleTreeSchema,\n} from \"../simple-tree/index.js\";\nimport {\n\ttype JsonCompatibleReadOnly,\n\ttype JsonCompatible,\n\tBreakable,\n\toneFromIterable,\n} from \"../util/index.js\";\n\nimport { initialize, initializerFromChunk } from \"./schematizeTree.js\";\nimport { SchematizingSimpleTreeView } from \"./schematizingTreeView.js\";\nimport {\n\tbuildConfiguredForest,\n\tdefaultSharedTreeOptions,\n\texportSimpleSchema,\n\ttype ForestOptions,\n} from \"./sharedTree.js\";\nimport { createTreeCheckout } from \"./treeCheckout.js\";\n\n/**\n * Options for supplying a telemetry logger to an independent tree view.\n * @remarks\n * Events emitted by the independent tree are tagged with the `independentView` namespace.\n * If no logger is provided, telemetry events are dropped.\n * @alpha @input\n */\nexport interface IndependentViewTelemetryOptions {\n\t/**\n\t * Optional logger for telemetry.\n\t */\n\treadonly logger?: ITelemetryBaseLogger | undefined;\n}\n\n/**\n * {@link createIndependentTreeViewAlpha} options.\n * @alpha @input\n */\nexport interface IndependentViewOptions\n\textends ForestOptions,\n\t\tPartial<CodecWriteOptions>,\n\t\tIndependentViewTelemetryOptions {\n\t/**\n\t * Optional ID compressor for generating and compressing identifiers.\n\t * If not provided, a new one will be created.\n\t */\n\tidCompressor?: IIdCompressor | undefined;\n}\n\n/**\n * {@link createIndependentTreeAlpha} options.\n * @alpha\n */\nexport type CreateIndependentTreeAlphaOptions = ForestOptions &\n\tIndependentViewTelemetryOptions &\n\t(\n\t\t| (IndependentViewOptions & {\n\t\t\t\t/**\n\t\t\t\t * Optional content for initializing the tree.\n\t\t\t\t * If not provided, the tree will be uninitialized.\n\t\t\t\t */\n\t\t\t\tcontent?: never;\n\t\t  })\n\t\t| (ICodecOptions & {\n\t\t\t\t/**\n\t\t\t\t * Content for initializing the tree.\n\t\t\t\t * The content includes the idCompressor, so idCompressor should not be provided at the top level.\n\t\t\t\t */\n\t\t\t\tcontent: ViewContent;\n\t\t\t\t/**\n\t\t\t\t * Should not be provided when content is specified.\n\t\t\t\t * The idCompressor will be obtained from the content.\n\t\t\t\t */\n\t\t\t\tidCompressor?: never;\n\t\t  })\n\t);\n\n/**\n * Create an uninitialized {@link TreeView} that is not tied to any {@link ITree} instance.\n *\n * @remarks\n * Such a view can never experience collaboration or be persisted to a Fluid Container.\n *\n * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.\n *\n * @param config - The configuration for the tree view.\n * @param options - Options for the independent tree view.\n * @returns An uninitialized, non-collaborative tree view.\n * @alpha\n */\nexport function createIndependentTreeViewAlpha<const TSchema extends ImplicitFieldSchema>(\n\tconfig: TreeViewConfiguration<TSchema>,\n\toptions?: IndependentViewOptions,\n): TreeViewAlpha<TSchema> {\n\treturn createIndependentTreeAlpha(options).viewWith(config) as TreeViewAlpha<TSchema>;\n}\n\n/**\n * {@inheritDoc createIndependentTreeViewAlpha}\n * @deprecated Use {@link createIndependentTreeViewAlpha} instead.\n * @alpha\n */\nexport function independentView<const TSchema extends ImplicitFieldSchema>(\n\tconfig: TreeViewConfiguration<TSchema>,\n\toptions?: IndependentViewOptions,\n): TreeViewAlpha<TSchema> {\n\treturn createIndependentTreeViewAlpha(config, options);\n}\n\n/**\n * Creates an uninitialized tree view that is not tied to any {@link ITree} instance.\n *\n * @remarks\n * Such a view can never experience collaboration or be persisted to a Fluid Container.\n *\n * This can be useful for testing and for use cases such as working on local files instead of documents stored in a Fluid service.\n *\n * @param config - The configuration for the tree view.\n * @param options - Options for the independent tree's forest.\n * @returns An uninitialized, non-collaborative tree view.\n * @beta\n */\nexport function createIndependentTreeView<const TSchema extends ImplicitFieldSchema>(\n\tconfig: TreeViewConfiguration<TSchema>,\n\toptions?: ForestOptions,\n): TreeViewBeta<TSchema> {\n\treturn createIndependentTreeBeta(options).viewWith(config) as TreeViewBeta<TSchema>;\n}\n\n/**\n * Create an initialized {@link TreeView} that is not tied to any {@link ITree} instance.\n *\n * @remarks\n * Such a view can never experience collaboration or be persisted to to a Fluid Container.\n *\n * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.\n * @privateRemarks\n * TODO: Providing an API which generates a {@link ViewableTree} extended with export options from {@link ITreeAlpha} and maybe even branching APIs would likely be better that just exposing a {@link TreeViewAlpha}.\n * @alpha\n */\nexport function independentInitializedView<const TSchema extends ImplicitFieldSchema>(\n\tconfig: TreeViewConfiguration<TSchema>,\n\toptions: ForestOptions & ICodecOptions & IndependentViewTelemetryOptions,\n\tcontent: ViewContent,\n): TreeViewAlpha<TSchema> {\n\treturn createIndependentTreeAlpha({ ...options, content }).viewWith(\n\t\tconfig,\n\t) as TreeViewAlpha<TSchema>;\n}\n\n/**\n * Create a {@link ViewableTree} that is not tied to any Fluid runtimes or services.\n *\n * @remarks\n * Such a tree can never experience collaboration or be persisted to to a Fluid Container.\n *\n * This can be useful for testing, as well as use-cases like working on local files instead of documents stored in some Fluid service.\n *\n * @example\n * ```typescript\n * const tree = createIndependentTreeBeta();\n *\n * const stagedConfig = new TreeViewConfiguration({\n * \tschema: SchemaFactoryAlpha.types([\n * \t\tSchemaFactory.number,\n * \t\tSchemaFactoryAlpha.staged(SchemaFactory.string),\n * \t]),\n * });\n * const afterConfig = new TreeViewConfigurationAlpha({\n * \tschema: [SchemaFactory.number, SchemaFactory.string],\n * });\n *\n * // Initialize tree\n * {\n * \tconst view = tree.viewWith(stagedConfig);\n * \tview.initialize(1);\n * \tview.dispose();\n * }\n *\n * // Do schema upgrade\n * {\n * \tconst view = tree.viewWith(afterConfig);\n * \tview.upgradeSchema();\n * \tview.root = \"A\";\n * \tview.dispose();\n * }\n *\n * // Can still view tree with staged schema\n * {\n * \tconst view = tree.viewWith(stagedConfig);\n * \tassert.equal(view.root, \"A\");\n * \tview.dispose();\n * }\n * ```\n * @privateRemarks\n * Before stabilizing this as public, consider if we can instead just expose a better way to create regular Fluid service based SharedTrees for tests.\n * Something like https://github.com/microsoft/FluidFramework/pull/25422 might be a better long term stable/public solution.\n * @beta\n */\nexport function createIndependentTreeBeta<const TSchema extends ImplicitFieldSchema>(\n\toptions?: ForestOptions,\n): ViewableTree {\n\treturn createIndependentTreeAlpha<TSchema>(options);\n}\n\n/**\n * Alpha extensions to {@link createIndependentTreeBeta}.\n *\n * @param options - Configuration options for the independent tree.\n * This can be used to create an uninitialized tree, or `content` can be provided to create an initialized tree.\n * If content is provided, the idCompressor is a required part of it: otherwise it is optional and provided at the top level.\n *\n * @privateRemarks\n * TODO: Support more of {@link ITreeAlpha}, including branching APIs to allow for merges.\n * TODO: Better unify this logic with SharedTreeKernel and SharedTreeCore.\n *\n * Before further stabilizing: consider better ways to handle initialized vs uninitialized trees.\n * Perhaps it would be better to not allow initialize here at all, but expose the ability to load compressed tree content and stored schema via ITree or TreeView?\n * If keeping the option here, maybe a separate function of overload would be better? Or maybe flatten ViewContent inline to deduplicate the idCompressor options?\n * @alpha\n */\nexport function createIndependentTreeAlpha<const TSchema extends ImplicitFieldSchema>(\n\toptions?: CreateIndependentTreeAlphaOptions,\n): ViewableTree & Pick<ITreeAlpha, \"exportVerbose\" | \"exportSimpleSchema\"> {\n\tconst logger = createChildLogger({\n\t\tlogger: options?.logger,\n\t\tnamespace: \"independentView\",\n\t});\n\tconst breaker = new Breakable(\"independentView\", logger);\n\tconst idCompressor: IIdCompressor =\n\t\toptions?.idCompressor ?? options?.content?.idCompressor ?? createIdCompressor();\n\tconst mintRevisionTag = (): RevisionTag => idCompressor.generateCompressedId();\n\tconst revisionTagCodec = new RevisionTagCodec(idCompressor);\n\n\t// To ensure the forest is in schema when constructed, start it with an empty schema and set the schema repository content later.\n\tconst schemaRepository = new TreeStoredSchemaRepository();\n\n\tconst forest = buildConfiguredForest(\n\t\tbreaker,\n\t\toptions?.forest ?? defaultSharedTreeOptions.forest,\n\t\tschemaRepository,\n\t\tidCompressor,\n\t\tdefaultIncrementalEncodingPolicy,\n\t);\n\n\tconst checkout = createTreeCheckout(idCompressor, mintRevisionTag, revisionTagCodec, {\n\t\tforest,\n\t\tschema: schemaRepository,\n\t\tcodecOptions: options,\n\t});\n\n\tif (options?.content !== undefined) {\n\t\tconst schemaCodec = schemaCodecBuilder.buildDecoder(options);\n\t\tconst fieldBatchCodec = fieldBatchCodecBuilder.buildDecoder(options);\n\t\tconst newSchema = schemaCodec.decode(options.content.schema);\n\n\t\t// TreeAlpha.exportCompressed encodes this payload in originatorless-safe form\n\t\t// (finalized compressed ids or strings), so summary-style decode is correct.\n\t\tconst context = FieldBatchDecodingContext.forSummary({\n\t\t\tidCompressor,\n\t\t\thealing: undefined,\n\t\t});\n\t\tconst fieldCursors = fieldBatchCodec.decode(\n\t\t\toptions.content.tree as JsonCompatibleReadOnly,\n\t\t\tcontext,\n\t\t);\n\t\tassert(fieldCursors.length === 1, 0xa5b /* must have exactly 1 field in batch */);\n\n\t\tconst fieldCursor = oneFromIterable(fieldCursors);\n\t\tassert(fieldCursor !== undefined, 0xc94 /* expected exactly one field in batch */);\n\n\t\tinitialize(\n\t\t\tcheckout,\n\t\t\tnewSchema,\n\t\t\tinitializerFromChunk(checkout, () =>\n\t\t\t\tcombineChunks(checkout.forest.chunkField(fieldCursor)),\n\t\t\t),\n\t\t);\n\t}\n\n\treturn {\n\t\tviewWith<TRoot extends ImplicitFieldSchema>(\n\t\t\tconfig: TreeViewConfiguration<TRoot>,\n\t\t): TreeView<TRoot> {\n\t\t\tconst out: TreeViewAlpha<TSchema> = new SchematizingSimpleTreeView<TSchema>(\n\t\t\t\tcheckout,\n\t\t\t\tconfig as TreeViewConfiguration as TreeViewConfiguration<ReadSchema<TSchema>>,\n\t\t\t\tcreateNodeIdentifierManager(idCompressor),\n\t\t\t);\n\t\t\treturn out as unknown as TreeView<TRoot>;\n\t\t},\n\n\t\texportVerbose(): VerboseTree | undefined {\n\t\t\treturn checkout.exportVerbose();\n\t\t},\n\n\t\texportSimpleSchema(): SimpleTreeSchema {\n\t\t\treturn exportSimpleSchema(checkout.storedSchema);\n\t\t},\n\t};\n}\n\n/**\n * The portion of SharedTree data typically persisted by the container.\n * Usable with {@link independentInitializedView} to create a {@link TreeView}\n * without loading a container.\n * @alpha\n */\nexport interface ViewContent {\n\t/**\n\t * Compressed tree from {@link (TreeAlpha:interface).exportCompressed}.\n\t * @remarks\n\t * This is an owning reference:\n\t * consumers of this content might modify this data in place (for example when applying edits) to avoid copying.\n\t */\n\treadonly tree: JsonCompatible<IFluidHandle>;\n\t/**\n\t * Persisted schema from {@link extractPersistedSchema}.\n\t */\n\treadonly schema: JsonCompatible;\n\t/**\n\t * IIdCompressor which will be used to decompress any compressed identifiers in `tree`\n\t * as well as for any other identifiers added to the view.\n\t */\n\treadonly idCompressor: IIdCompressor;\n}\n"]}

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

@@ -10,8 +10,9 @@ export type { ISharedTreeEditor, ISchemaEditor, SharedTreeEditBuilder, } from ".
 export { minimize } from "./transactionMinimize.js";
 export { Tree } from "./tree.js";
 export type { RunTransaction } from "./tree.js";
+export { TreeBeta } from "./treeBeta.js";
 export { TreeAlpha, type TreeIdentifierUtils, type ObservationResults, } from "./treeAlpha.js";
-export { independentInitializedView, type ViewContent, independentView, type IndependentViewOptions, type IndependentViewTelemetryOptions, createIndependentTreeBeta, createIndependentTreeAlpha, type CreateIndependentTreeAlphaOptions, } from "./independentView.js";
+export { independentInitializedView, type ViewContent, createIndependentTreeViewAlpha, independentView, type IndependentViewOptions, type IndependentViewTelemetryOptions, createIndependentTreeAlpha, createIndependentTreeBeta, createIndependentTreeView, type CreateIndependentTreeAlphaOptions, } from "./independentView.js";
 export type { SharedTreeChange } from "./sharedTreeChangeTypes.js";
 export { getCodecTreeForChangeFormat, type SharedTreeChangeFormatVersion, } from "./sharedTreeChangeCodecs.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,gBAAgB,EAChB,KAAK,UAAU,EACf,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,qBAAqB,EACrB,wBAAwB,EACxB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAClB,KAAK,oBAAoB,EACzB,uBAAuB,EACvB,+BAA+B,GAC/B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,cAAc,GACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEvE,YAAY,EACX,iBAAiB,EACjB,aAAa,EACb,qBAAqB,GACrB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EACN,SAAS,EACT,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,0BAA0B,EAC1B,KAAK,WAAW,EAChB,eAAe,EACf,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,yBAAyB,EACzB,0BAA0B,EAC1B,KAAK,iCAAiC,GACtC,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EACN,2BAA2B,EAC3B,KAAK,6BAA6B,GAClC,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,gBAAgB,EAChB,KAAK,UAAU,EACf,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,qBAAqB,EACrB,wBAAwB,EACxB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAClB,KAAK,oBAAoB,EACzB,uBAAuB,EACvB,+BAA+B,GAC/B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,cAAc,GACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEvE,YAAY,EACX,iBAAiB,EACjB,aAAa,EACb,qBAAqB,GACrB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EACN,SAAS,EACT,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACvB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,0BAA0B,EAC1B,KAAK,WAAW,EAChB,8BAA8B,EAC9B,eAAe,EACf,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,EACzB,KAAK,iCAAiC,GACtC,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EACN,2BAA2B,EAC3B,KAAK,6BAA6B,GAClC,MAAM,6BAA6B,CAAC"}

package/lib/shared-tree/index.js

@@ -8,7 +8,8 @@ export { SchematizingSimpleTreeView } from "./schematizingTreeView.js";
 export { initialize, initializerFromChunk } from "./schematizeTree.js";
 export { minimize } from "./transactionMinimize.js";
 export { Tree } from "./tree.js";
+export { TreeBeta } from "./treeBeta.js";
 export { TreeAlpha, } from "./treeAlpha.js";
-export { independentInitializedView, independentView, createIndependentTreeBeta, createIndependentTreeAlpha, } from "./independentView.js";
+export { independentInitializedView, createIndependentTreeViewAlpha, independentView, createIndependentTreeAlpha, createIndependentTreeBeta, createIndependentTreeView, } from "./independentView.js";
 export { getCodecTreeForChangeFormat, } from "./sharedTreeChangeCodecs.js";
 //# sourceMappingURL=index.js.map

package/lib/shared-tree/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAKN,gBAAgB,EAIhB,qBAAqB,EACrB,wBAAwB,EAGxB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAElB,uBAAuB,EACvB,+BAA+B,GAC/B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,kBAAkB,EAClB,YAAY,GAIZ,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAQvE,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC,OAAO,EACN,SAAS,GAGT,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,0BAA0B,EAE1B,eAAe,EAGf,yBAAyB,EACzB,0BAA0B,GAE1B,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EACN,2BAA2B,GAE3B,MAAM,6BAA6B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\ttype ITreePrivate,\n\ttype SharedTreeOptionsInternal,\n\ttype SharedTreeOptions,\n\ttype SharedTreeOptionsBeta,\n\tSharedTreeKernel,\n\ttype ForestType,\n\ttype SharedTreeContentSnapshot,\n\ttype SharedTreeFormatOptions,\n\tbuildConfiguredForest,\n\tdefaultSharedTreeOptions,\n\ttype ForestOptions,\n\ttype ITreeInternal,\n\tForestTypeOptimized,\n\tForestTypeExpensiveDebug,\n\tForestTypeReference,\n\texportSimpleSchema,\n\ttype SharedTreeKernelView,\n\tpersistedToSimpleSchema,\n\tgetCodecTreeForSharedTreeFormat,\n} from \"./sharedTree.js\";\n\nexport {\n\tcreateTreeCheckout,\n\tTreeCheckout,\n\ttype ITreeCheckout,\n\ttype CheckoutEvents,\n\ttype TreeTransactor,\n} from \"./treeCheckout.js\";\n\nexport { SchematizingSimpleTreeView } from \"./schematizingTreeView.js\";\n\nexport { initialize, initializerFromChunk } from \"./schematizeTree.js\";\n\nexport type {\n\tISharedTreeEditor,\n\tISchemaEditor,\n\tSharedTreeEditBuilder,\n} from \"./sharedTreeEditBuilder.js\";\n\nexport { minimize } from \"./transactionMinimize.js\";\n\nexport { Tree } from \"./tree.js\";\nexport type { RunTransaction } from \"./tree.js\";\n\nexport {\n\tTreeAlpha,\n\ttype TreeIdentifierUtils,\n\ttype ObservationResults,\n} from \"./treeAlpha.js\";\n\nexport {\n\tindependentInitializedView,\n\ttype ViewContent,\n\tindependentView,\n\ttype IndependentViewOptions,\n\ttype IndependentViewTelemetryOptions,\n\tcreateIndependentTreeBeta,\n\tcreateIndependentTreeAlpha,\n\ttype CreateIndependentTreeAlphaOptions,\n} from \"./independentView.js\";\n\nexport type { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\n\nexport {\n\tgetCodecTreeForChangeFormat,\n\ttype SharedTreeChangeFormatVersion,\n} from \"./sharedTreeChangeCodecs.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAKN,gBAAgB,EAIhB,qBAAqB,EACrB,wBAAwB,EAGxB,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,kBAAkB,EAElB,uBAAuB,EACvB,+BAA+B,GAC/B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,kBAAkB,EAClB,YAAY,GAIZ,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAQvE,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EACN,SAAS,GAGT,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,0BAA0B,EAE1B,8BAA8B,EAC9B,eAAe,EAGf,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,GAEzB,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EACN,2BAA2B,GAE3B,MAAM,6BAA6B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\ttype ITreePrivate,\n\ttype SharedTreeOptionsInternal,\n\ttype SharedTreeOptions,\n\ttype SharedTreeOptionsBeta,\n\tSharedTreeKernel,\n\ttype ForestType,\n\ttype SharedTreeContentSnapshot,\n\ttype SharedTreeFormatOptions,\n\tbuildConfiguredForest,\n\tdefaultSharedTreeOptions,\n\ttype ForestOptions,\n\ttype ITreeInternal,\n\tForestTypeOptimized,\n\tForestTypeExpensiveDebug,\n\tForestTypeReference,\n\texportSimpleSchema,\n\ttype SharedTreeKernelView,\n\tpersistedToSimpleSchema,\n\tgetCodecTreeForSharedTreeFormat,\n} from \"./sharedTree.js\";\n\nexport {\n\tcreateTreeCheckout,\n\tTreeCheckout,\n\ttype ITreeCheckout,\n\ttype CheckoutEvents,\n\ttype TreeTransactor,\n} from \"./treeCheckout.js\";\n\nexport { SchematizingSimpleTreeView } from \"./schematizingTreeView.js\";\n\nexport { initialize, initializerFromChunk } from \"./schematizeTree.js\";\n\nexport type {\n\tISharedTreeEditor,\n\tISchemaEditor,\n\tSharedTreeEditBuilder,\n} from \"./sharedTreeEditBuilder.js\";\n\nexport { minimize } from \"./transactionMinimize.js\";\n\nexport { Tree } from \"./tree.js\";\nexport type { RunTransaction } from \"./tree.js\";\n\nexport { TreeBeta } from \"./treeBeta.js\";\n\nexport {\n\tTreeAlpha,\n\ttype TreeIdentifierUtils,\n\ttype ObservationResults,\n} from \"./treeAlpha.js\";\n\nexport {\n\tindependentInitializedView,\n\ttype ViewContent,\n\tcreateIndependentTreeViewAlpha,\n\tindependentView,\n\ttype IndependentViewOptions,\n\ttype IndependentViewTelemetryOptions,\n\tcreateIndependentTreeAlpha,\n\tcreateIndependentTreeBeta,\n\tcreateIndependentTreeView,\n\ttype CreateIndependentTreeAlphaOptions,\n} from \"./independentView.js\";\n\nexport type { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\n\nexport {\n\tgetCodecTreeForChangeFormat,\n\ttype SharedTreeChangeFormatVersion,\n} from \"./sharedTreeChangeCodecs.js\";\n"]}

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

@@ -5,14 +5,14 @@
 import type { HasListeners, IEmitter, Listenable } from "@fluidframework/core-interfaces/internal";
 import { type RevertToOptionsAlpha } from "../core/index.js";
 import { type NodeIdentifierManager, Context } from "../feature-libraries/index.js";
-import { type ImplicitFieldSchema, type SchemaCompatibilityStatus, type TreeView, type TreeViewEvents, type TreeViewConfiguration, type TreeViewAlpha, type InsertableField, type ReadableField, type ReadSchema, type UnsafeUnknownSchema, type TreeBranchEvents, type VoidTransactionCallbackStatusAlpha, type TransactionCallbackStatusAlpha, type TransactionVoidResult, type TransactionValueResult, type RunTransactionParamsAlpha, type TreeBranchHistory, type UntypedTreeViewAlpha } from "../simple-tree/index.js";
+import { type ImplicitFieldSchema, type SchemaCompatibilityStatusBeta, type TreeContextAlpha, type TreeViewEvents, type TreeViewConfiguration, type TreeViewAlpha, type InsertableField, type ReadableField, type ReadSchema, type UnsafeUnknownSchema, type TreeBranchEvents, type VoidTransactionCallbackStatusAlpha, type TransactionCallbackStatusAlpha, type TransactionVoidResult, type TransactionValueResult, type RunTransactionParamsAlpha, type TreeBranchHistory, type UntypedTreeViewAlpha, type SchemaUpgrade, type StagedUpgradeStatus } from "../simple-tree/index.js";
 import { type Breakable, type JsonCompatibleReadOnly, type WithBreakable } from "../util/index.js";
 import type { TreeCheckout } from "./treeCheckout.js";
 /**
  * Creating multiple tree views from the same checkout is not supported. This slot is used to detect if one already
  * exists and error if creating a second.
  */
-export declare const ViewSlot: import("../core/index.js").AnchorSlot<TreeView<ImplicitFieldSchema>>;
+export declare const ViewSlot: import("../core/index.js").AnchorSlot<TreeContextAlpha>;
 /**
  * Implementation of TreeView wrapping a FlexTreeView.
  */
@@ -28,9 +28,14 @@ export declare class SchematizingSimpleTreeView<in out TRootSchema extends Impli
      */
     private flexTreeContext;
     /**
-     * Undefined iff uninitialized or disposed.
+     * Undefined if and only if uninitialized or disposed.
      */
     private currentCompatibility;
+    /**
+     * Cached map of upgrade statuses, computed alongside compatibility.
+     * @remarks Undefined if and only if uninitialized or disposed.
+     */
+    private currentEnabledUpgrades;
     readonly events: Listenable<TreeViewEvents & TreeBranchEvents> & IEmitter<TreeViewEvents & TreeBranchEvents> & HasListeners<TreeViewEvents & TreeBranchEvents>;
     /**
      * The schema for this view, captured at construction time for compatibility checking.
@@ -70,6 +75,8 @@ export declare class SchematizingSimpleTreeView<in out TRootSchema extends Impli
     get schema(): ReadSchema<TRootSchema>;
     initialize(content: InsertableField<TRootSchema>): void;
     upgradeSchema(): void;
+    isStagedUpgradeEnabled(upgrade: SchemaUpgrade): StagedUpgradeStatus;
+    private get effectiveUpgradePolicy();
     /**
      * Gets the flex-tree context. Throws when disposed or out of schema.
      */
@@ -92,10 +99,13 @@ export declare class SchematizingSimpleTreeView<in out TRootSchema extends Impli
      * If implicit initialization (or some other edit) is desired, it should be done outside of this method.
      */
     private update;
+    /**
+     * Computes the current schema compatibility status and updates the cached enabled upgrades.
+     */
     private computeCompatibility;
     private runSchemaEdit;
     private disposeFlexView;
-    get compatibility(): SchemaCompatibilityStatus;
+    get compatibility(): SchemaCompatibilityStatusBeta;
     dispose(): void;
     private get flexRoot();
     get root(): ReadableField<TRootSchema>;

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

@@ -1 +1 @@
-{"version":3,"file":"schematizingTreeView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizingTreeView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACX,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,MAAM,0CAA0C,CAAC;AAIlD,OAAO,EAA4B,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACvF,OAAO,EACN,KAAK,qBAAqB,EAG1B,OAAO,EAOP,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACN,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,QAAQ,EACb,KAAK,cAAc,EAOnB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,kCAAkC,EACvC,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAW9B,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAEzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,SAAS,EAGd,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,QAAQ,sEAA8C,CAAC;AAEpE;;GAEG;AACH,qBACa,0BAA0B,CACtC,EAAE,CAAC,GAAG,CAAC,WAAW,SAAS,mBAAmB,GAAG,mBAAmB,CACnE,YAAW,aAAa,CAAC,WAAW,CAAC,EAAE,aAAa;aAsDpC,QAAQ,EAAE,YAAY;aACtB,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACtD,cAAc,EAAE,qBAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAvD5B;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAsB;IAE7C;;OAEG;IACH,OAAO,CAAC,oBAAoB,CAAwC;IACpE,SAAgB,MAAM,EAAE,UAAU,CAAC,cAAc,GAAG,gBAAgB,CAAC,GACpE,QAAQ,CAAC,cAAc,GAAG,gBAAgB,CAAC,GAC3C,YAAY,CAAC,cAAc,GAAG,gBAAgB,CAAC,CAAmB;IAEnE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA4B;IAEhE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAAyB;IAEzE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAyB;IAEtD,QAAQ,UAAS;IACxB;;;;;OAKG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAC,CAAa;IAEtC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAc;IAC9C,SAAgB,OAAO,EAAE,SAAS,CAAC;gBAGlB,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EACtD,cAAc,EAAE,qBAAqB,EACpC,SAAS,CAAC,SAAQ,IAAI,aAAA;IAuCjC,QAAQ,IAAI,IAAI,IAAI,oBAAoB;IAIxC,MAAM,IAAI,IAAI,IAAI,oBAAoB;IAItC,WAAW,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIjD,aAAa,CAAC,OAAO,SAAS,mBAAmB,EACvD,MAAM,EAAE,OAAO,GACb,IAAI,IAAI,aAAa,CAAC,OAAO,CAAC;IAIjC,IAAW,MAAM,IAAI,UAAU,CAAC,WAAW,CAAC,CAE3C;IAEM,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,IAAI;IAgEvD,aAAa,IAAI,IAAI;IAkB5B;;OAEG;IACI,kBAAkB,IAAI,OAAO;IAM7B,cAAc,CAAC,aAAa,EAAE,aAAa,EACjD,WAAW,EAAE,MAAM,8BAA8B,CAAC,aAAa,EAAE,aAAa,CAAC,EAC/E,MAAM,CAAC,EAAE,yBAAyB,GAChC,sBAAsB,CAAC,aAAa,EAAE,aAAa,CAAC;IAChD,cAAc,CACpB,WAAW,EAAE,MAAM,kCAAkC,GAAG,IAAI,EAC5D,MAAM,CAAC,EAAE,yBAAyB,GAChC,qBAAqB;IAYjB,mBAAmB,CAAC,aAAa,EAAE,aAAa,EACtD,WAAW,EAAE,MAAM,OAAO,CAAC,8BAA8B,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,EACxF,MAAM,CAAC,EAAE,yBAAyB,GAChC,OAAO,CAAC,sBAAsB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IACzD,mBAAmB,CACzB,WAAW,EAAE,MAAM,OAAO,CAAC,kCAAkC,GAAG,IAAI,CAAC,EACrE,MAAM,CAAC,EAAE,yBAAyB,GAChC,OAAO,CAAC,qBAAqB,CAAC;IA0BjC,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,YAAY;IAIpB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM;IA2Ed,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,eAAe;IAkBvB,IAAW,aAAa,IAAI,yBAAyB,CAKpD;IAEM,OAAO,IAAI,IAAI;IAetB,OAAO,KAAK,QAAQ,GAenB;IAED,IAAW,IAAI,IAAI,aAAa,CAAC,WAAW,CAAC,CAE5C;IAED,IAAW,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,WAAW,CAAC,EAcpD;IAIM,IAAI,IAAI,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,GACtD,0BAA0B,CAAC,WAAW,CAAC;IAIjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIhC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI;IAIhE,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,aAAa,UAAO,GAAG,IAAI;IAIhE,UAAU,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAI/C,kBAAkB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO;IAI1D,6BAA6B,CACnC,OAAO,EAAE,oBAAoB,GAC3B,sBAAsB,GAAG,SAAS;IAMrC,IAAW,aAAa,IAAI,iBAAiB,CAE5C;CACD"}
+{"version":3,"file":"schematizingTreeView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizingTreeView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACX,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,MAAM,0CAA0C,CAAC;AAIlD,OAAO,EAA4B,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACvF,OAAO,EACN,KAAK,qBAAqB,EAG1B,OAAO,EAOP,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACN,KAAK,mBAAmB,EACxB,KAAK,6BAA6B,EAClC,KAAK,gBAAgB,EACrB,KAAK,cAAc,EAOnB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,kCAAkC,EACvC,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAW9B,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAEzB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,KAAK,SAAS,EAGd,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,QAAQ,yDAAiC,CAAC;AAuBvD;;GAEG;AACH,qBACa,0BAA0B,CACtC,EAAE,CAAC,GAAG,CAAC,WAAW,SAAS,mBAAmB,GAAG,mBAAmB,CACnE,YAAW,aAAa,CAAC,WAAW,CAAC,EAAE,aAAa;aA2DpC,QAAQ,EAAE,YAAY;aACtB,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACtD,cAAc,EAAE,qBAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IA5D5B;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAsB;IAE7C;;OAEG;IACH,OAAO,CAAC,oBAAoB,CAA4C;IACxE;;;OAGG;IACH,OAAO,CAAC,sBAAsB,CAA8D;IAC5F,SAAgB,MAAM,EAAE,UAAU,CAAC,cAAc,GAAG,gBAAgB,CAAC,GACpE,QAAQ,CAAC,cAAc,GAAG,gBAAgB,CAAC,GAC3C,YAAY,CAAC,cAAc,GAAG,gBAAgB,CAAC,CAAmB;IAEnE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA4B;IAEhE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAAyB;IAEzE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAyB;IAEtD,QAAQ,UAAS;IACxB;;;;;OAKG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAC,CAAa;IAEtC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAc;IAC9C,SAAgB,OAAO,EAAE,SAAS,CAAC;gBAGlB,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EACtD,cAAc,EAAE,qBAAqB,EACpC,SAAS,CAAC,GAAE,MAAM,IAAI,aAAA;IAuCjC,QAAQ,IAAI,IAAI,IAAI,oBAAoB;IAIxC,MAAM,IAAI,IAAI,IAAI,oBAAoB;IAItC,WAAW,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIjD,aAAa,CAAC,OAAO,SAAS,mBAAmB,EACvD,MAAM,EAAE,OAAO,GACb,IAAI,IAAI,aAAa,CAAC,OAAO,CAAC;IAIjC,IAAW,MAAM,IAAI,UAAU,CAAC,WAAW,CAAC,CAE3C;IAEM,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,IAAI;IAgEvD,aAAa,IAAI,IAAI;IAkBrB,sBAAsB,CAAC,OAAO,EAAE,aAAa,GAAG,mBAAmB;IAO1E,OAAO,KAAK,sBAAsB,GAoBjC;IAED;;OAEG;IACI,kBAAkB,IAAI,OAAO;IAM7B,cAAc,CAAC,aAAa,EAAE,aAAa,EACjD,WAAW,EAAE,MAAM,8BAA8B,CAAC,aAAa,EAAE,aAAa,CAAC,EAC/E,MAAM,CAAC,EAAE,yBAAyB,GAChC,sBAAsB,CAAC,aAAa,EAAE,aAAa,CAAC;IAChD,cAAc,CACpB,WAAW,EAAE,MAAM,kCAAkC,GAAG,IAAI,EAC5D,MAAM,CAAC,EAAE,yBAAyB,GAChC,qBAAqB;IAYjB,mBAAmB,CAAC,aAAa,EAAE,aAAa,EACtD,WAAW,EAAE,MAAM,OAAO,CAAC,8BAA8B,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,EACxF,MAAM,CAAC,EAAE,yBAAyB,GAChC,OAAO,CAAC,sBAAsB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IACzD,mBAAmB,CACzB,WAAW,EAAE,MAAM,OAAO,CAAC,kCAAkC,GAAG,IAAI,CAAC,EACrE,MAAM,CAAC,EAAE,yBAAyB,GAChC,OAAO,CAAC,qBAAqB,CAAC;IA0BjC,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,YAAY;IAIpB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM;IA2Ed;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,eAAe;IAkBvB,IAAW,aAAa,IAAI,6BAA6B,CAKxD;IAEM,OAAO,IAAI,IAAI;IAgBtB,OAAO,KAAK,QAAQ,GAWnB;IAED,IAAW,IAAI,IAAI,aAAa,CAAC,WAAW,CAAC,CAE5C;IAED,IAAW,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,WAAW,CAAC,EAUpD;IAIM,IAAI,IAAI,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,GACtD,0BAA0B,CAAC,WAAW,CAAC;IAIjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIhC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI;IAIhE,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,aAAa,UAAO,GAAG,IAAI;IAIhE,UAAU,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAI/C,kBAAkB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO;IAI1D,6BAA6B,CACnC,OAAO,EAAE,oBAAoB,GAC3B,sBAAsB,GAAG,SAAS;IAMrC,IAAW,aAAa,IAAI,iBAAiB,CAE5C;CACD"}

package/lib/shared-tree/schematizingTreeView.js

@@ -2,10 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { __esDecorate, __runInitializers, __setFunctionName } from "tslib";
+import { __esDecorate, __runInitializers } from "tslib";
 import { createEmitter } from "@fluid-internal/client-utils";
 import { assert } from "@fluidframework/core-utils/internal";
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
+import { tagSchemaArtifacts, UsageError } from "@fluidframework/telemetry-utils/internal";
 import { anchorSlot, rootFieldKey } from "../core/index.js";
 import { defaultSchemaPolicy, cursorForMapTreeField, Context, combineChunks, FieldKinds, allowsRepoSuperset, } from "../feature-libraries/index.js";
 import { tryGetTreeNodeForField, setField, normalizeFieldSchema, checkSchemaCompatibility, HydratedContext, SimpleContextSlot, areImplicitFieldSchemaEqual, prepareForInsertionContextless, tryDisposeTreeNode, FieldSchemaAlpha, TreeViewConfigurationAlpha, toInitialSchema, toUpgradeSchema, } from "../simple-tree/index.js";
@@ -16,6 +16,21 @@ import { canInitialize, initialize, initializerFromChunk } from "./schematizeTre
  * exists and error if creating a second.
  */
 export const ViewSlot = anchorSlot();
+function throwIfSchemaIsIncompatible(compatibility) {
+    if (compatibility.canView) {
+        return;
+    }
+    const resolution = compatibility.canInitialize
+        ? "The document is uninitialized; call TreeView.initialize() before reading or writing TreeView.root."
+        : compatibility.canUpgrade
+            ? "The stored schema can be upgraded; call TreeView.upgradeSchema() before reading or writing TreeView.root."
+            : "The schemas cannot be upgraded automatically. Use a compatible view schema or explicitly migrate the document schema and data.";
+    throw new UsageError(`TreeView.root is unavailable because the view schema is incompatible with the stored schema. ${resolution}`, tagSchemaArtifacts({
+        schemaIncompatibilityDetails: compatibility.discrepancies === undefined
+            ? undefined
+            : JSON.stringify(compatibility.discrepancies),
+    }));
+}
 /**
  * Implementation of TreeView wrapping a FlexTreeView.
  */
@@ -24,29 +39,70 @@ let SchematizingSimpleTreeView = (() => {
     let _classDescriptor;
     let _classExtraInitializers = [];
     let _classThis;
-    var SchematizingSimpleTreeView = _classThis = class {
+    var SchematizingSimpleTreeView = class {
+        static { _classThis = this; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            SchematizingSimpleTreeView = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
+        }
+        checkout;
+        config;
+        nodeKeyManager;
+        onDispose;
+        /**
+         * This is set to undefined when this object is disposed or the view schema does not support viewing the document's stored schema.
+         *
+         * The view schema may be incompatible with the stored schema. Use `compatibility` to check.
+         */
+        flexTreeContext;
+        /**
+         * Undefined if and only if uninitialized or disposed.
+         */
+        currentCompatibility;
+        /**
+         * Cached map of upgrade statuses, computed alongside compatibility.
+         * @remarks Undefined if and only if uninitialized or disposed.
+         */
+        currentEnabledUpgrades;
+        events = createEmitter();
+        /**
+         * The schema for this view, captured at construction time for compatibility checking.
+         */
+        viewSchema;
+        /**
+         * Stored-schema generation policy from the view configuration, frozen at construction time.
+         */
+        stagedUpgradePolicy;
+        /**
+         * Events to unregister upon flex-tree view disposal.
+         */
+        flexTreeViewUnregisterCallbacks = new Set();
+        /**
+         * Events to unregister upon disposal.
+         */
+        unregisterCallbacks = new Set();
+        disposed = false;
+        /**
+         * This is set to true while an edit impacting the document schema is in progress.
+         * This allows suppressing extra rootChanged / schemaChanged events until the edit concludes.
+         * This is useful especially for some initialization edits, since document initialization can involve transient schemas
+         * which are implementation details and should not be exposed to the user.
+         */
+        midUpgrade = false;
+        /**
+         * Hydration work deferred until Context has been created.
+         */
+        pendingHydration;
+        rootFieldSchema;
+        breaker;
         constructor(checkout, config, nodeKeyManager, onDispose) {
             this.checkout = checkout;
             this.config = config;
             this.nodeKeyManager = nodeKeyManager;
             this.onDispose = onDispose;
-            this.events = createEmitter();
-            /**
-             * Events to unregister upon flex-tree view disposal.
-             */
-            this.flexTreeViewUnregisterCallbacks = new Set();
-            /**
-             * Events to unregister upon disposal.
-             */
-            this.unregisterCallbacks = new Set();
-            this.disposed = false;
-            /**
-             * This is set to true while an edit impacting the document schema is in progress.
-             * This allows suppressing extra rootChanged / schemaChanged events until the edit concludes.
-             * This is useful especially for some initialization edits, since document initialization can involve transient schemas
-             * which are implementation details and should not be exposed to the user.
-             */
-            this.midUpgrade = false;
             this.breaker = checkout.breaker;
             if (checkout.forest.anchors.slots.has(ViewSlot)) {
                 throw new UsageError("Cannot create a second tree view from the same checkout");
@@ -55,9 +111,7 @@ let SchematizingSimpleTreeView = (() => {
             this.rootFieldSchema = normalizeFieldSchema(config.schema);
             const stagedUpgradePolicy = config instanceof TreeViewConfigurationAlpha ? config.stagedUpgradePolicy : undefined;
             const configAlpha = new TreeViewConfigurationAlpha({
-                schema: config.schema,
-                enableSchemaValidation: config.enableSchemaValidation,
-                preventAmbiguity: config.preventAmbiguity,
+                ...config,
                 stagedUpgradePolicy,
             });
             this.stagedUpgradePolicy = configAlpha.stagedUpgradePolicy;
@@ -69,7 +123,9 @@ let SchematizingSimpleTreeView = (() => {
                 canUpgrade: true,
                 isEquivalent: false,
                 canInitialize: true,
+                discrepancies: undefined,
             };
+            this.currentEnabledUpgrades = new Map();
             this.update();
             this.unregisterCallbacks.add(this.checkout.events.on("changed", (data, getRevertible) => {
                 this.events.emit("changed", data, getRevertible);
@@ -132,7 +188,7 @@ let SchematizingSimpleTreeView = (() => {
         }
         upgradeSchema() {
             this.ensureUndisposed();
-            const newSchema = toUpgradeSchema(this.viewSchema.root, this.stagedUpgradePolicy);
+            const newSchema = toUpgradeSchema(this.viewSchema.root, this.effectiveUpgradePolicy);
             const storedSchema = this.checkout.storedSchema.clone();
             if (!allowsRepoSuperset(defaultSchemaPolicy, storedSchema, newSchema)) {
                 throw new UsageError("Existing stored schema cannot be upgraded to the requested schema (see TreeView.compatibility.canUpgrade).");
@@ -143,6 +199,27 @@ let SchematizingSimpleTreeView = (() => {
             }
             this.runSchemaEdit(() => this.checkout.updateSchema(newSchema));
         }
+        isStagedUpgradeEnabled(upgrade) {
+            if (!this.currentEnabledUpgrades) {
+                this.failDisposed();
+            }
+            return this.currentEnabledUpgrades.get(upgrade) ?? "disabled";
+        }
+        get effectiveUpgradePolicy() {
+            const configuredPolicy = this.stagedUpgradePolicy;
+            if (configuredPolicy.includeAlreadyEnabledUpgrades === false) {
+                return configuredPolicy;
+            }
+            const enabledUpgrades = this.currentEnabledUpgrades;
+            assert(enabledUpgrades !== undefined, 0xd3e /* Enabled upgrades must be available for an active view */);
+            if (enabledUpgrades.size === 0) {
+                return configuredPolicy;
+            }
+            return {
+                includeStaged: (upgrade) => configuredPolicy.includeStaged(upgrade) || enabledUpgrades.has(upgrade),
+                includeStagedOptional: (upgrade) => configuredPolicy.includeStagedOptional(upgrade) || enabledUpgrades.has(upgrade),
+            };
+        }
         /**
          * Gets the flex-tree context. Throws when disposed or out of schema.
          */
@@ -230,8 +307,12 @@ let SchematizingSimpleTreeView = (() => {
                 this.events.emit("rootChanged");
             }
         }
+        /**
+         * Computes the current schema compatibility status and updates the cached enabled upgrades.
+         */
         computeCompatibility() {
-            const compatibility = checkSchemaCompatibility(this.viewSchema, this.checkout.storedSchema, this.stagedUpgradePolicy);
+            const { enabledUpgrades, ...compatibility } = checkSchemaCompatibility(this.viewSchema, this.checkout.storedSchema, this.stagedUpgradePolicy);
+            this.currentEnabledUpgrades = enabledUpgrades;
             return {
                 ...compatibility,
                 canInitialize: canInitialize(this.checkout),
@@ -281,6 +362,7 @@ let SchematizingSimpleTreeView = (() => {
             }
             this.checkout.forest.anchors.slots.delete(ViewSlot);
             this.currentCompatibility = undefined;
+            this.currentEnabledUpgrades = undefined;
             this.onDispose?.();
             if (!this.checkout.isSharedBranch && !this.checkout.disposed) {
                 // All non-shared branches are 1:1 with views, so if a user manually disposes a view, we should also dispose the checkout/branch.
@@ -289,9 +371,7 @@ let SchematizingSimpleTreeView = (() => {
         }
         get flexRoot() {
             this.breaker.use();
-            if (!this.compatibility.canView) {
-                throw new UsageError("Document is out of schema. Check TreeView.compatibility before accessing TreeView.root.");
-            }
+            throwIfSchemaIsIncompatible(this.compatibility);
             const view = this.getFlexTreeContext();
             assert(view.root.is(FieldKinds.optional) ||
                 view.root.is(FieldKinds.required) ||
@@ -303,9 +383,7 @@ let SchematizingSimpleTreeView = (() => {
         }
         set root(newRoot) {
             this.breaker.use();
-            if (!this.compatibility.canView) {
-                throw new UsageError("Document is out of schema. Check TreeView.compatibility before accessing TreeView.root.");
-            }
+            throwIfSchemaIsIncompatible(this.compatibility);
             const view = this.getFlexTreeContext();
             setField(view.root, this.rootFieldSchema, newRoot, this.checkout.storedSchema.rootFieldSchema);
         }
@@ -336,14 +414,6 @@ let SchematizingSimpleTreeView = (() => {
             return this.checkout.branchHistory;
         }
     };
-    __setFunctionName(_classThis, "SchematizingSimpleTreeView");
-    (() => {
-        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
-        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-        SchematizingSimpleTreeView = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
     return SchematizingSimpleTreeView = _classThis;
 })();
 export { SchematizingSimpleTreeView };