@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/chunked-forest/uniformChunk.d.ts

@@ -0,0 +1,186 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FieldKey, TreeNodeSchemaIdentifier, CursorLocationType, FieldUpPath, UpPath, TreeValue, Value, PathRootPrefix } from "../../core";
+import { ReferenceCountedBase } from "../../util";
+import { SynchronousCursor } from "../treeCursorUtils";
+import { ChunkedCursor, cursorChunk, TreeChunk } from "./chunk";
+/**
+ * Create a tree chunk with ref count 1.
+ *
+ * @param shape - describes the semantics and layout of `values`.
+ * @param values - provides exclusive ownership of this array to this object (which might mutate it in the future).
+ */
+export declare function uniformChunk(shape: ChunkShape, values: TreeValue[]): TreeChunk;
+/**
+ * Chunk which handles a sequence of trees with identical "shape" (see `TreeShape`).
+ *
+ * Separates shape from content,
+ * allowing deduplication of shape information and storing of content as a flat sequence of values.
+ */
+export declare class UniformChunk extends ReferenceCountedBase implements TreeChunk {
+    shape: ChunkShape;
+    values: TreeValue[];
+    /**
+     * Create a tree chunk with ref count 1.
+     *
+     * @param shape - describes the semantics and layout of `values`.
+     * @param values - provides exclusive ownership of this array to this object (which might mutate it in the future).
+     */
+    constructor(shape: ChunkShape, values: TreeValue[]);
+    get topLevelLength(): number;
+    clone(): UniformChunk;
+    cursor(): Cursor;
+    protected dispose(): void;
+}
+/**
+ * The "shape" of a field.
+ *
+ * Requires that all trees in the field have the same shape, which is described by `TreeShape`.
+ * Note that this requirement means that not all fields can be described using this type.
+ */
+export type FieldShape = readonly [FieldKey, TreeShape, number];
+/**
+ * The "shape" of a tree.
+ * Does not contain the actual values from  the tree, but describes everything else,
+ * including where the values would be found in a flat values array.
+ *
+ * Note that since this requires fields to have uniform shapes (see `FieldShape`),
+ * not all trees can have their shape described using this type.
+ */
+export declare class TreeShape {
+    readonly type: TreeNodeSchemaIdentifier;
+    readonly hasValue: boolean;
+    readonly fieldsArray: readonly FieldShape[];
+    readonly fields: ReadonlyMap<FieldKey, OffsetShape>;
+    readonly fieldsOffsetArray: readonly OffsetShape[];
+    readonly valuesPerTopLevelNode: number;
+    readonly positions: readonly NodePositionInfo[];
+    constructor(type: TreeNodeSchemaIdentifier, hasValue: boolean, fieldsArray: readonly FieldShape[]);
+    equals(other: TreeShape): boolean;
+    withTopLevelLength(topLevelLength: number): ChunkShape;
+}
+/**
+ * The shape (see `TreeShape`) of a sequence of trees, all with the same shape (like `FieldShape`, but without a field key).
+ *
+ * This shape is optimized (by caching derived data like the positions array),
+ * so that when paired with a value array it can be efficiently traversed like a tree by an {@link ITreeCursorSynchronous}.
+ * See {@link uniformChunk} for how to do this.
+ *
+ * TODO: consider storing shape information in WASM
+ */
+export declare class ChunkShape {
+    readonly treeShape: TreeShape;
+    readonly topLevelLength: number;
+    readonly positions: readonly (NodePositionInfo | undefined)[];
+    constructor(treeShape: TreeShape, topLevelLength: number);
+    equals(other: ChunkShape): boolean;
+}
+/**
+ * Shape of a field (like `FieldShape`) but with information about how it would be offset within a chunk because of its parents.
+ */
+declare class OffsetShape {
+    readonly shape: TreeShape;
+    readonly topLevelLength: number;
+    readonly offset: number;
+    readonly key: FieldKey;
+    readonly indexOfParentField: number | undefined;
+    /**
+     * @param shape - the shape of each child in this field
+     * @param topLevelLength - number of top level nodes in this sequence chunk (either field within a chunk, or top level chunk)
+     * @param offset - number of nodes before this in the parent's subtree
+     * @param key - field key
+     * @param indexOfParentField - index of node with this shape
+     */
+    constructor(shape: TreeShape, topLevelLength: number, offset: number, key: FieldKey, indexOfParentField: number | undefined);
+}
+/**
+ * Information about a node at a specific position within a uniform chunk.
+ */
+declare class NodePositionInfo implements UpPath {
+    readonly parent: NodePositionInfo | undefined;
+    readonly parentField: FieldKey;
+    readonly parentIndex: number;
+    readonly indexOfParentField: number | undefined;
+    readonly indexOfParentPosition: number | undefined;
+    readonly shape: TreeShape;
+    readonly topLevelLength: number;
+    readonly valueOffset: number;
+    /**
+     * @param parent - TODO
+     * @param parentField - TODO
+     * @param parentIndex - indexWithinParentField
+     * @param indexOfParentField - which field of the parent `parentIndex` is indexing into to locate this.
+     * @param indexOfParentPosition - Index of parent NodePositionInfo in positions array. TODO: use offsets to avoid copying at top level?
+     * @param shape - Shape of the top level sequence this node is part of
+     * @param valueOffset - TODO
+     */
+    constructor(parent: NodePositionInfo | undefined, // TODO; general UpPath to allow prefixing here?
+    parentField: FieldKey, parentIndex: number, indexOfParentField: number | undefined, indexOfParentPosition: number | undefined, shape: TreeShape, // Shape of sequence that contains this node (top level is parent of this node)
+    topLevelLength: number, valueOffset: number);
+}
+/**
+ * The cursor implementation for `UniformChunk`.
+ *
+ * Works by tracking its location in the chunk's `positions` array.
+ */
+declare class Cursor extends SynchronousCursor implements ChunkedCursor {
+    private readonly chunk;
+    private positionIndex;
+    private nodePositionInfo;
+    private readonly shape;
+    private readonly positions;
+    mode: CursorLocationType;
+    private fieldKey?;
+    private indexOfField;
+    constructor(chunk: UniformChunk);
+    get [cursorChunk](): UniformChunk | undefined;
+    atChunkRoot(): boolean;
+    fork(): Cursor;
+    /**
+     * Change the current node within the chunk.
+     * See `nodeInfo` for getting data about the current node.
+     *
+     * @param positionIndex - index of the position of the newly selected node in `positions`.
+     * This is NOT an index within a field, and is not bounds checked.
+     */
+    private moveToPosition;
+    /**
+     * Gets information about the current node.
+     *
+     * When in Nodes mode, this means the node this cursor is current at.
+     * When if fields mode, this means the node which is the parent of the current field.
+     * This cursor is in Nodes mode at the root, so there is no case where a fields mode does not have a parent.
+     *
+     * @param requiredMode - asserts that the mode matches this. Since the semantics of this function are somewhat mode dependent,
+     * providing this ensures that the caller knows what the results will mean.
+     */
+    private nodeInfo;
+    nextField(): boolean;
+    exitField(): void;
+    getFieldKey(): FieldKey;
+    getFieldLength(): number;
+    firstNode(): boolean;
+    enterNode(childIndex: number): void;
+    /**
+     * Enter the current field, at `childIndex`.
+     * @param childIndex - index into current field to navigate to. Must be non-negative integer.
+     */
+    private enterNodeInner;
+    private enterRootNodeInner;
+    getFieldPath(prefix?: PathRootPrefix): FieldUpPath;
+    getPath(prefix?: PathRootPrefix): UpPath | undefined;
+    get fieldIndex(): number;
+    readonly chunkStart: number;
+    get chunkLength(): number;
+    seekNodes(offset: number): boolean;
+    nextNode(): boolean;
+    exitNode(): void;
+    firstField(): boolean;
+    enterField(key: FieldKey): void;
+    get type(): TreeNodeSchemaIdentifier;
+    get value(): Value;
+}
+export {};
+//# sourceMappingURL=uniformChunk.d.ts.map

