@fluidframework/sequence 2.0.0-internal.4.4.0 → 2.0.0-internal.5.0.0

package/src/index.ts

@@ -23,8 +23,6 @@ export {
 	Interval,
 	IntervalIndex,
 	IIntervalCollection,
-	IntervalCollection,
-	IntervalCollectionIterator,
 	IntervalLocator,
 	intervalLocatorFromEndpoint,
 	IntervalOpType,
@@ -32,8 +30,6 @@ export {
 	ISerializableInterval,
 	ISerializedInterval,
 	SequenceInterval,
-	ISerializedIntervalCollectionV2,
-	CompressedSerializedInterval,
 	SerializedIntervalDelta,
 	IntervalStickiness,
 } from "./intervalCollection";

package/src/intervalCollection.ts

@@ -117,17 +117,11 @@ export type SerializedIntervalDelta = Omit<ISerializedInterval, "start" | "end"
  * Intervals are of the format:
  *
  * [start, end, sequenceNumber, intervalType, properties, stickiness?]
- *
- * @deprecated - Public export was never intended and will be removed.
  */
 export type CompressedSerializedInterval =
 	| [number, number, number, IntervalType, PropertySet, IntervalStickiness]
 	| [number, number, number, IntervalType, PropertySet];
 
-/**
- * @internal
- * @deprecated - Public export will be removed.
- */
 export interface ISerializedIntervalCollectionV2 {
 	label: string;
 	version: 2;
@@ -322,7 +316,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 `IntervalCollection<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.
 	 */
@@ -1558,11 +1552,7 @@ export function makeOpsMap<T extends ISerializableInterval>(): Map<
 
 export type DeserializeCallback = (properties: PropertySet) => void;
 
-/**
- * @deprecated - Public export will be removed. Use an appropriate iterator creation method on
- * {@link IIntervalCollection} to iterate intervals instead.
- */
-export class IntervalCollectionIterator<TInterval extends ISerializableInterval>
+class IntervalCollectionIterator<TInterval extends ISerializableInterval>
 	implements Iterator<TInterval>
 {
 	private readonly results: TInterval[];
@@ -1655,10 +1645,7 @@ export interface IIntervalCollectionEvent<TInterval extends ISerializableInterva
 
 /**
  * Collection of intervals that supports addition, modification, removal, and efficient spatial querying.
- * This class is not a DDS in its own right, but emits events on mutating operations such that it's possible to
- * integrate into a DDS.
- * This aligns with its usage in `SharedSegmentSequence`, which allows associating intervals to positions in the
- * sequence DDS which are broadcast to all other clients in an eventually consistent fashion.
+ * Changes to this collection will be incur updates on collaborating clients (i.e. they are not local-only).
  */
 export interface IIntervalCollection<TInterval extends ISerializableInterval>
 	extends TypedEventEmitter<IIntervalCollectionEvent<TInterval>> {
@@ -1691,11 +1678,18 @@ export interface IIntervalCollection<TInterval extends ISerializableInterval>
 	 * @param end - interval end position (exclusive)
 	 * @param intervalType - type of the interval. All intervals are SlideOnRemove. Intervals may not be Transient.
 	 * @param props - properties of the interval
+	 * @param stickiness - {@link (IntervalStickiness:type)} to apply to the added interval.
 	 * @returns - the created interval
 	 * @remarks - See documentation on {@link SequenceInterval} for comments on interval endpoint semantics: there are subtleties
 	 * with how the current half-open behavior is represented.
 	 */
-	add(start: number, end: number, intervalType: IntervalType, props?: PropertySet): TInterval;
+	add(
+		start: number,
+		end: number,
+		intervalType: IntervalType,
+		props?: PropertySet,
+		stickiness?: IntervalStickiness,
+	): TInterval;
 	/**
 	 * Removes an interval from the collection.
 	 * @param id - Id of the interval to remove
@@ -1776,7 +1770,7 @@ export interface IIntervalCollection<TInterval extends ISerializableInterval>
 }
 
 /**
- * @deprecated - Use {@link IIntervalCollection} instead.
+ * {@inheritdoc IIntervalCollection}
  */
 export class IntervalCollection<TInterval extends ISerializableInterval>
 	extends TypedEventEmitter<IIntervalCollectionEvent<TInterval>>

package/src/packageVersion.ts

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

package/src/revertibles.ts

@@ -284,7 +284,7 @@ export function appendSharedStringDeltaToRevertibles(
 
 		if (startIntervals.length > 0 || endIntervals.length > 0 || revertibleRefs.length > 0) {
 			const removeRevertibles: MergeTreeDeltaRevertible[] = [];
-			appendToMergeTreeDeltaRevertibles(string, delta.deltaArgs, removeRevertibles);
+			appendToMergeTreeDeltaRevertibles(delta.deltaArgs, removeRevertibles);
 			assert(
 				removeRevertibles.length === 1,
 				0x6c4 /* Remove revertible should be a single delta */,
@@ -337,7 +337,7 @@ export function appendSharedStringDeltaToRevertibles(
 	if (revertibles.length > 0 && isMergeTreeDeltaRevertible(revertibles[revertibles.length - 1])) {
 		mergeTreeRevertibles.push(revertibles.pop() as MergeTreeDeltaRevertible);
 	}
-	appendToMergeTreeDeltaRevertibles(string, delta.deltaArgs, mergeTreeRevertibles);
+	appendToMergeTreeDeltaRevertibles(delta.deltaArgs, mergeTreeRevertibles);
 	revertibles.push(...mergeTreeRevertibles);
 }
 

package/src/sequence.ts

@@ -52,6 +52,7 @@ import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtim
 import { DefaultMap, IMapOperation } from "./defaultMap";
 import { IMapMessageLocalMetadata, IValueChanged } from "./defaultMapInterfaces";
 import {
+	IIntervalCollection,
 	IntervalCollection,
 	SequenceInterval,
 	SequenceIntervalCollectionValueType,
@@ -451,7 +452,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * Retrieves the interval collection keyed on `label`. If no such interval collection exists,
 	 * creates one.
 	 */
-	public getIntervalCollection(label: string): IntervalCollection<SequenceInterval> {
+	public getIntervalCollection(label: string): IIntervalCollection<SequenceInterval> {
 		return this.intervalCollections.get(label);
 	}
 

package/src/sharedIntervalCollection.ts

@@ -21,6 +21,7 @@ import {
 import {
 	Interval,
 	IntervalCollection,
+	IIntervalCollection,
 	IntervalCollectionValueType,
 	ISerializableInterval,
 } from "./intervalCollection";
@@ -75,7 +76,7 @@ export class SharedIntervalCollectionFactory implements IChannelFactory {
 }
 
 export interface ISharedIntervalCollection<TInterval extends ISerializableInterval> {
-	getIntervalCollection(label: string): IntervalCollection<TInterval>;
+	getIntervalCollection(label: string): IIntervalCollection<TInterval>;
 }
 
 /**
@@ -126,7 +127,7 @@ export class SharedIntervalCollection
 		);
 	}
 
-	public getIntervalCollection(label: string): IntervalCollection<Interval> {
+	public getIntervalCollection(label: string): IIntervalCollection<Interval> {
 		const realLabel = this.getIntervalCollectionPath(label);
 		const sharedCollection = this.intervalCollections.get(realLabel);
 		return sharedCollection;