@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/codec/noopValidator.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { JsonValidator } from "./codec";
+/**
+ * A {@link JsonValidator} implementation which performs no validation and accepts all data as valid.
+ * @privateRemarks Having this as an option unifies opting out of validation with selection of
+ * validators, simplifying code performing validation.
+ * @internal
+ */
+export declare const noopValidator: JsonValidator;
+//# sourceMappingURL=noopValidator.d.ts.map

package/dist/codec/noopValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noopValidator.d.ts","sourceRoot":"","sources":["../../src/codec/noopValidator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,aAE3B,CAAC"}

package/dist/codec/noopValidator.js

@@ -0,0 +1,17 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noopValidator = void 0;
+/**
+ * A {@link JsonValidator} implementation which performs no validation and accepts all data as valid.
+ * @privateRemarks Having this as an option unifies opting out of validation with selection of
+ * validators, simplifying code performing validation.
+ * @internal
+ */
+exports.noopValidator = {
+    compile: () => ({ check: (data) => true }),
+};
+//# sourceMappingURL=noopValidator.js.map

package/dist/codec/noopValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noopValidator.js","sourceRoot":"","sources":["../../src/codec/noopValidator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;;;GAKG;AACU,QAAA,aAAa,GAAkB;IAC3C,OAAO,EAAE,GAA2B,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,EAA0B,EAAE,CAAC,IAAI,EAAE,CAAC;CAC1F,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Static, TSchema } from \"@sinclair/typebox\";\nimport { JsonValidator } from \"./codec\";\n\n/**\n * A {@link JsonValidator} implementation which performs no validation and accepts all data as valid.\n * @privateRemarks Having this as an option unifies opting out of validation with selection of\n * validators, simplifying code performing validation.\n * @internal\n */\nexport const noopValidator: JsonValidator = {\n\tcompile: <Schema extends TSchema>() => ({ check: (data): data is Static<Schema> => true }),\n};\n"]}

package/dist/core/change-family/changeFamily.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ICodecFamily } from "../../codec";
+import { ChangeRebaser } from "../rebase";
+export interface ChangeFamily<TEditor extends ChangeFamilyEditor, TChange> {
+    buildEditor(changeReceiver: (change: TChange) => void): TEditor;
+    readonly rebaser: ChangeRebaser<TChange>;
+    readonly codecs: ICodecFamily<TChange>;
+}
+export interface ChangeFamilyEditor {
+    /**
+     * Must be called when a new transaction starts.
+     *
+     * Note: transactions are an optional feature. It is valid to make edits outside of a transaction.
+     *
+     * For each call to this function, a matching call to `exitTransaction` must be made at a later time.
+     * Can be called repeatedly to indicate the start of nesting transactions.
+     */
+    enterTransaction(): void;
+    /**
+     * Must be called when a transaction ends.
+     *
+     * Note: transactions are an optional feature. It is valid to make edits outside of a transaction.
+     *
+     * For each call to this function, a matching call to `enterTransaction` must be made at an earlier time.
+     * Can be called repeatedly to indicate the end of nesting transactions.
+     */
+    exitTransaction(): void;
+}
+//# sourceMappingURL=changeFamily.d.ts.map

package/dist/core/change-family/changeFamily.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeFamily.d.ts","sourceRoot":"","sources":["../../../src/core/change-family/changeFamily.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,kBAAkB,EAAE,OAAO;IACxE,WAAW,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC;IAEhE,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IAClC;;;;;;;OAOG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;;;;;;OAOG;IACH,eAAe,IAAI,IAAI,CAAC;CACxB"}

package/dist/core/change-family/changeFamily.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=changeFamily.js.map

package/dist/core/change-family/changeFamily.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeFamily.js","sourceRoot":"","sources":["../../../src/core/change-family/changeFamily.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ICodecFamily } from \"../../codec\";\nimport { ChangeRebaser } from \"../rebase\";\n\nexport interface ChangeFamily<TEditor extends ChangeFamilyEditor, TChange> {\n\tbuildEditor(changeReceiver: (change: TChange) => void): TEditor;\n\n\treadonly rebaser: ChangeRebaser<TChange>;\n\treadonly codecs: ICodecFamily<TChange>;\n}\n\nexport interface ChangeFamilyEditor {\n\t/**\n\t * Must be called when a new transaction starts.\n\t *\n\t * Note: transactions are an optional feature. It is valid to make edits outside of a transaction.\n\t *\n\t * For each call to this function, a matching call to `exitTransaction` must be made at a later time.\n\t * Can be called repeatedly to indicate the start of nesting transactions.\n\t */\n\tenterTransaction(): void;\n\n\t/**\n\t * Must be called when a transaction ends.\n\t *\n\t * Note: transactions are an optional feature. It is valid to make edits outside of a transaction.\n\t *\n\t * For each call to this function, a matching call to `enterTransaction` must be made at an earlier time.\n\t * Can be called repeatedly to indicate the end of nesting transactions.\n\t */\n\texitTransaction(): void;\n}\n"]}

package/dist/core/change-family/editBuilder.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ChangeFamily, ChangeFamilyEditor } from "./changeFamily";
+export declare abstract class EditBuilder<TChange> implements ChangeFamilyEditor {
+    protected readonly changeFamily: ChangeFamily<ChangeFamilyEditor, TChange>;
+    private readonly changeReceiver;
+    constructor(changeFamily: ChangeFamily<ChangeFamilyEditor, TChange>, changeReceiver: (change: TChange) => void);
+    /**
+     * Subclasses add editing methods which call this with their generated edits.
+     *
+     * @sealed
+     */
+    protected applyChange(change: TChange): void;
+    enterTransaction(): void;
+    exitTransaction(): void;
+}
+//# sourceMappingURL=editBuilder.d.ts.map

