@fluid-experimental/tree 0.58.2002 → 0.59.1000

package/dist/HistoryEditFactory.js

@@ -0,0 +1,226 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revert = void 0;
+const Identifiers_1 = require("./Identifiers");
+const Common_1 = require("./Common");
+const TreeViewUtilities_1 = require("./TreeViewUtilities");
+const persisted_types_1 = require("./persisted-types");
+const TransactionInternal_1 = require("./TransactionInternal");
+const EditUtilities_1 = require("./EditUtilities");
+const SerializationUtilities_1 = require("./SerializationUtilities");
+/**
+ * Given a sequence of changes, produces an inverse sequence of changes, i.e. the minimal changes required to revert the given changes
+ * @param changes - the changes for which to produce an inverse.
+ * @param before - a view of the tree state before `changes` are/were applied - used as a basis for generating the inverse.
+ * @returns if the changes could be reverted, a sequence of changes _r_ that will produce `before` if applied to a view _A_, where _A_ is the result of
+ * applying `changes` to `before`. Applying _r_ to views other than _A_ is legal but may cause the changes to fail to apply or may
+ * not be a true semantic inverse. If the changes could not be reverted given the state of `before`, returns undefined.
+ *
+ * TODO: what should this do if `changes` fails to apply to `before`?
+ * TODO:#68574: Pass a view that corresponds to the appropriate Fluid reference sequence number rather than the view just before
+ * @internal
+ */
+function revert(changes, before) {
+    const result = [];
+    const builtNodes = new Map();
+    const detachedNodes = new Map();
+    // Open edit on revision to update it as changes are walked through
+    const editor = TransactionInternal_1.TransactionInternal.factory(before);
+    // Apply `edit`, generating an inverse as we go.
+    for (const change of changes) {
+        // Generate an inverse of each change
+        switch (change.type) {
+            case persisted_types_1.ChangeTypeInternal.Build: {
+                // Save nodes added to the detached state for use in future changes
+                const { destination, source } = change;
+                Common_1.assert(!builtNodes.has(destination), `Cannot revert Build: destination is already used by a Build`);
+                Common_1.assert(!detachedNodes.has(destination), `Cannot revert Build: destination is already used by a Detach`);
+                builtNodes.set(destination, source.reduce((ids, curr) => {
+                    var _a;
+                    if (Identifiers_1.isDetachedSequenceId(curr)) {
+                        const nodesForDetachedSequence = (_a = builtNodes.get(curr)) !== null && _a !== void 0 ? _a : Common_1.fail('detached sequence must have associated built nodes');
+                        ids.push(...nodesForDetachedSequence);
+                    }
+                    else {
+                        ids.push(curr.identifier);
+                    }
+                    return ids;
+                }, []));
+                break;
+            }
+            case persisted_types_1.ChangeTypeInternal.Insert: {
+                const { source } = change;
+                const nodesBuilt = builtNodes.get(source);
+                const nodesDetached = detachedNodes.get(source);
+                if (nodesBuilt !== undefined) {
+                    result.unshift(createInvertedInsert(change, nodesBuilt));
+                    builtNodes.delete(source);
+                }
+                else if (nodesDetached !== undefined) {
+                    result.unshift(createInvertedInsert(change, nodesDetached, true));
+                    detachedNodes.delete(source);
+                }
+                else {
+                    // Cannot revert an insert whose source is no longer available for inserting (i.e. not just built, and not detached)
+                    return undefined;
+                }
+                break;
+            }
+            case persisted_types_1.ChangeTypeInternal.Detach: {
+                const { destination } = change;
+                const invert = createInvertedDetach(change, editor.view);
+                if (invert === undefined) {
+                    // Cannot revert a detach whose source does not exist in the tree
+                    // TODO:68574: May not be possible once associated todo in `createInvertedDetach` is addressed
+                    return undefined;
+                }
+                const { invertedDetach, detachedNodeIds } = invert;
+                if (destination !== undefined) {
+                    if (builtNodes.has(destination) || detachedNodes.has(destination)) {
+                        // Malformed: destination was already used by a prior build or detach
+                        return undefined;
+                    }
+                    detachedNodes.set(destination, detachedNodeIds);
+                }
+                result.unshift(...invertedDetach);
+                break;
+            }
+            case persisted_types_1.ChangeTypeInternal.SetValue: {
+                const invert = createInvertedSetValue(change, editor.view);
+                if (invert === undefined) {
+                    // Cannot revert a set for a node that does not exist in the tree
+                    // TODO:68574: May not be possible once associated todo in `createInvertedSetValue` is addressed
+                    return undefined;
+                }
+                result.unshift(...invert);
+                break;
+            }
+            case persisted_types_1.ChangeTypeInternal.Constraint:
+                // TODO:#46759: Support Constraint in reverts
+                Common_1.fail('Revert currently does not support Constraints');
+            default:
+                Common_1.fail('Revert does not support the change type.');
+        }
+        // Update the revision
+        editor.applyChange(change);
+    }
+    editor.close();
+    return result;
+}
+exports.revert = revert;
+/**
+ * The inverse of an Insert is a Detach that starts before the leftmost node inserted and ends after the rightmost.
+ */
+function createInvertedInsert(insert, nodesInserted, saveDetached = false) {
+    const leftmostNode = nodesInserted[0];
+    const rightmostNode = nodesInserted[nodesInserted.length - 1];
+    const source = {
+        start: {
+            referenceSibling: leftmostNode,
+            side: persisted_types_1.Side.Before,
+        },
+        end: {
+            referenceSibling: rightmostNode,
+            side: persisted_types_1.Side.After,
+        },
+    };
+    return persisted_types_1.ChangeInternal.detach(source, saveDetached ? insert.source : undefined);
+}
+/**
+ * If a detach does not include a destination, its inverse is a build and insert. Otherwise, it is just an insert.
+ * Information on the nodes that were detached is obtained by going to the revision before the detach.
+ *
+ * The anchor for the resulting Insert is chosen in the following order:
+ *     1. If detach.source.start.side is After: detach.source.start
+ *
+ *        ex: For nodes A B [C..F] G H where [C..F] represents the detached nodes,
+ *            if detach.source.start is "After B", the anchor for the resulting Insert will also be "After B".
+ *
+ *            For nodes [A..F] G H where [A..F] represents the detached nodes,
+ *            if detach.source.start is "After start of trait", the anchor for the resulting Insert will also be "After start of trait".
+ *
+ *     2. Else if detach.source.end.side is Before: detach.source.end
+ *
+ *        ex: For nodes A B [C..F] G H where [C..F] represents the detached nodes,
+ *            if detach.source.start is "Before C" and detach.source.end is "Before G",
+ *            the anchor for the resulting Insert will be "Before G".
+ *
+ *     3. Else: After the node directly to the left of the originally detached nodes
+ *
+ *        ex: For nodes A B [C..F] G H where [C..F] represents the detached nodes,
+ *            if detach.source.start is "Before C" and detach.source.end is "After F",
+ *            the anchor for the resulting Insert will be "After B".
+ *
+ *  When choosing the anchor, the existing anchors on detach.source are preferred when they have a valid sibling. Otherwise, the valid
+ *  anchor to the left of the originally detached nodes is chosen.
+ */
+function createInvertedDetach(detach, viewBeforeChange) {
+    const validatedSource = EditUtilities_1.validateStableRange(viewBeforeChange, detach.source);
+    if (validatedSource.result !== EditUtilities_1.RangeValidationResultKind.Valid) {
+        // TODO:#68574: having the reference view would potentially allow us to revert some detaches that currently conflict
+        return undefined;
+    }
+    const { start, end } = TreeViewUtilities_1.rangeFromStableRange(viewBeforeChange, validatedSource);
+    const { trait: referenceTrait } = start;
+    const nodes = viewBeforeChange.getTrait(referenceTrait);
+    const startIndex = viewBeforeChange.findIndexWithinTrait(start);
+    const endIndex = viewBeforeChange.findIndexWithinTrait(end);
+    const detachedNodeIds = nodes.slice(startIndex, endIndex);
+    const leftOfDetached = nodes.slice(0, startIndex);
+    let insertDestination;
+    if (start.side === persisted_types_1.Side.After) {
+        insertDestination =
+            start.sibling === undefined
+                ? { side: persisted_types_1.Side.After, referenceTrait }
+                : { side: persisted_types_1.Side.After, referenceSibling: start.sibling };
+    }
+    else if (end.side === persisted_types_1.Side.Before) {
+        insertDestination =
+            end.sibling === undefined
+                ? { side: persisted_types_1.Side.Before, referenceTrait }
+                : { side: persisted_types_1.Side.Before, referenceSibling: end.sibling };
+    }
+    else {
+        const referenceSibling = leftOfDetached.pop();
+        insertDestination = {
+            side: persisted_types_1.Side.After,
+            referenceSibling,
+            referenceTrait: referenceSibling === undefined ? referenceTrait : undefined,
+        };
+    }
+    if (detach.destination !== undefined) {
+        return {
+            invertedDetach: [persisted_types_1.ChangeInternal.insert(detach.destination, insertDestination)],
+            detachedNodeIds,
+        };
+    }
+    const detachedSequenceId = 0;
+    return {
+        invertedDetach: [
+            persisted_types_1.ChangeInternal.build(detachedNodeIds.map((id) => SerializationUtilities_1.getChangeNodeFromViewNode(viewBeforeChange, id)), detachedSequenceId),
+            persisted_types_1.ChangeInternal.insert(detachedSequenceId, insertDestination),
+        ],
+        detachedNodeIds,
+    };
+}
+/**
+ * The inverse of a SetValue is a SetValue that sets the value to what it was prior to the change.
+ */
+function createInvertedSetValue(setValue, viewBeforeChange) {
+    const { nodeToModify } = setValue;
+    const node = viewBeforeChange.tryGetViewNode(nodeToModify);
+    if (node === undefined) {
+        // TODO:68574: With a reference view, may be able to better resolve conflicting sets
+        return undefined;
+    }
+    // Rationale: 'undefined' is reserved for future use (see 'SetValue' interface)
+    if (node.payload !== null) {
+        return [persisted_types_1.ChangeInternal.setPayload(nodeToModify, node.payload)];
+    }
+    return [persisted_types_1.ChangeInternal.clearPayload(nodeToModify)];
+}
+//# sourceMappingURL=HistoryEditFactory.js.map