package/dist/feature-libraries/chunked-forest/uniformChunk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniformChunk.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/chunked-forest/uniformChunk.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,QAAQ,EACR,wBAAwB,EACxB,kBAAkB,EAClB,WAAW,EACX,MAAM,EACN,SAAS,EACT,KAAK,EACL,cAAc,EACd,MAAM,YAAY,CAAC;AACpB,OAAO,EAAQ,oBAAoB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAA+B,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,WAAW,EAAa,SAAS,EAAE,MAAM,SAAS,CAAC;AAE3E;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,CAE9E;AAED;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,oBAAqB,YAAW,SAAS;IAQlE,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,SAAS,EAAE;IAR3B;;;;;OAKG;gBAEK,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,SAAS,EAAE;IAS3B,IAAW,cAAc,IAAI,MAAM,CAElC;IAEM,KAAK,IAAI,YAAY;IAIrB,MAAM,IAAI,MAAM;IAIvB,SAAS,CAAC,OAAO,IAAI,IAAI;CACzB;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,qBAAa,SAAS;aASJ,IAAI,EAAE,wBAAwB;aAC9B,QAAQ,EAAE,OAAO;aACjB,WAAW,EAAE,SAAS,UAAU,EAAE;IAVnD,SAAgB,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC3D,SAAgB,iBAAiB,EAAE,SAAS,WAAW,EAAE,CAAC;IAC1D,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAG9C,SAAgB,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAC;gBAGtC,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,UAAU,EAAE;IAuB5C,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAejC,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,UAAU;CAG7D;AAgCD;;;;;;;;GAQG;AACH,qBAAa,UAAU;aAIL,SAAS,EAAE,SAAS;aACpB,cAAc,EAAE,MAAM;IAJvC,SAAgB,SAAS,EAAE,SAAS,CAAC,gBAAgB,GAAG,SAAS,CAAC,EAAE,CAAC;gBAGpD,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,MAAM;IAUhC,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;CAIzC;AAED;;GAEG;AACH,cAAM,WAAW;aASC,KAAK,EAAE,SAAS;aAChB,cAAc,EAAE,MAAM;aACtB,MAAM,EAAE,MAAM;aACd,GAAG,EAAE,QAAQ;aACb,kBAAkB,EAAE,MAAM,GAAG,SAAS;IAZvD;;;;;;OAMG;gBAEc,KAAK,EAAE,SAAS,EAChB,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,QAAQ,EACb,kBAAkB,EAAE,MAAM,GAAG,SAAS;CAEvD;AAED;;GAEG;AACH,cAAM,gBAAiB,YAAW,MAAM;aAWtB,MAAM,EAAE,gBAAgB,GAAG,SAAS;aACpC,WAAW,EAAE,QAAQ;aACrB,WAAW,EAAE,MAAM;aACnB,kBAAkB,EAAE,MAAM,GAAG,SAAS;aACtC,qBAAqB,EAAE,MAAM,GAAG,SAAS;aACzC,KAAK,EAAE,SAAS;aAChB,cAAc,EAAE,MAAM;aACtB,WAAW,EAAE,MAAM;IAjBpC;;;;;;;;OAQG;gBAEc,MAAM,EAAE,gBAAgB,GAAG,SAAS,EAAE,gDAAgD;IACtF,WAAW,EAAE,QAAQ,EACrB,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,GAAG,SAAS,EACtC,qBAAqB,EAAE,MAAM,GAAG,SAAS,EACzC,KAAK,EAAE,SAAS,EAAE,+EAA+E;IACjG,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM;CAEpC;AAED;;;;GAIG;AACH,cAAM,MAAO,SAAQ,iBAAkB,YAAW,aAAa;IAmB3C,OAAO,CAAC,QAAQ,CAAC,KAAK;IAlBzC,OAAO,CAAC,aAAa,CAAU;IAE/B,OAAO,CAAC,gBAAgB,CAA+B;IAGvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4C;IAE/D,IAAI,EAAE,kBAAkB,CAA6B;IAG5D,OAAO,CAAC,QAAQ,CAAC,CAAW;IAI5B,OAAO,CAAC,YAAY,CAAa;gBAGG,KAAK,EAAE,YAAY;IAQvD,IAAW,CAAC,WAAW,CAAC,IAAI,YAAY,GAAG,SAAS,CAEnD;IAEM,WAAW,IAAI,OAAO;IAWtB,IAAI,IAAI,MAAM;IASrB;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAYtB;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ;IAST,SAAS,IAAI,OAAO;IAWpB,SAAS,IAAI,IAAI;IAOjB,WAAW,IAAI,QAAQ;IAIvB,cAAc,IAAI,MAAM;IAexB,SAAS,IAAI,OAAO;IAepB,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAkB1C;;;OAGG;IACH,OAAO,CAAC,cAAc;IAiBtB,OAAO,CAAC,kBAAkB;IAQnB,YAAY,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,WAAW;IAOlD,OAAO,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS;IAI3D,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,SAAgB,UAAU,EAAE,MAAM,CAAK;IAEvC,IAAW,WAAW,IAAI,MAAM,CAE/B;IAEM,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAWlC,QAAQ,IAAI,OAAO;IAanB,QAAQ,IAAI,IAAI;IAWhB,UAAU,IAAI,OAAO;IAWrB,UAAU,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI;IAWtC,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED,IAAW,KAAK,IAAI,KAAK,CAGxB;CACD"}

package/dist/feature-libraries/chunked-forest/uniformChunk.js