package/dist/core/change-family/editBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editBuilder.d.ts","sourceRoot":"","sources":["../../../src/core/change-family/editBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAElE,8BAAsB,WAAW,CAAC,OAAO,CAAE,YAAW,kBAAkB;IAEtE,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAC1E,OAAO,CAAC,QAAQ,CAAC,cAAc;gBADZ,YAAY,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EACzD,cAAc,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;IAG3D;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAIrC,gBAAgB,IAAI,IAAI;IACxB,eAAe,IAAI,IAAI;CAC9B"}

package/dist/core/change-family/editBuilder.js

@@ -0,0 +1,25 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EditBuilder = void 0;
+class EditBuilder {
+    constructor(changeFamily, changeReceiver) {
+        this.changeFamily = changeFamily;
+        this.changeReceiver = changeReceiver;
+    }
+    /**
+     * Subclasses add editing methods which call this with their generated edits.
+     *
+     * @sealed
+     */
+    applyChange(change) {
+        this.changeReceiver(change);
+    }
+    enterTransaction() { }
+    exitTransaction() { }
+}
+exports.EditBuilder = EditBuilder;
+//# sourceMappingURL=editBuilder.js.map

package/dist/core/change-family/editBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editBuilder.js","sourceRoot":"","sources":["../../../src/core/change-family/editBuilder.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,MAAsB,WAAW;IAChC,YACoB,YAAuD,EACzD,cAAyC;QADvC,iBAAY,GAAZ,YAAY,CAA2C;QACzD,mBAAc,GAAd,cAAc,CAA2B;IACxD,CAAC;IAEJ;;;;OAIG;IACO,WAAW,CAAC,MAAe;QACpC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAEM,gBAAgB,KAAU,CAAC;IAC3B,eAAe,KAAU,CAAC;CACjC;AAjBD,kCAiBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ChangeFamily, ChangeFamilyEditor } from \"./changeFamily\";\n\nexport abstract class EditBuilder<TChange> implements ChangeFamilyEditor {\n\tpublic constructor(\n\t\tprotected readonly changeFamily: ChangeFamily<ChangeFamilyEditor, TChange>,\n\t\tprivate readonly changeReceiver: (change: TChange) => void,\n\t) {}\n\n\t/**\n\t * Subclasses add editing methods which call this with their generated edits.\n\t *\n\t * @sealed\n\t */\n\tprotected applyChange(change: TChange): void {\n\t\tthis.changeReceiver(change);\n\t}\n\n\tpublic enterTransaction(): void {}\n\tpublic exitTransaction(): void {}\n}\n"]}

package/dist/core/change-family/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { ChangeFamily, ChangeFamilyEditor } from "./changeFamily";
+export { EditBuilder } from "./editBuilder";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/change-family/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/change-family/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/core/change-family/index.js

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

package/dist/core/change-family/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/change-family/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,6CAA4C;AAAnC,0GAAA,WAAW,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ChangeFamily, ChangeFamilyEditor } from \"./changeFamily\";\nexport { EditBuilder } from \"./editBuilder\";\n"]}

package/dist/core/forest/editableForest.d.ts

@@ -0,0 +1,54 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FieldKey } from "../schema-stored";
+import { DetachedField, Anchor, ITreeCursorSynchronous, DeltaVisitor } from "../tree";
+import { IForestSubscription, ITreeSubscriptionCursor } from "./forest";
+/**
+ * Editing APIs.
+ * @internal
+ */
+export interface IEditableForest extends IForestSubscription {
+    /**
+     * Provides a visitor that can be used to mutate the forest.
+     *
+     * @returns a visitor that can be used to mutate the forest.
+     *
+     * @remarks
+     * Mutating the forest does NOT update anchors.
+     * The visitor must be released after use by calling {@link DeltaVisitor.free} on it.
+     * It is invalid to acquire a visitor without releasing the previous one.
+     */
+    acquireVisitor(): DeltaVisitor;
+}
+/**
+ * Sets the contents of the forest via delta.
+ * Requires the fores starts empty.
+ *
+ * @remarks
+ * This does not perform an edit: it updates the forest content as if there was an edit that did that.
+ */
+export declare function initializeForest(forest: IEditableForest, content: readonly ITreeCursorSynchronous[]): void;
+/**
+ * Ways to refer to a node in an IEditableForest.
+ * @internal
+ */
+export type ForestLocation = ITreeSubscriptionCursor | Anchor;
+/**
+ * @internal
+ */
+export interface TreeLocation {
+    readonly range: FieldLocation | DetachedField;
+    readonly index: number;
+}
+export declare function isFieldLocation(range: FieldLocation | DetachedField): range is FieldLocation;
+/**
+ * Location of a field within a tree that is not a detached/root field.
+ * @internal
+ */
+export interface FieldLocation {
+    readonly key: FieldKey;
+    readonly parent: ForestLocation;
+}
+//# sourceMappingURL=editableForest.d.ts.map

package/dist/core/forest/editableForest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editableForest.d.ts","sourceRoot":"","sources":["../../../src/core/forest/editableForest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EACN,aAAa,EACb,MAAM,EACN,sBAAsB,EACtB,YAAY,EAKZ,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAExE;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC3D;;;;;;;;;OASG;IACH,cAAc,IAAI,YAAY,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,SAAS,sBAAsB,EAAE,GACxC,IAAI,CAIN;AAID;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,uBAAuB,GAAG,MAAM,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,CAAC;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,GAAG,KAAK,IAAI,aAAa,CAE5F;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CAChC"}

package/dist/core/forest/editableForest.js

