@fluidframework/sequence 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0

package/src/intervals/sequenceInterval.ts

@@ -100,7 +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
+ * @alpha
  */
 export class SequenceInterval implements ISerializableInterval {
 	/**
@@ -109,13 +109,10 @@ export class SequenceInterval implements ISerializableInterval {
 	public properties: PropertySet;
 	/**
 	 * {@inheritDoc ISerializableInterval.propertyManager}
-	 * @internal
 	 */
 	public propertyManager: PropertiesManager;
 
-	/**
-	 * @internal
-	 */
+	/***/
 	public get stickiness(): IntervalStickiness {
 		const startSegment = this.start.getSegment();
 		const endSegment = this.end.getSegment();
@@ -156,7 +153,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * Subscribes to position change events on this interval if there are no current listeners.
-	 * @internal
 	 */
 	public addPositionChangeListeners(
 		beforePositionChange: () => void,
@@ -177,7 +173,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * Removes the currently subscribed position change listeners.
-	 * @internal
 	 */
 	public removePositionChangeListeners(): void {
 		if (this.callbacks) {
@@ -189,7 +184,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc ISerializableInterval.serialize}
-	 * @internal
 	 */
 	public serialize(): ISerializedInterval {
 		const startPosition = this.client.localReferencePositionToPosition(this.start);
@@ -299,7 +293,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc IInterval.union}
-	 * @internal
 	 */
 	public union(b: SequenceInterval) {
 		const newStart = minReferencePosition(this.start, b.start);
@@ -334,7 +327,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc ISerializableInterval.addProperties}
-	 * @internal
 	 */
 	public addProperties(
 		newProps: PropertySet,
@@ -357,7 +349,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc IInterval.modify}
-	 * @internal
 	 */
 	public modify(
 		label: string,
@@ -637,7 +628,7 @@ export function createSequenceInterval(
 
 /**
  * @deprecated The methods within have substitutions
- * @public
+ * @internal
  */
 export const sequenceIntervalHelpers: IIntervalHelpers<SequenceInterval> = {
 	create: createSequenceInterval,

package/src/localValues.ts

@@ -11,6 +11,7 @@ import {
 	IValueOperation,
 	IValueType,
 } from "./defaultMapInterfaces";
+import { IntervalOpType } from "./intervals";
 
 /**
  * A local value to be stored in a container type DDS.
@@ -88,7 +89,7 @@ export class ValueTypeLocalValue<T> implements ILocalValue<T> {
 	 * @param opName - The name of the operation that needs processing
 	 * @returns The object which can process the given op
 	 */
-	public getOpHandler(opName: string): IValueOperation<T> {
+	public getOpHandler(opName: IntervalOpType): IValueOperation<T> {
 		const handler = this.valueType.ops.get(opName);
 		if (!handler) {
 			throw new Error("Unknown type message");

package/src/packageVersion.ts

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

package/src/revertibles.ts

@@ -2,6 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+
+/* eslint-disable import/no-deprecated */
 /* eslint-disable no-bitwise */
 
 import { assert, unreachableCase } from "@fluidframework/core-utils";
@@ -19,26 +21,24 @@ import {
 	revertMergeTreeDeltaRevertibles,
 	SortedSet,
 	getSlideToSegoff,
+	SlidingPreference,
 } from "@fluidframework/merge-tree";
+import { InteriorSequencePlace, Side } from "./intervalCollection";
 import { IntervalOpType, SequenceInterval } from "./intervals";
 import { SharedString, SharedStringSegment } from "./sharedString";
 import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
- *
- * @alpha
+ * @internal
  */
 export type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertible;
 
 const idMap = new Map<string, string>();
 
-type IntervalOpType = (typeof IntervalOpType)[keyof typeof IntervalOpType];
-
 /**
  * Data for undoing edits affecting Intervals.
- *
- * @alpha
+ * @internal
  */
 export type IntervalRevertible =
 	| {
@@ -92,7 +92,7 @@ function getUpdatedId(intervalId: string): string {
 
 /**
  * Create revertibles for adding an interval
- * @alpha
+ * @internal
  */
 export function appendAddIntervalToRevertibles(
 	interval: SequenceInterval,
@@ -108,7 +108,7 @@ export function appendAddIntervalToRevertibles(
 
 /**
  * Create revertibles for deleting an interval
- * @alpha
+ * @internal
  */
 export function appendDeleteIntervalToRevertibles(
 	string: SharedString,
@@ -154,7 +154,7 @@ export function appendDeleteIntervalToRevertibles(
 
 /**
  * Create revertibles for moving endpoints of an interval
- * @alpha
+ * @internal
  */
 export function appendChangeIntervalToRevertibles(
 	string: SharedString,
@@ -204,7 +204,7 @@ export function appendChangeIntervalToRevertibles(
 
 /**
  * Create revertibles for changing properties of an interval
- * @alpha
+ * @internal
  */
 export function appendIntervalPropertyChangedToRevertibles(
 	interval: SequenceInterval,
@@ -264,8 +264,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)
- *
- * @alpha
+ * @internal
  */
 export function appendSharedStringDeltaToRevertibles(
 	string: SharedString,
@@ -358,7 +357,7 @@ export function appendSharedStringDeltaToRevertibles(
 
 /**
  * Clean up resources held by revertibles that are no longer needed.
- * @alpha
+ * @internal
  */
 export function discardSharedStringRevertibles(
 	sharedString: SharedString,
@@ -387,13 +386,22 @@ function getSlidePosition(string: SharedString, lref: LocalReferencePosition, po
 		: pos;
 }
 
-function isValidRange(start: number, end: number, string: SharedString) {
+function isValidRange(
+	start: number,
+	startSlide: SlidingPreference | undefined,
+	end: number,
+	endSlide: SlidingPreference | undefined,
+	string: SharedString,
+) {
 	return (
 		start >= 0 &&
 		start < string.getLength() &&
 		end >= 0 &&
 		end < string.getLength() &&
-		start <= end
+		(start < end ||
+			(start === end &&
+				(startSlide === SlidingPreference.FORWARD ||
+					endSlide !== SlidingPreference.FORWARD)))
 	);
 }
 
@@ -406,6 +414,26 @@ function revertLocalAdd(
 	string.getIntervalCollection(label).removeIntervalById(id);
 }
 
+function createSequencePlace(
+	pos: number,
+	newSlidingPreference: SlidingPreference | undefined,
+	oldSlidingPreference: SlidingPreference | undefined = undefined,
+): number | InteriorSequencePlace {
+	return newSlidingPreference === SlidingPreference.BACKWARD ||
+		(newSlidingPreference === undefined && oldSlidingPreference === SlidingPreference.BACKWARD)
+		? {
+				pos,
+				side: Side.After,
+		  }
+		: newSlidingPreference === SlidingPreference.FORWARD &&
+		  oldSlidingPreference === SlidingPreference.BACKWARD
+		? {
+				pos,
+				side: Side.Before,
+		  }
+		: pos; // Avoid setting side if possible since stickiness may not be enabled
+}
+
 function revertLocalDelete(
 	string: SharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.DELETE>,
@@ -418,10 +446,18 @@ function revertLocalDelete(
 	const endSlidePos = getSlidePosition(string, revertible.end, end);
 	// 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)) {
+	if (
+		isValidRange(
+			startSlidePos,
+			revertible.start.slidingPreference,
+			endSlidePos,
+			revertible.end.slidingPreference,
+			string,
+		)
+	) {
 		const int = collection.add({
-			start: startSlidePos,
-			end: endSlidePos,
+			start: createSequencePlace(startSlidePos, revertible.start.slidingPreference),
+			end: createSequencePlace(endSlidePos, revertible.end.slidingPreference),
 			props,
 		});
 
@@ -448,8 +484,30 @@ function revertLocalChange(
 	const startSlidePos = getSlidePosition(string, revertible.start, start);
 	const end = string.localReferencePositionToPosition(revertible.end);
 	const endSlidePos = getSlidePosition(string, revertible.end, end);
-	if (isValidRange(startSlidePos, endSlidePos, string)) {
-		collection.change(id, startSlidePos, endSlidePos);
+	const interval = collection.getIntervalById(id);
+	if (
+		interval !== undefined &&
+		isValidRange(
+			startSlidePos,
+			revertible.start.slidingPreference ?? interval.start.slidingPreference,
+			endSlidePos,
+			revertible.end.slidingPreference ?? interval.end.slidingPreference,
+			string,
+		)
+	) {
+		collection.change(
+			id,
+			createSequencePlace(
+				startSlidePos,
+				revertible.start.slidingPreference,
+				interval.start.slidingPreference,
+			),
+			createSequencePlace(
+				endSlidePos,
+				revertible.end.slidingPreference,
+				interval.end.slidingPreference,
+			),
+		);
 	}
 
 	string.removeLocalReferencePosition(revertible.start);
@@ -537,8 +595,20 @@ function revertLocalSequenceRemove(
 			const end =
 				newEndpointPosition(intervalInfo.endOffset, restoredRanges, sharedString) ??
 				sharedString.localReferencePositionToPosition(interval.end);
-			if (start <= end) {
-				intervalCollection.change(intervalId, start, end);
+			if (
+				isValidRange(
+					start,
+					interval.start.slidingPreference,
+					end,
+					interval.end.slidingPreference,
+					sharedString,
+				)
+			) {
+				intervalCollection.change(
+					intervalId,
+					createSequencePlace(start, interval.start.slidingPreference),
+					createSequencePlace(end, interval.end.slidingPreference),
+				);
 			}
 		}
 	});
@@ -559,6 +629,7 @@ function revertLocalSequenceRemove(
 					pos.offset,
 					ReferenceType.StayOnRemove | ReferenceType.RangeBegin,
 					{ revertible: revertibleRef.revertible },
+					revertibleRef.revertible.start.slidingPreference,
 				);
 				revertibleRef.revertible.start = newRef;
 			} else {
@@ -568,6 +639,7 @@ function revertLocalSequenceRemove(
 					pos.offset,
 					ReferenceType.StayOnRemove | ReferenceType.RangeEnd,
 					{ revertible: revertibleRef.revertible },
+					revertibleRef.revertible.end.slidingPreference,
 				);
 				revertibleRef.revertible.end = newRef;
 			}
@@ -577,8 +649,7 @@ function revertLocalSequenceRemove(
 
 /**
  * Invoke revertibles to reverse prior edits
- *
- * @alpha
+ * @internal
  */
 export function revertSharedStringRevertibles(
 	sharedString: SharedString,

package/src/sequence.ts

@@ -2,6 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+
+/* eslint-disable import/no-deprecated */
+
 import { assert, Deferred } from "@fluidframework/core-utils";
 import { bufferToString } from "@fluid-internal/client-utils";
 import { LoggingError, createChildLogger } from "@fluidframework/telemetry-utils";
@@ -14,7 +17,6 @@ import {
 import {
 	Client,
 	createAnnotateRangeOp,
-	// eslint-disable-next-line import/no-deprecated
 	createGroupOp,
 	createInsertOp,
 	createRemoveRangeOp,
@@ -29,7 +31,6 @@ import {
 	ISegment,
 	ISegmentAction,
 	LocalReferencePosition,
-	// eslint-disable-next-line import/no-deprecated
 	matchProperties,
 	MergeTreeDeltaType,
 	PropertySet,
@@ -97,7 +98,7 @@ const contentPath = "content";
  * - `event` - Various information on the segments that were modified.
  *
  * - `target` - The sequence itself.
- * @public
+ * @alpha
  */
 export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 	(
@@ -115,7 +116,7 @@ export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 }
 
 /**
- * @public
+ * @alpha
  */
 export abstract class SharedSegmentSequence<T extends ISegment>
 	extends SharedObject<ISharedSegmentSequenceEvents>
@@ -136,7 +137,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 *
 	 * An application using SharedString which explicitly wants to opt in to allowing reentrancy anyway can set `sharedStringPreventReentrancy`
 	 * on the data store options to `false`.
-	 * @internal
 	 */
 	protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
 
@@ -153,7 +153,6 @@ 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;
@@ -764,7 +763,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

@@ -3,6 +3,8 @@
  * Licensed under the MIT License.
  */
 
+/* eslint-disable import/no-deprecated */
+
 import { assert } from "@fluidframework/core-utils";
 import {
 	Client,
@@ -23,7 +25,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
+ * @alpha
  */
 export abstract class SequenceEvent<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,
@@ -106,7 +108,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
+ * @alpha
  */
 export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
 	/**
@@ -130,7 +132,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
+ * @alpha
  */
 export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
 	constructor(
@@ -144,7 +146,7 @@ export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenance
 
 /**
  * A range that has changed corresponding to a segment modification.
- * @public
+ * @alpha
  */
 export interface ISequenceDeltaRange<
 	TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes,

package/src/sequenceFactory.ts

@@ -14,7 +14,7 @@ import { pkgVersion } from "./packageVersion";
 import { SharedString, SharedStringSegment } from "./sharedString";
 
 /**
- * @public
+ * @alpha
  */
 export class SharedStringFactory implements IChannelFactory {
 	// TODO rename back to https://graph.microsoft.com/types/mergeTree/string once paparazzi is able to dynamically

package/src/sharedIntervalCollection.ts

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

package/src/sharedSequence.ts

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

package/src/sharedString.ts

@@ -24,7 +24,7 @@ import { SharedStringFactory } from "./sequenceFactory";
 
 /**
  * Fluid object interface describing access methods on a SharedString
- * @public
+ * @alpha
  */
 export interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {
 	/**
@@ -54,7 +54,7 @@ export interface ISharedString extends SharedSegmentSequence<SharedStringSegment
 }
 
 /**
- * @public
+ * @alpha
  */
 export type SharedStringSegment = TextSegment | Marker;
 
@@ -66,8 +66,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.
- *
- * @public
+ * @alpha
  */
 export class SharedString
 	extends SharedSegmentSequence<SharedStringSegment>
@@ -196,6 +195,10 @@ export class SharedString
 	 * @param marker - The marker to annotate
 	 * @param props - The properties to annotate the marker with
 	 * @param consensusCallback - The callback called when consensus is reached
+	 *
+	 * @deprecated We no longer intend to support this functionality and it will
+	 * be removed in a future release. There is no replacement for this
+	 * functionality.
 	 */
 	public annotateMarkerNotifyConsensus(
 		marker: Marker,
@@ -339,7 +342,7 @@ interface ITextAndMarkerAccumulator {
  * // parallelMarkers === [<paragraph marker 1 object>, <paragraph marker 2 object>]
  * // Note parallelText does not include "missing".
  * ```
- * @public
+ * @internal
  */
 export function getTextAndMarkers(
 	sharedString: SharedString,

package/tsconfig.esnext.json

@@ -1,7 +1,6 @@
 {
-	"extends": "./tsconfig.json",
+	"extends": ["./tsconfig.json", "../../../common/build/build-common/tsconfig.esm.json"],
 	"compilerOptions": {
 		"outDir": "./lib",
-		"module": "esnext",
 	},
 }

package/tsconfig.json

@@ -1,10 +1,12 @@
 {
-	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"extends": [
+		"../../../common/build/build-common/tsconfig.base.json",
+		"../../../common/build/build-common/tsconfig.cjs.json",
+	],
+	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./dist",
-		"composite": true,
 	},
-	"include": ["src/**/*"],
 }