@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/fieldGenerator.d.ts

@@ -0,0 +1,46 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FieldKey, TreeFieldStoredSchema, MapTree } from "../core";
+import { FlexTreeSchema } from "./typed-schema";
+/**
+ * Information needed to interpret a subtree described by {@link ContextuallyTypedNodeData} and {@link ContextuallyTypedFieldData}.
+ * TODO:
+ * Currently being exposed at the package level which also requires us to export MapTree at the package level.
+ * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.
+ * @internal
+ */
+export interface TreeDataContext {
+    /**
+     * Schema for the document which the tree will be used in.
+     */
+    readonly schema: FlexTreeSchema;
+    /**
+     * Procedural data generator for fields.
+     * Fields which provide generators here can be omitted in the input contextually typed data.
+     *
+     * @remarks
+     * TODO:
+     * For implementers of this which are not pure (like identifier generation),
+     * order of invocation should be made consistent and documented.
+     * This will be important for identifier elision optimizations in tree encoding for session based identifier generation.
+     */
+    fieldSource?(key: FieldKey, schema: TreeFieldStoredSchema): undefined | FieldGenerator;
+}
+/**
+ * Generates field content for a MapTree on demand.
+ * TODO:
+ * Currently being exposed at the package level which also requires us to export MapTree at the package level.
+ * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.
+ * @internal
+ */
+export type FieldGenerator = () => MapTree[];
+/**
+ * Information needed to interpret a subtree described by {@link ContextuallyTypedNodeData} and {@link ContextuallyTypedFieldData}.
+ * TODO:
+ * Currently being exposed at the package level which also requires us to export MapTree at the package level.
+ * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.
+ * @internal
+ */
+//# sourceMappingURL=fieldGenerator.d.ts.map

package/dist/feature-libraries/fieldGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldGenerator.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/fieldGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAEhC;;;;;;;;;OASG;IACH,WAAW,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,GAAG,cAAc,CAAC;CACvF;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,EAAE,CAAC;AAC7C;;;;;;GAMG"}

package/dist/feature-libraries/fieldGenerator.js

@@ -0,0 +1,14 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Information needed to interpret a subtree described by {@link ContextuallyTypedNodeData} and {@link ContextuallyTypedFieldData}.
+ * TODO:
+ * Currently being exposed at the package level which also requires us to export MapTree at the package level.
+ * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.
+ * @internal
+ */
+//# sourceMappingURL=fieldGenerator.js.map

package/dist/feature-libraries/fieldGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldGenerator.js","sourceRoot":"","sources":["../../src/feature-libraries/fieldGenerator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAuCH;;;;;;GAMG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FieldKey, TreeFieldStoredSchema, MapTree } from \"../core\";\nimport { FlexTreeSchema } from \"./typed-schema\";\n\n/**\n * Information needed to interpret a subtree described by {@link ContextuallyTypedNodeData} and {@link ContextuallyTypedFieldData}.\n * TODO:\n * Currently being exposed at the package level which also requires us to export MapTree at the package level.\n * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.\n * @internal\n */\nexport interface TreeDataContext {\n\t/**\n\t * Schema for the document which the tree will be used in.\n\t */\n\treadonly schema: FlexTreeSchema;\n\n\t/**\n\t * Procedural data generator for fields.\n\t * Fields which provide generators here can be omitted in the input contextually typed data.\n\t *\n\t * @remarks\n\t * TODO:\n\t * For implementers of this which are not pure (like identifier generation),\n\t * order of invocation should be made consistent and documented.\n\t * This will be important for identifier elision optimizations in tree encoding for session based identifier generation.\n\t */\n\tfieldSource?(key: FieldKey, schema: TreeFieldStoredSchema): undefined | FieldGenerator;\n}\n\n/**\n * Generates field content for a MapTree on demand.\n * TODO:\n * Currently being exposed at the package level which also requires us to export MapTree at the package level.\n * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.\n * @internal\n */\nexport type FieldGenerator = () => MapTree[];\n/**\n * Information needed to interpret a subtree described by {@link ContextuallyTypedNodeData} and {@link ContextuallyTypedFieldData}.\n * TODO:\n * Currently being exposed at the package level which also requires us to export MapTree at the package level.\n * Refactor the FieldGenerator to use JsonableTree instead of MapTree, and convert them internally.\n * @internal\n */\n"]}