@@ -0,0 +1,27 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFieldLocation = exports.initializeForest = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const tree_1 = require("../tree");
+/**
+ * Sets the contents of the forest via delta.
+ * Requires the fores starts empty.
+ *
+ * @remarks
+ * This does not perform an edit: it updates the forest content as if there was an edit that did that.
+ */
+function initializeForest(forest, content) {
+    (0, core_utils_1.assert)(forest.isEmpty, 0x747 /* forest must be empty */);
+    const delta = (0, tree_1.deltaForRootInitialization)(content);
+    (0, tree_1.applyDelta)(delta, forest, (0, tree_1.makeDetachedFieldIndex)("init"));
+}
+exports.initializeForest = initializeForest;
+function isFieldLocation(range) {
+    return typeof range === "object";
+}
+exports.isFieldLocation = isFieldLocation;
+//# sourceMappingURL=editableForest.js.map

package/dist/core/forest/editableForest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editableForest.js","sourceRoot":"","sources":["../../../src/core/forest/editableForest.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAEpD,kCASiB;AAqBjB;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC/B,MAAuB,EACvB,OAA0C;IAE1C,IAAA,mBAAM,EAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IACzD,MAAM,KAAK,GAAc,IAAA,iCAA0B,EAAC,OAAO,CAAC,CAAC;IAC7D,IAAA,iBAAU,EAAC,KAAK,EAAE,MAAM,EAAE,IAAA,6BAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;AAC3D,CAAC;AAPD,4CAOC;AAkBD,SAAgB,eAAe,CAAC,KAAoC;IACnE,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AAClC,CAAC;AAFD,0CAEC","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 { FieldKey } from \"../schema-stored\";\nimport {\n\tDetachedField,\n\tAnchor,\n\tITreeCursorSynchronous,\n\tDeltaVisitor,\n\tapplyDelta,\n\tmakeDetachedFieldIndex,\n\tdeltaForRootInitialization,\n\tDeltaRoot,\n} from \"../tree\";\nimport { IForestSubscription, ITreeSubscriptionCursor } from \"./forest\";\n\n/**\n * Editing APIs.\n * @internal\n */\nexport interface IEditableForest extends IForestSubscription {\n\t/**\n\t * Provides a visitor that can be used to mutate the forest.\n\t *\n\t * @returns a visitor that can be used to mutate the forest.\n\t *\n\t * @remarks\n\t * Mutating the forest does NOT update anchors.\n\t * The visitor must be released after use by calling {@link DeltaVisitor.free} on it.\n\t * It is invalid to acquire a visitor without releasing the previous one.\n\t */\n\tacquireVisitor(): DeltaVisitor;\n}\n\n/**\n * Sets the contents of the forest via delta.\n * Requires the fores starts empty.\n *\n * @remarks\n * This does not perform an edit: it updates the forest content as if there was an edit that did that.\n */\nexport function initializeForest(\n\tforest: IEditableForest,\n\tcontent: readonly ITreeCursorSynchronous[],\n): void {\n\tassert(forest.isEmpty, 0x747 /* forest must be empty */);\n\tconst delta: DeltaRoot = deltaForRootInitialization(content);\n\tapplyDelta(delta, forest, makeDetachedFieldIndex(\"init\"));\n}\n\n// TODO: Types below here may be useful for input into edit building APIs, but are no longer used here directly.\n\n/**\n * Ways to refer to a node in an IEditableForest.\n * @internal\n */\nexport type ForestLocation = ITreeSubscriptionCursor | Anchor;\n\n/**\n * @internal\n */\nexport interface TreeLocation {\n\treadonly range: FieldLocation | DetachedField;\n\treadonly index: number;\n}\n\nexport function isFieldLocation(range: FieldLocation | DetachedField): range is FieldLocation {\n\treturn typeof range === \"object\";\n}\n\n/**\n * Location of a field within a tree that is not a detached/root field.\n * @internal\n */\nexport interface FieldLocation {\n\treadonly key: FieldKey;\n\treadonly parent: ForestLocation;\n}\n"]}

package/dist/core/forest/forest.d.ts

