@fluidframework/sequence 2.91.0 → 2.92.0

package/src/intervalCollection.ts

@@ -6,25 +6,27 @@
 /* eslint-disable no-bitwise */
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { IEvent } from "@fluidframework/core-interfaces";
+import type { IEvent } from "@fluidframework/core-interfaces";
 import {
 	assert,
 	DoublyLinkedList,
 	unreachableCase,
 	type ListNode,
 } from "@fluidframework/core-utils/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import {
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type {
 	Client,
 	ISegment,
 	LocalReferencePosition,
 	PropertySet,
+	SequencePlace,
+} from "@fluidframework/merge-tree/internal";
+import {
 	ReferenceType,
 	getSlideToSegoff,
 	refTypeIncludesFlag,
 	reservedRangeLabelsKey,
 	Side,
-	SequencePlace,
 	endpointPosAndSide,
 	type ISegmentInternal,
 	createLocalReconnectingPerspective,
@@ -33,12 +35,12 @@ import {
 import { LoggingError, UsageError } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
 
-import {
+import type {
+	IIntervalCollectionTypeOperationValue,
+	IntervalAddLocalMetadata,
+	IntervalChangeLocalMetadata,
 	IntervalMessageLocalMetadata,
 	SequenceOptions,
-	type IIntervalCollectionTypeOperationValue,
-	type IntervalAddLocalMetadata,
-	type IntervalChangeLocalMetadata,
 } from "./intervalCollectionMapInterfaces.js";
 import {
 	createIdIntervalIndex,
@@ -49,14 +51,16 @@ import {
 	type ISequenceOverlappingIntervalsIndex,
 	type SequenceIntervalIndex,
 } from "./intervalIndex/index.js";
-import {
+import type {
 	CompressedSerializedInterval,
 	ISerializedInterval,
-	IntervalStickiness,
-	IntervalType,
 	SequenceInterval,
 	SequenceIntervalClass,
 	SerializedIntervalDelta,
+} from "./intervals/index.js";
+import {
+	IntervalStickiness,
+	IntervalType,
 	createPositionReferenceFromSegoff,
 	createSequenceInterval,
 	getSerializedProperties,
@@ -72,8 +76,8 @@ export interface ISerializedIntervalCollectionV2 {
 }
 
 function sidesFromStickiness(stickiness: IntervalStickiness) {
-	const startSide = (stickiness & IntervalStickiness.START) !== 0 ? Side.After : Side.Before;
-	const endSide = (stickiness & IntervalStickiness.END) !== 0 ? Side.Before : Side.After;
+	const startSide = (stickiness & IntervalStickiness.START) === 0 ? Side.Before : Side.After;
+	const endSide = (stickiness & IntervalStickiness.END) === 0 ? Side.After : Side.Before;
 
 	return { startSide, endSide };
 }
@@ -853,8 +857,9 @@ export class IntervalCollection
 				}
 				break;
 			}
-			default:
+			default: {
 				unreachableCase(type);
+			}
 		}
 	}
 
@@ -903,8 +908,9 @@ export class IntervalCollection
 				);
 				break;
 			}
-			default:
+			default: {
 				unreachableCase(opName);
+			}
 		}
 		const pending = clearEmptyPendingEntry(this.pending, id);
 
@@ -962,8 +968,9 @@ export class IntervalCollection
 				this.removeIntervalById(id);
 				break;
 			}
-			default:
+			default: {
 				throw new Error("unknown ops should not be stashed");
+			}
 		}
 	}
 
@@ -1670,10 +1677,8 @@ export class IntervalCollection
 			op,
 		);
 
