@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/default-schema/defaultEditBuilder.d.ts

@@ -0,0 +1,136 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ICodecFamily, ICodecOptions } from "../../codec";
+import { ChangeFamily, ChangeRebaser, UpPath, ITreeCursor, ChangeFamilyEditor, FieldUpPath, TaggedChange, DeltaRoot, DeltaDetachedNodeId } from "../../core";
+import { ModularChangeset } from "../modular-schema";
+export type DefaultChangeset = ModularChangeset;
+/**
+ * Implementation of {@link ChangeFamily} based on the default set of supported field kinds.
+ *
+ * @sealed
+ */
+export declare class DefaultChangeFamily implements ChangeFamily<DefaultEditBuilder, DefaultChangeset> {
+    private readonly modularFamily;
+    constructor(codecOptions: ICodecOptions);
+    get rebaser(): ChangeRebaser<DefaultChangeset>;
+    get codecs(): ICodecFamily<DefaultChangeset>;
+    buildEditor(changeReceiver: (change: DefaultChangeset) => void): DefaultEditBuilder;
+}
+/**
+ * @param change - The change to convert into a delta.
+ */
+export declare function intoDelta(taggedChange: TaggedChange<ModularChangeset>): DeltaRoot;
+/**
+ * Returns the set of removed roots that should be in memory for the given change to be applied.
+ * A removed root is relevant if any of the following is true:
+ * - It is being inserted
+ * - It is being restored
+ * - It is being edited
+ * - The ID it is associated with is being changed
+ *
+ * May be conservative by returning more removed roots than strictly necessary.
+ *
+ * Will never return IDs for non-root trees, even if they are removed.
+ *
+ * @param change - The change to be applied.
+ */
+export declare function relevantRemovedRoots(taggedChange: TaggedChange<ModularChangeset>): Iterable<DeltaDetachedNodeId>;
+/**
+ * Default editor for transactional tree data changes.
+ * @internal
+ */
+export interface IDefaultEditBuilder {
+    /**
+     * @param field - the value field which is being edited under the parent node
+     * @returns An object with methods to edit the given field of the given parent.
+     * The returned object can be used (i.e., have its methods called) multiple times but its lifetime
+     * is bounded by the lifetime of this edit builder.
+     */
+    valueField(field: FieldUpPath): ValueFieldEditBuilder;
+    /**
+     * @param field - the optional field which is being edited under the parent node
+     * @returns An object with methods to edit the given field of the given parent.
+     * The returned object can be used (i.e., have its methods called) multiple times but its lifetime
+     * is bounded by the lifetime of this edit builder.
+     */
+    optionalField(field: FieldUpPath): OptionalFieldEditBuilder;
+    /**
+     * @param field - the sequence field which is being edited under the parent node
+     *
+     * @returns An object with methods to edit the given field of the given parent.
+     * The returned object can be used (i.e., have its methods called) multiple times but its lifetime
+     * is bounded by the lifetime of this edit builder.
+     */
+    sequenceField(field: FieldUpPath): SequenceFieldEditBuilder;
+    /**
+     * Moves a subsequence from one sequence field to another sequence field.
+     *
+     * Note that the `destinationIndex` is interpreted based on the state of the sequence *before* the move operation.
+     * For example, `move(field, 0, 1, field, 2)` changes `[A, B, C]` to `[B, A, C]`.
+     */
+    move(sourceField: FieldUpPath, sourceIndex: number, count: number, destinationField: FieldUpPath, destinationIndex: number): void;
+    addNodeExistsConstraint(path: UpPath): void;
+}
+/**
+ * Implementation of {@link IDefaultEditBuilder} based on the default set of supported field kinds.
+ * @sealed
+ */
+export declare class DefaultEditBuilder implements ChangeFamilyEditor, IDefaultEditBuilder {
+    private readonly modularBuilder;
+    constructor(family: ChangeFamily<ChangeFamilyEditor, DefaultChangeset>, changeReceiver: (change: DefaultChangeset) => void);
+    enterTransaction(): void;
+    exitTransaction(): void;
+    addNodeExistsConstraint(path: UpPath): void;
+    valueField(field: FieldUpPath): ValueFieldEditBuilder;
+    optionalField(field: FieldUpPath): OptionalFieldEditBuilder;
+    move(sourceField: FieldUpPath, sourceIndex: number, count: number, destinationField: FieldUpPath, destIndex: number): void;
+    sequenceField(field: FieldUpPath): SequenceFieldEditBuilder;
+}
+/**
+ * @internal
+ */
+export interface ValueFieldEditBuilder {
+    /**
+     * Issues a change which replaces the current newContent of the field with `newContent`.
+     * @param newContent - the new content for the field. Must be in Nodes mode.
+     */
+    set(newContent: ITreeCursor): void;
+}
+/**
+ * @internal
+ */
+export interface OptionalFieldEditBuilder {
+    /**
+     * Issues a change which replaces the current newContent of the field with `newContent`
+     * @param newContent - the new content for the field. Must be in Nodes mode.
+     * @param wasEmpty - whether the field is empty when creating this change
+     */
+    set(newContent: ITreeCursor | undefined, wasEmpty: boolean): void;
+}
+/**
+ * @internal
+ */
+export interface SequenceFieldEditBuilder {
+    /**
+     * Issues a change which inserts the `newContent` at the given `index`.
+     * @param index - the index at which to insert the `newContent`.
+     * @param newContent - the new content to be inserted in the field. Cursors must be in Nodes mode.
+     */
+    insert(index: number, newContent: ITreeCursor | readonly ITreeCursor[]): void;
+    /**
+     * Issues a change which deletes `count` elements starting at the given `index`.
+     * @param index - The index of the first deleted element.
+     * @param count - The number of elements to delete.
+     */
+    delete(index: number, count: number): void;
+    /**
+     * Issues a change which moves `count` elements starting at `sourceIndex` to `destIndex`.
+     * @param sourceIndex - the index of the first moved element.
+     * @param count - the number of elements to move.
+     * @param destIndex - the index the elements are moved to, interpreted before detaching the moved elements.
+     */
+    move(sourceIndex: number, count: number, destIndex: number): void;
+}
+//# sourceMappingURL=defaultEditBuilder.d.ts.map

