@fluidframework/sequence 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0

package/dist/intervalCollection.js

@@ -18,7 +18,7 @@ const intervalIndex_1 = require("./intervalIndex");
  * Defines a side relative to a character in a sequence.
  *
  * @remarks See {@link SequencePlace} for additional context on usage.
- * @public
+ * @alpha
  */
 var Side;
 (function (Side) {
@@ -329,6 +329,9 @@ function makeOpsMap() {
     const rebase = (collection, op, localOpMetadata) => {
         const { localSeq } = localOpMetadata;
         const rebasedValue = collection.rebaseLocalInterval(op.opName, op.value, localSeq);
+        if (rebasedValue === undefined) {
+            return undefined;
+        }
         const rebasedOp = { ...op, value: rebasedValue };
         return { rebasedOp, rebasedLocalOpMetadata: localOpMetadata };
     };
@@ -661,58 +664,54 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
     }
     /**
      * {@inheritdoc IIntervalCollection.changeProperties}
+     * @deprecated - call change with the id and an object containing the new props values
      */
     changeProperties(id, props) {
-        if (!this.attached) {
-            throw new telemetry_utils_1.LoggingError("Attach must be called before accessing intervals");
-        }
-        if (typeof id !== "string") {
-            throw new telemetry_utils_1.LoggingError("Change API requires an ID that is a string");
-        }
-        if (!props) {
-            throw new telemetry_utils_1.LoggingError("changeProperties should be called with a property set");
-        }
-        // prevent the overwriting of an interval label, it should remain unchanged
-        // once it has been inserted into the collection.
-        if (props[merge_tree_1.reservedRangeLabelsKey] !== undefined) {
-            throw new telemetry_utils_1.LoggingError("The label property should not be modified once inserted to the collection");
+        this.change(id, { props });
+    }
+    change(arg1, arg2, arg3) {
+        const id = arg1;
+        let start;
+        let end;
+        let props;
+        if (isSequencePlace(arg2)) {
+            start = arg2;
+            end = arg3;
         }
-        const interval = this.getIntervalById(id);
-        if (interval) {
-            const deltaProps = interval.addProperties(props, true, this.isCollaborating ? merge_tree_1.UnassignedSequenceNumber : merge_tree_1.UniversalSequenceNumber);
-            const serializedInterval = interval.serialize();
-            // 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();
-            const localSeq = this.getNextLocalSeq();
-            this.localSeqToSerializedInterval.set(localSeq, serializedInterval);
-            this.emitter.emit("change", undefined, serializedInterval, { localSeq });
-            this.emit("propertyChanged", interval, deltaProps, true, undefined);
+        else {
+            start = arg2.start;
+            end = arg2.end;
+            props = arg2.props;
         }
-    }
-    /**
-     * {@inheritdoc IIntervalCollection.change}
-     */
-    change(id, start, end) {
         if (!this.localCollection) {
             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 telemetry_utils_1.LoggingError("Change API requires an ID that is a string");
+            throw new telemetry_utils_1.UsageError("Change API requires an ID that is a string");
+        }
+        // Ensure that both start and end are defined or both are undefined.
+        if ((start === undefined) !== (end === undefined)) {
+            throw new telemetry_utils_1.UsageError("Change API requires both start and end to be defined or undefined");
+        }
+        // prevent the overwriting of an interval label, it should remain unchanged
+        // once it has been inserted into the collection.
+        if (props?.[merge_tree_1.reservedRangeLabelsKey] !== undefined) {
+            throw new telemetry_utils_1.UsageError("The label property should not be modified once inserted to the collection");
         }
         const interval = this.getIntervalById(id);
         if (interval) {
-            const newInterval = this.localCollection.changeInterval(interval, start, end);
-            if (!newInterval) {
-                return undefined;
+            let deltaProps;
+            let newInterval;
+            if (props !== undefined) {
+                deltaProps = interval.addProperties(props, true, this.isCollaborating ? merge_tree_1.UnassignedSequenceNumber : merge_tree_1.UniversalSequenceNumber);
             }
-            if (!this.isCollaborating && newInterval instanceof intervals_1.SequenceInterval) {
-                setSlideOnRemove(newInterval.start);
-                setSlideOnRemove(newInterval.end);
+            if (start !== undefined && end !== undefined) {
+                newInterval = this.localCollection.changeInterval(interval, start, end);
+                if (!this.isCollaborating && newInterval instanceof intervals_1.SequenceInterval) {
+                    setSlideOnRemove(newInterval.start);
+                    setSlideOnRemove(newInterval.end);
+                }
             }
             const serializedInterval = interval.serialize();
             const { startPos, startSide, endPos, endSide } = endpointPosAndSide(start, end);
@@ -722,15 +721,21 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
             serializedInterval.startSide = startSide;
             serializedInterval.endSide = endSide;
             serializedInterval.stickiness = stickiness;
-            // Emit a property bag containing only the ID, as we don't intend for this op to change any properties.
+            // Emit a property bag containing the ID and the other (if any) properties changed
             serializedInterval.properties = {
                 [reservedIntervalIdKey]: interval.getIntervalId(),
+                ...props,
             };
             const localSeq = this.getNextLocalSeq();
             this.localSeqToSerializedInterval.set(localSeq, serializedInterval);
             this.emitter.emit("change", undefined, serializedInterval, { localSeq });
-            this.addPendingChange(id, serializedInterval);
-            this.emitChange(newInterval, interval, true, false);
+            if (deltaProps !== undefined) {
+                this.emit("propertyChanged", interval, deltaProps, true, undefined);
+            }
+            if (newInterval) {
+                this.addPendingChange(id, serializedInterval);
+                this.emitChange(newInterval, interval, true, false);
+            }
             return newInterval;
         }
         // No interval to change
@@ -1025,7 +1030,7 @@ class IntervalCollection extends client_utils_1.TypedEventEmitter {
     ackDelete(serializedInterval, local, op) {
         if (local) {
             // Local ops were applied when the message was created and there's no "pending delete"
-            // state to bookkeep: remote operation application takes into account possibility of
+            // state to book keep: remote operation application takes into account possibility of
             // locally deleted interval whenever a lookup happens.
             return;
         }
@@ -1142,7 +1147,7 @@ function setSlideOnRemove(lref) {
  * @returns undefined if the reference position is not the endpoint of any interval (e.g. it was created
  * on the merge tree directly by app code), otherwise an {@link IntervalLocator} for the interval this
  * endpoint is a part of.
- * @public
+ * @internal
  */
 function intervalLocatorFromEndpoint(potentialEndpoint) {
     const { interval, [merge_tree_1.reservedRangeLabelsKey]: collectionNameArray } = potentialEndpoint.properties ?? {};