@fluidframework/sequence 2.0.0-internal.6.3.2 → 2.0.0-internal.6.4.0

package/src/intervalIndex/overlappingSequenceIntervalsIndex.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable import/no-deprecated */
 
 import {
 	Client,
@@ -16,6 +17,7 @@ import {
 	SequenceInterval,
 	createPositionReferenceFromSegoff,
 } from "../intervals";
+import { SharedString } from "../sharedString";
 import { SequenceIntervalIndexes } from "./sequenceIntervalIndexes";
 import { OverlappingIntervalsIndex } from "./overlappingIntervalsIndex";
 
@@ -65,7 +67,8 @@ class OverlappingSequenceIntervalsIndex
 }
 
 export function createOverlappingSequenceIntervalsIndex(
-	client: Client,
+	sharedString: SharedString,
 ): SequenceIntervalIndexes.Overlapping {
+	const client = (sharedString as unknown as { client: Client }).client;
 	return new OverlappingSequenceIntervalsIndex(client);
 }

package/src/intervalIndex/sequenceIntervalIndexes.ts

@@ -27,6 +27,6 @@ export namespace SequenceIntervalIndexes {
 		findOverlappingIntervalsBySegoff(
 			startSegoff: { segment: ISegment | undefined; offset: number | undefined },
 			endSegoff: { segment: ISegment | undefined; offset: number | undefined },
-		);
+		): Iterable<SequenceInterval>;
 	}
 }

package/src/intervalIndex/startpointInRangeIndex.ts

@@ -2,10 +2,18 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable import/no-deprecated */
 
 import { Client, PropertyAction, RedBlackTree } from "@fluidframework/merge-tree";
 import { assert } from "@fluidframework/core-utils";
-import { IIntervalHelpers, ISerializableInterval, IntervalType } from "../intervals";
+import {
+	IIntervalHelpers,
+	ISerializableInterval,
+	IntervalType,
+	SequenceInterval,
+	sequenceIntervalHelpers,
+} from "../intervals";
+import { SharedString } from "../sharedString";
 import { IntervalIndex } from "./intervalIndex";
 import { HasComparisonOverride, compareOverrideables, forceCompare } from "./intervalIndexUtils";
 
@@ -19,17 +27,17 @@ export interface IStartpointInRangeIndex<TInterval extends ISerializableInterval
 	/**
 	 * @returns an array of all intervals contained in this collection whose startpoints locate in the range [start, end] (includes both ends)
 	 */
-	findIntervalsWithStartpointInRange(start: number, end: number);
+	findIntervalsWithStartpointInRange(start: number, end: number): TInterval[];
 }
 