@@ -0,0 +1,200 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISubscribable } from "../../events";
+import { TreeStoredSchemaSubscription, FieldKey } from "../schema-stored";
+import { Anchor, AnchorSet, DetachedField, ITreeCursor, ITreeCursorSynchronous, UpPath } from "../tree";
+import type { IEditableForest } from "./editableForest";
+/**
+ * APIs for forest designed so the implementation can be copy on write,
+ * or mutate in place, and we can ensure no references are dangling into the forest to allow this.
+ *
+ * This results in rather manual memory management,
+ * but makes it practical to provide highly optimized implementations,
+ * for example WASM powered binary formats that can track reference counts and only copy when needed.
+ */
+/**
+ * Events for {@link IForestSubscription}.
+ *
+ * TODO: consider having before and after events per subtree instead while applying anchor (and this just shows what happens at the root).
+ * @internal
+ */
+export interface ForestEvents {
+    /**
+     * The forest is about to be changed.
+     * Emitted before the first change in a batch of changes.
+     */
+    beforeChange(): void;
+    /**
+     * The forest was just changed.
+     * Emitted after the last change in a batch of changes.
+     */
+    afterChange(): void;
+}
+/**
+ * Invalidates whenever the tree content changes.
+ * For now (might change later) downloading new parts of the forest counts as a change.
+ * Not invalidated when schema changes.
+ *
+ * When invalidating, all outstanding cursors must be freed or cleared.
+ * @internal
+ */
+export interface IForestSubscription extends ISubscribable<ForestEvents> {
+    /**
+     * Set of anchors this forest is tracking.
+     *
+     * To keep these anchors usable, this AnchorSet must be updated / rebased for any changes made to the forest.
+     * It is the responsibility of the caller of the forest-editing methods to do this, not the forest itself.
+     * The caller performs these updates because it has more semantic knowledge about the edits, which can be needed to
+     * update the anchors in a semantically optimal way.
+     */
+    readonly anchors: AnchorSet;
+    /**
+     * Create an independent copy of this forest, that uses the provided schema and anchors.
+     *
+     * The new copy will not invalidate observers (dependents) of the old one.
+     */
+    clone(schema: TreeStoredSchemaSubscription, anchors: AnchorSet): IEditableForest;
+    /**
+     * Allocates a cursor in the "cleared" state.
+     */
+    allocateCursor(): ITreeSubscriptionCursor;
+    /**
+     * Frees an Anchor, stopping tracking its position across edits.
+     */
+    forgetAnchor(anchor: Anchor): void;
+    /**
+     * It is an error not to free `cursorToMove` before the next edit.
+     * Must provide a `cursorToMove` from this subscription (acquired via `allocateCursor`).
+     */
+    tryMoveCursorToNode(destination: Anchor, cursorToMove: ITreeSubscriptionCursor): TreeNavigationResult;
+    /**
+     * It is an error not to free `cursorToMove` before the next edit.
+     * Must provide a `cursorToMove` from this subscription (acquired via `allocateCursor`).
+     */
+    tryMoveCursorToField(destination: FieldAnchor, cursorToMove: ITreeSubscriptionCursor): TreeNavigationResult;
+    /**
+     * Set `cursorToMove` to location described by path.
+     * This is NOT a relative move: current position is discarded.
+     * Path must point to existing node.
+     */
+    moveCursorToPath(destination: UpPath, cursorToMove: ITreeSubscriptionCursor): void;
+    /**
+     * The cursor is moved to a special dummy node above the detached fields.
+     * This dummy node can be used to read the detached fields,
+     * but other operations (such as inspecting the dummy node's type or path) should not be relied upon.
+     * While this method does not return an {@link ITreeSubscriptionCursor}, similar restrictions apply to its use:
+     * the returned cursor must not used after any edits are made to the forest.
+     */
+    getCursorAboveDetachedFields(): ITreeCursorSynchronous;
+    /**
+     * True if there are no nodes in the forest at all.
+     *
+     * @remarks
+     * This means no nodes under any detached field, not just the special document root one.
+     */
+    readonly isEmpty: boolean;
+}
+/**
+ * @param field - defaults to {@link rootField}.
+ * @returns anchor to `field`.
+ */
+export declare function rootAnchor(field?: DetachedField): FieldAnchor;
+/**
+ * @param field - defaults to {@link rootField}.
+ * @returns anchor to `field`.
+ */
+export declare function moveToDetachedField(forest: IForestSubscription, cursorToMove: ITreeSubscriptionCursor, field?: DetachedField): void;
+/**
+ * Anchor to a field.
+ * This is structurally based on the parent, so it will move only as the parent moves.
+ * @internal
+ */
+export interface FieldAnchor {
+    /**
+     * Node above this field.
+     * If `undefined`, field is a detached field.
+     */
+    parent: Anchor | undefined;
+    fieldKey: FieldKey;
+}
+/**
+ * ITreeCursor supporting IForestSubscription and its changes over time.
+ * @internal
+ */
+export interface ITreeSubscriptionCursor extends ITreeCursor {
+    /**
+     * @returns an independent copy of this cursor at the same location in the tree.
+     */
+    fork(): ITreeSubscriptionCursor;
+    /**
+     * Release any resources this cursor is holding onto.
+     * After doing this, further use of this object other than reading `state` is forbidden (undefined behavior).
+     */
+    free(): void;
+    /**
+     * Release any resources this cursor is holding onto.
+     * After doing this, further use of this object other than reading `state` or passing to `tryGet`
+     * or calling `free` is forbidden (undefined behavior).
+     */
+    clear(): void;
+    /**
+     * Construct an `Anchor` which the IForestSubscription will keep rebased to `current`.
+     * Note that maintaining an Anchor has cost: free them to stop incurring that cost.
+     *
+     * Only valid when `mode` is `Nodes`.
+     */
+    buildAnchor(): Anchor;
+    /**
+     * Construct a `FieldAnchor` which the IForestSubscription will keep rebased to `current`.
+     * Note that maintaining an Anchor has cost: free them to stop incurring that cost.
+     *
+     * Only valid when `mode` is `Fields`.
+     */
+    buildFieldAnchor(): FieldAnchor;
+    /**
+     * Current state.
+     */
+    readonly state: ITreeSubscriptionCursorState;
+}
+/**
+ * @internal
+ */
+export declare enum ITreeSubscriptionCursorState {
+    /**
+     * On the current revision of the forest.
+     */
+    Current = 0,
+    /**
+     * Empty, but can be reused.
+     */
+    Cleared = 1,
+    /**
+     * Freed and must not be used.
+     */
+    Freed = 2
+}
+/**
+ * @internal
+ */
+export declare const enum TreeNavigationResult {
+    /**
+     * Attempt to navigate cursor to a key or index that is outside the client's view.
+     */
+    NotFound = -1,
+    /**
+     * Attempt to navigate cursor to a portion of the tree that has not yet been loaded.
+     */
+    Pending = 0,
+    /**
+     * ITreeReader successfully navigated to the desired node.
+     */
+    Ok = 1
+}
+/**
+ * TreeNavigationResult, but never "Pending".
+ * Can be used when data is never pending.
+ */
+export type SynchronousNavigationResult = TreeNavigationResult.Ok | TreeNavigationResult.NotFound;
+//# sourceMappingURL=forest.d.ts.map

