@fluid-experimental/tree 0.58.2001 → 0.59.2000-61729

package/dist/BasicCheckout.d.ts

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { Snapshot } from './Snapshot';
-import { Checkout } from './Checkout';
-import { GenericSharedTree } from './generic';
-/**
- * Basic Session that stays up to date with the SharedTree.
- *
- * waitForPendingUpdates is always a no-op since BasicCheckout is always up to date.
- * @public
- * @sealed
- */
-export declare class BasicCheckout<TChange> extends Checkout<TChange> {
-    /**
-     * @param tree - the tree
-     */
-    constructor(tree: GenericSharedTree<TChange>);
-    protected get latestCommittedView(): Snapshot;
-    waitForPendingUpdates(): Promise<void>;
-}
-//# sourceMappingURL=BasicCheckout.d.ts.map

package/dist/BasicCheckout.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BasicCheckout.d.ts","sourceRoot":"","sources":["../src/BasicCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAA+B,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE3E;;;;;;GAMG;AACH,qBAAa,aAAa,CAAC,OAAO,CAAE,SAAQ,QAAQ,CAAC,OAAO,CAAC;IAC5D;;OAEG;gBACgB,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAMnD,SAAS,KAAK,mBAAmB,IAAI,QAAQ,CAE5C;IAEY,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;CAGnD"}

package/dist/BasicCheckout.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BasicCheckout.js","sourceRoot":"","sources":["../src/BasicCheckout.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yCAAsC;AAGtC;;;;;;GAMG;AACH,MAAa,aAAuB,SAAQ,mBAAiB;IAC5D;;OAEG;IACH,YAAmB,IAAgC;QAClD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,IAA6D,EAAE,EAAE;YAC/F,IAAI,CAAC,UAAU,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,IAAc,mBAAmB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,qBAAqB;QACjC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;CACD;AAjBD,sCAiBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Snapshot } from './Snapshot';\nimport { Checkout } from './Checkout';\nimport { EditCommittedEventArguments, GenericSharedTree } from './generic';\n\n/**\n * Basic Session that stays up to date with the SharedTree.\n *\n * waitForPendingUpdates is always a no-op since BasicCheckout is always up to date.\n * @public\n * @sealed\n */\nexport class BasicCheckout<TChange> extends Checkout<TChange> {\n\t/**\n\t * @param tree - the tree\n\t */\n\tpublic constructor(tree: GenericSharedTree<TChange>) {\n\t\tsuper(tree, tree.currentView, (args: EditCommittedEventArguments<GenericSharedTree<TChange>>) => {\n\t\t\tthis.emitChange();\n\t\t});\n\t}\n\n\tprotected get latestCommittedView(): Snapshot {\n\t\treturn this.tree.currentView;\n\t}\n\n\tpublic async waitForPendingUpdates(): Promise<void> {\n\t\treturn Promise.resolve();\n\t}\n}\n"]}

package/dist/Snapshot.d.ts