package/dist/feature-libraries/flex-tree/context.d.ts

@@ -0,0 +1,87 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ForestEvents, TreeFieldStoredSchema, FieldKey, IForestSubscription } from "../../core";
+import { ISubscribable } from "../../events";
+import { IDefaultEditBuilder } from "../default-schema";
+import { NodeKeyManager } from "../node-key";
+import { FieldGenerator } from "../fieldGenerator";
+import { FlexTreeSchema } from "../typed-schema";
+import { disposeSymbol, IDisposable } from "../../util";
+import { FlexTreeField } from "./flexTreeTypes";
+import { LazyEntity } from "./lazyEntity";
+import { NodeKeys } from "./nodeKeys";
+/**
+ * A common context of a "forest" of EditableTrees.
+ * It handles group operations like transforming cursors into anchors for edits.
+ * @internal
+ */
+export interface FlexTreeContext extends ISubscribable<ForestEvents> {
+    /**
+     * Gets the root field of the tree.
+     */
+    get root(): FlexTreeField;
+    /**
+     * Schema used within this context.
+     * All data must conform to these schema.
+     */
+    readonly schema: FlexTreeSchema;
+    readonly nodeKeys: NodeKeys;
+}
+/**
+ * Implementation of `EditableTreeContext`.
+ *
+ * @remarks An editor is required to edit the EditableTrees.
+ */
+export declare class Context implements FlexTreeContext, IDisposable {
+    readonly schema: FlexTreeSchema;
+    readonly forest: IForestSubscription;
+    readonly editor: IDefaultEditBuilder;
+    readonly nodeKeys: NodeKeys;
+    readonly nodeKeyFieldKey: FieldKey;
+    readonly withCursors: Set<LazyEntity>;
+    readonly withAnchors: Set<LazyEntity>;
+    private readonly eventUnregister;
+    private disposed;
+    /**
+     * @param forest - the Forest
+     * @param editor - an editor that makes changes to the forest.
+     * @param nodeKeys - an object which handles node key generation and conversion
+     * @param nodeKeyFieldKey - an optional field key under which node keys are stored in this tree.
+     * If present, clients may query the {@link LocalNodeKey} of a node directly via the {@link localNodeKeySymbol}.
+     */
+    constructor(schema: FlexTreeSchema, forest: IForestSubscription, editor: IDefaultEditBuilder, nodeKeys: NodeKeys, nodeKeyFieldKey: FieldKey);
+    /**
+     * Called before editing.
+     * Clears all cursors so editing can proceed.
+     */
+    private prepareForEdit;
+    [disposeSymbol](): void;
+    /**
+     * Release any cursors and anchors held by tree entities created in this context.
+     * Ensures the cashed references to those entities on the Anchors are also cleared.
+     * The tree entities are invalid to use after this, but the context may still be used
+     * to create new trees starting from the root.
+     */
+    clear(): void;
+    get root(): FlexTreeField;
+    on<K extends keyof ForestEvents>(eventName: K, listener: ForestEvents[K]): () => void;
+    /**
+     * FieldSource used to get a FieldGenerator to populate required fields during procedural contextual data generation.
+     */
+    fieldSource?(key: FieldKey, schema: TreeFieldStoredSchema): undefined | FieldGenerator;
+}
+/**
+ * A simple API for a Forest to interact with the tree.
+ *
+ * @param forest - the Forest
+ * @param editor - an editor that makes changes to the forest.
+ * @param nodeKeyManager - an object which handles node key generation and conversion.
+ * @param nodeKeyFieldKey - an optional field key under which node keys are stored in this tree.
+ * If present, clients may query the {@link LocalNodeKey} of a node directly via the {@link localNodeKeySymbol}.
+ * @returns {@link EditableTreeContext} which is used to manage the cursors and anchors within the EditableTrees:
+ * This is necessary for supporting using this tree across edits to the forest, and not leaking memory.
+ */
+export declare function getTreeContext(schema: FlexTreeSchema, forest: IForestSubscription, editor: IDefaultEditBuilder, nodeKeyManager: NodeKeyManager, nodeKeyFieldKey: FieldKey): Context;
+//# sourceMappingURL=context.d.ts.map