package/dist/feature-libraries/default-schema/defaultEditBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultEditBuilder.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultEditBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EACN,YAAY,EACZ,aAAa,EACb,MAAM,EACN,WAAW,EACX,kBAAkB,EAClB,WAAW,EAGX,YAAY,EACZ,SAAS,EAET,mBAAmB,EACnB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAIN,gBAAgB,EAKhB,MAAM,mBAAmB,CAAC;AAI3B,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,mBAAoB,YAAW,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC;IAC7F,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;gBAEjC,YAAY,EAAE,aAAa;IAQ9C,IAAW,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAEpD;IAED,IAAW,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,CAElD;IAEM,WAAW,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,kBAAkB;CAG1F;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAEjF;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CACnC,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAC,GAC1C,QAAQ,CAAC,mBAAmB,CAAC,CAE/B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,qBAAqB,CAAC;IAEtD;;;;;OAKG;IACH,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,wBAAwB,CAAC;IAE5D;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,wBAAwB,CAAC;IAE5D;;;;;OAKG;IACH,IAAI,CACH,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,WAAW,EAC7B,gBAAgB,EAAE,MAAM,GACtB,IAAI,CAAC;IAGR,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAED;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,kBAAkB,EAAE,mBAAmB;IACjF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqB;gBAGnD,MAAM,EAAE,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,EAC1D,cAAc,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI;IAK5C,gBAAgB,IAAI,IAAI;IAGxB,eAAe,IAAI,IAAI;IAIvB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI3C,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,qBAAqB;IAwBrD,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,wBAAwB;IAqC3D,IAAI,CACV,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,WAAW,EAC7B,SAAS,EAAE,MAAM,GACf,IAAI;IAwEA,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,wBAAwB;CAiDlE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;;;OAIG;IACH,GAAG,CAAC,UAAU,EAAE,WAAW,GAAG,SAAS,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,GAAG,SAAS,WAAW,EAAE,GAAG,IAAI,CAAC;IAE9E;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3C;;;;;OAKG;IACH,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAClE"}

package/dist/feature-libraries/default-schema/defaultEditBuilder.js

