@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/index.js

@@ -0,0 +1,133 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaBuilderBase = exports.ObjectNodeSchema = exports.MapNodeSchema = exports.LeafNodeSchema = exports.FieldNodeSchema = exports.TreeNodeSchemaBase = exports.TreeStatus = exports.nodeKeyFieldKey = exports.cursorForTypedTreeData = exports.Any = exports.TreeFieldSchema = exports.cursorFromContextualData = exports.FieldKinds = exports.InternalTypedSchemaTypes = exports.stackTreeNodeCursor = exports.singleTextCursor = exports.prefixFieldPath = exports.prefixPath = exports.compareLocalNodeKeys = exports.jsonableTreeFromCursor = exports.defaultSchemaPolicy = exports.isContextuallyTypedNodeDataObject = exports.valueSymbol = exports.typeNameSymbol = exports.isNeverField = exports.Multiplicity = exports.FieldKind = exports.leaf = exports.createEmitter = exports.disposeSymbol = exports.oneFromSet = exports.TransactionResult = exports.fail = exports.brand = exports.extractFromOpaque = exports.forbiddenFieldKindIdentifier = exports.DiscardResult = exports.RevertResult = exports.RevertibleKind = exports.AllowedUpdateType = exports.anchorSlot = exports.TreeNodeStoredSchema = exports.ValueSchema = exports.ITreeSubscriptionCursorState = exports.TreeNavigationResult = exports.CursorLocationType = exports.rootField = exports.rootFieldKey = exports.AnchorSet = exports.EmptyKey = void 0;
+exports.FlexTreeEntityKind = exports.flexTreeMarker = exports.ErasedType = exports.BrandedType = exports.InternalTypes = exports.typeboxValidator = exports.noopValidator = exports.TreeFactory = exports.SharedTree = exports.test_RecursiveObject_base = exports.test_RecursiveObject = exports.typedObjectValues = exports.singletonSchema = exports.enumFromStrings = exports.adaptEnum = exports.Tree = exports.SchemaFactory = exports.TreeConfiguration = exports.buildTreeConfiguration = exports.ForestType = exports.SharedTreeFactory = exports.runSynchronous = exports.TreeNode = exports.IterableTreeListContent = exports.TreeArrayNode = exports.stackTreeFieldCursor = exports.encodeTreeSchema = exports.treeSchemaFromStoredSchema = exports.TreeCompressionStrategy = exports.schemaIsObjectNode = exports.schemaIsMap = exports.schemaIsLeaf = exports.schemaIsFieldNode = void 0;
+var core_1 = require("./core");
+Object.defineProperty(exports, "EmptyKey", { enumerable: true, get: function () { return core_1.EmptyKey; } });
+Object.defineProperty(exports, "AnchorSet", { enumerable: true, get: function () { return core_1.AnchorSet; } });
+Object.defineProperty(exports, "rootFieldKey", { enumerable: true, get: function () { return core_1.rootFieldKey; } });
+Object.defineProperty(exports, "rootField", { enumerable: true, get: function () { return core_1.rootField; } });
+Object.defineProperty(exports, "CursorLocationType", { enumerable: true, get: function () { return core_1.CursorLocationType; } });
+Object.defineProperty(exports, "TreeNavigationResult", { enumerable: true, get: function () { return core_1.TreeNavigationResult; } });
+Object.defineProperty(exports, "ITreeSubscriptionCursorState", { enumerable: true, get: function () { return core_1.ITreeSubscriptionCursorState; } });
+Object.defineProperty(exports, "ValueSchema", { enumerable: true, get: function () { return core_1.ValueSchema; } });
+Object.defineProperty(exports, "TreeNodeStoredSchema", { enumerable: true, get: function () { return core_1.TreeNodeStoredSchema; } });
+Object.defineProperty(exports, "anchorSlot", { enumerable: true, get: function () { return core_1.anchorSlot; } });
+Object.defineProperty(exports, "AllowedUpdateType", { enumerable: true, get: function () { return core_1.AllowedUpdateType; } });
+Object.defineProperty(exports, "RevertibleKind", { enumerable: true, get: function () { return core_1.RevertibleKind; } });
+Object.defineProperty(exports, "RevertResult", { enumerable: true, get: function () { return core_1.RevertResult; } });
+Object.defineProperty(exports, "DiscardResult", { enumerable: true, get: function () { return core_1.DiscardResult; } });
+Object.defineProperty(exports, "forbiddenFieldKindIdentifier", { enumerable: true, get: function () { return core_1.forbiddenFieldKindIdentifier; } });
+var util_1 = require("./util");
+Object.defineProperty(exports, "extractFromOpaque", { enumerable: true, get: function () { return util_1.extractFromOpaque; } });
+Object.defineProperty(exports, "brand", { enumerable: true, get: function () { return util_1.brand; } });
+Object.defineProperty(exports, "fail", { enumerable: true, get: function () { return util_1.fail; } });
+Object.defineProperty(exports, "TransactionResult", { enumerable: true, get: function () { return util_1.TransactionResult; } });
+Object.defineProperty(exports, "oneFromSet", { enumerable: true, get: function () { return util_1.oneFromSet; } });
+Object.defineProperty(exports, "disposeSymbol", { enumerable: true, get: function () { return util_1.disposeSymbol; } });
+var events_1 = require("./events");
+Object.defineProperty(exports, "createEmitter", { enumerable: true, get: function () { return events_1.createEmitter; } });
+var domains_1 = require("./domains");
+Object.defineProperty(exports, "leaf", { enumerable: true, get: function () { return domains_1.leaf; } });
+var feature_libraries_1 = require("./feature-libraries");
+Object.defineProperty(exports, "FieldKind", { enumerable: true, get: function () { return feature_libraries_1.FieldKind; } });
+Object.defineProperty(exports, "Multiplicity", { enumerable: true, get: function () { return feature_libraries_1.Multiplicity; } });
+Object.defineProperty(exports, "isNeverField", { enumerable: true, get: function () { return feature_libraries_1.isNeverField; } });
+Object.defineProperty(exports, "typeNameSymbol", { enumerable: true, get: function () { return feature_libraries_1.typeNameSymbol; } });
+Object.defineProperty(exports, "valueSymbol", { enumerable: true, get: function () { return feature_libraries_1.valueSymbol; } });
+Object.defineProperty(exports, "isContextuallyTypedNodeDataObject", { enumerable: true, get: function () { return feature_libraries_1.isContextuallyTypedNodeDataObject; } });
+Object.defineProperty(exports, "defaultSchemaPolicy", { enumerable: true, get: function () { return feature_libraries_1.defaultSchemaPolicy; } });
+Object.defineProperty(exports, "jsonableTreeFromCursor", { enumerable: true, get: function () { return feature_libraries_1.jsonableTreeFromCursor; } });
+Object.defineProperty(exports, "compareLocalNodeKeys", { enumerable: true, get: function () { return feature_libraries_1.compareLocalNodeKeys; } });
+Object.defineProperty(exports, "prefixPath", { enumerable: true, get: function () { return feature_libraries_1.prefixPath; } });
+Object.defineProperty(exports, "prefixFieldPath", { enumerable: true, get: function () { return feature_libraries_1.prefixFieldPath; } });
+Object.defineProperty(exports, "singleTextCursor", { enumerable: true, get: function () { return feature_libraries_1.cursorForJsonableTreeNode; } });
+Object.defineProperty(exports, "stackTreeNodeCursor", { enumerable: true, get: function () { return feature_libraries_1.stackTreeNodeCursor; } });
+Object.defineProperty(exports, "InternalTypedSchemaTypes", { enumerable: true, get: function () { return feature_libraries_1.InternalTypedSchemaTypes; } });
+Object.defineProperty(exports, "FieldKinds", { enumerable: true, get: function () { return feature_libraries_1.FieldKinds; } });
+Object.defineProperty(exports, "cursorFromContextualData", { enumerable: true, get: function () { return feature_libraries_1.cursorFromContextualData; } });
+Object.defineProperty(exports, "TreeFieldSchema", { enumerable: true, get: function () { return feature_libraries_1.TreeFieldSchema; } });
+Object.defineProperty(exports, "Any", { enumerable: true, get: function () { return feature_libraries_1.Any; } });
+Object.defineProperty(exports, "cursorForTypedTreeData", { enumerable: true, get: function () { return feature_libraries_1.cursorForTypedTreeData; } });
+Object.defineProperty(exports, "nodeKeyFieldKey", { enumerable: true, get: function () { return feature_libraries_1.nodeKeyFieldKey; } });
+Object.defineProperty(exports, "TreeStatus", { enumerable: true, get: function () { return feature_libraries_1.TreeStatus; } });
+Object.defineProperty(exports, "TreeNodeSchemaBase", { enumerable: true, get: function () { return feature_libraries_1.TreeNodeSchemaBase; } });
+Object.defineProperty(exports, "FieldNodeSchema", { enumerable: true, get: function () { return feature_libraries_1.FieldNodeSchema; } });
+Object.defineProperty(exports, "LeafNodeSchema", { enumerable: true, get: function () { return feature_libraries_1.LeafNodeSchema; } });
+Object.defineProperty(exports, "MapNodeSchema", { enumerable: true, get: function () { return feature_libraries_1.MapNodeSchema; } });
+Object.defineProperty(exports, "ObjectNodeSchema", { enumerable: true, get: function () { return feature_libraries_1.ObjectNodeSchema; } });
+Object.defineProperty(exports, "SchemaBuilderBase", { enumerable: true, get: function () { return feature_libraries_1.SchemaBuilderBase; } });
+Object.defineProperty(exports, "schemaIsFieldNode", { enumerable: true, get: function () { return feature_libraries_1.schemaIsFieldNode; } });
+Object.defineProperty(exports, "schemaIsLeaf", { enumerable: true, get: function () { return feature_libraries_1.schemaIsLeaf; } });
+Object.defineProperty(exports, "schemaIsMap", { enumerable: true, get: function () { return feature_libraries_1.schemaIsMap; } });
+Object.defineProperty(exports, "schemaIsObjectNode", { enumerable: true, get: function () { return feature_libraries_1.schemaIsObjectNode; } });
+Object.defineProperty(exports, "TreeCompressionStrategy", { enumerable: true, get: function () { return feature_libraries_1.TreeCompressionStrategy; } });
+Object.defineProperty(exports, "treeSchemaFromStoredSchema", { enumerable: true, get: function () { return feature_libraries_1.treeSchemaFromStoredSchema; } });
+Object.defineProperty(exports, "encodeTreeSchema", { enumerable: true, get: function () { return feature_libraries_1.encodeTreeSchema; } });
+Object.defineProperty(exports, "stackTreeFieldCursor", { enumerable: true, get: function () { return feature_libraries_1.stackTreeFieldCursor; } });
+var simple_tree_1 = require("./simple-tree");
+Object.defineProperty(exports, "TreeArrayNode", { enumerable: true, get: function () { return simple_tree_1.TreeArrayNode; } });
+Object.defineProperty(exports, "IterableTreeListContent", { enumerable: true, get: function () { return simple_tree_1.IterableTreeListContent; } });
+Object.defineProperty(exports, "TreeNode", { enumerable: true, get: function () { return simple_tree_1.TreeNode; } });
+var shared_tree_1 = require("./shared-tree");
+Object.defineProperty(exports, "runSynchronous", { enumerable: true, get: function () { return shared_tree_1.runSynchronous; } });
+Object.defineProperty(exports, "SharedTreeFactory", { enumerable: true, get: function () { return shared_tree_1.SharedTreeFactory; } });
+Object.defineProperty(exports, "ForestType", { enumerable: true, get: function () { return shared_tree_1.ForestType; } });
+Object.defineProperty(exports, "buildTreeConfiguration", { enumerable: true, get: function () { return shared_tree_1.buildTreeConfiguration; } });
+var class_tree_1 = require("./class-tree");
+Object.defineProperty(exports, "TreeConfiguration", { enumerable: true, get: function () { return class_tree_1.TreeConfiguration; } });
+Object.defineProperty(exports, "SchemaFactory", { enumerable: true, get: function () { return class_tree_1.SchemaFactory; } });
+Object.defineProperty(exports, "Tree", { enumerable: true, get: function () { return class_tree_1.Tree; } });
+// experimental @internal APIs:
+Object.defineProperty(exports, "adaptEnum", { enumerable: true, get: function () { return class_tree_1.adaptEnum; } });
+Object.defineProperty(exports, "enumFromStrings", { enumerable: true, get: function () { return class_tree_1.enumFromStrings; } });
+Object.defineProperty(exports, "singletonSchema", { enumerable: true, get: function () { return class_tree_1.singletonSchema; } });
+Object.defineProperty(exports, "typedObjectValues", { enumerable: true, get: function () { return class_tree_1.typedObjectValues; } });
+// test recursive schema for checking that d.ts files handles schema correctly
+Object.defineProperty(exports, "test_RecursiveObject", { enumerable: true, get: function () { return class_tree_1.test_RecursiveObject; } });
+Object.defineProperty(exports, "test_RecursiveObject_base", { enumerable: true, get: function () { return class_tree_1.test_RecursiveObject_base; } });
+var treeFactory_1 = require("./treeFactory");
+Object.defineProperty(exports, "SharedTree", { enumerable: true, get: function () { return treeFactory_1.SharedTree; } });
+Object.defineProperty(exports, "TreeFactory", { enumerable: true, get: function () { return treeFactory_1.TreeFactory; } });
+var codec_1 = require("./codec");
+Object.defineProperty(exports, "noopValidator", { enumerable: true, get: function () { return codec_1.noopValidator; } });
+var external_utilities_1 = require("./external-utilities");
+Object.defineProperty(exports, "typeboxValidator", { enumerable: true, get: function () { return external_utilities_1.typeboxValidator; } });
+// Below here are things that are used by the above, but not part of the desired API surface.
+const InternalTypes = __importStar(require("./internal"));
+exports.InternalTypes = InternalTypes;
+// TODO: When previously tagged '@internal', these types could not be included in `InternalClassTreeTypes` due to https://github.com/microsoft/rushstack/issues/3639
+var util_2 = require("./util");
+Object.defineProperty(exports, "BrandedType", { enumerable: true, get: function () { return util_2.BrandedType; } });
+Object.defineProperty(exports, "ErasedType", { enumerable: true, get: function () { return util_2.ErasedType; } });
+var feature_libraries_2 = require("./feature-libraries");
+Object.defineProperty(exports, "flexTreeMarker", { enumerable: true, get: function () { return feature_libraries_2.flexTreeMarker; } });
+Object.defineProperty(exports, "FlexTreeEntityKind", { enumerable: true, get: function () { return feature_libraries_2.FlexTreeEntityKind; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+BAqFgB;AApFf,gGAAA,QAAQ,OAAA;AAKR,iGAAA,SAAS,OAAA;AAgCT,oGAAA,YAAY,OAAA;AACZ,iGAAA,SAAS,OAAA;AAET,0GAAA,kBAAkB,OAAA;AAIlB,4GAAA,oBAAoB,OAAA;AAOpB,oHAAA,4BAA4B,OAAA;AAG5B,mGAAA,WAAW,OAAA;AACX,4GAAA,oBAAoB,OAAA;AAYpB,kGAAA,UAAU,OAAA;AAKV,yGAAA,iBAAiB,OAAA;AAMjB,sGAAA,cAAc,OAAA;AACd,oGAAA,YAAY,OAAA;AACZ,qGAAA,aAAa,OAAA;AACb,oHAAA,4BAA4B,OAAA;AAK7B,+BAqBgB;AAlBf,yGAAA,iBAAiB,OAAA;AACjB,6FAAA,KAAK,OAAA;AAOL,4FAAA,IAAI,OAAA;AAEJ,yGAAA,iBAAiB,OAAA;AAKjB,kGAAA,UAAU,OAAA;AACV,qGAAA,aAAa,OAAA;AAId,mCAQkB;AAJjB,uGAAA,aAAa,OAAA;AAMd,qCAAiC;AAAxB,+FAAA,IAAI,OAAA;AAEb,yDAiG6B;AAhG5B,8GAAA,SAAS,OAAA;AACT,iHAAA,YAAY,OAAA;AACZ,iHAAA,YAAY,OAAA;AAEZ,mHAAA,cAAc,OAAA;AACd,gHAAA,WAAW,OAAA;AAIX,sIAAA,iCAAiC,OAAA;AACjC,wHAAA,mBAAmB,OAAA;AACnB,2HAAA,sBAAsB,OAAA;AAGtB,yHAAA,oBAAoB,OAAA;AAKpB,+GAAA,UAAU,OAAA;AACV,oHAAA,eAAe,OAAA;AACf,qHAAA,yBAAyB,OAAoB;AAC7C,wHAAA,mBAAmB,OAAA;AAInB,6HAAA,wBAAwB,OAAA;AAExB,+GAAA,UAAU,OAAA;AAEV,6HAAA,wBAAwB,OAAA;AAMxB,oHAAA,eAAe,OAAA;AACf,wGAAA,GAAG,OAAA;AAGH,2HAAA,sBAAsB,OAAA;AAItB,oHAAA,eAAe,OAAA;AAEf,+GAAA,UAAU,OAAA;AAmBV,uHAAA,kBAAkB,OAAA;AAClB,oHAAA,eAAe,OAAA;AACf,mHAAA,cAAc,OAAA;AACd,kHAAA,aAAa,OAAA;AACb,qHAAA,gBAAgB,OAAA;AAEhB,sHAAA,iBAAiB,OAAA;AAIjB,sHAAA,iBAAiB,OAAA;AACjB,iHAAA,YAAY,OAAA;AACZ,gHAAA,WAAW,OAAA;AACX,uHAAA,kBAAkB,OAAA;AAKlB,4HAAA,uBAAuB,OAAA;AACvB,+HAAA,0BAA0B,OAAA;AAC1B,qHAAA,gBAAgB,OAAA;AAChB,yHAAA,oBAAoB,OAAA;AAYrB,6CAMuB;AALtB,4GAAA,aAAa,OAAA;AAGb,sHAAA,uBAAuB,OAAA;AACvB,uGAAA,QAAQ,OAAA;AAGT,6CAoBuB;AAhBtB,6GAAA,cAAc,OAAA;AACd,gHAAA,iBAAiB,OAAA;AAQjB,yGAAA,UAAU,OAAA;AAIV,qHAAA,sBAAsB,OAAA;AAKvB,2CAyBsB;AAtBrB,+GAAA,iBAAiB,OAAA;AAEjB,2GAAA,aAAa,OAAA;AACb,kGAAA,IAAI,OAAA;AAUJ,+BAA+B;AAC/B,uGAAA,SAAS,OAAA;AACT,6GAAA,eAAe,OAAA;AACf,6GAAA,eAAe,OAAA;AACf,+GAAA,iBAAiB,OAAA;AAEjB,8EAA8E;AAC9E,kHAAA,oBAAoB,OAAA;AACpB,uHAAA,yBAAyB,OAAA;AAE1B,6CAAqE;AAA5D,yGAAA,UAAU,OAAA;AAAE,0GAAA,WAAW,OAAA;AAGhC,iCAAwC;AAA/B,sGAAA,aAAa,OAAA;AACtB,2DAAwD;AAA/C,sHAAA,gBAAgB,OAAA;AAEzB,6FAA6F;AAC7F,0DAA4C;AACnC,sCAAa;AAEtB,oKAAoK;AACpK,+BAkBgB;AAdf,mGAAA,WAAW,OAAA;AAYX,kGAAA,UAAU,OAAA;AAIX,yDA2B6B;AAf5B,mHAAA,cAAc,OAAA;AACd,uHAAA,kBAAkB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tEmptyKey,\n\tFieldKey,\n\tTreeType,\n\tValue,\n\tTreeValue,\n\tAnchorSet,\n\tDetachedField,\n\tUpPath,\n\tRange,\n\tRangeUpPath,\n\tPlaceUpPath,\n\tDetachedRangeUpPath,\n\tDetachedPlaceUpPath,\n\tPlaceIndex,\n\tNodeIndex,\n\tFieldUpPath,\n\tAnchor,\n\tRootField,\n\tChildCollection,\n\tChildLocation,\n\tDeltaVisitor,\n\tAnnouncedVisitor,\n\tFieldMapObject,\n\tNodeData,\n\tGenericTreeNode,\n\tJsonableTree,\n\tProtoNodes,\n\tDeltaRoot,\n\tDeltaProtoNode,\n\tDeltaMark,\n\tDeltaDetachedNodeId,\n\tDeltaFieldMap,\n\tDeltaDetachedNodeChanges,\n\tDeltaDetachedNodeBuild,\n\tDeltaDetachedNodeDestruction,\n\tDeltaDetachedNodeRename,\n\tDeltaFieldChanges,\n\trootFieldKey,\n\trootField,\n\tITreeCursor,\n\tCursorLocationType,\n\tITreeCursorSynchronous,\n\tGenericFieldsNode,\n\tAnchorLocator,\n\tTreeNavigationResult,\n\tIEditableForest,\n\tIForestSubscription,\n\tTreeLocation,\n\tFieldLocation,\n\tForestLocation,\n\tITreeSubscriptionCursor,\n\tITreeSubscriptionCursorState,\n\tTreeNodeSchemaIdentifier,\n\tTreeFieldStoredSchema,\n\tValueSchema,\n\tTreeNodeStoredSchema,\n\tTreeStoredSchemaSubscription,\n\tFieldKindIdentifier,\n\tTreeTypeSet,\n\tTreeStoredSchema,\n\tFieldAnchor,\n\tSchemaEvents,\n\tChangesetLocalId,\n\tForestEvents,\n\tPathRootPrefix,\n\tAnchorSlot,\n\tAnchorNode,\n\tanchorSlot,\n\tUpPathDefault,\n\tAnchorEvents,\n\tAnchorSetRootEvents,\n\tFieldKindSpecifier,\n\tAllowedUpdateType,\n\tPathVisitor,\n\tAdapters,\n\tTreeAdapter,\n\tMapTree,\n\tRevertible,\n\tRevertibleKind,\n\tRevertResult,\n\tDiscardResult,\n\tforbiddenFieldKindIdentifier,\n\tStoredSchemaCollection,\n\tErasedTreeNodeSchemaDataFormat,\n} from \"./core\";\n\nexport {\n\tBrand,\n\tOpaque,\n\textractFromOpaque,\n\tbrand,\n\tValueFromBranded,\n\tNameFromBranded,\n\tJsonCompatibleReadOnly,\n\tJsonCompatible,\n\tJsonCompatibleObject,\n\tNestedMap,\n\tfail,\n\tIdAllocator,\n\tTransactionResult,\n\tBrandedKey,\n\tBrandedMapSubset,\n\tRangeQueryResult,\n\tNamed,\n\toneFromSet,\n\tdisposeSymbol,\n\tIDisposable,\n} from \"./util\";\n\nexport {\n\tEvents,\n\tIsEvent,\n\tISubscribable,\n\tcreateEmitter,\n\tIEmitter,\n\tNoListenersCallback,\n\tHasListeners,\n} from \"./events\";\n\nexport { leaf } from \"./domains\";\n\nexport {\n\tFieldKind,\n\tMultiplicity,\n\tisNeverField,\n\tFullSchemaPolicy,\n\ttypeNameSymbol,\n\tvalueSymbol,\n\tContextuallyTypedNodeDataObject,\n\tContextuallyTypedNodeData,\n\tMarkedArrayLike,\n\tisContextuallyTypedNodeDataObject,\n\tdefaultSchemaPolicy,\n\tjsonableTreeFromCursor,\n\tStableNodeKey,\n\tLocalNodeKey,\n\tcompareLocalNodeKeys,\n\tIDefaultEditBuilder,\n\tValueFieldEditBuilder,\n\tOptionalFieldEditBuilder,\n\tSequenceFieldEditBuilder,\n\tprefixPath,\n\tprefixFieldPath,\n\tcursorForJsonableTreeNode as singleTextCursor,\n\tstackTreeNodeCursor,\n\tCursorAdapter,\n\tCursorWithNode,\n\tEditableTreeEvents,\n\tInternalTypedSchemaTypes,\n\tArrayLikeMut,\n\tFieldKinds,\n\tContextuallyTypedFieldData,\n\tcursorFromContextualData,\n\tAllowedTypes,\n\tTreeNodeSchema as FlexTreeNodeSchema,\n\tFlexTreeSchema,\n\tSchemaLibrary,\n\tSchemaLibraryData,\n\tTreeFieldSchema,\n\tAny,\n\tNewFieldContent,\n\tNodeExistsConstraint,\n\tcursorForTypedTreeData,\n\tLazyTreeNodeSchema,\n\tFieldGenerator,\n\tTreeDataContext,\n\tnodeKeyFieldKey,\n\tSchemaLintConfiguration,\n\tTreeStatus,\n\tFlexTreeFieldNode,\n\tFlexibleFieldContent,\n\tFlexibleNodeContent,\n\tFlexTreeLeafNode,\n\tFlexTreeMapNode,\n\tFlexTreeOptionalField,\n\tFlexTreeRequiredField,\n\tFlexTreeSequenceField,\n\tFlexTreeObjectNode,\n\tFlexTreeObjectNodeTyped,\n\tAssignableFieldKinds,\n\tFlexTreeContext as TreeContext,\n\tFlexTreeTypedField,\n\tFlexTreeTypedNode,\n\tFlexTreeTypedNodeUnion,\n\tFlexTreeEntity,\n\tFlexTreeField,\n\tFlexTreeNode,\n\tTreeNodeSchemaBase,\n\tFieldNodeSchema,\n\tLeafNodeSchema,\n\tMapNodeSchema,\n\tObjectNodeSchema,\n\tCheckTypesOverlap,\n\tSchemaBuilderBase,\n\tImplicitFieldSchema as FlexImplicitFieldSchema,\n\tImplicitAllowedTypes,\n\tUnenforced,\n\tschemaIsFieldNode,\n\tschemaIsLeaf,\n\tschemaIsMap,\n\tschemaIsObjectNode,\n\tAllowedTypeSet,\n\tSchemaBuilderOptions,\n\tTreeEvent,\n\tSchemaCollection,\n\tTreeCompressionStrategy,\n\ttreeSchemaFromStoredSchema,\n\tencodeTreeSchema,\n\tstackTreeFieldCursor,\n\tFlexTreeUnknownUnboxed,\n\tInsertableFlexNode,\n\tInsertableFlexField,\n\tAllowedTypesToFlexInsertableTree,\n\tApplyMultiplicity,\n\tNormalizeObjectNodeFields,\n\tNormalizeFieldSchema,\n\tFields,\n\tMapFieldSchema,\n} from \"./feature-libraries\";\n\nexport {\n\tTreeArrayNode,\n\tTreeMapNodeBase,\n\tUnhydrated,\n\tIterableTreeListContent,\n\tTreeNode,\n} from \"./simple-tree\";\n\nexport {\n\tISharedTree,\n\tITreeCheckout,\n\tITransaction,\n\trunSynchronous,\n\tSharedTreeFactory,\n\tSharedTreeOptions,\n\tITreeCheckoutFork,\n\tCheckoutEvents,\n\tSchematizeConfiguration,\n\tTreeContent,\n\tInitializeAndSchematizeConfiguration,\n\tSchemaConfiguration,\n\tForestType,\n\tSharedTreeContentSnapshot,\n\tFlexTreeView,\n\tITreeViewFork,\n\tbuildTreeConfiguration,\n\tISharedTreeEditor,\n\tISchemaEditor,\n} from \"./shared-tree\";\n\nexport {\n\tITree,\n\tTreeNodeSchema,\n\tTreeConfiguration,\n\tTreeView,\n\tSchemaFactory,\n\tTree,\n\tTreeApi,\n\tImplicitFieldSchema,\n\tTreeFieldFromImplicitField,\n\tTreeNodeEvents,\n\tNodeFromSchema,\n\tTreeMapNode,\n\tInsertableTreeNodeFromImplicitAllowedTypes,\n\tTreeLeafValue,\n\n\t// experimental @internal APIs:\n\tadaptEnum,\n\tenumFromStrings,\n\tsingletonSchema,\n\ttypedObjectValues,\n\n\t// test recursive schema for checking that d.ts files handles schema correctly\n\ttest_RecursiveObject,\n\ttest_RecursiveObject_base,\n} from \"./class-tree\";\nexport { SharedTree, TreeFactory, TreeOptions } from \"./treeFactory\";\n\nexport type { ICodecOptions, JsonValidator, SchemaValidationFunction } from \"./codec\";\nexport { noopValidator } from \"./codec\";\nexport { typeboxValidator } from \"./external-utilities\";\n\n// Below here are things that are used by the above, but not part of the desired API surface.\nimport * as InternalTypes from \"./internal\";\nexport { InternalTypes };\n\n// TODO: When previously tagged '@internal', these types could not be included in `InternalClassTreeTypes` due to https://github.com/microsoft/rushstack/issues/3639\nexport {\n\tInvariant,\n\tContravariant,\n\tCovariant,\n\tBrandedType,\n\tExtractFromOpaque,\n\tAssume,\n\tAllowOptional,\n\tRequiredFields,\n\tOptionalFields,\n\t_InlineTrick,\n\t_RecursiveTrick,\n\tFlattenKeys,\n\tAllowOptionalNotFlattened,\n\tisAny,\n\tBrandedKeyContent,\n\tErasedType,\n\tErased,\n} from \"./util\";\n\nexport {\n\tNormalizeField,\n\tNormalizeAllowedTypes,\n\tFlexTreeTypedFieldInner,\n\tFlexTreeUnboxFieldInner,\n\tFlexTreeObjectNodeFields,\n\tFlexTreeUnboxField,\n\tFlexTreeUnboxNode,\n\tFlexTreeUnboxNodeUnion,\n\tFlexTreeNodeKeyField,\n\tIsArrayOfOne,\n\tFlexibleNodeSubSequence,\n\tflexTreeMarker,\n\tFlexTreeEntityKind,\n\tNodeKeys,\n\tCollectOptions,\n\tTypedFields,\n\tUnbrandedName,\n\tEmptyObject,\n\n\t// These field kind types really only need to show up via FieldKinds.name, and not as top level names in the package.\n\t// These names also are collision prone.\n\tRequired,\n\tOptional,\n\tNodeKeyFieldKind,\n\tForbidden,\n\tSequence,\n} from \"./feature-libraries\";\n"]}