@@ -1,198 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { NodeId, TraitLabel } from './Identifiers';
-import { Delta } from './Forest';
-import { ChangeNode, NodeData, Payload, TraitLocation } from './generic';
-/**
- * An immutable view of a distributed tree node.
- * @public
- */
-export interface SnapshotNode extends NodeData {
-    readonly traits: ReadonlyMap<TraitLabel, readonly NodeId[]>;
-}
-/**
- * Index of a place within a trait.
- * 0 = before all nodes,
- * 1 = after first node,
- * etc.
- * @public
- */
-export declare type PlaceIndex = number & {
-    readonly PlaceIndex: unique symbol;
-};
-/**
- * Index of a node within a trait.
- * 0 = first node,
- * 1 = second node,
- * etc.
- * @public
- */
-export declare type TraitNodeIndex = number & {
-    readonly TraitNodeIndex: unique symbol;
-};
-/**
- * A place within a particular `Snapshot` that is anchored relative to a specific node in the tree, or relative to the outside of the trait.
- * Valid iff 'trait' is valid and, if provided, sibling is in the Location specified by 'trait'.
- * @public
- */
-export interface SnapshotPlace {
-    readonly sibling?: NodeId;
-    readonly side: Side;
-    readonly trait: TraitLocation;
-}
-/**
- * Defines a place relative to sibling.
- * The "outside" of a trait is the `undefined` sibling,
- * so After `undefined` is the beginning of the trait, and before `undefined` is the end.
- *
- * For this purpose, traits look like:
- *
- * `{undefined} - {Node 0} - {Node 1} - ... - {Node N} - {undefined}`
- *
- * Each `{value}` in the diagram is a possible sibling, which is either a Node or undefined.
- * Each `-` in the above diagram is a `Place`, and can be describe as being `After` a particular `{sibling}` or `Before` it.
- * This means that `After` `{undefined}` means the same `Place` as before the first node
- * and `Before` `{undefined}` means the `Place` after the last Node.
- *
- * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):
- * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the
- * two place description may no longer evaluate to the same place.
- * @public
- */
-export declare enum Side {
-    Before = 0,
-    After = 1
-}
-/**
- * Specifies the range of nodes from `start` to `end` within a trait within a particular `Snapshot`.
- * Valid iff start and end are valid and are withing the same trait.
- * @public
- */
-export interface SnapshotRange {
-    readonly start: SnapshotPlace;
-    readonly end: SnapshotPlace;
-}
-/**
- * An immutable view of a distributed tree.
- * @public
- */
-export declare class Snapshot {
-    readonly root: NodeId;
-    private readonly forest;
-    /**
-     * A cache of node's index within their parent trait.
-     * Used to avoid redundant linear scans of traits.
-     * Not shared across snapshots; initialized to empty each time a Snapshot is created.
-     */
-    private traitIndicesCache?;
-    /**
-     * Constructs a Snapshot using the supplied tree.
-     * @param root - the root of the tree to use as the contents of the `Snapshot`
-     */
-    static fromTree(root: ChangeNode, expensiveValidation?: boolean): Snapshot;
-    private constructor();
-    /** Return a tree of JSON-compatible `ChangeNode`s representing the current state of this `Snapshot` */
-    getChangeNodeTree(): ChangeNode;
-    /**
-     * Returns the number of nodes in this `Snapshot`
-     */
-    get size(): number;
-    /**
-     * @returns true iff the nodeId exists.
-     */
-    hasNode(id: NodeId): boolean;
-    /**
-     * @returns a `ChangeNode` derived from the `SnapshotNode` in this snapshot with the given `NodeId`.
-     */
-    getChangeNode(id: NodeId): ChangeNode;
-    /**
-     * @returns the `ChangeNode`s derived from the `SnapshotNode`s in this snapshot with the given `NodeId`s.
-     */
-    getChangeNodes(nodeIds: readonly NodeId[]): ChangeNode[];
-    /**
-     * Asserts the forest is in a consistent state.
-     */
-    assertConsistent(): void;
-    /**
-     * Inserts all nodes in a NodeSequence into the forest.
-     */
-    addNodes(sequence: Iterable<SnapshotNode>): Snapshot;
-    /**
-     * Remove all nodes with the given ids from the forest
-     */
-    deleteNodes(nodes: Iterable<NodeId>): Snapshot;
-    /**
-     * Parents a set of detached nodes at a specified place.
-     * @param nodesToAttach - the nodes to parent in the specified place. The nodes must already be present in the Snapshot.
-     * @param place - the location to insert the nodes.
-     */
-    attachRange(nodesToAttach: readonly NodeId[], place: SnapshotPlace): Snapshot;
-    /**
-     * Detaches a range of nodes from their parent. The detached nodes remain in the Snapshot.
-     * @param rangeToDetach - the range of nodes to detach
-     */
-    detachRange(rangeToDetach: SnapshotRange): {
-        snapshot: Snapshot;
-        detached: readonly NodeId[];
-    };
-    /**
-     * Sets a node's value. The node must exist in this `Snapshot`.
-     * @param nodeId - the id of the node
-     * @param value - the new value
-     */
-    setNodeValue(nodeId: NodeId, value: Payload): Snapshot;
-    /**
-     * @returns the index just after place (which specifies a location between items).
-     * Performance note: this is O(siblings in trait).
-     */
-    findIndexWithinTrait(place: SnapshotPlace): PlaceIndex;
-    /**
-     * Returns the node associated with `id` in this `Snapshot`.
-     */
-    getSnapshotNode(id: NodeId): SnapshotNode;
-    /**
-     * Returns the label of the trait that a node is under. Returns undefined if the node is not present or if it is the root node.
-     */
-    getTraitLabel(id: NodeId): TraitLabel | undefined;
-    /**
-     * Returns the parent of a node. Returns undefined if the node does not exist in the snapshot or if it does not have a parent.
-     */
-    getParentSnapshotNode(id: NodeId): SnapshotNode | undefined;
-    /**
-     * @param node - must have a parent.
-     */
-    getTraitLocation(node: NodeId): TraitLocation;
-    /**
-     * @param node - must have a parent.
-     * Performance note: this is O(siblings in trait).
-     */
-    getIndexInTrait(node: NodeId): TraitNodeIndex;
-    /**
-     * Return a trait given its location
-     * @param traitLocation - the location of the trait
-     */
-    getTrait(traitLocation: TraitLocation): readonly NodeId[];
-    private getIndexOfSide;
-    /** Compares this snapshot to another for equality. */
-    equals(snapshot: Snapshot): boolean;
-    private iterateNodeDescendants;
-    /**
-     * Calculate the difference between two `Snapshot`s
-     * @param snapshot - the other snapshot to compare to this one
-     * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `snapshot`.
-     * The snapshots must share a root.
-     */
-    delta(snapshot: Snapshot): Delta<NodeId>;
-    [Symbol.iterator](): IterableIterator<SnapshotNode>;
-}
-/**
- * Contains some redundant information. Use only in computations between edits. Do not store.
- * @public
- */
-export interface NodeInTrait {
-    readonly trait: TraitLocation;
-    readonly index: TraitNodeIndex;
-}
-//# sourceMappingURL=Snapshot.d.ts.map