@@ -0,0 +1,245 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultEditBuilder = exports.relevantRemovedRoots = exports.intoDelta = exports.DefaultChangeFamily = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const core_1 = require("../../core");
+const util_1 = require("../../util");
+const modular_schema_1 = require("../modular-schema");
+const shared_tree_core_1 = require("../../shared-tree-core");
+const defaultFieldKinds_1 = require("./defaultFieldKinds");
+/**
+ * Implementation of {@link ChangeFamily} based on the default set of supported field kinds.
+ *
+ * @sealed
+ */
+class DefaultChangeFamily {
+    constructor(codecOptions) {
+        this.modularFamily = new modular_schema_1.ModularChangeFamily(defaultFieldKinds_1.fieldKinds, new shared_tree_core_1.RevisionTagCodec(), codecOptions);
+    }
+    get rebaser() {
+        return this.modularFamily.rebaser;
+    }
+    get codecs() {
+        return this.modularFamily.codecs;
+    }
+    buildEditor(changeReceiver) {
+        return new DefaultEditBuilder(this, changeReceiver);
+    }
+}
+exports.DefaultChangeFamily = DefaultChangeFamily;
+/**
+ * @param change - The change to convert into a delta.
+ */
+function intoDelta(taggedChange) {
+    return (0, modular_schema_1.intoDelta)(taggedChange, defaultFieldKinds_1.fieldKinds);
+}
+exports.intoDelta = intoDelta;
+/**
+ * Returns the set of removed roots that should be in memory for the given change to be applied.
+ * A removed root is relevant if any of the following is true:
+ * - It is being inserted
+ * - It is being restored
+ * - It is being edited
+ * - The ID it is associated with is being changed
+ *
+ * May be conservative by returning more removed roots than strictly necessary.
+ *
+ * Will never return IDs for non-root trees, even if they are removed.
+ *
+ * @param change - The change to be applied.
+ */
+function relevantRemovedRoots(taggedChange) {
+    return (0, modular_schema_1.relevantRemovedRoots)(taggedChange, defaultFieldKinds_1.fieldKinds);
+}
+exports.relevantRemovedRoots = relevantRemovedRoots;
+/**
+ * Implementation of {@link IDefaultEditBuilder} based on the default set of supported field kinds.
+ * @sealed
+ */
+class DefaultEditBuilder {
+    constructor(family, changeReceiver) {
+        this.modularBuilder = new modular_schema_1.ModularEditBuilder(family, changeReceiver);
+    }
+    enterTransaction() {
+        this.modularBuilder.enterTransaction();
+    }
+    exitTransaction() {
+        this.modularBuilder.exitTransaction();
+    }
+    addNodeExistsConstraint(path) {
+        this.modularBuilder.addNodeExistsConstraint(path);
+    }
+    valueField(field) {
+        return {
+            set: (newContent) => {
+                const fillId = this.modularBuilder.generateId();
+                const build = this.modularBuilder.buildTrees(fillId, [newContent]);
+                const change = (0, util_1.brand)(defaultFieldKinds_1.required.changeHandler.editor.set({
+                    fill: fillId,
+                    detach: this.modularBuilder.generateId(),
+                }));
+                const edit = {
+                    type: "field",
+                    field,
+                    fieldKind: defaultFieldKinds_1.required.identifier,
+                    change,
+                };
+                this.modularBuilder.submitChanges([build, edit]);
+            },
+        };
+    }
+    optionalField(field) {
+        return {
+            set: (newContent, wasEmpty) => {
+                const detachId = this.modularBuilder.generateId();
+                let fillId;
+                const edits = [];
+                let optionalChange;
+                if (newContent !== undefined) {
+                    fillId = this.modularBuilder.generateId();
+                    const build = this.modularBuilder.buildTrees(fillId, [newContent]);
+                    edits.push(build);
+                    optionalChange = defaultFieldKinds_1.optional.changeHandler.editor.set(wasEmpty, {
+                        fill: fillId,
+                        detach: detachId,
+                    });
+                }
+                else {
+                    optionalChange = defaultFieldKinds_1.optional.changeHandler.editor.clear(wasEmpty, detachId);
+                }
+                const change = (0, util_1.brand)(optionalChange);
+                const edit = {
+                    type: "field",
+                    field,
+                    fieldKind: defaultFieldKinds_1.optional.identifier,
+                    change,
+                };
+                edits.push(edit);
+                this.modularBuilder.submitChanges(edits, newContent === undefined ? detachId : fillId);
+            },
+        };
+    }
+    move(sourceField, sourceIndex, count, destinationField, destIndex) {
+        const moveId = this.modularBuilder.generateId(count);
+        if ((0, core_1.compareFieldUpPaths)(sourceField, destinationField)) {
+            const change = defaultFieldKinds_1.sequence.changeHandler.editor.move(sourceIndex, count, destIndex, moveId);
+            this.modularBuilder.submitChange(sourceField, defaultFieldKinds_1.sequence.identifier, (0, util_1.brand)(change));
+        }
+        else {
+            const detachPath = (0, core_1.topDownPath)(sourceField.parent);
+            const attachPath = (0, core_1.topDownPath)(destinationField.parent);
+            const sharedDepth = getSharedPrefixLength(detachPath, attachPath);
+            let adjustedAttachField = destinationField;
+            // After the above loop, `sharedDepth` is the number of elements, starting from the root,
+            // that both paths have in common.
+            if (sharedDepth === detachPath.length) {
+                const attachField = attachPath[sharedDepth]?.parentField ?? destinationField.field;
+                if (attachField === sourceField.field) {
+                    // The detach occurs in an ancestor field of the field where the attach occurs.
+                    let attachAncestorIndex = attachPath[sharedDepth]?.parentIndex ?? sourceIndex;
+                    if (attachAncestorIndex < sourceIndex) {
+                        // The attach path runs through a node located before the detached nodes.
+                        // No need to adjust the attach path.
+                    }
+                    else {
+                        (0, core_utils_1.assert)(sourceIndex + count <= attachAncestorIndex, 0x801 /* Invalid move: the destination is below one of the moved elements. */);
+                        // The attach path runs through a node located after the detached nodes.
+                        // adjust the index for the node at that depth of the path, so that it is interpreted correctly
+                        // in the composition performed by `submitChanges`.
+                        attachAncestorIndex -= count;
+                        let parent = attachPath[sharedDepth - 1];
+                        parent = {
+                            parent,
+                            parentIndex: attachAncestorIndex,
+                            parentField: attachPath[sharedDepth].parentField,
+                        };
+                        for (let i = sharedDepth + 1; i < attachPath.length; i += 1) {
+                            parent = {
+                                ...attachPath[i],
+                                parent,
+                            };
+                        }
+                        adjustedAttachField = { parent, field: destinationField.field };
+                    }
+                }
+            }
+            const moveOut = defaultFieldKinds_1.sequence.changeHandler.editor.moveOut(sourceIndex, count, moveId);
+            const moveIn = defaultFieldKinds_1.sequence.changeHandler.editor.moveIn(destIndex, count, moveId);
+            this.modularBuilder.submitChanges([
+                {
+                    type: "field",
+                    field: sourceField,
+                    fieldKind: defaultFieldKinds_1.sequence.identifier,
+                    change: (0, util_1.brand)(moveOut),
+                },
+                {
+                    type: "field",
+                    field: adjustedAttachField,
+                    fieldKind: defaultFieldKinds_1.sequence.identifier,
+                    change: (0, util_1.brand)(moveIn),
+                },
+            ], moveId);
+        }
+    }
+    sequenceField(field) {
+        return {
+            insert: (index, newContent) => {
+                const content = (0, util_1.isReadonlyArray)(newContent) ? newContent : [newContent];
+                const length = content.length;
+                if (length === 0) {
+                    return;
+                }
+                const firstId = this.modularBuilder.generateId(length);
+                const build = this.modularBuilder.buildTrees(firstId, content);
+                const change = (0, util_1.brand)(defaultFieldKinds_1.sequence.changeHandler.editor.insert(index, length, firstId));
+                const attach = {
+                    type: "field",
+                    field,
+                    fieldKind: defaultFieldKinds_1.sequence.identifier,
+                    change,
+                };
+                // The changes have to be submitted together, otherwise they will be assigned different revisions,
+                // which will prevent the build ID and the insert ID from matching.
+                this.modularBuilder.submitChanges([build, attach], (0, util_1.brand)(firstId + length - 1));
+            },
+            delete: (index, count) => {
+                if (count === 0) {
+                    return;
+                }
+                const id = this.modularBuilder.generateId(count);
+                const change = (0, util_1.brand)(defaultFieldKinds_1.sequence.changeHandler.editor.delete(index, count, id));
+                this.modularBuilder.submitChange(field, defaultFieldKinds_1.sequence.identifier, change);
+            },
+            move: (sourceIndex, count, destIndex) => {
+                const moveId = this.modularBuilder.generateId(count);
+                const change = defaultFieldKinds_1.sequence.changeHandler.editor.move(sourceIndex, count, destIndex, moveId);
+                this.modularBuilder.submitChange(field, defaultFieldKinds_1.sequence.identifier, (0, util_1.brand)(change));
+            },
+        };
+    }
+}
+exports.DefaultEditBuilder = DefaultEditBuilder;
+/**
+ * @returns The number of path elements that both paths share, starting at index 0.
+ */
+function getSharedPrefixLength(pathA, pathB) {
+    const minDepth = Math.min(pathA.length, pathB.length);
+    let sharedDepth = 0;
+    while (sharedDepth < minDepth) {
+        const detachStep = pathA[sharedDepth];
+        const attachStep = pathB[sharedDepth];
+        if (detachStep !== attachStep) {
+            if (detachStep.parentField !== attachStep.parentField ||
+                detachStep.parentIndex !== attachStep.parentIndex) {
+                break;
+            }
+        }
+        sharedDepth += 1;
+    }
+    return sharedDepth;
+}
+//# sourceMappingURL=defaultEditBuilder.js.map