package/dist/HistoryEditFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HistoryEditFactory.js","sourceRoot":"","sources":["../src/HistoryEditFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+CAAiF;AACjF,qCAAwC;AACxC,2DAA2D;AAC3D,uDAS2B;AAC3B,+DAA4D;AAC5D,mDAAiF;AAIjF,qEAAqE;AAErE;;;;;;;;;;;GAWG;AACH,SAAgB,MAAM,CAAC,OAAkC,EAAE,MAAoB;IAC9E,MAAM,MAAM,GAAqB,EAAE,CAAC;IAEpC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAgC,CAAC;IAC3D,MAAM,aAAa,GAAG,IAAI,GAAG,EAAgC,CAAC;IAE9D,mEAAmE;IACnE,MAAM,MAAM,GAAG,yCAAmB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,gDAAgD;IAChD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC7B,qCAAqC;QACrC,QAAQ,MAAM,CAAC,IAAI,EAAE;YACpB,KAAK,oCAAkB,CAAC,KAAK,CAAC,CAAC;gBAC9B,mEAAmE;gBACnE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;gBACvC,eAAM,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,6DAA6D,CAAC,CAAC;gBACpG,eAAM,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,8DAA8D,CAAC,CAAC;gBACxG,UAAU,CAAC,GAAG,CACb,WAAW,EACX,MAAM,CAAC,MAAM,CAAC,CAAC,GAAa,EAAE,IAAuB,EAAE,EAAE;;oBACxD,IAAI,kCAAoB,CAAC,IAAI,CAAC,EAAE;wBAC/B,MAAM,wBAAwB,SAC7B,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,aAAI,CAAC,oDAAoD,CAAC,CAAC;wBAEpF,GAAG,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,CAAC;qBACtC;yBAAM;wBACN,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;qBAC1B;oBACD,OAAO,GAAG,CAAC;gBACZ,CAAC,EAAE,EAAE,CAAC,CACN,CAAC;gBACF,MAAM;aACN;YACD,KAAK,oCAAkB,CAAC,MAAM,CAAC,CAAC;gBAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;gBAC1B,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAEhD,IAAI,UAAU,KAAK,SAAS,EAAE;oBAC7B,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;oBACzD,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;iBAC1B;qBAAM,IAAI,aAAa,KAAK,SAAS,EAAE;oBACvC,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;oBAClE,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;iBAC7B;qBAAM;oBACN,oHAAoH;oBACpH,OAAO,SAAS,CAAC;iBACjB;gBAED,MAAM;aACN;YACD,KAAK,oCAAkB,CAAC,MAAM,CAAC,CAAC;gBAC/B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;gBAC/B,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;gBACzD,IAAI,MAAM,KAAK,SAAS,EAAE;oBACzB,iEAAiE;oBACjE,8FAA8F;oBAC9F,OAAO,SAAS,CAAC;iBACjB;gBACD,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;gBAEnD,IAAI,WAAW,KAAK,SAAS,EAAE;oBAC9B,IAAI,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;wBAClE,qEAAqE;wBACrE,OAAO,SAAS,CAAC;qBACjB;oBACD,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;iBAChD;gBAED,MAAM,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,CAAC;gBAClC,MAAM;aACN;YACD,KAAK,oCAAkB,CAAC,QAAQ,CAAC,CAAC;gBACjC,MAAM,MAAM,GAAG,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3D,IAAI,MAAM,KAAK,SAAS,EAAE;oBACzB,iEAAiE;oBACjE,gGAAgG;oBAChG,OAAO,SAAS,CAAC;iBACjB;gBACD,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC;gBAC1B,MAAM;aACN;YACD,KAAK,oCAAkB,CAAC,UAAU;gBACjC,6CAA6C;gBAC7C,aAAI,CAAC,+CAA+C,CAAC,CAAC;YACvD;gBACC,aAAI,CAAC,0CAA0C,CAAC,CAAC;SAClD;QAED,sBAAsB;QACtB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;KAC3B;IAED,MAAM,CAAC,KAAK,EAAE,CAAC;IACf,OAAO,MAAM,CAAC;AACf,CAAC;AA/FD,wBA+FC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAC5B,MAAsB,EACtB,aAAgC,EAChC,YAAY,GAAG,KAAK;IAEpB,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE9D,MAAM,MAAM,GAAwB;QACnC,KAAK,EAAE;YACN,gBAAgB,EAAE,YAAY;YAC9B,IAAI,EAAE,sBAAI,CAAC,MAAM;SACjB;QACD,GAAG,EAAE;YACJ,gBAAgB,EAAE,aAAa;YAC/B,IAAI,EAAE,sBAAI,CAAC,KAAK;SAChB;KACD,CAAC;IAEF,OAAO,gCAAc,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAS,oBAAoB,CAC5B,MAAsB,EACtB,gBAA0B;IAE1B,MAAM,eAAe,GAAG,mCAAmB,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7E,IAAI,eAAe,CAAC,MAAM,KAAK,yCAAyB,CAAC,KAAK,EAAE;QAC/D,oHAAoH;QACpH,OAAO,SAAS,CAAC;KACjB;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,wCAAoB,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAC/E,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IACxC,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAExD,MAAM,UAAU,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAChE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC5D,MAAM,eAAe,GAAa,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEpE,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;IAElD,IAAI,iBAA8B,CAAC;IAEnC,IAAI,KAAK,CAAC,IAAI,KAAK,sBAAI,CAAC,KAAK,EAAE;QAC9B,iBAAiB;YAChB,KAAK,CAAC,OAAO,KAAK,SAAS;gBAC1B,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,KAAK,EAAE,cAAc,EAAE;gBACtC,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;KAC1D;SAAM,IAAI,GAAG,CAAC,IAAI,KAAK,sBAAI,CAAC,MAAM,EAAE;QACpC,iBAAiB;YAChB,GAAG,CAAC,OAAO,KAAK,SAAS;gBACxB,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,MAAM,EAAE,cAAc,EAAE;gBACvC,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;KACzD;SAAM;QACN,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;QAC9C,iBAAiB,GAAG;YACnB,IAAI,EAAE,sBAAI,CAAC,KAAK;YAChB,gBAAgB;YAChB,cAAc,EAAE,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;SAC3E,CAAC;KACF;IAED,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE;QACrC,OAAO;YACN,cAAc,EAAE,CAAC,gCAAc,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;YAC9E,eAAe;SACf,CAAC;KACF;IAED,MAAM,kBAAkB,GAAG,CAAuB,CAAC;IACnD,OAAO;QACN,cAAc,EAAE;YACf,gCAAc,CAAC,KAAK,CACnB,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,kDAAyB,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,EAC5E,kBAAkB,CAClB;YACD,gCAAc,CAAC,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;SAC5D;QACD,eAAe;KACf,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,QAA0B,EAAE,gBAA0B;IACrF,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC;IAClC,MAAM,IAAI,GAAG,gBAAgB,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IAC3D,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,oFAAoF;QACpF,OAAO,SAAS,CAAC;KACjB;IAED,+EAA+E;IAC/E,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;QAC1B,OAAO,CAAC,gCAAc,CAAC,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;KAC/D;IACD,OAAO,CAAC,gCAAc,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;AACpD,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DetachedSequenceId, isDetachedSequenceId, NodeId } from './Identifiers';\nimport { assert, fail } from './Common';\nimport { rangeFromStableRange } from './TreeViewUtilities';\nimport {\n\tChangeInternal,\n\tChangeTypeInternal,\n\tDetachInternal,\n\tSetValueInternal,\n\tInsertInternal,\n\tBuildNodeInternal,\n\tSide,\n\tStableRangeInternal,\n} from './persisted-types';\nimport { TransactionInternal } from './TransactionInternal';\nimport { RangeValidationResultKind, validateStableRange } from './EditUtilities';\nimport { StablePlace } from './ChangeTypes';\nimport { RevisionView } from './RevisionView';\nimport { TreeView } from './TreeView';\nimport { getChangeNodeFromViewNode } from './SerializationUtilities';\n\n/**\n * Given a sequence of changes, produces an inverse sequence of changes, i.e. the minimal changes required to revert the given changes\n * @param changes - the changes for which to produce an inverse.\n * @param before - a view of the tree state before `changes` are/were applied - used as a basis for generating the inverse.\n * @returns if the changes could be reverted, a sequence of changes _r_ that will produce `before` if applied to a view _A_, where _A_ is the result of\n * applying `changes` to `before`. Applying _r_ to views other than _A_ is legal but may cause the changes to fail to apply or may\n * not be a true semantic inverse. If the changes could not be reverted given the state of `before`, returns undefined.\n *\n * TODO: what should this do if `changes` fails to apply to `before`?\n * TODO:#68574: Pass a view that corresponds to the appropriate Fluid reference sequence number rather than the view just before\n * @internal\n */\nexport function revert(changes: readonly ChangeInternal[], before: RevisionView): ChangeInternal[] | undefined {\n\tconst result: ChangeInternal[] = [];\n\n\tconst builtNodes = new Map<DetachedSequenceId, NodeId[]>();\n\tconst detachedNodes = new Map<DetachedSequenceId, NodeId[]>();\n\n\t// Open edit on revision to update it as changes are walked through\n\tconst editor = TransactionInternal.factory(before);\n\t// Apply `edit`, generating an inverse as we go.\n\tfor (const change of changes) {\n\t\t// Generate an inverse of each change\n\t\tswitch (change.type) {\n\t\t\tcase ChangeTypeInternal.Build: {\n\t\t\t\t// Save nodes added to the detached state for use in future changes\n\t\t\t\tconst { destination, source } = change;\n\t\t\t\tassert(!builtNodes.has(destination), `Cannot revert Build: destination is already used by a Build`);\n\t\t\t\tassert(!detachedNodes.has(destination), `Cannot revert Build: destination is already used by a Detach`);\n\t\t\t\tbuiltNodes.set(\n\t\t\t\t\tdestination,\n\t\t\t\t\tsource.reduce((ids: NodeId[], curr: BuildNodeInternal) => {\n\t\t\t\t\t\tif (isDetachedSequenceId(curr)) {\n\t\t\t\t\t\t\tconst nodesForDetachedSequence =\n\t\t\t\t\t\t\t\tbuiltNodes.get(curr) ?? fail('detached sequence must have associated built nodes');\n\n\t\t\t\t\t\t\tids.push(...nodesForDetachedSequence);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tids.push(curr.identifier);\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn ids;\n\t\t\t\t\t}, [])\n\t\t\t\t);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase ChangeTypeInternal.Insert: {\n\t\t\t\tconst { source } = change;\n\t\t\t\tconst nodesBuilt = builtNodes.get(source);\n\t\t\t\tconst nodesDetached = detachedNodes.get(source);\n\n\t\t\t\tif (nodesBuilt !== undefined) {\n\t\t\t\t\tresult.unshift(createInvertedInsert(change, nodesBuilt));\n\t\t\t\t\tbuiltNodes.delete(source);\n\t\t\t\t} else if (nodesDetached !== undefined) {\n\t\t\t\t\tresult.unshift(createInvertedInsert(change, nodesDetached, true));\n\t\t\t\t\tdetachedNodes.delete(source);\n\t\t\t\t} else {\n\t\t\t\t\t// Cannot revert an insert whose source is no longer available for inserting (i.e. not just built, and not detached)\n\t\t\t\t\treturn undefined;\n\t\t\t\t}\n\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase ChangeTypeInternal.Detach: {\n\t\t\t\tconst { destination } = change;\n\t\t\t\tconst invert = createInvertedDetach(change, editor.view);\n\t\t\t\tif (invert === undefined) {\n\t\t\t\t\t// Cannot revert a detach whose source does not exist in the tree\n\t\t\t\t\t// TODO:68574: May not be possible once associated todo in `createInvertedDetach` is addressed\n\t\t\t\t\treturn undefined;\n\t\t\t\t}\n\t\t\t\tconst { invertedDetach, detachedNodeIds } = invert;\n\n\t\t\t\tif (destination !== undefined) {\n\t\t\t\t\tif (builtNodes.has(destination) || detachedNodes.has(destination)) {\n\t\t\t\t\t\t// Malformed: destination was already used by a prior build or detach\n\t\t\t\t\t\treturn undefined;\n\t\t\t\t\t}\n\t\t\t\t\tdetachedNodes.set(destination, detachedNodeIds);\n\t\t\t\t}\n\n\t\t\t\tresult.unshift(...invertedDetach);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase ChangeTypeInternal.SetValue: {\n\t\t\t\tconst invert = createInvertedSetValue(change, editor.view);\n\t\t\t\tif (invert === undefined) {\n\t\t\t\t\t// Cannot revert a set for a node that does not exist in the tree\n\t\t\t\t\t// TODO:68574: May not be possible once associated todo in `createInvertedSetValue` is addressed\n\t\t\t\t\treturn undefined;\n\t\t\t\t}\n\t\t\t\tresult.unshift(...invert);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase ChangeTypeInternal.Constraint:\n\t\t\t\t// TODO:#46759: Support Constraint in reverts\n\t\t\t\tfail('Revert currently does not support Constraints');\n\t\t\tdefault:\n\t\t\t\tfail('Revert does not support the change type.');\n\t\t}\n\n\t\t// Update the revision\n\t\teditor.applyChange(change);\n\t}\n\n\teditor.close();\n\treturn result;\n}\n\n/**\n * The inverse of an Insert is a Detach that starts before the leftmost node inserted and ends after the rightmost.\n */\nfunction createInvertedInsert(\n\tinsert: InsertInternal,\n\tnodesInserted: readonly NodeId[],\n\tsaveDetached = false\n): ChangeInternal {\n\tconst leftmostNode = nodesInserted[0];\n\tconst rightmostNode = nodesInserted[nodesInserted.length - 1];\n\n\tconst source: StableRangeInternal = {\n\t\tstart: {\n\t\t\treferenceSibling: leftmostNode,\n\t\t\tside: Side.Before,\n\t\t},\n\t\tend: {\n\t\t\treferenceSibling: rightmostNode,\n\t\t\tside: Side.After,\n\t\t},\n\t};\n\n\treturn ChangeInternal.detach(source, saveDetached ? insert.source : undefined);\n}\n\n/**\n * If a detach does not include a destination, its inverse is a build and insert. Otherwise, it is just an insert.\n * Information on the nodes that were detached is obtained by going to the revision before the detach.\n *\n * The anchor for the resulting Insert is chosen in the following order:\n *     1. If detach.source.start.side is After: detach.source.start\n *\n *        ex: For nodes A B [C..F] G H where [C..F] represents the detached nodes,\n *            if detach.source.start is \"After B\", the anchor for the resulting Insert will also be \"After B\".\n *\n *            For nodes [A..F] G H where [A..F] represents the detached nodes,\n *            if detach.source.start is \"After start of trait\", the anchor for the resulting Insert will also be \"After start of trait\".\n *\n *     2. Else if detach.source.end.side is Before: detach.source.end\n *\n *        ex: For nodes A B [C..F] G H where [C..F] represents the detached nodes,\n *            if detach.source.start is \"Before C\" and detach.source.end is \"Before G\",\n *            the anchor for the resulting Insert will be \"Before G\".\n *\n *     3. Else: After the node directly to the left of the originally detached nodes\n *\n *        ex: For nodes A B [C..F] G H where [C..F] represents the detached nodes,\n *            if detach.source.start is \"Before C\" and detach.source.end is \"After F\",\n *            the anchor for the resulting Insert will be \"After B\".\n *\n *  When choosing the anchor, the existing anchors on detach.source are preferred when they have a valid sibling. Otherwise, the valid\n *  anchor to the left of the originally detached nodes is chosen.\n */\nfunction createInvertedDetach(\n\tdetach: DetachInternal,\n\tviewBeforeChange: TreeView\n): { invertedDetach: ChangeInternal[]; detachedNodeIds: NodeId[] } | undefined {\n\tconst validatedSource = validateStableRange(viewBeforeChange, detach.source);\n\tif (validatedSource.result !== RangeValidationResultKind.Valid) {\n\t\t// TODO:#68574: having the reference view would potentially allow us to revert some detaches that currently conflict\n\t\treturn undefined;\n\t}\n\n\tconst { start, end } = rangeFromStableRange(viewBeforeChange, validatedSource);\n\tconst { trait: referenceTrait } = start;\n\tconst nodes = viewBeforeChange.getTrait(referenceTrait);\n\n\tconst startIndex = viewBeforeChange.findIndexWithinTrait(start);\n\tconst endIndex = viewBeforeChange.findIndexWithinTrait(end);\n\tconst detachedNodeIds: NodeId[] = nodes.slice(startIndex, endIndex);\n\n\tconst leftOfDetached = nodes.slice(0, startIndex);\n\n\tlet insertDestination: StablePlace;\n\n\tif (start.side === Side.After) {\n\t\tinsertDestination =\n\t\t\tstart.sibling === undefined\n\t\t\t\t? { side: Side.After, referenceTrait }\n\t\t\t\t: { side: Side.After, referenceSibling: start.sibling };\n\t} else if (end.side === Side.Before) {\n\t\tinsertDestination =\n\t\t\tend.sibling === undefined\n\t\t\t\t? { side: Side.Before, referenceTrait }\n\t\t\t\t: { side: Side.Before, referenceSibling: end.sibling };\n\t} else {\n\t\tconst referenceSibling = leftOfDetached.pop();\n\t\tinsertDestination = {\n\t\t\tside: Side.After,\n\t\t\treferenceSibling,\n\t\t\treferenceTrait: referenceSibling === undefined ? referenceTrait : undefined,\n\t\t};\n\t}\n\n\tif (detach.destination !== undefined) {\n\t\treturn {\n\t\t\tinvertedDetach: [ChangeInternal.insert(detach.destination, insertDestination)],\n\t\t\tdetachedNodeIds,\n\t\t};\n\t}\n\n\tconst detachedSequenceId = 0 as DetachedSequenceId;\n\treturn {\n\t\tinvertedDetach: [\n\t\t\tChangeInternal.build(\n\t\t\t\tdetachedNodeIds.map((id) => getChangeNodeFromViewNode(viewBeforeChange, id)),\n\t\t\t\tdetachedSequenceId\n\t\t\t),\n\t\t\tChangeInternal.insert(detachedSequenceId, insertDestination),\n\t\t],\n\t\tdetachedNodeIds,\n\t};\n}\n\n/**\n * The inverse of a SetValue is a SetValue that sets the value to what it was prior to the change.\n */\nfunction createInvertedSetValue(setValue: SetValueInternal, viewBeforeChange: TreeView): ChangeInternal[] | undefined {\n\tconst { nodeToModify } = setValue;\n\tconst node = viewBeforeChange.tryGetViewNode(nodeToModify);\n\tif (node === undefined) {\n\t\t// TODO:68574: With a reference view, may be able to better resolve conflicting sets\n\t\treturn undefined;\n\t}\n\n\t// Rationale: 'undefined' is reserved for future use (see 'SetValue' interface)\n\tif (node.payload !== null) {\n\t\treturn [ChangeInternal.setPayload(nodeToModify, node.payload)];\n\t}\n\treturn [ChangeInternal.clearPayload(nodeToModify)];\n}\n"]}

package/dist/IdConversion.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ReplaceRecursive } from './Common';
+import { NodeId } from './Identifiers';
+import { ChangeInternal, Edit, NodeData, StablePlaceInternal, StableRangeInternal } from './persisted-types';
+export declare function convertEditIds<IdFrom, IdTo>(edit: ReplaceRecursive<Edit<ChangeInternal>, NodeId, IdFrom>, convert: (id: IdFrom) => IdTo): Edit<ReplaceRecursive<ChangeInternal, NodeId, IdTo>>;
+export declare function convertNodeDataIds<IdFrom, IdTo>(nodeData: NodeData<IdFrom>, convert: (id: IdFrom) => IdTo): NodeData<IdTo>;
+export declare function convertStableRangeIds<IdFrom, IdTo>(range: ReplaceRecursive<StableRangeInternal, NodeId, IdFrom>, convert: (id: IdFrom) => IdTo): ReplaceRecursive<StableRangeInternal, NodeId, IdTo>;
+export declare function convertStablePlaceIds<IdFrom, IdTo>({ side, referenceSibling, referenceTrait }: ReplaceRecursive<StablePlaceInternal, NodeId, IdFrom>, convert: (id: IdFrom) => IdTo): ReplaceRecursive<StablePlaceInternal, NodeId, IdTo>;
+//# sourceMappingURL=IdConversion.d.ts.map