package/dist/core/forest/forest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forest.d.ts","sourceRoot":"","sources":["../../../src/core/forest/forest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,4BAA4B,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EACN,MAAM,EACN,SAAS,EACT,aAAa,EAEb,WAAW,EACX,sBAAsB,EAEtB,MAAM,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,YAAY,IAAI,IAAI,CAAC;IAErB;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa,CAAC,YAAY,CAAC;IACvE;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC;IAE5B;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,EAAE,SAAS,GAAG,eAAe,CAAC;IAEjF;;OAEG;IACH,cAAc,IAAI,uBAAuB,CAAC;IAE1C;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAClB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,uBAAuB,GACnC,oBAAoB,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CACnB,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,uBAAuB,GACnC,oBAAoB,CAAC;IAExB;;;;OAIG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAEnF;;;;;;OAMG;IACH,4BAA4B,IAAI,sBAAsB,CAAC;IAEvD;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,KAAK,GAAE,aAAyB,GAAG,WAAW,CAKxE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAClC,MAAM,EAAE,mBAAmB,EAC3B,YAAY,EAAE,uBAAuB,EACrC,KAAK,GAAE,aAAyB,GAC9B,IAAI,CAMN;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B;;;OAGG;IACH,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC3D;;OAEG;IACH,IAAI,IAAI,uBAAuB,CAAC;IAEhC;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;;OAIG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;OAKG;IACH,WAAW,IAAI,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,gBAAgB,IAAI,WAAW,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,4BAA4B,CAAC;CAO7C;AAED;;GAEG;AACH,oBAAY,4BAA4B;IACvC;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,KAAK,IAAA;CACL;AAED;;GAEG;AACH,0BAAkB,oBAAoB;IACrC;;OAEG;IACH,QAAQ,KAAK;IAEb;;OAEG;IACH,OAAO,IAAI;IAEX;;OAEG;IACH,EAAE,IAAI;CACN;AAED;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC,EAAE,GAAG,oBAAoB,CAAC,QAAQ,CAAC"}

package/dist/core/forest/forest.js

@@ -0,0 +1,66 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeNavigationResult = exports.ITreeSubscriptionCursorState = exports.moveToDetachedField = exports.rootAnchor = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const tree_1 = require("../tree");
+/**
+ * @param field - defaults to {@link rootField}.
+ * @returns anchor to `field`.
+ */
+function rootAnchor(field = tree_1.rootField) {
+    return {
+        parent: undefined,
+        fieldKey: (0, tree_1.detachedFieldAsKey)(field),
+    };
+}
+exports.rootAnchor = rootAnchor;
+/**
+ * @param field - defaults to {@link rootField}.
+ * @returns anchor to `field`.
+ */
+function moveToDetachedField(forest, cursorToMove, field = tree_1.rootField) {
+    const result = forest.tryMoveCursorToField(rootAnchor(field), cursorToMove);
+    (0, core_utils_1.assert)(result === 1 /* TreeNavigationResult.Ok */, 0x42d /* Navigation to detached fields should never fail */);
+}
+exports.moveToDetachedField = moveToDetachedField;
+/**
+ * @internal
+ */
+var ITreeSubscriptionCursorState;
+(function (ITreeSubscriptionCursorState) {
+    /**
+     * On the current revision of the forest.
+     */
+    ITreeSubscriptionCursorState[ITreeSubscriptionCursorState["Current"] = 0] = "Current";
+    /**
+     * Empty, but can be reused.
+     */
+    ITreeSubscriptionCursorState[ITreeSubscriptionCursorState["Cleared"] = 1] = "Cleared";
+    /**
+     * Freed and must not be used.
+     */
+    ITreeSubscriptionCursorState[ITreeSubscriptionCursorState["Freed"] = 2] = "Freed";
+})(ITreeSubscriptionCursorState || (exports.ITreeSubscriptionCursorState = ITreeSubscriptionCursorState = {}));
+/**
+ * @internal
+ */
+var TreeNavigationResult;
+(function (TreeNavigationResult) {
+    /**
+     * Attempt to navigate cursor to a key or index that is outside the client's view.
+     */
+    TreeNavigationResult[TreeNavigationResult["NotFound"] = -1] = "NotFound";
+    /**
+     * Attempt to navigate cursor to a portion of the tree that has not yet been loaded.
+     */
+    TreeNavigationResult[TreeNavigationResult["Pending"] = 0] = "Pending";
+    /**
+     * ITreeReader successfully navigated to the desired node.
+     */
+    TreeNavigationResult[TreeNavigationResult["Ok"] = 1] = "Ok";
+})(TreeNavigationResult || (exports.TreeNavigationResult = TreeNavigationResult = {}));
+//# sourceMappingURL=forest.js.map