package/dist/feature-libraries/default-schema/defaultEditBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultEditBuilder.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultEditBuilder.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAGpD,qCAaoB;AACpB,qCAAoD;AACpD,sDAS2B;AAC3B,6DAA0D;AAC1D,2DAAiG;AAIjG;;;;GAIG;AACH,MAAa,mBAAmB;IAG/B,YAAmB,YAA2B;QAC7C,IAAI,CAAC,aAAa,GAAG,IAAI,oCAAmB,CAC3C,8BAAU,EACV,IAAI,mCAAgB,EAAE,EACtB,YAAY,CACZ,CAAC;IACH,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;IAClC,CAAC;IAEM,WAAW,CAAC,cAAkD;QACpE,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACrD,CAAC;CACD;AAtBD,kDAsBC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,YAA4C;IACrE,OAAO,IAAA,0BAAgB,EAAC,YAAY,EAAE,8BAAU,CAAC,CAAC;AACnD,CAAC;AAFD,8BAEC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,oBAAoB,CACnC,YAA4C;IAE5C,OAAO,IAAA,qCAA2B,EAAC,YAAY,EAAE,8BAAU,CAAC,CAAC;AAC9D,CAAC;AAJD,oDAIC;AAkDD;;;GAGG;AACH,MAAa,kBAAkB;IAG9B,YACC,MAA0D,EAC1D,cAAkD;QAElD,IAAI,CAAC,cAAc,GAAG,IAAI,mCAAkB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAEM,gBAAgB;QACtB,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;IACM,eAAe;QACrB,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAEM,uBAAuB,CAAC,IAAY;QAC1C,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,UAAU,CAAC,KAAkB;QACnC,OAAO;YACN,GAAG,EAAE,CAAC,UAAuB,EAAQ,EAAE;gBACtC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;gBAEhD,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBACnE,MAAM,MAAM,GAAmB,IAAA,YAAK,EACnC,4BAAc,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC;oBACvC,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;iBACxC,CAAC,CACF,CAAC;gBAEF,MAAM,IAAI,GAAyB;oBAClC,IAAI,EAAE,OAAO;oBACb,KAAK;oBACL,SAAS,EAAE,4BAAc,CAAC,UAAU;oBACpC,MAAM;iBACN,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YAClD,CAAC;SACD,CAAC;IACH,CAAC;IAEM,aAAa,CAAC,KAAkB;QACtC,OAAO;YACN,GAAG,EAAE,CAAC,UAAmC,EAAE,QAAiB,EAAQ,EAAE;gBACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;gBAClD,IAAI,MAAoC,CAAC;gBACzC,MAAM,KAAK,GAAsB,EAAE,CAAC;gBACpC,IAAI,cAAiC,CAAC;gBACtC,IAAI,UAAU,KAAK,SAAS,EAAE;oBAC7B,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;oBAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;oBACnE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAElB,cAAc,GAAG,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;wBAC5D,IAAI,EAAE,MAAM;wBACZ,MAAM,EAAE,QAAQ;qBAChB,CAAC,CAAC;iBACH;qBAAM;oBACN,cAAc,GAAG,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;iBACzE;gBAED,MAAM,MAAM,GAAmB,IAAA,YAAK,EAAC,cAAc,CAAC,CAAC;gBACrD,MAAM,IAAI,GAAyB;oBAClC,IAAI,EAAE,OAAO;oBACb,KAAK;oBACL,SAAS,EAAE,4BAAQ,CAAC,UAAU;oBAC9B,MAAM;iBACN,CAAC;gBACF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAEjB,IAAI,CAAC,cAAc,CAAC,aAAa,CAChC,KAAK,EACL,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAC5C,CAAC;YACH,CAAC;SACD,CAAC;IACH,CAAC;IAEM,IAAI,CACV,WAAwB,EACxB,WAAmB,EACnB,KAAa,EACb,gBAA6B,EAC7B,SAAiB;QAEjB,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,IAAA,0BAAmB,EAAC,WAAW,EAAE,gBAAgB,CAAC,EAAE;YACvD,MAAM,MAAM,GAAG,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAChD,WAAW,EACX,KAAK,EACL,SAAS,EACT,MAAM,CACN,CAAC;YACF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,EAAE,4BAAQ,CAAC,UAAU,EAAE,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC,CAAC;SAClF;aAAM;YACN,MAAM,UAAU,GAAG,IAAA,kBAAW,EAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAA,kBAAW,EAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YACxD,MAAM,WAAW,GAAG,qBAAqB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAClE,IAAI,mBAAmB,GAAG,gBAAgB,CAAC;YAC3C,yFAAyF;YACzF,kCAAkC;YAClC,IAAI,WAAW,KAAK,UAAU,CAAC,MAAM,EAAE;gBACtC,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,EAAE,WAAW,IAAI,gBAAgB,CAAC,KAAK,CAAC;gBACnF,IAAI,WAAW,KAAK,WAAW,CAAC,KAAK,EAAE;oBACtC,+EAA+E;oBAC/E,IAAI,mBAAmB,GAAG,UAAU,CAAC,WAAW,CAAC,EAAE,WAAW,IAAI,WAAW,CAAC;oBAC9E,IAAI,mBAAmB,GAAG,WAAW,EAAE;wBACtC,yEAAyE;wBACzE,qCAAqC;qBACrC;yBAAM;wBACN,IAAA,mBAAM,EACL,WAAW,GAAG,KAAK,IAAI,mBAAmB,EAC1C,KAAK,CAAC,uEAAuE,CAC7E,CAAC;wBACF,wEAAwE;wBACxE,+FAA+F;wBAC/F,mDAAmD;wBACnD,mBAAmB,IAAI,KAAK,CAAC;wBAC7B,IAAI,MAAM,GAAuB,UAAU,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;wBAC7D,MAAM,GAAG;4BACR,MAAM;4BACN,WAAW,EAAE,mBAAmB;4BAChC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,WAAW;yBAChD,CAAC;wBACF,KAAK,IAAI,CAAC,GAAG,WAAW,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;4BAC5D,MAAM,GAAG;gCACR,GAAG,UAAU,CAAC,CAAC,CAAC;gCAChB,MAAM;6BACN,CAAC;yBACF;wBACD,mBAAmB,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC;qBAChE;iBACD;aACD;YACD,MAAM,OAAO,GAAG,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YAClF,MAAM,MAAM,GAAG,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YAC9E,IAAI,CAAC,cAAc,CAAC,aAAa,CAChC;gBACC;oBACC,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,WAAW;oBAClB,SAAS,EAAE,4BAAQ,CAAC,UAAU;oBAC9B,MAAM,EAAE,IAAA,YAAK,EAAC,OAAO,CAAC;iBACtB;gBACD;oBACC,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,mBAAmB;oBAC1B,SAAS,EAAE,4BAAQ,CAAC,UAAU;oBAC9B,MAAM,EAAE,IAAA,YAAK,EAAC,MAAM,CAAC;iBACrB;aACD,EACD,MAAM,CACN,CAAC;SACF;IACF,CAAC;IAEM,aAAa,CAAC,KAAkB;QACtC,OAAO;YACN,MAAM,EAAE,CAAC,KAAa,EAAE,UAAgD,EAAQ,EAAE;gBACjF,MAAM,OAAO,GAAG,IAAA,sBAAe,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;gBACxE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC9B,IAAI,MAAM,KAAK,CAAC,EAAE;oBACjB,OAAO;iBACP;gBAED,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBACvD,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC/D,MAAM,MAAM,GAAmB,IAAA,YAAK,EACnC,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAC5D,CAAC;gBACF,MAAM,MAAM,GAAyB;oBACpC,IAAI,EAAE,OAAO;oBACb,KAAK;oBACL,SAAS,EAAE,4BAAQ,CAAC,UAAU;oBAC9B,MAAM;iBACN,CAAC;gBACF,kGAAkG;gBAClG,mEAAmE;gBACnE,IAAI,CAAC,cAAc,CAAC,aAAa,CAChC,CAAC,KAAK,EAAE,MAAM,CAAC,EACf,IAAA,YAAK,EAAE,OAAkB,GAAG,MAAM,GAAG,CAAC,CAAC,CACvC,CAAC;YACH,CAAC;YACD,MAAM,EAAE,CAAC,KAAa,EAAE,KAAa,EAAQ,EAAE;gBAC9C,IAAI,KAAK,KAAK,CAAC,EAAE;oBAChB,OAAO;iBACP;gBACD,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACjD,MAAM,MAAM,GAAmB,IAAA,YAAK,EACnC,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CACtD,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,KAAK,EAAE,4BAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,EAAE,CAAC,WAAmB,EAAE,KAAa,EAAE,SAAiB,EAAQ,EAAE;gBACrE,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACrD,MAAM,MAAM,GAAG,4BAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAChD,WAAW,EACX,KAAK,EACL,SAAS,EACT,MAAM,CACN,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,KAAK,EAAE,4BAAQ,CAAC,UAAU,EAAE,IAAA,YAAK,EAAC,MAAM,CAAC,CAAC,CAAC;YAC7E,CAAC;SACD,CAAC;IACH,CAAC;CACD;AAjND,gDAiNC;AAoDD;;GAEG;AACH,SAAS,qBAAqB,CAAC,KAAwB,EAAE,KAAwB;IAChF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,OAAO,WAAW,GAAG,QAAQ,EAAE;QAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QACtC,IAAI,UAAU,KAAK,UAAU,EAAE;YAC9B,IACC,UAAU,CAAC,WAAW,KAAK,UAAU,CAAC,WAAW;gBACjD,UAAU,CAAC,WAAW,KAAK,UAAU,CAAC,WAAW,EAChD;gBACD,MAAM;aACN;SACD;QACD,WAAW,IAAI,CAAC,CAAC;KACjB;IACD,OAAO,WAAW,CAAC;AACpB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { OptionalChangeset } from \"../optional-field\";\nimport { ICodecFamily, ICodecOptions } from \"../../codec\";\nimport {\n\tChangeFamily,\n\tChangeRebaser,\n\tUpPath,\n\tITreeCursor,\n\tChangeFamilyEditor,\n\tFieldUpPath,\n\tcompareFieldUpPaths,\n\ttopDownPath,\n\tTaggedChange,\n\tDeltaRoot,\n\tChangesetLocalId,\n\tDeltaDetachedNodeId,\n} from \"../../core\";\nimport { brand, isReadonlyArray } from \"../../util\";\nimport {\n\tModularChangeFamily,\n\tModularEditBuilder,\n\tFieldChangeset,\n\tModularChangeset,\n\tFieldEditDescription,\n\tintoDelta as intoModularDelta,\n\trelevantRemovedRoots as relevantModularRemovedRoots,\n\tEditDescription,\n} from \"../modular-schema\";\nimport { RevisionTagCodec } from \"../../shared-tree-core\";\nimport { fieldKinds, optional, sequence, required as valueFieldKind } from \"./defaultFieldKinds\";\n\nexport type DefaultChangeset = ModularChangeset;\n\n/**\n * Implementation of {@link ChangeFamily} based on the default set of supported field kinds.\n *\n * @sealed\n */\nexport class DefaultChangeFamily implements ChangeFamily<DefaultEditBuilder, DefaultChangeset> {\n\tprivate readonly modularFamily: ModularChangeFamily;\n\n\tpublic constructor(codecOptions: ICodecOptions) {\n\t\tthis.modularFamily = new ModularChangeFamily(\n\t\t\tfieldKinds,\n\t\t\tnew RevisionTagCodec(),\n\t\t\tcodecOptions,\n\t\t);\n\t}\n\n\tpublic get rebaser(): ChangeRebaser<DefaultChangeset> {\n\t\treturn this.modularFamily.rebaser;\n\t}\n\n\tpublic get codecs(): ICodecFamily<DefaultChangeset> {\n\t\treturn this.modularFamily.codecs;\n\t}\n\n\tpublic buildEditor(changeReceiver: (change: DefaultChangeset) => void): DefaultEditBuilder {\n\t\treturn new DefaultEditBuilder(this, changeReceiver);\n\t}\n}\n\n/**\n * @param change - The change to convert into a delta.\n */\nexport function intoDelta(taggedChange: TaggedChange<ModularChangeset>): DeltaRoot {\n\treturn intoModularDelta(taggedChange, fieldKinds);\n}\n\n/**\n * Returns the set of removed roots that should be in memory for the given change to be applied.\n * A removed root is relevant if any of the following is true:\n * - It is being inserted\n * - It is being restored\n * - It is being edited\n * - The ID it is associated with is being changed\n *\n * May be conservative by returning more removed roots than strictly necessary.\n *\n * Will never return IDs for non-root trees, even if they are removed.\n *\n * @param change - The change to be applied.\n */\nexport function relevantRemovedRoots(\n\ttaggedChange: TaggedChange<ModularChangeset>,\n): Iterable<DeltaDetachedNodeId> {\n\treturn relevantModularRemovedRoots(taggedChange, fieldKinds);\n}\n\n/**\n * Default editor for transactional tree data changes.\n * @internal\n */\nexport interface IDefaultEditBuilder {\n\t/**\n\t * @param field - the value field which is being edited under the parent node\n\t * @returns An object with methods to edit the given field of the given parent.\n\t * The returned object can be used (i.e., have its methods called) multiple times but its lifetime\n\t * is bounded by the lifetime of this edit builder.\n\t */\n\tvalueField(field: FieldUpPath): ValueFieldEditBuilder;\n\n\t/**\n\t * @param field - the optional field which is being edited under the parent node\n\t * @returns An object with methods to edit the given field of the given parent.\n\t * The returned object can be used (i.e., have its methods called) multiple times but its lifetime\n\t * is bounded by the lifetime of this edit builder.\n\t */\n\toptionalField(field: FieldUpPath): OptionalFieldEditBuilder;\n\n\t/**\n\t * @param field - the sequence field which is being edited under the parent node\n\t *\n\t * @returns An object with methods to edit the given field of the given parent.\n\t * The returned object can be used (i.e., have its methods called) multiple times but its lifetime\n\t * is bounded by the lifetime of this edit builder.\n\t */\n\tsequenceField(field: FieldUpPath): SequenceFieldEditBuilder;\n\n\t/**\n\t * Moves a subsequence from one sequence field to another sequence field.\n\t *\n\t * Note that the `destinationIndex` is interpreted based on the state of the sequence *before* the move operation.\n\t * For example, `move(field, 0, 1, field, 2)` changes `[A, B, C]` to `[B, A, C]`.\n\t */\n\tmove(\n\t\tsourceField: FieldUpPath,\n\t\tsourceIndex: number,\n\t\tcount: number,\n\t\tdestinationField: FieldUpPath,\n\t\tdestinationIndex: number,\n\t): void;\n\n\t// TODO: document\n\taddNodeExistsConstraint(path: UpPath): void;\n}\n\n/**\n * Implementation of {@link IDefaultEditBuilder} based on the default set of supported field kinds.\n * @sealed\n */\nexport class DefaultEditBuilder implements ChangeFamilyEditor, IDefaultEditBuilder {\n\tprivate readonly modularBuilder: ModularEditBuilder;\n\n\tpublic constructor(\n\t\tfamily: ChangeFamily<ChangeFamilyEditor, DefaultChangeset>,\n\t\tchangeReceiver: (change: DefaultChangeset) => void,\n\t) {\n\t\tthis.modularBuilder = new ModularEditBuilder(family, changeReceiver);\n\t}\n\n\tpublic enterTransaction(): void {\n\t\tthis.modularBuilder.enterTransaction();\n\t}\n\tpublic exitTransaction(): void {\n\t\tthis.modularBuilder.exitTransaction();\n\t}\n\n\tpublic addNodeExistsConstraint(path: UpPath): void {\n\t\tthis.modularBuilder.addNodeExistsConstraint(path);\n\t}\n\n\tpublic valueField(field: FieldUpPath): ValueFieldEditBuilder {\n\t\treturn {\n\t\t\tset: (newContent: ITreeCursor): void => {\n\t\t\t\tconst fillId = this.modularBuilder.generateId();\n\n\t\t\t\tconst build = this.modularBuilder.buildTrees(fillId, [newContent]);\n\t\t\t\tconst change: FieldChangeset = brand(\n\t\t\t\t\tvalueFieldKind.changeHandler.editor.set({\n\t\t\t\t\t\tfill: fillId,\n\t\t\t\t\t\tdetach: this.modularBuilder.generateId(),\n\t\t\t\t\t}),\n\t\t\t\t);\n\n\t\t\t\tconst edit: FieldEditDescription = {\n\t\t\t\t\ttype: \"field\",\n\t\t\t\t\tfield,\n\t\t\t\t\tfieldKind: valueFieldKind.identifier,\n\t\t\t\t\tchange,\n\t\t\t\t};\n\t\t\t\tthis.modularBuilder.submitChanges([build, edit]);\n\t\t\t},\n\t\t};\n\t}\n\n\tpublic optionalField(field: FieldUpPath): OptionalFieldEditBuilder {\n\t\treturn {\n\t\t\tset: (newContent: ITreeCursor | undefined, wasEmpty: boolean): void => {\n\t\t\t\tconst detachId = this.modularBuilder.generateId();\n\t\t\t\tlet fillId: ChangesetLocalId | undefined;\n\t\t\t\tconst edits: EditDescription[] = [];\n\t\t\t\tlet optionalChange: OptionalChangeset;\n\t\t\t\tif (newContent !== undefined) {\n\t\t\t\t\tfillId = this.modularBuilder.generateId();\n\t\t\t\t\tconst build = this.modularBuilder.buildTrees(fillId, [newContent]);\n\t\t\t\t\tedits.push(build);\n\n\t\t\t\t\toptionalChange = optional.changeHandler.editor.set(wasEmpty, {\n\t\t\t\t\t\tfill: fillId,\n\t\t\t\t\t\tdetach: detachId,\n\t\t\t\t\t});\n\t\t\t\t} else {\n\t\t\t\t\toptionalChange = optional.changeHandler.editor.clear(wasEmpty, detachId);\n\t\t\t\t}\n\n\t\t\t\tconst change: FieldChangeset = brand(optionalChange);\n\t\t\t\tconst edit: FieldEditDescription = {\n\t\t\t\t\ttype: \"field\",\n\t\t\t\t\tfield,\n\t\t\t\t\tfieldKind: optional.identifier,\n\t\t\t\t\tchange,\n\t\t\t\t};\n\t\t\t\tedits.push(edit);\n\n\t\t\t\tthis.modularBuilder.submitChanges(\n\t\t\t\t\tedits,\n\t\t\t\t\tnewContent === undefined ? detachId : fillId,\n\t\t\t\t);\n\t\t\t},\n\t\t};\n\t}\n\n\tpublic move(\n\t\tsourceField: FieldUpPath,\n\t\tsourceIndex: number,\n\t\tcount: number,\n\t\tdestinationField: FieldUpPath,\n\t\tdestIndex: number,\n\t): void {\n\t\tconst moveId = this.modularBuilder.generateId(count);\n\t\tif (compareFieldUpPaths(sourceField, destinationField)) {\n\t\t\tconst change = sequence.changeHandler.editor.move(\n\t\t\t\tsourceIndex,\n\t\t\t\tcount,\n\t\t\t\tdestIndex,\n\t\t\t\tmoveId,\n\t\t\t);\n\t\t\tthis.modularBuilder.submitChange(sourceField, sequence.identifier, brand(change));\n\t\t} else {\n\t\t\tconst detachPath = topDownPath(sourceField.parent);\n\t\t\tconst attachPath = topDownPath(destinationField.parent);\n\t\t\tconst sharedDepth = getSharedPrefixLength(detachPath, attachPath);\n\t\t\tlet adjustedAttachField = destinationField;\n\t\t\t// After the above loop, `sharedDepth` is the number of elements, starting from the root,\n\t\t\t// that both paths have in common.\n\t\t\tif (sharedDepth === detachPath.length) {\n\t\t\t\tconst attachField = attachPath[sharedDepth]?.parentField ?? destinationField.field;\n\t\t\t\tif (attachField === sourceField.field) {\n\t\t\t\t\t// The detach occurs in an ancestor field of the field where the attach occurs.\n\t\t\t\t\tlet attachAncestorIndex = attachPath[sharedDepth]?.parentIndex ?? sourceIndex;\n\t\t\t\t\tif (attachAncestorIndex < sourceIndex) {\n\t\t\t\t\t\t// The attach path runs through a node located before the detached nodes.\n\t\t\t\t\t\t// No need to adjust the attach path.\n\t\t\t\t\t} else {\n\t\t\t\t\t\tassert(\n\t\t\t\t\t\t\tsourceIndex + count <= attachAncestorIndex,\n\t\t\t\t\t\t\t0x801 /* Invalid move: the destination is below one of the moved elements. */,\n\t\t\t\t\t\t);\n\t\t\t\t\t\t// The attach path runs through a node located after the detached nodes.\n\t\t\t\t\t\t// adjust the index for the node at that depth of the path, so that it is interpreted correctly\n\t\t\t\t\t\t// in the composition performed by `submitChanges`.\n\t\t\t\t\t\tattachAncestorIndex -= count;\n\t\t\t\t\t\tlet parent: UpPath | undefined = attachPath[sharedDepth - 1];\n\t\t\t\t\t\tparent = {\n\t\t\t\t\t\t\tparent,\n\t\t\t\t\t\t\tparentIndex: attachAncestorIndex,\n\t\t\t\t\t\t\tparentField: attachPath[sharedDepth].parentField,\n\t\t\t\t\t\t};\n\t\t\t\t\t\tfor (let i = sharedDepth + 1; i < attachPath.length; i += 1) {\n\t\t\t\t\t\t\tparent = {\n\t\t\t\t\t\t\t\t...attachPath[i],\n\t\t\t\t\t\t\t\tparent,\n\t\t\t\t\t\t\t};\n\t\t\t\t\t\t}\n\t\t\t\t\t\tadjustedAttachField = { parent, field: destinationField.field };\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst moveOut = sequence.changeHandler.editor.moveOut(sourceIndex, count, moveId);\n\t\t\tconst moveIn = sequence.changeHandler.editor.moveIn(destIndex, count, moveId);\n\t\t\tthis.modularBuilder.submitChanges(\n\t\t\t\t[\n\t\t\t\t\t{\n\t\t\t\t\t\ttype: \"field\",\n\t\t\t\t\t\tfield: sourceField,\n\t\t\t\t\t\tfieldKind: sequence.identifier,\n\t\t\t\t\t\tchange: brand(moveOut),\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\ttype: \"field\",\n\t\t\t\t\t\tfield: adjustedAttachField,\n\t\t\t\t\t\tfieldKind: sequence.identifier,\n\t\t\t\t\t\tchange: brand(moveIn),\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t\tmoveId,\n\t\t\t);\n\t\t}\n\t}\n\n\tpublic sequenceField(field: FieldUpPath): SequenceFieldEditBuilder {\n\t\treturn {\n\t\t\tinsert: (index: number, newContent: ITreeCursor | readonly ITreeCursor[]): void => {\n\t\t\t\tconst content = isReadonlyArray(newContent) ? newContent : [newContent];\n\t\t\t\tconst length = content.length;\n\t\t\t\tif (length === 0) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tconst firstId = this.modularBuilder.generateId(length);\n\t\t\t\tconst build = this.modularBuilder.buildTrees(firstId, content);\n\t\t\t\tconst change: FieldChangeset = brand(\n\t\t\t\t\tsequence.changeHandler.editor.insert(index, length, firstId),\n\t\t\t\t);\n\t\t\t\tconst attach: FieldEditDescription = {\n\t\t\t\t\ttype: \"field\",\n\t\t\t\t\tfield,\n\t\t\t\t\tfieldKind: sequence.identifier,\n\t\t\t\t\tchange,\n\t\t\t\t};\n\t\t\t\t// The changes have to be submitted together, otherwise they will be assigned different revisions,\n\t\t\t\t// which will prevent the build ID and the insert ID from matching.\n\t\t\t\tthis.modularBuilder.submitChanges(\n\t\t\t\t\t[build, attach],\n\t\t\t\t\tbrand((firstId as number) + length - 1),\n\t\t\t\t);\n\t\t\t},\n\t\t\tdelete: (index: number, count: number): void => {\n\t\t\t\tif (count === 0) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tconst id = this.modularBuilder.generateId(count);\n\t\t\t\tconst change: FieldChangeset = brand(\n\t\t\t\t\tsequence.changeHandler.editor.delete(index, count, id),\n\t\t\t\t);\n\t\t\t\tthis.modularBuilder.submitChange(field, sequence.identifier, change);\n\t\t\t},\n\t\t\tmove: (sourceIndex: number, count: number, destIndex: number): void => {\n\t\t\t\tconst moveId = this.modularBuilder.generateId(count);\n\t\t\t\tconst change = sequence.changeHandler.editor.move(\n\t\t\t\t\tsourceIndex,\n\t\t\t\t\tcount,\n\t\t\t\t\tdestIndex,\n\t\t\t\t\tmoveId,\n\t\t\t\t);\n\t\t\t\tthis.modularBuilder.submitChange(field, sequence.identifier, brand(change));\n\t\t\t},\n\t\t};\n\t}\n}\n\n/**\n * @internal\n */\nexport interface ValueFieldEditBuilder {\n\t/**\n\t * Issues a change which replaces the current newContent of the field with `newContent`.\n\t * @param newContent - the new content for the field. Must be in Nodes mode.\n\t */\n\tset(newContent: ITreeCursor): void;\n}\n\n/**\n * @internal\n */\nexport interface OptionalFieldEditBuilder {\n\t/**\n\t * Issues a change which replaces the current newContent of the field with `newContent`\n\t * @param newContent - the new content for the field. Must be in Nodes mode.\n\t * @param wasEmpty - whether the field is empty when creating this change\n\t */\n\tset(newContent: ITreeCursor | undefined, wasEmpty: boolean): void;\n}\n\n/**\n * @internal\n */\nexport interface SequenceFieldEditBuilder {\n\t/**\n\t * Issues a change which inserts the `newContent` at the given `index`.\n\t * @param index - the index at which to insert the `newContent`.\n\t * @param newContent - the new content to be inserted in the field. Cursors must be in Nodes mode.\n\t */\n\tinsert(index: number, newContent: ITreeCursor | readonly ITreeCursor[]): void;\n\n\t/**\n\t * Issues a change which deletes `count` elements starting at the given `index`.\n\t * @param index - The index of the first deleted element.\n\t * @param count - The number of elements to delete.\n\t */\n\tdelete(index: number, count: number): void;\n\n\t/**\n\t * Issues a change which moves `count` elements starting at `sourceIndex` to `destIndex`.\n\t * @param sourceIndex - the index of the first moved element.\n\t * @param count - the number of elements to move.\n\t * @param destIndex - the index the elements are moved to, interpreted before detaching the moved elements.\n\t */\n\tmove(sourceIndex: number, count: number, destIndex: number): void;\n}\n\n/**\n * @returns The number of path elements that both paths share, starting at index 0.\n */\nfunction getSharedPrefixLength(pathA: readonly UpPath[], pathB: readonly UpPath[]): number {\n\tconst minDepth = Math.min(pathA.length, pathB.length);\n\tlet sharedDepth = 0;\n\twhile (sharedDepth < minDepth) {\n\t\tconst detachStep = pathA[sharedDepth];\n\t\tconst attachStep = pathB[sharedDepth];\n\t\tif (detachStep !== attachStep) {\n\t\t\tif (\n\t\t\t\tdetachStep.parentField !== attachStep.parentField ||\n\t\t\t\tdetachStep.parentIndex !== attachStep.parentIndex\n\t\t\t) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t\tsharedDepth += 1;\n\t}\n\treturn sharedDepth;\n}\n"]}

