@fluidframework/sequence 2.12.0 → 2.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.12.0",
+  "version": "2.20.0",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -79,37 +79,37 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.12.0",
-    "@fluidframework/core-interfaces": "~2.12.0",
-    "@fluidframework/core-utils": "~2.12.0",
-    "@fluidframework/datastore-definitions": "~2.12.0",
-    "@fluidframework/driver-definitions": "~2.12.0",
-    "@fluidframework/merge-tree": "~2.12.0",
-    "@fluidframework/runtime-definitions": "~2.12.0",
-    "@fluidframework/runtime-utils": "~2.12.0",
-    "@fluidframework/shared-object-base": "~2.12.0",
-    "@fluidframework/telemetry-utils": "~2.12.0",
+    "@fluid-internal/client-utils": "~2.20.0",
+    "@fluidframework/core-interfaces": "~2.20.0",
+    "@fluidframework/core-utils": "~2.20.0",
+    "@fluidframework/datastore-definitions": "~2.20.0",
+    "@fluidframework/driver-definitions": "~2.20.0",
+    "@fluidframework/merge-tree": "~2.20.0",
+    "@fluidframework/runtime-definitions": "~2.20.0",
+    "@fluidframework/runtime-utils": "~2.20.0",
+    "@fluidframework/shared-object-base": "~2.20.0",
+    "@fluidframework/telemetry-utils": "~2.20.0",
     "double-ended-queue": "^2.1.0-0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.12.0",
-    "@fluid-private/stochastic-test-utils": "~2.12.0",
-    "@fluid-private/test-dds-utils": "~2.12.0",
+    "@fluid-internal/mocha-test-setup": "~2.20.0",
+    "@fluid-private/stochastic-test-utils": "~2.20.0",
+    "@fluid-private/test-dds-utils": "~2.20.0",
     "@fluid-tools/benchmark": "^0.50.0",
     "@fluid-tools/build-cli": "^0.51.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.51.0",
-    "@fluidframework/container-definitions": "~2.12.0",
+    "@fluidframework/container-definitions": "~2.20.0",
     "@fluidframework/eslint-config-fluid": "^5.6.0",
-    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.11.0",
-    "@fluidframework/test-runtime-utils": "~2.12.0",
+    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.13.0",
+    "@fluidframework/test-runtime-utils": "~2.20.0",
     "@microsoft/api-extractor": "7.47.8",
     "@types/diff": "^3.5.1",
     "@types/double-ended-queue": "^2.1.0",
-    "@types/mocha": "^9.1.1",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "@types/uuid": "^9.0.2",
     "c8": "^8.0.1",