package/dist/core/forest/forest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forest.js","sourceRoot":"","sources":["../../../src/core/forest/forest.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAGpD,kCASiB;AA+GjB;;;GAGG;AACH,SAAgB,UAAU,CAAC,QAAuB,gBAAS;IAC1D,OAAO;QACN,MAAM,EAAE,SAAS;QACjB,QAAQ,EAAE,IAAA,yBAAkB,EAAC,KAAK,CAAC;KACnC,CAAC;AACH,CAAC;AALD,gCAKC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAClC,MAA2B,EAC3B,YAAqC,EACrC,QAAuB,gBAAS;IAEhC,MAAM,MAAM,GAAG,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC;IAC5E,IAAA,mBAAM,EACL,MAAM,oCAA4B,EAClC,KAAK,CAAC,qDAAqD,CAC3D,CAAC;AACH,CAAC;AAVD,kDAUC;AAmED;;GAEG;AACH,IAAY,4BAaX;AAbD,WAAY,4BAA4B;IACvC;;OAEG;IACH,qFAAO,CAAA;IACP;;OAEG;IACH,qFAAO,CAAA;IACP;;OAEG;IACH,iFAAK,CAAA;AACN,CAAC,EAbW,4BAA4B,4CAA5B,4BAA4B,QAavC;AAED;;GAEG;AACH,IAAkB,oBAejB;AAfD,WAAkB,oBAAoB;IACrC;;OAEG;IACH,wEAAa,CAAA;IAEb;;OAEG;IACH,qEAAW,CAAA;IAEX;;OAEG;IACH,2DAAM,CAAA;AACP,CAAC,EAfiB,oBAAoB,oCAApB,oBAAoB,QAerC","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 { ISubscribable } from \"../../events\";\nimport { TreeStoredSchemaSubscription, FieldKey } from \"../schema-stored\";\nimport {\n\tAnchor,\n\tAnchorSet,\n\tDetachedField,\n\tdetachedFieldAsKey,\n\tITreeCursor,\n\tITreeCursorSynchronous,\n\trootField,\n\tUpPath,\n} from \"../tree\";\nimport type { IEditableForest } from \"./editableForest\";\n\n/**\n * APIs for forest designed so the implementation can be copy on write,\n * or mutate in place, and we can ensure no references are dangling into the forest to allow this.\n *\n * This results in rather manual memory management,\n * but makes it practical to provide highly optimized implementations,\n * for example WASM powered binary formats that can track reference counts and only copy when needed.\n */\n\n/**\n * Events for {@link IForestSubscription}.\n *\n * TODO: consider having before and after events per subtree instead while applying anchor (and this just shows what happens at the root).\n * @internal\n */\nexport interface ForestEvents {\n\t/**\n\t * The forest is about to be changed.\n\t * Emitted before the first change in a batch of changes.\n\t */\n\tbeforeChange(): void;\n\n\t/**\n\t * The forest was just changed.\n\t * Emitted after the last change in a batch of changes.\n\t */\n\tafterChange(): void;\n}\n\n/**\n * Invalidates whenever the tree content changes.\n * For now (might change later) downloading new parts of the forest counts as a change.\n * Not invalidated when schema changes.\n *\n * When invalidating, all outstanding cursors must be freed or cleared.\n * @internal\n */\nexport interface IForestSubscription extends ISubscribable<ForestEvents> {\n\t/**\n\t * Set of anchors this forest is tracking.\n\t *\n\t * To keep these anchors usable, this AnchorSet must be updated / rebased for any changes made to the forest.\n\t * It is the responsibility of the caller of the forest-editing methods to do this, not the forest itself.\n\t * The caller performs these updates because it has more semantic knowledge about the edits, which can be needed to\n\t * update the anchors in a semantically optimal way.\n\t */\n\treadonly anchors: AnchorSet;\n\n\t/**\n\t * Create an independent copy of this forest, that uses the provided schema and anchors.\n\t *\n\t * The new copy will not invalidate observers (dependents) of the old one.\n\t */\n\tclone(schema: TreeStoredSchemaSubscription, anchors: AnchorSet): IEditableForest;\n\n\t/**\n\t * Allocates a cursor in the \"cleared\" state.\n\t */\n\tallocateCursor(): ITreeSubscriptionCursor;\n\n\t/**\n\t * Frees an Anchor, stopping tracking its position across edits.\n\t */\n\tforgetAnchor(anchor: Anchor): void;\n\n\t/**\n\t * It is an error not to free `cursorToMove` before the next edit.\n\t * Must provide a `cursorToMove` from this subscription (acquired via `allocateCursor`).\n\t */\n\ttryMoveCursorToNode(\n\t\tdestination: Anchor,\n\t\tcursorToMove: ITreeSubscriptionCursor,\n\t): TreeNavigationResult;\n\n\t/**\n\t * It is an error not to free `cursorToMove` before the next edit.\n\t * Must provide a `cursorToMove` from this subscription (acquired via `allocateCursor`).\n\t */\n\ttryMoveCursorToField(\n\t\tdestination: FieldAnchor,\n\t\tcursorToMove: ITreeSubscriptionCursor,\n\t): TreeNavigationResult;\n\n\t/**\n\t * Set `cursorToMove` to location described by path.\n\t * This is NOT a relative move: current position is discarded.\n\t * Path must point to existing node.\n\t */\n\tmoveCursorToPath(destination: UpPath, cursorToMove: ITreeSubscriptionCursor): void;\n\n\t/**\n\t * The cursor is moved to a special dummy node above the detached fields.\n\t * This dummy node can be used to read the detached fields,\n\t * but other operations (such as inspecting the dummy node's type or path) should not be relied upon.\n\t * While this method does not return an {@link ITreeSubscriptionCursor}, similar restrictions apply to its use:\n\t * the returned cursor must not used after any edits are made to the forest.\n\t */\n\tgetCursorAboveDetachedFields(): ITreeCursorSynchronous;\n\n\t/**\n\t * True if there are no nodes in the forest at all.\n\t *\n\t * @remarks\n\t * This means no nodes under any detached field, not just the special document root one.\n\t */\n\treadonly isEmpty: boolean;\n}\n\n/**\n * @param field - defaults to {@link rootField}.\n * @returns anchor to `field`.\n */\nexport function rootAnchor(field: DetachedField = rootField): FieldAnchor {\n\treturn {\n\t\tparent: undefined,\n\t\tfieldKey: detachedFieldAsKey(field),\n\t};\n}\n\n/**\n * @param field - defaults to {@link rootField}.\n * @returns anchor to `field`.\n */\nexport function moveToDetachedField(\n\tforest: IForestSubscription,\n\tcursorToMove: ITreeSubscriptionCursor,\n\tfield: DetachedField = rootField,\n): void {\n\tconst result = forest.tryMoveCursorToField(rootAnchor(field), cursorToMove);\n\tassert(\n\t\tresult === TreeNavigationResult.Ok,\n\t\t0x42d /* Navigation to detached fields should never fail */,\n\t);\n}\n\n/**\n * Anchor to a field.\n * This is structurally based on the parent, so it will move only as the parent moves.\n * @internal\n */\nexport interface FieldAnchor {\n\t/**\n\t * Node above this field.\n\t * If `undefined`, field is a detached field.\n\t */\n\tparent: Anchor | undefined;\n\tfieldKey: FieldKey;\n}\n\n/**\n * ITreeCursor supporting IForestSubscription and its changes over time.\n * @internal\n */\nexport interface ITreeSubscriptionCursor extends ITreeCursor {\n\t/**\n\t * @returns an independent copy of this cursor at the same location in the tree.\n\t */\n\tfork(): ITreeSubscriptionCursor;\n\n\t/**\n\t * Release any resources this cursor is holding onto.\n\t * After doing this, further use of this object other than reading `state` is forbidden (undefined behavior).\n\t */\n\tfree(): void;\n\n\t/**\n\t * Release any resources this cursor is holding onto.\n\t * After doing this, further use of this object other than reading `state` or passing to `tryGet`\n\t * or calling `free` is forbidden (undefined behavior).\n\t */\n\tclear(): void;\n\n\t/**\n\t * Construct an `Anchor` which the IForestSubscription will keep rebased to `current`.\n\t * Note that maintaining an Anchor has cost: free them to stop incurring that cost.\n\t *\n\t * Only valid when `mode` is `Nodes`.\n\t */\n\tbuildAnchor(): Anchor;\n\n\t/**\n\t * Construct a `FieldAnchor` which the IForestSubscription will keep rebased to `current`.\n\t * Note that maintaining an Anchor has cost: free them to stop incurring that cost.\n\t *\n\t * Only valid when `mode` is `Fields`.\n\t */\n\tbuildFieldAnchor(): FieldAnchor;\n\n\t/**\n\t * Current state.\n\t */\n\treadonly state: ITreeSubscriptionCursorState;\n\n\t/**\n\t * @returns location within parent field or range.\n\t */\n\t// TODO: maybe support this.\n\t// getParentInfo(id: NodeId): TreeLocation;\n}\n\n/**\n * @internal\n */\nexport enum ITreeSubscriptionCursorState {\n\t/**\n\t * On the current revision of the forest.\n\t */\n\tCurrent,\n\t/**\n\t * Empty, but can be reused.\n\t */\n\tCleared,\n\t/**\n\t * Freed and must not be used.\n\t */\n\tFreed,\n}\n\n/**\n * @internal\n */\nexport const enum TreeNavigationResult {\n\t/**\n\t * Attempt to navigate cursor to a key or index that is outside the client's view.\n\t */\n\tNotFound = -1,\n\n\t/**\n\t * Attempt to navigate cursor to a portion of the tree that has not yet been loaded.\n\t */\n\tPending = 0,\n\n\t/**\n\t * ITreeReader successfully navigated to the desired node.\n\t */\n\tOk = 1,\n}\n\n/**\n * TreeNavigationResult, but never \"Pending\".\n * Can be used when data is never pending.\n */\nexport type SynchronousNavigationResult = TreeNavigationResult.Ok | TreeNavigationResult.NotFound;\n"]}