package/dist/internal.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { MakeNominal, RestrictiveReadonlyRecord } from "./util";
+export { NodeKind, TreeNodeSchemaClass, TreeNodeSchemaNonClass, TreeNodeSchemaCore, InternalClassTreeTypes, } from "./class-tree";
+export { TreeArrayNodeBase } from "./simple-tree";
+//# sourceMappingURL=internal.d.ts.map

package/dist/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,MAAM,QAAQ,CAAC;AAEhE,OAAO,EACN,QAAQ,EACR,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,GACtB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC"}

package/dist/internal.js

@@ -0,0 +1,11 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalClassTreeTypes = exports.NodeKind = void 0;
+var class_tree_1 = require("./class-tree");
+Object.defineProperty(exports, "NodeKind", { enumerable: true, get: function () { return class_tree_1.NodeKind; } });
+Object.defineProperty(exports, "InternalClassTreeTypes", { enumerable: true, get: function () { return class_tree_1.InternalClassTreeTypes; } });
+//# sourceMappingURL=internal.js.map

package/dist/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,2CAMsB;AALrB,sGAAA,QAAQ,OAAA;AAIR,oHAAA,sBAAsB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Used by public types, but not part of the desired API surface.\nexport { MakeNominal, RestrictiveReadonlyRecord } from \"./util\";\n\nexport {\n\tNodeKind,\n\tTreeNodeSchemaClass,\n\tTreeNodeSchemaNonClass,\n\tTreeNodeSchemaCore,\n\tInternalClassTreeTypes,\n} from \"./class-tree\";\n\nexport { TreeArrayNodeBase } from \"./simple-tree\";\n"]}

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

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { ISharedTree, SharedTreeFactory, SharedTreeOptions, SharedTree, ForestType, SharedTreeContentSnapshot, } from "./sharedTree";
+export { createTreeCheckout, ITreeCheckout, runSynchronous, CheckoutEvents, ITransaction, ITreeCheckoutFork, } from "./treeCheckout";
+export { SchematizeConfiguration, TreeContent, InitializeAndSchematizeConfiguration, SchemaConfiguration, buildTreeConfiguration, } from "./schematizedTree";
+export { FlexTreeView, CheckoutFlexTreeView, ITreeViewFork } from "./treeView";
+export { ISharedTreeEditor, ISchemaEditor } from "./sharedTreeEditBuilder";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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,cAAc,CAAC;AAEtB,OAAO,EACN,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,iBAAiB,GACjB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,uBAAuB,EACvB,WAAW,EACX,oCAAoC,EACpC,mBAAmB,EACnB,sBAAsB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE/E,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/shared-tree/index.js