@@ -136,7 +136,56 @@
     }
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Class_BaseSegment": {
+        "backCompat": false
+      },
+      "Class_Marker": {
+        "backCompat": false
+      },
+      "Class_TextSegment": {
+        "backCompat": false
+      },
+      "Class_TrackingGroup": {
+        "backCompat": false
+      },
+      "ClassStatics_BaseSegment": {
+        "backCompat": false
+      },
+      "ClassStatics_Marker": {
+        "backCompat": false
+      },
+      "ClassStatics_TextSegment": {
+        "backCompat": false
+      },
+      "ClassStatics_TrackingGroup": {
+        "backCompat": false
+      },
+      "Interface_ISegment": {
+        "backCompat": false
+      },
+      "Interface_ISequenceDeltaRange": {
+        "backCompat": false
+      },
+      "Interface_SequenceDeltaEvent": {
+        "backCompat": false
+      },
+      "Interface_SequenceEvent": {
+        "backCompat": false
+      },
+      "Interface_SequenceMaintenanceEvent": {
+        "backCompat": false
+      },
+      "TypeAlias_IntervalRevertible": {
+        "backCompat": false
+      },
+      "TypeAlias_SharedStringRevertible": {
+        "backCompat": false
+      },
+      "TypeAlias_SharedStringSegment": {
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/intervals/sequenceInterval.ts

@@ -29,6 +29,7 @@ import {
 	endpointPosAndSide,
 	addProperties,
 	copyPropertiesAndManager,
+	type ISegmentInternal,
 } from "@fluidframework/merge-tree/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
@@ -196,8 +197,8 @@ export class SequenceIntervalClass implements SequenceInterval {
 
 	/***/
 	public get stickiness(): IntervalStickiness {
-		const startSegment = this.start.getSegment();
-		const endSegment = this.end.getSegment();
+		const startSegment: ISegmentInternal | undefined = this.start.getSegment();
+		const endSegment: ISegmentInternal | undefined = this.end.getSegment();
 		return computeStickinessFromSide(
 			startSegment?.endpointType,
 			this.startSide,
@@ -428,10 +429,12 @@ export class SequenceIntervalClass implements SequenceInterval {
 		useNewSlidingBehavior: boolean = false,
 	) {
 		const { startSide, endSide, startPos, endPos } = endpointPosAndSide(start, end);
+		const startSegment: ISegmentInternal | undefined = this.start.getSegment();
+		const endSegment: ISegmentInternal | undefined = this.end.getSegment();
 		const stickiness = computeStickinessFromSide(
-			startPos ?? this.start.getSegment()?.endpointType,
+			startPos ?? startSegment?.endpointType,
 			startSide ?? this.startSide,
-			endPos ?? this.end.getSegment()?.endpointType,
+			endPos ?? endSegment?.endpointType,
 			endSide ?? this.endSide,
 		);
 		const getRefType = (baseType: ReferenceType): ReferenceType => {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.12.0";
+export const pkgVersion = "2.20.0";

package/src/revertibles.ts

@@ -14,7 +14,6 @@ import {
 	PropertySet,
 	ReferenceType,
 	SlidingPreference, // eslint-disable-next-line import/no-deprecated
-	SortedSet,
 	appendToMergeTreeDeltaRevertibles,
 	discardMergeTreeDeltaRevertible,
 	getSlideToSegoff,
@@ -24,6 +23,9 @@ import {
 	InteriorSequencePlace,
 	Side,
 	type ISegmentInternal,
+	segmentIsRemoved,
+	SortedSegmentSet,
+	type ISegment,
 } from "@fluidframework/merge-tree/internal";
 
 import { IntervalOpType, SequenceInterval, SequenceIntervalClass } from "./intervals/index.js";
@@ -127,18 +129,16 @@ export function appendDeleteIntervalToRevertibles(
 	if (!startSeg) {
 		return revertibles;
 	}
-	const startType =
-		startSeg.removedSeq !== undefined
-			? ReferenceType.SlideOnRemove | ReferenceType.RangeBegin
-			: ReferenceType.StayOnRemove | ReferenceType.RangeBegin;
+	const startType = segmentIsRemoved(startSeg)
+		? ReferenceType.SlideOnRemove | ReferenceType.RangeBegin
+		: ReferenceType.StayOnRemove | ReferenceType.RangeBegin;
 	const endSeg = interval.end.getSegment() as SharedStringSegment | undefined;
 	if (!endSeg) {
 		return revertibles;
 	}
-	const endType =
-		endSeg.removedSeq !== undefined
-			? ReferenceType.SlideOnRemove | ReferenceType.RangeEnd
-			: ReferenceType.StayOnRemove | ReferenceType.RangeEnd;
+	const endType = segmentIsRemoved(startSeg)
+		? ReferenceType.SlideOnRemove | ReferenceType.RangeEnd
+		: ReferenceType.StayOnRemove | ReferenceType.RangeEnd;
 	const startRef = string.createLocalReferencePosition(
 		startSeg,
 		interval.start.getOffset(),
@@ -181,15 +181,13 @@ export function appendChangeIntervalToRevertibles(
 	// This logic is needed because the ReferenceType StayOnRemove cannot be used
 	// on removed segments. This works for revertibles because the old position of the
 	// interval within the removed segment is handled by the remove range revertible.
-	const startType =
-		startSeg.removedSeq !== undefined
-			? ReferenceType.SlideOnRemove | ReferenceType.RangeBegin
-			: ReferenceType.StayOnRemove | ReferenceType.RangeBegin;
+	const startType = segmentIsRemoved(startSeg)
+		? ReferenceType.SlideOnRemove | ReferenceType.RangeBegin
+		: ReferenceType.StayOnRemove | ReferenceType.RangeBegin;
 	const endSeg = previousInterval.end.getSegment() as SharedStringSegment;
-	const endType =
-		endSeg.removedSeq !== undefined
-			? ReferenceType.SlideOnRemove | ReferenceType.RangeEnd
-			: ReferenceType.StayOnRemove | ReferenceType.RangeEnd;
+	const endType = segmentIsRemoved(startSeg)
+		? ReferenceType.SlideOnRemove | ReferenceType.RangeEnd
+		: ReferenceType.StayOnRemove | ReferenceType.RangeEnd;
 	const prevStartRef = string.createLocalReferencePosition(
 		startSeg,
 		previousInterval.start.getOffset(),
@@ -582,14 +580,11 @@ function newEndpointPosition(
 interface RangeInfo {
 	ranges: readonly Readonly<ISequenceDeltaRange<MergeTreeDeltaOperationType>>[];
 	length: number;
+	segment: ISegment;
 }
 
 // eslint-disable-next-line import/no-deprecated
-class SortedRangeSet extends SortedSet<RangeInfo, string> {
-	protected getKey(item: RangeInfo): string {
-		return item.ranges[0].segment.ordinal;
-	}
-}
+class SortedRangeSet extends SortedSegmentSet<RangeInfo> {}
 
 function revertLocalSequenceRemove(
 	sharedString: ISharedString,
@@ -602,7 +597,11 @@ function revertLocalSequenceRemove(
 			event.ranges.forEach((range) => {
 				length += range.segment.cachedLength;
 			});
-			restoredRanges.addOrUpdate({ ranges: event.ranges, length });
+			restoredRanges.addOrUpdate({
+				ranges: event.ranges,
+				length,
+				segment: event.ranges[0].segment,
+			});
 		}
 	};
 	sharedString.on("sequenceDelta", saveSegments);

package/src/sequence.ts

@@ -16,7 +16,6 @@ import {
 	ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import {
-	// eslint-disable-next-line import/no-deprecated
 	Client,
 	IJSONSegment,
 	IMergeTreeAnnotateMsg,
@@ -36,8 +35,6 @@ import {
 	PropertySet,
 	ReferencePosition,
 	ReferenceType,
-	// eslint-disable-next-line import/no-deprecated
-	SegmentGroup,
 	SlidingPreference,
 	createAnnotateRangeOp,
 	// eslint-disable-next-line import/no-deprecated
@@ -504,7 +501,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		return this.ongoingResubmitRefSeq ?? this.deltaManager.lastSequenceNumber;
 	}
 
-	// eslint-disable-next-line import/no-deprecated
 	protected client: Client;
 	private messagesSinceMSNChange: ISequencedDocumentMessage[] = [];
 	private readonly intervalCollections: IntervalCollectionMap<SequenceInterval>;
@@ -543,7 +539,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			dataStoreRuntime.options,
 		);
 
-		// eslint-disable-next-line import/no-deprecated
 		this.client = new Client(
 			segmentFromSpec,
 			createChildLogger({
@@ -812,11 +807,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				)
 			) {
 				this.submitSequenceMessage(
-					this.client.regeneratePendingOp(
-						content as IMergeTreeOp,
-						// eslint-disable-next-line import/no-deprecated
-						localOpMetadata as SegmentGroup | SegmentGroup[],
-					),
+					this.client.regeneratePendingOp(content as IMergeTreeOp, localOpMetadata),
 				);
 			}
 		});