package/dist/IdConversion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdConversion.d.ts","sourceRoot":"","sources":["../src/IdConversion.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAwC,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAElF,OAAO,EAA4C,MAAM,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAEN,cAAc,EAId,IAAI,EACJ,QAAQ,EACR,mBAAmB,EACnB,mBAAmB,EAEnB,MAAM,mBAAmB,CAAC;AAE3B,wBAAgB,cAAc,CAAC,MAAM,EAAE,IAAI,EAC1C,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAC5D,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,GAC3B,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAyDtD;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,IAAI,EAC9C,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC1B,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,GAC3B,QAAQ,CAAC,IAAI,CAAC,CAKhB;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,IAAI,EACjD,KAAK,EAAE,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,EAAE,MAAM,CAAC,EAC5D,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,GAC3B,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,EAAE,IAAI,CAAC,CAIrD;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,IAAI,EACjD,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,EAAE,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,EAAE,MAAM,CAAC,EACjG,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,GAC3B,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,EAAE,IAAI,CAAC,CAmBrD"}

package/dist/IdConversion.js

@@ -0,0 +1,98 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertStablePlaceIds = exports.convertStableRangeIds = exports.convertNodeDataIds = exports.convertEditIds = void 0;
+const Common_1 = require("./Common");
+const EditUtilities_1 = require("./EditUtilities");
+const Identifiers_1 = require("./Identifiers");
+const persisted_types_1 = require("./persisted-types");
+function convertEditIds(edit, convert) {
+    const changes = edit.changes.map((change) => {
+        switch (change.type) {
+            case persisted_types_1.ChangeTypeInternal.Build:
+                return {
+                    type: persisted_types_1.ChangeTypeInternal.Build,
+                    destination: change.destination,
+                    source: change.source.map((tree) => {
+                        return EditUtilities_1.convertTreeNodes(tree, (node) => convertNodeDataIds(node, convert), Identifiers_1.isDetachedSequenceId);
+                    }),
+                };
+            case persisted_types_1.ChangeTypeInternal.Insert:
+                return {
+                    type: persisted_types_1.ChangeTypeInternal.Insert,
+                    source: change.source,
+                    destination: convertStablePlaceIds(change.destination, convert),
+                };
+            case persisted_types_1.ChangeTypeInternal.Detach: {
+                const detach = {
+                    type: persisted_types_1.ChangeTypeInternal.Detach,
+                    source: convertStableRangeIds(change.source, convert),
+                };
+                Common_1.copyPropertyIfDefined(change, detach, 'destination');
+                return detach;
+            }
+            case persisted_types_1.ChangeTypeInternal.SetValue:
+                return {
+                    type: persisted_types_1.ChangeTypeInternal.SetValue,
+                    nodeToModify: convert(change.nodeToModify),
+                    payload: change.payload,
+                };
+            case persisted_types_1.ChangeTypeInternal.Constraint: {
+                const constraint = {
+                    type: persisted_types_1.ChangeTypeInternal.Constraint,
+                    effect: change.effect,
+                    toConstrain: convertStableRangeIds(change.toConstrain, convert),
+                };
+                Common_1.copyPropertyIfDefined(change, constraint, 'identityHash');
+                Common_1.copyPropertyIfDefined(change, constraint, 'label');
+                Common_1.copyPropertyIfDefined(change, constraint, 'length');
+                Common_1.copyPropertyIfDefined(change, constraint, 'contentHash');
+                if (change.parentNode !== undefined) {
+                    constraint.parentNode = convert(change.parentNode);
+                }
+                return constraint;
+            }
+            default:
+                Common_1.fail('Unknown change type.');
+        }
+    });
+    const newEdit = { id: edit.id, changes };
+    Common_1.copyPropertyIfDefined(edit, newEdit, 'pastAttemptCount');
+    return newEdit;
+}
+exports.convertEditIds = convertEditIds;
+function convertNodeDataIds(nodeData, convert) {
+    const identifier = convert(nodeData.identifier);
+    const output = { definition: nodeData.definition, identifier };
+    Common_1.copyPropertyIfDefined(nodeData, output, 'payload');
+    return output;
+}
+exports.convertNodeDataIds = convertNodeDataIds;
+function convertStableRangeIds(range, convert) {
+    const start = convertStablePlaceIds(range.start, convert);
+    const end = convertStablePlaceIds(range.end, convert);
+    return { start, end };
+}
+exports.convertStableRangeIds = convertStableRangeIds;
+function convertStablePlaceIds({ side, referenceSibling, referenceTrait }, convert) {
+    const stablePlaceNew = {
+        side,
+    };
+    if (referenceSibling !== undefined) {
+        const nodeId = convert(referenceSibling);
+        stablePlaceNew.referenceSibling = nodeId;
+    }
+    if (referenceTrait !== undefined) {
+        const parent = convert(referenceTrait.parent);
+        stablePlaceNew.referenceTrait = {
+            label: referenceTrait.label,
+            parent,
+        };
+    }
+    return stablePlaceNew;
+}
+exports.convertStablePlaceIds = convertStablePlaceIds;
+//# sourceMappingURL=IdConversion.js.map

