@fluidframework/sequence 2.1.1 → 2.2.1

package/src/intervalCollection.ts

@@ -26,6 +26,9 @@ import {
 	getSlideToSegoff,
 	refTypeIncludesFlag,
 	reservedRangeLabelsKey,
+	Side,
+	SequencePlace,
+	endpointPosAndSide,
 } from "@fluidframework/merge-tree/internal";
 import { LoggingError, UsageError } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
@@ -65,58 +68,6 @@ import {
 	startReferenceSlidingPreference,
 } from "./intervals/index.js";
 
-/**
- * Defines a position and side relative to a character in a sequence.
- *
- * For this purpose, sequences look like:
- *
- * `{start} - {character 0} - {character 1} - ... - {character N} - {end}`
- *
- * Each `{value}` in the diagram is a character within a sequence.
- * Each `-` in the above diagram is a position where text could be inserted.
- * Each position between a `{value}` and a `-` is a `SequencePlace`.
- *
- * The special endpoints `{start}` and `{end}` refer to positions outside the
- * contents of the string.
- *
- * This gives us 2N + 2 possible positions to refer to within a string, where N
- * is the number of characters.
- *
- * If the position is specified with a bare number, the side defaults to
- * `Side.Before`.
- *
- * If a SequencePlace is the endpoint of a range (e.g. start/end of an interval or search range),
- * the Side value means it is exclusive if it is nearer to the other position and inclusive if it is farther.
- * E.g. the start of a range with Side.After is exclusive of the character at the position.
- * @legacy
- * @alpha
- */
-export type SequencePlace = number | "start" | "end" | InteriorSequencePlace;
-
-/**
- * A sequence place that does not refer to the special endpoint segments.
- *
- * See {@link SequencePlace} for additional context.
- * @legacy
- * @alpha
- */
-export interface InteriorSequencePlace {
-	pos: number;
-	side: Side;
-}
-
-/**
- * Defines a side relative to a character in a sequence.
- *
- * @remarks See {@link SequencePlace} for additional context on usage.
- * @legacy
- * @alpha
- */
-export enum Side {
-	Before = 0,
-	After = 1,
-}
-
 export const reservedIntervalIdKey = "intervalId";
 
 export interface ISerializedIntervalCollectionV2 {
@@ -179,28 +130,6 @@ function compressInterval(interval: ISerializedInterval): CompressedSerializedIn
 	return base;
 }
 
-export function endpointPosAndSide(
-	start: SequencePlace | undefined,
-	end: SequencePlace | undefined,
-) {
-	const startIsPlainEndpoint =
-		typeof start === "number" || start === "start" || start === "end";
-	const endIsPlainEndpoint = typeof end === "number" || end === "start" || end === "end";
-
-	const startSide = startIsPlainEndpoint ? Side.Before : start?.side;
-	const endSide = endIsPlainEndpoint ? Side.Before : end?.side;
-
-	const startPos = startIsPlainEndpoint ? start : start?.pos;
-	const endPos = endIsPlainEndpoint ? end : end?.pos;
-
-	return {
-		startSide,
-		endSide,
-		startPos,
-		endPos,
-	};
-}
-
 export function toSequencePlace(
 	pos: number | "start" | "end",
 	side: Side | undefined,
@@ -375,7 +304,7 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
 						"Adding an interval that belongs to another interval collection is not permitted",
 					);
 				}
-				interval.addProperties(props);
+				interval.properties = addProperties(interval.properties, props);
 			}
 			interval.properties[reservedIntervalIdKey] ??= uuid();
 			this.add(interval);
@@ -816,7 +745,7 @@ export interface IIntervalCollection<TInterval extends ISerializableInterval>
 	 * it is possible to control whether the interval expands to include content
 	 * inserted at its start or end.
 	 *
-	 *	See {@link SequencePlace} for more details on the model.
+	 *	See {@link @fluidframework/merge-tree#SequencePlace} for more details on the model.
 	 *
 	 *	@example
 	 *
@@ -1189,7 +1118,7 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
 					this.options.mergeTreeReferencesCanSlideToEndpoint,
 				);
 				if (properties) {
-					interval.addProperties(properties);
+					interval.properties = addProperties(interval.properties, properties);
 				}
 				this.localCollection.add(interval);
 			}

package/src/intervalCollectionMapInterfaces.ts

