@fluidframework/sequence 2.5.0 → 2.10.0-304831

package/src/intervals/sequenceInterval.ts

@@ -28,6 +28,7 @@ import {
 	Side,
 	endpointPosAndSide,
 	addProperties,
+	copyPropertiesAndManager,
 } from "@fluidframework/merge-tree/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
@@ -38,13 +39,13 @@ import {
 } from "../intervalCollection.js";
 
 import {
-	IIntervalHelpers,
 	ISerializableInterval,
 	ISerializedInterval,
 	IntervalStickiness,
 	IntervalType,
 	endReferenceSlidingPreference,
 	startReferenceSlidingPreference,
+	type IIntervalHelpers,
 } from "./intervalUtils.js";
 
 function compareSides(sideA: Side, sideB: Side): number {
@@ -101,10 +102,88 @@ function maxSide(sideA: Side, sideB: Side): Side {
  * `mergeTreeReferencesCanSlideToEndpoint` feature flag set to true, the endpoints
  * of the interval that are exclusive will have the ability to slide to these
  * special endpoint segments.
- * @legacy
  * @alpha
+ * @legacy
  */
-export class SequenceInterval implements ISerializableInterval {
+export interface SequenceInterval extends ISerializableInterval {
+	readonly start: LocalReferencePosition;
+	/**
+	 * End endpoint of this interval.
+	 * @remarks This endpoint can be resolved into a character position using the SharedString it's a part of.
+	 */
+	readonly end: LocalReferencePosition;
+	readonly intervalType: IntervalType;
+	readonly startSide: Side;
+	readonly endSide: Side;
+	readonly stickiness: IntervalStickiness;
+
+	/**
+	 * @returns a new interval object with identical semantics.
+	 */
+	clone(): SequenceInterval;
+	/**
+	 * Compares this interval to `b` with standard comparator semantics:
+	 * - returns -1 if this is less than `b`
+	 * - returns 1 if this is greater than `b`
+	 * - returns 0 if this is equivalent to `b`
+	 * @param b - Interval to compare against
+	 */
+	compare(b: SequenceInterval): number;
+	/**
+	 * Compares the start endpoint of this interval to `b`'s start endpoint.
+	 * Standard comparator semantics apply.
+	 * @param b - Interval to compare against
+	 */
+	compareStart(b: SequenceInterval): number;
+	/**
+	 * Compares the end endpoint of this interval to `b`'s end endpoint.
+	 * Standard comparator semantics apply.
+	 * @param b - Interval to compare against
+	 */
+	compareEnd(b: SequenceInterval): number;
+	/**
+	 * Modifies one or more of the endpoints of this interval, returning a new interval representing the result.
+	 */
+	modify(
+		label: string,
+		start: SequencePlace | undefined,
+		end: SequencePlace | undefined,
+		op?: ISequencedDocumentMessage,
+		localSeq?: number,
+		useNewSlidingBehavior?: boolean,
+	): SequenceInterval | undefined;
+	/**
+	 * @returns whether this interval overlaps with `b`.
+	 * Intervals are considered to overlap if their intersection is non-empty.
+	 */
+	overlaps(b: SequenceInterval): boolean;
+	/**
+	 * 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.
+	 */
+	union(b: SequenceInterval): SequenceInterval;
+
+	/**
+	 * Subscribes to position change events on this interval if there are no current listeners.
+	 */
+	addPositionChangeListeners(
+		beforePositionChange: () => void,
+		afterPositionChange: () => void,
+	): void;
+
+	/**
+	 * Removes the currently subscribed position change listeners.
+	 */
+	removePositionChangeListeners(): void;
+
+	/**
+	 * @returns whether this interval overlaps two numerical positions.
+	 */
+	overlapsPos(bstart: number, bend: number): boolean;
+}
+
+export class SequenceIntervalClass implements SequenceInterval {
 	/**
 	 * {@inheritDoc ISerializableInterval.properties}
 	 */
@@ -113,7 +192,7 @@ export class SequenceInterval implements ISerializableInterval {
 	/**
 	 * {@inheritDoc ISerializableInterval.propertyManager}
 	 */
-	public propertyManager: PropertiesManager = new PropertiesManager();
+	public propertyManager?: PropertiesManager;
 
 	/***/
 	public get stickiness(): IntervalStickiness {
@@ -127,9 +206,6 @@ export class SequenceInterval implements ISerializableInterval {
 		);
 	}
 
-	/**
-	 * @deprecated  This functionality was not meant to be exported and will be removed in a future release
-	 */
 	constructor(
 		private readonly client: Client,
 		/**
@@ -215,8 +291,8 @@ export class SequenceInterval implements ISerializableInterval {
 	/**
 	 * {@inheritDoc IInterval.clone}
 	 */
-	public clone() {
-		return new SequenceInterval(
+	public clone(): SequenceInterval {
+		return new SequenceIntervalClass(
 			this.client,
 			this.start,
 			this.end,
@@ -320,7 +396,7 @@ export class SequenceInterval implements ISerializableInterval {
 			endSide = this.end === newEnd ? this.endSide : b.endSide;
 		}
 
-		return new SequenceInterval(
+		return new SequenceIntervalClass(
 			this.client,
 			newStart,
 			newEnd,
@@ -331,17 +407,6 @@ export class SequenceInterval implements ISerializableInterval {
 		);
 	}
 
-	/**
-	 * {@inheritDoc ISerializableInterval.addProperties}
-	 */
-	public addProperties(
-		newProps: PropertySet,
-		collab: boolean = false,
-		seq?: number,
-	): PropertySet | undefined {
-		return this.propertyManager.addProperties(this.properties, newProps, seq, collab);
-	}
-
 	/**
 	 * @returns whether this interval overlaps two numerical positions.
 	 */
@@ -414,7 +479,7 @@ export class SequenceInterval implements ISerializableInterval {
 			}
 		}
 
-		const newInterval = new SequenceInterval(
+		const newInterval = new SequenceIntervalClass(
 			this.client,
 			startRef,
 			endRef,
@@ -423,13 +488,7 @@ export class SequenceInterval implements ISerializableInterval {
 			startSide ?? this.startSide,
 			endSide ?? this.endSide,
 		);
-		if (this.properties) {
-			this.propertyManager.copyTo(
-				this.properties,
-				newInterval.properties,
-				newInterval.propertyManager,
-			);
-		}
+		copyPropertiesAndManager(this, newInterval);
 		return newInterval;
 	}
 }
@@ -604,7 +663,7 @@ export function createSequenceInterval(
 	startLref.addProperties(rangeProp);
 	endLref.addProperties(rangeProp);
 
-	const ival = new SequenceInterval(
+	const ival = new SequenceIntervalClass(
 		client,
 		startLref,
 		endLref,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.5.0";
+export const pkgVersion = "2.10.0-304831";

package/src/revertibles.ts

@@ -26,7 +26,7 @@ import {
 	type ISegmentInternal,
 } from "@fluidframework/merge-tree/internal";
 
-import { IntervalOpType, SequenceInterval } from "./intervals/index.js";
+import { IntervalOpType, SequenceInterval, SequenceIntervalClass } from "./intervals/index.js";
 import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
 import { ISharedString, SharedStringSegment } from "./sharedString.js";
 
@@ -244,13 +244,13 @@ function addIfIntervalEndpoint(
 ) {
 	if (refTypeIncludesFlag(ref.refType, ReferenceType.RangeBegin)) {
 		const interval = ref.properties?.interval;
-		if (interval && interval instanceof SequenceInterval) {
+		if (interval && interval instanceof SequenceIntervalClass) {
 			startIntervals.push({ offset: segmentLengths + interval.start.getOffset(), interval });
 			return true;
 		}
 	} else if (refTypeIncludesFlag(ref.refType, ReferenceType.RangeEnd)) {
 		const interval = ref.properties?.interval;
-		if (interval && interval instanceof SequenceInterval) {
+		if (interval && interval instanceof SequenceIntervalClass) {
 			endIntervals.push({ offset: segmentLengths + interval.end.getOffset(), interval });
 			return true;
 		}

package/src/sequence.ts

@@ -81,7 +81,12 @@ import {
 	type SequenceOptions,
 } from "./intervalCollectionMapInterfaces.js";
 import { SequenceInterval } from "./intervals/index.js";
-import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent.js";
+import {
+	SequenceDeltaEvent,
+	SequenceDeltaEventClass,
+	SequenceMaintenanceEvent,
+	SequenceMaintenanceEventClass,
+} from "./sequenceDeltaEvent.js";
 import { ISharedIntervalCollection } from "./sharedIntervalCollection.js";
 
 const snapshotFileName = "header";
@@ -362,9 +367,7 @@ export interface ISharedSegmentSequence<T extends ISegment>
 }
 
 /**
- * @legacy
- * @alpha
- * @deprecated  This functionality was not meant to be exported and will be removed in a future release
+ * @internal
  */
 export abstract class SharedSegmentSequence<T extends ISegment>
 	extends SharedObject<ISharedSegmentSequenceEvents>
@@ -534,7 +537,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		);
 
 		this.client.prependListener("delta", (opArgs, deltaArgs) => {
-			const event = new SequenceDeltaEvent(opArgs, deltaArgs, this.client);
+			const event = new SequenceDeltaEventClass(opArgs, deltaArgs, this.client);
 			if (event.isLocal) {
 				this.submitSequenceMessage(opArgs.op);
 			}
@@ -542,7 +545,11 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		});
 
 		this.client.on("maintenance", (args, opArgs) => {
-			this.emit("maintenance", new SequenceMaintenanceEvent(opArgs, args, this.client), this);
+			this.emit(
+				"maintenance",
+				new SequenceMaintenanceEventClass(opArgs, args, this.client),
+				this,
+			);
 		});
 
 		this.intervalCollections = new IntervalCollectionMap(

package/src/sequenceDeltaEvent.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils/internal";
+import { assert, Lazy } from "@fluidframework/core-utils/internal";
 import {
 	// eslint-disable-next-line import/no-deprecated
 	Client,
@@ -27,19 +27,49 @@ import {
  * @legacy
  * @alpha
  */
-export abstract class SequenceEvent<
+export interface SequenceEvent<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,
 > {
+	readonly deltaOperation: TOperation;
+
+	readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>;
+	/**
+	 * The in-order ranges affected by this delta.
+	 * These are not necessarily contiguous.
+	 *
+	 * @remarks - If processing code doesn't care about the order of the ranges, it may instead consider using the
+	 * {@link @fluidframework/merge-tree#IMergeTreeDeltaCallbackArgs.deltaSegments|deltaSegments} field on {@link SequenceEvent.deltaArgs|deltaArgs}.
+	 */
+	readonly ranges: readonly Readonly<ISequenceDeltaRange<TOperation>>[];
+
+	/**
+	 * The client id of the client that made the change which caused the delta event
+	 */
+	readonly clientId: string | undefined;
+
+	/**
+	 * The first of the modified ranges.
+	 */
+	readonly first: Readonly<ISequenceDeltaRange<TOperation>>;
+
+	/**
+	 * The last of the modified ranges.
+	 */
+	readonly last: Readonly<ISequenceDeltaRange<TOperation>>;
+}
+export abstract class SequenceEventClass<
+	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,
+> implements SequenceEvent<TOperation>
+{
+	public readonly isLocal: boolean;
 	public readonly deltaOperation: TOperation;
 	// eslint-disable-next-line import/no-deprecated
 	private readonly sortedRanges: Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>;
 	private readonly pFirst: Lazy<ISequenceDeltaRange<TOperation>>;
 	private readonly pLast: Lazy<ISequenceDeltaRange<TOperation>>;
 
-	/**
-	 * @deprecated This functionality was not meant to be exported and will be removed in a future release
-	 */
 	constructor(
+		public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,
 		/**
 		 * Arguments reflecting the type of change that caused this event.
 		 */
@@ -52,6 +82,7 @@ export abstract class SequenceEvent<
 			0x2d8 /* "Empty change event should not be emitted." */,
 		);
 		this.deltaOperation = deltaArgs.operation;
+		this.isLocal = opArgs?.sequencedMessage === undefined;
 
 		// eslint-disable-next-line import/no-deprecated
 		this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(() => {
@@ -124,23 +155,25 @@ export abstract class SequenceEvent<
  * @legacy
  * @alpha
  */
-export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
-	/**
-	 * Whether the event was caused by a locally-made change.
-	 */
-	public readonly isLocal: boolean;
+export interface SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
+	readonly opArgs: IMergeTreeDeltaOpArgs;
 
 	/**
-	 * @deprecated This functionality was not meant to be exported and will be removed in a future release
+	 * Whether the event was caused by a locally-made change.
 	 */
+	readonly isLocal: boolean;
+}
+export class SequenceDeltaEventClass
+	extends SequenceEventClass<MergeTreeDeltaOperationType>
+	implements SequenceDeltaEvent
+{
 	constructor(
 		public readonly opArgs: IMergeTreeDeltaOpArgs,
 		deltaArgs: IMergeTreeDeltaCallbackArgs,
 		// eslint-disable-next-line import/no-deprecated
 		mergeTreeClient: Client,
 	) {
-		super(deltaArgs, mergeTreeClient);
-		this.isLocal = opArgs.sequencedMessage === undefined;
+		super(opArgs, deltaArgs, mergeTreeClient);
 	}
 }
 
@@ -153,10 +186,13 @@ export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationTyp
  * @legacy
  * @alpha
  */
-export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
-	/**
-	 * @deprecated This functionality was not meant to be exported and will be removed in a future release
-	 */
+export interface SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
+	readonly opArgs: IMergeTreeDeltaOpArgs | undefined;
+}
+export class SequenceMaintenanceEventClass
+	extends SequenceEventClass<MergeTreeMaintenanceType>
+	implements SequenceMaintenanceEvent
+{
 	constructor(
 		/**
 		 * Defined iff `deltaArgs.operation` is {@link @fluidframework/merge-tree#MergeTreeMaintenanceType.ACKNOWLEDGED|MergeTreeMaintenanceType.ACKNOWLEDGED}.
@@ -168,7 +204,7 @@ export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenance
 		// eslint-disable-next-line import/no-deprecated
 		mergeTreeClient: Client,
 	) {
-		super(deltaArgs, mergeTreeClient);
+		super(opArgs, deltaArgs, mergeTreeClient);
 	}
 }
 
@@ -213,23 +249,3 @@ export interface ISequenceDeltaRange<
 	 */
 	propertyDeltas: PropertySet;
 }
-
-class Lazy<T> {
-	private pValue: T | undefined;
-	private pEvaluated: boolean;
-	constructor(private readonly valueGenerator: () => T) {
-		this.pEvaluated = false;
-	}
-
-	public get evaluated(): boolean {
-		return this.pEvaluated;
-	}
-
-	public get value(): T {
-		if (!this.pEvaluated) {
-			this.pEvaluated = true;
-			this.pValue = this.valueGenerator();
-		}
-		return this.pValue as T;
-	}
-}

package/src/sharedString.ts

@@ -140,9 +140,7 @@ export type SharedStringSegment = TextSegment | Marker;
  * In addition to text, a Shared String can also contain markers. Markers can be
  * used to store metadata at positions within the text, like the details of an
  * image or Fluid object that should be rendered with the text.
- * @legacy
- * @alpha
- * @deprecated  This functionality was not meant to be exported and will be removed in a future release
+ * @internal
  */
 export class SharedStringClass
 	// eslint-disable-next-line import/no-deprecated