package/dist/IdConversion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdConversion.js","sourceRoot":"","sources":["../src/IdConversion.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAAkF;AAClF,mDAAmD;AACnD,+CAAiF;AACjF,uDAW2B;AAE3B,SAAgB,cAAc,CAC7B,IAA4D,EAC5D,OAA6B;IAE7B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAkD,EAAE;QAC3F,QAAQ,MAAM,CAAC,IAAI,EAAE;YACpB,KAAK,oCAAkB,CAAC,KAAK;gBAC5B,OAAO;oBACN,IAAI,EAAE,oCAAkB,CAAC,KAAK;oBAC9B,WAAW,EAAE,MAAM,CAAC,WAAW;oBAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;wBAClC,OAAO,gCAAgB,CAIrB,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,kCAAoB,CAAC,CAAC;oBAC5E,CAAC,CAAC;iBACF,CAAC;YACH,KAAK,oCAAkB,CAAC,MAAM;gBAC7B,OAAO;oBACN,IAAI,EAAE,oCAAkB,CAAC,MAAM;oBAC/B,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,WAAW,EAAE,qBAAqB,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC;iBAC/D,CAAC;YACH,KAAK,oCAAkB,CAAC,MAAM,CAAC,CAAC;gBAC/B,MAAM,MAAM,GAAmD;oBAC9D,IAAI,EAAE,oCAAkB,CAAC,MAAM;oBAC/B,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;iBACrD,CAAC;gBACF,8BAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;gBACrD,OAAO,MAAM,CAAC;aACd;YACD,KAAK,oCAAkB,CAAC,QAAQ;gBAC/B,OAAO;oBACN,IAAI,EAAE,oCAAkB,CAAC,QAAQ;oBACjC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;oBAC1C,OAAO,EAAE,MAAM,CAAC,OAAO;iBACvB,CAAC;YACH,KAAK,oCAAkB,CAAC,UAAU,CAAC,CAAC;gBACnC,MAAM,UAAU,GAAgE;oBAC/E,IAAI,EAAE,oCAAkB,CAAC,UAAU;oBACnC,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,WAAW,EAAE,qBAAqB,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC;iBAC/D,CAAC;gBACF,8BAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;gBAC1D,8BAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;gBACnD,8BAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;gBACpD,8BAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;gBACzD,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE;oBACpC,UAAU,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;iBACnD;gBACD,OAAO,UAAU,CAAC;aAClB;YACD;gBACC,aAAI,CAAC,sBAAsB,CAAC,CAAC;SAC9B;IACF,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC;IACzC,8BAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACzD,OAAO,OAAO,CAAC;AAChB,CAAC;AA5DD,wCA4DC;AAED,SAAgB,kBAAkB,CACjC,QAA0B,EAC1B,OAA6B;IAE7B,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC;IAC/D,8BAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACnD,OAAO,MAAM,CAAC;AACf,CAAC;AARD,gDAQC;AAED,SAAgB,qBAAqB,CACpC,KAA4D,EAC5D,OAA6B;IAE7B,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,qBAAqB,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACtD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACvB,CAAC;AAPD,sDAOC;AAED,SAAgB,qBAAqB,CACpC,EAAE,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAyD,EACjG,OAA6B;IAE7B,MAAM,cAAc,GAAiE;QACpF,IAAI;KACJ,CAAC;IAEF,IAAI,gBAAgB,KAAK,SAAS,EAAE;QACnC,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACzC,cAAc,CAAC,gBAAgB,GAAG,MAAM,CAAC;KACzC;IAED,IAAI,cAAc,KAAK,SAAS,EAAE;QACjC,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9C,cAAc,CAAC,cAAc,GAAG;YAC/B,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM;SACN,CAAC;KACF;IAED,OAAO,cAAc,CAAC;AACvB,CAAC;AAtBD,sDAsBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { copyPropertyIfDefined, fail, Mutable, ReplaceRecursive } from './Common';\nimport { convertTreeNodes } from './EditUtilities';\nimport { DetachedSequenceId, isDetachedSequenceId, NodeId } from './Identifiers';\nimport {\n\tBuildNodeInternal,\n\tChangeInternal,\n\tChangeTypeInternal,\n\tConstraintInternal,\n\tDetachInternal,\n\tEdit,\n\tNodeData,\n\tStablePlaceInternal,\n\tStableRangeInternal,\n\tTreeNode,\n} from './persisted-types';\n\nexport function convertEditIds<IdFrom, IdTo>(\n\tedit: ReplaceRecursive<Edit<ChangeInternal>, NodeId, IdFrom>,\n\tconvert: (id: IdFrom) => IdTo\n): Edit<ReplaceRecursive<ChangeInternal, NodeId, IdTo>> {\n\tconst changes = edit.changes.map((change): ReplaceRecursive<ChangeInternal, NodeId, IdTo> => {\n\t\tswitch (change.type) {\n\t\t\tcase ChangeTypeInternal.Build:\n\t\t\t\treturn {\n\t\t\t\t\ttype: ChangeTypeInternal.Build,\n\t\t\t\t\tdestination: change.destination,\n\t\t\t\t\tsource: change.source.map((tree) => {\n\t\t\t\t\t\treturn convertTreeNodes<\n\t\t\t\t\t\t\tTreeNode<ReplaceRecursive<BuildNodeInternal, NodeId, IdFrom>, IdFrom>,\n\t\t\t\t\t\t\tTreeNode<ReplaceRecursive<BuildNodeInternal, NodeId, IdTo>, IdTo>,\n\t\t\t\t\t\t\tDetachedSequenceId\n\t\t\t\t\t\t>(tree, (node) => convertNodeDataIds(node, convert), isDetachedSequenceId);\n\t\t\t\t\t}),\n\t\t\t\t};\n\t\t\tcase ChangeTypeInternal.Insert:\n\t\t\t\treturn {\n\t\t\t\t\ttype: ChangeTypeInternal.Insert,\n\t\t\t\t\tsource: change.source,\n\t\t\t\t\tdestination: convertStablePlaceIds(change.destination, convert),\n\t\t\t\t};\n\t\t\tcase ChangeTypeInternal.Detach: {\n\t\t\t\tconst detach: ReplaceRecursive<DetachInternal, NodeId, IdTo> = {\n\t\t\t\t\ttype: ChangeTypeInternal.Detach,\n\t\t\t\t\tsource: convertStableRangeIds(change.source, convert),\n\t\t\t\t};\n\t\t\t\tcopyPropertyIfDefined(change, detach, 'destination');\n\t\t\t\treturn detach;\n\t\t\t}\n\t\t\tcase ChangeTypeInternal.SetValue:\n\t\t\t\treturn {\n\t\t\t\t\ttype: ChangeTypeInternal.SetValue,\n\t\t\t\t\tnodeToModify: convert(change.nodeToModify),\n\t\t\t\t\tpayload: change.payload,\n\t\t\t\t};\n\t\t\tcase ChangeTypeInternal.Constraint: {\n\t\t\t\tconst constraint: Mutable<ReplaceRecursive<ConstraintInternal, NodeId, IdTo>> = {\n\t\t\t\t\ttype: ChangeTypeInternal.Constraint,\n\t\t\t\t\teffect: change.effect,\n\t\t\t\t\ttoConstrain: convertStableRangeIds(change.toConstrain, convert),\n\t\t\t\t};\n\t\t\t\tcopyPropertyIfDefined(change, constraint, 'identityHash');\n\t\t\t\tcopyPropertyIfDefined(change, constraint, 'label');\n\t\t\t\tcopyPropertyIfDefined(change, constraint, 'length');\n\t\t\t\tcopyPropertyIfDefined(change, constraint, 'contentHash');\n\t\t\t\tif (change.parentNode !== undefined) {\n\t\t\t\t\tconstraint.parentNode = convert(change.parentNode);\n\t\t\t\t}\n\t\t\t\treturn constraint;\n\t\t\t}\n\t\t\tdefault:\n\t\t\t\tfail('Unknown change type.');\n\t\t}\n\t});\n\tconst newEdit = { id: edit.id, changes };\n\tcopyPropertyIfDefined(edit, newEdit, 'pastAttemptCount');\n\treturn newEdit;\n}\n\nexport function convertNodeDataIds<IdFrom, IdTo>(\n\tnodeData: NodeData<IdFrom>,\n\tconvert: (id: IdFrom) => IdTo\n): NodeData<IdTo> {\n\tconst identifier = convert(nodeData.identifier);\n\tconst output = { definition: nodeData.definition, identifier };\n\tcopyPropertyIfDefined(nodeData, output, 'payload');\n\treturn output;\n}\n\nexport function convertStableRangeIds<IdFrom, IdTo>(\n\trange: ReplaceRecursive<StableRangeInternal, NodeId, IdFrom>,\n\tconvert: (id: IdFrom) => IdTo\n): ReplaceRecursive<StableRangeInternal, NodeId, IdTo> {\n\tconst start = convertStablePlaceIds(range.start, convert);\n\tconst end = convertStablePlaceIds(range.end, convert);\n\treturn { start, end };\n}\n\nexport function convertStablePlaceIds<IdFrom, IdTo>(\n\t{ side, referenceSibling, referenceTrait }: ReplaceRecursive<StablePlaceInternal, NodeId, IdFrom>,\n\tconvert: (id: IdFrom) => IdTo\n): ReplaceRecursive<StablePlaceInternal, NodeId, IdTo> {\n\tconst stablePlaceNew: Mutable<ReplaceRecursive<StablePlaceInternal, NodeId, IdTo>> = {\n\t\tside,\n\t};\n\n\tif (referenceSibling !== undefined) {\n\t\tconst nodeId = convert(referenceSibling);\n\t\tstablePlaceNew.referenceSibling = nodeId;\n\t}\n\n\tif (referenceTrait !== undefined) {\n\t\tconst parent = convert(referenceTrait.parent);\n\t\tstablePlaceNew.referenceTrait = {\n\t\t\tlabel: referenceTrait.label,\n\t\t\tparent,\n\t\t};\n\t}\n\n\treturn stablePlaceNew;\n}\n"]}