@@ -0,0 +1,397 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChunkShape = exports.TreeShape = exports.UniformChunk = exports.uniformChunk = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const util_1 = require("../../util");
+const treeCursorUtils_1 = require("../treeCursorUtils");
+const chunk_1 = require("./chunk");
+/**
+ * Create a tree chunk with ref count 1.
+ *
+ * @param shape - describes the semantics and layout of `values`.
+ * @param values - provides exclusive ownership of this array to this object (which might mutate it in the future).
+ */
+function uniformChunk(shape, values) {
+    return new UniformChunk(shape, values);
+}
+exports.uniformChunk = uniformChunk;
+/**
+ * Chunk which handles a sequence of trees with identical "shape" (see `TreeShape`).
+ *
+ * Separates shape from content,
+ * allowing deduplication of shape information and storing of content as a flat sequence of values.
+ */
+class UniformChunk extends util_1.ReferenceCountedBase {
+    /**
+     * Create a tree chunk with ref count 1.
+     *
+     * @param shape - describes the semantics and layout of `values`.
+     * @param values - provides exclusive ownership of this array to this object (which might mutate it in the future).
+     */
+    constructor(shape, values) {
+        super();
+        this.shape = shape;
+        this.values = values;
+        (0, core_utils_1.assert)(shape.treeShape.valuesPerTopLevelNode * shape.topLevelLength === values.length, 0x4c3 /* invalid number of values for shape */);
+    }
+    get topLevelLength() {
+        return this.shape.topLevelLength;
+    }
+    clone() {
+        return new UniformChunk(this.shape, this.values.slice());
+    }
+    cursor() {
+        return new Cursor(this);
+    }
+    dispose() { }
+}
+exports.UniformChunk = UniformChunk;
+/**
+ * The "shape" of a tree.
+ * Does not contain the actual values from  the tree, but describes everything else,
+ * including where the values would be found in a flat values array.
+ *
+ * Note that since this requires fields to have uniform shapes (see `FieldShape`),
+ * not all trees can have their shape described using this type.
+ */
+class TreeShape {
+    constructor(type, hasValue, fieldsArray) {
+        this.type = type;
+        this.hasValue = hasValue;
+        this.fieldsArray = fieldsArray;
+        const fields = new Map();
+        let numberOfValues = hasValue ? 1 : 0;
+        const infos = [
+            new NodePositionInfo(undefined, chunk_1.dummyRoot, 0, undefined, undefined, this, 1, 0),
+        ];
+        let fieldIndex = 0;
+        for (const [k, f, length] of fieldsArray) {
+            (0, core_utils_1.assert)(!fields.has(k), 0x4c5 /* no duplicate keys */);
+            const offset = new OffsetShape(f, length, infos.length, k, fieldIndex);
+            fields.set(k, offset);
+            clonePositions(0, [k, f, length], fieldIndex, numberOfValues, infos);
+            numberOfValues += f.valuesPerTopLevelNode * length;
+            fieldIndex++;
+        }
+        this.fields = fields;
+        this.valuesPerTopLevelNode = numberOfValues;
+        this.positions = infos;
+        this.fieldsOffsetArray = [...fields.values()];
+    }
+    equals(other) {
+        // TODO: either dedup instances and/or store a collision resistant hash for fast compare.
+        if (!(0, core_utils_1.compareArrays)(this.fieldsArray, other.fieldsArray, ([k, f, l], [k2, f2, l2]) => k === k2 && l === l2 && f.equals(f2))) {
+            return false;
+        }
+        return this.type === other.type && this.hasValue === other.hasValue;
+    }
+    withTopLevelLength(topLevelLength) {
+        return new ChunkShape(this, topLevelLength);
+    }
+}
+exports.TreeShape = TreeShape;
+function clonePositions(indexOfParentInOutput, [key, shape, copies], indexOfParentField, valueOffset, outputInto) {
+    const offset = outputInto.length;
+    for (let index = 0; index < copies; index++) {
+        for (const inner of shape.positions) {
+            const wasRoot = inner.indexOfParentPosition === undefined;
+            const parentPositionIndex = wasRoot
+                ? indexOfParentInOutput
+                : inner.indexOfParentPosition + index * shape.positions.length + offset;
+            outputInto.push(new NodePositionInfo(parentPositionIndex === undefined ? undefined : outputInto[parentPositionIndex], inner.parentField === chunk_1.dummyRoot ? key : inner.parentField, wasRoot ? index : inner.parentIndex, inner.indexOfParentField ?? indexOfParentField, parentPositionIndex, inner.shape, wasRoot ? copies : inner.topLevelLength, inner.valueOffset + valueOffset + shape.valuesPerTopLevelNode * index));
+        }
+    }
+}
+/**
+ * The shape (see `TreeShape`) of a sequence of trees, all with the same shape (like `FieldShape`, but without a field key).
+ *
+ * This shape is optimized (by caching derived data like the positions array),
+ * so that when paired with a value array it can be efficiently traversed like a tree by an {@link ITreeCursorSynchronous}.
+ * See {@link uniformChunk} for how to do this.
+ *
+ * TODO: consider storing shape information in WASM
+ */
+class ChunkShape {
+    constructor(treeShape, topLevelLength) {
+        this.treeShape = treeShape;
+        this.topLevelLength = topLevelLength;
+        (0, core_utils_1.assert)(topLevelLength > 0, 0x4c6 /* topLevelLength must be greater than 0 */);
+        // TODO: avoid duplication from inner loop
+        const positions = [undefined];
+        clonePositions(0, [chunk_1.dummyRoot, treeShape, topLevelLength], 0, 0, positions);
+        this.positions = positions;
+    }
+    equals(other) {
+        // TODO: either dedup instances and/or store a collision resistant hash for fast compare.
+        return this.topLevelLength === other.topLevelLength && this.treeShape === other.treeShape;
+    }
+}
+exports.ChunkShape = ChunkShape;
+/**
+ * Shape of a field (like `FieldShape`) but with information about how it would be offset within a chunk because of its parents.
+ */
+class OffsetShape {
+    /**
+     * @param shape - the shape of each child in this field
+     * @param topLevelLength - number of top level nodes in this sequence chunk (either field within a chunk, or top level chunk)
+     * @param offset - number of nodes before this in the parent's subtree
+     * @param key - field key
+     * @param indexOfParentField - index of node with this shape
+     */
+    constructor(shape, topLevelLength, offset, key, indexOfParentField) {
+        this.shape = shape;
+        this.topLevelLength = topLevelLength;
+        this.offset = offset;
+        this.key = key;
+        this.indexOfParentField = indexOfParentField;
+    }
+}
+/**
+ * Information about a node at a specific position within a uniform chunk.
+ */
+class NodePositionInfo {
+    /**
+     * @param parent - TODO
+     * @param parentField - TODO
+     * @param parentIndex - indexWithinParentField
+     * @param indexOfParentField - which field of the parent `parentIndex` is indexing into to locate this.
+     * @param indexOfParentPosition - Index of parent NodePositionInfo in positions array. TODO: use offsets to avoid copying at top level?
+     * @param shape - Shape of the top level sequence this node is part of
+     * @param valueOffset - TODO
+     */
+    constructor(parent, // TODO; general UpPath to allow prefixing here?
+    parentField, parentIndex, indexOfParentField, indexOfParentPosition, shape, // Shape of sequence that contains this node (top level is parent of this node)
+    topLevelLength, valueOffset) {
+        this.parent = parent;
+        this.parentField = parentField;
+        this.parentIndex = parentIndex;
+        this.indexOfParentField = indexOfParentField;
+        this.indexOfParentPosition = indexOfParentPosition;
+        this.shape = shape;
+        this.topLevelLength = topLevelLength;
+        this.valueOffset = valueOffset;
+    }
+}
+/**
+ * The cursor implementation for `UniformChunk`.
+ *
+ * Works by tracking its location in the chunk's `positions` array.
+ */
+class Cursor extends treeCursorUtils_1.SynchronousCursor {
+    // TODO: support prefix (path above root, including index offset of chunk in its containing field)
+    constructor(chunk) {
+        super();
+        this.chunk = chunk;
+        this.mode = 1 /* CursorLocationType.Fields */;
+        // Valid only in fields mode. Can be past end for empty fields.
+        // This is redundant with fieldKey above (but might be worth keeping for perf), and could be removed.
+        this.indexOfField = 0;
+        this.chunkStart = 0;
+        this.shape = this.chunk.shape;
+        this.positions = this.shape.positions;
+        this.fieldKey = chunk_1.dummyRoot;
+        this.moveToPosition(0);
+    }
+    get [chunk_1.cursorChunk]() {
+        return this.atChunkRoot() ? this.chunk : undefined;
+    }
+    atChunkRoot() {
+        (0, core_utils_1.assert)((this.fieldKey === undefined) === (this.mode === 0 /* CursorLocationType.Nodes */), 0x560 /* expect valid field key */);
+        return (this.nodePositionInfo === undefined ||
+            (this.nodePositionInfo.parent === undefined && this.fieldKey === undefined));
+    }
+    fork() {
+        const cursor = new Cursor(this.chunk);
+        cursor.mode = this.mode;
+        cursor.fieldKey = this.fieldKey;
+        cursor.indexOfField = this.indexOfField;
+        cursor.moveToPosition(this.positionIndex);
+        return cursor;
+    }
+    /**
+     * Change the current node within the chunk.
+     * See `nodeInfo` for getting data about the current node.
+     *
+     * @param positionIndex - index of the position of the newly selected node in `positions`.
+     * This is NOT an index within a field, and is not bounds checked.
+     */
+    moveToPosition(positionIndex) {
+        this.nodePositionInfo = this.positions[positionIndex];
+        this.positionIndex = positionIndex;
+        if (this.nodePositionInfo === undefined) {
+            (0, core_utils_1.assert)(positionIndex === 0, 0x561 /* expected root at start */);
+            (0, core_utils_1.assert)(this.mode === 1 /* CursorLocationType.Fields */, 0x562 /* expected root to be a field */);
+        }
+    }
+    /**
+     * Gets information about the current node.
+     *
+     * When in Nodes mode, this means the node this cursor is current at.
+     * When if fields mode, this means the node which is the parent of the current field.
+     * This cursor is in Nodes mode at the root, so there is no case where a fields mode does not have a parent.
+     *
+     * @param requiredMode - asserts that the mode matches this. Since the semantics of this function are somewhat mode dependent,
+     * providing this ensures that the caller knows what the results will mean.
+     */
+    nodeInfo(requiredMode) {
+        (0, core_utils_1.assert)(this.mode === requiredMode, 0x4c8 /* tried to access cursor when in wrong mode */);
+        (0, core_utils_1.assert)(this.nodePositionInfo !== undefined, 0x53e /* can not access nodeInfo in root field */);
+        return this.nodePositionInfo;
+    }
+    nextField() {
+        this.indexOfField++;
+        const fields = this.nodeInfo(1 /* CursorLocationType.Fields */).shape.fieldsArray;
+        if (this.indexOfField < fields.length) {
+            this.fieldKey = fields[this.indexOfField][0];
+            return true;
+        }
+        this.exitField();
+        return false;
+    }
+    exitField() {
+        (0, core_utils_1.assert)(this.mode === 1 /* CursorLocationType.Fields */, 0x4c9 /* exitField when in wrong mode */);
+        (0, core_utils_1.assert)(this.nodePositionInfo !== undefined, 0x563 /* can not exit root field */);
+        this.fieldKey = undefined;
+        this.mode = 0 /* CursorLocationType.Nodes */;
+    }
+    getFieldKey() {
+        return this.fieldKey ?? (0, util_1.fail)("not in a field");
+    }
+    getFieldLength() {
+        (0, core_utils_1.assert)(this.mode === 1 /* CursorLocationType.Fields */, 0x53f /* tried to access cursor when in wrong mode */);
+        if (this.nodePositionInfo === undefined) {
+            return this.shape.topLevelLength;
+        }
+        const fieldInfo = this.nodePositionInfo.shape.fieldsArray[this.indexOfField];
+        if (fieldInfo === undefined) {
+            return 0;
+        }
+        return fieldInfo[2];
+    }
+    firstNode() {
+        (0, core_utils_1.assert)(this.mode === 1 /* CursorLocationType.Fields */, 0x540 /* tried to access cursor when in wrong mode */);
+        if (this.nodePositionInfo === undefined) {
+            // Root field is not allowed to be empty, so we can skip handling that case.
+            this.enterRootNodeInner(0);
+            return true;
+        }
+        else {
+            return this.enterNodeInner(this.nodePositionInfo, 0);
+        }
+    }
+    enterNode(childIndex) {
+        (0, core_utils_1.assert)(this.mode === 1 /* CursorLocationType.Fields */, 0x541 /* tried to access cursor when in wrong mode */);
+        (0, core_utils_1.assert)(childIndex >= 0, 0x4ca /* index must be positive */);
+        if (this.nodePositionInfo === undefined) {
+            (0, core_utils_1.assert)(childIndex < this.shape.topLevelLength, 0x542 /* index must not be past the end of the field */);
+            this.enterRootNodeInner(childIndex);
+        }
+        else {
+            const moved = this.enterNodeInner(this.nodePositionInfo, childIndex);
+            (0, core_utils_1.assert)(moved, 0x4cb /* index must not be past the end of the field */);
+        }
+    }
+    /**
+     * Enter the current field, at `childIndex`.
+     * @param childIndex - index into current field to navigate to. Must be non-negative integer.
+     */
+    enterNodeInner(currentPosition, childIndex) {
+        const shape = currentPosition.shape;
+        const fields = shape.fieldsOffsetArray;
+        if (this.indexOfField >= fields.length) {
+            return false; // Handle empty field (indexed by key into empty field)
+        }
+        const f = shape.fieldsOffsetArray[this.indexOfField];
+        if (childIndex >= f.topLevelLength) {
+            return false;
+        }
+        this.mode = 0 /* CursorLocationType.Nodes */;
+        this.fieldKey = undefined;
+        this.moveToPosition(this.positionIndex + f.offset + childIndex * f.shape.positions.length);
+        (0, core_utils_1.assert)(this.fieldIndex === childIndex, 0x4cc /* should be at selected child */);
+        return true;
+    }
+    enterRootNodeInner(childIndex) {
+        this.mode = 0 /* CursorLocationType.Nodes */;
+        this.fieldKey = undefined;
+        // 1 for the "undefined" at the beginning of the positions array, then stride by top level tree shape.
+        this.moveToPosition(1 + childIndex * this.shape.treeShape.positions.length);
+        (0, core_utils_1.assert)(this.fieldIndex === childIndex, 0x543 /* should be at selected child */);
+    }
+    getFieldPath(prefix) {
+        return (0, treeCursorUtils_1.prefixFieldPath)(prefix, {
+            field: this.getFieldKey(),
+            parent: this.nodePositionInfo,
+        });
+    }
+    getPath(prefix) {
+        return (0, treeCursorUtils_1.prefixPath)(prefix, this.nodeInfo(0 /* CursorLocationType.Nodes */));
+    }
+    get fieldIndex() {
+        return this.nodeInfo(0 /* CursorLocationType.Nodes */).parentIndex;
+    }
+    get chunkLength() {
+        return this.nodeInfo(0 /* CursorLocationType.Nodes */).topLevelLength;
+    }
+    seekNodes(offset) {
+        const info = this.nodeInfo(0 /* CursorLocationType.Nodes */);
+        const index = offset + info.parentIndex;
+        if (index >= 0 && index < info.topLevelLength) {
+            this.moveToPosition(this.positionIndex + offset * info.shape.positions.length);
+            return true;
+        }
+        this.exitNode();
+        return false;
+    }
+    nextNode() {
+        // This is the same as `return this.seekNodes(1);` but slightly faster.
+        const info = this.nodeInfo(0 /* CursorLocationType.Nodes */);
+        const index = info.parentIndex + 1;
+        if (index === info.topLevelLength) {
+            this.exitNode();
+            return false;
+        }
+        this.moveToPosition(this.positionIndex + info.shape.positions.length);
+        return true;
+    }
+    exitNode() {
+        const info = this.nodeInfo(0 /* CursorLocationType.Nodes */);
+        this.indexOfField =
+            info.indexOfParentField ?? (0, util_1.fail)("navigation up to root field not yet supported"); // TODO;
+        this.fieldKey = info.parentField;
+        this.mode = 1 /* CursorLocationType.Fields */;
+        this.moveToPosition(info.indexOfParentPosition ?? (0, util_1.fail)("navigation up to root field not yet supported")); // TODO
+    }
+    firstField() {
+        const fieldsArray = this.nodeInfo(0 /* CursorLocationType.Nodes */).shape.fieldsArray;
+        if (fieldsArray.length === 0) {
+            return false;
+        }
+        this.indexOfField = 0;
+        this.mode = 1 /* CursorLocationType.Fields */;
+        this.fieldKey = fieldsArray[0][0];
+        return true;
+    }
+    enterField(key) {
+        const fieldMap = this.nodeInfo(0 /* CursorLocationType.Nodes */).shape.fields;
+        const fieldInfo = fieldMap.get(key);
+        this.indexOfField =
+            fieldInfo === undefined
+                ? fieldMap.size
+                : fieldInfo.indexOfParentField ?? (0, util_1.fail)("children should have parents");
+        this.fieldKey = key;
+        this.mode = 1 /* CursorLocationType.Fields */;
+    }
+    get type() {
+        return this.nodeInfo(0 /* CursorLocationType.Nodes */).shape.type;
+    }
+    get value() {
+        const info = this.nodeInfo(0 /* CursorLocationType.Nodes */);
+        return info.shape.hasValue ? this.chunk.values[info.valueOffset] : undefined;
+    }
+}
+//# sourceMappingURL=uniformChunk.js.map

