@fluid-experimental/tree 0.58.2002 → 0.59.1000

package/dist/TreeView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeView.d.ts","sourceRoot":"","sources":["../src/TreeView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAwB,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,CAAC,MAAM,CAAC;IACrD,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;IAC5D,sIAAsI;IACtI,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;CACnC;AAED;;;;;;GAMG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEzE;;;;;;GAMG;AACH,oBAAY,cAAc,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,cAAc,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAC/B;AAED;;;GAGG;AACH,8BAAsB,QAAQ;IAC7B,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IAExC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD,SAAS,aAAa,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAMlD,gDAAgD;IAChD,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,qEAAqE;IAC9D,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAInC;;;OAGG;IACI,oBAAoB,CAAC,KAAK,EAAE,aAAa,GAAG,UAAU;IAO7D,kHAAkH;IAC3G,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAI5C,wHAAwH;IACjH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAmB3D;;;OAGG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU;IAI5C;;;OAGG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAI3D;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAKlD;;;OAGG;IACI,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAQjE;;;OAGG;IACI,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa;IAQlD;;;OAGG;IACI,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAWjE;;;;OAIG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc;IAKlD;;;;OAIG;IACI,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAmCjE;;OAEG;IACI,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,MAAM,EAAE;IAIhE,2FAA2F;IACpF,gBAAgB,IAAI,IAAI;IAIxB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAI1D,6DAA6D;aAC7C,MAAM,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAE/C;;;OAGG;IACI,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,UAAQ,GAAG,OAAO;IAS9D,OAAO,CAAE,sBAAsB;IAW/B,OAAO,CAAC,cAAc;IAItB;;;;;OAKG;IACI,KAAK,CAAC,IAAI,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;CAI3C"}

package/dist/TreeView.js

@@ -0,0 +1,218 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeView = void 0;
+const Common_1 = require("./Common");
+const Forest_1 = require("./Forest");
+const persisted_types_1 = require("./persisted-types");
+/**
+ * A view of a distributed tree.
+ * @public
+ */
+class TreeView {
+    constructor(root, forest) {
+        this.root = root;
+        this.forest = forest;
+        this.rootNode = this.getViewNode(root);
+    }
+    /** @returns the number of nodes in this view */
+    get size() {
+        return this.forest.size;
+    }
+    /** @returns true iff a node with the given id exists in this view */
+    hasNode(id) {
+        return this.forest.has(id);
+    }
+    /**
+     * @returns the index just after place (which specifies a location between items).
+     * Performance note: this is O(siblings in trait).
+     */
+    findIndexWithinTrait(place) {
+        if (place.sibling === undefined) {
+            return this.getIndexOfSide(place.side, place.trait);
+        }
+        return getIndex(place.side, this.getIndexInTrait(place.sibling));
+    }
+    /** @returns the node associated with the given id in this view. Fails if the node does not exist in this view. */
+    getViewNode(id) {
+        var _a;
+        return (_a = this.tryGetViewNode(id)) !== null && _a !== void 0 ? _a : Common_1.fail('NodeId not found');
+    }
+    /** @returns the node associated with the given id in this view, or undefined if the node does not exist in this view */
+    tryGetViewNode(id) {
+        const forestNode = this.forest.tryGet(id);
+        if (forestNode !== undefined && Forest_1.isParentedForestNode(forestNode)) {
+            const viewNode = {
+                definition: forestNode.definition,
+                identifier: forestNode.identifier,
+                traits: forestNode.traits,
+                parentage: {
+                    label: forestNode.traitParent,
+                    parent: forestNode.parentId,
+                },
+            };
+            Common_1.copyPropertyIfDefined(forestNode, viewNode, 'payload');
+            return viewNode;
+        }
+        return forestNode;
+    }
+    /**
+     * @returns the label of the trait under which a node with the given id resides. Fails if the node does not exist in this view or if
+     * it is the root node.
+     */
+    getTraitLabel(id) {
+        return this.forest.getParent(id).traitParent;
+    }
+    /**
+     * @returns the label of the trait under which a node with the given id resides, or undefined if the node is not present in this
+     * view or if it is the root node
+     */
+    tryGetTraitLabel(id) {
+        var _a;
+        return (_a = this.forest.tryGetParent(id)) === null || _a === void 0 ? void 0 : _a.traitParent;
+    }
+    /**
+     * @returns the parent of the node with the given id. Fails if the node does not exist in this view or if it is the root node.
+     */
+    getParentViewNode(id) {
+        const parentInfo = this.forest.getParent(id);
+        return this.getViewNode(parentInfo.parentId);
+    }
+    /**
+     * @returns the parent of the node with the given id. Returns undefined if the node does not exist in this view or if it is the root
+     * node.
+     */
+    tryGetParentViewNode(id) {
+        const parentInfo = this.forest.tryGetParent(id);
+        if (parentInfo === undefined) {
+            return undefined;
+        }
+        return this.getViewNode(parentInfo.parentId);
+    }
+    /**
+     * @returns the trait location of the node with the given id. Fails if the node does not exist in this view or of it is the root
+     * node
+     */
+    getTraitLocation(id) {
+        const parentData = this.forest.getParent(id);
+        return {
+            parent: parentData.parentId,
+            label: parentData.traitParent,
+        };
+    }
+    /**
+     * @returns the trait location of the node with the given id, or undefined if the node does not exist in this view or if it is the root
+     * node
+     */
+    tryGetTraitLocation(id) {
+        const parentData = this.forest.tryGetParent(id);
+        if (parentData === undefined) {
+            return undefined;
+        }
+        return {
+            parent: parentData.parentId,
+            label: parentData.traitParent,
+        };
+    }
+    /**
+     * @returns the index within the trait under which the node with the given id resides. The node must exist in this view and must have a
+     * parent.
+     * Performance note: this is O(siblings in trait).
+     */
+    getIndexInTrait(id) {
+        const index = this.tryGetIndexInTrait(id);
+        return index !== null && index !== void 0 ? index : Common_1.fail('ID does not exist in the forest.');
+    }
+    /**
+     * @returns the index within the trait under which the node with the given id resides, or undefined if the node does not exist in this
+     * view or does not have a parent.
+     * Performance note: this is O(siblings in trait).
+     */
+    tryGetIndexInTrait(id) {
+        var _a, _b, _c;
+        const cachedIndex = (_a = this.traitIndicesCache) === null || _a === void 0 ? void 0 : _a.get(id);
+        if (cachedIndex !== undefined) {
+            return cachedIndex;
+        }
+        const parentData = this.forest.tryGetParent(id);
+        if (parentData === undefined) {
+            return undefined;
+        }
+        const parent = this.forest.tryGet(parentData.parentId);
+        if (parent === undefined) {
+            return undefined;
+        }
+        const trait = (_b = parent.traits.get(parentData.traitParent)) !== null && _b !== void 0 ? _b : Common_1.fail('inconsistent forest: trait parent not found');
+        let foundIndex;
+        if (trait.length === 0) {
+            return foundIndex;
+        }
+        (_c = this.traitIndicesCache) !== null && _c !== void 0 ? _c : (this.traitIndicesCache = new Map());
+        for (let i = 0; i < trait.length; i++) {
+            const nodeInTrait = trait[i];
+            const index = i;
+            this.traitIndicesCache.set(nodeInTrait, index);
+            if (nodeInTrait === id) {
+                foundIndex = index;
+            }
+        }
+        return foundIndex;
+    }
+    /**
+     * @returns the trait at the given location. If no such trait exists, returns an empty trait.
+     */
+    getTrait(traitLocation) {
+        var _a;
+        return (_a = this.getViewNode(traitLocation.parent).traits.get(traitLocation.label)) !== null && _a !== void 0 ? _a : [];
+    }
+    /** Asserts that the view's internal state is consistent. Useful for testing/validation. */
+    assertConsistent() {
+        this.forest.assertConsistent();
+    }
+    [Symbol.iterator]() {
+        return this.iterateNodeDescendants(this.rootNode);
+    }
+    /**
+     * @returns true iff the given view's forest of nodes is equivalent to this view's forest of nodes
+     * @param strict - if true, the views' forests must be the same object, otherwise they must merely be equivalent
+     */
+    hasEqualForest(view, strict = false) {
+        if (this.root === view.root) {
+            // TODO:#49100:Perf: make this faster and/or remove use by PrefetchingCheckout.
+            return strict ? this.forest === view.forest : this.forest.equals(view.forest);
+        }
+        return false;
+    }
+    *iterateNodeDescendants(node) {
+        yield node;
+        for (const label of [...node.traits.keys()].sort()) {
+            const trait = node.traits.get(label);
+            for (const childId of trait !== null && trait !== void 0 ? trait : Common_1.fail('Expected trait with label')) {
+                const child = this.getViewNode(childId);
+                yield* this.iterateNodeDescendants(child);
+            }
+        }
+    }
+    getIndexOfSide(side, traitLocation) {
+        return side === persisted_types_1.Side.After ? 0 : this.getTrait(traitLocation).length;
+    }
+    /**
+     * Calculate the difference between two `TreeView`s
+     * @param view - the other view to compare to this one
+     * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `view`.
+     * The views must share a root.
+     */
+    delta(view) {
+        Common_1.assert(this.root === view.root, 'Delta can only be calculated between views that share a root');
+        return this.forest.delta(view.forest);
+    }
+}
+exports.TreeView = TreeView;
+function getIndex(side, index) {
+    // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+    return (side + index);
+}
+//# sourceMappingURL=TreeView.js.map