@@ -0,0 +1,19 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckoutFlexTreeView = exports.buildTreeConfiguration = exports.runSynchronous = exports.createTreeCheckout = exports.ForestType = exports.SharedTree = exports.SharedTreeFactory = void 0;
+var sharedTree_1 = require("./sharedTree");
+Object.defineProperty(exports, "SharedTreeFactory", { enumerable: true, get: function () { return sharedTree_1.SharedTreeFactory; } });
+Object.defineProperty(exports, "SharedTree", { enumerable: true, get: function () { return sharedTree_1.SharedTree; } });
+Object.defineProperty(exports, "ForestType", { enumerable: true, get: function () { return sharedTree_1.ForestType; } });
+var treeCheckout_1 = require("./treeCheckout");
+Object.defineProperty(exports, "createTreeCheckout", { enumerable: true, get: function () { return treeCheckout_1.createTreeCheckout; } });
+Object.defineProperty(exports, "runSynchronous", { enumerable: true, get: function () { return treeCheckout_1.runSynchronous; } });
+var schematizedTree_1 = require("./schematizedTree");
+Object.defineProperty(exports, "buildTreeConfiguration", { enumerable: true, get: function () { return schematizedTree_1.buildTreeConfiguration; } });
+var treeView_1 = require("./treeView");
+Object.defineProperty(exports, "CheckoutFlexTreeView", { enumerable: true, get: function () { return treeView_1.CheckoutFlexTreeView; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared-tree/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAOsB;AALrB,+GAAA,iBAAiB,OAAA;AAEjB,wGAAA,UAAU,OAAA;AACV,wGAAA,UAAU,OAAA;AAIX,+CAOwB;AANvB,kHAAA,kBAAkB,OAAA;AAElB,8GAAA,cAAc,OAAA;AAMf,qDAM2B;AAD1B,yHAAA,sBAAsB,OAAA;AAGvB,uCAA+E;AAAxD,gHAAA,oBAAoB,OAAA","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\";\n\nexport {\n\tcreateTreeCheckout,\n\tITreeCheckout,\n\trunSynchronous,\n\tCheckoutEvents,\n\tITransaction,\n\tITreeCheckoutFork,\n} from \"./treeCheckout\";\n\nexport {\n\tSchematizeConfiguration,\n\tTreeContent,\n\tInitializeAndSchematizeConfiguration,\n\tSchemaConfiguration,\n\tbuildTreeConfiguration,\n} from \"./schematizedTree\";\n\nexport { FlexTreeView, CheckoutFlexTreeView, ITreeViewFork } from \"./treeView\";\n\nexport { ISharedTreeEditor, ISchemaEditor } from \"./sharedTreeEditBuilder\";\n"]}

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

@@ -0,0 +1,94 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AllowedUpdateType, ITreeCursorSynchronous } from "../core";
+import { FlexTreeSchema, TreeFieldSchema, InsertableFlexField } from "../feature-libraries";
+import { ISubscribable } from "../events";
+import { CheckoutEvents, ITreeCheckout } from "./treeCheckout";
+/**
+ * Modify `storedSchema` and invoke `setInitialTree` when it's time to set the tree content.
+ *
+ * Requires `storedSchema` to be in its default/empty state.
+ *
+ * This is done in such a way that if the content (implicitly assumed to start empty)
+ * is never out of schema.
+ * This means that if the root field of the new schema requires content (like a value field),
+ * a temporary intermediate schema is used so the initial empty state is not out of schema.
+ *
+ * Since this makes multiple changes, callers may want to wrap it in a transaction.
+ */
+export declare function initializeContent(schemaRepository: {
+    storedSchema: ITreeCheckout["storedSchema"];
+    updateSchema: ITreeCheckout["updateSchema"];
+}, newSchema: FlexTreeSchema, setInitialTree: () => void): void;
+/**
+ * See {@link ISharedTree.schematize} for more details.
+ *
+ * TODO:
+ * - Support adapters for handling out of schema data.
+ * - Handle initialization via an adapter.
+ * - Support per adapter update policy.
+ * - Support lazy schema updates.
+ * - Better error for change to invalid schema approach than throwing on later event.
+ */
+export declare function schematize(events: ISubscribable<CheckoutEvents>, schemaRepository: {
+    storedSchema: ITreeCheckout["storedSchema"];
+    updateSchema: ITreeCheckout["updateSchema"];
+}, config: SchematizeConfiguration): void;
+/**
+ * @param callback - run after a schema change. If returns true, will run after next change as well.
+ */
+export declare function afterSchemaChanges(events: ISubscribable<CheckoutEvents>, schemaRepository: {
+    storedSchema: ITreeCheckout["storedSchema"];
+    updateSchema: ITreeCheckout["updateSchema"];
+}, callback: () => boolean): void;
+/**
+ * View Schema for a `SharedTree`.
+ *
+ * @internal
+ */
+export interface SchemaConfiguration<TRoot extends TreeFieldSchema = TreeFieldSchema> {
+    /**
+     * The schema which the application wants to view the tree with.
+     */
+    readonly schema: FlexTreeSchema<TRoot>;
+}
+/**
+ * Content that can populate a `SharedTree`.
+ *
+ * @internal
+ */
+export interface TreeContent<TRoot extends TreeFieldSchema = TreeFieldSchema> extends SchemaConfiguration<TRoot> {
+    /**
+     * Default tree content to initialize the tree with iff the tree is uninitialized
+     * (meaning it does not even have any schema set at all).
+     */
+    readonly initialTree: InsertableFlexField<TRoot> | readonly ITreeCursorSynchronous[] | ITreeCursorSynchronous;
+}
+/**
+ * Options used to schematize a `SharedTree`.
+ *
+ * @internal
+ */
+export interface SchematizeConfiguration<TRoot extends TreeFieldSchema = TreeFieldSchema> extends SchemaConfiguration<TRoot> {
+    /**
+     * Controls if and how schema from existing documents can be updated to accommodate the view schema.
+     */
+    readonly allowedSchemaModifications: AllowedUpdateType;
+}
+/**
+ * Options used to initialize (if needed) and schematize a `SharedTree`.
+ *
+ * @internal
+ */
+export interface InitializeAndSchematizeConfiguration<TRoot extends TreeFieldSchema = TreeFieldSchema> extends TreeContent<TRoot>, SchematizeConfiguration<TRoot> {
+}
+/**
+ * Options used to initialize (if needed) and schematize a `SharedTree`.
+ * @remarks
+ * Using this builder improves type safety and error quality over just constructing the configuration as a object.
+ * @internal
+ */
+export declare function buildTreeConfiguration<T extends TreeFieldSchema>(config: InitializeAndSchematizeConfiguration<T>): InitializeAndSchematizeConfiguration<T>;
+//# sourceMappingURL=schematizedTree.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schematizedTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/schematizedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,iBAAiB,EAGjB,sBAAsB,EAEtB,MAAM,SAAS,CAAC;AACjB,OAAO,EAIN,cAAc,EACd,eAAe,EAEf,mBAAmB,EAEnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;;;;;;;;;;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;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACzB,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,EACrC,gBAAgB,EAAE;IACjB,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5C,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC5C,EACD,MAAM,EAAE,uBAAuB,GAC7B,IAAI,CAqDN;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,EACrC,gBAAgB,EAAE;IACjB,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5C,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC5C,EACD,QAAQ,EAAE,MAAM,OAAO,GACrB,IAAI,CA6BN;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/schematizedTree.js