package/dist/feature-libraries/flex-tree/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/flex-tree/context.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,YAAY,EACZ,qBAAqB,EACrB,QAAQ,EACR,mBAAmB,EACnB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,UAAU,EAAwB,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAkB,MAAM,YAAY,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa,CAAC,YAAY,CAAC;IACnE;;OAEG;IACH,IAAI,IAAI,IAAI,aAAa,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAMhC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC5B;AAED;;;;GAIG;AACH,qBAAa,OAAQ,YAAW,eAAe,EAAE,WAAW;aAe1C,MAAM,EAAE,cAAc;aACtB,MAAM,EAAE,mBAAmB;aAC3B,MAAM,EAAE,mBAAmB;aAC3B,QAAQ,EAAE,QAAQ;aAClB,eAAe,EAAE,QAAQ;IAlB1C,SAAgB,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,CAAa;IACzD,SAAgB,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,CAAa;IAEzD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAS;IAEzB;;;;;;OAMG;gBAEc,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,EAAE,QAAQ,EAClB,eAAe,EAAE,QAAQ;IAS1C;;;OAGG;IACH,OAAO,CAAC,cAAc;IAQf,CAAC,aAAa,CAAC,IAAI,IAAI;IAU9B;;;;;OAKG;IACI,KAAK,IAAI,IAAI;IAQpB,IAAW,IAAI,IAAI,aAAa,CAO/B;IAEM,EAAE,CAAC,CAAC,SAAS,MAAM,YAAY,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAI5F;;OAEG;IAEI,WAAW,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,qBAAqB,GAAG,SAAS,GAAG,cAAc;CAC7F;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,mBAAmB,EAC3B,cAAc,EAAE,cAAc,EAC9B,eAAe,EAAE,QAAQ,GACvB,OAAO,CAQT"}

package/dist/feature-libraries/flex-tree/context.js

