@fluidframework/tree 2.41.0-338401 → 2.42.0

package/dist/feature-libraries/object-forest/objectForest.js

@@ -3,6 +3,40 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -14,16 +48,16 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _ObjectForest_events, _ObjectForest_roots;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildForest = exports.ObjectForest = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
 const client_utils_1 = require("@fluid-internal/client-utils");
+const internal_1 = require("@fluidframework/core-utils/internal");
 const index_js_1 = require("../../core/index.js");
 const index_js_2 = require("../../util/index.js");
+const index_js_3 = require("../chunked-forest/index.js");
 const mapTreeCursor_js_1 = require("../mapTreeCursor.js");
 const treeCursorUtils_js_1 = require("../treeCursorUtils.js");
-const index_js_3 = require("../chunked-forest/index.js");
+const index_js_4 = require("../default-schema/index.js");
 /** Get a field from a `MutableMapTree`, optionally modifying the tree to create it if missing. */
 function getOrCreateField(mapTree, key) {
     const field = mapTree.fields.get(key);
@@ -40,226 +74,278 @@ function getOrCreateField(mapTree, key) {
  * This implementation focuses on correctness and simplicity, not performance.
  * It does not use compressed chunks: instead nodes are implemented using objects.
  */
-class ObjectForest {
-    get roots() {
-        return __classPrivateFieldGet(this, _ObjectForest_roots, "f");
-    }
-    constructor(anchors = new index_js_1.AnchorSet(), additionalAsserts = false, roots) {
-        this.anchors = anchors;
-        this.additionalAsserts = additionalAsserts;
-        // All cursors that are in the "Current" state. Must be empty when editing.
-        this.currentCursors = new Set();
-        this.deltaVisitors = new Set();
-        _ObjectForest_events.set(this, (0, client_utils_1.createEmitter)());
-        this.events = __classPrivateFieldGet(this, _ObjectForest_events, "f");
-        _ObjectForest_roots.set(this, void 0);
-        this.nextRange = 0;
-        __classPrivateFieldSet(this, _ObjectForest_roots, roots !== undefined
-            ? (0, index_js_1.deepCopyMapTree)(roots)
-            : {
-                type: index_js_1.aboveRootPlaceholder,
-                fields: new Map(),
-            }, "f");
-    }
-    get isEmpty() {
-        return this.roots.fields.size === 0;
-    }
-    clone(_, anchors) {
-        return new ObjectForest(anchors, this.additionalAsserts, this.roots);
-    }
-    chunkField(cursor) {
-        return (0, index_js_3.chunkFieldSingle)(cursor, { idCompressor: undefined, policy: index_js_3.defaultChunkPolicy });
-    }
-    forgetAnchor(anchor) {
-        this.anchors.forget(anchor);
-    }
-    acquireVisitor() {
-        (0, internal_1.assert)(this.activeVisitor === undefined, 0x76c /* Must release existing visitor before acquiring another */);
-        // Note: This code uses cursors, however it also modifies the tree.
-        // In general this is not safe, but this code happens to only modify the tree below the current cursor location,
-        // which happens to work.
-        // This pattern could be generalized/formalized with a concept of an exclusive cursor,
-        // which can edit, but is the only cursor allowed at the time.
-        const cursor = this.allocateCursor("acquireVisitor");
-        cursor.setToAboveDetachedSequences();
-        /**
-         * Called before each edit to allow cursor cleanup to happen and ensure that there are no unexpected cursors.
-         * This is required for each change since there may be app facing change event handlers which create cursors.
-         */
-        const preEdit = () => {
-            __classPrivateFieldGet(this, _ObjectForest_events, "f").emit("beforeChange");
-            (0, internal_1.assert)(this.currentCursors.has(cursor), 0x995 /* missing visitor cursor while editing */);
-            if (this.currentCursors.size > 1) {
-                const unexpectedSources = [...this.currentCursors].flatMap((c) => c === cursor ? [] : (c.source ?? null));
-                throw new Error(`Found unexpected cursors when editing with the following annotations: ${JSON.stringify(unexpectedSources)}`);
-            }
-        };
-        class Visitor {
-            constructor(forest) {
-                this.forest = forest;
+let ObjectForest = (() => {
+    var _a, _ObjectForest_events, _ObjectForest_roots;
+    let _instanceExtraInitializers = [];
+    let _checkSchema_decorators;
+    return _a = class ObjectForest {
+            get roots() {
+                return __classPrivateFieldGet(this, _ObjectForest_roots, "f");
             }
-            free() {
-                cursor.free();
-                (0, internal_1.assert)(this.forest.activeVisitor !== undefined, 0x76d /* Multiple free calls for same visitor */);
-                this.forest.activeVisitor = undefined;
+            constructor(breaker, 
+            /**
+             * If provided, may be used for validation, but otherwise unused.
+             */
+            schema, anchors = new index_js_1.AnchorSet(), additionalAsserts = false, roots) {
+                this.breaker = (__runInitializers(this, _instanceExtraInitializers), breaker);
+                this.schema = schema;
+                this.anchors = anchors;
+                this.additionalAsserts = additionalAsserts;
+                // All cursors that are in the "Current" state. Must be empty when editing.
+                this.currentCursors = new Set();
+                this.deltaVisitors = new Set();
+                _ObjectForest_events.set(this, (0, client_utils_1.createEmitter)());
+                this.events = __classPrivateFieldGet(this, _ObjectForest_events, "f");
+                _ObjectForest_roots.set(this, void 0);
+                this.nextRange = 0;
+                __classPrivateFieldSet(this, _ObjectForest_roots, roots !== undefined
+                    ? (0, index_js_1.deepCopyMapTree)(roots)
+                    : {
+                        type: index_js_1.aboveRootPlaceholder,
+                        fields: new Map(),
+                    }, "f");
+                if (additionalAsserts) {
+                    this.checkSchema();
+                }
             }
-            destroy(detachedField, count) {
-                preEdit();
-                this.forest.delete(detachedField);
+            get isEmpty() {
+                return this.roots.fields.size === 0;
             }
-            create(content, destination) {
-                preEdit();
-                this.forest.add(content, destination);
-                __classPrivateFieldGet(this.forest, _ObjectForest_events, "f").emit("afterRootFieldCreated", destination);
+            clone(schema, anchors) {
+                return new _a(this.breaker, schema, anchors, this.additionalAsserts, this.roots);
             }
-            attach(source, count, destination) {
-                preEdit();
-                this.attachEdit(source, count, destination);
+            chunkField(cursor) {
+                return (0, index_js_3.chunkFieldSingle)(cursor, { idCompressor: undefined, policy: index_js_3.defaultChunkPolicy });
             }
-            detach(source, destination, id) {
-                preEdit();
-                this.detachEdit(source, destination);
+            forgetAnchor(anchor) {
+                this.anchors.forget(anchor);
             }
             /**
-             * Attaches the nodes from the given source field into the current field.
-             * Does not invalidate dependents.
-             * @param source - The the range to be attached.
-             * @param count - The number of nodes being attached.
-             * Expected to match the number of nodes in the source detached field.
-             * @param destination - The index in the current field at which to attach the content.
+             * Throw (and break) if content does not match schema.
              */
-            attachEdit(source, count, destination) {
-                (0, index_js_2.assertNonNegativeSafeInteger)(count);
-                if (count === 0) {
-                    return;
+            checkSchema() {
+                const schema = this.schema;
+                if (schema !== undefined) {
+                    const roots = new Set([...this.roots.fields.keys(), index_js_1.rootFieldKey]);
+                    for (const key of roots) {
+                        const documentRoot = this.roots.fields.get(key) ?? [];
+                        const fieldSchema = key === index_js_1.rootFieldKey
+                            ? schema.rootFieldSchema
+                            : // TODO: someday we should have schema for detached fields, and use that instead of generating one here.
+                                {
+                                    // Some detached fields may have multiple nodes, so we must treat them as sequences:
+                                    kind: index_js_4.FieldKinds.sequence.identifier,
+                                    types: new Set(documentRoot.map((node) => node.type)),
+                                };
+                        const maybeError = (0, index_js_4.isFieldInSchema)(documentRoot, fieldSchema, {
+                            schema,
+                            policy: index_js_4.defaultSchemaPolicy,
+                        });
+                        (0, index_js_4.inSchemaOrThrow)(maybeError);
+                    }
                 }
-                const [parent, key] = cursor.getParent();
-                (0, internal_1.assert)(parent !== this.forest.roots || key !== source, 0x7b6 /* Attach source field must be different from current field */);
-                const currentField = getOrCreateField(parent, key);
-                (0, index_js_2.assertValidIndex)(destination, currentField, true);
-                const sourceField = __classPrivateFieldGet(this.forest, _ObjectForest_roots, "f").fields.get(source) ?? [];
-                (0, internal_1.assert)(sourceField !== undefined, 0x7b7 /* Attach source field must exist */);
-                (0, internal_1.assert)(sourceField.length === count, 0x7b8 /* Attach must consume all nodes in source field */);
-                // TODO: this will fail for very large insertions due to argument limits.
-                currentField.splice(destination, 0, ...sourceField);
-                this.forest.delete(source);
             }
-            /**
-             * Detaches the range from the current field and transfers it to the given destination if any.
-             * Does not invalidate dependents.
-             * @param source - The bounds of the range to be detached from the current field.
-             * @param destination - If specified, the destination to transfer the detached range to.
-             * If not specified, the detached range is destroyed.
-             */
-            detachEdit(source, destination) {
-                const [parent, key] = cursor.getParent();
-                (0, internal_1.assert)(destination === undefined || parent !== this.forest.roots || key !== destination, 0x7b9 /* Detach destination field must be different from current field */);
-                const currentField = getOrCreateField(parent, key);
-                (0, index_js_2.assertValidRange)(source, currentField);
-                const content = currentField.splice(source.start, source.end - source.start);
-                if (destination !== undefined) {
-                    this.forest.addFieldAsDetached(content, destination);
+            acquireVisitor() {
+                (0, internal_1.assert)(this.activeVisitor === undefined, 0x76c /* Must release existing visitor before acquiring another */);
+                // Note: This code uses cursors, however it also modifies the tree.
+                // In general this is not safe, but this code happens to only modify the tree below the current cursor location,
+                // which happens to work.
+                // This pattern could be generalized/formalized with a concept of an exclusive cursor,
+                // which can edit, but is the only cursor allowed at the time.
+                const cursor = this.allocateCursor("acquireVisitor");
+                cursor.setToAboveDetachedSequences();
+                /**
+                 * Called before each edit to allow cursor cleanup to happen and ensure that there are no unexpected cursors.
+                 * This is required for each change since there may be app facing change event handlers which create cursors.
+                 */
+                const preEdit = () => {
+                    __classPrivateFieldGet(this, _ObjectForest_events, "f").emit("beforeChange");
+                    (0, internal_1.assert)(this.currentCursors.has(cursor), 0x995 /* missing visitor cursor while editing */);
+                    if (this.currentCursors.size > 1) {
+                        const unexpectedSources = [...this.currentCursors].flatMap((c) => c === cursor ? [] : (c.source ?? null));
+                        throw new Error(`Found unexpected cursors when editing with the following annotations: ${JSON.stringify(unexpectedSources)}`);
+                    }
+                };
+                class Visitor {
+                    constructor(forest) {
+                        this.forest = forest;
+                    }
+                    free() {
+                        cursor.free();
+                        (0, internal_1.assert)(this.forest.activeVisitor !== undefined, 0x76d /* Multiple free calls for same visitor */);
+                        this.forest.activeVisitor = undefined;
+                        if (this.forest.additionalAsserts) {
+                            // Schema validation:
+                            // When doing "additionalAsserts", validate the content against the schema after every batch of edits.
+                            this.forest.checkSchema();
+                        }
+                    }
+                    destroy(detachedField, count) {
+                        preEdit();
+                        this.forest.delete(detachedField);
+                    }
+                    create(content, destination) {
+                        preEdit();
+                        this.forest.add(content, destination);
+                        __classPrivateFieldGet(this.forest, _ObjectForest_events, "f").emit("afterRootFieldCreated", destination);
+                    }
+                    attach(source, count, destination) {
+                        preEdit();
+                        this.attachEdit(source, count, destination);
+                    }
+                    detach(source, destination, id) {
+                        preEdit();
+                        this.detachEdit(source, destination);
+                    }
+                    /**
+                     * Attaches the nodes from the given source field into the current field.
+                     * Does not invalidate dependents.
+                     * @param source - The the range to be attached.
+                     * @param count - The number of nodes being attached.
+                     * Expected to match the number of nodes in the source detached field.
+                     * @param destination - The index in the current field at which to attach the content.
+                     */
+                    attachEdit(source, count, destination) {
+                        (0, index_js_2.assertNonNegativeSafeInteger)(count);
+                        if (count === 0) {
+                            return;
+                        }
+                        const [parent, key] = cursor.getParent();
+                        (0, internal_1.assert)(parent !== this.forest.roots || key !== source, 0x7b6 /* Attach source field must be different from current field */);
+                        const currentField = getOrCreateField(parent, key);
+                        (0, index_js_2.assertValidIndex)(destination, currentField, true);
+                        const sourceField = __classPrivateFieldGet(this.forest, _ObjectForest_roots, "f").fields.get(source) ?? [];
+                        (0, internal_1.assert)(sourceField !== undefined, 0x7b7 /* Attach source field must exist */);
+                        (0, internal_1.assert)(sourceField.length === count, 0x7b8 /* Attach must consume all nodes in source field */);
+                        // TODO: this will fail for very large insertions due to argument limits.
+                        currentField.splice(destination, 0, ...sourceField);
+                        this.forest.delete(source);
+                    }
+                    /**
+                     * Detaches the range from the current field and transfers it to the given destination if any.
+                     * Does not invalidate dependents.
+                     * @param source - The bounds of the range to be detached from the current field.
+                     * @param destination - If specified, the destination to transfer the detached range to.
+                     * If not specified, the detached range is destroyed.
+                     */
+                    detachEdit(source, destination) {
+                        const [parent, key] = cursor.getParent();
+                        (0, internal_1.assert)(destination === undefined || parent !== this.forest.roots || key !== destination, 0x7b9 /* Detach destination field must be different from current field */);
+                        const currentField = getOrCreateField(parent, key);
+                        (0, index_js_2.assertValidRange)(source, currentField);
+                        const content = currentField.splice(source.start, source.end - source.start);
+                        if (destination !== undefined) {
+                            this.forest.addFieldAsDetached(content, destination);
+                        }
+                        // This check is performed after the transfer to ensure that the field is not removed in scenarios
+                        // where the source and destination are the same.
+                        if (currentField.length === 0) {
+                            parent.fields.delete(key);
+                        }
+                    }
+                    enterNode(index) {
+                        cursor.enterNode(index);
+                    }
+                    exitNode(index) {
+                        cursor.exitNode();
+                    }
+                    enterField(key) {
+                        cursor.enterField(key);
+                    }
+                    exitField(key) {
+                        cursor.exitField();
+                    }
                 }
-                // This check is performed after the transfer to ensure that the field is not removed in scenarios
-                // where the source and destination are the same.
-                if (currentField.length === 0) {
-                    parent.fields.delete(key);
+                const forestVisitor = new Visitor(this);
+                const announcedVisitors = [];
+                this.deltaVisitors.forEach((getVisitor) => announcedVisitors.push(getVisitor()));
+                const combinedVisitor = (0, index_js_1.combineVisitors)([forestVisitor, ...announcedVisitors]);
+                this.activeVisitor = combinedVisitor;
+                return combinedVisitor;
+            }
+            registerAnnouncedVisitor(visitor) {
+                this.deltaVisitors.add(visitor);
+            }
+            deregisterAnnouncedVisitor(visitor) {
+                this.deltaVisitors.delete(visitor);
+            }
+            newDetachedField() {
+                const range = (0, index_js_2.brand)(String(this.nextRange));
+                this.nextRange += 1;
+                return range;
+            }
+            add(nodes, key) {
+                const field = Array.from(nodes, mapTreeCursor_js_1.mapTreeFromCursor);
+                this.addFieldAsDetached(field, key);
+            }
+            addFieldAsDetached(field, key) {
+                (0, internal_1.assert)(!this.roots.fields.has(key), 0x370 /* new range must not already exist */);
+                if (field.length > 0) {
+                    __classPrivateFieldGet(this, _ObjectForest_roots, "f").fields.set(key, field);
                 }
             }
-            enterNode(index) {
-                cursor.enterNode(index);
+            delete(field) {
+                __classPrivateFieldGet(this, _ObjectForest_roots, "f").fields.delete(field);
             }
-            exitNode(index) {
-                cursor.exitNode();
+            allocateCursor(source) {
+                return new Cursor(this, source);
             }
-            enterField(key) {
-                cursor.enterField(key);
+            tryMoveCursorToNode(destination, cursorToMove) {
+                const path = this.anchors.locate(destination);
+                if (path === undefined) {
+                    return -1 /* TreeNavigationResult.NotFound */;
+                }
+                this.moveCursorToPath(path, cursorToMove);
+                return 1 /* TreeNavigationResult.Ok */;
             }
-            exitField(key) {
-                cursor.exitField();
+            tryMoveCursorToField(destination, cursorToMove) {
+                if (destination.parent === undefined) {
+                    this.moveCursorToPath(undefined, cursorToMove);
+                }
+                else {
+                    const result = this.tryMoveCursorToNode(destination.parent, cursorToMove);
+                    if (result !== 1 /* TreeNavigationResult.Ok */) {
+                        return result;
+                    }
+                }
+                cursorToMove.enterField(destination.fieldKey);
+                return 1 /* TreeNavigationResult.Ok */;
             }
-        }
-        const forestVisitor = new Visitor(this);
-        const announcedVisitors = [];
-        this.deltaVisitors.forEach((getVisitor) => announcedVisitors.push(getVisitor()));
-        const combinedVisitor = (0, index_js_1.combineVisitors)([forestVisitor, ...announcedVisitors]);
-        this.activeVisitor = combinedVisitor;
-        return combinedVisitor;
-    }
-    registerAnnouncedVisitor(visitor) {
-        this.deltaVisitors.add(visitor);
-    }
-    deregisterAnnouncedVisitor(visitor) {
-        this.deltaVisitors.delete(visitor);
-    }
-    newDetachedField() {
-        const range = (0, index_js_2.brand)(String(this.nextRange));
-        this.nextRange += 1;
-        return range;
-    }
-    add(nodes, key) {
-        const field = Array.from(nodes, mapTreeCursor_js_1.mapTreeFromCursor);
-        this.addFieldAsDetached(field, key);
-    }
-    addFieldAsDetached(field, key) {
-        (0, internal_1.assert)(!this.roots.fields.has(key), 0x370 /* new range must not already exist */);
-        if (field.length > 0) {
-            __classPrivateFieldGet(this, _ObjectForest_roots, "f").fields.set(key, field);
-        }
-    }
-    delete(field) {
-        __classPrivateFieldGet(this, _ObjectForest_roots, "f").fields.delete(field);
-    }
-    allocateCursor(source) {
-        return new Cursor(this, source);
-    }
-    tryMoveCursorToNode(destination, cursorToMove) {
-        const path = this.anchors.locate(destination);
-        if (path === undefined) {
-            return -1 /* TreeNavigationResult.NotFound */;
-        }
-        this.moveCursorToPath(path, cursorToMove);
-        return 1 /* TreeNavigationResult.Ok */;
-    }
-    tryMoveCursorToField(destination, cursorToMove) {
-        if (destination.parent === undefined) {
-            this.moveCursorToPath(undefined, cursorToMove);
-        }
-        else {
-            const result = this.tryMoveCursorToNode(destination.parent, cursorToMove);
-            if (result !== 1 /* TreeNavigationResult.Ok */) {
-                return result;
+            moveCursorToPath(destination, cursorToMove) {
+                (0, internal_1.assert)(cursorToMove instanceof Cursor, 0x337 /* ObjectForest must only be given its own Cursor type */);
+                (0, internal_1.assert)(cursorToMove.forest === this, 0x338 /* ObjectForest must only be given its own Cursor */);
+                const indexStack = [];
+                const keyStack = [];
+                let path = destination;
+                while (path !== undefined) {
+                    indexStack.push(path.parentIndex);
+                    keyStack.push(path.parentField);
+                    path = path.parent;
+                }
+                cursorToMove.setToAboveDetachedSequences();
+                while (keyStack.length > 0) {
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    cursorToMove.enterField(keyStack.pop());
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    cursorToMove.enterNode(indexStack.pop());
+                }
+                return;
             }
-        }
-        cursorToMove.enterField(destination.fieldKey);
-        return 1 /* TreeNavigationResult.Ok */;
-    }
-    moveCursorToPath(destination, cursorToMove) {
-        (0, internal_1.assert)(cursorToMove instanceof Cursor, 0x337 /* ObjectForest must only be given its own Cursor type */);
-        (0, internal_1.assert)(cursorToMove.forest === this, 0x338 /* ObjectForest must only be given its own Cursor */);
-        const indexStack = [];
-        const keyStack = [];
-        let path = destination;
-        while (path !== undefined) {
-            indexStack.push(path.parentIndex);
-            keyStack.push(path.parentField);
-            path = path.parent;
-        }
-        cursorToMove.setToAboveDetachedSequences();
-        while (keyStack.length > 0) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            cursorToMove.enterField(keyStack.pop());
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            cursorToMove.enterNode(indexStack.pop());
-        }
-        return;
-    }
-    getCursorAboveDetachedFields() {
-        return (0, mapTreeCursor_js_1.cursorForMapTreeNode)(this.roots);
-    }
-}
+            getCursorAboveDetachedFields() {
+                return (0, mapTreeCursor_js_1.cursorForMapTreeNode)(this.roots);
+            }
+        },
+        _ObjectForest_events = new WeakMap(),
+        _ObjectForest_roots = new WeakMap(),
+        (() => {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            _checkSchema_decorators = [index_js_2.breakingMethod];
+            __esDecorate(_a, null, _checkSchema_decorators, { kind: "method", name: "checkSchema", static: false, private: false, access: { has: obj => "checkSchema" in obj, get: obj => obj.checkSchema }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(_a, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        })(),
+        _a;
+})();
 exports.ObjectForest = ObjectForest;
-_ObjectForest_events = new WeakMap(), _ObjectForest_roots = new WeakMap();
 /**
  * Cursor implementation for ObjectForest.
  */
@@ -416,10 +502,13 @@ class Cursor extends treeCursorUtils_js_1.SynchronousCursor {
 // When other forest implementations are created (ex: optimized ones),
 // this function should likely be moved and updated to (at least conditionally) use them.
 /**
- * @returns an implementation of {@link IEditableForest} with no data or schema.
+ * Returns an implementation of {@link IEditableForest} with no content.
+ * @privateRemarks
+ * TODO:
+ * refactor to remove this function, and instead place `ForestTypeReference` and `ForestTypeExpensiveDebug` here as a better way to encapsulate ObjectForest.
  */
-function buildForest(anchors, additionalAsserts = false) {
-    return new ObjectForest(anchors, additionalAsserts);
+function buildForest(breaker, schema, anchors, additionalAsserts = false) {
+    return new ObjectForest(breaker, schema, anchors, additionalAsserts);
 }
 exports.buildForest = buildForest;
 //# sourceMappingURL=objectForest.js.map