package/dist/feature-libraries/default-schema/defaultFieldKinds.d.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FieldKindIdentifier, forbiddenFieldKindIdentifier, ChangesetLocalId } from "../../core";
+import { FieldKind, FieldChangeHandler, FieldEditor, FieldKindWithEditor } from "../modular-schema";
+import { OptionalChangeset } from "../optional-field";
+import { Multiplicity } from "../multiplicity";
+/**
+ * ChangeHandler that only handles no-op / identity changes.
+ */
+export declare const noChangeHandler: FieldChangeHandler<0>;
+export interface ValueFieldEditor extends FieldEditor<OptionalChangeset> {
+    /**
+     * Creates a change which replaces the current value of the field with `newValue`.
+     * @param newContent - the new content for the field
+     * @param changeId - the ID associated with the replacement of the current content.
+     * @param buildId - the ID associated with the creation of the `newContent`.
+     */
+    set(ids: {
+        fill: ChangesetLocalId;
+        detach: ChangesetLocalId;
+    }): OptionalChangeset;
+}
+/**
+ * 0 or 1 items.
+ */
+export declare const optional: FieldKindWithEditor<import("../optional-field/optionalField").OptionalFieldEditor, Multiplicity.Optional, "Optional">;
+export declare const valueFieldEditor: ValueFieldEditor;
+export declare const valueChangeHandler: FieldChangeHandler<OptionalChangeset, ValueFieldEditor>;
+/**
+ * Exactly one item.
+ */
+export declare const required: FieldKindWithEditor<ValueFieldEditor, Multiplicity.Single, "Value">;
+/**
+ * 0 or more items.
+ */
+export declare const sequence: FieldKindWithEditor<import("../sequence-field").SequenceFieldEditor, Multiplicity.Sequence, "Sequence">;
+/**
+ * Exactly one identifier.
+ */
+export declare const nodeKey: FieldKindWithEditor<FieldEditor<0>, Multiplicity.Single, "NodeKey">;
+/**
+ * Exactly 0 items.
+ *
+ * Using Forbidden makes what types are listed for allowed in a field irrelevant
+ * since the field will never have values in it.
+ *
+ * Using Forbidden is equivalent to picking a kind that permits empty (like sequence or optional)
+ * and having no allowed types (or only never types).
+ * Because of this, its possible to express everything constraint wise without Forbidden,
+ * but using Forbidden can be more semantically clear than optional with no allowed types.
+ *
+ * For view schema, this can be useful if you need to:
+ * - run a specific out of schema handler when a field is present,
+ * but otherwise are ignoring or tolerating (ex: via extra fields) unmentioned fields.
+ * - prevent a specific field from being used as an extra field
+ * (perhaps for some past of future compatibility reason)
+ * - keep a field in a schema for metadata purposes
+ * (ex: for improved error messaging, error handling or documentation)
+ * that is not used in this specific version of the schema (ex: to document what it was or will be used for).
+ *
+ * For stored schema, this can be useful if you need to:
+ * - have a field which can have its schema updated to Optional or Sequence of any type.
+ * - to exclude a field from extra fields
+ * - for the schema system to use as a default for fields which aren't declared
+ * (ex: when updating a field that did not exist into one that does)
+ *
+ * See {@link emptyField} for a constant, reusable field using Forbidden.
+ */
+export declare const forbidden: FieldKindWithEditor<FieldEditor<0>, Multiplicity.Forbidden, "Forbidden">;
+/**
+ * Default field kinds by identifier
+ */
+export declare const fieldKinds: ReadonlyMap<FieldKindIdentifier, FieldKindWithEditor>;
+/**
+ * @internal
+ */
+export interface Required extends FieldKind<"Value", Multiplicity.Single> {
+}
+/**
+ * @internal
+ */
+export interface Optional extends FieldKind<"Optional", Multiplicity.Optional> {
+}
+/**
+ * @internal
+ */
+export interface Sequence extends FieldKind<"Sequence", Multiplicity.Sequence> {
+}
+/**
+ * @internal
+ */
+export interface NodeKeyFieldKind extends FieldKind<"NodeKey", Multiplicity.Single> {
+}
+/**
+ * @internal
+ */
+export interface Forbidden extends FieldKind<typeof forbiddenFieldKindIdentifier, Multiplicity.Forbidden> {
+}
+/**
+ * Default FieldKinds with their editor types erased.
+ * @internal
+ */
+export declare const FieldKinds: {
+    readonly required: Required;
+    readonly optional: Optional;
+    readonly sequence: Sequence;
+    readonly nodeKey: NodeKeyFieldKind;
+    readonly forbidden: Forbidden;
+};
+//# sourceMappingURL=defaultFieldKinds.d.ts.map