package/dist/Snapshot.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Snapshot.d.ts","sourceRoot":"","sources":["../src/Snapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAU,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC7C,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;CAC5D;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;;;;;;;;;;;;;;;;;;GAkBG;AACH,oBAAY,IAAI;IACf,MAAM,IAAI;IACV,KAAK,IAAI;CACT;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;CAC5B;AAED;;;GAGG;AACH,qBAAa,QAAQ;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD;;;OAGG;WACW,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,mBAAmB,UAAQ,GAAG,QAAQ;IA+B/E,OAAO;IAKP,uGAAuG;IAChG,iBAAiB,IAAI,UAAU;IAItC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAInC;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU;IAI5C;;OAEG;IACI,cAAc,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,EAAE;IAI/D;;OAEG;IACI,gBAAgB,IAAI,IAAI;IAI/B;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,QAAQ;IAI3D;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ;IAIrD;;;;OAIG;IACI,WAAW,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,GAAG,QAAQ;IAMpF;;;OAGG;IACI,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;KAAE;IAUrG;;;;OAIG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,QAAQ;IAI7D;;;OAGG;IACI,oBAAoB,CAAC,KAAK,EAAE,aAAa,GAAG,UAAU;IAO7D;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAIhD;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAQlE;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IASpD;;;OAGG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc;IAyBpD;;;OAGG;IACI,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,MAAM,EAAE;IAIhE,OAAO,CAAC,cAAc;IAItB,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAS1C,OAAO,CAAE,sBAAsB;IAU/B;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAKxC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,YAAY,CAAC;CAG1D;AAOD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAC/B"}

package/dist/Snapshot.js