@@ -0,0 +1,110 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTreeContext = exports.Context = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const core_1 = require("../../core");
+const node_key_1 = require("../node-key");
+const util_1 = require("../../util");
+const lazyField_1 = require("./lazyField");
+const lazyEntity_1 = require("./lazyEntity");
+const nodeKeys_1 = require("./nodeKeys");
+/**
+ * Implementation of `EditableTreeContext`.
+ *
+ * @remarks An editor is required to edit the EditableTrees.
+ */
+class Context {
+    /**
+     * @param forest - the Forest
+     * @param editor - an editor that makes changes to the forest.
+     * @param nodeKeys - an object which handles node key generation and conversion
+     * @param nodeKeyFieldKey - an optional field key under which node keys are stored in this tree.
+     * If present, clients may query the {@link LocalNodeKey} of a node directly via the {@link localNodeKeySymbol}.
+     */
+    constructor(schema, forest, editor, nodeKeys, nodeKeyFieldKey) {
+        this.schema = schema;
+        this.forest = forest;
+        this.editor = editor;
+        this.nodeKeys = nodeKeys;
+        this.nodeKeyFieldKey = nodeKeyFieldKey;
+        this.withCursors = new Set();
+        this.withAnchors = new Set();
+        this.disposed = false;
+        this.eventUnregister = [
+            this.forest.on("beforeChange", () => {
+                this.prepareForEdit();
+            }),
+        ];
+    }
+    /**
+     * Called before editing.
+     * Clears all cursors so editing can proceed.
+     */
+    prepareForEdit() {
+        (0, core_utils_1.assert)(this.disposed === false, 0x802 /* use after dispose */);
+        for (const target of this.withCursors) {
+            target[lazyEntity_1.prepareForEditSymbol]();
+        }
+        (0, core_utils_1.assert)(this.withCursors.size === 0, 0x773 /* prepareForEdit should remove all cursors */);
+    }
+    [util_1.disposeSymbol]() {
+        (0, core_utils_1.assert)(this.disposed === false, 0x803 /* double dispose */);
+        this.disposed = true;
+        this.clear();
+        for (const unregister of this.eventUnregister) {
+            unregister();
+        }
+        this.eventUnregister.length = 0;
+    }
+    /**
+     * Release any cursors and anchors held by tree entities created in this context.
+     * Ensures the cashed references to those entities on the Anchors are also cleared.
+     * The tree entities are invalid to use after this, but the context may still be used
+     * to create new trees starting from the root.
+     */
+    clear() {
+        for (const target of this.withAnchors) {
+            target[util_1.disposeSymbol]();
+        }
+        (0, core_utils_1.assert)(this.withCursors.size === 0, 0x774 /* free should remove all cursors */);
+        (0, core_utils_1.assert)(this.withAnchors.size === 0, 0x775 /* free should remove all anchors */);
+    }
+    get root() {
+        (0, core_utils_1.assert)(this.disposed === false, 0x804 /* use after dispose */);
+        const cursor = this.forest.allocateCursor();
+        (0, core_1.moveToDetachedField)(this.forest, cursor);
+        const field = (0, lazyField_1.makeField)(this, this.schema.rootFieldSchema, cursor);
+        cursor.free();
+        return field;
+    }
+    on(eventName, listener) {
+        return this.forest.on(eventName, listener);
+    }
+}
+exports.Context = Context;
+/**
+ * A simple API for a Forest to interact with the tree.
+ *
+ * @param forest - the Forest
+ * @param editor - an editor that makes changes to the forest.
+ * @param nodeKeyManager - an object which handles node key generation and conversion.
+ * @param nodeKeyFieldKey - an optional field key under which node keys are stored in this tree.
+ * If present, clients may query the {@link LocalNodeKey} of a node directly via the {@link localNodeKeySymbol}.
+ * @returns {@link EditableTreeContext} which is used to manage the cursors and anchors within the EditableTrees:
+ * This is necessary for supporting using this tree across edits to the forest, and not leaking memory.
+ */
+function getTreeContext(schema, forest, editor, nodeKeyManager, nodeKeyFieldKey) {
+    const nodeKeys = new nodeKeys_1.SimpleNodeKeys(new node_key_1.NodeKeyIndex(nodeKeyFieldKey), nodeKeyManager);
+    const context = new Context(schema, forest, editor, nodeKeys, nodeKeyFieldKey);
+    nodeKeys.map.scanKeys(context);
+    context.on("afterChange", () => {
+        nodeKeys.map.scanKeys(context);
+    });
+    return context;
+}
+exports.getTreeContext = getTreeContext;
+//# sourceMappingURL=context.js.map

