@fluidframework/sequence 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/src/sequenceDeltaEvent.ts

@@ -3,10 +3,9 @@
  * Licensed under the MIT License.
  */
 
-/* eslint-disable import/no-deprecated */
-
 import { assert } from "@fluidframework/core-utils";
 import {
+	// eslint-disable-next-line import/no-deprecated
 	Client,
 	IMergeTreeDeltaCallbackArgs,
 	IMergeTreeDeltaOpArgs,
@@ -16,6 +15,7 @@ import {
 	MergeTreeDeltaOperationTypes,
 	MergeTreeMaintenanceType,
 	PropertySet,
+	// eslint-disable-next-line import/no-deprecated
 	SortedSegmentSet,
 } from "@fluidframework/merge-tree";
 
@@ -25,18 +25,20 @@ 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,
 > {
 	public readonly deltaOperation: TOperation;
+	// eslint-disable-next-line import/no-deprecated
 	private readonly sortedRanges: Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>;
 	private readonly pFirst: Lazy<ISequenceDeltaRange<TOperation>>;
 	private readonly pLast: Lazy<ISequenceDeltaRange<TOperation>>;
 
 	constructor(
 		public readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>,
+		// eslint-disable-next-line import/no-deprecated
 		private readonly mergeTreeClient: Client,
 	) {
 		assert(
@@ -45,7 +47,9 @@ export abstract class SequenceEvent<
 		);
 		this.deltaOperation = deltaArgs.operation;
 
+		// eslint-disable-next-line import/no-deprecated
 		this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(() => {
+			// eslint-disable-next-line import/no-deprecated
 			const set = new SortedSegmentSet<ISequenceDeltaRange<TOperation>>();
 			this.deltaArgs.deltaSegments.forEach((delta) => {
 				const newRange: ISequenceDeltaRange<TOperation> = {
@@ -108,7 +112,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> {
 	/**
@@ -119,6 +123,7 @@ export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationTyp
 	constructor(
 		public readonly opArgs: IMergeTreeDeltaOpArgs,
 		deltaArgs: IMergeTreeDeltaCallbackArgs,
+		// eslint-disable-next-line import/no-deprecated
 		mergeTreeClient: Client,
 	) {
 		super(deltaArgs, mergeTreeClient);
@@ -132,12 +137,13 @@ 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(
 		public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,
 		deltaArgs: IMergeTreeMaintenanceCallbackArgs,
+		// eslint-disable-next-line import/no-deprecated
 		mergeTreeClient: Client,
 	) {
 		super(deltaArgs, mergeTreeClient);
@@ -146,7 +152,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,14 +24,14 @@ 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";
 	public static is(segment: ISegment): segment is SubSequence<any> {
 		return segment.type === SubSequence.typeString;
 	}
-	public static fromJSONObject<U>(spec: Serializable) {
+	public static fromJSONObject<U>(spec: any) {
 		if (spec && typeof spec === "object" && "items" in spec) {
 			const segment = new SubSequence<U>(spec.items);
 			if (spec.props) {
@@ -76,7 +76,10 @@ export class SubSequence<T> extends BaseSegment {
 	public append(segment: ISegment) {
 		assert(SubSequence.is(segment), 0x448 /* can only append to another run segment */);
 		super.append(segment);
-		this.items = this.items.concat(segment.items);
+		// assert above checks that segment is a SubSequence but not that generic T matches.
+		// Since SubSequence is already deprecated, assume that usage is generic T consistent
+		// and just cast here to satisfy concat.
+		this.items = this.items.concat((segment as SubSequence<T>).items);
 	}
 
 	// TODO: retain removed items for undo
@@ -108,7 +111,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(
@@ -169,7 +172,10 @@ export class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
 					if (firstSegment === undefined) {
 						firstSegment = segment;
 					}
-					items.push(...segment.items);
+					// Condition above checks that segment is a SubSequence but not that
+					// generic T matches. Since SubSequence is already deprecated, assume
+					// that walk only has SubSequence<T> segments and just cast here.
+					items.push(...(segment as SubSequence<T>).items);
 				}
 				return true;
 			},

package/src/sharedString.ts

@@ -4,9 +4,6 @@
  */
 
 import {
-	ICombiningOp,
-	IMergeTreeInsertMsg,
-	IMergeTreeRemoveMsg,
 	IMergeTreeTextHelper,
 	IRelativePosition,
 	ISegment,
@@ -24,7 +21,7 @@ import { SharedStringFactory } from "./sequenceFactory";
 
 /**
  * Fluid object interface describing access methods on a SharedString
- * @public
+ * @alpha
  */
 export interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {
 	/**
@@ -41,11 +38,7 @@ export interface ISharedString extends SharedSegmentSequence<SharedStringSegment
 	 * @param refType - The reference type of the marker
 	 * @param props - The properties of the marker
 	 */
-	insertMarker(
-		pos: number,
-		refType: ReferenceType,
-		props?: PropertySet,
-	): IMergeTreeInsertMsg | undefined;
+	insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): void;
 
 	/**
 	 * {@inheritDoc SharedSegmentSequence.posFromRelativePos}
@@ -54,7 +47,7 @@ export interface ISharedString extends SharedSegmentSequence<SharedStringSegment
 }
 
 /**
- * @public
+ * @alpha
  */
 export type SharedStringSegment = TextSegment | Marker;
 
@@ -66,8 +59,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>
@@ -116,7 +108,7 @@ export class SharedString
 		relativePos1: IRelativePosition,
 		refType: ReferenceType,
 		props?: PropertySet,
-	) {
+	): void {
 		const segment = new Marker(refType);
 		if (props) {
 			segment.addProperties(props);
@@ -129,17 +121,13 @@ export class SharedString
 	/**
 	 * {@inheritDoc ISharedString.insertMarker}
 	 */
-	public insertMarker(
-		pos: number,
-		refType: ReferenceType,
-		props?: PropertySet,
-	): IMergeTreeInsertMsg | undefined {
+	public insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): void {
 		const segment = new Marker(refType);
 		if (props) {
 			segment.addProperties(props);
 		}
 
-		return this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
+		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
 	/**
@@ -148,7 +136,11 @@ export class SharedString
 	 * @param text - The text to insert
 	 * @param props - The properties of text
 	 */
-	public insertTextRelative(relativePos1: IRelativePosition, text: string, props?: PropertySet) {
+	public insertTextRelative(
+		relativePos1: IRelativePosition,
+		text: string,
+		props?: PropertySet,
+	): void {
 		const segment = new TextSegment(text);
 		if (props) {
 			segment.addProperties(props);
@@ -161,7 +153,7 @@ export class SharedString
 	/**
 	 * {@inheritDoc ISharedString.insertText}
 	 */
-	public insertText(pos: number, text: string, props?: PropertySet) {
+	public insertText(pos: number, text: string, props?: PropertySet): void {
 		const segment = new TextSegment(text);
 		if (props) {
 			segment.addProperties(props);
@@ -177,7 +169,7 @@ export class SharedString
 	 * @param text - The text to replace the range with
 	 * @param props - Optional. The properties of the replacement text
 	 */
-	public replaceText(start: number, end: number, text: string, props?: PropertySet) {
+	public replaceText(start: number, end: number, text: string, props?: PropertySet): void {
 		this.replaceRange(start, end, TextSegment.make(text, props));
 	}
 
@@ -187,34 +179,17 @@ export class SharedString
 	 * @param end - The exclusive end of the range to replace
 	 * @returns the message sent.
 	 */
-	public removeText(start: number, end: number): IMergeTreeRemoveMsg {
-		return this.removeRange(start, end);
-	}
-
-	/**
-	 * Annotates the marker with the provided properties and calls the callback on consensus.
-	 * @param marker - The marker to annotate
-	 * @param props - The properties to annotate the marker with
-	 * @param consensusCallback - The callback called when consensus is reached
-	 */
-	public annotateMarkerNotifyConsensus(
-		marker: Marker,
-		props: PropertySet,
-		callback: (m: Marker) => void,
-	) {
-		this.guardReentrancy(() =>
-			this.client.annotateMarkerNotifyConsensus(marker, props, callback),
-		);
+	public removeText(start: number, end: number): void {
+		this.removeRange(start, end);
 	}
 
 	/**
 	 * Annotates the marker with the provided properties.
 	 * @param marker - The marker to annotate
 	 * @param props - The properties to annotate the marker with
-	 * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.
 	 */
-	public annotateMarker(marker: Marker, props: PropertySet, combiningOp?: ICombiningOp) {
-		this.guardReentrancy(() => this.client.annotateMarker(marker, props, combiningOp));
+	public annotateMarker(marker: Marker, props: PropertySet) {
+		this.guardReentrancy(() => this.client.annotateMarker(marker, props));
 	}
 
 	/**
@@ -339,7 +314,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,
@@ -427,10 +402,8 @@ const gatherTextAndMarkers: ISegmentAction<ITextAndMarkerAccumulator> = (
 	} else {
 		if (placeholder && placeholder.length > 0) {
 			const placeholderText =
-				placeholder === "*"
-					? // eslint-disable-next-line @typescript-eslint/no-base-to-string
-					  `\n${segment.toString()}`
-					: placeholder.repeat(segment.cachedLength);
+				// eslint-disable-next-line @typescript-eslint/no-base-to-string
+				placeholder === "*" ? `\n${segment}` : placeholder.repeat(segment.cachedLength);
 			textSegment.text += placeholderText;
 		} else {
 			const marker = segment as Marker;

package/tsconfig.json

@@ -8,5 +8,6 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./dist",
+		"noImplicitAny": true,
 	},
 }