@@ -1,267 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Snapshot = exports.Side = void 0;
-const Common_1 = require("./Common");
-const SnapshotUtilities_1 = require("./SnapshotUtilities");
-const Forest_1 = require("./Forest");
-/**
- * Defines a place relative to sibling.
- * The "outside" of a trait is the `undefined` sibling,
- * so After `undefined` is the beginning of the trait, and before `undefined` is the end.
- *
- * For this purpose, traits look like:
- *
- * `{undefined} - {Node 0} - {Node 1} - ... - {Node N} - {undefined}`
- *
- * Each `{value}` in the diagram is a possible sibling, which is either a Node or undefined.
- * Each `-` in the above diagram is a `Place`, and can be describe as being `After` a particular `{sibling}` or `Before` it.
- * This means that `After` `{undefined}` means the same `Place` as before the first node
- * and `Before` `{undefined}` means the `Place` after the last Node.
- *
- * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):
- * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the
- * two place description may no longer evaluate to the same place.
- * @public
- */
-var Side;
-(function (Side) {
-    Side[Side["Before"] = 0] = "Before";
-    Side[Side["After"] = 1] = "After";
-})(Side = exports.Side || (exports.Side = {}));
-/**
- * An immutable view of a distributed tree.
- * @public
- */
-class Snapshot {
-    constructor(root, forest) {
-        this.root = root;
-        this.forest = forest;
-    }
-    /**
-     * Constructs a Snapshot using the supplied tree.
-     * @param root - the root of the tree to use as the contents of the `Snapshot`
-     */
-    static fromTree(root, expensiveValidation = false) {
-        function insertNodeRecursive(node, newSnapshotNodes) {
-            const { identifier, definition } = node;
-            const traits = new Map();
-            // eslint-disable-next-line no-restricted-syntax
-            for (const key in node.traits) {
-                if (Object.prototype.hasOwnProperty.call(node.traits, key)) {
-                    const element = node.traits[key];
-                    if (element.length > 0) {
-                        traits.set(key, element.map((n) => insertNodeRecursive(n, newSnapshotNodes)));
-                    }
-                }
-            }
-            const snapshotNode = { identifier, definition, traits };
-            Common_1.copyPropertyIfDefined(node, snapshotNode, 'payload');
-            Common_1.assert(!newSnapshotNodes.has(identifier), `duplicate node in tree for snapshot: { identifier: ${identifier}, definition: ${definition}`);
-            newSnapshotNodes.set(snapshotNode.identifier, snapshotNode);
-            return snapshotNode.identifier;
-        }
-        const map = new Map();
-        return new Snapshot(insertNodeRecursive(root, map), Forest_1.Forest.create(expensiveValidation).add(map.values()));
-    }
-    /** Return a tree of JSON-compatible `ChangeNode`s representing the current state of this `Snapshot` */
-    getChangeNodeTree() {
-        return SnapshotUtilities_1.getChangeNodeFromSnapshot(this, this.root);
-    }
-    /**
-     * Returns the number of nodes in this `Snapshot`
-     */
-    get size() {
-        return this.forest.size;
-    }
-    /**
-     * @returns true iff the nodeId exists.
-     */
-    hasNode(id) {
-        return this.forest.tryGet(id) !== undefined;
-    }
-    /**
-     * @returns a `ChangeNode` derived from the `SnapshotNode` in this snapshot with the given `NodeId`.
-     */
-    getChangeNode(id) {
-        return SnapshotUtilities_1.getChangeNodeFromSnapshot(this, id);
-    }
-    /**
-     * @returns the `ChangeNode`s derived from the `SnapshotNode`s in this snapshot with the given `NodeId`s.
-     */
-    getChangeNodes(nodeIds) {
-        return nodeIds.map((id) => this.getChangeNode(id));
-    }
-    /**
-     * Asserts the forest is in a consistent state.
-     */
-    assertConsistent() {
-        this.forest.assertConsistent();
-    }
-    /**
-     * Inserts all nodes in a NodeSequence into the forest.
-     */
-    addNodes(sequence) {
-        return new Snapshot(this.root, this.forest.add(sequence));
-    }
-    /**
-     * Remove all nodes with the given ids from the forest
-     */
-    deleteNodes(nodes) {
-        return new Snapshot(this.root, this.forest.delete(nodes, true));
-    }
-    /**
-     * Parents a set of detached nodes at a specified place.
-     * @param nodesToAttach - the nodes to parent in the specified place. The nodes must already be present in the Snapshot.
-     * @param place - the location to insert the nodes.
-     */
-    attachRange(nodesToAttach, place) {
-        const { parent, label } = place.trait;
-        const index = this.findIndexWithinTrait(place);
-        return new Snapshot(this.root, this.forest.attachRangeOfChildren(parent, label, index, nodesToAttach));
-    }
-    /**
-     * Detaches a range of nodes from their parent. The detached nodes remain in the Snapshot.
-     * @param rangeToDetach - the range of nodes to detach
-     */
-    detachRange(rangeToDetach) {
-        const { start, end } = rangeToDetach;
-        const { trait: traitLocation } = start;
-        const { parent, label } = traitLocation;
-        const startIndex = this.findIndexWithinTrait(start);
-        const endIndex = this.findIndexWithinTrait(end);
-        const { forest, detached } = this.forest.detachRangeOfChildren(parent, label, startIndex, endIndex);
-        return { snapshot: new Snapshot(this.root, forest), detached };
-    }
-    /**
-     * Sets a node's value. The node must exist in this `Snapshot`.
-     * @param nodeId - the id of the node
-     * @param value - the new value
-     */
-    setNodeValue(nodeId, value) {
-        return new Snapshot(this.root, this.forest.setValue(nodeId, value));
-    }
-    /**
-     * @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 `id` in this `Snapshot`.
-     */
-    getSnapshotNode(id) {
-        return this.forest.get(id);
-    }
-    /**
-     * Returns the label of the trait that a node is under. Returns undefined if the node is not present or if it is the root node.
-     */
-    getTraitLabel(id) {
-        var _a;
-        return (_a = this.forest.tryGetParent(id)) === null || _a === void 0 ? void 0 : _a.traitParent;
-    }
-    /**
-     * Returns the parent of a node. Returns undefined if the node does not exist in the snapshot or if it does not have a parent.
-     */
-    getParentSnapshotNode(id) {
-        const parentInfo = this.forest.tryGetParent(id);
-        if (parentInfo === undefined) {
-            return undefined;
-        }
-        return this.getSnapshotNode(parentInfo.parentId);
-    }
-    /**
-     * @param node - must have a parent.
-     */
-    getTraitLocation(node) {
-        const parentData = this.forest.getParent(node);
-        Common_1.assert(parentData !== undefined, 'node must have parent');
-        return {
-            parent: parentData.parentId,
-            label: parentData.traitParent,
-        };
-    }
-    /**
-     * @param node - must have a parent.
-     * Performance note: this is O(siblings in trait).
-     */
-    getIndexInTrait(node) {
-        var _a;
-        if (this.traitIndicesCache === undefined) {
-            this.traitIndicesCache = new Map();
-        }
-        else {
-            const cached = this.traitIndicesCache.get(node);
-            if (cached !== undefined) {
-                return cached;
-            }
-        }
-        const parentData = this.forest.getParent(node);
-        const parent = this.forest.get(parentData.parentId);
-        const traitParent = (_a = parent.traits.get(parentData.traitParent)) !== null && _a !== void 0 ? _a : Common_1.fail('invalid parentData: trait parent not found.');
-        let foundIndex = -1;
-        for (let i = 0; i < traitParent.length; i++) {
-            const nodeInTrait = traitParent[i];
-            const index = i;
-            this.traitIndicesCache.set(nodeInTrait, index);
-            if (nodeInTrait === node) {
-                foundIndex = index;
-            }
-        }
-        return foundIndex !== -1 ? foundIndex : Common_1.fail('invalidParentData: node not found in specified trait');
-    }
-    /**
-     * Return a trait given its location
-     * @param traitLocation - the location of the trait
-     */
-    getTrait(traitLocation) {
-        var _a;
-        return (_a = this.getSnapshotNode(traitLocation.parent).traits.get(traitLocation.label)) !== null && _a !== void 0 ? _a : [];
-    }
-    getIndexOfSide(side, traitLocation) {
-        return side === Side.After ? 0 : this.getTrait(traitLocation).length;
-    }
-    /** Compares this snapshot to another for equality. */
-    equals(snapshot) {
-        if (this.root !== snapshot.root) {
-            return false;
-        }
-        // TODO:#49100:Perf: make this faster and/or remove use by PrefetchingCheckout.
-        return this.forest.equals(snapshot.forest);
-    }
-    *iterateNodeDescendants(nodeId) {
-        const node = this.getSnapshotNode(nodeId);
-        yield node;
-        for (const trait of node.traits.values()) {
-            for (const childId of trait) {
-                yield* this.iterateNodeDescendants(childId);
-            }
-        }
-    }
-    /**
-     * Calculate the difference between two `Snapshot`s
-     * @param snapshot - the other snapshot to compare to this one
-     * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `snapshot`.
-     * The snapshots must share a root.
-     */
-    delta(snapshot) {
-        Common_1.assert(this.root === snapshot.root, 'Delta can only be calculated between snapshots that share a root');
-        return this.forest.delta(snapshot.forest);
-    }
-    [Symbol.iterator]() {
-        return this.iterateNodeDescendants(this.root);
-    }
-}
-exports.Snapshot = Snapshot;
-function getIndex(side, index) {
-    // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-    return (side + index);
-}
-//# sourceMappingURL=Snapshot.js.map