package/dist/feature-libraries/flex-tree/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../src/feature-libraries/flex-tree/context.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,qCAMoB;AAGpB,0CAA2D;AAG3D,qCAAwD;AAExD,2CAAwC;AACxC,6CAAgE;AAChE,yCAAsD;AA0BtD;;;;GAIG;AACH,MAAa,OAAO;IAOnB;;;;;;OAMG;IACH,YACiB,MAAsB,EACtB,MAA2B,EAC3B,MAA2B,EAC3B,QAAkB,EAClB,eAAyB;QAJzB,WAAM,GAAN,MAAM,CAAgB;QACtB,WAAM,GAAN,MAAM,CAAqB;QAC3B,WAAM,GAAN,MAAM,CAAqB;QAC3B,aAAQ,GAAR,QAAQ,CAAU;QAClB,oBAAe,GAAf,eAAe,CAAU;QAlB1B,gBAAW,GAAoB,IAAI,GAAG,EAAE,CAAC;QACzC,gBAAW,GAAoB,IAAI,GAAG,EAAE,CAAC;QAGjD,aAAQ,GAAG,KAAK,CAAC;QAgBxB,IAAI,CAAC,eAAe,GAAG;YACtB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;gBACnC,IAAI,CAAC,cAAc,EAAE,CAAC;YACvB,CAAC,CAAC;SACF,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,cAAc;QACrB,IAAA,mBAAM,EAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC/D,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE;YACtC,MAAM,CAAC,iCAAoB,CAAC,EAAE,CAAC;SAC/B;QACD,IAAA,mBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAC3F,CAAC;IAEM,CAAC,oBAAa,CAAC;QACrB,IAAA,mBAAM,EAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,eAAe,EAAE;YAC9C,UAAU,EAAE,CAAC;SACb;QACD,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK;QACX,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE;YACtC,MAAM,CAAC,oBAAa,CAAC,EAAE,CAAC;SACxB;QACD,IAAA,mBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAChF,IAAA,mBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACjF,CAAC;IAED,IAAW,IAAI;QACd,IAAA,mBAAM,EAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAC5C,IAAA,0BAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAA,qBAAS,EAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,EAAE,CAA+B,SAAY,EAAE,QAAyB;QAC9E,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;CAOD;AAlFD,0BAkFC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,cAAc,CAC7B,MAAsB,EACtB,MAA2B,EAC3B,MAA2B,EAC3B,cAA8B,EAC9B,eAAyB;IAEzB,MAAM,QAAQ,GAAG,IAAI,yBAAc,CAAC,IAAI,uBAAY,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC,CAAC;IACvF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC/E,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,CAAC,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;QAC9B,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AAChB,CAAC;AAdD,wCAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport {\n\tmoveToDetachedField,\n\tForestEvents,\n\tTreeFieldStoredSchema,\n\tFieldKey,\n\tIForestSubscription,\n} from \"../../core\";\nimport { ISubscribable } from \"../../events\";\nimport { IDefaultEditBuilder } from \"../default-schema\";\nimport { NodeKeyIndex, NodeKeyManager } from \"../node-key\";\nimport { FieldGenerator } from \"../fieldGenerator\";\nimport { FlexTreeSchema } from \"../typed-schema\";\nimport { disposeSymbol, IDisposable } from \"../../util\";\nimport { FlexTreeField } from \"./flexTreeTypes\";\nimport { makeField } from \"./lazyField\";\nimport { LazyEntity, prepareForEditSymbol } from \"./lazyEntity\";\nimport { NodeKeys, SimpleNodeKeys } from \"./nodeKeys\";\n\n/**\n * A common context of a \"forest\" of EditableTrees.\n * It handles group operations like transforming cursors into anchors for edits.\n * @internal\n */\nexport interface FlexTreeContext extends ISubscribable<ForestEvents> {\n\t/**\n\t * Gets the root field of the tree.\n\t */\n\tget root(): FlexTreeField;\n\n\t/**\n\t * Schema used within this context.\n\t * All data must conform to these schema.\n\t */\n\treadonly schema: FlexTreeSchema;\n\n\t// TODO: Add more members:\n\t// - transaction APIs\n\t// - branching APIs\n\n\treadonly nodeKeys: NodeKeys;\n}\n\n/**\n * Implementation of `EditableTreeContext`.\n *\n * @remarks An editor is required to edit the EditableTrees.\n */\nexport class Context implements FlexTreeContext, IDisposable {\n\tpublic readonly withCursors: Set<LazyEntity> = new Set();\n\tpublic readonly withAnchors: Set<LazyEntity> = new Set();\n\n\tprivate readonly eventUnregister: (() => void)[];\n\tprivate disposed = false;\n\n\t/**\n\t * @param forest - the Forest\n\t * @param editor - an editor that makes changes to the forest.\n\t * @param nodeKeys - an object which handles node key generation and conversion\n\t * @param nodeKeyFieldKey - an optional field key under which node keys are stored in this tree.\n\t * If present, clients may query the {@link LocalNodeKey} of a node directly via the {@link localNodeKeySymbol}.\n\t */\n\tpublic constructor(\n\t\tpublic readonly schema: FlexTreeSchema,\n\t\tpublic readonly forest: IForestSubscription,\n\t\tpublic readonly editor: IDefaultEditBuilder,\n\t\tpublic readonly nodeKeys: NodeKeys,\n\t\tpublic readonly nodeKeyFieldKey: FieldKey,\n\t) {\n\t\tthis.eventUnregister = [\n\t\t\tthis.forest.on(\"beforeChange\", () => {\n\t\t\t\tthis.prepareForEdit();\n\t\t\t}),\n\t\t];\n\t}\n\n\t/**\n\t * Called before editing.\n\t * Clears all cursors so editing can proceed.\n\t */\n\tprivate prepareForEdit(): void {\n\t\tassert(this.disposed === false, 0x802 /* use after dispose */);\n\t\tfor (const target of this.withCursors) {\n\t\t\ttarget[prepareForEditSymbol]();\n\t\t}\n\t\tassert(this.withCursors.size === 0, 0x773 /* prepareForEdit should remove all cursors */);\n\t}\n\n\tpublic [disposeSymbol](): void {\n\t\tassert(this.disposed === false, 0x803 /* double dispose */);\n\t\tthis.disposed = true;\n\t\tthis.clear();\n\t\tfor (const unregister of this.eventUnregister) {\n\t\t\tunregister();\n\t\t}\n\t\tthis.eventUnregister.length = 0;\n\t}\n\n\t/**\n\t * Release any cursors and anchors held by tree entities created in this context.\n\t * Ensures the cashed references to those entities on the Anchors are also cleared.\n\t * The tree entities are invalid to use after this, but the context may still be used\n\t * to create new trees starting from the root.\n\t */\n\tpublic clear(): void {\n\t\tfor (const target of this.withAnchors) {\n\t\t\ttarget[disposeSymbol]();\n\t\t}\n\t\tassert(this.withCursors.size === 0, 0x774 /* free should remove all cursors */);\n\t\tassert(this.withAnchors.size === 0, 0x775 /* free should remove all anchors */);\n\t}\n\n\tpublic get root(): FlexTreeField {\n\t\tassert(this.disposed === false, 0x804 /* use after dispose */);\n\t\tconst cursor = this.forest.allocateCursor();\n\t\tmoveToDetachedField(this.forest, cursor);\n\t\tconst field = makeField(this, this.schema.rootFieldSchema, cursor);\n\t\tcursor.free();\n\t\treturn field;\n\t}\n\n\tpublic on<K extends keyof ForestEvents>(eventName: K, listener: ForestEvents[K]): () => void {\n\t\treturn this.forest.on(eventName, listener);\n\t}\n\n\t/**\n\t * FieldSource used to get a FieldGenerator to populate required fields during procedural contextual data generation.\n\t */\n\t// TODO: Use this to automatically provide node keys where required.\n\tpublic fieldSource?(key: FieldKey, schema: TreeFieldStoredSchema): undefined | FieldGenerator;\n}\n\n/**\n * A simple API for a Forest to interact with the tree.\n *\n * @param forest - the Forest\n * @param editor - an editor that makes changes to the forest.\n * @param nodeKeyManager - an object which handles node key generation and conversion.\n * @param nodeKeyFieldKey - an optional field key under which node keys are stored in this tree.\n * If present, clients may query the {@link LocalNodeKey} of a node directly via the {@link localNodeKeySymbol}.\n * @returns {@link EditableTreeContext} which is used to manage the cursors and anchors within the EditableTrees:\n * This is necessary for supporting using this tree across edits to the forest, and not leaking memory.\n */\nexport function getTreeContext(\n\tschema: FlexTreeSchema,\n\tforest: IForestSubscription,\n\teditor: IDefaultEditBuilder,\n\tnodeKeyManager: NodeKeyManager,\n\tnodeKeyFieldKey: FieldKey,\n): Context {\n\tconst nodeKeys = new SimpleNodeKeys(new NodeKeyIndex(nodeKeyFieldKey), nodeKeyManager);\n\tconst context = new Context(schema, forest, editor, nodeKeys, nodeKeyFieldKey);\n\tnodeKeys.map.scanKeys(context);\n\tcontext.on(\"afterChange\", () => {\n\t\tnodeKeys.map.scanKeys(context);\n\t});\n\treturn context;\n}\n"]}