-class StartpointInRangeIndex<TInterval extends ISerializableInterval>
+export class StartpointInRangeIndex<TInterval extends ISerializableInterval>
 	implements IStartpointInRangeIndex<TInterval>
 {
 	private readonly intervalTree;
 
 	constructor(
-		private readonly helpers: IIntervalHelpers<TInterval>,
 		private readonly client: Client,
+		private readonly helpers: IIntervalHelpers<TInterval>,
 	) {
 		this.intervalTree = new RedBlackTree<TInterval, TInterval>((a: TInterval, b: TInterval) => {
 			assert(
@@ -66,7 +74,7 @@ class StartpointInRangeIndex<TInterval extends ISerializableInterval>
 		this.intervalTree.remove(interval);
 	}
 
-	public findIntervalsWithStartpointInRange(start: number, end: number) {
+	public findIntervalsWithStartpointInRange(start: number, end: number): TInterval[] {
 		if (start <= 0 || start > end || this.intervalTree.isEmpty()) {
 			return [];
 		}
@@ -101,9 +109,9 @@ class StartpointInRangeIndex<TInterval extends ISerializableInterval>
 	}
 }
 
-export function createStartpointInRangeIndex<TInterval extends ISerializableInterval>(
-	helpers: IIntervalHelpers<TInterval>,
-	client: Client,
-): IStartpointInRangeIndex<TInterval> {
-	return new StartpointInRangeIndex<TInterval>(helpers, client);
+export function createStartpointInRangeIndex(
+	sharedString: SharedString,
+): IStartpointInRangeIndex<SequenceInterval> {
+	const client = (sharedString as unknown as { client: Client }).client;
+	return new StartpointInRangeIndex<SequenceInterval>(client, sequenceIntervalHelpers);
 }

package/src/intervals/interval.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable import/no-deprecated */
 
 import {
 	ICombiningOp,
@@ -60,7 +61,7 @@ export class Interval implements ISerializableInterval {
 	 * Adds an auxiliary set of properties to this interval.
 	 * These properties can be recovered using `getAdditionalPropertySets`
 	 * @param props - set of properties to add
-	 * @remarks - This gets called as part of the default conflict resolver for `IIntervalCollection<Interval>`
+	 * @remarks This gets called as part of the default conflict resolver for `IIntervalCollection<Interval>`
 	 * (i.e. non-sequence-based interval collections). However, the additional properties don't get serialized.
 	 * This functionality seems half-baked.
 	 */

package/src/intervals/intervalUtils.ts

@@ -12,6 +12,7 @@ import {
 	SlidingPreference,
 } from "@fluidframework/merge-tree";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+
 /**
  * Basic interval abstraction
  */
@@ -105,7 +106,7 @@ export interface ISerializedInterval {
 	/**
 	 * Sequence number at which `start` and `end` should be interpreted
 	 *
-	 * @remarks - It's unclear that this is necessary to store here.
+	 * @remarks It's unclear that this is necessary to store here.
 	 * This should just be the refSeq on the op that modified the interval, which should be available via other means.
 	 * At the time of writing, it's not plumbed through to the reconnect/rebase code, however, which does need it.
 	 */
@@ -138,7 +139,7 @@ export interface ISerializableInterval extends IInterval {
 	 * 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.
-	 * @remarks - This signature includes `undefined` strictly for backwards-compatibility reasons, as older versions
+	 * @remarks This signature includes `undefined` strictly for backwards-compatibility reasons, as older versions
 	 * of Fluid didn't always write interval ids.
 	 */
 	getIntervalId(): string | undefined;
@@ -166,6 +167,7 @@ export type CompressedSerializedInterval =
 
 /**
  * @sealed
+ * @deprecated The methods within have substitutions
  */
 export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
 	/**

package/src/intervals/sequenceInterval.ts

@@ -4,6 +4,7 @@
  */
 
 /* eslint-disable no-bitwise */
+/* eslint-disable import/no-deprecated */
 
 import {
 	Client,
@@ -43,7 +44,7 @@ const reservedIntervalIdKey = "intervalId";
  * As such, when content is inserted into the middle of the interval, the interval expands to
  * include that content.
  *
- * @remarks - The endpoint's position should be treated exclusively to get reasonable behavior--i.e.
+ * @remarks The endpoint's position should be treated exclusively to get reasonable behavior--i.e.
  * an interval referring to "hello" in "hello world" should have a start position of 0 and an end
  * position of 5.
  *
@@ -74,12 +75,12 @@ export class SequenceInterval implements ISerializableInterval {
 		private readonly client: Client,
 		/**
 		 * Start endpoint of this interval.
-		 * @remarks - This endpoint can be resolved into a character position using the SharedString it's a part of.
+		 * @remarks This endpoint can be resolved into a character position using the SharedString it's a part of.
 		 */
 		public 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.
+		 * @remarks This endpoint can be resolved into a character position using the SharedString it's a part of.
 		 */
 		public end: LocalReferencePosition,
 		public intervalType: IntervalType,
@@ -435,7 +436,7 @@ export function createSequenceInterval(
 		// All non-transient interval references must eventually be SlideOnRemove
 		// To ensure eventual consistency, they must start as StayOnRemove when
 		// pending (created locally and creation op is not acked)
-		if (op || fromSnapshot) {
+		if (op ?? fromSnapshot) {
 			beginRefType |= ReferenceType.SlideOnRemove;
 			endRefType |= ReferenceType.SlideOnRemove;
 		} else {
@@ -487,6 +488,9 @@ export const compareSequenceIntervalEnds = (a: SequenceInterval, b: SequenceInte
 export const compareSequenceIntervalStarts = (a: SequenceInterval, b: SequenceInterval): number =>
 	compareReferencePositions(a.start, b.start);
 
+/**
+ * @deprecated The methods within have substitutions
+ */
 export const sequenceIntervalHelpers: IIntervalHelpers<SequenceInterval> = {
 	compareEnds: compareSequenceIntervalEnds,
 	compareStarts: compareSequenceIntervalStarts,

package/src/packageVersion.ts

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

package/src/sequence.ts

@@ -452,7 +452,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	}
 
 	/**
-	 * @returns - The most recent sequence number which has been acked by the server and processed by this
+	 * @returns The most recent sequence number which has been acked by the server and processed by this
 	 * SharedSegmentSequence.
 	 */
 	public getCurrentSeq() {
@@ -489,6 +489,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * @returns An iterable object that enumerates the IntervalCollection labels.
 	 *
 	 * @example
+	 *
 	 * ```typescript
 	 * const iter = this.getIntervalCollectionKeys();
 	 * for (key of iter)
@@ -704,7 +705,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
 	 */
 	protected applyStashedOp(content: any): unknown {
-		return this.client.applyStashedOp(content);
+		return this.client.applyStashedOp(parseHandles(content, this.serializer));
 	}
 
 	private summarizeMergeTree(serializer: IFluidSerializer): ISummaryTreeWithStats {

package/src/sequenceDeltaEvent.ts

@@ -147,25 +147,33 @@ export interface ISequenceDeltaRange<
 > {
 	/**
 	 * The type of operation that changed this range.
-	 * @remarks - Consuming code should typically compare this to the enum values defined in
+	 *
+	 * @remarks Consuming code should typically compare this to the enum values defined in
 	 * `MergeTreeDeltaOperationTypes`.
 	 */
 	operation: TOperation;
+
 	/**
 	 * The index of the start of the range.
 	 */
 	position: number;
+
 	/**
 	 * The segment that corresponds to the range.
 	 */
 	segment: ISegment;
+
 	/**
 	 * Deltas object which contains all modified properties with their previous values.
 	 * Since `undefined` doesn't survive a round-trip through JSON serialization, the old value being absent
 	 * is instead encoded with `null`.
-	 * @remarks - This object is motivated by undo/redo scenarios, and provides a convenient "inverse op" to apply to
+	 *
+	 * @remarks This object is motivated by undo/redo scenarios, and provides a convenient "inverse op" to apply to
 	 * undo a property change.
-	 * @example - If a segment initially had properties `{ foo: "1", bar: 2 }` and it was annotated with
+	 *
+	 * @example
+	 *
+	 * If a segment initially had properties `{ foo: "1", bar: 2 }` and it was annotated with
 	 * `{ foo: 3, baz: 5 }`, the corresponding event would have a `propertyDeltas` of `{ foo: "1", baz: null }`.
 	 */
 	propertyDeltas: PropertySet;

package/src/sequenceFactory.ts

@@ -15,7 +15,7 @@ import { SharedString, SharedStringSegment } from "./sharedString";
 
 export class SharedStringFactory implements IChannelFactory {
 	// TODO rename back to https://graph.microsoft.com/types/mergeTree/string once paparazzi is able to dynamically
-	// load code
+	// load code (UPDATE: paparazzi is gone... anything to do here?)
 	public static Type = "https://graph.microsoft.com/types/mergeTree";
 
 	public static readonly Attributes: IChannelAttributes = {

package/src/sharedString.ts

@@ -406,7 +406,8 @@ const gatherTextAndMarkers: ISegmentAction<ITextAndMarkerAccumulator> = (
 		if (placeholder && placeholder.length > 0) {
 			const placeholderText =
 				placeholder === "*"
-					? `\n${segment.toString()}`
+					? // eslint-disable-next-line @typescript-eslint/no-base-to-string
+					  `\n${segment.toString()}`
 					: placeholder.repeat(segment.cachedLength);
 			textSegment.text += placeholderText;
 		} else {