package/dist/Snapshot.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Snapshot.js","sourceRoot":"","sources":["../src/Snapshot.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAA+D;AAE/D,2DAAgE;AAChE,qCAAyC;AAwCzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,IAAY,IAGX;AAHD,WAAY,IAAI;IACf,mCAAU,CAAA;IACV,iCAAS,CAAA;AACV,CAAC,EAHW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAGf;AAYD;;;GAGG;AACH,MAAa,QAAQ;IA8CpB,YAAoB,IAAY,EAAE,MAAc;QAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAtCD;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAgB,EAAE,mBAAmB,GAAG,KAAK;QACnE,SAAS,mBAAmB,CAAC,IAAgB,EAAE,gBAA2C;YACzF,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;YACxC,MAAM,MAAM,GAAuC,IAAI,GAAG,EAAE,CAAC;YAE7D,gDAAgD;YAChD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC9B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;oBAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACjC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;wBACvB,MAAM,CAAC,GAAG,CACT,GAAiB,EACjB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAC5D,CAAC;qBACF;iBACD;aACD;YACD,MAAM,YAAY,GAAiB,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;YACtE,8BAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;YACrD,eAAM,CACL,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,EACjC,sDAAsD,UAAU,iBAAiB,UAAU,EAAE,CAC7F,CAAC;YACF,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YAC5D,OAAO,YAAY,CAAC,UAAU,CAAC;QAChC,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,EAAwB,CAAC;QAC5C,OAAO,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,eAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3G,CAAC;IAOD,uGAAuG;IAChG,iBAAiB;QACvB,OAAO,6CAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,EAAU;QAC9B,OAAO,6CAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,OAA0B;QAC/C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,gBAAgB;QACtB,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,QAAgC;QAC/C,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,KAAuB;QACzC,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,aAAgC,EAAE,KAAoB;QACxE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC/C,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IACxG,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,aAA4B;QAC9C,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC;QACrC,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;QACvC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpG,OAAO,EAAE,QAAQ,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,MAAc,EAAE,KAAc;QACjD,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IACrE,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;;OAEG;IACI,eAAe,CAAC,EAAU;QAChC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,EAAU;;QAC9B,aAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,0CAAE,WAAW,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,EAAU;QACtC,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,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,IAAY;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,eAAM,CAAC,UAAU,KAAK,SAAS,EAAE,uBAAuB,CAAC,CAAC;QAC1D,OAAO;YACN,MAAM,EAAE,UAAU,CAAC,QAAQ;YAC3B,KAAK,EAAE,UAAU,CAAC,WAAW;SAC7B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,IAAY;;QAClC,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,EAAE,CAAC;SACnC;aAAM;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,MAAM,KAAK,SAAS,EAAE;gBACzB,OAAO,MAAM,CAAC;aACd;SACD;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,WAAW,SAChB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,mCAAI,aAAI,CAAC,6CAA6C,CAAC,CAAC;QAClG,IAAI,UAAU,GAAG,CAAC,CAAmB,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5C,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC/C,IAAI,WAAW,KAAK,IAAI,EAAE;gBACzB,UAAU,GAAG,KAAK,CAAC;aACnB;SACD;QACD,OAAO,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAI,CAAC,sDAAsD,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,aAA4B;;QAC3C,aAAO,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,mCAAI,EAAE,CAAC;IACzF,CAAC;IAEO,cAAc,CAAC,IAAU,EAAE,aAA4B;QAC9D,OAAO,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAgB,CAAC,CAAC,CAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,MAAqB,CAAC;IACtG,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAkB;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;YAChC,OAAO,KAAK,CAAC;SACb;QAED,+EAA+E;QAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAEO,CAAC,sBAAsB,CAAC,MAAc;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,IAAI,CAAC;QACX,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE;YACzC,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE;gBAC5B,KAAK,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;aAC5C;SACD;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAkB;QAC9B,eAAM,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,kEAAkE,CAAC,CAAC;QACxG,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;CACD;AAtQD,4BAsQC;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 { getChangeNodeFromSnapshot } from './SnapshotUtilities';\nimport { Delta, Forest } from './Forest';\nimport { ChangeNode, NodeData, Payload, TraitLocation } from './generic';\n\n/**\n * An immutable view of a distributed tree node.\n * @public\n */\nexport interface SnapshotNode extends NodeData {\n\treadonly traits: ReadonlyMap<TraitLabel, readonly NodeId[]>;\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 `Snapshot` 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 SnapshotPlace {\n\treadonly sibling?: NodeId;\n\treadonly side: Side;\n\treadonly trait: TraitLocation;\n}\n\n/**\n * Defines a place relative to sibling.\n * The \"outside\" of a trait is the `undefined` sibling,\n * so After `undefined` is the beginning of the trait, and before `undefined` is the end.\n *\n * For this purpose, traits look like:\n *\n * `{undefined} - {Node 0} - {Node 1} - ... - {Node N} - {undefined}`\n *\n * Each `{value}` in the diagram is a possible sibling, which is either a Node or undefined.\n * Each `-` in the above diagram is a `Place`, and can be describe as being `After` a particular `{sibling}` or `Before` it.\n * This means that `After` `{undefined}` means the same `Place` as before the first node\n * and `Before` `{undefined}` means the `Place` after the last Node.\n *\n * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):\n * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the\n * two place description may no longer evaluate to the same place.\n * @public\n */\nexport enum Side {\n\tBefore = 0,\n\tAfter = 1,\n}\n\n/**\n * Specifies the range of nodes from `start` to `end` within a trait within a particular `Snapshot`.\n * Valid iff start and end are valid and are withing the same trait.\n * @public\n */\nexport interface SnapshotRange {\n\treadonly start: SnapshotPlace;\n\treadonly end: SnapshotPlace;\n}\n\n/**\n * An immutable view of a distributed tree.\n * @public\n */\nexport class Snapshot {\n\tpublic readonly root: NodeId;\n\tprivate readonly forest: Forest;\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 snapshots; initialized to empty each time a Snapshot is created.\n\t */\n\tprivate traitIndicesCache?: Map<NodeId, TraitNodeIndex>;\n\n\t/**\n\t * Constructs a Snapshot using the supplied tree.\n\t * @param root - the root of the tree to use as the contents of the `Snapshot`\n\t */\n\tpublic static fromTree(root: ChangeNode, expensiveValidation = false): Snapshot {\n\t\tfunction insertNodeRecursive(node: ChangeNode, newSnapshotNodes: Map<NodeId, SnapshotNode>): NodeId {\n\t\t\tconst { identifier, definition } = node;\n\t\t\tconst traits: Map<TraitLabel, readonly NodeId[]> = new Map();\n\n\t\t\t// eslint-disable-next-line no-restricted-syntax\n\t\t\tfor (const key in node.traits) {\n\t\t\t\tif (Object.prototype.hasOwnProperty.call(node.traits, key)) {\n\t\t\t\t\tconst element = node.traits[key];\n\t\t\t\t\tif (element.length > 0) {\n\t\t\t\t\t\ttraits.set(\n\t\t\t\t\t\t\tkey as TraitLabel,\n\t\t\t\t\t\t\telement.map((n) => insertNodeRecursive(n, newSnapshotNodes))\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst snapshotNode: SnapshotNode = { identifier, definition, traits };\n\t\t\tcopyPropertyIfDefined(node, snapshotNode, 'payload');\n\t\t\tassert(\n\t\t\t\t!newSnapshotNodes.has(identifier),\n\t\t\t\t`duplicate node in tree for snapshot: { identifier: ${identifier}, definition: ${definition}`\n\t\t\t);\n\t\t\tnewSnapshotNodes.set(snapshotNode.identifier, snapshotNode);\n\t\t\treturn snapshotNode.identifier;\n\t\t}\n\n\t\tconst map = new Map<NodeId, SnapshotNode>();\n\t\treturn new Snapshot(insertNodeRecursive(root, map), Forest.create(expensiveValidation).add(map.values()));\n\t}\n\n\tprivate constructor(root: NodeId, forest: Forest) {\n\t\tthis.root = root;\n\t\tthis.forest = forest;\n\t}\n\n\t/** Return a tree of JSON-compatible `ChangeNode`s representing the current state of this `Snapshot` */\n\tpublic getChangeNodeTree(): ChangeNode {\n\t\treturn getChangeNodeFromSnapshot(this, this.root);\n\t}\n\n\t/**\n\t * Returns the number of nodes in this `Snapshot`\n\t */\n\tpublic get size(): number {\n\t\treturn this.forest.size;\n\t}\n\n\t/**\n\t * @returns true iff the nodeId exists.\n\t */\n\tpublic hasNode(id: NodeId): boolean {\n\t\treturn this.forest.tryGet(id) !== undefined;\n\t}\n\n\t/**\n\t * @returns a `ChangeNode` derived from the `SnapshotNode` in this snapshot with the given `NodeId`.\n\t */\n\tpublic getChangeNode(id: NodeId): ChangeNode {\n\t\treturn getChangeNodeFromSnapshot(this, id);\n\t}\n\n\t/**\n\t * @returns the `ChangeNode`s derived from the `SnapshotNode`s in this snapshot with the given `NodeId`s.\n\t */\n\tpublic getChangeNodes(nodeIds: readonly NodeId[]): ChangeNode[] {\n\t\treturn nodeIds.map((id) => this.getChangeNode(id));\n\t}\n\n\t/**\n\t * Asserts the forest is in a consistent state.\n\t */\n\tpublic assertConsistent(): void {\n\t\tthis.forest.assertConsistent();\n\t}\n\n\t/**\n\t * Inserts all nodes in a NodeSequence into the forest.\n\t */\n\tpublic addNodes(sequence: Iterable<SnapshotNode>): Snapshot {\n\t\treturn new Snapshot(this.root, this.forest.add(sequence));\n\t}\n\n\t/**\n\t * Remove all nodes with the given ids from the forest\n\t */\n\tpublic deleteNodes(nodes: Iterable<NodeId>): Snapshot {\n\t\treturn new Snapshot(this.root, this.forest.delete(nodes, true));\n\t}\n\n\t/**\n\t * Parents a set of detached nodes at a specified place.\n\t * @param nodesToAttach - the nodes to parent in the specified place. The nodes must already be present in the Snapshot.\n\t * @param place - the location to insert the nodes.\n\t */\n\tpublic attachRange(nodesToAttach: readonly NodeId[], place: SnapshotPlace): Snapshot {\n\t\tconst { parent, label } = place.trait;\n\t\tconst index = this.findIndexWithinTrait(place);\n\t\treturn new Snapshot(this.root, this.forest.attachRangeOfChildren(parent, label, index, nodesToAttach));\n\t}\n\n\t/**\n\t * Detaches a range of nodes from their parent. The detached nodes remain in the Snapshot.\n\t * @param rangeToDetach - the range of nodes to detach\n\t */\n\tpublic detachRange(rangeToDetach: SnapshotRange): { snapshot: Snapshot; detached: readonly NodeId[] } {\n\t\tconst { start, end } = rangeToDetach;\n\t\tconst { trait: traitLocation } = start;\n\t\tconst { parent, label } = traitLocation;\n\t\tconst startIndex = this.findIndexWithinTrait(start);\n\t\tconst endIndex = this.findIndexWithinTrait(end);\n\t\tconst { forest, detached } = this.forest.detachRangeOfChildren(parent, label, startIndex, endIndex);\n\t\treturn { snapshot: new Snapshot(this.root, forest), detached };\n\t}\n\n\t/**\n\t * Sets a node's value. The node must exist in this `Snapshot`.\n\t * @param nodeId - the id of the node\n\t * @param value - the new value\n\t */\n\tpublic setNodeValue(nodeId: NodeId, value: Payload): Snapshot {\n\t\treturn new Snapshot(this.root, this.forest.setValue(nodeId, value));\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: SnapshotPlace): 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/**\n\t * Returns the node associated with `id` in this `Snapshot`.\n\t */\n\tpublic getSnapshotNode(id: NodeId): SnapshotNode {\n\t\treturn this.forest.get(id);\n\t}\n\n\t/**\n\t * Returns the label of the trait that a node is under. Returns undefined if the node is not present or if it is the root node.\n\t */\n\tpublic getTraitLabel(id: NodeId): TraitLabel | undefined {\n\t\treturn this.forest.tryGetParent(id)?.traitParent;\n\t}\n\n\t/**\n\t * Returns the parent of a node. Returns undefined if the node does not exist in the snapshot or if it does not have a parent.\n\t */\n\tpublic getParentSnapshotNode(id: NodeId): SnapshotNode | 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.getSnapshotNode(parentInfo.parentId);\n\t}\n\n\t/**\n\t * @param node - must have a parent.\n\t */\n\tpublic getTraitLocation(node: NodeId): TraitLocation {\n\t\tconst parentData = this.forest.getParent(node);\n\t\tassert(parentData !== undefined, 'node must have parent');\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 * @param node - must have a parent.\n\t * Performance note: this is O(siblings in trait).\n\t */\n\tpublic getIndexInTrait(node: NodeId): TraitNodeIndex {\n\t\tif (this.traitIndicesCache === undefined) {\n\t\t\tthis.traitIndicesCache = new Map();\n\t\t} else {\n\t\t\tconst cached = this.traitIndicesCache.get(node);\n\t\t\tif (cached !== undefined) {\n\t\t\t\treturn cached;\n\t\t\t}\n\t\t}\n\t\tconst parentData = this.forest.getParent(node);\n\t\tconst parent = this.forest.get(parentData.parentId);\n\t\tconst traitParent =\n\t\t\tparent.traits.get(parentData.traitParent) ?? fail('invalid parentData: trait parent not found.');\n\t\tlet foundIndex = -1 as TraitNodeIndex;\n\t\tfor (let i = 0; i < traitParent.length; i++) {\n\t\t\tconst nodeInTrait = traitParent[i];\n\t\t\tconst index = i as TraitNodeIndex;\n\t\t\tthis.traitIndicesCache.set(nodeInTrait, index);\n\t\t\tif (nodeInTrait === node) {\n\t\t\t\tfoundIndex = index;\n\t\t\t}\n\t\t}\n\t\treturn foundIndex !== -1 ? foundIndex : fail('invalidParentData: node not found in specified trait');\n\t}\n\n\t/**\n\t * Return a trait given its location\n\t * @param traitLocation - the location of the trait\n\t */\n\tpublic getTrait(traitLocation: TraitLocation): readonly NodeId[] {\n\t\treturn this.getSnapshotNode(traitLocation.parent).traits.get(traitLocation.label) ?? [];\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/** Compares this snapshot to another for equality. */\n\tpublic equals(snapshot: Snapshot): boolean {\n\t\tif (this.root !== snapshot.root) {\n\t\t\treturn false;\n\t\t}\n\n\t\t// TODO:#49100:Perf: make this faster and/or remove use by PrefetchingCheckout.\n\t\treturn this.forest.equals(snapshot.forest);\n\t}\n\n\tprivate *iterateNodeDescendants(nodeId: NodeId): IterableIterator<SnapshotNode> {\n\t\tconst node = this.getSnapshotNode(nodeId);\n\t\tyield node;\n\t\tfor (const trait of node.traits.values()) {\n\t\t\tfor (const childId of trait) {\n\t\t\t\tyield* this.iterateNodeDescendants(childId);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Calculate the difference between two `Snapshot`s\n\t * @param snapshot - the other snapshot to compare to this one\n\t * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `snapshot`.\n\t * The snapshots must share a root.\n\t */\n\tpublic delta(snapshot: Snapshot): Delta<NodeId> {\n\t\tassert(this.root === snapshot.root, 'Delta can only be calculated between snapshots that share a root');\n\t\treturn this.forest.delta(snapshot.forest);\n\t}\n\n\tpublic [Symbol.iterator](): IterableIterator<SnapshotNode> {\n\t\treturn this.iterateNodeDescendants(this.root);\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\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"]}

package/dist/SnapshotUtilities.d.ts

@@ -1,29 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { NodeId } from './Identifiers';
-import { ChangeNode } from './generic';
-import { Snapshot } from './Snapshot';
-/**
- * Converts a node in a snapshot to an equivalent `ChangeNode`.
- * @param snapshot - the snapshot in which the node exists
- * @param nodeId - the id of the node in the snapshot
- * @param lazyTraits - whether or not traits should be populated lazily.
- * If lazy, the subtrees under each trait will not be read until the trait is first accessed.
- */
-export declare function getChangeNodeFromSnapshot(snapshot: Snapshot, nodeId: NodeId, lazyTraits?: boolean): ChangeNode;
-/**
- * Compares finite numbers to form a strict partial ordering.
- *
- * Handles +/-0 like Map: -0 is equal to +0.
- *
- * Once https://github.com/qwertie/btree-typescript/pull/15 is merged, we can use the version of this function from it.
- */
-export declare function compareFiniteNumbers(a: number, b: number): number;
-/**
- * Compares strings lexically to form a strict partial ordering.
- * Once https://github.com/qwertie/btree-typescript/pull/15 is merged, we can use the version of this function from it.
- */
-export declare function compareStrings(a: string, b: string): number;
-//# sourceMappingURL=SnapshotUtilities.d.ts.map

package/dist/SnapshotUtilities.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SnapshotUtilities.d.ts","sourceRoot":"","sources":["../src/SnapshotUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAc,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,UAAU,EAAY,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,UAAU,CAqB5G;AAgCD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAE3D"}

package/dist/SnapshotUtilities.js

@@ -1,73 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareStrings = exports.compareFiniteNumbers = exports.getChangeNodeFromSnapshot = void 0;
-const Common_1 = require("./Common");
-/**
- * Converts a node in a snapshot to an equivalent `ChangeNode`.
- * @param snapshot - the snapshot in which the node exists
- * @param nodeId - the id of the node in the snapshot
- * @param lazyTraits - whether or not traits should be populated lazily.
- * If lazy, the subtrees under each trait will not be read until the trait is first accessed.
- */
-function getChangeNodeFromSnapshot(snapshot, nodeId, lazyTraits = false) {
-    const node = snapshot.getSnapshotNode(nodeId);
-    const nodeData = {
-        definition: node.definition,
-        identifier: node.identifier,
-    };
-    Common_1.copyPropertyIfDefined(node, nodeData, 'payload');
-    if (lazyTraits) {
-        return Object.assign(Object.assign({}, nodeData), { get traits() {
-                return Common_1.memoizeGetter(this, 'traits', makeTraits(snapshot, node.traits, lazyTraits));
-            } });
-    }
-    return Object.assign(Object.assign({}, nodeData), { traits: makeTraits(snapshot, node.traits, lazyTraits) });
-}
-exports.getChangeNodeFromSnapshot = getChangeNodeFromSnapshot;
-/** Given the traits of a SnapshotNode, return the corresponding traits on a Node */
-function makeTraits(snapshot, traits, lazyTraits = false) {
-    const traitMap = {};
-    for (const [label, trait] of traits.entries()) {
-        if (lazyTraits) {
-            Object.defineProperty(traitMap, label, {
-                get() {
-                    const treeNodeTrait = trait.map((nodeId) => getChangeNodeFromSnapshot(snapshot, nodeId, lazyTraits));
-                    return Common_1.memoizeGetter(this, label, treeNodeTrait);
-                },
-                configurable: true,
-                enumerable: true,
-            });
-        }
-        else {
-            Object.defineProperty(traitMap, label, {
-                value: trait.map((nodeId) => getChangeNodeFromSnapshot(snapshot, nodeId, lazyTraits)),
-                enumerable: true,
-            });
-        }
-    }
-    return traitMap;
-}
-/**
- * Compares finite numbers to form a strict partial ordering.
- *
- * Handles +/-0 like Map: -0 is equal to +0.
- *
- * Once https://github.com/qwertie/btree-typescript/pull/15 is merged, we can use the version of this function from it.
- */
-function compareFiniteNumbers(a, b) {
-    return a - b;
-}
-exports.compareFiniteNumbers = compareFiniteNumbers;
-/**
- * Compares strings lexically to form a strict partial ordering.
- * Once https://github.com/qwertie/btree-typescript/pull/15 is merged, we can use the version of this function from it.
- */
-function compareStrings(a, b) {
-    return a > b ? 1 : a === b ? 0 : -1;
-}
-exports.compareStrings = compareStrings;
-//# sourceMappingURL=SnapshotUtilities.js.map