@fluidframework/tree 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/tree";
-export declare const pkgVersion = "2.0.0-rc.2.0.2";
+export declare const pkgVersion = "2.0.0-rc.3.0.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/tree";
-exports.pkgVersion = "2.0.0-rc.2.0.2";
+exports.pkgVersion = "2.0.0-rc.3.0.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sBAAsB,CAAC;AACjC,QAAA,UAAU,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/tree\";\nexport const pkgVersion = \"2.0.0-rc.2.0.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sBAAsB,CAAC;AACjC,QAAA,UAAU,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/tree\";\nexport const pkgVersion = \"2.0.0-rc.3.0.0\";\n"]}

package/dist/public.d.ts

@@ -0,0 +1,90 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+
+export {
+	// public APIs
+	AllowedTypes, 
+	ApplyKind, 
+	CommitKind, 
+	CommitMetadata, 
+	Events, 
+	ExtractItemType, 
+	FieldKind, 
+	FieldProps, 
+	FieldSchema, 
+	FieldSchemaUnsafe, 
+	FlexList, 
+	FlexListToUnion, 
+	IDisposable, 
+	ISubscribable, 
+	ITree, 
+	ImplicitAllowedTypes, 
+	ImplicitFieldSchema, 
+	InsertableObjectFromSchemaRecord, 
+	InsertableObjectFromSchemaRecordUnsafe, 
+	InsertableTreeFieldFromImplicitField, 
+	InsertableTreeFieldFromImplicitFieldUnsafe, 
+	InsertableTreeNodeFromImplicitAllowedTypes, 
+	InsertableTreeNodeFromImplicitAllowedTypesUnsafe, 
+	InsertableTypedNode, 
+	InsertableTypedNodeUnsafe, 
+	IsEvent, 
+	IterableTreeArrayContent, 
+	LazyItem, 
+	MakeNominal, 
+	NodeBuilderData, 
+	NodeBuilderDataUnsafe, 
+	NodeFromSchema, 
+	NodeFromSchemaUnsafe, 
+	NodeInDocumentConstraint, 
+	NodeKind, 
+	ObjectFromSchemaRecord, 
+	ObjectFromSchemaRecordUnsafe, 
+	RestrictiveReadonlyRecord, 
+	Revertible, 
+	RevertibleFactory, 
+	RevertibleStatus, 
+	SchemaFactory, 
+	SchemaIncompatible, 
+	ScopedSchemaName, 
+	SharedTree, 
+	TransactionConstraint, 
+	Tree, 
+	TreeApi, 
+	TreeArrayNode, 
+	TreeArrayNodeBase, 
+	TreeArrayNodeUnsafe, 
+	TreeChangeEvents, 
+	TreeConfiguration, 
+	TreeFieldFromImplicitField, 
+	TreeFieldFromImplicitFieldUnsafe, 
+	TreeLeafValue, 
+	TreeMapNode, 
+	TreeMapNodeUnsafe, 
+	TreeNode, 
+	TreeNodeApi, 
+	TreeNodeFromImplicitAllowedTypes, 
+	TreeNodeFromImplicitAllowedTypesUnsafe, 
+	TreeNodeSchema, 
+	TreeNodeSchemaClass, 
+	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
+	TreeObjectNode, 
+	TreeObjectNodeUnsafe, 
+	TreeStatus, 
+	TreeView, 
+	TreeViewEvents, 
+	Unenforced, 
+	Unhydrated, 
+	ValidateRecursiveSchema, 
+	WithType, 
+	disposeSymbol, 
+	type
+} from "./index.js";

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

@@ -2,10 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { ISharedTree, SharedTreeFactory, SharedTreeOptions, SharedTree, ForestType, SharedTreeContentSnapshot, } from "./sharedTree.js";
-export { createTreeCheckout, TreeCheckout, ITreeCheckout, runSynchronous, CheckoutEvents, ITransaction, ITreeCheckoutFork, } from "./treeCheckout.js";
+export { ISharedTree, SharedTreeFactory, SharedTreeOptions, SharedTree, ForestType, SharedTreeContentSnapshot, SharedTreeFormatOptions, SharedTreeFormatVersion, } from "./sharedTree.js";
+export { createTreeCheckout, TreeCheckout, ITreeCheckout, runSynchronous, CheckoutEvents, ITransaction, ITreeCheckoutFork, RevertibleFactory, } from "./treeCheckout.js";
 export { SchematizeConfiguration, TreeContent, InitializeAndSchematizeConfiguration, SchemaConfiguration, buildTreeConfiguration, } from "./schematizeTree.js";
 export { FlexTreeView, CheckoutFlexTreeView, ITreeViewFork } from "./treeView.js";
 export { ISharedTreeEditor, ISchemaEditor } from "./sharedTreeEditBuilder.js";
-export { treeApi as Tree, TreeApi } from "./treeApi.js";
+export { treeApi as Tree, TreeApi, TransactionConstraint, NodeInDocumentConstraint, } from "./treeApi.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/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,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,yBAAyB,GACzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,iBAAiB,GACjB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACN,uBAAuB,EACvB,WAAW,EACX,oCAAoC,EACpC,mBAAmB,EACnB,sBAAsB,GACtB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAElF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE9E,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,yBAAyB,EACzB,uBAAuB,EACvB,uBAAuB,GACvB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,GACjB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACN,uBAAuB,EACvB,WAAW,EACX,oCAAoC,EACpC,mBAAmB,EACnB,sBAAsB,GACtB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAElF,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE9E,OAAO,EACN,OAAO,IAAI,IAAI,EACf,OAAO,EACP,qBAAqB,EACrB,wBAAwB,GACxB,MAAM,cAAc,CAAC"}

package/dist/shared-tree/index.js

@@ -4,11 +4,12 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Tree = exports.CheckoutFlexTreeView = exports.buildTreeConfiguration = exports.runSynchronous = exports.TreeCheckout = exports.createTreeCheckout = exports.ForestType = exports.SharedTree = exports.SharedTreeFactory = void 0;
+exports.Tree = exports.CheckoutFlexTreeView = exports.buildTreeConfiguration = exports.runSynchronous = exports.TreeCheckout = exports.createTreeCheckout = exports.SharedTreeFormatVersion = exports.ForestType = exports.SharedTree = exports.SharedTreeFactory = void 0;
 var sharedTree_js_1 = require("./sharedTree.js");
 Object.defineProperty(exports, "SharedTreeFactory", { enumerable: true, get: function () { return sharedTree_js_1.SharedTreeFactory; } });
 Object.defineProperty(exports, "SharedTree", { enumerable: true, get: function () { return sharedTree_js_1.SharedTree; } });
 Object.defineProperty(exports, "ForestType", { enumerable: true, get: function () { return sharedTree_js_1.ForestType; } });
