@fluidframework/sequence 0.59.4001 → 1.1.0-75972

package/dist/intervalCollection.js

@@ -18,20 +18,61 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntervalCollection = exports.IntervalCollectionIterator = exports.IntervalCollectionValueType = exports.SequenceIntervalCollectionValueType = exports.LocalIntervalCollection = exports.createIntervalIndex = exports.defaultIntervalConflictResolver = exports.SequenceInterval = exports.Interval = exports.IntervalType = void 0;
 /* eslint-disable no-bitwise */
 const common_utils_1 = require("@fluidframework/common-utils");
+const container_utils_1 = require("@fluidframework/container-utils");
 const merge_tree_1 = require("@fluidframework/merge-tree");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const uuid_1 = require("uuid");
 const reservedIntervalIdKey = "intervalId";
 var IntervalType;
 (function (IntervalType) {
     IntervalType[IntervalType["Simple"] = 0] = "Simple";
     IntervalType[IntervalType["Nest"] = 1] = "Nest";
+    /**
+     * SlideOnRemove indicates that the ends of the interval will slide if the segment
+     * they reference is removed and acked.
+     * See `packages\dds\merge-tree\REFERENCEPOSITIONS.md` for details
+     * SlideOnRemove is the default interval behavior and does not need to be specified.
+     */
     IntervalType[IntervalType["SlideOnRemove"] = 2] = "SlideOnRemove";
+    /**
+     * @internal
+     * A temporary interval, used internally
+     */
     IntervalType[IntervalType["Transient"] = 4] = "Transient";
 })(IntervalType = exports.IntervalType || (exports.IntervalType = {}));
+/**
+ * Decompress an interval after loading a summary from JSON. The exact format
+ * of this compression is unspecified and subject to change
+ */
+function decompressInterval(interval, label) {
+    return {
+        start: interval[0],
+        end: interval[1],
+        sequenceNumber: interval[2],
+        intervalType: interval[3],
+        properties: Object.assign(Object.assign({}, interval[4]), { [merge_tree_1.reservedRangeLabelsKey]: label }),
+    };
+}
+/**
+ * Compress an interval prior to serialization as JSON. The exact format of this
+ * compression is unspecified and subject to change
+ */
+function compressInterval(interval) {
+    const { start, end, sequenceNumber, intervalType, properties } = interval;
+    return [
+        start,
+        end,
+        sequenceNumber,
+        intervalType,
+        Object.assign(Object.assign({}, properties), { [merge_tree_1.reservedRangeLabelsKey]: undefined }),
+    ];
+}
 class Interval {
     constructor(start, end, props) {
         this.start = start;
         this.end = end;
+        this.propertyManager = new merge_tree_1.PropertiesManager();
+        this.properties = {};
         if (props) {
             this.addProperties(props);
         }
@@ -114,12 +155,7 @@ class Interval {
     }
     addProperties(newProps, collaborating = false, seq, op) {
         if (newProps) {
-            if (!this.propertyManager) {
-                this.propertyManager = new merge_tree_1.PropertiesManager();
-            }
-            if (!this.properties) {
-                this.properties = (0, merge_tree_1.createMap)();
-            }
+            this.initializeProperties();
             return this.propertyManager.addProperties(this.properties, newProps, op, seq, collaborating);
         }
     }
@@ -130,7 +166,20 @@ class Interval {
             // Return undefined to indicate that no change is necessary.
             return;
         }
-        return new Interval(startPos, endPos, this.properties);
+        const newInterval = new Interval(startPos, endPos);
+        if (this.properties) {
+            newInterval.initializeProperties();
+            this.propertyManager.copyTo(this.properties, newInterval.properties, newInterval.propertyManager);
+        }
+        return newInterval;
+    }
+    initializeProperties() {
+        if (!this.propertyManager) {
+            this.propertyManager = new merge_tree_1.PropertiesManager();
+        }
+        if (!this.properties) {
+            this.properties = (0, merge_tree_1.createMap)();
+        }
     }
 }
 exports.Interval = Interval;
@@ -139,10 +188,41 @@ class SequenceInterval {
         this.start = start;
         this.end = end;
         this.intervalType = intervalType;
+        this.propertyManager = new merge_tree_1.PropertiesManager();
+        this.properties = {};
         if (props) {
             this.addProperties(props);
         }
     }