package/dist/core/forest/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { IEditableForest, FieldLocation, TreeLocation, isFieldLocation, ForestLocation, initializeForest, } from "./editableForest";
+export { IForestSubscription, ITreeSubscriptionCursor, ITreeSubscriptionCursorState, TreeNavigationResult, FieldAnchor, moveToDetachedField, ForestEvents, } from "./forest";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/forest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/forest/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,aAAa,EACb,YAAY,EACZ,eAAe,EACf,cAAc,EACd,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,mBAAmB,EACnB,uBAAuB,EACvB,4BAA4B,EAC5B,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,YAAY,GACZ,MAAM,UAAU,CAAC"}

package/dist/core/forest/index.js

@@ -0,0 +1,15 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moveToDetachedField = exports.TreeNavigationResult = exports.ITreeSubscriptionCursorState = exports.initializeForest = exports.isFieldLocation = void 0;
+var editableForest_1 = require("./editableForest");
+Object.defineProperty(exports, "isFieldLocation", { enumerable: true, get: function () { return editableForest_1.isFieldLocation; } });
+Object.defineProperty(exports, "initializeForest", { enumerable: true, get: function () { return editableForest_1.initializeForest; } });
+var forest_1 = require("./forest");
+Object.defineProperty(exports, "ITreeSubscriptionCursorState", { enumerable: true, get: function () { return forest_1.ITreeSubscriptionCursorState; } });
+Object.defineProperty(exports, "TreeNavigationResult", { enumerable: true, get: function () { return forest_1.TreeNavigationResult; } });
+Object.defineProperty(exports, "moveToDetachedField", { enumerable: true, get: function () { return forest_1.moveToDetachedField; } });
+//# sourceMappingURL=index.js.map

package/dist/core/forest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/forest/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mDAO0B;AAHzB,iHAAA,eAAe,OAAA;AAEf,kHAAA,gBAAgB,OAAA;AAEjB,mCAQkB;AALjB,sHAAA,4BAA4B,OAAA;AAC5B,8GAAA,oBAAoB,OAAA;AAEpB,6GAAA,mBAAmB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIEditableForest,\n\tFieldLocation,\n\tTreeLocation,\n\tisFieldLocation,\n\tForestLocation,\n\tinitializeForest,\n} from \"./editableForest\";\nexport {\n\tIForestSubscription,\n\tITreeSubscriptionCursor,\n\tITreeSubscriptionCursorState,\n\tTreeNavigationResult,\n\tFieldAnchor,\n\tmoveToDetachedField,\n\tForestEvents,\n} from \"./forest\";\n"]}