@@ -0,0 +1,158 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildTreeConfiguration = exports.afterSchemaChanges = exports.schematize = exports.initializeContent = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const core_1 = require("../core");
+const feature_libraries_1 = require("../feature-libraries");
+const util_1 = require("../util");
+/**
+ * Modify `storedSchema` and invoke `setInitialTree` when it's time to set the tree content.
+ *
+ * Requires `storedSchema` to be in its default/empty state.
+ *
+ * This is done in such a way that if the content (implicitly assumed to start empty)
+ * is never out of schema.
+ * This means that if the root field of the new schema requires content (like a value field),
+ * a temporary intermediate schema is used so the initial empty state is not out of schema.
+ *
+ * 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, core_1.schemaDataIsEmpty)(schemaRepository.storedSchema), 0x743 /* cannot initialize after a schema is set */);
+    const schema = (0, feature_libraries_1.intoStoredSchema)(newSchema);
+    const rootSchema = schema.rootFieldSchema;
+    const rootKind = rootSchema.kind.identifier;
+    // 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 === feature_libraries_1.FieldKinds.sequence.identifier ||
+        rootKind === feature_libraries_1.FieldKinds.optional.identifier) {
+        // These kinds are known to tolerate empty, so use the schema as is:
+        incrementalSchemaUpdate = schema;
+    }
+    else {
+        (0, core_utils_1.assert)(rootKind === feature_libraries_1.FieldKinds.required.identifier, 0x5c8 /* Unexpected kind */);
+        // Replace value kind with optional kind in root field schema:
+        incrementalSchemaUpdate = {
+            nodeSchema: schema.nodeSchema,
+            rootFieldSchema: {
+                kind: feature_libraries_1.FieldKinds.optional,
+                types: rootSchema.types,
+            },
+        };
+    }
+    // TODO: fix issues with schema comparison and enable this.
+    // assert(
+    // 	allowsRepoSuperset(defaultSchemaPolicy, tree.storedSchema, incrementalSchemaUpdate),
+    // 	"Incremental Schema update should support the existing empty tree",
+    // );
+    (0, core_utils_1.assert)((0, feature_libraries_1.allowsRepoSuperset)(feature_libraries_1.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
+    setInitialTree();
+    // If intermediate schema is not final desired schema, update to the final schema:
+    if (incrementalSchemaUpdate !== schema) {
+        schemaRepository.updateSchema(schema);
+    }
+}
+exports.initializeContent = initializeContent;
+/**
+ * See {@link ISharedTree.schematize} for more details.
+ *
+ * TODO:
+ * - Support adapters for handling out of schema data.
+ * - Handle initialization via an adapter.
+ * - Support per adapter update policy.
+ * - Support lazy schema updates.
+ * - Better error for change to invalid schema approach than throwing on later event.
+ */
+function schematize(events, schemaRepository, config) {
+    // TODO: support adapters and include them here.
+    const viewSchema = new feature_libraries_1.ViewSchema(feature_libraries_1.defaultSchemaPolicy, {}, config.schema);
+    {
+        const compatibility = viewSchema.checkCompatibility(schemaRepository.storedSchema);
+        switch (config.allowedSchemaModifications) {
+            case core_1.AllowedUpdateType.None: {
+                if (compatibility.read !== core_1.Compatibility.Compatible) {
+                    (0, util_1.fail)("Existing stored schema permits trees which are incompatible with the view schema");
+                }
+                if (compatibility.write !== core_1.Compatibility.Compatible) {
+                    // TODO: support readonly mode in this case.
+                    (0, util_1.fail)("View schema permits trees which are incompatible with the stored schema");
+                }
+                break;
+            }
+            case core_1.AllowedUpdateType.SchemaCompatible: {
+                if (compatibility.read !== core_1.Compatibility.Compatible) {
+                    (0, util_1.fail)("Existing stored schema permits trees which are incompatible with the view schema, so schema can not be updated");
+                }
+                if (compatibility.write !== core_1.Compatibility.Compatible) {
+                    schemaRepository.updateSchema((0, feature_libraries_1.intoStoredSchema)(config.schema));
+                }
+                break;
+            }
+            default: {
+                (0, core_utils_1.unreachableCase)(config.allowedSchemaModifications);
+            }
+        }
+    }
+    afterSchemaChanges(events, schemaRepository, () => {
+        const compatibility = viewSchema.checkCompatibility(schemaRepository.storedSchema);
+        if (compatibility.read !== core_1.Compatibility.Compatible) {
+            (0, util_1.fail)("Stored schema changed to one that permits data incompatible with the view schema");
+        }
+        if (compatibility.write !== core_1.Compatibility.Compatible) {
+            // TODO: support readonly mode in this case.
+            (0, util_1.fail)("Stored schema changed to one that does not support all data allowed by view schema");
+        }
+        return true;
+    });
+}
+exports.schematize = schematize;
+/**
+ * @param callback - run after a schema change. If returns true, will run after next change as well.
+ */
+function afterSchemaChanges(events, schemaRepository, callback) {
+    // Callback to cleanup afterBatch schema checking.
+    // Set only when such a callback is pending.
+    let afterBatchCheck;
+    // TODO: errors thrown by this will usually be in response to remote edits, and thus may not surface to the app.
+    // Two fixes should be done related to this:
+    // 1. Ensure errors in response to edits like this crash app and report telemetry.
+    // 2. Replace these (and the above) exception based errors with
+    // out of schema handlers which update the schematized view of the tree instead of throwing.
+    const unregister = schemaRepository.storedSchema.on("afterSchemaChange", () => {
+        // On schema change, setup a callback (deduplicated so its only run once) after a batch of changes.
+        // This avoids erroring about invalid schema in the middle of a batch of changes.
+        // TODO:
+        // Ideally this would run at the end of the batch containing the schema change, but currently schema changes don't trigger afterBatch.
+        // Fortunately this works out ok, since the tree can't actually become out of schema until its actually edited, which should trigger after batch.
+        // When batching properly handles schema edits, this documentation and related tests should be updated.
+        // TODO:
+        // With the the updated incremental batch application policy, this behavior is not valid.
+        afterBatchCheck ?? (afterBatchCheck = events.on("afterBatch", () => {
+            (0, core_utils_1.assert)(afterBatchCheck !== undefined, 0x728 /* unregistered event ran */);
+            afterBatchCheck();
+            afterBatchCheck = undefined;
+            if (!callback()) {
+                unregister();
+            }
+        }));
+    });
+}
+exports.afterSchemaChanges = afterSchemaChanges;
+/**
+ * Options used to initialize (if needed) and schematize a `SharedTree`.
+ * @remarks
+ * Using this builder improves type safety and error quality over just constructing the configuration as a object.
+ * @internal
+ */
+function buildTreeConfiguration(config) {
+    return config;
+}
+exports.buildTreeConfiguration = buildTreeConfiguration;
+//# sourceMappingURL=schematizedTree.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schematizedTree.js","sourceRoot":"","sources":["../../src/shared-tree/schematizedTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAqE;AACrE,kCAMiB;AACjB,4DAS8B;AAC9B,kCAA+B;AAI/B;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAChC,gBAGC,EACD,SAAyB,EACzB,cAA0B;IAE1B,IAAA,mBAAM,EACL,IAAA,wBAAiB,EAAC,gBAAgB,CAAC,YAAY,CAAC,EAChD,KAAK,CAAC,6CAA6C,CACnD,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,oCAAgB,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,8BAAU,CAAC,QAAQ,CAAC,UAAU;QAC3C,QAAQ,KAAK,8BAAU,CAAC,QAAQ,CAAC,UAAU,EAC1C;QACD,oEAAoE;QACpE,uBAAuB,GAAG,MAAM,CAAC;KACjC;SAAM;QACN,IAAA,mBAAM,EAAC,QAAQ,KAAK,8BAAU,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,8BAAU,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,sCAAkB,EAAC,uCAAmB,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;;;;;;;;;GASG;AACH,SAAgB,UAAU,CACzB,MAAqC,EACrC,gBAGC,EACD,MAA+B;IAE/B,gDAAgD;IAChD,MAAM,UAAU,GAAG,IAAI,8BAAU,CAAC,uCAAmB,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1E;QACC,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACnF,QAAQ,MAAM,CAAC,0BAA0B,EAAE;YAC1C,KAAK,wBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC5B,IAAI,aAAa,CAAC,IAAI,KAAK,oBAAa,CAAC,UAAU,EAAE;oBACpD,IAAA,WAAI,EACH,kFAAkF,CAClF,CAAC;iBACF;gBAED,IAAI,aAAa,CAAC,KAAK,KAAK,oBAAa,CAAC,UAAU,EAAE;oBACrD,4CAA4C;oBAC5C,IAAA,WAAI,EAAC,yEAAyE,CAAC,CAAC;iBAChF;gBAED,MAAM;aACN;YACD,KAAK,wBAAiB,CAAC,gBAAgB,CAAC,CAAC;gBACxC,IAAI,aAAa,CAAC,IAAI,KAAK,oBAAa,CAAC,UAAU,EAAE;oBACpD,IAAA,WAAI,EACH,gHAAgH,CAChH,CAAC;iBACF;gBACD,IAAI,aAAa,CAAC,KAAK,KAAK,oBAAa,CAAC,UAAU,EAAE;oBACrD,gBAAgB,CAAC,YAAY,CAAC,IAAA,oCAAgB,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;iBAC/D;gBAED,MAAM;aACN;YACD,OAAO,CAAC,CAAC;gBACR,IAAA,4BAAe,EAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;aACnD;SACD;KACD;IACD,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE;QACjD,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACnF,IAAI,aAAa,CAAC,IAAI,KAAK,oBAAa,CAAC,UAAU,EAAE;YACpD,IAAA,WAAI,EACH,kFAAkF,CAClF,CAAC;SACF;QAED,IAAI,aAAa,CAAC,KAAK,KAAK,oBAAa,CAAC,UAAU,EAAE;YACrD,4CAA4C;YAC5C,IAAA,WAAI,EACH,oFAAoF,CACpF,CAAC;SACF;QACD,OAAO,IAAI,CAAC;IACb,CAAC,CAAC,CAAC;AACJ,CAAC;AA5DD,gCA4DC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CACjC,MAAqC,EACrC,gBAGC,EACD,QAAuB;IAEvB,kDAAkD;IAClD,4CAA4C;IAC5C,IAAI,eAAyC,CAAC;IAE9C,gHAAgH;IAChH,4CAA4C;IAC5C,kFAAkF;IAClF,+DAA+D;IAC/D,4FAA4F;IAC5F,MAAM,UAAU,GAAG,gBAAgB,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC7E,mGAAmG;QACnG,iFAAiF;QACjF,QAAQ;QACR,sIAAsI;QACtI,iJAAiJ;QACjJ,uGAAuG;QACvG,QAAQ;QACR,yFAAyF;QACzF,eAAe,KAAf,eAAe,GAAK,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YAChD,IAAA,mBAAM,EAAC,eAAe,KAAK,SAAS,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAC1E,eAAe,EAAE,CAAC;YAClB,eAAe,GAAG,SAAS,CAAC;YAE5B,IAAI,CAAC,QAAQ,EAAE,EAAE;gBAChB,UAAU,EAAE,CAAC;aACb;QACF,CAAC,CAAC,EAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AApCD,gDAoCC;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} from \"../core\";\nimport {\n\tdefaultSchemaPolicy,\n\tFieldKinds,\n\tallowsRepoSuperset,\n\tFlexTreeSchema,\n\tTreeFieldSchema,\n\tViewSchema,\n\tInsertableFlexField,\n\tintoStoredSchema,\n} from \"../feature-libraries\";\nimport { fail } from \"../util\";\nimport { ISubscribable } from \"../events\";\nimport { CheckoutEvents, ITreeCheckout } from \"./treeCheckout\";\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\n/**\n * See {@link ISharedTree.schematize} for more details.\n *\n * TODO:\n * - Support adapters for handling out of schema data.\n * - Handle initialization via an adapter.\n * - Support per adapter update policy.\n * - Support lazy schema updates.\n * - Better error for change to invalid schema approach than throwing on later event.\n */\nexport function schematize(\n\tevents: ISubscribable<CheckoutEvents>,\n\tschemaRepository: {\n\t\tstoredSchema: ITreeCheckout[\"storedSchema\"];\n\t\tupdateSchema: ITreeCheckout[\"updateSchema\"];\n\t},\n\tconfig: SchematizeConfiguration,\n): void {\n\t// TODO: support adapters and include them here.\n\tconst viewSchema = new ViewSchema(defaultSchemaPolicy, {}, config.schema);\n\t{\n\t\tconst compatibility = viewSchema.checkCompatibility(schemaRepository.storedSchema);\n\t\tswitch (config.allowedSchemaModifications) {\n\t\t\tcase AllowedUpdateType.None: {\n\t\t\t\tif (compatibility.read !== Compatibility.Compatible) {\n\t\t\t\t\tfail(\n\t\t\t\t\t\t\"Existing stored schema permits trees which are incompatible with the view schema\",\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tif (compatibility.write !== Compatibility.Compatible) {\n\t\t\t\t\t// TODO: support readonly mode in this case.\n\t\t\t\t\tfail(\"View schema permits trees which are incompatible with the stored schema\");\n\t\t\t\t}\n\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase AllowedUpdateType.SchemaCompatible: {\n\t\t\t\tif (compatibility.read !== Compatibility.Compatible) {\n\t\t\t\t\tfail(\n\t\t\t\t\t\t\"Existing stored schema permits trees which are incompatible with the view schema, so schema can not be updated\",\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\tif (compatibility.write !== Compatibility.Compatible) {\n\t\t\t\t\tschemaRepository.updateSchema(intoStoredSchema(config.schema));\n\t\t\t\t}\n\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tunreachableCase(config.allowedSchemaModifications);\n\t\t\t}\n\t\t}\n\t}\n\tafterSchemaChanges(events, schemaRepository, () => {\n\t\tconst compatibility = viewSchema.checkCompatibility(schemaRepository.storedSchema);\n\t\tif (compatibility.read !== Compatibility.Compatible) {\n\t\t\tfail(\n\t\t\t\t\"Stored schema changed to one that permits data incompatible with the view schema\",\n\t\t\t);\n\t\t}\n\n\t\tif (compatibility.write !== Compatibility.Compatible) {\n\t\t\t// TODO: support readonly mode in this case.\n\t\t\tfail(\n\t\t\t\t\"Stored schema changed to one that does not support all data allowed by view schema\",\n\t\t\t);\n\t\t}\n\t\treturn true;\n\t});\n}\n\n/**\n * @param callback - run after a schema change. If returns true, will run after next change as well.\n */\nexport function afterSchemaChanges(\n\tevents: ISubscribable<CheckoutEvents>,\n\tschemaRepository: {\n\t\tstoredSchema: ITreeCheckout[\"storedSchema\"];\n\t\tupdateSchema: ITreeCheckout[\"updateSchema\"];\n\t},\n\tcallback: () => boolean,\n): void {\n\t// Callback to cleanup afterBatch schema checking.\n\t// Set only when such a callback is pending.\n\tlet afterBatchCheck: undefined | (() => void);\n\n\t// TODO: errors thrown by this will usually be in response to remote edits, and thus may not surface to the app.\n\t// Two fixes should be done related to this:\n\t// 1. Ensure errors in response to edits like this crash app and report telemetry.\n\t// 2. Replace these (and the above) exception based errors with\n\t// out of schema handlers which update the schematized view of the tree instead of throwing.\n\tconst unregister = schemaRepository.storedSchema.on(\"afterSchemaChange\", () => {\n\t\t// On schema change, setup a callback (deduplicated so its only run once) after a batch of changes.\n\t\t// This avoids erroring about invalid schema in the middle of a batch of changes.\n\t\t// TODO:\n\t\t// Ideally this would run at the end of the batch containing the schema change, but currently schema changes don't trigger afterBatch.\n\t\t// Fortunately this works out ok, since the tree can't actually become out of schema until its actually edited, which should trigger after batch.\n\t\t// When batching properly handles schema edits, this documentation and related tests should be updated.\n\t\t// TODO:\n\t\t// With the the updated incremental batch application policy, this behavior is not valid.\n\t\tafterBatchCheck ??= events.on(\"afterBatch\", () => {\n\t\t\tassert(afterBatchCheck !== undefined, 0x728 /* unregistered event ran */);\n\t\t\tafterBatchCheck();\n\t\t\tafterBatchCheck = undefined;\n\n\t\t\tif (!callback()) {\n\t\t\t\tunregister();\n\t\t\t}\n\t\t});\n\t});\n}\n\n/**\n * View Schema for a `SharedTree`.\n *\n * @internal\n */\nexport interface SchemaConfiguration<TRoot extends TreeFieldSchema = TreeFieldSchema> {\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 TreeFieldSchema = TreeFieldSchema>\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 TreeFieldSchema = TreeFieldSchema>\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 TreeFieldSchema = TreeFieldSchema,\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 TreeFieldSchema>(\n\tconfig: InitializeAndSchematizeConfiguration<T>,\n): InitializeAndSchematizeConfiguration<T> {\n\treturn config;\n}\n"]}