package/dist/TreeView.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeView.js","sourceRoot":"","sources":["../src/TreeView.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAA+D;AAE/D,qCAA+D;AAC/D,uDAAmD;AAsEnD;;;GAGG;AACH,MAAsB,QAAQ;IAY7B,YAAsB,IAAY,EAAE,MAAc;QACjD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,gDAAgD;IAChD,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,qEAAqE;IAC9D,OAAO,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,KAAoB;QAC/C,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;SACpD;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,kHAAkH;IAC3G,WAAW,CAAC,EAAU;;QAC5B,aAAO,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,mCAAI,aAAI,CAAC,kBAAkB,CAAC,CAAC;IAC5D,CAAC;IAED,wHAAwH;IACjH,cAAc,CAAC,EAAU;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,UAAU,KAAK,SAAS,IAAI,6BAAoB,CAAC,UAAU,CAAC,EAAE;YACjE,MAAM,QAAQ,GAAiB;gBAC9B,UAAU,EAAE,UAAU,CAAC,UAAU;gBACjC,UAAU,EAAE,UAAU,CAAC,UAAU;gBACjC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,SAAS,EAAE;oBACV,KAAK,EAAE,UAAU,CAAC,WAAW;oBAC7B,MAAM,EAAE,UAAU,CAAC,QAAQ;iBAC3B;aACD,CAAC;YACF,8BAAqB,CAAC,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;YACvD,OAAO,QAAQ,CAAC;SAChB;QAED,OAAO,UAAU,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,EAAU;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,EAAU;;QACjC,aAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,0CAAE,WAAW,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,EAAU;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,EAAU;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAChD,IAAI,UAAU,KAAK,SAAS,EAAE;YAC7B,OAAO,SAAS,CAAC;SACjB;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,EAAU;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC7C,OAAO;YACN,MAAM,EAAE,UAAU,CAAC,QAAQ;YAC3B,KAAK,EAAE,UAAU,CAAC,WAAW;SAC7B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,EAAU;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAChD,IAAI,UAAU,KAAK,SAAS,EAAE;YAC7B,OAAO,SAAS,CAAC;SACjB;QACD,OAAO;YACN,MAAM,EAAE,UAAU,CAAC,QAAQ;YAC3B,KAAK,EAAE,UAAU,CAAC,WAAW;SAC7B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,EAAU;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,aAAI,CAAC,kCAAkC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,EAAU;;QACnC,MAAM,WAAW,SAAG,IAAI,CAAC,iBAAiB,0CAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QACpD,IAAI,WAAW,KAAK,SAAS,EAAE;YAC9B,OAAO,WAAW,CAAC;SACnB;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAChD,IAAI,UAAU,KAAK,SAAS,EAAE;YAC7B,OAAO,SAAS,CAAC;SACjB;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,MAAM,KAAK,SAAS,EAAE;YACzB,OAAO,SAAS,CAAC;SACjB;QAED,MAAM,KAAK,SAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,mCAAI,aAAI,CAAC,6CAA6C,CAAC,CAAC;QAC/G,IAAI,UAAsC,CAAC;QAC3C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,UAAU,CAAC;SAClB;QAED,MAAA,IAAI,CAAC,iBAAiB,oCAAtB,IAAI,CAAC,iBAAiB,GAAK,IAAI,GAAG,EAAE,EAAC;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACtC,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC/C,IAAI,WAAW,KAAK,EAAE,EAAE;gBACvB,UAAU,GAAG,KAAK,CAAC;aACnB;SACD;QAED,OAAO,UAAU,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,aAA4B;;QAC3C,aAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,mCAAI,EAAE,CAAC;IACrF,CAAC;IAED,2FAA2F;IACpF,gBAAgB;QACtB,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAChC,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAKD;;;OAGG;IACI,cAAc,CAAC,IAAc,EAAE,MAAM,GAAG,KAAK;QACnD,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;YAC5B,+EAA+E;YAC/E,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC9E;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAEO,CAAC,sBAAsB,CAAC,IAAkB;QACjD,MAAM,IAAI,CAAC;QACX,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;YACnD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrC,KAAK,MAAM,OAAO,IAAI,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,aAAI,CAAC,2BAA2B,CAAC,EAAE;gBACjE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBACxC,KAAK,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;aAC1C;SACD;IACF,CAAC;IAEO,cAAc,CAAC,IAAU,EAAE,aAA4B;QAC9D,OAAO,IAAI,KAAK,sBAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAgB,CAAC,CAAC,CAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,MAAqB,CAAC;IACtG,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAc;QAC1B,eAAM,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,8DAA8D,CAAC,CAAC;QAChG,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;CACD;AA1OD,4BA0OC;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,KAAqB;IAClD,qEAAqE;IACrE,OAAO,CAAC,IAAI,GAAG,KAAK,CAAe,CAAC;AACrC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, copyPropertyIfDefined, fail } from './Common';\nimport { NodeId, TraitLabel } from './Identifiers';\nimport { Delta, Forest, isParentedForestNode } from './Forest';\nimport { NodeData, Side } from './persisted-types';\n\n/**\n * Specifies the location of a trait (a labeled sequence of nodes) within the tree.\n * @public\n */\nexport interface TraitLocation {\n\treadonly parent: NodeId;\n\treadonly label: TraitLabel;\n}\n\n/**\n * An immutable view of a distributed tree node.\n * @public\n */\nexport interface TreeViewNode extends NodeData<NodeId> {\n\t/** The IDs of the children under this node */\n\treadonly traits: ReadonlyMap<TraitLabel, readonly NodeId[]>;\n\t/** The parent and trait under which this node resides. Undefined iff this is the root node of the tree (i.e. {@link initialTree}). */\n\treadonly parentage?: TraitLocation;\n}\n\n/**\n * Index of a place within a trait.\n * 0 = before all nodes,\n * 1 = after first node,\n * etc.\n * @public\n */\nexport type PlaceIndex = number & { readonly PlaceIndex: unique symbol };\n\n/**\n * Index of a node within a trait.\n * 0 = first node,\n * 1 = second node,\n * etc.\n * @public\n */\nexport type TraitNodeIndex = number & { readonly TraitNodeIndex: unique symbol };\n\n/**\n * A place within a particular `TreeView` that is anchored relative to a specific node in the tree, or relative to the outside of the trait.\n * Valid iff 'trait' is valid and, if provided, sibling is in the Location specified by 'trait'.\n * @public\n */\nexport interface TreeViewPlace {\n\treadonly sibling?: NodeId;\n\treadonly side: Side;\n\treadonly trait: TraitLocation;\n}\n\n/**\n * Specifies the range of nodes from `start` to `end` within a trait within a particular `TreeView`.\n * Valid iff start and end are valid and are within the same trait.\n * @public\n */\nexport interface TreeViewRange {\n\treadonly start: TreeViewPlace;\n\treadonly end: TreeViewPlace;\n}\n\n/**\n * Contains some redundant information. Use only in computations between edits. Do not store.\n * @public\n */\nexport interface NodeInTrait {\n\treadonly trait: TraitLocation;\n\treadonly index: TraitNodeIndex;\n}\n\n/**\n * A view of a distributed tree.\n * @public\n */\nexport abstract class TreeView {\n\tpublic readonly root: NodeId;\n\tprotected readonly forest: Forest;\n\tprivate readonly rootNode: TreeViewNode;\n\n\t/**\n\t * A cache of node's index within their parent trait.\n\t * Used to avoid redundant linear scans of traits.\n\t * Not shared across views; initialized to empty each time a TreeView is created.\n\t */\n\tprivate traitIndicesCache?: Map<NodeId, TraitNodeIndex>;\n\n\tprotected constructor(root: NodeId, forest: Forest) {\n\t\tthis.root = root;\n\t\tthis.forest = forest;\n\t\tthis.rootNode = this.getViewNode(root);\n\t}\n\n\t/** @returns the number of nodes in this view */\n\tpublic get size(): number {\n\t\treturn this.forest.size;\n\t}\n\n\t/** @returns true iff a node with the given id exists in this view */\n\tpublic hasNode(id: NodeId): boolean {\n\t\treturn this.forest.has(id);\n\t}\n\n\t/**\n\t * @returns the index just after place (which specifies a location between items).\n\t * Performance note: this is O(siblings in trait).\n\t */\n\tpublic findIndexWithinTrait(place: TreeViewPlace): PlaceIndex {\n\t\tif (place.sibling === undefined) {\n\t\t\treturn this.getIndexOfSide(place.side, place.trait);\n\t\t}\n\t\treturn getIndex(place.side, this.getIndexInTrait(place.sibling));\n\t}\n\n\t/** @returns the node associated with the given id in this view. Fails if the node does not exist in this view. */\n\tpublic getViewNode(id: NodeId): TreeViewNode {\n\t\treturn this.tryGetViewNode(id) ?? fail('NodeId not found');\n\t}\n\n\t/** @returns the node associated with the given id in this view, or undefined if the node does not exist in this view */\n\tpublic tryGetViewNode(id: NodeId): TreeViewNode | undefined {\n\t\tconst forestNode = this.forest.tryGet(id);\n\t\tif (forestNode !== undefined && isParentedForestNode(forestNode)) {\n\t\t\tconst viewNode: TreeViewNode = {\n\t\t\t\tdefinition: forestNode.definition,\n\t\t\t\tidentifier: forestNode.identifier,\n\t\t\t\ttraits: forestNode.traits,\n\t\t\t\tparentage: {\n\t\t\t\t\tlabel: forestNode.traitParent,\n\t\t\t\t\tparent: forestNode.parentId,\n\t\t\t\t},\n\t\t\t};\n\t\t\tcopyPropertyIfDefined(forestNode, viewNode, 'payload');\n\t\t\treturn viewNode;\n\t\t}\n\n\t\treturn forestNode;\n\t}\n\n\t/**\n\t * @returns the label of the trait under which a node with the given id resides. Fails if the node does not exist in this view or if\n\t * it is the root node.\n\t */\n\tpublic getTraitLabel(id: NodeId): TraitLabel {\n\t\treturn this.forest.getParent(id).traitParent;\n\t}\n\n\t/**\n\t * @returns the label of the trait under which a node with the given id resides, or undefined if the node is not present in this\n\t * view or if it is the root node\n\t */\n\tpublic tryGetTraitLabel(id: NodeId): TraitLabel | undefined {\n\t\treturn this.forest.tryGetParent(id)?.traitParent;\n\t}\n\n\t/**\n\t * @returns the parent of the node with the given id. Fails if the node does not exist in this view or if it is the root node.\n\t */\n\tpublic getParentViewNode(id: NodeId): TreeViewNode {\n\t\tconst parentInfo = this.forest.getParent(id);\n\t\treturn this.getViewNode(parentInfo.parentId);\n\t}\n\n\t/**\n\t * @returns the parent of the node with the given id. Returns undefined if the node does not exist in this view or if it is the root\n\t * node.\n\t */\n\tpublic tryGetParentViewNode(id: NodeId): TreeViewNode | undefined {\n\t\tconst parentInfo = this.forest.tryGetParent(id);\n\t\tif (parentInfo === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn this.getViewNode(parentInfo.parentId);\n\t}\n\n\t/**\n\t * @returns the trait location of the node with the given id. Fails if the node does not exist in this view or of it is the root\n\t * node\n\t */\n\tpublic getTraitLocation(id: NodeId): TraitLocation {\n\t\tconst parentData = this.forest.getParent(id);\n\t\treturn {\n\t\t\tparent: parentData.parentId,\n\t\t\tlabel: parentData.traitParent,\n\t\t};\n\t}\n\n\t/**\n\t * @returns the trait location of the node with the given id, or undefined if the node does not exist in this view or if it is the root\n\t * node\n\t */\n\tpublic tryGetTraitLocation(id: NodeId): TraitLocation | undefined {\n\t\tconst parentData = this.forest.tryGetParent(id);\n\t\tif (parentData === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn {\n\t\t\tparent: parentData.parentId,\n\t\t\tlabel: parentData.traitParent,\n\t\t};\n\t}\n\n\t/**\n\t * @returns the index within the trait under which the node with the given id resides. The node must exist in this view and must have a\n\t * parent.\n\t * Performance note: this is O(siblings in trait).\n\t */\n\tpublic getIndexInTrait(id: NodeId): TraitNodeIndex {\n\t\tconst index = this.tryGetIndexInTrait(id);\n\t\treturn index ?? fail('ID does not exist in the forest.');\n\t}\n\n\t/**\n\t * @returns the index within the trait under which the node with the given id resides, or undefined if the node does not exist in this\n\t * view or does not have a parent.\n\t * Performance note: this is O(siblings in trait).\n\t */\n\tpublic tryGetIndexInTrait(id: NodeId): TraitNodeIndex | undefined {\n\t\tconst cachedIndex = this.traitIndicesCache?.get(id);\n\t\tif (cachedIndex !== undefined) {\n\t\t\treturn cachedIndex;\n\t\t}\n\n\t\tconst parentData = this.forest.tryGetParent(id);\n\t\tif (parentData === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst parent = this.forest.tryGet(parentData.parentId);\n\t\tif (parent === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst trait = parent.traits.get(parentData.traitParent) ?? fail('inconsistent forest: trait parent not found');\n\t\tlet foundIndex: TraitNodeIndex | undefined;\n\t\tif (trait.length === 0) {\n\t\t\treturn foundIndex;\n\t\t}\n\n\t\tthis.traitIndicesCache ??= new Map();\n\t\tfor (let i = 0; i < trait.length; i++) {\n\t\t\tconst nodeInTrait = trait[i];\n\t\t\tconst index = i as TraitNodeIndex;\n\t\t\tthis.traitIndicesCache.set(nodeInTrait, index);\n\t\t\tif (nodeInTrait === id) {\n\t\t\t\tfoundIndex = index;\n\t\t\t}\n\t\t}\n\n\t\treturn foundIndex;\n\t}\n\n\t/**\n\t * @returns the trait at the given location. If no such trait exists, returns an empty trait.\n\t */\n\tpublic getTrait(traitLocation: TraitLocation): readonly NodeId[] {\n\t\treturn this.getViewNode(traitLocation.parent).traits.get(traitLocation.label) ?? [];\n\t}\n\n\t/** Asserts that the view's internal state is consistent. Useful for testing/validation. */\n\tpublic assertConsistent(): void {\n\t\tthis.forest.assertConsistent();\n\t}\n\n\tpublic [Symbol.iterator](): IterableIterator<TreeViewNode> {\n\t\treturn this.iterateNodeDescendants(this.rootNode);\n\t}\n\n\t/** @returns true iff the given view is equal to this view */\n\tpublic abstract equals(view: TreeView): boolean;\n\n\t/**\n\t * @returns true iff the given view's forest of nodes is equivalent to this view's forest of nodes\n\t * @param strict - if true, the views' forests must be the same object, otherwise they must merely be equivalent\n\t */\n\tpublic hasEqualForest(view: TreeView, strict = false): boolean {\n\t\tif (this.root === view.root) {\n\t\t\t// TODO:#49100:Perf: make this faster and/or remove use by PrefetchingCheckout.\n\t\t\treturn strict ? this.forest === view.forest : this.forest.equals(view.forest);\n\t\t}\n\n\t\treturn false;\n\t}\n\n\tprivate *iterateNodeDescendants(node: TreeViewNode): IterableIterator<TreeViewNode> {\n\t\tyield node;\n\t\tfor (const label of [...node.traits.keys()].sort()) {\n\t\t\tconst trait = node.traits.get(label);\n\t\t\tfor (const childId of trait ?? fail('Expected trait with label')) {\n\t\t\t\tconst child = this.getViewNode(childId);\n\t\t\t\tyield* this.iterateNodeDescendants(child);\n\t\t\t}\n\t\t}\n\t}\n\n\tprivate getIndexOfSide(side: Side, traitLocation: TraitLocation): PlaceIndex {\n\t\treturn side === Side.After ? (0 as PlaceIndex) : (this.getTrait(traitLocation).length as PlaceIndex);\n\t}\n\n\t/**\n\t * Calculate the difference between two `TreeView`s\n\t * @param view - the other view to compare to this one\n\t * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `view`.\n\t * The views must share a root.\n\t */\n\tpublic delta(view: TreeView): Delta<NodeId> {\n\t\tassert(this.root === view.root, 'Delta can only be calculated between views that share a root');\n\t\treturn this.forest.delta(view.forest);\n\t}\n}\n\nfunction getIndex(side: Side, index: TraitNodeIndex): PlaceIndex {\n\t// eslint-disable-next-line @typescript-eslint/restrict-plus-operands\n\treturn (side + index) as PlaceIndex;\n}\n"]}

package/dist/TreeViewUtilities.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { StablePlace, StableRange } from './ChangeTypes';
+import { TraitLocation, TreeView, TreeViewPlace, TreeViewRange } from './TreeView';
+/**
+ * Express the given {@link (StableRange:interface)} as a {@link TreeViewRange}
+ */
+export declare function rangeFromStableRange(view: TreeView, range: StableRange): TreeViewRange;
+/**
+ * Express the given {@link (StablePlace:interface)} as a {@link TreeViewPlace}
+ */
+export declare function placeFromStablePlace(view: TreeView, stablePlace: StablePlace): TreeViewPlace;
+/**
+ * Return the trait under which the given range resides
+ * @param view - the {@link TreeView} within which to retrieve the trait location
+ * @param range - must be well formed and valid
+ */
+export declare function getTraitLocationOfRange(view: TreeView, range: StableRange): TraitLocation;
+//# sourceMappingURL=TreeViewUtilities.d.ts.map

package/dist/TreeViewUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeViewUtilities.d.ts","sourceRoot":"","sources":["../src/TreeViewUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEnF;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,GAAG,aAAa,CAOtF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,GAAG,aAAa,CAc5F;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,GAAG,aAAa,CAQzF"}

package/dist/TreeViewUtilities.js

@@ -0,0 +1,77 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTraitLocationOfRange = exports.placeFromStablePlace = exports.rangeFromStableRange = void 0;
+const Common_1 = require("./Common");
+/**
+ * Express the given {@link (StableRange:interface)} as a {@link TreeViewRange}
+ */
+function rangeFromStableRange(view, range) {
+    const location = getTraitLocationOfRange(view, range);
+    // This can be optimized for better constant factors.
+    return {
+        start: sideOfRange(range, SideOfRange.Start, location),
+        end: sideOfRange(range, SideOfRange.End, location),
+    };
+}
+exports.rangeFromStableRange = rangeFromStableRange;
+/**
+ * Express the given {@link (StablePlace:interface)} as a {@link TreeViewPlace}
+ */
+function placeFromStablePlace(view, stablePlace) {
+    const { side } = stablePlace;
+    if (stablePlace.referenceSibling === undefined) {
+        Common_1.assert(stablePlace.referenceTrait !== undefined);
+        return {
+            trait: stablePlace.referenceTrait,
+            side,
+        };
+    }
+    return {
+        trait: view.getTraitLocation(stablePlace.referenceSibling),
+        side: stablePlace.side,
+        sibling: stablePlace.referenceSibling,
+    };
+}
+exports.placeFromStablePlace = placeFromStablePlace;
+/**
+ * Return the trait under which the given range resides
+ * @param view - the {@link TreeView} within which to retrieve the trait location
+ * @param range - must be well formed and valid
+ */
+function getTraitLocationOfRange(view, range) {
+    var _a, _b, _c;
+    const referenceTrait = (_a = range.start.referenceTrait) !== null && _a !== void 0 ? _a : range.end.referenceTrait;
+    if (referenceTrait) {
+        return referenceTrait;
+    }
+    const sibling = (_c = (_b = range.start.referenceSibling) !== null && _b !== void 0 ? _b : range.end.referenceSibling) !== null && _c !== void 0 ? _c : Common_1.fail('malformed range does not indicate trait');
+    return view.getTraitLocation(sibling);
+}
+exports.getTraitLocationOfRange = getTraitLocationOfRange;
+function sideOfRange(range, sideOfRange, trait) {
+    const siblingRelative = sideOfRange === SideOfRange.Start ? range.start : range.end;
+    return {
+        trait,
+        side: siblingRelative.side,
+        sibling: siblingRelative.referenceSibling,
+    };
+}
+/**
+ * Denotes either the start or end of a range
+ */
+var SideOfRange;
+(function (SideOfRange) {
+    /**
+     * The start of the range
+     */
+    SideOfRange[SideOfRange["Start"] = 0] = "Start";
+    /**
+     * The end of the range
+     */
+    SideOfRange[SideOfRange["End"] = 1] = "End";
+})(SideOfRange || (SideOfRange = {}));
+//# sourceMappingURL=TreeViewUtilities.js.map

package/dist/TreeViewUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeViewUtilities.js","sourceRoot":"","sources":["../src/TreeViewUtilities.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,qCAAwC;AAGxC;;GAEG;AACH,SAAgB,oBAAoB,CAAC,IAAc,EAAE,KAAkB;IACtE,MAAM,QAAQ,GAAG,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,qDAAqD;IACrD,OAAO;QACN,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;QACtD,GAAG,EAAE,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC;KAClD,CAAC;AACH,CAAC;AAPD,oDAOC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,IAAc,EAAE,WAAwB;IAC5E,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;IAC7B,IAAI,WAAW,CAAC,gBAAgB,KAAK,SAAS,EAAE;QAC/C,eAAM,CAAC,WAAW,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC;QACjD,OAAO;YACN,KAAK,EAAE,WAAW,CAAC,cAAc;YACjC,IAAI;SACJ,CAAC;KACF;IACD,OAAO;QACN,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,gBAAgB,CAAC;QAC1D,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,OAAO,EAAE,WAAW,CAAC,gBAAgB;KACrC,CAAC;AACH,CAAC;AAdD,oDAcC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,IAAc,EAAE,KAAkB;;IACzE,MAAM,cAAc,SAAG,KAAK,CAAC,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC;IAC9E,IAAI,cAAc,EAAE;QACnB,OAAO,cAAc,CAAC;KACtB;IACD,MAAM,OAAO,eACZ,KAAK,CAAC,KAAK,CAAC,gBAAgB,mCAAI,KAAK,CAAC,GAAG,CAAC,gBAAgB,mCAAI,aAAI,CAAC,yCAAyC,CAAC,CAAC;IAC/G,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACvC,CAAC;AARD,0DAQC;AAED,SAAS,WAAW,CAAC,KAAkB,EAAE,WAAwB,EAAE,KAAoB;IACtF,MAAM,eAAe,GAAG,WAAW,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;IACpF,OAAO;QACN,KAAK;QACL,IAAI,EAAE,eAAe,CAAC,IAAI;QAC1B,OAAO,EAAE,eAAe,CAAC,gBAAgB;KACzC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,IAAK,WASJ;AATD,WAAK,WAAW;IACf;;OAEG;IACH,+CAAS,CAAA;IACT;;OAEG;IACH,2CAAO,CAAA;AACR,CAAC,EATI,WAAW,KAAX,WAAW,QASf","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { StablePlace, StableRange } from './ChangeTypes';\nimport { assert, fail } from './Common';\nimport { TraitLocation, TreeView, TreeViewPlace, TreeViewRange } from './TreeView';\n\n/**\n * Express the given {@link (StableRange:interface)} as a {@link TreeViewRange}\n */\nexport function rangeFromStableRange(view: TreeView, range: StableRange): TreeViewRange {\n\tconst location = getTraitLocationOfRange(view, range);\n\t// This can be optimized for better constant factors.\n\treturn {\n\t\tstart: sideOfRange(range, SideOfRange.Start, location),\n\t\tend: sideOfRange(range, SideOfRange.End, location),\n\t};\n}\n\n/**\n * Express the given {@link (StablePlace:interface)} as a {@link TreeViewPlace}\n */\nexport function placeFromStablePlace(view: TreeView, stablePlace: StablePlace): TreeViewPlace {\n\tconst { side } = stablePlace;\n\tif (stablePlace.referenceSibling === undefined) {\n\t\tassert(stablePlace.referenceTrait !== undefined);\n\t\treturn {\n\t\t\ttrait: stablePlace.referenceTrait,\n\t\t\tside,\n\t\t};\n\t}\n\treturn {\n\t\ttrait: view.getTraitLocation(stablePlace.referenceSibling),\n\t\tside: stablePlace.side,\n\t\tsibling: stablePlace.referenceSibling,\n\t};\n}\n\n/**\n * Return the trait under which the given range resides\n * @param view - the {@link TreeView} within which to retrieve the trait location\n * @param range - must be well formed and valid\n */\nexport function getTraitLocationOfRange(view: TreeView, range: StableRange): TraitLocation {\n\tconst referenceTrait = range.start.referenceTrait ?? range.end.referenceTrait;\n\tif (referenceTrait) {\n\t\treturn referenceTrait;\n\t}\n\tconst sibling =\n\t\trange.start.referenceSibling ?? range.end.referenceSibling ?? fail('malformed range does not indicate trait');\n\treturn view.getTraitLocation(sibling);\n}\n\nfunction sideOfRange(range: StableRange, sideOfRange: SideOfRange, trait: TraitLocation): TreeViewPlace {\n\tconst siblingRelative = sideOfRange === SideOfRange.Start ? range.start : range.end;\n\treturn {\n\t\ttrait,\n\t\tside: siblingRelative.side,\n\t\tsibling: siblingRelative.referenceSibling,\n\t};\n}\n\n/**\n * Denotes either the start or end of a range\n */\nenum SideOfRange {\n\t/**\n\t * The start of the range\n\t */\n\tStart = 0,\n\t/**\n\t * The end of the range\n\t */\n\tEnd = 1,\n}\n"]}

package/dist/{default-edits/UndoRedoHandler.d.ts → UndoRedoHandler.d.ts}

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { EditId } from '../Identifiers';
+import { EditId } from './Identifiers';
 import { SharedTree } from './SharedTree';
 export interface IRevertible {
     revert(): any;
@@ -26,7 +26,7 @@ export declare class SharedTreeUndoRedoHandler {
  * Tracks a change on a shared tree and allows reverting it
  */
 export declare class SharedTreeRevertible implements IRevertible {
-    private editId;
+    private readonly editId;
     private readonly tree;
     constructor(editId: EditId, tree: SharedTree);
     revert(): void;

package/dist/UndoRedoHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UndoRedoHandler.d.ts","sourceRoot":"","sources":["../src/UndoRedoHandler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAA+B,UAAU,EAAE,MAAM,cAAc,CAAC;AAKvE,MAAM,WAAW,WAAW;IAC3B,MAAM,QAAG;IACT,OAAO,QAAG;CACV;AAED,MAAM,WAAW,aAAa;IAC7B,sBAAsB,CAAC,UAAU,EAAE,WAAW,OAAE;CAChD;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY;gBAAZ,YAAY,EAAE,aAAa;IAEjD,UAAU,CAAC,IAAI,EAAE,UAAU;IAG3B,UAAU,CAAC,IAAI,EAAE,UAAU;IAIlC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAc/B;CACF;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,WAAW;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM;IAAU,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAArC,MAAM,EAAE,MAAM,EAAmB,IAAI,EAAE,UAAU;IAEvE,MAAM;IAIN,OAAO;CAGd"}

package/dist/{default-edits/UndoRedoHandler.js → UndoRedoHandler.js}

@@ -5,8 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedTreeRevertible = exports.SharedTreeUndoRedoHandler = void 0;
-const Common_1 = require("../Common");
-const generic_1 = require("../generic");
+const Common_1 = require("./Common");
+const EventTypes_1 = require("./EventTypes");
 /**
  * A shared tree undo redo handler that will add revertible local tree changes to the provided
  * undo redo stack manager
@@ -22,10 +22,10 @@ class SharedTreeUndoRedoHandler {
         };
     }
     attachTree(tree) {
-        tree.on(generic_1.SharedTreeEvent.EditCommitted, this.treeDeltaHandler);
+        tree.on(EventTypes_1.SharedTreeEvent.EditCommitted, this.treeDeltaHandler);
     }
     detachTree(tree) {
-        tree.off(generic_1.SharedTreeEvent.EditCommitted, this.treeDeltaHandler);
+        tree.off(EventTypes_1.SharedTreeEvent.EditCommitted, this.treeDeltaHandler);
     }
 }
 exports.SharedTreeUndoRedoHandler = SharedTreeUndoRedoHandler;
@@ -38,11 +38,7 @@ class SharedTreeRevertible {
         this.tree = tree;
     }
     revert() {
-        const editIndex = this.tree.edits.getIndexOfId(this.editId);
-        const edit = this.tree.edits.getEditInSessionAtIndex(editIndex);
-        const snapshotBefore = this.tree.logViewer.getSnapshotInSession(editIndex);
-        // Apply the revert edit and set it as the new revertible edit.
-        this.editId = this.tree.editor.revert(edit, snapshotBefore);
+        this.tree.revert(this.editId);
     }
     discard() {
         return;

package/dist/UndoRedoHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UndoRedoHandler.js","sourceRoot":"","sources":["../src/UndoRedoHandler.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAA8C;AAC9C,6CAA+C;AAgB/C;;;GAGG;AACH,MAAa,yBAAyB;IACrC,YAA6B,YAA2B;QAA3B,iBAAY,GAAZ,YAAY,CAAe;QASvC,qBAAgB,GAAG,CAAC,cAA2C,EAAE,EAAE;YACnF,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,cAAc,CAAC;YAE/C,IAAI,KAAK,EAAE;gBACV,IAAI,CAAC,YAAY,CAAC,sBAAsB,CACvC,IAAI,oBAAoB,CACvB,MAAM,EACN,2BAAkB,CACjB,IAAI,EACJ,sGAAsG,CACtG,CACD,CACD,CAAC;aACF;QACF,CAAC,CAAC;IAvByD,CAAC;IAErD,UAAU,CAAC,IAAgB;QACjC,IAAI,CAAC,EAAE,CAAC,4BAAe,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IACM,UAAU,CAAC,IAAgB;QACjC,IAAI,CAAC,GAAG,CAAC,4BAAe,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAChE,CAAC;CAiBD;AAzBD,8DAyBC;AAED;;GAEG;AACH,MAAa,oBAAoB;IAChC,YAA6B,MAAc,EAAmB,IAAgB;QAAjD,WAAM,GAAN,MAAM,CAAQ;QAAmB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAE3E,MAAM;QACZ,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAEM,OAAO;QACb,OAAO;IACR,CAAC;CACD;AAVD,oDAUC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assertNotUndefined } from './Common';\nimport { SharedTreeEvent } from './EventTypes';\nimport { EditId } from './Identifiers';\nimport { EditCommittedEventArguments, SharedTree } from './SharedTree';\n\n// TODO: We temporarily duplicate these contracts from 'framework/undo-redo' to unblock development\n// while we decide on the correct layering for undo.\n\nexport interface IRevertible {\n\trevert();\n\tdiscard();\n}\n\nexport interface IUndoConsumer {\n\tpushToCurrentOperation(revertible: IRevertible);\n}\n\n/**\n * A shared tree undo redo handler that will add revertible local tree changes to the provided\n * undo redo stack manager\n */\nexport class SharedTreeUndoRedoHandler {\n\tconstructor(private readonly stackManager: IUndoConsumer) {}\n\n\tpublic attachTree(tree: SharedTree) {\n\t\ttree.on(SharedTreeEvent.EditCommitted, this.treeDeltaHandler);\n\t}\n\tpublic detachTree(tree: SharedTree) {\n\t\ttree.off(SharedTreeEvent.EditCommitted, this.treeDeltaHandler);\n\t}\n\n\tprivate readonly treeDeltaHandler = (eventArguments: EditCommittedEventArguments) => {\n\t\tconst { editId, local, tree } = eventArguments;\n\n\t\tif (local) {\n\t\t\tthis.stackManager.pushToCurrentOperation(\n\t\t\t\tnew SharedTreeRevertible(\n\t\t\t\t\teditId,\n\t\t\t\t\tassertNotUndefined(\n\t\t\t\t\t\ttree,\n\t\t\t\t\t\t'An edit committed event for a revertible edit should include the target SharedTree in its arguments.'\n\t\t\t\t\t)\n\t\t\t\t)\n\t\t\t);\n\t\t}\n\t};\n}\n\n/**\n * Tracks a change on a shared tree and allows reverting it\n */\nexport class SharedTreeRevertible implements IRevertible {\n\tconstructor(private readonly editId: EditId, private readonly tree: SharedTree) {}\n\n\tpublic revert() {\n\t\tthis.tree.revert(this.editId);\n\t}\n\n\tpublic discard() {\n\t\treturn;\n\t}\n}\n"]}

package/dist/id-compressor/AppendOnlySortedMap.d.ts

@@ -0,0 +1,127 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * A map in which entries are always added in key-sorted order.
+ * Supports appending and searching.
+ */
+export declare class AppendOnlySortedMap<K, V> {
+    protected readonly comparator: (a: K, b: K) => number;
+    protected readonly elements: [K, V][];
+    /**
+     * @param comparator a comparator for keys
+     */
+    constructor(comparator: (a: K, b: K) => number);
+    /**
+     * @returns the number of entries in this map
+     */
+    get size(): number;
+    /**
+     * @returns the min key in the map.
+     */
+    minKey(): K | undefined;
+    /**
+     * @returns the max key in the map.
+     */
+    maxKey(): K | undefined;
+    /**
+     * @returns an iterable of the entries in the map.
+     */
+    entries(): IterableIterator<readonly [K, V]>;
+    /**
+     * @returns an iterable of the keys in the map.
+     */
+    keys(): IterableIterator<K>;
+    /**
+     * @returns an iterable of the values in the map.
+     */
+    values(): IterableIterator<V>;
+    /**
+     * @returns an iterable of the entries in the map, reversed.
+     */
+    entriesReversed(): IterableIterator<readonly [K, V]>;
+    /**
+     * Adds a new key/value pair to the map. `key` must be > to all keys in the map.
+     * @param key the key to add.
+     * @param value the value to add.
+     */
+    append(key: K, value: V): void;
+    private readonly compareKeys;
+    /**
+     * @param key the key to lookup.
+     * @returns the value associated with `key` if such an entry exists, and undefined otherwise.
+     */
+    get(key: K): V | undefined;
+    /**
+     * @param key the key to lookup.
+     * @returns the entry associated with `key` if such an entry exists, the entry associated with the next lower key if such an entry
+     * exists, and undefined otherwise.
+     */
+    getPairOrNextLower(key: K): readonly [K, V] | undefined;
+    /**
+     * @param key the key to lookup.
+     * @returns the entry associated with `key` if such an entry exists, the entry associated with the next higher key if such an entry
+     * exists, and undefined otherwise.
+     */
+    getPairOrNextHigher(key: K): readonly [K, V] | undefined;
+    /**
+     * Compares two `AppendOnlySortedMap`s.
+     */
+    equals(other: AppendOnlySortedMap<K, V>, compareValues: (a: V, b: V) => boolean): boolean;
+    /**
+     * Queries a range of entries.
+     * @param from the key to start the range query at, inclusive.
+     * @param to the key to end the range query at, inclusive.
+     * @returns the range of entries.
+     */
+    getRange(from: K, to: K): IterableIterator<readonly [K, V]>;
+    protected getPairOrNextLowerBy<T>(search: T, comparator: (search: T, element: readonly [K, V]) => number): readonly [K, V] | undefined;
+    private getIndexOfOrNextLower;
+    protected getPairOrNextHigherBy<T>(search: T, comparator: (search: T, element: readonly [K, V]) => number): readonly [K, V] | undefined;
+    private getIndexOfOrNextHigher;
+    /**
+     * The value xor'd with the result index when a search fails.
+     */
+    static readonly failureXor = -1;
+    /**
+     * Performs a binary search on the sorted array.
+     * @param elements
+     * @param search
+     * @param comparator
+     * @returns the index of `search`, or (if not present) the index it would have been inserted into xor'd with `failureXor`. Note that
+     * negating is not an adequate solution as that could result in -0.
+     */
+    static indexOf<T, K, V>(elements: readonly (readonly [K, V])[], search: T, comparator: (search: T, element: readonly [K, V]) => number): number;
+}
+/**
+ * A map in which entries are always added in both key-sorted and value-sorted order.
+ * Supports appending and searching.
+ */
+export declare class AppendOnlyDoublySortedMap<K, V, S> extends AppendOnlySortedMap<K, V> {
+    private readonly extractSearchValue;
+    private readonly valueComparator;
+    constructor(keyComparator: (a: K, b: K) => number, extractSearchValue: (value: V) => S, valueComparator: (search: S, value: V) => number);
+    append(key: K, value: V): void;
+    private readonly compareValues;
+    /**
+     * @param value the value to lookup.
+     * @returns the key associated with `value` if such an entry exists, and undefined otherwise.
+     */
+    getByValue(value: S): K | undefined;
+    /**
+     * @param searchValue the search value to lookup.
+     * @returns the entry who's value, when run through the extractor provided to the constructor, matches `searchValue`. If no such entry
+     * exists, this method returns the next lower entry as determined by the value comparator provided to the constructor. If no such entry
+     * exists, this method returns undefined.
+     */
+    getPairOrNextLowerByValue(searchValue: S): readonly [K, V] | undefined;
+    /**
+     * @param searchValue the search value to lookup.
+     * @returns the entry who's value, when run through the extractor provided to the constructor, matches `searchValue`. If no such entry
+     * exists, this method returns the next higher entry as determined by the value comparator provided to the constructor. If no such entry
+     * exists, this method returns undefined.
+     */
+    getPairOrNextHigherByValue(searchValue: S): readonly [K, V] | undefined;
+}
+//# sourceMappingURL=AppendOnlySortedMap.d.ts.map

package/dist/id-compressor/AppendOnlySortedMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppendOnlySortedMap.d.ts","sourceRoot":"","sources":["../../src/id-compressor/AppendOnlySortedMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,CAAC,EAAE,CAAC;IAMjB,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM;IALxE,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAM;IAE3C;;OAEG;gBACmC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM;IAExE;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACI,MAAM,IAAI,CAAC,GAAG,SAAS;IAI9B;;OAEG;IACI,MAAM,IAAI,CAAC,GAAG,SAAS;IAI9B;;OAEG;IACK,OAAO,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAMpD;;OAEG;IACK,IAAI,IAAI,gBAAgB,CAAC,CAAC,CAAC;IAMnC;;OAEG;IACK,MAAM,IAAI,gBAAgB,CAAC,CAAC,CAAC;IAMrC;;OAEG;IACK,eAAe,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAM5D;;;;OAIG;IACI,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAOrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAE1B;IAEF;;;OAGG;IACI,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAKjC;;;;OAIG;IACI,kBAAkB,CAAC,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;IAI9D;;;;OAIG;IACI,mBAAmB,CAAC,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;IAI/D;;OAEG;IACI,MAAM,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,GAAG,OAAO;IAuBhG;;;;;OAKG;IACK,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAgBnE,SAAS,CAAC,oBAAoB,CAAC,CAAC,EAC/B,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,GACzD,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;IAS9B,OAAO,CAAC,qBAAqB;IAmB7B,SAAS,CAAC,qBAAqB,CAAC,CAAC,EAChC,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,GACzD,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;IAS9B,OAAO,CAAC,sBAAsB;IAmB9B;;OAEG;IACH,gBAAuB,UAAU,MAAM;IAEvC;;;;;;;OAOG;WACW,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAC5B,QAAQ,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EACtC,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,GACzD,MAAM;CAmBT;AAED;;;GAGG;AACH,qBAAa,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAE,SAAQ,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC;IAG/E,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAFhC,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,EACpB,kBAAkB,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EACnC,eAAe,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,MAAM;IAK3D,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAUrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAE5B;IAEF;;;OAGG;IACI,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAK1C;;;;;OAKG;IACI,yBAAyB,CAAC,WAAW,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;IAI7E;;;;;OAKG;IACI,0BAA0B,CAAC,WAAW,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS;CAG9E"}