@fluidframework/sequence 2.0.0-internal.7.0.0 → 2.0.0-internal.7.2.0

package/src/intervalIndex/idIntervalIndex.ts

@@ -9,6 +9,9 @@ import { IntervalIndex } from "./intervalIndex";
 
 const reservedIntervalIdKey = "intervalId";
 
+/**
+ * @public
+ */
 export interface IIdIntervalIndex<TInterval extends ISerializableInterval>
 	extends IntervalIndex<TInterval>,
 		Iterable<TInterval> {
@@ -51,6 +54,9 @@ class IdIntervalIndex<TInterval extends ISerializableInterval>
 	}
 }
 
+/**
+ * @public
+ */
 export function createIdIntervalIndex<
 	TInterval extends ISerializableInterval,
 >(): IIdIntervalIndex<TInterval> {

package/src/intervalIndex/intervalIndex.ts

@@ -13,6 +13,7 @@ import { ISerializableInterval } from "../intervals";
  * - "find all intervals with start endpoint between these two points"
  * - "find all intervals which overlap this range"
  * etc.
+ * @public
  */
 export interface IntervalIndex<TInterval extends ISerializableInterval> {
 	/**

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -17,6 +17,9 @@ import { SharedString } from "../sharedString";
 import { SequencePlace, endpointPosAndSide } from "../intervalCollection";
 import { IntervalIndex } from "./intervalIndex";
 
+/**
+ * @public
+ */
 export interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval>
 	extends IntervalIndex<TInterval> {
 	/**
@@ -36,6 +39,9 @@ export interface IOverlappingIntervalsIndex<TInterval extends ISerializableInter
 	): void;
 }
 
+/**
+ * @public
+ */
 export class OverlappingIntervalsIndex<TInterval extends ISerializableInterval>
 	implements IOverlappingIntervalsIndex<TInterval>
 {
@@ -170,6 +176,9 @@ export class OverlappingIntervalsIndex<TInterval extends ISerializableInterval>
 	}
 }
 
+/**
+ * @public
+ */
 export function createOverlappingIntervalsIndex(
 	sharedString: SharedString,
 ): IOverlappingIntervalsIndex<SequenceInterval> {

package/src/intervalIndex/overlappingSequenceIntervalsIndex.ts

@@ -21,6 +21,9 @@ import { SharedString } from "../sharedString";
 import { SequenceIntervalIndexes } from "./sequenceIntervalIndexes";
 import { OverlappingIntervalsIndex } from "./overlappingIntervalsIndex";
 
+/**
+ * @public
+ */
 class OverlappingSequenceIntervalsIndex
 	extends OverlappingIntervalsIndex<SequenceInterval>
 	implements SequenceIntervalIndexes.Overlapping
@@ -66,6 +69,9 @@ class OverlappingSequenceIntervalsIndex
 	}
 }
 
+/**
+ * @public
+ */
 export function createOverlappingSequenceIntervalsIndex(
 	sharedString: SharedString,
 ): SequenceIntervalIndexes.Overlapping {

package/src/intervalIndex/sequenceIntervalIndexes.ts

@@ -10,6 +10,7 @@ import { IOverlappingIntervalsIndex } from "./overlappingIntervalsIndex";
 /**
  * This namespace contains specialiazations of indexes which support spatial queries
  * specifically for `SequenceInterval`s.
+ * @public
  */
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace SequenceIntervalIndexes {

package/src/intervalIndex/startpointInRangeIndex.ts

@@ -20,6 +20,7 @@ import { HasComparisonOverride, compareOverrideables, forceCompare } from "./int
  * Collection of intervals.
  *
  * Provide additional APIs to support efficiently querying a collection of intervals whose startpoints fall within a specified range.
+ * @public
  */
 export interface IStartpointInRangeIndex<TInterval extends ISerializableInterval>
 	extends IntervalIndex<TInterval> {
@@ -102,7 +103,9 @@ export class StartpointInRangeIndex<TInterval extends ISerializableInterval>
 		return results;
 	}
 }
-
+/**
+ * @public
+ */
 export function createStartpointInRangeIndex(
 	sharedString: SharedString,
 ): IStartpointInRangeIndex<SequenceInterval> {

package/src/intervals/interval.ts

@@ -21,6 +21,7 @@ const reservedIntervalIdKey = "intervalId";
 
 /**
  * Serializable interval whose endpoints are plain-old numbers.
+ * @public
  */
 export class Interval implements ISerializableInterval {
 	/**
@@ -34,7 +35,11 @@ export class Interval implements ISerializableInterval {
 	 * @internal
 	 */
 	public propertyManager: PropertiesManager;
-	constructor(public start: number, public end: number, props?: PropertySet) {
+	constructor(
+		public start: number,
+		public end: number,
+		props?: PropertySet,
+	) {
 		this.propertyManager = new PropertiesManager();
 		this.properties = {};
 

package/src/intervals/intervalUtils.ts

@@ -16,6 +16,7 @@ import { SequencePlace, Side } from "../intervalCollection";
 
 /**
  * Basic interval abstraction
+ * @public
  */
 export interface IInterval {
 	/**
@@ -80,8 +81,14 @@ export const IntervalOpType = {
 	POSITION_REMOVE: "positionRemove",
 } as const;
 
+/**
+ * @public
+ */
 export enum IntervalType {
 	Simple = 0x0,
+	/**
+	 * @deprecated this functionality is no longer supported and will be removed
+	 */
 	Nest = 0x1,
 
 	/**
@@ -129,6 +136,9 @@ export interface ISerializedInterval {
 	properties?: PropertySet;
 }
 
+/**
+ * @public
+ */
 export interface ISerializableInterval extends IInterval {
 	/** Serializable bag of properties associated with the interval. */
 	properties: PropertySet;
@@ -191,6 +201,7 @@ export type CompressedSerializedInterval =
 /**
  * @sealed
  * @deprecated The methods within have substitutions
+ * @public
  */
 export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
 	/**
@@ -262,7 +273,7 @@ export const IntervalStickiness = {
  *
  * @internal
  */
-export type IntervalStickiness = typeof IntervalStickiness[keyof typeof IntervalStickiness];
+export type IntervalStickiness = (typeof IntervalStickiness)[keyof typeof IntervalStickiness];
 
 export function startReferenceSlidingPreference(stickiness: IntervalStickiness): SlidingPreference {
 	// if any start stickiness, prefer sliding backwards

package/src/intervals/sequenceInterval.ts

@@ -100,6 +100,7 @@ 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.
+ * @public
  */
 export class SequenceInterval implements ISerializableInterval {
 	/**
@@ -636,6 +637,7 @@ export function createSequenceInterval(
 
 /**
  * @deprecated The methods within have substitutions
+ * @public
  */
 export const sequenceIntervalHelpers: IIntervalHelpers<SequenceInterval> = {
 	create: createSequenceInterval,

package/src/localValues.ts

@@ -58,7 +58,10 @@ export class ValueTypeLocalValue<T> implements ILocalValue<T> {
 	 * @param value - The instance of the value type stored within
 	 * @param valueType - The type object of the value type stored within
 	 */
-	constructor(public readonly value: T, private readonly valueType: IValueType<T>) {}
+	constructor(
+		public readonly value: T,
+		private readonly valueType: IValueType<T>,
+	) {}
 
 	/**
 	 * {@inheritDoc ILocalValue."type"}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.0.0-internal.7.0.0";
+export const pkgVersion = "2.0.0-internal.7.2.0";

package/src/revertibles.ts

@@ -33,7 +33,7 @@ export type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertib
 
 const idMap = new Map<string, string>();
 
-type IntervalOpType = typeof IntervalOpType[keyof typeof IntervalOpType];
+type IntervalOpType = (typeof IntervalOpType)[keyof typeof IntervalOpType];
 
 /**
  * Data for undoing edits affecting Intervals.
@@ -416,11 +416,14 @@ function revertLocalDelete(
 	const startSlidePos = getSlidePosition(string, revertible.start, start);
 	const end = string.localReferencePositionToPosition(revertible.end);
 	const endSlidePos = getSlidePosition(string, revertible.end, end);
-	const type = revertible.interval.intervalType;
 	// reusing the id causes eventual consistency bugs, so it is removed here and recreated in add
 	const { intervalId, ...props } = revertible.interval.properties;
 	if (isValidRange(startSlidePos, endSlidePos, string)) {
-		const int = collection.add(startSlidePos, endSlidePos, type, props);
+		const int = collection.add({
+			start: startSlidePos,
+			end: endSlidePos,
+			props,
+		});
 
 		idMap.forEach((newId, oldId) => {
 			if (intervalId === newId) {

package/src/sequence.ts

@@ -29,6 +29,7 @@ import {
 	ISegment,
 	ISegmentAction,
 	LocalReferencePosition,
+	// eslint-disable-next-line import/no-deprecated
 	matchProperties,
 	MergeTreeDeltaType,
 	PropertySet,
@@ -96,6 +97,7 @@ const contentPath = "content";
  * - `event` - Various information on the segments that were modified.
  *
  * - `target` - The sequence itself.
+ * @public
  */
 export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 	(
@@ -112,6 +114,9 @@ export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 	);
 }
 
+/**
+ * @public
+ */
 export abstract class SharedSegmentSequence<T extends ISegment>
 	extends SharedObject<ISharedSegmentSequenceEvents>
 	implements ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver
@@ -148,6 +153,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 					if (
 						lastAnnotate &&
 						lastAnnotate.pos2 === r.position &&
+						// eslint-disable-next-line import/no-deprecated
 						matchProperties(lastAnnotate.props, props)
 					) {
 						lastAnnotate.pos2 += r.segment.cachedLength;
@@ -266,7 +272,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	}
 
 	/**
-	 * @deprecated - The ability to create group ops will be removed in an upcoming release, as group ops are redundant with the native batching capabilities of the runtime
+	 * @deprecated The ability to create group ops will be removed in an upcoming release, as group ops are redundant with the native batching capabilities of the runtime
 	 */
 	public groupOperation(groupOp: IMergeTreeGroupMsg) {
 		this.guardReentrancy(() => this.client.localTransaction(groupOp));
@@ -393,7 +399,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	}
 
 	/**
-	 * @deprecated - This method will no longer be public in an upcoming release as it is not safe to use outside of this class
+	 * @deprecated This method will no longer be public in an upcoming release as it is not safe to use outside of this class
 	 */
 	public submitSequenceMessage(message: IMergeTreeOp) {
 		if (!this.isAttached()) {
@@ -447,7 +453,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	}
 
 	/**
-	 * @deprecated - this functionality is no longer supported and will be removed
+	 * @deprecated this functionality is no longer supported and will be removed
 	 */
 	public getStackContext(startPos: number, rangeLabels: string[]): RangeStackMap {
 		return this.client.getStackContext(startPos, rangeLabels);
@@ -619,7 +625,8 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 							m.minimumSequenceNumber < collabWindow.minSeq ||
 							m.referenceSequenceNumber < collabWindow.minSeq ||
 							m.sequenceNumber <= collabWindow.minSeq ||
-							m.sequenceNumber <= collabWindow.currentSeq
+							// sequenceNumber could be the same if messages are part of a grouped batch
+							m.sequenceNumber < collabWindow.currentSeq
 						) {
 							throw new Error(
 								`Invalid catchup operations in snapshot: ${JSON.stringify({

package/src/sequenceDeltaEvent.ts

@@ -23,6 +23,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.
+ * @public
  */
 export abstract class SequenceEvent<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,
@@ -105,6 +106,7 @@ export abstract class SequenceEvent<
  * 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.
+ * @public
  */
 export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
 	/**
@@ -128,6 +130,7 @@ export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationTyp
  * 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.
+ * @public
  */
 export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
 	constructor(
@@ -141,6 +144,7 @@ export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenance
 
 /**
  * A range that has changed corresponding to a segment modification.
+ * @public
  */
 export interface ISequenceDeltaRange<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,

package/src/sequenceFactory.ts

@@ -13,6 +13,9 @@ import { Marker, TextSegment } from "@fluidframework/merge-tree";
 import { pkgVersion } from "./packageVersion";
 import { SharedString, SharedStringSegment } from "./sharedString";
 
+/**
+ * @public
+ */
 export class SharedStringFactory implements IChannelFactory {
 	// TODO rename back to https://graph.microsoft.com/types/mergeTree/string once paparazzi is able to dynamically
 	// load code (UPDATE: paparazzi is gone... anything to do here?)

package/src/sharedIntervalCollection.ts

@@ -33,6 +33,7 @@ const snapshotFileName = "header";
 /**
  * The factory that defines the SharedIntervalCollection.
  * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
+ * @public
  */
 export class SharedIntervalCollectionFactory implements IChannelFactory {
 	public static readonly Type = "https://graph.microsoft.com/types/sharedIntervalCollection";
@@ -74,12 +75,16 @@ export class SharedIntervalCollectionFactory implements IChannelFactory {
 	}
 }
 
+/**
+ * @public
+ */
 export interface ISharedIntervalCollection<TInterval extends ISerializableInterval> {
 	getIntervalCollection(label: string): IIntervalCollection<TInterval>;
 }
 
 /**
  * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
+ * @public
  */
 export class SharedIntervalCollection
 	extends SharedObject

package/src/sharedSequence.ts

@@ -15,14 +15,16 @@ import { SharedSegmentSequence } from "./sequence";
 const MaxRun = 128;
 
 /**
- * @deprecated - IJSONRunSegment will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ * @deprecated IJSONRunSegment will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ * @public
  */
 export interface IJSONRunSegment<T> extends IJSONSegment {
 	items: Serializable<T>[];
 }
 
 /**
- * @deprecated - SubSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ * @deprecated SubSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ * @public
  */
 export class SubSequence<T> extends BaseSegment {
 	public static readonly typeString: string = "SubSequence";
@@ -105,7 +107,8 @@ 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
+ * @deprecated SharedSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ * @public
  */
 export class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
 	constructor(

package/src/sharedString.ts

@@ -24,6 +24,7 @@ import { SharedStringFactory } from "./sequenceFactory";
 
 /**
  * Fluid object interface describing access methods on a SharedString
+ * @public
  */
 export interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {
 	/**
@@ -52,6 +53,9 @@ export interface ISharedString extends SharedSegmentSequence<SharedStringSegment
 	posFromRelativePos(relativePos: IRelativePosition): number;
 }
 
+/**
+ * @public
+ */
 export type SharedStringSegment = TextSegment | Marker;
 
 /**
@@ -63,6 +67,7 @@ export type SharedStringSegment = TextSegment | Marker;
  * 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.
  *
+ * @public
  */
 export class SharedString
 	extends SharedSegmentSequence<SharedStringSegment>
@@ -215,6 +220,7 @@ export class SharedString
 	/**
 	 * Finds the nearest reference with ReferenceType.Tile to `startPos` in the direction dictated by `tilePrecedesPos`.
 	 * Note that Markers receive `ReferenceType.Tile` by default.
+	 * @deprecated Use `searchForMarker` instead.
 	 * @param startPos - Position at which to start the search
 	 * @param clientId - clientId dictating the perspective to search from
 	 * @param tileLabel - Label of the tile to search for
@@ -233,6 +239,22 @@ export class SharedString
 		return this.client.findTile(startPos ?? 0, tileLabel, preceding);
 	}
 
+	/**
+	 * Searches a string for the nearest marker in either direction to a given start position.
+	 * The search will include the start position, so markers at the start position are valid
+	 * results of the search.
+	 * @param startPos - Position at which to start the search
+	 * @param markerLabel - Label of the marker to search for
+	 * @param forwards - Whether the desired marker comes before (false) or after (true) `startPos`
+	 */
+	public searchForMarker(
+		startPos: number,
+		markerLabel: string,
+		forwards = true,
+	): Marker | undefined {
+		return this.client.searchForMarker(startPos, markerLabel, forwards);
+	}
+
 	/**
 	 * Retrieve text from the SharedString in string format.
 	 * @param start - The starting index of the text to retrieve, or 0 if omitted.
@@ -309,7 +331,6 @@ interface ITextAndMarkerAccumulator {
  * @param sharedString - String to retrieve text and markers from
  * @param label - label to split on
  * @returns Two parallel lists of text and markers, split by markers with the provided `label`.
- *
  * For example:
  * ```typescript
  * // Say sharedstring has contents "hello<paragraph marker 1>world<paragraph marker 2>missing".
@@ -318,6 +339,7 @@ interface ITextAndMarkerAccumulator {
  * // parallelMarkers === [<paragraph marker 1 object>, <paragraph marker 2 object>]
  * // Note parallelText does not include "missing".
  * ```
+ * @public
  */
 export function getTextAndMarkers(
 	sharedString: SharedString,