package/dist/feature-libraries/chunked-forest/uniformChunk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniformChunk.js","sourceRoot":"","sources":["../../../src/feature-libraries/chunked-forest/uniformChunk.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAmE;AAWnE,qCAAwD;AACxD,wDAAoF;AACpF,mCAA2E;AAE3E;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,KAAiB,EAAE,MAAmB;IAClE,OAAO,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAFD,oCAEC;AAED;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,2BAAoB;IACrD;;;;;OAKG;IACH,YACQ,KAAiB,EACjB,MAAmB;QAE1B,KAAK,EAAE,CAAC;QAHD,UAAK,GAAL,KAAK,CAAY;QACjB,WAAM,GAAN,MAAM,CAAa;QAG1B,IAAA,mBAAM,EACL,KAAK,CAAC,SAAS,CAAC,qBAAqB,GAAG,KAAK,CAAC,cAAc,KAAK,MAAM,CAAC,MAAM,EAC9E,KAAK,CAAC,wCAAwC,CAC9C,CAAC;IACH,CAAC;IAED,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;IAClC,CAAC;IAEM,KAAK;QACX,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEM,MAAM;QACZ,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAES,OAAO,KAAU,CAAC;CAC5B;AA/BD,oCA+BC;AAUD;;;;;;;GAOG;AACH,MAAa,SAAS;IAQrB,YACiB,IAA8B,EAC9B,QAAiB,EACjB,WAAkC;QAFlC,SAAI,GAAJ,IAAI,CAA0B;QAC9B,aAAQ,GAAR,QAAQ,CAAS;QACjB,gBAAW,GAAX,WAAW,CAAuB;QAElD,MAAM,MAAM,GAA+B,IAAI,GAAG,EAAE,CAAC;QACrD,IAAI,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,KAAK,GAAuB;YACjC,IAAI,gBAAgB,CAAC,SAAS,EAAE,iBAAS,EAAE,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;SAC/E,CAAC;QACF,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,WAAW,EAAE;YACzC,IAAA,mBAAM,EAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;YACvE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACtB,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;YACrE,cAAc,IAAI,CAAC,CAAC,qBAAqB,GAAG,MAAM,CAAC;YACnD,UAAU,EAAE,CAAC;SACb;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,qBAAqB,GAAG,cAAc,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QAEvB,IAAI,CAAC,iBAAiB,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAAgB;QAC7B,yFAAyF;QAEzF,IACC,CAAC,IAAA,0BAAa,EACb,IAAI,CAAC,WAAW,EAChB,KAAK,CAAC,WAAW,EACjB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CACjE,EACA;YACD,OAAO,KAAK,CAAC;SACb;QACD,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,CAAC;IACrE,CAAC;IAEM,kBAAkB,CAAC,cAAsB;QAC/C,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC7C,CAAC;CACD;AApDD,8BAoDC;AAED,SAAS,cAAc,CACtB,qBAAyC,EACzC,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAa,EAChC,kBAA0B,EAC1B,WAAmB,EACnB,UAAiE;IAEjE,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IACjC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE;QAC5C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE;YACpC,MAAM,OAAO,GAAG,KAAK,CAAC,qBAAqB,KAAK,SAAS,CAAC;YAC1D,MAAM,mBAAmB,GAAG,OAAO;gBAClC,CAAC,CAAC,qBAAqB;gBACvB,CAAC,CAAC,KAAK,CAAC,qBAAqB,GAAG,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;YACzE,UAAU,CAAC,IAAI,CACd,IAAI,gBAAgB,CACnB,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAC/E,KAAK,CAAC,WAAW,KAAK,iBAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EACzD,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EACnC,KAAK,CAAC,kBAAkB,IAAI,kBAAkB,EAC9C,mBAAmB,EACnB,KAAK,CAAC,KAAK,EACX,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EACvC,KAAK,CAAC,WAAW,GAAG,WAAW,GAAG,KAAK,CAAC,qBAAqB,GAAG,KAAK,CACrE,CACD,CAAC;SACF;KACD;AACF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAa,UAAU;IAGtB,YACiB,SAAoB,EACpB,cAAsB;QADtB,cAAS,GAAT,SAAS,CAAW;QACpB,mBAAc,GAAd,cAAc,CAAQ;QAEtC,IAAA,mBAAM,EAAC,cAAc,GAAG,CAAC,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAE9E,0CAA0C;QAC1C,MAAM,SAAS,GAAqC,CAAC,SAAS,CAAC,CAAC;QAChE,cAAc,CAAC,CAAC,EAAE,CAAC,iBAAS,EAAE,SAAS,EAAE,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,KAAiB;QAC9B,yFAAyF;QACzF,OAAO,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC;IAC3F,CAAC;CACD;AAnBD,gCAmBC;AAED;;GAEG;AACH,MAAM,WAAW;IAChB;;;;;;OAMG;IACH,YACiB,KAAgB,EAChB,cAAsB,EACtB,MAAc,EACd,GAAa,EACb,kBAAsC;QAJtC,UAAK,GAAL,KAAK,CAAW;QAChB,mBAAc,GAAd,cAAc,CAAQ;QACtB,WAAM,GAAN,MAAM,CAAQ;QACd,QAAG,GAAH,GAAG,CAAU;QACb,uBAAkB,GAAlB,kBAAkB,CAAoB;IACpD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,gBAAgB;IACrB;;;;;;;;OAQG;IACH,YACiB,MAAoC,EAAE,gDAAgD;IACtF,WAAqB,EACrB,WAAmB,EACnB,kBAAsC,EACtC,qBAAyC,EACzC,KAAgB,EAAE,+EAA+E;IACjG,cAAsB,EACtB,WAAmB;QAPnB,WAAM,GAAN,MAAM,CAA8B;QACpC,gBAAW,GAAX,WAAW,CAAU;QACrB,gBAAW,GAAX,WAAW,CAAQ;QACnB,uBAAkB,GAAlB,kBAAkB,CAAoB;QACtC,0BAAqB,GAArB,qBAAqB,CAAoB;QACzC,UAAK,GAAL,KAAK,CAAW;QAChB,mBAAc,GAAd,cAAc,CAAQ;QACtB,gBAAW,GAAX,WAAW,CAAQ;IACjC,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,MAAO,SAAQ,mCAAiB;IAkBrC,kGAAkG;IAClG,YAAoC,KAAmB;QACtD,KAAK,EAAE,CAAC;QAD2B,UAAK,GAAL,KAAK,CAAc;QAVhD,SAAI,qCAAiD;QAK5D,+DAA+D;QAC/D,qGAAqG;QAC7F,iBAAY,GAAW,CAAC,CAAC;QA2LjB,eAAU,GAAW,CAAC,CAAC;QAtLtC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,iBAAS,CAAC;QAC1B,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC;IAED,IAAW,CAAC,mBAAW,CAAC;QACvB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACpD,CAAC;IAEM,WAAW;QACjB,IAAA,mBAAM,EACL,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,qCAA6B,CAAC,EAC1E,KAAK,CAAC,4BAA4B,CAClC,CAAC;QACF,OAAO,CACN,IAAI,CAAC,gBAAgB,KAAK,SAAS;YACnC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAC3E,CAAC;IACH,CAAC;IAEM,IAAI;QACV,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAChC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACxC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1C,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACK,cAAc,CAAC,aAAqB;QAC3C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACtD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,IAAA,mBAAM,EAAC,aAAa,KAAK,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAChE,IAAA,mBAAM,EACL,IAAI,CAAC,IAAI,sCAA8B,EACvC,KAAK,CAAC,iCAAiC,CACvC,CAAC;SACF;IACF,CAAC;IAED;;;;;;;;;OASG;IACK,QAAQ,CAAC,YAAgC;QAChD,IAAA,mBAAM,EAAC,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC1F,IAAA,mBAAM,EACL,IAAI,CAAC,gBAAgB,KAAK,SAAS,EACnC,KAAK,CAAC,2CAA2C,CACjD,CAAC;QACF,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAEM,SAAS;QACf,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,mCAA2B,CAAC,KAAK,CAAC,WAAW,CAAC;QAC1E,IAAI,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE;YACtC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;SACZ;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,SAAS;QACf,IAAA,mBAAM,EAAC,IAAI,CAAC,IAAI,sCAA8B,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAC1F,IAAA,mBAAM,EAAC,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjF,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,IAAI,mCAA2B,CAAC;IACtC,CAAC;IAEM,WAAW;QACjB,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAA,WAAI,EAAC,gBAAgB,CAAC,CAAC;IAChD,CAAC;IAEM,cAAc;QACpB,IAAA,mBAAM,EACL,IAAI,CAAC,IAAI,sCAA8B,EACvC,KAAK,CAAC,+CAA+C,CACrD,CAAC;QACF,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;SACjC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7E,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,OAAO,CAAC,CAAC;SACT;QACD,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IAEM,SAAS;QACf,IAAA,mBAAM,EACL,IAAI,CAAC,IAAI,sCAA8B,EACvC,KAAK,CAAC,+CAA+C,CACrD,CAAC;QAEF,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,4EAA4E;YAC5E,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;SACZ;aAAM;YACN,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;SACrD;IACF,CAAC;IAEM,SAAS,CAAC,UAAkB;QAClC,IAAA,mBAAM,EACL,IAAI,CAAC,IAAI,sCAA8B,EACvC,KAAK,CAAC,+CAA+C,CACrD,CAAC;QACF,IAAA,mBAAM,EAAC,UAAU,IAAI,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,IAAA,mBAAM,EACL,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,EACtC,KAAK,CAAC,iDAAiD,CACvD,CAAC;YACF,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;SACpC;aAAM;YACN,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YACrE,IAAA,mBAAM,EAAC,KAAK,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACvE;IACF,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,eAAiC,EAAE,UAAkB;QAC3E,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACvC,IAAI,IAAI,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE;YACvC,OAAO,KAAK,CAAC,CAAC,uDAAuD;SACrE;QACD,MAAM,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrD,IAAI,UAAU,IAAI,CAAC,CAAC,cAAc,EAAE;YACnC,OAAO,KAAK,CAAC;SACb;QACD,IAAI,CAAC,IAAI,mCAA2B,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,MAAM,GAAG,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3F,IAAA,mBAAM,EAAC,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC;IACb,CAAC;IAEO,kBAAkB,CAAC,UAAkB;QAC5C,IAAI,CAAC,IAAI,mCAA2B,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,sGAAsG;QACtG,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAA,mBAAM,EAAC,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACjF,CAAC;IAEM,YAAY,CAAC,MAAuB;QAC1C,OAAO,IAAA,iCAAe,EAAC,MAAM,EAAE;YAC9B,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE;YACzB,MAAM,EAAE,IAAI,CAAC,gBAAgB;SAC7B,CAAC,CAAC;IACJ,CAAC;IAEM,OAAO,CAAC,MAAuB;QACrC,OAAO,IAAA,4BAAU,EAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,kCAA0B,CAAC,CAAC;IACpE,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,QAAQ,kCAA0B,CAAC,WAAW,CAAC;IAC5D,CAAC;IAID,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,QAAQ,kCAA0B,CAAC,cAAc,CAAC;IAC/D,CAAC;IAEM,SAAS,CAAC,MAAc;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,kCAA0B,CAAC;QACrD,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,cAAc,EAAE;YAC9C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC/E,OAAO,IAAI,CAAC;SACZ;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,QAAQ;QACd,uEAAuE;QAEvE,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,kCAA0B,CAAC;QACrD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,KAAK,IAAI,CAAC,cAAc,EAAE;YAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,OAAO,KAAK,CAAC;SACb;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,kCAA0B,CAAC;QACrD,IAAI,CAAC,YAAY;YAChB,IAAI,CAAC,kBAAkB,IAAI,IAAA,WAAI,EAAC,+CAA+C,CAAC,CAAC,CAAC,QAAQ;QAC3F,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC;QACjC,IAAI,CAAC,IAAI,oCAA4B,CAAC;QACtC,IAAI,CAAC,cAAc,CAClB,IAAI,CAAC,qBAAqB,IAAI,IAAA,WAAI,EAAC,+CAA+C,CAAC,CACnF,CAAC,CAAC,OAAO;IACX,CAAC;IAEM,UAAU;QAChB,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,kCAA0B,CAAC,KAAK,CAAC,WAAW,CAAC;QAC9E,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,OAAO,KAAK,CAAC;SACb;QACD,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,oCAA4B,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,UAAU,CAAC,GAAa;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,kCAA0B,CAAC,KAAK,CAAC,MAAM,CAAC;QACtE,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,YAAY;YAChB,SAAS,KAAK,SAAS;gBACtB,CAAC,CAAC,QAAQ,CAAC,IAAI;gBACf,CAAC,CAAC,SAAS,CAAC,kBAAkB,IAAI,IAAA,WAAI,EAAC,8BAA8B,CAAC,CAAC;QACzE,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QACpB,IAAI,CAAC,IAAI,oCAA4B,CAAC;IACvC,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,QAAQ,kCAA0B,CAAC,KAAK,CAAC,IAAI,CAAC;IAC3D,CAAC;IAED,IAAW,KAAK;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,kCAA0B,CAAC;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9E,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, compareArrays } from \"@fluidframework/core-utils\";\nimport {\n\tFieldKey,\n\tTreeNodeSchemaIdentifier,\n\tCursorLocationType,\n\tFieldUpPath,\n\tUpPath,\n\tTreeValue,\n\tValue,\n\tPathRootPrefix,\n} from \"../../core\";\nimport { fail, ReferenceCountedBase } from \"../../util\";\nimport { prefixFieldPath, prefixPath, SynchronousCursor } from \"../treeCursorUtils\";\nimport { ChunkedCursor, cursorChunk, dummyRoot, TreeChunk } from \"./chunk\";\n\n/**\n * Create a tree chunk with ref count 1.\n *\n * @param shape - describes the semantics and layout of `values`.\n * @param values - provides exclusive ownership of this array to this object (which might mutate it in the future).\n */\nexport function uniformChunk(shape: ChunkShape, values: TreeValue[]): TreeChunk {\n\treturn new UniformChunk(shape, values);\n}\n\n/**\n * Chunk which handles a sequence of trees with identical \"shape\" (see `TreeShape`).\n *\n * Separates shape from content,\n * allowing deduplication of shape information and storing of content as a flat sequence of values.\n */\nexport class UniformChunk extends ReferenceCountedBase implements TreeChunk {\n\t/**\n\t * Create a tree chunk with ref count 1.\n\t *\n\t * @param shape - describes the semantics and layout of `values`.\n\t * @param values - provides exclusive ownership of this array to this object (which might mutate it in the future).\n\t */\n\tpublic constructor(\n\t\tpublic shape: ChunkShape,\n\t\tpublic values: TreeValue[],\n\t) {\n\t\tsuper();\n\t\tassert(\n\t\t\tshape.treeShape.valuesPerTopLevelNode * shape.topLevelLength === values.length,\n\t\t\t0x4c3 /* invalid number of values for shape */,\n\t\t);\n\t}\n\n\tpublic get topLevelLength(): number {\n\t\treturn this.shape.topLevelLength;\n\t}\n\n\tpublic clone(): UniformChunk {\n\t\treturn new UniformChunk(this.shape, this.values.slice());\n\t}\n\n\tpublic cursor(): Cursor {\n\t\treturn new Cursor(this);\n\t}\n\n\tprotected dispose(): void {}\n}\n\n/**\n * The \"shape\" of a field.\n *\n * Requires that all trees in the field have the same shape, which is described by `TreeShape`.\n * Note that this requirement means that not all fields can be described using this type.\n */\nexport type FieldShape = readonly [FieldKey, TreeShape, number];\n\n/**\n * The \"shape\" of a tree.\n * Does not contain the actual values from  the tree, but describes everything else,\n * including where the values would be found in a flat values array.\n *\n * Note that since this requires fields to have uniform shapes (see `FieldShape`),\n * not all trees can have their shape described using this type.\n */\nexport class TreeShape {\n\tpublic readonly fields: ReadonlyMap<FieldKey, OffsetShape>;\n\tpublic readonly fieldsOffsetArray: readonly OffsetShape[];\n\tpublic readonly valuesPerTopLevelNode: number;\n\n\t// TODO: this is only needed at chunk roots. Optimize it base on that.\n\tpublic readonly positions: readonly NodePositionInfo[];\n\n\tpublic constructor(\n\t\tpublic readonly type: TreeNodeSchemaIdentifier,\n\t\tpublic readonly hasValue: boolean,\n\t\tpublic readonly fieldsArray: readonly FieldShape[],\n\t) {\n\t\tconst fields: Map<FieldKey, OffsetShape> = new Map();\n\t\tlet numberOfValues = hasValue ? 1 : 0;\n\t\tconst infos: NodePositionInfo[] = [\n\t\t\tnew NodePositionInfo(undefined, dummyRoot, 0, undefined, undefined, this, 1, 0),\n\t\t];\n\t\tlet fieldIndex = 0;\n\t\tfor (const [k, f, length] of fieldsArray) {\n\t\t\tassert(!fields.has(k), 0x4c5 /* no duplicate keys */);\n\t\t\tconst offset = new OffsetShape(f, length, infos.length, k, fieldIndex);\n\t\t\tfields.set(k, offset);\n\t\t\tclonePositions(0, [k, f, length], fieldIndex, numberOfValues, infos);\n\t\t\tnumberOfValues += f.valuesPerTopLevelNode * length;\n\t\t\tfieldIndex++;\n\t\t}\n\t\tthis.fields = fields;\n\t\tthis.valuesPerTopLevelNode = numberOfValues;\n\t\tthis.positions = infos;\n\n\t\tthis.fieldsOffsetArray = [...fields.values()];\n\t}\n\n\tpublic equals(other: TreeShape): boolean {\n\t\t// TODO: either dedup instances and/or store a collision resistant hash for fast compare.\n\n\t\tif (\n\t\t\t!compareArrays(\n\t\t\t\tthis.fieldsArray,\n\t\t\t\tother.fieldsArray,\n\t\t\t\t([k, f, l], [k2, f2, l2]) => k === k2 && l === l2 && f.equals(f2),\n\t\t\t)\n\t\t) {\n\t\t\treturn false;\n\t\t}\n\t\treturn this.type === other.type && this.hasValue === other.hasValue;\n\t}\n\n\tpublic withTopLevelLength(topLevelLength: number): ChunkShape {\n\t\treturn new ChunkShape(this, topLevelLength);\n\t}\n}\n\nfunction clonePositions(\n\tindexOfParentInOutput: number | undefined,\n\t[key, shape, copies]: FieldShape,\n\tindexOfParentField: number,\n\tvalueOffset: number,\n\toutputInto: NodePositionInfo[] | (NodePositionInfo | undefined)[],\n): void {\n\tconst offset = outputInto.length;\n\tfor (let index = 0; index < copies; index++) {\n\t\tfor (const inner of shape.positions) {\n\t\t\tconst wasRoot = inner.indexOfParentPosition === undefined;\n\t\t\tconst parentPositionIndex = wasRoot\n\t\t\t\t? indexOfParentInOutput\n\t\t\t\t: inner.indexOfParentPosition + index * shape.positions.length + offset;\n\t\t\toutputInto.push(\n\t\t\t\tnew NodePositionInfo(\n\t\t\t\t\tparentPositionIndex === undefined ? undefined : outputInto[parentPositionIndex],\n\t\t\t\t\tinner.parentField === dummyRoot ? key : inner.parentField,\n\t\t\t\t\twasRoot ? index : inner.parentIndex,\n\t\t\t\t\tinner.indexOfParentField ?? indexOfParentField,\n\t\t\t\t\tparentPositionIndex,\n\t\t\t\t\tinner.shape,\n\t\t\t\t\twasRoot ? copies : inner.topLevelLength,\n\t\t\t\t\tinner.valueOffset + valueOffset + shape.valuesPerTopLevelNode * index,\n\t\t\t\t),\n\t\t\t);\n\t\t}\n\t}\n}\n\n/**\n * The shape (see `TreeShape`) of a sequence of trees, all with the same shape (like `FieldShape`, but without a field key).\n *\n * This shape is optimized (by caching derived data like the positions array),\n * so that when paired with a value array it can be efficiently traversed like a tree by an {@link ITreeCursorSynchronous}.\n * See {@link uniformChunk} for how to do this.\n *\n * TODO: consider storing shape information in WASM\n */\nexport class ChunkShape {\n\tpublic readonly positions: readonly (NodePositionInfo | undefined)[];\n\n\tpublic constructor(\n\t\tpublic readonly treeShape: TreeShape,\n\t\tpublic readonly topLevelLength: number,\n\t) {\n\t\tassert(topLevelLength > 0, 0x4c6 /* topLevelLength must be greater than 0 */);\n\n\t\t// TODO: avoid duplication from inner loop\n\t\tconst positions: (NodePositionInfo | undefined)[] = [undefined];\n\t\tclonePositions(0, [dummyRoot, treeShape, topLevelLength], 0, 0, positions);\n\t\tthis.positions = positions;\n\t}\n\n\tpublic equals(other: ChunkShape): boolean {\n\t\t// TODO: either dedup instances and/or store a collision resistant hash for fast compare.\n\t\treturn this.topLevelLength === other.topLevelLength && this.treeShape === other.treeShape;\n\t}\n}\n\n/**\n * Shape of a field (like `FieldShape`) but with information about how it would be offset within a chunk because of its parents.\n */\nclass OffsetShape {\n\t/**\n\t * @param shape - the shape of each child in this field\n\t * @param topLevelLength - number of top level nodes in this sequence chunk (either field within a chunk, or top level chunk)\n\t * @param offset - number of nodes before this in the parent's subtree\n\t * @param key - field key\n\t * @param indexOfParentField - index of node with this shape\n\t */\n\tpublic constructor(\n\t\tpublic readonly shape: TreeShape,\n\t\tpublic readonly topLevelLength: number,\n\t\tpublic readonly offset: number,\n\t\tpublic readonly key: FieldKey,\n\t\tpublic readonly indexOfParentField: number | undefined,\n\t) {}\n}\n\n/**\n * Information about a node at a specific position within a uniform chunk.\n */\nclass NodePositionInfo implements UpPath {\n\t/**\n\t * @param parent - TODO\n\t * @param parentField - TODO\n\t * @param parentIndex - indexWithinParentField\n\t * @param indexOfParentField - which field of the parent `parentIndex` is indexing into to locate this.\n\t * @param indexOfParentPosition - Index of parent NodePositionInfo in positions array. TODO: use offsets to avoid copying at top level?\n\t * @param shape - Shape of the top level sequence this node is part of\n\t * @param valueOffset - TODO\n\t */\n\tpublic constructor(\n\t\tpublic readonly parent: NodePositionInfo | undefined, // TODO; general UpPath to allow prefixing here?\n\t\tpublic readonly parentField: FieldKey,\n\t\tpublic readonly parentIndex: number,\n\t\tpublic readonly indexOfParentField: number | undefined,\n\t\tpublic readonly indexOfParentPosition: number | undefined,\n\t\tpublic readonly shape: TreeShape, // Shape of sequence that contains this node (top level is parent of this node)\n\t\tpublic readonly topLevelLength: number,\n\t\tpublic readonly valueOffset: number,\n\t) {}\n}\n\n/**\n * The cursor implementation for `UniformChunk`.\n *\n * Works by tracking its location in the chunk's `positions` array.\n */\nclass Cursor extends SynchronousCursor implements ChunkedCursor {\n\tprivate positionIndex!: number; // When in fields mode, this points to the parent node.\n\t// Undefined when in root field\n\tprivate nodePositionInfo: NodePositionInfo | undefined;\n\n\t// Cached constants for faster access\n\tprivate readonly shape: ChunkShape;\n\tprivate readonly positions: readonly (NodePositionInfo | undefined)[];\n\n\tpublic mode: CursorLocationType = CursorLocationType.Fields;\n\n\t// Undefined when not in fields mode.\n\tprivate fieldKey?: FieldKey;\n\n\t// Valid only in fields mode. Can be past end for empty fields.\n\t// This is redundant with fieldKey above (but might be worth keeping for perf), and could be removed.\n\tprivate indexOfField: number = 0;\n\n\t// TODO: support prefix (path above root, including index offset of chunk in its containing field)\n\tpublic constructor(private readonly chunk: UniformChunk) {\n\t\tsuper();\n\t\tthis.shape = this.chunk.shape;\n\t\tthis.positions = this.shape.positions;\n\t\tthis.fieldKey = dummyRoot;\n\t\tthis.moveToPosition(0);\n\t}\n\n\tpublic get [cursorChunk](): UniformChunk | undefined {\n\t\treturn this.atChunkRoot() ? this.chunk : undefined;\n\t}\n\n\tpublic atChunkRoot(): boolean {\n\t\tassert(\n\t\t\t(this.fieldKey === undefined) === (this.mode === CursorLocationType.Nodes),\n\t\t\t0x560 /* expect valid field key */,\n\t\t);\n\t\treturn (\n\t\t\tthis.nodePositionInfo === undefined ||\n\t\t\t(this.nodePositionInfo.parent === undefined && this.fieldKey === undefined)\n\t\t);\n\t}\n\n\tpublic fork(): Cursor {\n\t\tconst cursor = new Cursor(this.chunk);\n\t\tcursor.mode = this.mode;\n\t\tcursor.fieldKey = this.fieldKey;\n\t\tcursor.indexOfField = this.indexOfField;\n\t\tcursor.moveToPosition(this.positionIndex);\n\t\treturn cursor;\n\t}\n\n\t/**\n\t * Change the current node within the chunk.\n\t * See `nodeInfo` for getting data about the current node.\n\t *\n\t * @param positionIndex - index of the position of the newly selected node in `positions`.\n\t * This is NOT an index within a field, and is not bounds checked.\n\t */\n\tprivate moveToPosition(positionIndex: number): void {\n\t\tthis.nodePositionInfo = this.positions[positionIndex];\n\t\tthis.positionIndex = positionIndex;\n\t\tif (this.nodePositionInfo === undefined) {\n\t\t\tassert(positionIndex === 0, 0x561 /* expected root at start */);\n\t\t\tassert(\n\t\t\t\tthis.mode === CursorLocationType.Fields,\n\t\t\t\t0x562 /* expected root to be a field */,\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Gets information about the current node.\n\t *\n\t * When in Nodes mode, this means the node this cursor is current at.\n\t * When if fields mode, this means the node which is the parent of the current field.\n\t * This cursor is in Nodes mode at the root, so there is no case where a fields mode does not have a parent.\n\t *\n\t * @param requiredMode - asserts that the mode matches this. Since the semantics of this function are somewhat mode dependent,\n\t * providing this ensures that the caller knows what the results will mean.\n\t */\n\tprivate nodeInfo(requiredMode: CursorLocationType): NodePositionInfo {\n\t\tassert(this.mode === requiredMode, 0x4c8 /* tried to access cursor when in wrong mode */);\n\t\tassert(\n\t\t\tthis.nodePositionInfo !== undefined,\n\t\t\t0x53e /* can not access nodeInfo in root field */,\n\t\t);\n\t\treturn this.nodePositionInfo;\n\t}\n\n\tpublic nextField(): boolean {\n\t\tthis.indexOfField++;\n\t\tconst fields = this.nodeInfo(CursorLocationType.Fields).shape.fieldsArray;\n\t\tif (this.indexOfField < fields.length) {\n\t\t\tthis.fieldKey = fields[this.indexOfField][0];\n\t\t\treturn true;\n\t\t}\n\t\tthis.exitField();\n\t\treturn false;\n\t}\n\n\tpublic exitField(): void {\n\t\tassert(this.mode === CursorLocationType.Fields, 0x4c9 /* exitField when in wrong mode */);\n\t\tassert(this.nodePositionInfo !== undefined, 0x563 /* can not exit root field */);\n\t\tthis.fieldKey = undefined;\n\t\tthis.mode = CursorLocationType.Nodes;\n\t}\n\n\tpublic getFieldKey(): FieldKey {\n\t\treturn this.fieldKey ?? fail(\"not in a field\");\n\t}\n\n\tpublic getFieldLength(): number {\n\t\tassert(\n\t\t\tthis.mode === CursorLocationType.Fields,\n\t\t\t0x53f /* tried to access cursor when in wrong mode */,\n\t\t);\n\t\tif (this.nodePositionInfo === undefined) {\n\t\t\treturn this.shape.topLevelLength;\n\t\t}\n\t\tconst fieldInfo = this.nodePositionInfo.shape.fieldsArray[this.indexOfField];\n\t\tif (fieldInfo === undefined) {\n\t\t\treturn 0;\n\t\t}\n\t\treturn fieldInfo[2];\n\t}\n\n\tpublic firstNode(): boolean {\n\t\tassert(\n\t\t\tthis.mode === CursorLocationType.Fields,\n\t\t\t0x540 /* tried to access cursor when in wrong mode */,\n\t\t);\n\n\t\tif (this.nodePositionInfo === undefined) {\n\t\t\t// Root field is not allowed to be empty, so we can skip handling that case.\n\t\t\tthis.enterRootNodeInner(0);\n\t\t\treturn true;\n\t\t} else {\n\t\t\treturn this.enterNodeInner(this.nodePositionInfo, 0);\n\t\t}\n\t}\n\n\tpublic enterNode(childIndex: number): void {\n\t\tassert(\n\t\t\tthis.mode === CursorLocationType.Fields,\n\t\t\t0x541 /* tried to access cursor when in wrong mode */,\n\t\t);\n\t\tassert(childIndex >= 0, 0x4ca /* index must be positive */);\n\t\tif (this.nodePositionInfo === undefined) {\n\t\t\tassert(\n\t\t\t\tchildIndex < this.shape.topLevelLength,\n\t\t\t\t0x542 /* index must not be past the end of the field */,\n\t\t\t);\n\t\t\tthis.enterRootNodeInner(childIndex);\n\t\t} else {\n\t\t\tconst moved = this.enterNodeInner(this.nodePositionInfo, childIndex);\n\t\t\tassert(moved, 0x4cb /* index must not be past the end of the field */);\n\t\t}\n\t}\n\n\t/**\n\t * Enter the current field, at `childIndex`.\n\t * @param childIndex - index into current field to navigate to. Must be non-negative integer.\n\t */\n\tprivate enterNodeInner(currentPosition: NodePositionInfo, childIndex: number): boolean {\n\t\tconst shape = currentPosition.shape;\n\t\tconst fields = shape.fieldsOffsetArray;\n\t\tif (this.indexOfField >= fields.length) {\n\t\t\treturn false; // Handle empty field (indexed by key into empty field)\n\t\t}\n\t\tconst f = shape.fieldsOffsetArray[this.indexOfField];\n\t\tif (childIndex >= f.topLevelLength) {\n\t\t\treturn false;\n\t\t}\n\t\tthis.mode = CursorLocationType.Nodes;\n\t\tthis.fieldKey = undefined;\n\t\tthis.moveToPosition(this.positionIndex + f.offset + childIndex * f.shape.positions.length);\n\t\tassert(this.fieldIndex === childIndex, 0x4cc /* should be at selected child */);\n\t\treturn true;\n\t}\n\n\tprivate enterRootNodeInner(childIndex: number): void {\n\t\tthis.mode = CursorLocationType.Nodes;\n\t\tthis.fieldKey = undefined;\n\t\t// 1 for the \"undefined\" at the beginning of the positions array, then stride by top level tree shape.\n\t\tthis.moveToPosition(1 + childIndex * this.shape.treeShape.positions.length);\n\t\tassert(this.fieldIndex === childIndex, 0x543 /* should be at selected child */);\n\t}\n\n\tpublic getFieldPath(prefix?: PathRootPrefix): FieldUpPath {\n\t\treturn prefixFieldPath(prefix, {\n\t\t\tfield: this.getFieldKey(),\n\t\t\tparent: this.nodePositionInfo,\n\t\t});\n\t}\n\n\tpublic getPath(prefix?: PathRootPrefix): UpPath | undefined {\n\t\treturn prefixPath(prefix, this.nodeInfo(CursorLocationType.Nodes));\n\t}\n\n\tpublic get fieldIndex(): number {\n\t\treturn this.nodeInfo(CursorLocationType.Nodes).parentIndex;\n\t}\n\n\tpublic readonly chunkStart: number = 0;\n\n\tpublic get chunkLength(): number {\n\t\treturn this.nodeInfo(CursorLocationType.Nodes).topLevelLength;\n\t}\n\n\tpublic seekNodes(offset: number): boolean {\n\t\tconst info = this.nodeInfo(CursorLocationType.Nodes);\n\t\tconst index = offset + info.parentIndex;\n\t\tif (index >= 0 && index < info.topLevelLength) {\n\t\t\tthis.moveToPosition(this.positionIndex + offset * info.shape.positions.length);\n\t\t\treturn true;\n\t\t}\n\t\tthis.exitNode();\n\t\treturn false;\n\t}\n\n\tpublic nextNode(): boolean {\n\t\t// This is the same as `return this.seekNodes(1);` but slightly faster.\n\n\t\tconst info = this.nodeInfo(CursorLocationType.Nodes);\n\t\tconst index = info.parentIndex + 1;\n\t\tif (index === info.topLevelLength) {\n\t\t\tthis.exitNode();\n\t\t\treturn false;\n\t\t}\n\t\tthis.moveToPosition(this.positionIndex + info.shape.positions.length);\n\t\treturn true;\n\t}\n\n\tpublic exitNode(): void {\n\t\tconst info = this.nodeInfo(CursorLocationType.Nodes);\n\t\tthis.indexOfField =\n\t\t\tinfo.indexOfParentField ?? fail(\"navigation up to root field not yet supported\"); // TODO;\n\t\tthis.fieldKey = info.parentField;\n\t\tthis.mode = CursorLocationType.Fields;\n\t\tthis.moveToPosition(\n\t\t\tinfo.indexOfParentPosition ?? fail(\"navigation up to root field not yet supported\"),\n\t\t); // TODO\n\t}\n\n\tpublic firstField(): boolean {\n\t\tconst fieldsArray = this.nodeInfo(CursorLocationType.Nodes).shape.fieldsArray;\n\t\tif (fieldsArray.length === 0) {\n\t\t\treturn false;\n\t\t}\n\t\tthis.indexOfField = 0;\n\t\tthis.mode = CursorLocationType.Fields;\n\t\tthis.fieldKey = fieldsArray[0][0];\n\t\treturn true;\n\t}\n\n\tpublic enterField(key: FieldKey): void {\n\t\tconst fieldMap = this.nodeInfo(CursorLocationType.Nodes).shape.fields;\n\t\tconst fieldInfo = fieldMap.get(key);\n\t\tthis.indexOfField =\n\t\t\tfieldInfo === undefined\n\t\t\t\t? fieldMap.size\n\t\t\t\t: fieldInfo.indexOfParentField ?? fail(\"children should have parents\");\n\t\tthis.fieldKey = key;\n\t\tthis.mode = CursorLocationType.Fields;\n\t}\n\n\tpublic get type(): TreeNodeSchemaIdentifier {\n\t\treturn this.nodeInfo(CursorLocationType.Nodes).shape.type;\n\t}\n\n\tpublic get value(): Value {\n\t\tconst info = this.nodeInfo(CursorLocationType.Nodes);\n\t\treturn info.shape.hasValue ? this.chunk.values[info.valueOffset] : undefined;\n\t}\n}\n"]}