@@ -71,10 +71,10 @@ export interface SequenceOptions
 	> {
 	/**
 	 * Enable the ability to use interval APIs that rely on positions before and
-	 * after individual characters, referred to as "sides". See {@link SequencePlace}
+	 * after individual characters, referred to as "sides". See {@link @fluidframework/merge-tree#SequencePlace}
 	 * for additional context.
 	 *
-	 * This flag must be enabled to pass instances of {@link SequencePlace} to
+	 * This flag must be enabled to pass instances of {@link @fluidframework/merge-tree#SequencePlace} to
 	 * any IIntervalCollection API.
 	 *
 	 * Also see the feature flag `mergeTreeReferencesCanSlideToEndpoint` to allow

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -5,9 +5,12 @@
 
 /* eslint-disable import/no-deprecated */
 
-import { Client } from "@fluidframework/merge-tree/internal";
+import {
+	Client,
+	SequencePlace,
+	endpointPosAndSide,
+} from "@fluidframework/merge-tree/internal";
 
-import { SequencePlace, endpointPosAndSide } from "../intervalCollection.js";
 import { IntervalNode, IntervalTree } from "../intervalTree.js";
 import {
 	IIntervalHelpers,

package/src/intervals/interval.ts

@@ -12,10 +12,12 @@ import {
 	PropertySet,
 	createMap,
 	reservedRangeLabelsKey,
+	SequencePlace,
+	addProperties,
 } from "@fluidframework/merge-tree/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
-import { SequencePlace, reservedIntervalIdKey } from "../intervalCollection.js";
+import { reservedIntervalIdKey } from "../intervalCollection.js";
 
 import {
 	IIntervalHelpers,
@@ -47,7 +49,7 @@ export class Interval implements ISerializableInterval {
 		props?: PropertySet,
 	) {
 		if (props) {
-			this.addProperties(props);
+			this.properties = addProperties(this.properties, props);
 		}
 	}
 
@@ -93,7 +95,10 @@ export class Interval implements ISerializableInterval {
 			start: this.start,
 		};
 		if (this.properties) {
-			serializedInterval.properties = { ...this.properties };
+			serializedInterval.properties = addProperties(
+				serializedInterval.properties,
+				this.properties,
+			);
 		}
 		return serializedInterval;
 	}

package/src/intervals/intervalUtils.ts

@@ -9,13 +9,14 @@ import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/in
 import {
 	// eslint-disable-next-line import/no-deprecated
 	Client,
+	// eslint-disable-next-line import/no-deprecated
 	PropertiesManager,
 	PropertySet,
 	SlidingPreference,
+	SequencePlace,
+	Side,
 } from "@fluidframework/merge-tree/internal";
 
-import { SequencePlace, Side } from "../intervalCollection.js";
-
 /**
  * Basic interval abstraction
  * @legacy
@@ -159,11 +160,16 @@ export interface ISerializedInterval {
 export interface ISerializableInterval extends IInterval {
 	/** Serializable bag of properties associated with the interval. */
 	properties: PropertySet;
-	/***/
+	/**
+	 * @deprecated - This property should not be used externally and will be removed in a subsequent release.
+	 */
+	// eslint-disable-next-line import/no-deprecated
 	propertyManager: PropertiesManager;
 	/***/
 	serialize(): ISerializedInterval;
-	/***/
+	/**
+	 * @deprecated - This function should not be used externally and will be removed in a subsequent release.
+	 */
 	addProperties(
 		props: PropertySet,
 		collaborating?: boolean,
@@ -235,9 +241,9 @@ export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
 	 * @param op - If this create came from a remote client, op that created it. Default is undefined (i.e. local)
 	 * @param fromSnapshot - If this create came from loading a snapshot. Default is false.
 	 * @param startSide - The side on which the start position lays. See
-	 * {@link SequencePlace} for additional context
+	 * {@link @fluidframework/merge-tree#SequencePlace} for additional context
 	 * @param endSide - The side on which the end position lays. See
-	 * {@link SequencePlace} for additional context
+	 * {@link @fluidframework/merge-tree#SequencePlace} for additional context
 	 */
 	create(
 		label: string,

package/src/intervals/sequenceInterval.ts

@@ -24,14 +24,15 @@ import {
 	minReferencePosition,
 	refTypeIncludesFlag,
 	reservedRangeLabelsKey,
+	SequencePlace,
+	Side,
+	endpointPosAndSide,
+	addProperties,
 } from "@fluidframework/merge-tree/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 import {
-	SequencePlace,
-	Side,
 	computeStickinessFromSide,
-	endpointPosAndSide,
 	reservedIntervalIdKey,
 	sidesFromStickiness,
 } from "../intervalCollection.js";
@@ -144,7 +145,7 @@ export class SequenceInterval implements ISerializableInterval {
 		public readonly endSide: Side = Side.Before,
 	) {
 		if (props) {
-			this.addProperties(props);
+			this.properties = addProperties(this.properties, props);
 		}
 	}
 
@@ -199,7 +200,10 @@ export class SequenceInterval implements ISerializableInterval {
 		};
 
 		if (this.properties) {
-			serializedInterval.properties = { ...this.properties };
+			serializedInterval.properties = addProperties(
+				serializedInterval.properties,
+				this.properties,
+			);
 		}
 
 		return serializedInterval;

package/src/packageVersion.ts

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

package/src/revertibles.ts

@@ -21,9 +21,10 @@ import {
 	isMergeTreeDeltaRevertible,
 	refTypeIncludesFlag,
 	revertMergeTreeDeltaRevertibles,
+	InteriorSequencePlace,
+	Side,
 } from "@fluidframework/merge-tree/internal";
 
-import { InteriorSequencePlace, Side } from "./intervalCollection.js";
 import { IntervalOpType, SequenceInterval } from "./intervals/index.js";
 import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
 import { ISharedString, SharedStringSegment } from "./sharedString.js";

package/src/sharedSequence.ts

@@ -39,19 +39,18 @@ export class SubSequence<T> extends BaseSegment {
 	}
 	public static fromJSONObject<U>(spec: any) {
 		if (spec && typeof spec === "object" && "items" in spec) {
-			const segment = new SubSequence<U>(spec.items);
-			if (spec.props) {
-				segment.addProperties(spec.props);
-			}
-			return segment;
+			return new SubSequence<U>(spec.items, spec.props);
 		}
 		return undefined;
 	}
 
 	public readonly type = SubSequence.typeString;
 
-	constructor(public items: Serializable<T>[]) {
-		super();
+	constructor(
+		public items: Serializable<T>[],
+		props?: PropertySet,
+	) {
+		super(props);
 		this.cachedLength = items.length;
 	}
 
@@ -135,10 +134,7 @@ export class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
 	 * @param props - Optional. Properties to set on the inserted items.
 	 */
 	public insert(pos: number, items: Serializable<T>[], props?: PropertySet) {
-		const segment = new SubSequence<T>(items);
-		if (props) {
-			segment.addProperties(props);
-		}
+		const segment = new SubSequence<T>(items, props);
 		this.client.insertSegmentLocal(pos, segment);
 	}
 

package/src/sharedString.ts

@@ -170,25 +170,19 @@ export class SharedStringClass
 		refType: ReferenceType,
 		props?: PropertySet,
 	): void {
-		const segment = new Marker(refType);
-		if (props) {
-			segment.addProperties(props);
-		}
-
 		const pos = this.posFromRelativePos(relativePos1);
-		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
+		this.guardReentrancy(() =>
+			this.client.insertSegmentLocal(pos, Marker.make(refType, props)),
+		);
 	}
 
 	/**
 	 * {@inheritDoc ISharedString.insertMarker}
 	 */
 	public insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): void {
-		const segment = new Marker(refType);
-		if (props) {
-			segment.addProperties(props);
-		}
-
-		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
+		this.guardReentrancy(() =>
+			this.client.insertSegmentLocal(pos, Marker.make(refType, props)),
+		);
 	}
 
 	/**
@@ -199,25 +193,19 @@ export class SharedStringClass
 		text: string,
 		props?: PropertySet,
 	): void {
-		const segment = new TextSegment(text);
-		if (props) {
-			segment.addProperties(props);
-		}
-
 		const pos = this.posFromRelativePos(relativePos1);
-		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
+		this.guardReentrancy(() =>
+			this.client.insertSegmentLocal(pos, TextSegment.make(text, props)),
+		);
 	}
 
 	/**
 	 * {@inheritDoc ISharedString.insertText}
 	 */
 	public insertText(pos: number, text: string, props?: PropertySet): void {
-		const segment = new TextSegment(text);
-		if (props) {
-			segment.addProperties(props);
-		}
-
-		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
+		this.guardReentrancy(() =>
+			this.client.insertSegmentLocal(pos, TextSegment.make(text, props)),
+		);
 	}
 
 	/**