+    /**
+     * @internal
+     * Subscribes to position change events on this interval if there are no current listeners.
+     */
+    addPositionChangeListeners(beforePositionChange, afterPositionChange) {
+        var _a, _b;
+        var _c, _d;
+        if (this.callbacks === undefined) {
+            this.callbacks = {
+                beforePositionChange,
+                afterPositionChange,
+            };
+            const startCbs = (_a = (_c = this.start).callbacks) !== null && _a !== void 0 ? _a : (_c.callbacks = {});
+            const endCbs = (_b = (_d = this.end).callbacks) !== null && _b !== void 0 ? _b : (_d.callbacks = {});
+            startCbs.beforeSlide = endCbs.beforeSlide = beforePositionChange;
+            startCbs.afterSlide = endCbs.afterSlide = afterPositionChange;
+        }
+    }
+    /**
+     * @internal
+     * Removes the currently subscribed position change listeners.
+     */
+    removePositionChangeListeners() {
+        if (this.callbacks) {
+            this.callbacks = undefined;
+            this.start.callbacks = undefined;
+            this.end.callbacks = undefined;
+        }
+    }
     serialize(client) {
         const startPosition = this.start.toPosition();
         const endPosition = this.end.toPosition();
@@ -206,12 +286,7 @@ class SequenceInterval {
         return new SequenceInterval(this.start.min(b.start), this.end.max(b.end), this.intervalType);
     }
     addProperties(newProps, collab = false, seq, op) {
-        if (!this.propertyManager) {
-            this.propertyManager = new merge_tree_1.PropertiesManager();
-        }
-        if (!this.properties) {
-            this.properties = (0, merge_tree_1.createMap)();
-        }
+        this.initializeProperties();
         return this.propertyManager.addProperties(this.properties, newProps, op, seq, collab);
     }
     overlapsPos(bstart, bend) {
@@ -220,60 +295,103 @@ class SequenceInterval {
         return (endPos > bstart) && (startPos < bend);
     }
     modify(label, start, end, op) {
-        const startPos = start !== null && start !== void 0 ? start : this.start.toPosition();
-        const endPos = end !== null && end !== void 0 ? end : this.end.toPosition();
-        if (this.start.toPosition() === startPos && this.end.toPosition() === endPos) {
-            // Return undefined to indicate that no change is necessary.
-            return;
-        }
-        const newInterval = createSequenceInterval(label, startPos, endPos, this.start.getClient(), this.intervalType, op);
+        const getRefType = (baseType) => {
+            let refType = baseType;
+            if (op === undefined) {
+                refType &= ~merge_tree_1.ReferenceType.SlideOnRemove;
+                refType |= merge_tree_1.ReferenceType.StayOnRemove;
+            }
+            return refType;
+        };
+        let startRef = this.start;
+        if (start !== undefined) {
+            startRef = createPositionReference(this.start.getClient(), start, getRefType(this.start.refType), op);
+            startRef.addProperties(this.start.properties);
+        }
+        let endRef = this.end;
+        if (end !== undefined) {
+            endRef = createPositionReference(this.end.getClient(), end, getRefType(this.end.refType), op);
+            endRef.addProperties(this.end.properties);
+        }
+        startRef.pairedRef = endRef;
+        endRef.pairedRef = startRef;
+        const newInterval = new SequenceInterval(startRef, endRef, this.intervalType);
         if (this.properties) {
-            newInterval.addProperties(this.properties);
+            newInterval.initializeProperties();
+            this.propertyManager.copyTo(this.properties, newInterval.properties, newInterval.propertyManager);
         }
         return newInterval;
     }
+    initializeProperties() {
+        if (!this.propertyManager) {
+            this.propertyManager = new merge_tree_1.PropertiesManager();
+        }
+        if (!this.properties) {
+            this.properties = (0, merge_tree_1.createMap)();
+        }
+    }
 }
 exports.SequenceInterval = SequenceInterval;
-function createPositionReference(client, pos, refType, op) {
-    const segoff = client.getContainingSegment(pos, op);
-    if (segoff === null || segoff === void 0 ? void 0 : segoff.segment) {
-        const lref = new merge_tree_1.LocalReference(client, segoff.segment, segoff.offset, refType);
-        if (refType !== merge_tree_1.ReferenceType.Transient) {
-            client.addLocalReference(lref);
+function createPositionReferenceFromSegoff(client, segoff, refType, op) {
+    if (segoff.segment) {
+        const ref = client.createLocalReferencePosition(segoff.segment, segoff.offset, refType, undefined);
+        return ref;
+    }
+    else {
+        if (!op && !(0, merge_tree_1.refTypeIncludesFlag)(refType, merge_tree_1.ReferenceType.Transient)) {
+            throw new container_utils_1.UsageError("Non-transient references need segment");
         }
-        return lref;
+        return new merge_tree_1.LocalReference(client, undefined, 0, refType);
+    }
+}
+function createPositionReference(client, pos, refType, op) {
+    let segoff;
+    if (op) {
+        (0, common_utils_1.assert)((refType & merge_tree_1.ReferenceType.SlideOnRemove) !== 0, 0x2f5 /* op create references must be SlideOnRemove */);
+        segoff = client.getContainingSegment(pos, op);
+        segoff = client.getSlideToSegment(segoff);
+    }
+    else {
+        (0, common_utils_1.assert)((refType & merge_tree_1.ReferenceType.SlideOnRemove) === 0, 0x2f6 /* SlideOnRemove references must be op created */);
+        segoff = client.getContainingSegment(pos);
     }
-    return new merge_tree_1.LocalReference(client, undefined);
+    return createPositionReferenceFromSegoff(client, segoff, refType, op);
 }
 function createSequenceInterval(label, start, end, client, intervalType, op) {
     let beginRefType = merge_tree_1.ReferenceType.RangeBegin;
     let endRefType = merge_tree_1.ReferenceType.RangeEnd;
-    if (intervalType === IntervalType.Nest) {
-        beginRefType = merge_tree_1.ReferenceType.NestBegin;
-        endRefType = merge_tree_1.ReferenceType.NestEnd;
-    }
-    else if (intervalType === IntervalType.Transient) {
+    if (intervalType === IntervalType.Transient) {
         beginRefType = merge_tree_1.ReferenceType.Transient;
         endRefType = merge_tree_1.ReferenceType.Transient;
     }
-    // TODO: Should SlideOnRemove be the default behavior?
-    if (intervalType & IntervalType.SlideOnRemove) {
-        beginRefType |= merge_tree_1.ReferenceType.SlideOnRemove;
-        endRefType |= merge_tree_1.ReferenceType.SlideOnRemove;
+    else {
+        if (intervalType === IntervalType.Nest) {
+            beginRefType = merge_tree_1.ReferenceType.NestBegin;
+            endRefType = merge_tree_1.ReferenceType.NestEnd;
+        }
+        // All non-transient interval references must eventually be SlideOnRemove
+        // To ensure eventual consistency, they must start as StayOnRemove when
+        // pending (created locally and creation op is not acked)
+        if (op) {
+            beginRefType |= merge_tree_1.ReferenceType.SlideOnRemove;
+            endRefType |= merge_tree_1.ReferenceType.SlideOnRemove;
+        }
+        else {
+            beginRefType |= merge_tree_1.ReferenceType.StayOnRemove;
+            endRefType |= merge_tree_1.ReferenceType.StayOnRemove;
+        }
     }
     const startLref = createPositionReference(client, start, beginRefType, op);
     const endLref = createPositionReference(client, end, endRefType, op);
-    if (startLref && endLref) {
-        startLref.pairedRef = endLref;
-        endLref.pairedRef = startLref;
-        const rangeProp = {
-            [merge_tree_1.reservedRangeLabelsKey]: [label],
-        };
-        startLref.addProperties(rangeProp);
-        endLref.addProperties(rangeProp);
-        const ival = new SequenceInterval(startLref, endLref, intervalType, rangeProp);
-        return ival;
-    }
+    startLref.pairedRef = endLref;
+    endLref.pairedRef = startLref;
+    const rangeProp = {
+        [merge_tree_1.reservedRangeLabelsKey]: [label],
+    };
+    startLref.addProperties(rangeProp);
+    endLref.addProperties(rangeProp);
+    const ival = new SequenceInterval(startLref, endLref, intervalType, rangeProp);
+    return ival;
 }
 function defaultIntervalConflictResolver(a, b) {
     a.addPropertySet(b.properties);
@@ -296,11 +414,15 @@ function createIntervalIndex(conflict) {
 }
 exports.createIntervalIndex = createIntervalIndex;
 class LocalIntervalCollection {
-    constructor(client, label, helpers) {
+    constructor(client, label, helpers, 
+    /** Callback invoked each time one of the endpoints of an interval slides. */
+    onPositionChange) {
         this.client = client;
         this.label = label;
         this.helpers = helpers;
+        this.onPositionChange = onPositionChange;
         this.intervalTree = new merge_tree_1.IntervalTree();
+        this.intervalIdMap = new Map();
         // eslint-disable-next-line @typescript-eslint/unbound-method
         this.endIntervalTree = new merge_tree_1.RedBlackTree(helpers.compareEnds);
     }
@@ -308,7 +430,7 @@ class LocalIntervalCollection {
         this.conflictResolver = conflictResolver;
         this.endConflictResolver =
             (key, currentKey) => {
-                const ival = this.conflictResolver(key, currentKey);
+                const ival = conflictResolver(key, currentKey);
                 return {
                     data: ival,
                     key: ival,
@@ -323,13 +445,22 @@ class LocalIntervalCollection {
         // without ID's.
         return `${LocalIntervalCollection.legacyIdPrefix}${start}-${end}`;
     }
+    /**
+     * Validates that a serialized interval has the ID property. Creates an ID
+     * if one does not already exist
+     *
+     * @param serializedInterval - The interval to be checked
+     * @returns The interval's existing or newly created id
+     */
     ensureSerializedId(serializedInterval) {
         var _a;
-        if (((_a = serializedInterval.properties) === null || _a === void 0 ? void 0 : _a[reservedIntervalIdKey]) === undefined) {
+        let id = (_a = serializedInterval.properties) === null || _a === void 0 ? void 0 : _a[reservedIntervalIdKey];
+        if (id === undefined) {
             // An interval came over the wire without an ID, so create a non-unique one based on start/end.
             // This will allow all clients to refer to this interval consistently.
+            id = this.createLegacyId(serializedInterval.start, serializedInterval.end);
             const newProps = {
-                [reservedIntervalIdKey]: this.createLegacyId(serializedInterval.start, serializedInterval.end),
+                [reservedIntervalIdKey]: id,
             };
             serializedInterval.properties = (0, merge_tree_1.addProperties)(serializedInterval.properties, newProps);
         }
@@ -339,6 +470,7 @@ class LocalIntervalCollection {
             enumerable: true,
             writable: false,
         });
+        return id;
     }
     mapUntil(fn) {
         this.intervalTree.mapUntil(fn);
@@ -405,14 +537,12 @@ class LocalIntervalCollection {
         }
     }
     findOverlappingIntervals(startPosition, endPosition) {
-        if (!this.intervalTree.intervals.isEmpty()) {
-            const transientInterval = this.helpers.create("transient", startPosition, endPosition, this.client, IntervalType.Transient);
-            const overlappingIntervalNodes = this.intervalTree.match(transientInterval);
-            return overlappingIntervalNodes.map((node) => node.key);
-        }
-        else {
+        if (endPosition < startPosition || this.intervalTree.intervals.isEmpty()) {
             return [];
         }
+        const transientInterval = this.helpers.create("transient", startPosition, endPosition, this.client, IntervalType.Transient);
+        const overlappingIntervalNodes = this.intervalTree.match(transientInterval);
+        return overlappingIntervalNodes.map((node) => node.key);
     }
     previousInterval(pos) {
         const transientInterval = this.helpers.create("transient", pos, pos, this.client, IntervalType.Transient);
@@ -434,9 +564,16 @@ class LocalIntervalCollection {
         this.endIntervalTree.remove(transientInterval);
         return transientInterval;
     }
-    removeExistingInterval(interval) {
+    removeIntervalFromIndex(interval) {
         this.intervalTree.removeExisting(interval);
         this.endIntervalTree.remove(interval);
+        const id = interval.getIntervalId();
+        (0, common_utils_1.assert)(id !== undefined, 0x311 /* expected id to exist on interval */);
+        this.intervalIdMap.delete(id);
+    }
+    removeExistingInterval(interval) {
+        this.removeIntervalFromIndex(interval);
+        this.removeIntervalListeners(interval);
     }
     createInterval(start, end, intervalType, op) {
         return this.helpers.create(this.label, start, end, this.client, intervalType, op);
@@ -458,8 +595,9 @@ class LocalIntervalCollection {
         }
         return interval;
     }
-    add(interval) {
-        (0, common_utils_1.assert)(Object.prototype.hasOwnProperty.call(interval.properties, reservedIntervalIdKey), 0x2c0 /* "ID must be created before adding interval to collection" */);
+    addIntervalToIndex(interval) {
+        const id = interval.getIntervalId();
+        (0, common_utils_1.assert)(id !== undefined, 0x2c0 /* "ID must be created before adding interval to collection" */);
         // Make the ID immutable.
         Object.defineProperty(interval.properties, reservedIntervalIdKey, {
             configurable: false,
@@ -468,17 +606,14 @@ class LocalIntervalCollection {
         });
         this.intervalTree.put(interval, this.conflictResolver);
         this.endIntervalTree.put(interval, interval, this.endConflictResolver);
+        this.intervalIdMap.set(id, interval);
+    }
+    add(interval) {
+        this.addIntervalToIndex(interval);
+        this.addIntervalListeners(interval);
     }
     getIntervalById(id) {
-        let result;
-        this.mapUntil((interval) => {
-            if (interval.getIntervalId() === id) {
-                result = interval;
-                return false;
-            }
-            return true;
-        });
-        return result;
+        return this.intervalIdMap.get(id);
     }
     changeInterval(interval, start, end, op) {
         const newInterval = interval.modify(this.label, start, end, op);
@@ -491,7 +626,25 @@ class LocalIntervalCollection {
     serialize() {
         const client = this.client;
         const intervals = this.intervalTree.intervals.keys();
-        return intervals.map((interval) => interval.serialize(client));
+        return {
+            label: this.label,
+            intervals: intervals.map((interval) => compressInterval(interval.serialize(client))),
+            version: 2,
+        };
+    }
+    addIntervalListeners(interval) {
+        if (interval instanceof SequenceInterval) {
+            interval.addPositionChangeListeners(() => this.removeIntervalFromIndex(interval), () => {
+                var _a;
+                this.addIntervalToIndex(interval);
+                (_a = this.onPositionChange) === null || _a === void 0 ? void 0 : _a.call(this, interval);
+            });
+        }
+    }
+    removeIntervalListeners(interval) {
+        if (interval instanceof SequenceInterval) {
+            interval.removePositionChangeListeners();
+        }
     }
 }
 exports.LocalIntervalCollection = LocalIntervalCollection;
@@ -523,37 +676,12 @@ class SequenceIntervalCollectionValueType {
 exports.SequenceIntervalCollectionValueType = SequenceIntervalCollectionValueType;
 SequenceIntervalCollectionValueType.Name = "sharedStringIntervalCollection";
 SequenceIntervalCollectionValueType._factory = new SequenceIntervalCollectionFactory();
-SequenceIntervalCollectionValueType._ops = new Map([[
-        "add",
-        {
-            process: (value, params, local, op) => {
-                value.ackAdd(params, local, op);
-            },
-        },
-    ],
-    [
-        "delete",
-        {
-            process: (value, params, local, op) => {
-                value.ackDelete(params, local, op);
-            },
-        },
-    ],
-    [
-        "change",
-        {
-            process: (value, params, local, op) => {
-                value.ackChange(params, local, op);
-            },
-        },
-    ]]);
+SequenceIntervalCollectionValueType._ops = makeOpsMap();
 const compareIntervalEnds = (a, b) => a.end - b.end;
 function createInterval(label, start, end, client) {
-    let rangeProp;
-    if (label && (label.length > 0)) {
-        rangeProp = {
-            [merge_tree_1.reservedRangeLabelsKey]: [label],
-        };
+    const rangeProp = {};
+    if (label && label.length > 0) {
+        rangeProp[merge_tree_1.reservedRangeLabelsKey] = [label];
     }
     return new Interval(start, end, rangeProp);
 }
@@ -585,30 +713,45 @@ class IntervalCollectionValueType {
 exports.IntervalCollectionValueType = IntervalCollectionValueType;
 IntervalCollectionValueType.Name = "sharedIntervalCollection";
 IntervalCollectionValueType._factory = new IntervalCollectionFactory();
-IntervalCollectionValueType._ops = new Map([[
-        "add",
-        {
-            process: (value, params, local, op) => {
-                value.ackAdd(params, local, op);
+IntervalCollectionValueType._ops = makeOpsMap();
+function makeOpsMap() {
+    const rebase = (collection, op, localOpMetadata) => {
+        const { localSeq } = localOpMetadata;
+        const rebasedValue = collection.rebaseLocalInterval(op.opName, op.value, localSeq);
+        const rebasedOp = Object.assign(Object.assign({}, op), { value: rebasedValue });
+        return { rebasedOp, rebasedLocalOpMetadata: localOpMetadata };
+    };
+    return new Map([[
+            "add",
+            {
+                process: (collection, params, local, op) => {
+                    collection.ackAdd(params, local, op);
+                },
+                rebase,
             },
-        },
-    ],
-    [
-        "delete",
-        {
-            process: (value, params, local, op) => {
-                value.ackDelete(params, local, op);
+        ],
+        [
+            "delete",
+            {
+                process: (collection, params, local, op) => {
+                    collection.ackDelete(params, local, op);
+                },
+                rebase: (collection, op, localOpMetadata) => {
+                    // Deletion of intervals is based on id, so requires no rebasing.
+                    return { rebasedOp: op, rebasedLocalOpMetadata: localOpMetadata };
+                },
             },
-        },
-    ],
-    [
-        "change",
-        {
-            process: (value, params, local, op) => {
-                value.ackChange(params, local, op);
+        ],
+        [
+            "change",
+            {
+                process: (collection, params, local, op) => {
+                    collection.ackChange(params, local, op);
+                },
+                rebase,
             },
-        },
-    ]]);
+        ]]);
+}
 class IntervalCollectionIterator {
     constructor(collection, iteratesForward = true, start, end) {
         this.results = [];
@@ -630,26 +773,35 @@ class IntervalCollectionIterator {
 }
 exports.IntervalCollectionIterator = IntervalCollectionIterator;
 class IntervalCollection extends common_utils_1.TypedEventEmitter {
+    /** @internal */
     constructor(helpers, requiresClient, emitter, serializedIntervals) {
         super();
         this.helpers = helpers;
         this.requiresClient = requiresClient;
         this.emitter = emitter;
-        this.savedSerializedIntervals = serializedIntervals;
+        this.pendingChangesStart = new Map();
+        this.pendingChangesEnd = new Map();
+        if (Array.isArray(serializedIntervals)) {
+            this.savedSerializedIntervals = serializedIntervals;
+        }
+        else {
+            this.savedSerializedIntervals =
+                serializedIntervals.intervals.map((i) => decompressInterval(i, serializedIntervals.label));
+        }
     }
     get attached() {
         return !!this.localCollection;
     }
     attachGraph(client, label) {
         if (this.attached) {
-            throw new Error("Only supports one Sequence attach");
+            throw new telemetry_utils_1.LoggingError("Only supports one Sequence attach");
         }
         if ((client === undefined) && (this.requiresClient)) {
-            throw new Error("Client required for this collection");
+            throw new telemetry_utils_1.LoggingError("Client required for this collection");
         }
         // Instantiate the local interval collection based on the saved intervals
         this.client = client;
-        this.localCollection = new LocalIntervalCollection(client, label, this.helpers);
+        this.localCollection = new LocalIntervalCollection(client, label, this.helpers, (interval) => this.emit("changeInterval", interval, true, undefined));
         if (this.savedSerializedIntervals) {
             for (const serializedInterval of this.savedSerializedIntervals) {
                 this.localCollection.ensureSerializedId(serializedInterval);
@@ -658,16 +810,33 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
         }
         this.savedSerializedIntervals = undefined;
     }
+    /**
+     * Gets the next local sequence number, modifying this client's collab window in doing so.
+     */
+    getNextLocalSeq() {
+        return ++this.client.getCollabWindow().localSeq;
+    }
     getIntervalById(id) {
         if (!this.attached) {
-            throw new Error("attach must be called before accessing intervals");
+            throw new telemetry_utils_1.LoggingError("attach must be called before accessing intervals");
         }
         return this.localCollection.getIntervalById(id);
     }
+    /**
+     * Create a new interval and add it to the collection
+     * @param start - interval start position
+     * @param end - interval end position
+     * @param intervalType - type of the interval. All intervals are SlideOnRemove. Intervals may not be Transient.
+     * @param props - properties of the interval
+     * @returns - the created interval
+     */
     add(start, end, intervalType, props) {
         var _a, _b;
         if (!this.attached) {
-            throw new Error("attach must be called prior to adding intervals");
+            throw new telemetry_utils_1.LoggingError("attach must be called prior to adding intervals");
+        }
+        if (intervalType & IntervalType.Transient) {
+            throw new telemetry_utils_1.LoggingError("Can not add transient intervals");
         }
         const interval = this.localCollection.addInterval(start, end, intervalType, props);
         if (interval) {
@@ -679,7 +848,7 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
                 start,
             };
             // Local ops get submitted to the server. Remote ops have the deserializer run.
-            this.emitter.emit("add", undefined, serializedInterval);
+            this.emitter.emit("add", undefined, serializedInterval, { localSeq: this.getNextLocalSeq() });
         }
         this.emit("addInterval", interval, true, undefined);
         return interval;
@@ -690,7 +859,7 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
         if (interval) {
             // Local ops get submitted to the server. Remote ops have the deserializer run.
             if (local) {
-                this.emitter.emit("delete", undefined, interval.serialize(this.client));
+                this.emitter.emit("delete", undefined, interval.serialize(this.client), { localSeq: this.getNextLocalSeq() });
             }
             else {
                 if (this.onDeserialize) {
@@ -709,40 +878,41 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
     }
     changeProperties(id, props) {
         if (!this.attached) {
-            throw new Error("Attach must be called before accessing intervals");
+            throw new telemetry_utils_1.LoggingError("Attach must be called before accessing intervals");
         }
         if (typeof (id) !== "string") {
-            throw new Error("Change API requires an ID that is a string");
+            throw new telemetry_utils_1.LoggingError("Change API requires an ID that is a string");
         }
         if (!props) {
-            throw new Error("changeProperties should be called with a property set");
+            throw new telemetry_utils_1.LoggingError("changeProperties should be called with a property set");
         }
         const interval = this.getIntervalById(id);
         if (interval) {
             // Pass Unassigned as the sequence number to indicate that this is a local op that is waiting for an ack.
             const deltaProps = interval.addProperties(props, true, merge_tree_1.UnassignedSequenceNumber);
             const serializedInterval = interval.serialize(this.client);
-            // Emit a change op that will only change properties. Add the ID to the property bag provided by the caller.
+            // Emit a change op that will only change properties. Add the ID to
+            // the property bag provided by the caller.
             serializedInterval.start = undefined;
             serializedInterval.end = undefined;
             serializedInterval.properties = props;
             serializedInterval.properties[reservedIntervalIdKey] = interval.getIntervalId();
-            this.emitter.emit("change", undefined, serializedInterval);
+            this.emitter.emit("change", undefined, serializedInterval, { localSeq: this.getNextLocalSeq() });
             this.emit("propertyChanged", interval, deltaProps);
         }
         this.emit("changeInterval", interval, true, undefined);
     }
     change(id, start, end) {
         if (!this.attached) {
-            throw new Error("Attach must be called before accessing intervals");
+            throw new telemetry_utils_1.LoggingError("Attach must be called before accessing intervals");
         }
+        // Force id to be a string.
         if (typeof (id) !== "string") {
-            throw new Error("Change API requires an ID that is a string");
+            throw new telemetry_utils_1.LoggingError("Change API requires an ID that is a string");
         }
-        // Force id to be a string.
         const interval = this.getIntervalById(id);
         if (interval) {
-            this.localCollection.changeInterval(interval, start, end);
+            const newInterval = this.localCollection.changeInterval(interval, start, end);
             const serializedInterval = interval.serialize(this.client);
             serializedInterval.start = start;
             serializedInterval.end = end;
@@ -751,23 +921,19 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
                 {
                     [reservedIntervalIdKey]: interval.getIntervalId(),
                 };
-            this.emitter.emit("change", undefined, serializedInterval);
+            this.emitter.emit("change", undefined, serializedInterval, { localSeq: this.getNextLocalSeq() });
             this.addPendingChange(id, serializedInterval);
+            this.emit("changeInterval", newInterval, true, undefined);
+            return newInterval;
         }
-        this.emit("changeInterval", interval, true, undefined);
-        return interval;
+        // No interval to change
+        return undefined;
     }
     addPendingChange(id, serializedInterval) {
         if (serializedInterval.start !== undefined) {
-            if (!this.pendingChangesStart) {
-                this.pendingChangesStart = new Map();
-            }
             this.addPendingChangeHelper(id, this.pendingChangesStart, serializedInterval);
         }
         if (serializedInterval.end !== undefined) {
-            if (!this.pendingChangesEnd) {
-                this.pendingChangesEnd = new Map();
-            }
             this.addPendingChangeHelper(id, this.pendingChangesEnd, serializedInterval);
         }
     }
@@ -780,8 +946,9 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
         entries.push(serializedInterval);
     }
     removePendingChange(serializedInterval) {
+        var _a;
         // Change ops always have an ID.
-        const id = serializedInterval.properties[reservedIntervalIdKey];
+        const id = (_a = serializedInterval.properties) === null || _a === void 0 ? void 0 : _a[reservedIntervalIdKey];
         if (serializedInterval.start !== undefined) {
             this.removePendingChangeHelper(id, this.pendingChangesStart, serializedInterval);
         }
@@ -790,26 +957,24 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
         }
     }
     removePendingChangeHelper(id, pendingChanges, serializedInterval) {
-        const entries = pendingChanges === null || pendingChanges === void 0 ? void 0 : pendingChanges.get(id);
+        const entries = pendingChanges.get(id);
         if (entries) {
             const pendingChange = entries.shift();
             if (entries.length === 0) {
                 pendingChanges.delete(id);
             }
-            if (pendingChange.start !== serializedInterval.start ||
-                pendingChange.end !== serializedInterval.end) {
-                throw new Error("Mismatch in pending changes");
+            if ((pendingChange === null || pendingChange === void 0 ? void 0 : pendingChange.start) !== serializedInterval.start ||
+                (pendingChange === null || pendingChange === void 0 ? void 0 : pendingChange.end) !== serializedInterval.end) {
+                throw new telemetry_utils_1.LoggingError("Mismatch in pending changes");
             }
         }
     }
     hasPendingChangeStart(id) {
-        var _a;
-        const entries = (_a = this.pendingChangesStart) === null || _a === void 0 ? void 0 : _a.get(id);
+        const entries = this.pendingChangesStart.get(id);
         return entries && entries.length !== 0;
     }
     hasPendingChangeEnd(id) {
-        var _a;
-        const entries = (_a = this.pendingChangesEnd) === null || _a === void 0 ? void 0 : _a.get(id);
+        const entries = this.pendingChangesEnd.get(id);
         return entries && entries.length !== 0;
     }
     /** @deprecated - use ackChange */
@@ -818,22 +983,23 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
     }
     /** @internal */
     ackChange(serializedInterval, local, op) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         if (!this.attached) {
-            throw new Error("Attach must be called before accessing intervals");
+            throw new telemetry_utils_1.LoggingError("Attach must be called before accessing intervals");
         }
         let interval;
         if (local) {
             // This is an ack from the server. Remove the pending change.
             this.removePendingChange(serializedInterval);
-            const id = serializedInterval.properties[reservedIntervalIdKey];
+            const id = (_a = serializedInterval.properties) === null || _a === void 0 ? void 0 : _a[reservedIntervalIdKey];
             interval = this.getIntervalById(id);
             if (interval) {
                 // Let the propertyManager prune its pending change-properties set.
-                (_a = interval.propertyManager) === null || _a === void 0 ? void 0 : _a.ackPendingProperties({
-                    type: 2 /* ANNOTATE */,
-                    props: serializedInterval.properties,
+                (_b = interval.propertyManager) === null || _b === void 0 ? void 0 : _b.ackPendingProperties({
+                    type: merge_tree_1.MergeTreeDeltaType.ANNOTATE,
+                    props: (_c = serializedInterval.properties) !== null && _c !== void 0 ? _c : {},
                 });
+                this.ackInterval(interval, op);
             }
         }
         else {
@@ -842,7 +1008,7 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
             // Note that the ID is in the property bag only to allow us to find the interval.
             // This API cannot change the ID, and writing to the ID property will result in an exception. So we
             // strip it out of the properties here.
-            const _c = serializedInterval.properties, _d = reservedIntervalIdKey, id = _c[_d], newProps = __rest(_c, [typeof _d === "symbol" ? _d : _d + ""]);
+            const _e = serializedInterval.properties, _f = reservedIntervalIdKey, id = _e[_f], newProps = __rest(_e, [typeof _f === "symbol" ? _f : _f + ""]);
             interval = this.getIntervalById(id);
             if (interval) {
                 let start;
@@ -857,7 +1023,7 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
                 if (start !== undefined || end !== undefined) {
                     // If changeInterval gives us a new interval, work with that one. Otherwise keep working with
                     // the one we originally found in the tree.
-                    interval = (_b = this.localCollection.changeInterval(interval, start, end, op)) !== null && _b !== void 0 ? _b : interval;
+                    interval = (_d = this.localCollection.changeInterval(interval, start, end, op)) !== null && _d !== void 0 ? _d : interval;
                 }
                 const deltaProps = interval.addProperties(newProps, true, op.sequenceNumber);
                 if (this.onDeserialize) {
@@ -872,7 +1038,7 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
     }
     addConflictResolver(conflictResolver) {
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         this.localCollection.addConflictResolver(conflictResolver);
     }
@@ -885,22 +1051,109 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
         this.onDeserialize = onDeserialize;
         // Trigger the async prepare work across all values in the collection
         this.localCollection.map((interval) => {
-            this.onDeserialize(interval);
+            onDeserialize(interval);
         });
     }
+    /** @internal */
+    rebaseLocalInterval(opName, serializedInterval, localSeq) {
+        var _a, _b;
+        if (!this.attached) {
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
+        }
+        const { start, end, intervalType, properties, sequenceNumber } = serializedInterval;
+        const startRebased = start === undefined ? undefined :
+            this.client.rebasePosition(start, sequenceNumber, localSeq);
+        const endRebased = end === undefined ? undefined :
+            this.client.rebasePosition(end, sequenceNumber, localSeq);
+        const intervalId = properties === null || properties === void 0 ? void 0 : properties[reservedIntervalIdKey];
+        const rebased = {
+            start: startRebased,
+            end: endRebased,
+            intervalType,
+            sequenceNumber: (_b = (_a = this.client) === null || _a === void 0 ? void 0 : _a.getCurrentSeq()) !== null && _b !== void 0 ? _b : 0,
+            properties,
+        };
+        if (opName === "change" && (this.hasPendingChangeStart(intervalId) || this.hasPendingChangeEnd(intervalId))) {
+            this.removePendingChange(serializedInterval);
+            this.addPendingChange(intervalId, rebased);
+        }
+        return rebased;
+    }
+    getSlideToSegment(lref) {
+        const segoff = { segment: lref.segment, offset: lref.offset };
+        const newSegoff = this.client.getSlideToSegment(segoff);
+        const value = (segoff.segment === newSegoff.segment && segoff.offset === newSegoff.offset) ? undefined : newSegoff;
+        return value;
+    }
+    setSlideOnRemove(lref) {
+        let refType = lref.refType;
+        refType = refType & ~merge_tree_1.ReferenceType.StayOnRemove;
+        refType = refType | merge_tree_1.ReferenceType.SlideOnRemove;
+        lref.refType = refType;
+    }
+    ackInterval(interval, op) {
+        // in current usage, interval is always a SequenceInterval
+        if (!(interval instanceof SequenceInterval)) {
+            return;
+        }
+        if (!(0, merge_tree_1.refTypeIncludesFlag)(interval.start, merge_tree_1.ReferenceType.StayOnRemove) &&
+            !(0, merge_tree_1.refTypeIncludesFlag)(interval.end, merge_tree_1.ReferenceType.StayOnRemove)) {
+            return;
+        }
+        const newStart = this.getSlideToSegment(interval.start);
+        const newEnd = this.getSlideToSegment(interval.end);
+        const id = interval.properties[reservedIntervalIdKey];
+        const hasPendingStartChange = this.hasPendingChangeStart(id);
+        const hasPendingEndChange = this.hasPendingChangeEnd(id);
+        if (!hasPendingStartChange) {
+            this.setSlideOnRemove(interval.start);
+        }
+        if (!hasPendingEndChange) {
+            this.setSlideOnRemove(interval.end);
+        }
+        const needsStartUpdate = newStart !== undefined && !hasPendingStartChange;
+        const needsEndUpdate = newEnd !== undefined && !hasPendingEndChange;
+        if (needsStartUpdate || needsEndUpdate) {
+            // In this case, where we change the start or end of an interval,
+            // it is necessary to remove and re-add the interval listeners.
+            // This ensures that the correct listeners are added to the ReferencePosition.
+            this.localCollection.removeExistingInterval(interval);
+            if (needsStartUpdate) {
+                const props = interval.start.properties;
+                this.client.removeLocalReferencePosition(interval.start);
+                interval.start = createPositionReferenceFromSegoff(this.client, newStart, interval.start.refType, op);
+                if (props) {
+                    interval.start.addProperties(props);
+                }
+            }
+            if (needsEndUpdate) {
+                const props = interval.end.properties;
+                this.client.removeLocalReferencePosition(interval.end);
+                interval.end = createPositionReferenceFromSegoff(this.client, newEnd, interval.end.refType, op);
+                if (props) {
+                    interval.end.addProperties(props);
+                }
+            }
+            this.localCollection.add(interval);
+        }
+    }
     /** @deprecated - use ackAdd */
     addInternal(serializedInterval, local, op) {
         return this.ackAdd(serializedInterval, local, op);
     }
     /** @internal */
     ackAdd(serializedInterval, local, op) {
+        var _a;
         if (local) {
-            // Local ops were applied when the message was created and there's no "pending add"
-            // state to bookkeep
+            const id = (_a = serializedInterval.properties) === null || _a === void 0 ? void 0 : _a[reservedIntervalIdKey];
+            const localInterval = this.getIntervalById(id);
+            if (localInterval) {
+                this.ackInterval(localInterval, op);
+            }
             return;
         }
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         this.localCollection.ensureSerializedId(serializedInterval);
         const interval = this.localCollection.addInterval(serializedInterval.start, serializedInterval.end, serializedInterval.intervalType, serializedInterval.properties, op);
@@ -925,17 +1178,20 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
             return;
         }
         if (!this.attached) {
-            throw new Error("attach must be called prior to deleting intervals");
+            throw new telemetry_utils_1.LoggingError("attach must be called prior to deleting intervals");
         }
-        this.localCollection.ensureSerializedId(serializedInterval);
-        const interval = this.localCollection.getIntervalById(serializedInterval.properties[reservedIntervalIdKey]);
+        const id = this.localCollection.ensureSerializedId(serializedInterval);
+        const interval = this.localCollection.getIntervalById(id);
         if (interval) {
             this.deleteExistingInterval(interval, local, op);
         }
     }
+    /**
+     * @internal
+     */
     serializeInternal() {
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         return this.localCollection.serialize();
     }
@@ -967,25 +1223,25 @@ class IntervalCollection extends common_utils_1.TypedEventEmitter {
     }
     findOverlappingIntervals(startPosition, endPosition) {
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         return this.localCollection.findOverlappingIntervals(startPosition, endPosition);
     }
     map(fn) {
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         this.localCollection.map(fn);
     }
     previousInterval(pos) {
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         return this.localCollection.previousInterval(pos);
     }
     nextInterval(pos) {
         if (!this.attached) {
-            throw new Error("attachSequence must be called");
+            throw new telemetry_utils_1.LoggingError("attachSequence must be called");
         }
         return this.localCollection.nextInterval(pos);
     }