package/dist/Identifiers.d.ts

@@ -14,6 +14,20 @@
 export declare type UuidString = string & {
     readonly UuidString: '9d40d0ae-90d9-44b1-9482-9f55d59d5465';
 };
+/**
+ * A version 4, variant 2 uuid (https://datatracker.ietf.org/doc/html/rfc4122).
+ * @internal
+ */
+export declare type StableId = UuidString & {
+    readonly StableId: '53172b0d-a3d5-41ea-bd75-b43839c97f5a';
+};
+/**
+ * A StableId which is suitable for use as a session identifier
+ * @internal
+ */
+export declare type SessionId = StableId & {
+    readonly SessionId: '4498f850-e14e-4be9-8db0-89ec00997e58';
+};
 /**
  * Edit identifier
  * @public
@@ -32,13 +46,81 @@ export declare type EditId = UuidString & {
 export declare type DetachedSequenceId = number & {
     readonly DetachedSequenceId: 'f7d7903a-194e-45e7-8e82-c9ef4333577d';
 };
+/**
+ * An identifier (UUID) that has been shortened by a distributed compression algorithm.
+ * @public
+ */
+export declare type CompressedId = FinalCompressedId | LocalCompressedId;
+/**
+ * The ID of the string that has been interned, which can be used by a {@link StringInterner} to retrieve the original string.
+ * @public
+ */
+export declare type InternedStringId = number & {
+    readonly InternedStringId: 'e221abc9-9d17-4493-8db0-70c871a1c27c';
+};
+/**
+ * A brand for identity types that are unique within a particular session (SharedTree instance).
+ */
+export interface SessionUnique {
+    readonly SessionUnique: 'cea55054-6b82-4cbf-ad19-1fa645ea3b3e';
+}
+/**
+ * A compressed ID that has been normalized into "session space" (see `IdCompressor` for more).
+ * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to the
+ * compressor that produced them.
+ * @public
+ */
+export declare type SessionSpaceCompressedId = CompressedId & SessionUnique;
+/**
+ * A compressed ID that has been normalized into "op space" (see `IdCompressor` for more).
+ * Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require no normalizing when
+ * received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.
+ * @internal
+ */
+export declare type OpSpaceCompressedId = CompressedId & {
+    readonly OpNormalized: '9209432d-a959-4df7-b2ad-767ead4dbcae';
+};
+/**
+ * A compressed ID that is local to a document. Stable across all revisions of a document starting from the one in which it was created.
+ * It should not be persisted outside of the history as it can only be decompressed in the context of the originating document.
+ * If external persistence is needed (e.g. by a client), a StableId should be used instead.
+ * @public
+ */
+export declare type FinalCompressedId = number & {
+    readonly FinalCompressedId: '5d83d1e2-98b7-4e4e-a889-54c855cfa73d';
+    readonly OpNormalized: '9209432d-a959-4df7-b2ad-767ead4dbcae';
+};
+/**
+ * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).
+ * It should not be persisted outside of the history as it can only be decompressed in the context of the originating session.
+ * If external persistence is needed (e.g. by a client), a StableId should be used instead.
+ * @public
+ */
+export declare type LocalCompressedId = number & {
+    readonly LocalCompressedId: '6fccb42f-e2a4-4243-bd29-f13d12b9c6d1';
+} & SessionUnique;
+export interface NodeIdBrand {
+    readonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342';
+}
 /**
  * Node identifier.
  * Identifies a node within a document.
  * @public
  */