package/dist/feature-libraries/default-schema/defaultFieldKinds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultFieldKinds.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultFieldKinds.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAGhB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACN,SAAS,EAGT,kBAAkB,EAClB,WAAW,EAEX,mBAAmB,EACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAEN,iBAAiB,EAGjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,kBAAkB,CAAC,CAAC,CAWjD,CAAC;AAEF,MAAM,WAAW,gBAAiB,SAAQ,WAAW,CAAC,iBAAiB,CAAC;IACvE;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,gBAAgB,CAAC;QAAC,MAAM,EAAE,gBAAgB,CAAA;KAAE,GAAG,iBAAiB,CAAC;CAClF;AAGD;;GAEG;AACH,eAAO,MAAM,QAAQ,uHASpB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,gBAI9B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,kBAAkB,CAAC,iBAAiB,EAAE,gBAAgB,CAGtF,CAAC;AAIF;;GAEG;AACH,eAAO,MAAM,QAAQ,qEAWpB,CAAC;AAIF;;GAEG;AACH,eAAO,MAAM,QAAQ,yGASpB,CAAC;AAIF;;GAEG;AACH,eAAO,MAAM,OAAO,qEAWnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,SAAS,0EAOrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,mBAAmB,EAAE,mBAAmB,CAE5E,CAAC;AAOF;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC;CAAG;AAC5E;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,QAAQ,CAAC;CAAG;AACjF;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,QAAQ,CAAC;CAAG;AACjF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC;CAAG;AACtF;;GAEG;AACH,MAAM,WAAW,SAChB,SAAQ,SAAS,CAAC,OAAO,4BAA4B,EAAE,YAAY,CAAC,SAAS,CAAC;CAAG;AAElF;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE;IAExB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CACyB,CAAC"}