package/dist/core/index.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { EmptyKey, TreeType, Value, TreeValue, AnchorSet, DetachedField, UpPath, Range, RangeUpPath, PlaceUpPath, PlaceIndex, NodeIndex, DetachedPlaceUpPath, DetachedRangeUpPath, FieldUpPath, Anchor, RootField, ChildCollection, ChildLocation, FieldMapObject, NodeData, GenericTreeNode, JsonableTree, EncodedJsonableTree, rootFieldKey, rootField, ITreeCursor, CursorLocationType, ITreeCursorSynchronous, castCursorToSynchronous, GenericFieldsNode, AnchorLocator, genericTreeKeys, getGenericTreeField, genericTreeDeleteIfEmpty, getDepth, mapCursorField, mapCursorFields, iterateCursorField, getMapTreeField, MapTree, detachedFieldAsKey, keyAsDetachedField, visitDelta, combineVisitors, announceDelta, applyDelta, makeDetachedFieldIndex, setGenericTreeField, DeltaVisitor, AnnouncedVisitor, PathVisitor, SparseNode, getDescendant, compareUpPaths, clonePath, topDownPath, compareFieldUpPaths, forEachNode, forEachNodeInSubtree, forEachField, PathRootPrefix, deltaForRootInitialization, deltaForSet, emptyFieldChanges, isEmptyFieldChanges, makeDetachedNodeId, offsetDetachId, emptyDelta, AnchorSlot, AnchorNode, anchorSlot, UpPathDefault, inCursorField, inCursorNode, AnchorEvents, AnchorSetRootEvents, ProtoNodes, CursorMarker, isCursor, DetachedFieldIndex, ForestRootId, getDetachedFieldContainingPath, aboveRootPlaceholder, DeltaRoot, DeltaProtoNode, DeltaMark, DeltaDetachedNodeId, DeltaFieldMap, DeltaDetachedNodeChanges, DeltaDetachedNodeBuild, DeltaDetachedNodeDestruction, DeltaDetachedNodeRename, DeltaFieldChanges, } from "./tree";
+export { TreeNavigationResult, IEditableForest, IForestSubscription, TreeLocation, FieldLocation, ForestLocation, ITreeSubscriptionCursor, ITreeSubscriptionCursorState, initializeForest, FieldAnchor, moveToDetachedField, ForestEvents, } from "./forest";
+export { FieldKey, TreeNodeSchemaIdentifier, TreeFieldStoredSchema, ValueSchema, TreeNodeStoredSchema, TreeStoredSchemaSubscription as TreeStoredSchemaSubscription, MutableTreeStoredSchema, FieldKindIdentifier, FieldKindSpecifier, TreeTypeSet, TreeStoredSchema, TreeStoredSchemaRepository, schemaDataIsEmpty, SchemaEvents, forbiddenFieldKindIdentifier, storedEmptyFieldSchema, StoredSchemaCollection, schemaFormat, LeafNodeStoredSchema, ObjectNodeStoredSchema, MapNodeStoredSchema, BrandedTreeNodeSchemaDataFormat, decodeFieldSchema, encodeFieldSchema, storedSchemaDecodeDispatcher, ErasedTreeNodeSchemaDataFormat, } from "./schema-stored";
+export { ChangeFamily, ChangeFamilyEditor, EditBuilder } from "./change-family";
+export { areEqualChangeAtomIds, assertIsRevisionTag, ChangeRebaser, findAncestor, findCommonAncestor, GraphCommit, isRevisionTag, RevisionTag, RevisionTagSchema, ChangesetLocalId, ChangeAtomId, ChangeAtomIdMap, TaggedChange, makeAnonChange, tagChange, mapTaggedChange, noFailure, OutputType, verifyChangeRebaser, tagRollbackInverse, SessionId, SessionIdSchema, mintCommit, mintRevisionTag, rebaseBranch, BranchRebaseResult, rebaseChange, rebaseChangeOverChanges, RevisionMetadataSource, revisionMetadataSourceFromInfo, RevisionInfo, EncodedRevisionTag, EncodedChangeAtomId, } from "./rebase";
+export { Adapters, AdaptedViewSchema, Compatibility, TreeAdapter, AllowedUpdateType, } from "./schema-view";
+export { Revertible, RevertibleKind, RevertResult, DiscardResult } from "./revertible";
+//# sourceMappingURL=index.d.ts.map

package/dist/core/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,SAAS,EACT,SAAS,EACT,aAAa,EACb,MAAM,EACN,KAAK,EACL,WAAW,EACX,WAAW,EACX,UAAU,EACV,SAAS,EACT,mBAAmB,EACnB,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,SAAS,EACT,eAAe,EACf,aAAa,EACb,cAAc,EACd,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,YAAY,EACZ,SAAS,EACT,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,wBAAwB,EACxB,QAAQ,EACR,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,OAAO,EACP,kBAAkB,EAClB,kBAAkB,EAClB,UAAU,EACV,eAAe,EACf,aAAa,EACb,UAAU,EACV,sBAAsB,EACtB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,aAAa,EACb,cAAc,EACd,SAAS,EACT,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,oBAAoB,EACpB,YAAY,EACZ,cAAc,EACd,0BAA0B,EAC1B,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,UAAU,EACV,UAAU,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,kBAAkB,EAClB,YAAY,EACZ,8BAA8B,EAC9B,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,aAAa,EACb,wBAAwB,EACxB,sBAAsB,EACtB,4BAA4B,EAC5B,uBAAuB,EACvB,iBAAiB,GACjB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACN,oBAAoB,EACpB,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,4BAA4B,EAC5B,gBAAgB,EAChB,WAAW,EACX,mBAAmB,EACnB,YAAY,GACZ,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,QAAQ,EACR,wBAAwB,EACxB,qBAAqB,EACrB,WAAW,EACX,oBAAoB,EACpB,4BAA4B,IAAI,4BAA4B,EAC5D,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,0BAA0B,EAC1B,iBAAiB,EACjB,YAAY,EACZ,4BAA4B,EAC5B,sBAAsB,EACtB,sBAAsB,EACtB,YAAY,EACZ,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,+BAA+B,EAC/B,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,8BAA8B,GAC9B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEhF,OAAO,EACN,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,cAAc,EACd,SAAS,EACT,eAAe,EACf,SAAS,EACT,UAAU,EACV,mBAAmB,EACnB,kBAAkB,EAClB,SAAS,EACT,eAAe,EACf,UAAU,EACV,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,uBAAuB,EACvB,sBAAsB,EACtB,8BAA8B,EAC9B,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,iBAAiB,GACjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}