@fluidframework/sequence 2.53.1 → 2.60.0

package/src/intervals/sequenceInterval.ts

@@ -36,7 +36,6 @@ import { LoggingError, UsageError } from "@fluidframework/telemetry-utils/intern
 import { v4 as uuid } from "uuid";
 
 import {
-	// eslint-disable-next-line import/no-deprecated
 	ISerializableInterval,
 	ISerializedInterval,
 	IntervalStickiness,
@@ -44,6 +43,7 @@ import {
 	computeStickinessFromSide,
 	endReferenceSlidingPreference,
 	startReferenceSlidingPreference,
+	type IInterval,
 	type SerializedIntervalDelta,
 } from "./intervalUtils.js";
 
@@ -125,11 +125,9 @@ export function getSerializedProperties(
  * `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.
- * @alpha
- * @legacy
+ * @legacy @beta
  */
-// eslint-disable-next-line import/no-deprecated
-export interface SequenceInterval extends ISerializableInterval {
+export interface SequenceInterval extends IInterval {
 	readonly start: LocalReferencePosition;
 	/**
 	 * End endpoint of this interval.
@@ -144,11 +142,6 @@ export interface SequenceInterval extends ISerializableInterval {
 	/** 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;
 	/**
 	 * Compares this interval to `b` with standard comparator semantics:
 	 * - returns -1 if this is less than `b`
@@ -169,45 +162,12 @@ export interface SequenceInterval extends ISerializableInterval {
 	 * @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.
-	 * @deprecated This api is not meant or necessary for external consumption and will be removed in subsequent release
-	 */
-	modify(
-		label: string,
-		start: SequencePlace | undefined,
-		end: SequencePlace | undefined,
-		op?: ISequencedDocumentMessage,
-		localSeq?: number,
-		canSlideToEndpoint?: 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.
-	 * @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,
-		afterPositionChange: () => void,
-	): void;
-
-	/**
-	 * 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;
 
 	/**
 	 * @returns whether this interval overlaps two numerical positions.
@@ -223,7 +183,6 @@ export interface SequenceInterval extends ISerializableInterval {
 }
 
 export class SequenceIntervalClass
-	// eslint-disable-next-line import/no-deprecated
 	implements SequenceInterval, ISerializableInterval, IDisposable
 {
 	readonly #props: {

package/src/packageVersion.ts

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

package/src/revertibles.ts

@@ -13,7 +13,7 @@ import {
 	MergeTreeDeltaType,
 	PropertySet,
 	ReferenceType,
-	SlidingPreference, // eslint-disable-next-line import/no-deprecated
+	SlidingPreference,
 	appendToMergeTreeDeltaRevertibles,
 	discardMergeTreeDeltaRevertible,
 	getSlideToSegoff,
@@ -34,8 +34,7 @@ import { ISharedString, SharedStringSegment } from "./sharedString.js";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertible;
 
@@ -43,8 +42,7 @@ const idMap = new Map<string, string>();
 
 /**
  * Data for undoing edits affecting Intervals.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IntervalRevertible =
 	| {
@@ -100,8 +98,7 @@ function getUpdatedId(intervalId: string): string {
 
 /**
  * Create revertibles for adding an interval
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function appendAddIntervalToRevertibles(
 	interval: SequenceInterval,
@@ -117,8 +114,7 @@ export function appendAddIntervalToRevertibles(
 
 /**
  * Create revertibles for deleting an interval
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function appendDeleteIntervalToRevertibles(
 	string: ISharedString,
@@ -168,8 +164,7 @@ export function appendDeleteIntervalToRevertibles(
 
 /**
  * Create revertibles for moving endpoints of an interval
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function appendChangeIntervalToRevertibles(
 	string: ISharedString,
@@ -217,8 +212,7 @@ export function appendChangeIntervalToRevertibles(
 
 /**
  * Create revertibles for changing properties of an interval
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function appendIntervalPropertyChangedToRevertibles(
 	interval: SequenceInterval,
@@ -278,8 +272,7 @@ function addIfRevertibleRef(
 /**
  * Create revertibles for SharedStringDeltas, handling indirectly modified intervals
  * (e.g. reverting remove of a range that contains an interval will move the interval back)
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function appendSharedStringDeltaToRevertibles(
 	string: ISharedString,
@@ -376,8 +369,7 @@ export function appendSharedStringDeltaToRevertibles(
 
 /**
  * Clean up resources held by revertibles that are no longer needed.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function discardSharedStringRevertibles(
 	sharedString: ISharedString,
@@ -585,7 +577,6 @@ interface RangeInfo {
 	segment: ISegment;
 }
 
-// eslint-disable-next-line import/no-deprecated
 class SortedRangeSet extends SortedSegmentSet<RangeInfo> {}
 
 function revertLocalSequenceRemove(
@@ -674,8 +665,7 @@ function revertLocalSequenceRemove(
 
 /**
  * Invoke revertibles to reverse prior edits
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function revertSharedStringRevertibles(
 	sharedString: ISharedString,

package/src/sequence.ts

@@ -37,7 +37,6 @@ import {
 	ReferenceType,
 	SlidingPreference,
 	createAnnotateRangeOp,
-	// eslint-disable-next-line import/no-deprecated
 	createGroupOp,
 	createInsertOp,
 	createObliterateRangeOp,
@@ -114,8 +113,7 @@ const contentPath = "content";
  * - `event` - Various information on the segments that were modified.
  *
  * - `target` - The sequence itself.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 	(
@@ -133,8 +131,7 @@ export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISharedSegmentSequence<T extends ISegment>
 	extends ISharedObject<ISharedSegmentSequenceEvents>,
@@ -973,7 +970,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				stashMessage = {
 					...message,
 					referenceSequenceNumber: stashMessage.sequenceNumber - 1,
-					// eslint-disable-next-line import/no-deprecated
 					contents: ops.length !== 1 ? createGroupOp(...ops) : ops[0],
 				};
 			}

package/src/sequenceDeltaEvent.ts

@@ -5,7 +5,6 @@
 
 import { assert, Lazy } from "@fluidframework/core-utils/internal";
 import {
-	// eslint-disable-next-line import/no-deprecated
 	Client,
 	IMergeTreeDeltaCallbackArgs,
 	IMergeTreeDeltaOpArgs,
@@ -15,7 +14,7 @@ import {
 	MergeTreeDeltaOperationTypes,
 	MergeTreeDeltaType,
 	MergeTreeMaintenanceType,
-	PropertySet, // eslint-disable-next-line import/no-deprecated
+	PropertySet,
 	SortedSegmentSet,
 } from "@fluidframework/merge-tree/internal";
 
@@ -25,8 +24,7 @@ import {
  * The properties of this object and its sub-objects represent the state of the sequence at the
  * point in time at which the operation was applied.
  * They will not take into any future modifications performed to the underlying sequence and merge tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface SequenceEvent<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,
@@ -64,7 +62,6 @@ export abstract class SequenceEventClass<
 {
 	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>>;
@@ -75,7 +72,6 @@ export abstract class SequenceEventClass<
 		 * Arguments reflecting the type of change that caused this event.
 		 */
 		public readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>,
-		// eslint-disable-next-line import/no-deprecated
 		private readonly mergeTreeClient: Client,
 	) {
 		if (
@@ -90,9 +86,7 @@ export abstract class SequenceEventClass<
 		this.deltaOperation = deltaArgs.operation;
 		this.isLocal = opArgs?.sequencedMessage === undefined;
 
-		// eslint-disable-next-line import/no-deprecated
 		this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(() => {
-			// eslint-disable-next-line import/no-deprecated
 			const set = new SortedSegmentSet<ISequenceDeltaRange<TOperation>>();
 			this.deltaArgs.deltaSegments.forEach((delta) => {
 				const newRange: ISequenceDeltaRange<TOperation> = {
@@ -158,8 +152,7 @@ export abstract class SequenceEventClass<
  * For group ops, each op will get its own event, and the group op property will be set on the op args.
  *
  * Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
 	readonly opArgs: IMergeTreeDeltaOpArgs;
@@ -176,7 +169,6 @@ export class SequenceDeltaEventClass
 	constructor(
 		public readonly opArgs: IMergeTreeDeltaOpArgs,
 		deltaArgs: IMergeTreeDeltaCallbackArgs,
-		// eslint-disable-next-line import/no-deprecated
 		mergeTreeClient: Client,
 	) {
 		super(opArgs, deltaArgs, mergeTreeClient);
@@ -189,8 +181,7 @@ export class SequenceDeltaEventClass
  * The properties of this object and its sub-objects represent the state of the sequence at the
  * point in time at which the operation was applied.
  * They will not take into consideration any future modifications performed to the underlying sequence and merge tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
 	readonly opArgs: IMergeTreeDeltaOpArgs | undefined;
@@ -207,7 +198,6 @@ export class SequenceMaintenanceEventClass
 		 */
 		public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,
 		deltaArgs: IMergeTreeMaintenanceCallbackArgs,
-		// eslint-disable-next-line import/no-deprecated
 		mergeTreeClient: Client,
 	) {
 		super(opArgs, deltaArgs, mergeTreeClient);
@@ -216,8 +206,7 @@ export class SequenceMaintenanceEventClass
 
 /**
  * A range that has changed corresponding to a segment modification.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISequenceDeltaRange<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,

package/src/sequenceFactory.ts

@@ -13,7 +13,6 @@ import { Marker, TextSegment } from "@fluidframework/merge-tree/internal";
 import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { pkgVersion } from "./packageVersion.js";
-// eslint-disable-next-line import/no-deprecated
 import { SharedStringClass, SharedStringSegment, type ISharedString } from "./sharedString.js";
 
 export class SharedStringFactory implements IChannelFactory<ISharedString> {
@@ -57,9 +56,7 @@ export class SharedStringFactory implements IChannelFactory<ISharedString> {
 		id: string,
 		services: IChannelServices,
 		attributes: IChannelAttributes,
-		// eslint-disable-next-line import/no-deprecated
 	): Promise<SharedStringClass> {
-		// eslint-disable-next-line import/no-deprecated
 		const sharedString = new SharedStringClass(runtime, id, attributes);
 		await sharedString.load(services);
 		return sharedString;
@@ -68,9 +65,7 @@ export class SharedStringFactory implements IChannelFactory<ISharedString> {
 	/**
 	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
 	 */
-	// eslint-disable-next-line import/no-deprecated
 	public create(document: IFluidDataStoreRuntime, id: string): SharedStringClass {
-		// eslint-disable-next-line import/no-deprecated
 		const sharedString = new SharedStringClass(document, id, this.attributes);
 		sharedString.initializeLocal();
 		return sharedString;
@@ -79,14 +74,12 @@ export class SharedStringFactory implements IChannelFactory<ISharedString> {
 
 /**
  * Entrypoint for {@link ISharedString} creation.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const SharedString = createSharedObjectKind<ISharedString>(SharedStringFactory);
 
 /**
  * Alias for {@link ISharedString} for compatibility.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SharedString = ISharedString;

package/src/sharedSequence.ts

@@ -16,7 +16,6 @@ import {
 	PropertySet,
 } from "@fluidframework/merge-tree/internal";
 
-// eslint-disable-next-line import/no-deprecated
 import { SharedSegmentSequence } from "./sequence.js";
 
 const MaxRun = 128;
@@ -119,7 +118,6 @@ export class SubSequence<T> extends BaseSegment {
  * @deprecated SharedSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
  * @internal
  */
-// eslint-disable-next-line import/no-deprecated
 export class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
 	constructor(
 		document: IFluidDataStoreRuntime,

package/src/sharedString.ts

@@ -8,7 +8,6 @@ import {
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions/internal";
 import {
-	// eslint-disable-next-line import/no-deprecated
 	IMergeTreeTextHelper,
 	IRelativePosition,
 	ISegment,
@@ -20,14 +19,12 @@ import {
 	refHasTileLabel,
 } from "@fluidframework/merge-tree/internal";
 
-// eslint-disable-next-line import/no-deprecated
 import { SharedSegmentSequence, type ISharedSegmentSequence } from "./sequence.js";
 import { SharedStringFactory } from "./sequenceFactory.js";
 
 /**
  * Fluid object interface describing access methods on a SharedString
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISharedString extends ISharedSegmentSequence<SharedStringSegment> {
 	/**
@@ -127,8 +124,7 @@ export interface ISharedString extends ISharedSegmentSequence<SharedStringSegmen
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SharedStringSegment = TextSegment | Marker;
 
@@ -143,7 +139,6 @@ export type SharedStringSegment = TextSegment | Marker;
  * @internal
  */
 export class SharedStringClass
-	// eslint-disable-next-line import/no-deprecated
 	extends SharedSegmentSequence<SharedStringSegment>
 	implements ISharedString
 {
@@ -151,7 +146,6 @@ export class SharedStringClass
 		return this;
 	}
 
-	// eslint-disable-next-line import/no-deprecated
 	private readonly mergeTreeTextHelper: IMergeTreeTextHelper;
 
 	constructor(