-export declare type NodeId = UuidString & {
-    readonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342';
+export declare type NodeId = number & SessionSpaceCompressedId & NodeIdBrand;
+export declare type FinalNodeId = FinalCompressedId & NodeIdBrand;
+/**
+ * A Node identifier which is persisted by SharedTree internals. Not usable as a {@link NodeId}.
+ * @internal
+ */
+export declare type OpSpaceNodeId = number & OpSpaceCompressedId & NodeIdBrand;
+/**
+ * Globally unique node identifier.
+ * Uniquely identifies a node within and across documents. Can be used across SharedTree instances.
+ * @public
+ */
+export declare type StableNodeId = string & {
+    readonly StableNodeId: 'a0843b38-699d-4bb2-aa7a-16c502a71151';
 };
 /**
  * Definition.
@@ -56,4 +138,9 @@ export declare type Definition = UuidString & {
 export declare type TraitLabel = UuidString & {
     readonly TraitLabel: '613826ed-49cc-4df3-b2b8-bfc6866af8e3';
 };
+/**
+ * Determine if a node is a DetachedSequenceId.
+ * @internal
+ */
+export declare function isDetachedSequenceId(node: DetachedSequenceId | object): node is DetachedSequenceId;
 //# sourceMappingURL=Identifiers.d.ts.map

package/dist/Identifiers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Identifiers.d.ts","sourceRoot":"","sources":["../src/Identifiers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAElG;;;GAGG;AACH,oBAAY,MAAM,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAE9F;;;;;;;GAOG;AACH,oBAAY,kBAAkB,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,kBAAkB,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAElH;;;;GAIG;AACH,oBAAY,MAAM,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAE9F;;;;GAIG;AACH,oBAAY,UAAU,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAEtG;;;;GAIG;AACH,oBAAY,UAAU,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,sCAAsC,CAAA;CAAE,CAAC"}
+{"version":3,"file":"Identifiers.d.ts","sourceRoot":"","sources":["../src/Identifiers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAElG;;;GAGG;AACH,oBAAY,QAAQ,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAElG;;;GAGG;AACH,oBAAY,SAAS,GAAG,QAAQ,GAAG;IAAE,QAAQ,CAAC,SAAS,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAElG;;;GAGG;AACH,oBAAY,MAAM,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAE9F;;;;;;;GAOG;AACH,oBAAY,kBAAkB,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,kBAAkB,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAElH;;;GAGG;AACH,oBAAY,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAEjE;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,gBAAgB,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAE9G;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,aAAa,EAAE,sCAAsC,CAAC;CAC/D;AAED;;;;;GAKG;AACH,oBAAY,wBAAwB,GAAG,YAAY,GAAG,aAAa,CAAC;AAEpE;;;;;GAKG;AACH,oBAAY,mBAAmB,GAAG,YAAY,GAAG;IAChD,QAAQ,CAAC,YAAY,EAAE,sCAAsC,CAAC;CAC9D,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,iBAAiB,GAAG,MAAM,GAAG;IACxC,QAAQ,CAAC,iBAAiB,EAAE,sCAAsC,CAAC;IAGnE,QAAQ,CAAC,YAAY,EAAE,sCAAsC,CAAC;CAC9D,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,iBAAiB,GAAG,MAAM,GAAG;IACxC,QAAQ,CAAC,iBAAiB,EAAE,sCAAsC,CAAC;CACnE,GAAG,aAAa,CAAC;AAElB,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,MAAM,EAAE,sCAAsC,CAAC;CACxD;AAED;;;;GAIG;AACH,oBAAY,MAAM,GAAG,MAAM,GAAG,wBAAwB,GAAG,WAAW,CAAC;AAErE,oBAAY,WAAW,GAAG,iBAAiB,GAAG,WAAW,CAAC;AAE1D;;;GAGG;AACH,oBAAY,aAAa,GAAG,MAAM,GAAG,mBAAmB,GAAG,WAAW,CAAC;AAEvE;;;;GAIG;AACH,oBAAY,YAAY,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,YAAY,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAEtG;;;;GAIG;AACH,oBAAY,UAAU,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAEtG;;;;GAIG;AACH,oBAAY,UAAU,GAAG,UAAU,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,sCAAsC,CAAA;CAAE,CAAC;AAEtG;;;GAGG;AAEH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,kBAAkB,GAAG,MAAM,GAAG,IAAI,IAAI,kBAAkB,CAElG"}

package/dist/Identifiers.js

@@ -4,4 +4,14 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDetachedSequenceId = void 0;
+/**
+ * Determine if a node is a DetachedSequenceId.
+ * @internal
+ */
+// Nodes can be an `object` type which is a banned type.
+function isDetachedSequenceId(node) {
+    return typeof node !== 'object';
+}
+exports.isDetachedSequenceId = isDetachedSequenceId;
 //# sourceMappingURL=Identifiers.js.map

package/dist/Identifiers.js.map

@@ -1 +1 @@
-{"version":3,"file":"Identifiers.js","sourceRoot":"","sources":["../src/Identifiers.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Type-safe identifiers for specific use cases.\n */\n\n/**\n * A 128-bit Universally Unique IDentifier. Represented here\n * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,\n * where x is a lowercase hex digit.\n * @public\n */\nexport type UuidString = string & { readonly UuidString: '9d40d0ae-90d9-44b1-9482-9f55d59d5465' };\n\n/**\n * Edit identifier\n * @public\n */\nexport type EditId = UuidString & { readonly EditId: '56897beb-53e4-4e66-85da-4bf5cd5d0d49' };\n\n/**\n * Scoped to a single edit: identifies a sequences of nodes that can be moved into a trait.\n *\n * Within a given Edit, any DetachedSequenceId must be a source at most once, and a destination at most once.\n * If used as a source, it must be after it is used as a destination.\n * If this is violated, the Edit is considered malformed.\n * @public\n */\nexport type DetachedSequenceId = number & { readonly DetachedSequenceId: 'f7d7903a-194e-45e7-8e82-c9ef4333577d' };\n\n/**\n * Node identifier.\n * Identifies a node within a document.\n * @public\n */\nexport type NodeId = UuidString & { readonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342' };\n\n/**\n * Definition.\n * A full (Uuid) persistable definition.\n * @public\n */\nexport type Definition = UuidString & { readonly Definition: 'c0ef9488-2a78-482d-aeed-37fba996354c' };\n\n/**\n * Definition.\n * A full (Uuid) persistable label for a trait.\n * @public\n */\nexport type TraitLabel = UuidString & { readonly TraitLabel: '613826ed-49cc-4df3-b2b8-bfc6866af8e3' };\n"]}
+{"version":3,"file":"Identifiers.js","sourceRoot":"","sources":["../src/Identifiers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA8IH;;;GAGG;AACH,wDAAwD;AACxD,SAAgB,oBAAoB,CAAC,IAAiC;IACrE,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC;AACjC,CAAC;AAFD,oDAEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Type-safe identifiers for specific use cases.\n */\n\n/**\n * A 128-bit Universally Unique IDentifier. Represented here\n * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,\n * where x is a lowercase hex digit.\n * @public\n */\nexport type UuidString = string & { readonly UuidString: '9d40d0ae-90d9-44b1-9482-9f55d59d5465' };\n\n/**\n * A version 4, variant 2 uuid (https://datatracker.ietf.org/doc/html/rfc4122).\n * @internal\n */\nexport type StableId = UuidString & { readonly StableId: '53172b0d-a3d5-41ea-bd75-b43839c97f5a' };\n\n/**\n * A StableId which is suitable for use as a session identifier\n * @internal\n */\nexport type SessionId = StableId & { readonly SessionId: '4498f850-e14e-4be9-8db0-89ec00997e58' };\n\n/**\n * Edit identifier\n * @public\n */\nexport type EditId = UuidString & { readonly EditId: '56897beb-53e4-4e66-85da-4bf5cd5d0d49' };\n\n/**\n * Scoped to a single edit: identifies a sequences of nodes that can be moved into a trait.\n *\n * Within a given Edit, any DetachedSequenceId must be a source at most once, and a destination at most once.\n * If used as a source, it must be after it is used as a destination.\n * If this is violated, the Edit is considered malformed.\n * @public\n */\nexport type DetachedSequenceId = number & { readonly DetachedSequenceId: 'f7d7903a-194e-45e7-8e82-c9ef4333577d' };\n\n/**\n * An identifier (UUID) that has been shortened by a distributed compression algorithm.\n * @public\n */\nexport type CompressedId = FinalCompressedId | LocalCompressedId;\n\n/**\n * The ID of the string that has been interned, which can be used by a {@link StringInterner} to retrieve the original string.\n * @public\n */\nexport type InternedStringId = number & { readonly InternedStringId: 'e221abc9-9d17-4493-8db0-70c871a1c27c' };\n\n/**\n * A brand for identity types that are unique within a particular session (SharedTree instance).\n */\nexport interface SessionUnique {\n\treadonly SessionUnique: 'cea55054-6b82-4cbf-ad19-1fa645ea3b3e';\n}\n\n/**\n * A compressed ID that has been normalized into \"session space\" (see `IdCompressor` for more).\n * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to the\n * compressor that produced them.\n * @public\n */\nexport type SessionSpaceCompressedId = CompressedId & SessionUnique;\n\n/**\n * A compressed ID that has been normalized into \"op space\" (see `IdCompressor` for more).\n * Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require no normalizing when\n * received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.\n * @internal\n */\nexport type OpSpaceCompressedId = CompressedId & {\n\treadonly OpNormalized: '9209432d-a959-4df7-b2ad-767ead4dbcae';\n};\n\n/**\n * A compressed ID that is local to a document. Stable across all revisions of a document starting from the one in which it was created.\n * It should not be persisted outside of the history as it can only be decompressed in the context of the originating document.\n * If external persistence is needed (e.g. by a client), a StableId should be used instead.\n * @public\n */\nexport type FinalCompressedId = number & {\n\treadonly FinalCompressedId: '5d83d1e2-98b7-4e4e-a889-54c855cfa73d';\n\n\t// Same brand as OpNormalizedCompressedId, as final IDs are always finally normalized\n\treadonly OpNormalized: '9209432d-a959-4df7-b2ad-767ead4dbcae';\n};\n\n/**\n * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).\n * It should not be persisted outside of the history as it can only be decompressed in the context of the originating session.\n * If external persistence is needed (e.g. by a client), a StableId should be used instead.\n * @public\n */\nexport type LocalCompressedId = number & {\n\treadonly LocalCompressedId: '6fccb42f-e2a4-4243-bd29-f13d12b9c6d1';\n} & SessionUnique; // Same brand as CompressedId, as local IDs are always locally normalized\n\nexport interface NodeIdBrand {\n\treadonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342';\n}\n\n/**\n * Node identifier.\n * Identifies a node within a document.\n * @public\n */\nexport type NodeId = number & SessionSpaceCompressedId & NodeIdBrand;\n\nexport type FinalNodeId = FinalCompressedId & NodeIdBrand;\n\n/**\n * A Node identifier which is persisted by SharedTree internals. Not usable as a {@link NodeId}.\n * @internal\n */\nexport type OpSpaceNodeId = number & OpSpaceCompressedId & NodeIdBrand;\n\n/**\n * Globally unique node identifier.\n * Uniquely identifies a node within and across documents. Can be used across SharedTree instances.\n * @public\n */\nexport type StableNodeId = string & { readonly StableNodeId: 'a0843b38-699d-4bb2-aa7a-16c502a71151' };\n\n/**\n * Definition.\n * A full (Uuid) persistable definition.\n * @public\n */\nexport type Definition = UuidString & { readonly Definition: 'c0ef9488-2a78-482d-aeed-37fba996354c' };\n\n/**\n * Definition.\n * A full (Uuid) persistable label for a trait.\n * @public\n */\nexport type TraitLabel = UuidString & { readonly TraitLabel: '613826ed-49cc-4df3-b2b8-bfc6866af8e3' };\n\n/**\n * Determine if a node is a DetachedSequenceId.\n * @internal\n */\n// Nodes can be an `object` type which is a banned type.\nexport function isDetachedSequenceId(node: DetachedSequenceId | object): node is DetachedSequenceId {\n\treturn typeof node !== 'object';\n}\n"]}

package/dist/InitialTree.d.ts

@@ -2,10 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ChangeNode } from './generic';
+import { ChangeNode_0_0_2 } from './persisted-types';
 /**
  * The initial tree.
  * @public
  */
-export declare const initialTree: ChangeNode;
+export declare const initialTree: ChangeNode_0_0_2;
 //# sourceMappingURL=InitialTree.d.ts.map

package/dist/InitialTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InitialTree.d.ts","sourceRoot":"","sources":["../src/InitialTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,UAIzB,CAAC"}
+{"version":3,"file":"InitialTree.d.ts","sourceRoot":"","sources":["../src/InitialTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,gBAIzB,CAAC"}

package/dist/InitialTree.js

@@ -5,6 +5,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initialTree = void 0;
+const id_compressor_1 = require("./id-compressor");
 /**
  * The initial tree.
  * @public
@@ -12,6 +13,6 @@ exports.initialTree = void 0;
 exports.initialTree = {
     traits: {},
     definition: '51c58718-47b9-4fe4-ad46-56312f3b9e86',
-    identifier: '24e26f0b-3c1a-47f8-a7a1-e8461ddb69ce6',
+    identifier: id_compressor_1.legacySharedTreeInitialTreeId,
 };
 //# sourceMappingURL=InitialTree.js.map

package/dist/InitialTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"InitialTree.js","sourceRoot":"","sources":["../src/InitialTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH;;;GAGG;AACU,QAAA,WAAW,GAAe;IACtC,MAAM,EAAE,EAAE;IACV,UAAU,EAAE,sCAAoD;IAChE,UAAU,EAAE,uCAAiD;CAC7D,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Definition, NodeId } from './Identifiers';\nimport { ChangeNode } from './generic';\n\n/**\n * The initial tree.\n * @public\n */\nexport const initialTree: ChangeNode = {\n\ttraits: {},\n\tdefinition: '51c58718-47b9-4fe4-ad46-56312f3b9e86' as Definition,\n\tidentifier: '24e26f0b-3c1a-47f8-a7a1-e8461ddb69ce6' as NodeId,\n};\n"]}
+{"version":3,"file":"InitialTree.js","sourceRoot":"","sources":["../src/InitialTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,mDAAgE;AAGhE;;;GAGG;AACU,QAAA,WAAW,GAAqB;IAC5C,MAAM,EAAE,EAAE;IACV,UAAU,EAAE,sCAAoD;IAChE,UAAU,EAAE,6CAA6C;CACzD,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Definition, StableNodeId } from './Identifiers';\nimport { legacySharedTreeInitialTreeId } from './id-compressor';\nimport { ChangeNode_0_0_2 } from './persisted-types';\n\n/**\n * The initial tree.\n * @public\n */\nexport const initialTree: ChangeNode_0_0_2 = {\n\ttraits: {},\n\tdefinition: '51c58718-47b9-4fe4-ad46-56312f3b9e86' as Definition,\n\tidentifier: legacySharedTreeInitialTreeId as StableNodeId,\n};\n"]}

package/dist/LazyCheckout.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Checkout } from './Checkout';
+import { EditId } from './Identifiers';
+import { RevisionView } from './RevisionView';
+import { SharedTree } from './SharedTree';
+import { ValidEditingResult } from './TransactionInternal';
+/**
+ * Checkout that only updates its view of the tree when explicitly requested.
+ * This means that the {@link Checkout.currentView} field will never change unless {@link LazyCheckout.waitForPendingUpdates} is called.
+ *
+ * @public
+ * @sealed
+ */
+export declare class LazyCheckout extends Checkout {
+    private latestView;
+    /**
+     * @param tree - the tree
+     */
+    constructor(tree: SharedTree);
+    protected handleNewEdit(id: EditId, result: ValidEditingResult): void;
+    protected get latestCommittedView(): RevisionView;
+    waitForPendingUpdates(): Promise<void>;
+    waitForEditsToSubmit(): Promise<void>;
+}
+//# sourceMappingURL=LazyCheckout.d.ts.map

package/dist/LazyCheckout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LazyCheckout.d.ts","sourceRoot":"","sources":["../src/LazyCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAA+B,UAAU,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACzC,OAAO,CAAC,UAAU,CAAe;IAEjC;;OAEG;gBACgB,IAAI,EAAE,UAAU;IAKnC,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAKrE,SAAS,KAAK,mBAAmB,IAAI,YAAY,CAEhD;IAEY,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAQtC,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;CAIlD"}