-		if (interval) {
-			if (this.onDeserialize) {
-				this.onDeserialize(interval);
-			}
+		if (interval && this.onDeserialize) {
+			this.onDeserialize(interval);
 		}
 
 		this.emit("addInterval", interval, local, op);

package/src/intervalCollectionMap.ts

@@ -4,11 +4,11 @@
  */
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { IFluidHandle } from "@fluidframework/core-interfaces";
-import type { IEvent, IEventProvider } from "@fluidframework/core-interfaces";
+import type { IEvent, IEventProvider, IFluidHandle } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import { ValueType, IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import { ValueType } from "@fluidframework/shared-object-base/internal";
 
 import { makeSerializable } from "./IntervalCollectionValues.js";
 import {
@@ -16,7 +16,7 @@ import {
 	type ISerializedIntervalCollectionV1,
 	type ISerializedIntervalCollectionV2,
 } from "./intervalCollection.js";
-import {
+import type {
 	IIntervalCollectionTypeOperationValue,
 	ISerializableIntervalCollection,
 	SequenceOptions,
@@ -135,14 +135,14 @@ export class IntervalCollectionMap {
 
 	public serialize(serializer: IFluidSerializer): string {
 		const serializableMapData: IMapDataObjectSerializable = {};
-		this.data.forEach((localValue, key) => {
+		for (const [key, localValue] of this.data.entries()) {
 			serializableMapData[key] = makeSerializable(
 				localValue,
 				serializer,
 				this.handle,
 				this.options?.intervalSerializationFormat ?? "2",
 			);
-		});
+		}
 		return JSON.stringify(serializableMapData);
 	}
 
@@ -168,7 +168,7 @@ export class IntervalCollectionMap {
 			// "intervalCollections/". This would burden users trying to iterate the collection and
 			// access its value, as well as those trying to match a create message to its underlying
 			// collection. See https://github.com/microsoft/FluidFramework/issues/10557 for more context.
-			const normalizedKey = key.startsWith("intervalCollections/") ? key.substring(20) : key;
+			const normalizedKey = key.startsWith("intervalCollections/") ? key.slice(20) : key;
 
 			assert(
 				serializable.type !== ValueType[ValueType.Plain] &&

package/src/intervalCollectionMapInterfaces.ts

@@ -4,19 +4,19 @@
  */
 
 import type { ListNode } from "@fluidframework/core-utils/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import { IMergeTreeOptions } from "@fluidframework/merge-tree/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { IMergeTreeOptions } from "@fluidframework/merge-tree/internal";
 
 import type {
 	IntervalCollection,
 	ISerializedIntervalCollectionV1,
 	ISerializedIntervalCollectionV2,
 } from "./intervalCollection.js";
-import {
+import type {
 	ISerializedInterval,
 	IntervalDeltaOpType,
+	SequenceIntervalClass,
 	SerializedIntervalDelta,
-	type SequenceIntervalClass,
 } from "./intervals/index.js";
 
 export interface IntervalAddLocalMetadata {

package/src/intervalIndex/endpointInRangeIndex.ts

@@ -3,18 +3,17 @@
  * Licensed under the MIT License.
  */
 
-import { PropertyAction, RedBlackTree } from "@fluidframework/merge-tree/internal";
+import type { PropertyAction } from "@fluidframework/merge-tree/internal";
+import { RedBlackTree } from "@fluidframework/merge-tree/internal";
 
-import { SequenceInterval, createTransientIntervalFromSequence } from "../intervals/index.js";
+import type { SequenceInterval } from "../intervals/index.js";
+import { createTransientIntervalFromSequence } from "../intervals/index.js";
 import type { ISharedSegmentSequence } from "../sequence.js";
-import { ISharedString } from "../sharedString.js";
+import type { ISharedString } from "../sharedString.js";
 
 import type { SequenceIntervalIndex } from "./intervalIndex.js";
-import {
-	HasComparisonOverride,
-	compareOverrideables,
-	forceCompare,
-} from "./intervalIndexUtils.js";
+import type { HasComparisonOverride } from "./intervalIndexUtils.js";
+import { compareOverrideables, forceCompare } from "./intervalIndexUtils.js";
 
 /**
  * Collection of intervals.

package/src/intervalIndex/endpointIndex.ts

@@ -5,9 +5,10 @@
 
 import { RedBlackTree } from "@fluidframework/merge-tree/internal";
 
-import { createTransientIntervalFromSequence, SequenceInterval } from "../intervals/index.js";
+import type { SequenceInterval } from "../intervals/index.js";
+import { createTransientIntervalFromSequence } from "../intervals/index.js";
 import type { ISharedSegmentSequence } from "../sequence.js";
-import { ISharedString } from "../sharedString.js";
+import type { ISharedString } from "../sharedString.js";
 
 import type { SequenceIntervalIndex } from "./intervalIndex.js";
 

package/src/intervalIndex/index.ts

@@ -3,22 +3,22 @@
  * Licensed under the MIT License.
  */
 
-export { SequenceIntervalIndex } from "./intervalIndex.js";
-export { IIdIntervalIndex, createIdIntervalIndex } from "./idIntervalIndex.js";
-export { IEndpointIndex, createEndpointIndex, EndpointIndex } from "./endpointIndex.js";
+export type { SequenceIntervalIndex } from "./intervalIndex.js";
+export { type IIdIntervalIndex, createIdIntervalIndex } from "./idIntervalIndex.js";
+export { type IEndpointIndex, createEndpointIndex, EndpointIndex } from "./endpointIndex.js";
 export {
-	IEndpointInRangeIndex,
+	type IEndpointInRangeIndex,
 	createEndpointInRangeIndex,
 	EndpointInRangeIndex,
 } from "./endpointInRangeIndex.js";
 export {
-	IStartpointInRangeIndex,
+	type IStartpointInRangeIndex,
 	createStartpointInRangeIndex,
 	StartpointInRangeIndex,
 } from "./startpointInRangeIndex.js";
-export { SequenceIntervalIndexes } from "./sequenceIntervalIndexes.js";
+export type { SequenceIntervalIndexes } from "./sequenceIntervalIndexes.js";
 export {
 	createOverlappingIntervalsIndex,
 	OverlappingIntervalsIndex,
-	ISequenceOverlappingIntervalsIndex,
+	type ISequenceOverlappingIntervalsIndex,
 } from "./overlappingIntervalsIndex.js";

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -3,16 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import { SequencePlace, endpointPosAndSide } from "@fluidframework/merge-tree/internal";
-
-import { IntervalNode, IntervalTree } from "../intervalTree.js";
-import {
-	SequenceInterval,
-	BaseSequenceInterval,
-	createTransientIntervalFromSequence,
-} from "../intervals/index.js";
+import type { SequencePlace } from "@fluidframework/merge-tree/internal";
+import { endpointPosAndSide } from "@fluidframework/merge-tree/internal";
+
+import type { IntervalNode } from "../intervalTree.js";
+import { IntervalTree } from "../intervalTree.js";
+import type { SequenceInterval, BaseSequenceInterval } from "../intervals/index.js";
+import { createTransientIntervalFromSequence } from "../intervals/index.js";
 import type { ISharedSegmentSequence } from "../sequence.js";
-import { ISharedString } from "../sharedString.js";
+import type { ISharedString } from "../sharedString.js";
 
 import type { SequenceIntervalIndex } from "./intervalIndex.js";
 

package/src/intervalIndex/sequenceIntervalIndexes.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { ISegment } from "@fluidframework/merge-tree/internal";
+import type { ISegment } from "@fluidframework/merge-tree/internal";
 
-import { SequenceInterval } from "../intervals/index.js";
+import type { SequenceInterval } from "../intervals/index.js";
 
 import type { ISequenceOverlappingIntervalsIndex } from "./overlappingIntervalsIndex.js";
 

package/src/intervalIndex/startpointInRangeIndex.ts

@@ -3,18 +3,17 @@
  * Licensed under the MIT License.
  */
 
-import { PropertyAction, RedBlackTree } from "@fluidframework/merge-tree/internal";
+import type { PropertyAction } from "@fluidframework/merge-tree/internal";
+import { RedBlackTree } from "@fluidframework/merge-tree/internal";
 
-import { SequenceInterval, createTransientIntervalFromSequence } from "../intervals/index.js";
+import type { SequenceInterval } from "../intervals/index.js";
+import { createTransientIntervalFromSequence } from "../intervals/index.js";
 import type { ISharedSegmentSequence } from "../sequence.js";
-import { ISharedString } from "../sharedString.js";
+import type { ISharedString } from "../sharedString.js";
 
 import type { SequenceIntervalIndex } from "./intervalIndex.js";
-import {
-	HasComparisonOverride,
-	compareOverrideables,
-	forceCompare,
-} from "./intervalIndexUtils.js";
+import type { HasComparisonOverride } from "./intervalIndexUtils.js";
+import { compareOverrideables, forceCompare } from "./intervalIndexUtils.js";
 
 /**
  * Collection of intervals.

package/src/intervalTree.ts

@@ -3,15 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IRBAugmentation,
 	IRBMatcher,
 	RBNode,
 	RBNodeActions,
-	RedBlackTree,
 } from "@fluidframework/merge-tree/internal";
+import { RedBlackTree } from "@fluidframework/merge-tree/internal";
 
-import { ISerializableInterval } from "./intervals/index.js";
+import type { ISerializableInterval } from "./intervals/index.js";
 
 export interface AugmentedIntervalNode {
 	minmax: ISerializableInterval;

package/src/intervals/index.ts

@@ -4,20 +4,20 @@
  */
 
 export {
-	IInterval,
-	ISerializedInterval,
-	ISerializableInterval,
+	type IInterval,
+	type ISerializedInterval,
+	type ISerializableInterval,
 	IntervalOpType,
 	IntervalType,
 	IntervalDeltaOpType,
 	IntervalStickiness,
-	SerializedIntervalDelta,
-	CompressedSerializedInterval,
+	type SerializedIntervalDelta,
+	type CompressedSerializedInterval,
 	endReferenceSlidingPreference,
 	startReferenceSlidingPreference,
 } from "./intervalUtils.js";
 export {
-	SequenceInterval,
+	type SequenceInterval,
 	SequenceIntervalClass,
 	BaseSequenceInterval,
 	createSequenceInterval,

package/src/intervals/intervalUtils.ts

@@ -5,7 +5,8 @@
 
 /* eslint-disable no-bitwise */
 
-import { PropertySet, SlidingPreference, Side } from "@fluidframework/merge-tree/internal";
+import type { PropertySet } from "@fluidframework/merge-tree/internal";
+import { SlidingPreference, Side } from "@fluidframework/merge-tree/internal";
 
 /**
  * Basic interval abstraction

package/src/intervals/sequenceInterval.ts

@@ -7,13 +7,16 @@
 
 import type { IDisposable } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import {
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type {
 	Client,
 	ISegment,
 	LocalReferencePosition,
-	PropertiesManager,
 	PropertySet,
+	SequencePlace,
+} from "@fluidframework/merge-tree/internal";
+import {
+	PropertiesManager,
 	ReferenceType,
 	SlidingPreference,
 	compareReferencePositions,
@@ -24,7 +27,6 @@ import {
 	minReferencePosition,
 	refTypeIncludesFlag,
 	reservedRangeLabelsKey,
-	SequencePlace,
 	Side,
 	endpointPosAndSide,
 	addProperties,
@@ -37,9 +39,8 @@ import { v4 as uuid } from "uuid";
 
 import type { ISharedSegmentSequence } from "../sequence.js";
 
+import type { ISerializableInterval, ISerializedInterval } from "./intervalUtils.js";
 import {
-	ISerializableInterval,
-	ISerializedInterval,
 	IntervalStickiness,
 	IntervalType,
 	computeStickinessFromSide,

package/src/packageVersion.ts

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

package/src/revertibles.ts

@@ -6,12 +6,15 @@
 /* eslint-disable no-bitwise */
 
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import {
+import type {
 	LocalReferencePosition,
 	MergeTreeDeltaOperationType,
 	MergeTreeDeltaRevertible,
-	MergeTreeDeltaType,
 	PropertySet,
+	InteriorSequencePlace,
+} from "@fluidframework/merge-tree/internal";
+import {
+	MergeTreeDeltaType,
 	ReferenceType,
 	SlidingPreference,
 	appendToMergeTreeDeltaRevertibles,
@@ -20,7 +23,6 @@ import {
 	isMergeTreeDeltaRevertible,
 	refTypeIncludesFlag,
 	revertMergeTreeDeltaRevertibles,
-	InteriorSequencePlace,
 	Side,
 	type ISegmentInternal,
 	segmentIsRemoved,
@@ -28,9 +30,10 @@ import {
 	type ISegment,
 } from "@fluidframework/merge-tree/internal";
 
-import { IntervalOpType, SequenceInterval, SequenceIntervalClass } from "./intervals/index.js";
-import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
-import { ISharedString, SharedStringSegment } from "./sharedString.js";
+import type { SequenceInterval } from "./intervals/index.js";
+import { IntervalOpType, SequenceIntervalClass } from "./intervals/index.js";
+import type { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
+import type { ISharedString, SharedStringSegment } from "./sharedString.js";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
@@ -321,7 +324,7 @@ export function appendSharedStringDeltaToRevertibles(
 			};
 
 			// add an interval for each startInterval, accounting for any corresponding endIntervals
-			startIntervals.forEach(({ interval, offset }) => {
+			for (const { interval, offset } of startIntervals) {
 				// find any corresponding end for this interval
 				const endIntervalIndex = endIntervals.findIndex((end) => {
 					return end.interval === interval;
@@ -338,16 +341,16 @@ export function appendSharedStringDeltaToRevertibles(
 					startOffset: offset,
 					endOffset,
 				});
-			});
+			}
 
 			// add any remaining endIntervals that aren't matched with a startInterval
-			endIntervals.forEach(({ interval, offset }) => {
+			for (const { interval, offset } of endIntervals) {
 				revertible.intervals.push({
 					intervalId: interval.getIntervalId(),
 					label: interval.start.properties?.referenceRangeLabels[0],
 					endOffset: offset,
 				});
-			});
+			}
 
 			revertibles.push(revertible);
 			return;
@@ -375,14 +378,14 @@ export function discardSharedStringRevertibles(
 	sharedString: ISharedString,
 	revertibles: SharedStringRevertible[],
 ) {
-	revertibles.forEach((r) => {
+	for (const r of revertibles) {
 		if (isMergeTreeDeltaRevertible(r)) {
 			discardMergeTreeDeltaRevertible([r]);
 		} else if (r.event === IntervalOpType.CHANGE || r.event === IntervalOpType.DELETE) {
 			sharedString.removeLocalReferencePosition(r.start);
 			sharedString.removeLocalReferencePosition(r.end);
 		}
-	});
+	}
 }
 
 function getSlidePosition(
@@ -478,11 +481,11 @@ function revertLocalDelete(
 			props,
 		});
 
-		idMap.forEach((newId, oldId) => {
+		for (const [oldId, newId] of idMap.entries()) {
 			if (intervalId === newId) {
 				idMap.set(oldId, getUpdatedIdFromInterval(int));
 			}
-		});
+		}
 		idMap.set(intervalId, int.getIntervalId());
 	}
 
@@ -587,9 +590,9 @@ function revertLocalSequenceRemove(
 	const saveSegments = (event: SequenceDeltaEvent) => {
 		if (event.ranges.length > 0) {
 			let length = 0;
-			event.ranges.forEach((range) => {
+			for (const range of event.ranges) {
 				length += range.segment.cachedLength;
-			});
+			}
 			restoredRanges.addOrUpdate({
 				ranges: event.ranges,
 				length,
@@ -601,7 +604,7 @@ function revertLocalSequenceRemove(
 	revertMergeTreeDeltaRevertibles(sharedString, [revertible.mergeTreeRevertible]);
 	sharedString.off("sequenceDelta", saveSegments);
 
-	revertible.intervals.forEach((intervalInfo) => {
+	for (const intervalInfo of revertible.intervals) {
 		const intervalCollection = sharedString.getIntervalCollection(intervalInfo.label);
 		const intervalId = getUpdatedId(intervalInfo.intervalId);
 		const interval = intervalCollection.getIntervalById(intervalId);
@@ -627,10 +630,10 @@ function revertLocalSequenceRemove(
 				});
 			}
 		}
-	});
+	}
 
 	// fix up the local references used by delete and change revertibles
-	revertible.revertibleRefs.forEach((revertibleRef) => {
+	for (const revertibleRef of revertible.revertibleRefs) {
 		assert(
 			revertibleRef.revertible.event === IntervalOpType.CHANGE ||
 				revertibleRef.revertible.event === IntervalOpType.DELETE,
@@ -660,7 +663,7 @@ function revertLocalSequenceRemove(
 				revertibleRef.revertible.end = newRef;
 			}
 		}
-	});
+	}
 }
 
 /**
@@ -677,23 +680,29 @@ export function revertSharedStringRevertibles(
 		if ("event" in r) {
 			const event = r.event;
 			switch (event) {
-				case IntervalOpType.ADD:
+				case IntervalOpType.ADD: {
 					revertLocalAdd(sharedString, r);
 					break;
-				case IntervalOpType.DELETE:
+				}
+				case IntervalOpType.DELETE: {
 					revertLocalDelete(sharedString, r);
 					break;
-				case IntervalOpType.CHANGE:
+				}
+				case IntervalOpType.CHANGE: {
 					revertLocalChange(sharedString, r);
 					break;
-				case IntervalOpType.PROPERTY_CHANGED:
+				}
+				case IntervalOpType.PROPERTY_CHANGED: {
 					revertLocalPropertyChanged(sharedString, r);
 					break;
-				case IntervalOpType.POSITION_REMOVE:
+				}
+				case IntervalOpType.POSITION_REMOVE: {
 					revertLocalSequenceRemove(sharedString, r);
 					break;
-				default:
+				}
+				default: {
 					unreachableCase(event);
+				}
 			}
 		} else {
 			revertMergeTreeDeltaRevertibles(sharedString, [r]);