@fluidframework/sequence 2.41.0 → 2.43.0-343119

package/src/intervalCollectionMap.ts

@@ -18,7 +18,6 @@ import {
 } from "./intervalCollection.js";
 import {
 	IIntervalCollectionTypeOperationValue,
-	IMapMessageLocalMetadata,
 	ISerializableIntervalCollection,
 	SequenceOptions,
 } from "./intervalCollectionMapInterfaces.js";
@@ -94,10 +93,7 @@ export class IntervalCollectionMap {
 	constructor(
 		private readonly serializer: IFluidSerializer,
 		private readonly handle: IFluidHandle,
-		private readonly submitMessage: (
-			op: IMapOperation,
-			localOpMetadata: IMapMessageLocalMetadata,
-		) => void,
+		private readonly submitMessage: (op: IMapOperation, localOpMetadata: unknown) => void,
 		private readonly options?: Partial<SequenceOptions>,
 	) {}
 
@@ -192,10 +188,7 @@ export class IntervalCollectionMap {
 	 * also sent if we are asked to resubmit the message.
 	 * @returns True if the operation was submitted, false otherwise.
 	 */
-	public tryResubmitMessage(
-		content: unknown,
-		localOpMetadata: IMapMessageLocalMetadata,
-	): boolean {
+	public tryResubmitMessage(content: unknown, localOpMetadata: unknown): boolean {
 		if (isMapOperation(content)) {
 			const { value, key } = content;
 			const localValue = this.data.get(key);
@@ -212,7 +205,7 @@ export class IntervalCollectionMap {
 
 			assert(localValue !== undefined, 0xb7e /* Local value expected on rollback */);
 
-			localValue.rollback(content.value, localOpMetadata as IMapMessageLocalMetadata);
+			localValue.rollback(content.value, localOpMetadata);
 
 			return true;
 		}
@@ -254,7 +247,7 @@ export class IntervalCollectionMap {
 		if (isMapOperation(content)) {
 			const { value, key } = content;
 			const localValue = this.data.get(key) ?? this.createCore(key, local);
-			localValue.process(value, local, message, localOpMetadata as IMapMessageLocalMetadata);
+			localValue.process(value, local, message, localOpMetadata);
 			return true;
 		}
 		return false;

package/src/intervalCollectionMapInterfaces.ts

@@ -4,7 +4,7 @@
  */
 
 import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import type { IMergeTreeOptions } from "@fluidframework/merge-tree/internal";
+import { IMergeTreeOptions, ListNode } from "@fluidframework/merge-tree/internal";
 
 import type {
 	IntervalCollection,
@@ -17,11 +17,31 @@ import {
 	SerializedIntervalDelta,
 } from "./intervals/index.js";
 
-export interface IMapMessageLocalMetadata {
+export interface IntervalAddLocalMetadata {
+	type: typeof IntervalDeltaOpType.ADD;
 	localSeq: number;
-	previous?: ISerializedInterval;
+	endpointChangesNode?: ListNode<IntervalAddLocalMetadata | IntervalChangeLocalMetadata>;
+	rebased?: ISerializedInterval;
+	original: ISerializedInterval;
 }
-
+export interface IntervalChangeLocalMetadata {
+	type: typeof IntervalDeltaOpType.CHANGE;
+	localSeq: number;
+	previous: ISerializedInterval;
+	endpointChangesNode?: ListNode<IntervalChangeLocalMetadata | IntervalChangeLocalMetadata>;
+	rebased?: SerializedIntervalDelta;
+	original: SerializedIntervalDelta;
+}
+export interface IntervalDeleteLocalMetadata {
+	type: typeof IntervalDeltaOpType.DELETE;
+	localSeq: number;
+	previous: ISerializedInterval;
+	endpointChangesNode?: undefined;
+}
+export type IntervalMessageLocalMetadata =
+	| IntervalAddLocalMetadata
+	| IntervalChangeLocalMetadata
+	| IntervalDeleteLocalMetadata;
 /**
  * Optional flags that configure options for sequence DDSs
  * @internal
@@ -73,7 +93,7 @@ export interface IIntervalCollectionOperation {
 		params: ISerializedInterval,
 		local: boolean,
 		message: ISequencedDocumentMessage | undefined,
-		localOpMetadata: IMapMessageLocalMetadata | undefined,
+		localOpMetadata: IntervalMessageLocalMetadata | undefined,
 	): void;
 }
 

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -12,7 +12,11 @@ import {
 } from "@fluidframework/merge-tree/internal";
 
 import { IntervalNode, IntervalTree } from "../intervalTree.js";
-import { SequenceInterval, createTransientInterval } from "../intervals/index.js";
+import {
+	SequenceInterval,
+	SequenceIntervalClass,
+	createTransientInterval,
+} from "../intervals/index.js";
 import { ISharedString } from "../sharedString.js";
 
 import { type SequenceIntervalIndex } from "./intervalIndex.js";
@@ -40,7 +44,7 @@ export interface ISequenceOverlappingIntervalsIndex extends SequenceIntervalInde
 }
 
 export class OverlappingIntervalsIndex implements ISequenceOverlappingIntervalsIndex {
-	protected readonly intervalTree = new IntervalTree<SequenceInterval>();
+	protected readonly intervalTree = new IntervalTree<SequenceIntervalClass>();
 	protected readonly client: Client;
 
 	constructor(client: Client) {
@@ -68,7 +72,7 @@ export class OverlappingIntervalsIndex implements ISequenceOverlappingIntervalsI
 		if (start === undefined && end === undefined) {
 			// No start/end provided. Gather the whole tree in the specified order.
 			if (iteratesForward) {
-				this.intervalTree.map((interval: SequenceInterval) => {
+				this.intervalTree.map((interval: SequenceIntervalClass) => {
 					results.push(interval);
 				});
 			} else {
@@ -77,7 +81,7 @@ export class OverlappingIntervalsIndex implements ISequenceOverlappingIntervalsI
 				});
 			}
 		} else {
-			const transientInterval: SequenceInterval = createTransientInterval(
+			const transientInterval: SequenceIntervalClass = createTransientInterval(
 				start ?? "start",
 				end ?? "end",
 				this.client,
@@ -87,13 +91,13 @@ export class OverlappingIntervalsIndex implements ISequenceOverlappingIntervalsI
 				// Only end position provided. Since the tree is not sorted by end position,
 				// walk the whole tree in the specified order, gathering intervals that match the end.
 				if (iteratesForward) {
-					this.intervalTree.map((interval: SequenceInterval) => {
+					this.intervalTree.map((interval: SequenceIntervalClass) => {
 						if (transientInterval.compareEnd(interval) === 0) {
 							results.push(interval);
 						}
 					});
 				} else {
-					this.intervalTree.mapBackward((interval: SequenceInterval) => {
+					this.intervalTree.mapBackward((interval: SequenceIntervalClass) => {
 						if (transientInterval.compareEnd(interval) === 0) {
 							results.push(interval);
 						}
@@ -104,15 +108,15 @@ export class OverlappingIntervalsIndex implements ISequenceOverlappingIntervalsI
 				// this start position.
 				const compareFn =
 					end === undefined
-						? (node: IntervalNode<SequenceInterval>) => {
+						? (node: IntervalNode<SequenceIntervalClass>) => {
 								return transientInterval.compareStart(node.key);
 							}
-						: (node: IntervalNode<SequenceInterval>) => {
+						: (node: IntervalNode<SequenceIntervalClass>) => {
 								return transientInterval.compare(node.key);
 							};
 				const continueLeftFn = (cmpResult: number) => cmpResult <= 0;
 				const continueRightFn = (cmpResult: number) => cmpResult >= 0;
-				const actionFn = (node: IntervalNode<SequenceInterval>) => {
+				const actionFn = (node: IntervalNode<SequenceIntervalClass>) => {
 					results.push(node.key);
 				};
 
@@ -157,11 +161,11 @@ export class OverlappingIntervalsIndex implements ISequenceOverlappingIntervalsI
 		return overlappingIntervalNodes.map((node) => node.key);
 	}
 
-	public remove(interval: SequenceInterval) {
+	public remove(interval: SequenceIntervalClass) {
 		this.intervalTree.removeExisting(interval);
 	}
 
-	public add(interval: SequenceInterval) {
+	public add(interval: SequenceIntervalClass) {
 		this.intervalTree.put(interval);
 	}
 }

package/src/intervals/intervalUtils.ts

@@ -21,6 +21,9 @@ import {
 export interface IInterval {
 	/**
 	 * @returns a new interval object with identical semantics.
+	 *
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
+	 * @privateRemarks Move to ISerializableInterval after deprecation period
 	 */
 	clone(): IInterval;
 	/**
@@ -45,6 +48,8 @@ export interface IInterval {
 	compareEnd(b: IInterval): number;
 	/**
 	 * Modifies one or more of the endpoints of this interval, returning a new interval representing the result.
+	 *
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
 	 */
 	modify(
 		label: string,
@@ -63,6 +68,8 @@ export interface IInterval {
 	 * Unions this interval with `b`, returning a new interval.
 	 * The union operates as a convex hull, i.e. if the two intervals are disjoint, the return value includes
 	 * intermediate values between the two intervals.
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
+	 * @privateRemarks Move to ISerializableInterval after deprecation period
 	 */
 	union(b: IInterval): IInterval;
 }
@@ -152,12 +159,16 @@ export interface ISerializedInterval {
 /**
  * @legacy
  * @alpha
+ * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
+ * @privateRemarks Remove from external exports, and replace usages of IInterval with this interface after deprecation period
  */
 export interface ISerializableInterval extends IInterval {
 	/** Serializable bag of properties associated with the interval. */
 	properties: PropertySet;
 
-	/***/
+	/**
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
+	 */
 	serialize(): ISerializedInterval;
 
 	/**

package/src/intervals/sequenceInterval.ts

@@ -38,6 +38,7 @@ import { v4 as uuid } from "uuid";
 import { computeStickinessFromSide } from "../intervalCollection.js";
 
 import {
+	// eslint-disable-next-line import/no-deprecated
 	ISerializableInterval,
 	ISerializedInterval,
 	IntervalStickiness,
@@ -128,6 +129,7 @@ export function getSerializedProperties(
  * @alpha
  * @legacy
  */
+// eslint-disable-next-line import/no-deprecated
 export interface SequenceInterval extends ISerializableInterval {
 	readonly start: LocalReferencePosition;
 	/**
@@ -140,8 +142,12 @@ export interface SequenceInterval extends ISerializableInterval {
 	readonly endSide: Side;
 	readonly stickiness: IntervalStickiness;
 
+	/** Serializable bag of properties associated with the interval. */
+	properties: PropertySet;
+
 	/**
 	 * @returns a new interval object with identical semantics.
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
 	 */
 	clone(): SequenceInterval;
 	/**
@@ -166,6 +172,7 @@ export interface SequenceInterval extends ISerializableInterval {
 	compareEnd(b: SequenceInterval): number;
 	/**
 	 * Modifies one or more of the endpoints of this interval, returning a new interval representing the result.
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
 	 */
 	modify(
 		label: string,
@@ -184,11 +191,13 @@ export interface SequenceInterval extends ISerializableInterval {
 	 * Unions this interval with `b`, returning a new interval.
 	 * The union operates as a convex hull, i.e. if the two intervals are disjoint, the return value includes
 	 * intermediate values between the two intervals.
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
 	 */
 	union(b: SequenceInterval): SequenceInterval;
 
 	/**
 	 * Subscribes to position change events on this interval if there are no current listeners.
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
 	 */
 	addPositionChangeListeners(
 		beforePositionChange: () => void,
@@ -197,6 +206,7 @@ export interface SequenceInterval extends ISerializableInterval {
 
 	/**
 	 * Removes the currently subscribed position change listeners.
+	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
 	 */
 	removePositionChangeListeners(): void;
 
@@ -204,9 +214,17 @@ export interface SequenceInterval extends ISerializableInterval {
 	 * @returns whether this interval overlaps two numerical positions.
 	 */
 	overlapsPos(bstart: number, bend: number): boolean;
+
+	/**
+	 * Gets the id associated with this interval.
+	 * When the interval is used as part of an interval collection, this id can be used to modify or remove the
+	 * interval.
+	 */
+	getIntervalId(): string;
 }
 
-export class SequenceIntervalClass implements SequenceInterval {
+// eslint-disable-next-line import/no-deprecated
+export class SequenceIntervalClass implements SequenceInterval, ISerializableInterval {
 	readonly #props: {
 		propertyManager?: PropertiesManager;
 		properties: PropertySet;
@@ -438,7 +456,7 @@ export class SequenceIntervalClass implements SequenceInterval {
 	/**
 	 * {@inheritDoc IInterval.union}
 	 */
-	public union(b: SequenceInterval) {
+	public union(b: SequenceIntervalClass) {
 		const newStart = minReferencePosition(this.start, b.start);
 		const newEnd = maxReferencePosition(this.end, b.end);
 
@@ -571,7 +589,7 @@ export class SequenceIntervalClass implements SequenceInterval {
 
 export function createPositionReferenceFromSegoff(
 	client: Client,
-	segoff: { segment: ISegment | undefined; offset: number | undefined } | "start" | "end",
+	segoff: { segment: ISegment; offset: number } | undefined | "start" | "end",
 	refType: ReferenceType,
 	op?: ISequencedDocumentMessage,
 	localSeq?: number,
@@ -591,7 +609,7 @@ export function createPositionReferenceFromSegoff(
 		);
 	}
 
-	if (segoff.segment) {
+	if (segoff?.segment) {
 		const ref = client.createLocalReferencePosition(
 			segoff.segment,
 			segoff.offset,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.41.0";
+export const pkgVersion = "2.43.0-343119";

package/src/revertibles.ts

@@ -398,12 +398,13 @@ function getSlidePosition(
 	lref: LocalReferencePosition,
 	pos: number,
 ): number {
-	const slide = getSlideToSegoff(
-		{ segment: lref.getSegment(), offset: undefined },
-		lref.slidingPreference,
-	);
-	return slide?.segment !== undefined &&
-		slide.offset !== undefined &&
+	const segment = lref.getSegment();
+	const offset = lref.getOffset();
+	const slide =
+		segment === undefined
+			? undefined
+			: getSlideToSegoff({ segment, offset }, lref.slidingPreference);
+	return slide !== undefined &&
 		string.getPosition(slide.segment) !== -1 &&
 		(pos < 0 || pos >= string.getLength())
 		? string.getPosition(slide.segment) + slide.offset

package/src/sequence.ts

@@ -71,10 +71,7 @@ import Deque from "double-ended-queue";
 
 import { type ISequenceIntervalCollection } from "./intervalCollection.js";
 import { IMapOperation, IntervalCollectionMap } from "./intervalCollectionMap.js";
-import {
-	IMapMessageLocalMetadata,
-	type SequenceOptions,
-} from "./intervalCollectionMapInterfaces.js";
+import { type SequenceOptions } from "./intervalCollectionMapInterfaces.js";
 import {
 	SequenceDeltaEvent,
 	SequenceDeltaEventClass,
@@ -586,7 +583,9 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		segment: T | undefined;
 		offset: number | undefined;
 	} {
-		return this.client.getContainingSegment<T>(pos);
+		return (
+			this.client.getContainingSegment<T>(pos) ?? { segment: undefined, offset: undefined }
+		);
 	}
 
 	public getLength(): number {
@@ -776,26 +775,25 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
 	 */
-	protected reSubmitCore(content: any, localOpMetadata: unknown) {
+	protected reSubmitCore(content: any, localOpMetadata: unknown, squash: boolean = false) {
 		const originalRefSeq = this.inFlightRefSeqs.shift();
 		assert(
 			originalRefSeq !== undefined,
 			0x8bb /* Expected a recorded refSeq when resubmitting an op */,
 		);
 		this.useResubmitRefSeq(originalRefSeq, () => {
-			if (
-				!this.intervalCollections.tryResubmitMessage(
-					content,
-					localOpMetadata as IMapMessageLocalMetadata,
-				)
-			) {
+			if (!this.intervalCollections.tryResubmitMessage(content, localOpMetadata)) {
 				this.submitSequenceMessage(
-					this.client.regeneratePendingOp(content as IMergeTreeOp, localOpMetadata),
+					this.client.regeneratePendingOp(content as IMergeTreeOp, localOpMetadata, squash),
 				);
 			}
 		});
 	}
 
+	protected reSubmitSquashed(content: unknown, localOpMetadata: unknown): void {
+		this.reSubmitCore(content, localOpMetadata, true);
+	}
+
 	/**
 	 * Revert an op
 	 */