+Object.defineProperty(exports, "SharedTreeFormatVersion", { enumerable: true, get: function () { return sharedTree_js_1.SharedTreeFormatVersion; } });
 var treeCheckout_js_1 = require("./treeCheckout.js");
 Object.defineProperty(exports, "createTreeCheckout", { enumerable: true, get: function () { return treeCheckout_js_1.createTreeCheckout; } });
 Object.defineProperty(exports, "TreeCheckout", { enumerable: true, get: function () { return treeCheckout_js_1.TreeCheckout; } });

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAOyB;AALxB,kHAAA,iBAAiB,OAAA;AAEjB,2GAAA,UAAU,OAAA;AACV,2GAAA,UAAU,OAAA;AAIX,qDAQ2B;AAP1B,qHAAA,kBAAkB,OAAA;AAClB,+GAAA,YAAY,OAAA;AAEZ,iHAAA,cAAc,OAAA;AAMf,yDAM6B;AAD5B,2HAAA,sBAAsB,OAAA;AAGvB,6CAAkF;AAA3D,mHAAA,oBAAoB,OAAA;AAI3C,2CAAwD;AAA/C,kGAAA,OAAO,OAAQ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tISharedTree,\n\tSharedTreeFactory,\n\tSharedTreeOptions,\n\tSharedTree,\n\tForestType,\n\tSharedTreeContentSnapshot,\n} from \"./sharedTree.js\";\n\nexport {\n\tcreateTreeCheckout,\n\tTreeCheckout,\n\tITreeCheckout,\n\trunSynchronous,\n\tCheckoutEvents,\n\tITransaction,\n\tITreeCheckoutFork,\n} from \"./treeCheckout.js\";\n\nexport {\n\tSchematizeConfiguration,\n\tTreeContent,\n\tInitializeAndSchematizeConfiguration,\n\tSchemaConfiguration,\n\tbuildTreeConfiguration,\n} from \"./schematizeTree.js\";\n\nexport { FlexTreeView, CheckoutFlexTreeView, ITreeViewFork } from \"./treeView.js\";\n\nexport { ISharedTreeEditor, ISchemaEditor } from \"./sharedTreeEditBuilder.js\";\n\nexport { treeApi as Tree, TreeApi } from \"./treeApi.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDASyB;AAPxB,kHAAA,iBAAiB,OAAA;AAEjB,2GAAA,UAAU,OAAA;AACV,2GAAA,UAAU,OAAA;AAGV,wHAAA,uBAAuB,OAAA;AAGxB,qDAS2B;AAR1B,qHAAA,kBAAkB,OAAA;AAClB,+GAAA,YAAY,OAAA;AAEZ,iHAAA,cAAc,OAAA;AAOf,yDAM6B;AAD5B,2HAAA,sBAAsB,OAAA;AAGvB,6CAAkF;AAA3D,mHAAA,oBAAoB,OAAA;AAI3C,2CAKsB;AAJrB,kGAAA,OAAO,OAAQ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tISharedTree,\n\tSharedTreeFactory,\n\tSharedTreeOptions,\n\tSharedTree,\n\tForestType,\n\tSharedTreeContentSnapshot,\n\tSharedTreeFormatOptions,\n\tSharedTreeFormatVersion,\n} from \"./sharedTree.js\";\n\nexport {\n\tcreateTreeCheckout,\n\tTreeCheckout,\n\tITreeCheckout,\n\trunSynchronous,\n\tCheckoutEvents,\n\tITransaction,\n\tITreeCheckoutFork,\n\tRevertibleFactory,\n} from \"./treeCheckout.js\";\n\nexport {\n\tSchematizeConfiguration,\n\tTreeContent,\n\tInitializeAndSchematizeConfiguration,\n\tSchemaConfiguration,\n\tbuildTreeConfiguration,\n} from \"./schematizeTree.js\";\n\nexport { FlexTreeView, CheckoutFlexTreeView, ITreeViewFork } from \"./treeView.js\";\n\nexport { ISharedTreeEditor, ISchemaEditor } from \"./sharedTreeEditBuilder.js\";\n\nexport {\n\ttreeApi as Tree,\n\tTreeApi,\n\tTransactionConstraint,\n\tNodeInDocumentConstraint,\n} from \"./treeApi.js\";\n"]}

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

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { AllowedUpdateType, ITreeCursorSynchronous } from "../core/index.js";
-import { FlexTreeSchema, FlexFieldSchema, ViewSchema, InsertableFlexField } from "../feature-libraries/index.js";
+import { FlexFieldSchema, FlexTreeSchema, InsertableFlexField, ViewSchema } from "../feature-libraries/index.js";
 import { ITreeCheckout } from "./treeCheckout.js";
 /**
  * Modify `storedSchema` and invoke `setInitialTree` when it's time to set the tree content.

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

@@ -1 +1 @@
-{"version":3,"file":"schematizeTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizeTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,iBAAiB,EAGjB,sBAAsB,EAGtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAIN,cAAc,EACd,eAAe,EACf,UAAU,EACV,mBAAmB,EAGnB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAChC,gBAAgB,EAAE;IACjB,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5C,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC5C,EACD,SAAS,EAAE,cAAc,EACzB,cAAc,EAAE,MAAM,IAAI,GACxB,IAAI,CAgDN;AAED,oBAAY,UAAU;IACrB;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,UAAU,IAAA;IACV;;OAEG;IACH,gBAAgB,IAAA;IAChB;;OAEG;IACH,YAAY,IAAA;CACZ;AAED,wBAAgB,cAAc,CAC7B,UAAU,EAAE,UAAU,EACtB,0BAA0B,EAAE,iBAAiB,EAC7C,QAAQ,EAAE,aAAa,GACrB,UAAU,CA4BZ;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAG9D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC3B,UAAU,EAAE,UAAU,EACtB,0BAA0B,EAAE,iBAAiB,EAC7C,QAAQ,EAAE,aAAa,EACvB,WAAW,EAAE,WAAW,GAAG,SAAS,GAClC,OAAO,CAgET;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,SAAS,eAAe,GAAG,eAAe;IACnF;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK,SAAS,eAAe,GAAG,eAAe,CAC3E,SAAQ,mBAAmB,CAAC,KAAK,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,WAAW,EACjB,mBAAmB,CAAC,KAAK,CAAC,GAC1B,SAAS,sBAAsB,EAAE,GACjC,sBAAsB,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB,CAAC,KAAK,SAAS,eAAe,GAAG,eAAe,CACvF,SAAQ,mBAAmB,CAAC,KAAK,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,0BAA0B,EAAE,iBAAiB,CAAC;CACvD;AAED;;;;GAIG;AACH,MAAM,WAAW,oCAAoC,CACpD,KAAK,SAAS,eAAe,GAAG,eAAe,CAC9C,SAAQ,WAAW,CAAC,KAAK,CAAC,EAC1B,uBAAuB,CAAC,KAAK,CAAC;CAAG;AAEnC;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,eAAe,EAC/D,MAAM,EAAE,oCAAoC,CAAC,CAAC,CAAC,GAC7C,oCAAoC,CAAC,CAAC,CAAC,CAEzC"}
+{"version":3,"file":"schematizeTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizeTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,iBAAiB,EAEjB,sBAAsB,EAItB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAEN,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,UAAU,EAKV,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAChC,gBAAgB,EAAE;IACjB,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5C,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC5C,EACD,SAAS,EAAE,cAAc,EACzB,cAAc,EAAE,MAAM,IAAI,GACxB,IAAI,CAgDN;AAED,oBAAY,UAAU;IACrB;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,UAAU,IAAA;IACV;;OAEG;IACH,gBAAgB,IAAA;IAChB;;OAEG;IACH,YAAY,IAAA;CACZ;AAED,wBAAgB,cAAc,CAC7B,UAAU,EAAE,UAAU,EACtB,0BAA0B,EAAE,iBAAiB,EAC7C,QAAQ,EAAE,aAAa,GACrB,UAAU,CA4BZ;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAG9D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC3B,UAAU,EAAE,UAAU,EACtB,0BAA0B,EAAE,iBAAiB,EAC7C,QAAQ,EAAE,aAAa,EACvB,WAAW,EAAE,WAAW,GAAG,SAAS,GAClC,OAAO,CAgET;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,SAAS,eAAe,GAAG,eAAe;IACnF;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK,SAAS,eAAe,GAAG,eAAe,CAC3E,SAAQ,mBAAmB,CAAC,KAAK,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,WAAW,EACjB,mBAAmB,CAAC,KAAK,CAAC,GAC1B,SAAS,sBAAsB,EAAE,GACjC,sBAAsB,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB,CAAC,KAAK,SAAS,eAAe,GAAG,eAAe,CACvF,SAAQ,mBAAmB,CAAC,KAAK,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,0BAA0B,EAAE,iBAAiB,CAAC;CACvD;AAED;;;;GAIG;AACH,MAAM,WAAW,oCAAoC,CACpD,KAAK,SAAS,eAAe,GAAG,eAAe,CAC9C,SAAQ,WAAW,CAAC,KAAK,CAAC,EAC1B,uBAAuB,CAAC,KAAK,CAAC;CAAG;AAEnC;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,eAAe,EAC/D,MAAM,EAAE,oCAAoC,CAAC,CAAC,CAAC,GAC7C,oCAAoC,CAAC,CAAC,CAAC,CAEzC"}

package/dist/shared-tree/schematizeTree.js

@@ -5,7 +5,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildTreeConfiguration = exports.ensureSchema = exports.canInitialize = exports.evaluateUpdate = exports.UpdateType = exports.initializeContent = void 0;
-const core_utils_1 = require("@fluidframework/core-utils");
+const internal_1 = require("@fluidframework/core-utils/internal");
 const index_js_1 = require("../core/index.js");
 const index_js_2 = require("../feature-libraries/index.js");
 const index_js_3 = require("../util/index.js");
@@ -22,10 +22,10 @@ const index_js_3 = require("../util/index.js");
  * Since this makes multiple changes, callers may want to wrap it in a transaction.
  */
 function initializeContent(schemaRepository, newSchema, setInitialTree) {
-    (0, core_utils_1.assert)((0, index_js_1.schemaDataIsEmpty)(schemaRepository.storedSchema), 0x743 /* cannot initialize after a schema is set */);
+    (0, internal_1.assert)((0, index_js_1.schemaDataIsEmpty)(schemaRepository.storedSchema), 0x743 /* cannot initialize after a schema is set */);
     const schema = (0, index_js_2.intoStoredSchema)(newSchema);
     const rootSchema = schema.rootFieldSchema;
-    const rootKind = rootSchema.kind.identifier;
+    const rootKind = rootSchema.kind;
     // To keep the data in schema during the update, first define a schema that tolerates the current (empty) tree as well as the final (initial) tree.
     let incrementalSchemaUpdate;
     if (rootKind === index_js_2.FieldKinds.sequence.identifier ||
@@ -34,12 +34,12 @@ function initializeContent(schemaRepository, newSchema, setInitialTree) {
         incrementalSchemaUpdate = schema;
     }
     else {
-        (0, core_utils_1.assert)(rootKind === index_js_2.FieldKinds.required.identifier, 0x5c8 /* Unexpected kind */);
+        (0, internal_1.assert)(rootKind === index_js_2.FieldKinds.required.identifier, 0x5c8 /* Unexpected kind */);
         // Replace value kind with optional kind in root field schema:
         incrementalSchemaUpdate = {
             nodeSchema: schema.nodeSchema,
             rootFieldSchema: {
-                kind: index_js_2.FieldKinds.optional,
+                kind: index_js_2.FieldKinds.optional.identifier,
                 types: rootSchema.types,
             },
         };
@@ -49,7 +49,7 @@ function initializeContent(schemaRepository, newSchema, setInitialTree) {
     // 	allowsRepoSuperset(defaultSchemaPolicy, tree.storedSchema, incrementalSchemaUpdate),
     // 	"Incremental Schema update should support the existing empty tree",
     // );
-    (0, core_utils_1.assert)((0, index_js_2.allowsRepoSuperset)(index_js_2.defaultSchemaPolicy, schema, incrementalSchemaUpdate), 0x5c9 /* Incremental Schema during update should be a allow a superset of the final schema */);
+    (0, internal_1.assert)((0, index_js_2.allowsRepoSuperset)(index_js_2.defaultSchemaPolicy, schema, incrementalSchemaUpdate), 0x5c9 /* Incremental Schema during update should be a allow a superset of the final schema */);
     // Update to intermediate schema
     schemaRepository.updateSchema(incrementalSchemaUpdate);
     // Insert initial tree
@@ -94,8 +94,8 @@ function evaluateUpdate(viewSchema, allowedSchemaModifications, checkout) {
         // Existing stored schema permits trees which are incompatible with the view schema, so schema can not be updated
         return UpdateType.Incompatible;
     }
-    (0, core_utils_1.assert)(compatibility.write === index_js_1.Compatibility.Incompatible, 0x8bd /* unexpected case */);
-    (0, core_utils_1.assert)(compatibility.read === index_js_1.Compatibility.Compatible, 0x8be /* unexpected case */);
+    (0, internal_1.assert)(compatibility.write === index_js_1.Compatibility.Incompatible, 0x8bd /* unexpected case */);
+    (0, internal_1.assert)(compatibility.read === index_js_1.Compatibility.Compatible, 0x8be /* unexpected case */);
     // eslint-disable-next-line no-bitwise
     return allowedSchemaModifications & index_js_1.AllowedUpdateType.SchemaCompatible
         ? UpdateType.SchemaCompatible
@@ -149,10 +149,10 @@ function ensureSchema(viewSchema, allowedSchemaModifications, checkout, treeCont
             initializeContent(checkout, treeContent.schema, () => {
                 const field = { field: index_js_1.rootFieldKey, parent: undefined };
                 const content = (0, index_js_2.normalizeNewFieldContent)({ schema: treeContent.schema }, treeContent.schema.rootFieldSchema, treeContent.initialTree);
-                switch (checkout.storedSchema.rootFieldSchema.kind.identifier) {
+                switch (checkout.storedSchema.rootFieldSchema.kind) {
                     case index_js_2.FieldKinds.optional.identifier: {
                         const fieldEditor = checkout.editor.optionalField(field);
-                        (0, core_utils_1.assert)(content.getFieldLength() <= 1, 0x7f4 /* optional field content should normalize at most one item */);
+                        (0, internal_1.assert)(content.getFieldLength() <= 1, 0x7f4 /* optional field content should normalize at most one item */);
                         fieldEditor.set(content.getFieldLength() === 0 ? undefined : content, true);
                         break;
                     }
@@ -171,7 +171,7 @@ function ensureSchema(viewSchema, allowedSchemaModifications, checkout, treeCont
             return true;
         }
         default: {
-            (0, core_utils_1.unreachableCase)(updatedNeeded);
+            (0, internal_1.unreachableCase)(updatedNeeded);
         }
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"schematizeTree.js","sourceRoot":"","sources":["../../src/shared-tree/schematizeTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAqE;AACrE,+CAO0B;AAC1B,4DAUuC;AACvC,+CAAwC;AAGxC;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAChC,gBAGC,EACD,SAAyB,EACzB,cAA0B;IAE1B,IAAA,mBAAM,EACL,IAAA,4BAAiB,EAAC,gBAAgB,CAAC,YAAY,CAAC,EAChD,KAAK,CAAC,6CAA6C,CACnD,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,2BAAgB,EAAC,SAAS,CAAC,CAAC;IAC3C,MAAM,UAAU,GAAG,MAAM,CAAC,eAAe,CAAC;IAC1C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;IAE5C,mJAAmJ;IACnJ,IAAI,uBAAyC,CAAC;IAC9C,IACC,QAAQ,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU;QAC3C,QAAQ,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,EAC1C;QACD,oEAAoE;QACpE,uBAAuB,GAAG,MAAM,CAAC;KACjC;SAAM;QACN,IAAA,mBAAM,EAAC,QAAQ,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACjF,8DAA8D;QAC9D,uBAAuB,GAAG;YACzB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,eAAe,EAAE;gBAChB,IAAI,EAAE,qBAAU,CAAC,QAAQ;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;aACvB;SACD,CAAC;KACF;IAED,2DAA2D;IAC3D,UAAU;IACV,wFAAwF;IACxF,uEAAuE;IACvE,KAAK;IACL,IAAA,mBAAM,EACL,IAAA,6BAAkB,EAAC,8BAAmB,EAAE,MAAM,EAAE,uBAAuB,CAAC,EACxE,KAAK,CAAC,uFAAuF,CAC7F,CAAC;IACF,gCAAgC;IAChC,gBAAgB,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC;IACvD,sBAAsB;IACtB,cAAc,EAAE,CAAC;IAEjB,kFAAkF;IAClF,IAAI,uBAAuB,KAAK,MAAM,EAAE;QACvC,gBAAgB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;KACtC;AACF,CAAC;AAvDD,8CAuDC;AAED,IAAY,UAiBX;AAjBD,WAAY,UAAU;IACrB;;OAEG;IACH,2CAAI,CAAA;IACJ;;OAEG;IACH,uDAAU,CAAA;IACV;;OAEG;IACH,mEAAgB,CAAA;IAChB;;OAEG;IACH,2DAAY,CAAA;AACb,CAAC,EAjBW,UAAU,0BAAV,UAAU,QAiBrB;AAED,SAAgB,cAAc,CAC7B,UAAsB,EACtB,0BAA6C,EAC7C,QAAuB;IAEvB,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAE3E,IACC,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU;QAC/C,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,UAAU,EAC/C;QACD,mBAAmB;QACnB,OAAO,UAAU,CAAC,IAAI,CAAC;KACvB;IAED,sCAAsC;IACtC,IAAI,0BAA0B,GAAG,4BAAiB,CAAC,UAAU,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;QACzF,OAAO,UAAU,CAAC,UAAU,CAAC;KAC7B;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAAE;QACpD,iHAAiH;QACjH,OAAO,UAAU,CAAC,YAAY,CAAC;KAC/B;IAED,IAAA,mBAAM,EAAC,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,YAAY,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACxF,IAAA,mBAAM,EAAC,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAErF,sCAAsC;IACtC,OAAO,0BAA0B,GAAG,4BAAiB,CAAC,gBAAgB;QACrE,CAAC,CAAC,UAAU,CAAC,gBAAgB;QAC7B,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;AAC5B,CAAC;AAhCD,wCAgCC;AAED,SAAgB,aAAa,CAAC,QAAuB;IACpD,mBAAmB;IACnB,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,IAAI,IAAA,4BAAiB,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AAC5E,CAAC;AAHD,sCAGC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAC3B,UAAsB,EACtB,0BAA6C,EAC7C,QAAuB,EACvB,WAAoC;IAEpC,IAAI,qBAAqB,GAAG,0BAA0B,CAAC;IACvD,IAAI,WAAW,KAAK,SAAS,EAAE;QAC9B,4DAA4D;QAC5D,sCAAsC;QACtC,qBAAqB,IAAI,CAAC,4BAAiB,CAAC,UAAU,CAAC;KACvD;IACD,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,EAAE,qBAAqB,EAAE,QAAQ,CAAC,CAAC;IAClF,QAAQ,aAAa,EAAE;QACtB,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;SACZ;QACD,KAAK,UAAU,CAAC,YAAY,CAAC,CAAC;YAC7B,OAAO,KAAK,CAAC;SACb;QACD,KAAK,UAAU,CAAC,gBAAgB,CAAC,CAAC;YACjC,QAAQ,CAAC,YAAY,CAAC,IAAA,2BAAgB,EAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;SACZ;QACD,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC;YAC3B,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC9B,OAAO,KAAK,CAAC;aACb;YACD,QAAQ;YACR,sFAAsF;YACtF,iGAAiG;YAEjG,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7B,iBAAiB,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE;gBACpD,MAAM,KAAK,GAAG,EAAE,KAAK,EAAE,uBAAY,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;gBACzD,MAAM,OAAO,GAAG,IAAA,mCAAwB,EACvC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,EAC9B,WAAW,CAAC,MAAM,CAAC,eAAe,EAClC,WAAW,CAAC,WAAW,CACvB,CAAC;gBACF,QAAQ,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,EAAE;oBAC9D,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBACpC,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;wBACzD,IAAA,mBAAM,EACL,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,EAC7B,KAAK,CAAC,8DAA8D,CACpE,CAAC;wBACF,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;wBAC5E,MAAM;qBACN;oBACD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBACpC,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;wBACzD,2CAA2C;wBAC3C,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;wBAC/B,MAAM;qBACN;oBACD,OAAO,CAAC,CAAC;wBACR,IAAA,eAAI,EAAC,8CAA8C,CAAC,CAAC;qBACrD;iBACD;YACF,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YAE9B,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,CAAC,CAAC;YACR,IAAA,4BAAe,EAAC,aAAa,CAAC,CAAC;SAC/B;KACD;AACF,CAAC;AArED,oCAqEC;AAsDD;;;;;GAKG;AACH,SAAgB,sBAAsB,CACrC,MAA+C;IAE/C,OAAO,MAAM,CAAC;AACf,CAAC;AAJD,wDAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, unreachableCase } from \"@fluidframework/core-utils\";\nimport {\n\tAllowedUpdateType,\n\tCompatibility,\n\tTreeStoredSchema,\n\tITreeCursorSynchronous,\n\tschemaDataIsEmpty,\n\trootFieldKey,\n} from \"../core/index.js\";\nimport {\n\tdefaultSchemaPolicy,\n\tFieldKinds,\n\tallowsRepoSuperset,\n\tFlexTreeSchema,\n\tFlexFieldSchema,\n\tViewSchema,\n\tInsertableFlexField,\n\tintoStoredSchema,\n\tnormalizeNewFieldContent,\n} from \"../feature-libraries/index.js\";\nimport { fail } from \"../util/index.js\";\nimport { ITreeCheckout } from \"./treeCheckout.js\";\n\n/**\n * Modify `storedSchema` and invoke `setInitialTree` when it's time to set the tree content.\n *\n * Requires `storedSchema` to be in its default/empty state.\n *\n * This is done in such a way that if the content (implicitly assumed to start empty)\n * is never out of schema.\n * This means that if the root field of the new schema requires content (like a value field),\n * a temporary intermediate schema is used so the initial empty state is not out of schema.\n *\n * Since this makes multiple changes, callers may want to wrap it in a transaction.\n */\nexport function initializeContent(\n\tschemaRepository: {\n\t\tstoredSchema: ITreeCheckout[\"storedSchema\"];\n\t\tupdateSchema: ITreeCheckout[\"updateSchema\"];\n\t},\n\tnewSchema: FlexTreeSchema,\n\tsetInitialTree: () => void,\n): void {\n\tassert(\n\t\tschemaDataIsEmpty(schemaRepository.storedSchema),\n\t\t0x743 /* cannot initialize after a schema is set */,\n\t);\n\n\tconst schema = intoStoredSchema(newSchema);\n\tconst rootSchema = schema.rootFieldSchema;\n\tconst rootKind = rootSchema.kind.identifier;\n\n\t// To keep the data in schema during the update, first define a schema that tolerates the current (empty) tree as well as the final (initial) tree.\n\tlet incrementalSchemaUpdate: TreeStoredSchema;\n\tif (\n\t\trootKind === FieldKinds.sequence.identifier ||\n\t\trootKind === FieldKinds.optional.identifier\n\t) {\n\t\t// These kinds are known to tolerate empty, so use the schema as is:\n\t\tincrementalSchemaUpdate = schema;\n\t} else {\n\t\tassert(rootKind === FieldKinds.required.identifier, 0x5c8 /* Unexpected kind */);\n\t\t// Replace value kind with optional kind in root field schema:\n\t\tincrementalSchemaUpdate = {\n\t\t\tnodeSchema: schema.nodeSchema,\n\t\t\trootFieldSchema: {\n\t\t\t\tkind: FieldKinds.optional,\n\t\t\t\ttypes: rootSchema.types,\n\t\t\t},\n\t\t};\n\t}\n\n\t// TODO: fix issues with schema comparison and enable this.\n\t// assert(\n\t// \tallowsRepoSuperset(defaultSchemaPolicy, tree.storedSchema, incrementalSchemaUpdate),\n\t// \t\"Incremental Schema update should support the existing empty tree\",\n\t// );\n\tassert(\n\t\tallowsRepoSuperset(defaultSchemaPolicy, schema, incrementalSchemaUpdate),\n\t\t0x5c9 /* Incremental Schema during update should be a allow a superset of the final schema */,\n\t);\n\t// Update to intermediate schema\n\tschemaRepository.updateSchema(incrementalSchemaUpdate);\n\t// Insert initial tree\n\tsetInitialTree();\n\n\t// If intermediate schema is not final desired schema, update to the final schema:\n\tif (incrementalSchemaUpdate !== schema) {\n\t\tschemaRepository.updateSchema(schema);\n\t}\n}\n\nexport enum UpdateType {\n\t/**\n\t * Already compatible, no update needed.\n\t */\n\tNone,\n\t/**\n\t * Empty: needs initializing.\n\t */\n\tInitialize,\n\t/**\n\t * Schema can be upgraded leaving tree as is.\n\t */\n\tSchemaCompatible,\n\t/**\n\t * No update currently supported.\n\t */\n\tIncompatible,\n}\n\nexport function evaluateUpdate(\n\tviewSchema: ViewSchema,\n\tallowedSchemaModifications: AllowedUpdateType,\n\tcheckout: ITreeCheckout,\n): UpdateType {\n\tconst compatibility = viewSchema.checkCompatibility(checkout.storedSchema);\n\n\tif (\n\t\tcompatibility.read === Compatibility.Compatible &&\n\t\tcompatibility.write === Compatibility.Compatible\n\t) {\n\t\t// Compatible as is\n\t\treturn UpdateType.None;\n\t}\n\n\t// eslint-disable-next-line no-bitwise\n\tif (allowedSchemaModifications & AllowedUpdateType.Initialize && canInitialize(checkout)) {\n\t\treturn UpdateType.Initialize;\n\t}\n\n\tif (compatibility.read !== Compatibility.Compatible) {\n\t\t// Existing stored schema permits trees which are incompatible with the view schema, so schema can not be updated\n\t\treturn UpdateType.Incompatible;\n\t}\n\n\tassert(compatibility.write === Compatibility.Incompatible, 0x8bd /* unexpected case */);\n\tassert(compatibility.read === Compatibility.Compatible, 0x8be /* unexpected case */);\n\n\t// eslint-disable-next-line no-bitwise\n\treturn allowedSchemaModifications & AllowedUpdateType.SchemaCompatible\n\t\t? UpdateType.SchemaCompatible\n\t\t: UpdateType.Incompatible;\n}\n\nexport function canInitialize(checkout: ITreeCheckout): boolean {\n\t// Check for empty.\n\treturn checkout.forest.isEmpty && schemaDataIsEmpty(checkout.storedSchema);\n}\n\n/**\n * Ensure a {@link ITreeCheckout} can be used with a given {@link ViewSchema}.\n *\n * @remarks\n * It is up to the caller to ensure that compatibility is reevaluated if the checkout's stored schema is edited in the future.\n *\n * @param viewSchema - View schema that `checkout` should be made compatible with.\n * @param allowedSchemaModifications - Flags enum describing the ways this is allowed to modify `checkout`.\n * @param checkout - To be modified as needed to be compatible with `viewSchema`.\n * @param treeContent - Content to be used to initialize `checkout`'s the tree if needed and allowed.\n * @returns true iff checkout now is compatible with `viewSchema`.\n */\nexport function ensureSchema(\n\tviewSchema: ViewSchema,\n\tallowedSchemaModifications: AllowedUpdateType,\n\tcheckout: ITreeCheckout,\n\ttreeContent: TreeContent | undefined,\n): boolean {\n\tlet possibleModifications = allowedSchemaModifications;\n\tif (treeContent === undefined) {\n\t\t// Clear bit for Initialize if initial tree is not provided.\n\t\t// eslint-disable-next-line no-bitwise\n\t\tpossibleModifications &= ~AllowedUpdateType.Initialize;\n\t}\n\tconst updatedNeeded = evaluateUpdate(viewSchema, possibleModifications, checkout);\n\tswitch (updatedNeeded) {\n\t\tcase UpdateType.None: {\n\t\t\treturn true;\n\t\t}\n\t\tcase UpdateType.Incompatible: {\n\t\t\treturn false;\n\t\t}\n\t\tcase UpdateType.SchemaCompatible: {\n\t\t\tcheckout.updateSchema(intoStoredSchema(viewSchema.schema));\n\t\t\treturn true;\n\t\t}\n\t\tcase UpdateType.Initialize: {\n\t\t\tif (treeContent === undefined) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t\t// TODO:\n\t\t\t// When this becomes a more proper out of schema adapter, editing should be made lazy.\n\t\t\t// This will improve support for readonly documents, cross version collaboration and attribution.\n\n\t\t\tcheckout.transaction.start();\n\t\t\tinitializeContent(checkout, treeContent.schema, () => {\n\t\t\t\tconst field = { field: rootFieldKey, parent: undefined };\n\t\t\t\tconst content = normalizeNewFieldContent(\n\t\t\t\t\t{ schema: treeContent.schema },\n\t\t\t\t\ttreeContent.schema.rootFieldSchema,\n\t\t\t\t\ttreeContent.initialTree,\n\t\t\t\t);\n\t\t\t\tswitch (checkout.storedSchema.rootFieldSchema.kind.identifier) {\n\t\t\t\t\tcase FieldKinds.optional.identifier: {\n\t\t\t\t\t\tconst fieldEditor = checkout.editor.optionalField(field);\n\t\t\t\t\t\tassert(\n\t\t\t\t\t\t\tcontent.getFieldLength() <= 1,\n\t\t\t\t\t\t\t0x7f4 /* optional field content should normalize at most one item */,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tfieldEditor.set(content.getFieldLength() === 0 ? undefined : content, true);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tcase FieldKinds.sequence.identifier: {\n\t\t\t\t\t\tconst fieldEditor = checkout.editor.sequenceField(field);\n\t\t\t\t\t\t// TODO: should do an idempotent edit here.\n\t\t\t\t\t\tfieldEditor.insert(0, content);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tdefault: {\n\t\t\t\t\t\tfail(\"unexpected root field kind during initialize\");\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\t\t\tcheckout.transaction.commit();\n\n\t\t\treturn true;\n\t\t}\n\t\tdefault: {\n\t\t\tunreachableCase(updatedNeeded);\n\t\t}\n\t}\n}\n\n/**\n * View Schema for a `SharedTree`.\n *\n * @internal\n */\nexport interface SchemaConfiguration<TRoot extends FlexFieldSchema = FlexFieldSchema> {\n\t/**\n\t * The schema which the application wants to view the tree with.\n\t */\n\treadonly schema: FlexTreeSchema<TRoot>;\n}\n\n/**\n * Content that can populate a `SharedTree`.\n *\n * @internal\n */\nexport interface TreeContent<TRoot extends FlexFieldSchema = FlexFieldSchema>\n\textends SchemaConfiguration<TRoot> {\n\t/**\n\t * Default tree content to initialize the tree with iff the tree is uninitialized\n\t * (meaning it does not even have any schema set at all).\n\t */\n\treadonly initialTree:\n\t\t| InsertableFlexField<TRoot>\n\t\t| readonly ITreeCursorSynchronous[]\n\t\t| ITreeCursorSynchronous;\n}\n\n/**\n * Options used to schematize a `SharedTree`.\n *\n * @internal\n */\nexport interface SchematizeConfiguration<TRoot extends FlexFieldSchema = FlexFieldSchema>\n\textends SchemaConfiguration<TRoot> {\n\t/**\n\t * Controls if and how schema from existing documents can be updated to accommodate the view schema.\n\t */\n\treadonly allowedSchemaModifications: AllowedUpdateType;\n}\n\n/**\n * Options used to initialize (if needed) and schematize a `SharedTree`.\n *\n * @internal\n */\nexport interface InitializeAndSchematizeConfiguration<\n\tTRoot extends FlexFieldSchema = FlexFieldSchema,\n> extends TreeContent<TRoot>,\n\t\tSchematizeConfiguration<TRoot> {}\n\n/**\n * Options used to initialize (if needed) and schematize a `SharedTree`.\n * @remarks\n * Using this builder improves type safety and error quality over just constructing the configuration as a object.\n * @internal\n */\nexport function buildTreeConfiguration<T extends FlexFieldSchema>(\n\tconfig: InitializeAndSchematizeConfiguration<T>,\n): InitializeAndSchematizeConfiguration<T> {\n\treturn config;\n}\n"]}
+{"version":3,"file":"schematizeTree.js","sourceRoot":"","sources":["../../src/shared-tree/schematizeTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA8E;AAE9E,+CAO0B;AAC1B,4DAUuC;AACvC,+CAAwC;AAIxC;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAChC,gBAGC,EACD,SAAyB,EACzB,cAA0B;IAE1B,IAAA,iBAAM,EACL,IAAA,4BAAiB,EAAC,gBAAgB,CAAC,YAAY,CAAC,EAChD,KAAK,CAAC,6CAA6C,CACnD,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,2BAAgB,EAAC,SAAS,CAAC,CAAC;IAC3C,MAAM,UAAU,GAAG,MAAM,CAAC,eAAe,CAAC;IAC1C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC;IAEjC,mJAAmJ;IACnJ,IAAI,uBAAyC,CAAC;IAC9C,IACC,QAAQ,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU;QAC3C,QAAQ,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,EAC1C;QACD,oEAAoE;QACpE,uBAAuB,GAAG,MAAM,CAAC;KACjC;SAAM;QACN,IAAA,iBAAM,EAAC,QAAQ,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACjF,8DAA8D;QAC9D,uBAAuB,GAAG;YACzB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,eAAe,EAAE;gBAChB,IAAI,EAAE,qBAAU,CAAC,QAAQ,CAAC,UAAU;gBACpC,KAAK,EAAE,UAAU,CAAC,KAAK;aACvB;SACD,CAAC;KACF;IAED,2DAA2D;IAC3D,UAAU;IACV,wFAAwF;IACxF,uEAAuE;IACvE,KAAK;IACL,IAAA,iBAAM,EACL,IAAA,6BAAkB,EAAC,8BAAmB,EAAE,MAAM,EAAE,uBAAuB,CAAC,EACxE,KAAK,CAAC,uFAAuF,CAC7F,CAAC;IACF,gCAAgC;IAChC,gBAAgB,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC;IACvD,sBAAsB;IACtB,cAAc,EAAE,CAAC;IAEjB,kFAAkF;IAClF,IAAI,uBAAuB,KAAK,MAAM,EAAE;QACvC,gBAAgB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;KACtC;AACF,CAAC;AAvDD,8CAuDC;AAED,IAAY,UAiBX;AAjBD,WAAY,UAAU;IACrB;;OAEG;IACH,2CAAI,CAAA;IACJ;;OAEG;IACH,uDAAU,CAAA;IACV;;OAEG;IACH,mEAAgB,CAAA;IAChB;;OAEG;IACH,2DAAY,CAAA;AACb,CAAC,EAjBW,UAAU,0BAAV,UAAU,QAiBrB;AAED,SAAgB,cAAc,CAC7B,UAAsB,EACtB,0BAA6C,EAC7C,QAAuB;IAEvB,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAE3E,IACC,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU;QAC/C,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,UAAU,EAC/C;QACD,mBAAmB;QACnB,OAAO,UAAU,CAAC,IAAI,CAAC;KACvB;IAED,sCAAsC;IACtC,IAAI,0BAA0B,GAAG,4BAAiB,CAAC,UAAU,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;QACzF,OAAO,UAAU,CAAC,UAAU,CAAC;KAC7B;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAAE;QACpD,iHAAiH;QACjH,OAAO,UAAU,CAAC,YAAY,CAAC;KAC/B;IAED,IAAA,iBAAM,EAAC,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,YAAY,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACxF,IAAA,iBAAM,EAAC,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAErF,sCAAsC;IACtC,OAAO,0BAA0B,GAAG,4BAAiB,CAAC,gBAAgB;QACrE,CAAC,CAAC,UAAU,CAAC,gBAAgB;QAC7B,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;AAC5B,CAAC;AAhCD,wCAgCC;AAED,SAAgB,aAAa,CAAC,QAAuB;IACpD,mBAAmB;IACnB,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,IAAI,IAAA,4BAAiB,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AAC5E,CAAC;AAHD,sCAGC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAC3B,UAAsB,EACtB,0BAA6C,EAC7C,QAAuB,EACvB,WAAoC;IAEpC,IAAI,qBAAqB,GAAG,0BAA0B,CAAC;IACvD,IAAI,WAAW,KAAK,SAAS,EAAE;QAC9B,4DAA4D;QAC5D,sCAAsC;QACtC,qBAAqB,IAAI,CAAC,4BAAiB,CAAC,UAAU,CAAC;KACvD;IACD,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,EAAE,qBAAqB,EAAE,QAAQ,CAAC,CAAC;IAClF,QAAQ,aAAa,EAAE;QACtB,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;SACZ;QACD,KAAK,UAAU,CAAC,YAAY,CAAC,CAAC;YAC7B,OAAO,KAAK,CAAC;SACb;QACD,KAAK,UAAU,CAAC,gBAAgB,CAAC,CAAC;YACjC,QAAQ,CAAC,YAAY,CAAC,IAAA,2BAAgB,EAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;SACZ;QACD,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC;YAC3B,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC9B,OAAO,KAAK,CAAC;aACb;YACD,QAAQ;YACR,sFAAsF;YACtF,iGAAiG;YAEjG,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YAC7B,iBAAiB,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE;gBACpD,MAAM,KAAK,GAAG,EAAE,KAAK,EAAE,uBAAY,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;gBACzD,MAAM,OAAO,GAAG,IAAA,mCAAwB,EACvC,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,EAC9B,WAAW,CAAC,MAAM,CAAC,eAAe,EAClC,WAAW,CAAC,WAAW,CACvB,CAAC;gBACF,QAAQ,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,EAAE;oBACnD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBACpC,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;wBACzD,IAAA,iBAAM,EACL,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,EAC7B,KAAK,CAAC,8DAA8D,CACpE,CAAC;wBACF,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;wBAC5E,MAAM;qBACN;oBACD,KAAK,qBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBACpC,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;wBACzD,2CAA2C;wBAC3C,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;wBAC/B,MAAM;qBACN;oBACD,OAAO,CAAC,CAAC;wBACR,IAAA,eAAI,EAAC,8CAA8C,CAAC,CAAC;qBACrD;iBACD;YACF,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YAE9B,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,CAAC,CAAC;YACR,IAAA,0BAAe,EAAC,aAAa,CAAC,CAAC;SAC/B;KACD;AACF,CAAC;AArED,oCAqEC;AAsDD;;;;;GAKG;AACH,SAAgB,sBAAsB,CACrC,MAA+C;IAE/C,OAAO,MAAM,CAAC;AACf,CAAC;AAJD,wDAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\n\nimport {\n\tAllowedUpdateType,\n\tCompatibility,\n\tITreeCursorSynchronous,\n\tTreeStoredSchema,\n\trootFieldKey,\n\tschemaDataIsEmpty,\n} from \"../core/index.js\";\nimport {\n\tFieldKinds,\n\tFlexFieldSchema,\n\tFlexTreeSchema,\n\tInsertableFlexField,\n\tViewSchema,\n\tallowsRepoSuperset,\n\tdefaultSchemaPolicy,\n\tintoStoredSchema,\n\tnormalizeNewFieldContent,\n} from \"../feature-libraries/index.js\";\nimport { fail } from \"../util/index.js\";\n\nimport { ITreeCheckout } from \"./treeCheckout.js\";\n\n/**\n * Modify `storedSchema` and invoke `setInitialTree` when it's time to set the tree content.\n *\n * Requires `storedSchema` to be in its default/empty state.\n *\n * This is done in such a way that if the content (implicitly assumed to start empty)\n * is never out of schema.\n * This means that if the root field of the new schema requires content (like a value field),\n * a temporary intermediate schema is used so the initial empty state is not out of schema.\n *\n * Since this makes multiple changes, callers may want to wrap it in a transaction.\n */\nexport function initializeContent(\n\tschemaRepository: {\n\t\tstoredSchema: ITreeCheckout[\"storedSchema\"];\n\t\tupdateSchema: ITreeCheckout[\"updateSchema\"];\n\t},\n\tnewSchema: FlexTreeSchema,\n\tsetInitialTree: () => void,\n): void {\n\tassert(\n\t\tschemaDataIsEmpty(schemaRepository.storedSchema),\n\t\t0x743 /* cannot initialize after a schema is set */,\n\t);\n\n\tconst schema = intoStoredSchema(newSchema);\n\tconst rootSchema = schema.rootFieldSchema;\n\tconst rootKind = rootSchema.kind;\n\n\t// To keep the data in schema during the update, first define a schema that tolerates the current (empty) tree as well as the final (initial) tree.\n\tlet incrementalSchemaUpdate: TreeStoredSchema;\n\tif (\n\t\trootKind === FieldKinds.sequence.identifier ||\n\t\trootKind === FieldKinds.optional.identifier\n\t) {\n\t\t// These kinds are known to tolerate empty, so use the schema as is:\n\t\tincrementalSchemaUpdate = schema;\n\t} else {\n\t\tassert(rootKind === FieldKinds.required.identifier, 0x5c8 /* Unexpected kind */);\n\t\t// Replace value kind with optional kind in root field schema:\n\t\tincrementalSchemaUpdate = {\n\t\t\tnodeSchema: schema.nodeSchema,\n\t\t\trootFieldSchema: {\n\t\t\t\tkind: FieldKinds.optional.identifier,\n\t\t\t\ttypes: rootSchema.types,\n\t\t\t},\n\t\t};\n\t}\n\n\t// TODO: fix issues with schema comparison and enable this.\n\t// assert(\n\t// \tallowsRepoSuperset(defaultSchemaPolicy, tree.storedSchema, incrementalSchemaUpdate),\n\t// \t\"Incremental Schema update should support the existing empty tree\",\n\t// );\n\tassert(\n\t\tallowsRepoSuperset(defaultSchemaPolicy, schema, incrementalSchemaUpdate),\n\t\t0x5c9 /* Incremental Schema during update should be a allow a superset of the final schema */,\n\t);\n\t// Update to intermediate schema\n\tschemaRepository.updateSchema(incrementalSchemaUpdate);\n\t// Insert initial tree\n\tsetInitialTree();\n\n\t// If intermediate schema is not final desired schema, update to the final schema:\n\tif (incrementalSchemaUpdate !== schema) {\n\t\tschemaRepository.updateSchema(schema);\n\t}\n}\n\nexport enum UpdateType {\n\t/**\n\t * Already compatible, no update needed.\n\t */\n\tNone,\n\t/**\n\t * Empty: needs initializing.\n\t */\n\tInitialize,\n\t/**\n\t * Schema can be upgraded leaving tree as is.\n\t */\n\tSchemaCompatible,\n\t/**\n\t * No update currently supported.\n\t */\n\tIncompatible,\n}\n\nexport function evaluateUpdate(\n\tviewSchema: ViewSchema,\n\tallowedSchemaModifications: AllowedUpdateType,\n\tcheckout: ITreeCheckout,\n): UpdateType {\n\tconst compatibility = viewSchema.checkCompatibility(checkout.storedSchema);\n\n\tif (\n\t\tcompatibility.read === Compatibility.Compatible &&\n\t\tcompatibility.write === Compatibility.Compatible\n\t) {\n\t\t// Compatible as is\n\t\treturn UpdateType.None;\n\t}\n\n\t// eslint-disable-next-line no-bitwise\n\tif (allowedSchemaModifications & AllowedUpdateType.Initialize && canInitialize(checkout)) {\n\t\treturn UpdateType.Initialize;\n\t}\n\n\tif (compatibility.read !== Compatibility.Compatible) {\n\t\t// Existing stored schema permits trees which are incompatible with the view schema, so schema can not be updated\n\t\treturn UpdateType.Incompatible;\n\t}\n\n\tassert(compatibility.write === Compatibility.Incompatible, 0x8bd /* unexpected case */);\n\tassert(compatibility.read === Compatibility.Compatible, 0x8be /* unexpected case */);\n\n\t// eslint-disable-next-line no-bitwise\n\treturn allowedSchemaModifications & AllowedUpdateType.SchemaCompatible\n\t\t? UpdateType.SchemaCompatible\n\t\t: UpdateType.Incompatible;\n}\n\nexport function canInitialize(checkout: ITreeCheckout): boolean {\n\t// Check for empty.\n\treturn checkout.forest.isEmpty && schemaDataIsEmpty(checkout.storedSchema);\n}\n\n/**\n * Ensure a {@link ITreeCheckout} can be used with a given {@link ViewSchema}.\n *\n * @remarks\n * It is up to the caller to ensure that compatibility is reevaluated if the checkout's stored schema is edited in the future.\n *\n * @param viewSchema - View schema that `checkout` should be made compatible with.\n * @param allowedSchemaModifications - Flags enum describing the ways this is allowed to modify `checkout`.\n * @param checkout - To be modified as needed to be compatible with `viewSchema`.\n * @param treeContent - Content to be used to initialize `checkout`'s the tree if needed and allowed.\n * @returns true iff checkout now is compatible with `viewSchema`.\n */\nexport function ensureSchema(\n\tviewSchema: ViewSchema,\n\tallowedSchemaModifications: AllowedUpdateType,\n\tcheckout: ITreeCheckout,\n\ttreeContent: TreeContent | undefined,\n): boolean {\n\tlet possibleModifications = allowedSchemaModifications;\n\tif (treeContent === undefined) {\n\t\t// Clear bit for Initialize if initial tree is not provided.\n\t\t// eslint-disable-next-line no-bitwise\n\t\tpossibleModifications &= ~AllowedUpdateType.Initialize;\n\t}\n\tconst updatedNeeded = evaluateUpdate(viewSchema, possibleModifications, checkout);\n\tswitch (updatedNeeded) {\n\t\tcase UpdateType.None: {\n\t\t\treturn true;\n\t\t}\n\t\tcase UpdateType.Incompatible: {\n\t\t\treturn false;\n\t\t}\n\t\tcase UpdateType.SchemaCompatible: {\n\t\t\tcheckout.updateSchema(intoStoredSchema(viewSchema.schema));\n\t\t\treturn true;\n\t\t}\n\t\tcase UpdateType.Initialize: {\n\t\t\tif (treeContent === undefined) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t\t// TODO:\n\t\t\t// When this becomes a more proper out of schema adapter, editing should be made lazy.\n\t\t\t// This will improve support for readonly documents, cross version collaboration and attribution.\n\n\t\t\tcheckout.transaction.start();\n\t\t\tinitializeContent(checkout, treeContent.schema, () => {\n\t\t\t\tconst field = { field: rootFieldKey, parent: undefined };\n\t\t\t\tconst content = normalizeNewFieldContent(\n\t\t\t\t\t{ schema: treeContent.schema },\n\t\t\t\t\ttreeContent.schema.rootFieldSchema,\n\t\t\t\t\ttreeContent.initialTree,\n\t\t\t\t);\n\t\t\t\tswitch (checkout.storedSchema.rootFieldSchema.kind) {\n\t\t\t\t\tcase FieldKinds.optional.identifier: {\n\t\t\t\t\t\tconst fieldEditor = checkout.editor.optionalField(field);\n\t\t\t\t\t\tassert(\n\t\t\t\t\t\t\tcontent.getFieldLength() <= 1,\n\t\t\t\t\t\t\t0x7f4 /* optional field content should normalize at most one item */,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tfieldEditor.set(content.getFieldLength() === 0 ? undefined : content, true);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tcase FieldKinds.sequence.identifier: {\n\t\t\t\t\t\tconst fieldEditor = checkout.editor.sequenceField(field);\n\t\t\t\t\t\t// TODO: should do an idempotent edit here.\n\t\t\t\t\t\tfieldEditor.insert(0, content);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\t}\n\t\t\t\t\tdefault: {\n\t\t\t\t\t\tfail(\"unexpected root field kind during initialize\");\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t});\n\t\t\tcheckout.transaction.commit();\n\n\t\t\treturn true;\n\t\t}\n\t\tdefault: {\n\t\t\tunreachableCase(updatedNeeded);\n\t\t}\n\t}\n}\n\n/**\n * View Schema for a `SharedTree`.\n *\n * @internal\n */\nexport interface SchemaConfiguration<TRoot extends FlexFieldSchema = FlexFieldSchema> {\n\t/**\n\t * The schema which the application wants to view the tree with.\n\t */\n\treadonly schema: FlexTreeSchema<TRoot>;\n}\n\n/**\n * Content that can populate a `SharedTree`.\n *\n * @internal\n */\nexport interface TreeContent<TRoot extends FlexFieldSchema = FlexFieldSchema>\n\textends SchemaConfiguration<TRoot> {\n\t/**\n\t * Default tree content to initialize the tree with iff the tree is uninitialized\n\t * (meaning it does not even have any schema set at all).\n\t */\n\treadonly initialTree:\n\t\t| InsertableFlexField<TRoot>\n\t\t| readonly ITreeCursorSynchronous[]\n\t\t| ITreeCursorSynchronous;\n}\n\n/**\n * Options used to schematize a `SharedTree`.\n *\n * @internal\n */\nexport interface SchematizeConfiguration<TRoot extends FlexFieldSchema = FlexFieldSchema>\n\textends SchemaConfiguration<TRoot> {\n\t/**\n\t * Controls if and how schema from existing documents can be updated to accommodate the view schema.\n\t */\n\treadonly allowedSchemaModifications: AllowedUpdateType;\n}\n\n/**\n * Options used to initialize (if needed) and schematize a `SharedTree`.\n *\n * @internal\n */\nexport interface InitializeAndSchematizeConfiguration<\n\tTRoot extends FlexFieldSchema = FlexFieldSchema,\n> extends TreeContent<TRoot>,\n\t\tSchematizeConfiguration<TRoot> {}\n\n/**\n * Options used to initialize (if needed) and schematize a `SharedTree`.\n * @remarks\n * Using this builder improves type safety and error quality over just constructing the configuration as a object.\n * @internal\n */\nexport function buildTreeConfiguration<T extends FlexFieldSchema>(\n\tconfig: InitializeAndSchematizeConfiguration<T>,\n): InitializeAndSchematizeConfiguration<T> {\n\treturn config;\n}\n"]}

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

@@ -1,15 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
 import { FieldKey } from "../core/index.js";
-import { FlexFieldSchema, ViewSchema, NodeKeyManager } from "../feature-libraries/index.js";
 import { HasListeners, IEmitter, ISubscribable } from "../events/index.js";
+import { FlexFieldSchema, NodeKeyManager, ViewSchema } from "../feature-libraries/index.js";
+import { ImplicitFieldSchema, InsertableTreeFieldFromImplicitField, SchemaIncompatible, TreeConfiguration, TreeFieldFromImplicitField, TreeView, TreeViewEvents } from "../simple-tree/index.js";
 import { disposeSymbol } from "../util/index.js";
-import { TreeConfiguration, ImplicitFieldSchema, TreeFieldFromImplicitField, TreeView, TreeViewEvents, SchemaIncompatible } from "../simple-tree/index.js";
 import { UpdateType } from "./schematizeTree.js";
 import { TreeCheckout } from "./treeCheckout.js";
 import { CheckoutFlexTreeView } from "./treeView.js";
 /**
  * Implementation of TreeView wrapping a FlexTreeView.
  */
-export declare class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitFieldSchema> implements TreeView<TreeFieldFromImplicitField<TRootSchema>> {
+export declare class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitFieldSchema> implements TreeView<TRootSchema> {
     readonly checkout: TreeCheckout;
     readonly config: TreeConfiguration<TRootSchema>;
     readonly nodeKeyManager: NodeKeyManager;
@@ -24,7 +28,9 @@ export declare class SchematizingSimpleTreeView<in out TRootSchema extends Impli
     private readonly flexConfig;
     readonly events: ISubscribable<TreeViewEvents> & IEmitter<TreeViewEvents> & HasListeners<TreeViewEvents>;
     private readonly viewSchema;
+    private readonly unregisterCallbacks;
     private disposed;
+    private readonly rootFieldSchema;
     constructor(checkout: TreeCheckout, config: TreeConfiguration<TRootSchema>, nodeKeyManager: NodeKeyManager, nodeKeyFieldKey: FieldKey);
     upgradeSchema(): void;
     /**
@@ -45,6 +51,7 @@ export declare class SchematizingSimpleTreeView<in out TRootSchema extends Impli
     get error(): SchematizeError | undefined;
     [disposeSymbol](): void;
     get root(): TreeFieldFromImplicitField<TRootSchema>;
+    set root(newRoot: InsertableTreeFieldFromImplicitField<TRootSchema>);
 }
 export declare class SchematizeError implements SchemaIncompatible {
     readonly updateType: UpdateType;

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

@@ -1 +1 @@
-{"version":3,"file":"schematizingTreeView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizingTreeView.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAgD,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAEN,eAAe,EACf,UAAU,EACV,cAAc,EACd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAiB,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EACN,iBAAiB,EAEjB,mBAAmB,EACnB,0BAA0B,EAC1B,QAAQ,EACR,cAAc,EAEd,kBAAkB,EAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAe,UAAU,EAAgC,MAAM,qBAAqB,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD;;GAEG;AACH,qBAAa,0BAA0B,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,SAAS,mBAAmB,CACrF,YAAW,QAAQ,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;aAmB3C,QAAQ,EAAE,YAAY;aACtB,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC;aACtC,cAAc,EAAE,cAAc;aAC9B,eAAe,EAAE,QAAQ;IApB1C;;;;;OAKG;IACH,OAAO,CAAC,IAAI,CAAsE;IAClF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IACzC,SAAgB,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,GACpD,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC,CAAmB;IAEhD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAExC,OAAO,CAAC,QAAQ,CAAS;gBAGR,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,EACtC,cAAc,EAAE,cAAc,EAC9B,eAAe,EAAE,QAAQ;IAOnC,aAAa,IAAI,IAAI;IAyB5B;;;OAGG;IACI,cAAc,IAAI,oBAAoB,CAAC,eAAe,CAAC,GAAG,eAAe;IAQhF;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM;IA6Dd,OAAO,CAAC,WAAW;IAOnB,IAAW,KAAK,IAAI,eAAe,GAAG,SAAS,CAG9C;IAEM,CAAC,aAAa,CAAC,IAAI,IAAI;IAM9B,IAAW,IAAI,IAAI,0BAA0B,CAAC,WAAW,CAAC,CAQzD;CACD;AAED,qBAAa,eAAgB,YAAW,kBAAkB;aACtB,UAAU,EAAE,UAAU;gBAAtB,UAAU,EAAE,UAAU;IAEzD,IAAW,UAAU,IAAI,OAAO,CAK/B;IAED,IAAW,aAAa,IAAI,OAAO,CAElC;CACD;AAWD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,SAAS,eAAe,EAC1D,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,EAC7B,SAAS,EAAE,MAAM,IAAI,EACrB,cAAc,EAAE,cAAc,EAC9B,eAAe,EAAE,QAAQ,GACvB,oBAAoB,CAAC,KAAK,CAAC,CAuC7B"}
+{"version":3,"file":"schematizingTreeView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizingTreeView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAoC,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAiB,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EACN,eAAe,EACf,cAAc,EACd,UAAU,EAGV,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAEN,mBAAmB,EACnB,oCAAoC,EACpC,kBAAkB,EAClB,iBAAiB,EACjB,0BAA0B,EAC1B,QAAQ,EACR,cAAc,EAMd,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAe,UAAU,EAAgC,MAAM,qBAAqB,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD;;GAEG;AACH,qBAAa,0BAA0B,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,SAAS,mBAAmB,CACrF,YAAW,QAAQ,CAAC,WAAW,CAAC;aAsBf,QAAQ,EAAE,YAAY;aACtB,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC;aACtC,cAAc,EAAE,cAAc;aAC9B,eAAe,EAAE,QAAQ;IAvB1C;;;;;OAKG;IACH,OAAO,CAAC,IAAI,CAAsE;IAClF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IACzC,SAAgB,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,GACpD,QAAQ,CAAC,cAAc,CAAC,GACxB,YAAY,CAAC,cAAc,CAAC,CAAmB;IAEhD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAExC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAyB;IAC7D,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAc;gBAG7B,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,EACtC,cAAc,EAAE,cAAc,EAC9B,eAAe,EAAE,QAAQ;IAcnC,aAAa,IAAI,IAAI;IAyB5B;;;OAGG;IACI,cAAc,IAAI,oBAAoB,CAAC,eAAe,CAAC,GAAG,eAAe;IAQhF;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM;IA+Dd,OAAO,CAAC,WAAW;IAQnB,IAAW,KAAK,IAAI,eAAe,GAAG,SAAS,CAG9C;IAEM,CAAC,aAAa,CAAC,IAAI,IAAI;IAM9B,IAAW,IAAI,IAAI,0BAA0B,CAAC,WAAW,CAAC,CAQzD;IAED,IAAW,IAAI,CAAC,OAAO,EAAE,oCAAoC,CAAC,WAAW,CAAC,EASzE;CACD;AAED,qBAAa,eAAgB,YAAW,kBAAkB;aACtB,UAAU,EAAE,UAAU;gBAAtB,UAAU,EAAE,UAAU;IAEzD,IAAW,UAAU,IAAI,OAAO,CAK/B;IAED,IAAW,aAAa,IAAI,OAAO,CAElC;CACD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,SAAS,eAAe,EAC1D,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,EAC7B,SAAS,EAAE,MAAM,IAAI,EACrB,cAAc,EAAE,cAAc,EAC9B,eAAe,EAAE,QAAQ,GACvB,oBAAoB,CAAC,KAAK,CAAC,CAkC7B"}

package/dist/shared-tree/schematizingTreeView.js

@@ -1,17 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requireSchema = exports.SchematizeError = exports.SchematizingSimpleTreeView = void 0;
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-const core_utils_1 = require("@fluidframework/core-utils");
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireSchema = exports.SchematizeError = exports.SchematizingSimpleTreeView = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/telemetry-utils/internal");
 const index_js_1 = require("../core/index.js");
-const index_js_2 = require("../feature-libraries/index.js");
-const index_js_3 = require("../events/index.js");
-const index_js_4 = require("../util/index.js");
-const index_js_5 = require("../simple-tree/index.js");
+const index_js_2 = require("../events/index.js");
+const index_js_3 = require("../feature-libraries/index.js");
+const index_js_4 = require("../simple-tree/index.js");
+const index_js_5 = require("../util/index.js");
 const schematizeTree_js_1 = require("./schematizeTree.js");
 const treeView_js_1 = require("./treeView.js");
 /**
@@ -23,11 +23,14 @@ class SchematizingSimpleTreeView {
         this.config = config;
         this.nodeKeyManager = nodeKeyManager;
         this.nodeKeyFieldKey = nodeKeyFieldKey;
-        this.events = (0, index_js_3.createEmitter)();
+        this.events = (0, index_js_2.createEmitter)();
+        this.unregisterCallbacks = new Set();
         this.disposed = false;
-        this.flexConfig = (0, index_js_5.toFlexConfig)(config);
-        this.viewSchema = new index_js_2.ViewSchema(index_js_2.defaultSchemaPolicy, {}, this.flexConfig.schema);
+        this.rootFieldSchema = (0, index_js_4.normalizeFieldSchema)(config.schema);
+        this.flexConfig = (0, index_js_4.toFlexConfig)(config);
+        this.viewSchema = new index_js_3.ViewSchema(index_js_3.defaultSchemaPolicy, {}, this.flexConfig.schema);
         this.update();
+        this.unregisterCallbacks.add(this.checkout.events.on("commitApplied", (data, getRevertible) => this.events.emit("commitApplied", data, getRevertible)));
     }
     upgradeSchema() {
         // Errors if disposed.
@@ -37,12 +40,12 @@ class SchematizingSimpleTreeView {
             return;
         }
         if (this.error?.canUpgrade !== true) {
-            throw new telemetry_utils_1.UsageError("Existing stored schema can not be upgraded (see TreeView.canUpgrade).");
+            throw new internal_2.UsageError("Existing stored schema can not be upgraded (see TreeView.canUpgrade).");
         }
         const result = (0, schematizeTree_js_1.ensureSchema)(this.viewSchema, 
         // eslint-disable-next-line no-bitwise
         index_js_1.AllowedUpdateType.SchemaCompatible | index_js_1.AllowedUpdateType.Initialize, this.checkout, this.flexConfig);
-        (0, core_utils_1.assert)(result, 0x8bf /* Schema upgrade should always work if canUpgrade is set. */);
+        (0, internal_1.assert)(result, 0x8bf /* Schema upgrade should always work if canUpgrade is set. */);
     }
     /**
      * Gets the view is the stored schema is compatible with the view schema,
@@ -50,9 +53,9 @@ class SchematizingSimpleTreeView {
      */
     getViewOrError() {
         if (this.disposed) {
-            throw new telemetry_utils_1.UsageError("Accessed a disposed TreeView.");
+            throw new internal_2.UsageError("Accessed a disposed TreeView.");
         }
-        (0, core_utils_1.assert)(this.view !== undefined, 0x8c0 /* unexpected getViewOrError */);
+        (0, internal_1.assert)(this.view !== undefined, 0x8c0 /* unexpected getViewOrError */);
         return this.view;
     }
     /**
@@ -74,7 +77,7 @@ class SchematizingSimpleTreeView {
             case schematizeTree_js_1.UpdateType.None: {
                 // Remove event from checkout when view is disposed
                 this.view = requireSchema(this.checkout, this.viewSchema, () => {
-                    (0, core_utils_1.assert)(cleanupCheckOutEvents !== undefined, 0x8c1 /* missing cleanup */);
+                    (0, internal_1.assert)(cleanupCheckOutEvents !== undefined, 0x8c1 /* missing cleanup */);
                     cleanupCheckOutEvents();
                     this.view = undefined;
                     if (!this.disposed) {
@@ -102,27 +105,30 @@ class SchematizingSimpleTreeView {
                 this.view = new SchematizeError(compatibility);
                 const unregister = this.checkout.storedSchema.on("afterSchemaChange", () => {
                     unregister();
+                    this.unregisterCallbacks.delete(unregister);
                     this.update();
                 });
+                this.unregisterCallbacks.add(unregister);
                 break;
             }
             default: {
-                (0, core_utils_1.unreachableCase)(compatibility);
+                (0, internal_1.unreachableCase)(compatibility);
             }
         }
         this.events.emit("rootChanged");
     }
     disposeView() {
         if (this.view !== undefined && !(this.view instanceof SchematizeError)) {
-            this.view[index_js_4.disposeSymbol]();
+            this.view[index_js_5.disposeSymbol]();
             this.view = undefined;
+            this.unregisterCallbacks.forEach((unregister) => unregister());
         }
     }
     get error() {
         const view = this.getViewOrError();
         return view instanceof SchematizeError ? view : undefined;
     }
-    [index_js_4.disposeSymbol]() {
+    [index_js_5.disposeSymbol]() {
         this.getViewOrError();
         this.disposed = true;
         this.disposeView();
@@ -130,9 +136,16 @@ class SchematizingSimpleTreeView {
     get root() {
         const view = this.getViewOrError();
         if (view instanceof SchematizeError) {
-            throw new telemetry_utils_1.UsageError("Document is out of schema. Check TreeView.error before accessing TreeView.root.");
+            throw new internal_2.UsageError("Document is out of schema. Check TreeView.error before accessing TreeView.root.");
         }
-        return (0, index_js_5.getProxyForField)(view.flexTree);
+        return (0, index_js_4.getProxyForField)(view.flexTree);
+    }
+    set root(newRoot) {
+        const view = this.getViewOrError();
+        if (view instanceof SchematizeError) {
+            throw new internal_2.UsageError("Document is out of schema. Check TreeView.error before accessing TreeView.root.");
+        }
+        (0, index_js_4.setField)(view.context.root, this.rootFieldSchema, newRoot);
     }
 }
 exports.SchematizingSimpleTreeView = SchematizingSimpleTreeView;
@@ -149,14 +162,6 @@ class SchematizeError {
     }
 }
 exports.SchematizeError = SchematizeError;
-/**
- * Creating multiple flex tree contexts for the same branch, and thus with the same underlying AnchorSet does not work due to how TreeNode caching works.
- * This slot is used to detect if one already exists and error if creating a second.
- *
- * TODO:
- * 1. API docs need to reflect this limitation or the limitation has to be removed.
- */
-const ViewSlot = (0, index_js_1.anchorSlot)();
 /**
  * Flex-Tree schematizing layer.
  * Creates a view that self-disposes when stored schema becomes incompatible.
@@ -164,25 +169,20 @@ const ViewSlot = (0, index_js_1.anchorSlot)();
  */
 function requireSchema(checkout, viewSchema, onDispose, nodeKeyManager, nodeKeyFieldKey) {
     const slots = checkout.forest.anchors.slots;
-    (0, core_utils_1.assert)(!slots.has(ViewSlot), 0x8c2 /* Cannot create second view from checkout */);
+    (0, internal_1.assert)(!slots.has(index_js_3.ContextSlot), 0x8c2 /* Cannot create second view from checkout */);
     {
         const compatibility = viewSchema.checkCompatibility(checkout.storedSchema);
-        (0, core_utils_1.assert)(compatibility.write === index_js_1.Compatibility.Compatible &&
+        (0, internal_1.assert)(compatibility.write === index_js_1.Compatibility.Compatible &&
             compatibility.read === index_js_1.Compatibility.Compatible, 0x8c3 /* requireSchema invoked with incompatible schema */);
     }
-    const view = new treeView_js_1.CheckoutFlexTreeView(checkout, viewSchema.schema, nodeKeyManager, nodeKeyFieldKey, () => {
-        const deleted = slots.delete(ViewSlot);
-        (0, core_utils_1.assert)(deleted, 0x8c4 /* unexpected dispose */);
-        onDispose();
-    });
-    (0, core_utils_1.assert)(!slots.has(ViewSlot), 0x8c5 /* Cannot create second view from checkout */);
-    slots.set(ViewSlot, view);
+    const view = new treeView_js_1.CheckoutFlexTreeView(checkout, viewSchema.schema, nodeKeyManager, nodeKeyFieldKey, onDispose);
+    (0, internal_1.assert)(slots.has(index_js_3.ContextSlot), 0x90d /* Context should be tracked in slot */);
     const unregister = checkout.storedSchema.on("afterSchemaChange", () => {
         const compatibility = viewSchema.checkCompatibility(checkout.storedSchema);
         if (compatibility.write !== index_js_1.Compatibility.Compatible ||
             compatibility.read !== index_js_1.Compatibility.Compatible) {
             unregister();
-            view[index_js_4.disposeSymbol]();
+            view[index_js_5.disposeSymbol]();
         }
     });
     return view;