@fluidframework/sequence 2.0.0-rc.3.0.3 → 2.0.0-rc.4.0.0

package/src/sharedString.ts

@@ -42,9 +42,79 @@ export interface ISharedString extends SharedSegmentSequence<SharedStringSegment
 	insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): void;
 
 	/**
-	 * {@inheritDoc SharedSegmentSequence.posFromRelativePos}
+	 * Inserts a marker at a relative position.
+	 * @param relativePos1 - The relative position to insert the marker at
+	 * @param refType - The reference type of the marker
+	 * @param props - The properties of the marker
+	 */
+	insertMarkerRelative(
+		relativePos1: IRelativePosition,
+		refType: ReferenceType,
+		props?: PropertySet,
+	): void;
+
+	/**
+	 * Inserts the text at the position.
+	 * @param relativePos1 - The relative position to insert the text at
+	 * @param text - The text to insert
+	 * @param props - The properties of text
+	 */
+	insertTextRelative(relativePos1: IRelativePosition, text: string, props?: PropertySet): void;
+
+	/**
+	 * Replaces a range with the provided text.
+	 * @param start - The inclusive start of the range to replace
+	 * @param end - The exclusive end of the range to replace
+	 * @param text - The text to replace the range with
+	 * @param props - Optional. The properties of the replacement text
+	 */
+	replaceText(start: number, end: number, text: string, props?: PropertySet): void;
+
+	/**
+	 * Removes the text in the given range.
+	 * @param start - The inclusive start of the range to remove
+	 * @param end - The exclusive end of the range to replace
+	 * @returns the message sent.
+	 */
+	removeText(start: number, end: number): void;
+
+	/**
+	 * Annotates the marker with the provided properties.
+	 * @param marker - The marker to annotate
+	 * @param props - The properties to annotate the marker with
+	 */
+	annotateMarker(marker: Marker, props: PropertySet): void;
+
+	/**
+	 * Searches a string for the nearest marker in either direction to a given start position.
+	 * The search will include the start position, so markers at the start position are valid
+	 * results of the search.
+	 * @param startPos - Position at which to start the search
+	 * @param markerLabel - Label of the marker to search for
+	 * @param forwards - Whether the desired marker comes before (false) or after (true) `startPos`. Default true.
+	 */
+	searchForMarker(startPos: number, markerLabel: string, forwards?: boolean): Marker | undefined;
+
+	/**
+	 * Retrieve text from the SharedString in string format.
+	 * @param start - The starting index of the text to retrieve, or 0 if omitted.
+	 * @param end - The ending index of the text to retrieve, or the end of the string if omitted
+	 * @returns The requested text content as a string.
+	 */
+	getText(start?: number, end?: number): string;
+
+	/**
+	 * Adds spaces for markers and handles, so that position calculations account for them.
 	 */
-	posFromRelativePos(relativePos: IRelativePosition): number;
+	getTextWithPlaceholders(start?: number, end?: number): string;
+
+	getTextRangeWithMarkers(start: number, end: number): string;
+
+	/**
+	 * Looks up and returns a `Marker` using its id. Returns `undefined` if there is no marker with the provided
+	 * id in this `SharedString`.
+	 */
+	getMarkerFromId(id: string): ISegment | undefined;
 }
 
 /**
@@ -62,28 +132,10 @@ export type SharedStringSegment = TextSegment | Marker;
  * image or Fluid object that should be rendered with the text.
  * @alpha
  */
-export class SharedString
+export class SharedStringClass
 	extends SharedSegmentSequence<SharedStringSegment>
 	implements ISharedString
 {
-	/**
-	 * Create a new shared string.
-	 * @param runtime - data store runtime the new shared string belongs to
-	 * @param id - optional name of the shared string
-	 * @returns newly create shared string (but not attached yet)
-	 */
-	public static create(runtime: IFluidDataStoreRuntime, id?: string) {
-		return runtime.createChannel(id, SharedStringFactory.Type) as SharedString;
-	}
-
-	/**
-	 * Get a factory for SharedString to register with the data store.
-	 * @returns a factory that creates and load SharedString
-	 */
-	public static getFactory() {
-		return new SharedStringFactory();
-	}
-
 	public get ISharedString(): ISharedString {
 		return this;
 	}
@@ -101,10 +153,7 @@ export class SharedString
 	}
 
 	/**
-	 * Inserts a marker at a relative position.
-	 * @param relativePos1 - The relative position to insert the marker at
-	 * @param refType - The reference type of the marker
-	 * @param props - The properties of the marker
+	 * {@inheritDoc ISharedString.insertMarkerRelative}
 	 */
 	public insertMarkerRelative(
 		relativePos1: IRelativePosition,
@@ -133,10 +182,7 @@ export class SharedString
 	}
 
 	/**
-	 * Inserts the text at the position.
-	 * @param relativePos1 - The relative position to insert the text at
-	 * @param text - The text to insert
-	 * @param props - The properties of text
+	 * {@inheritDoc ISharedString.insertTextRelative}
 	 */
 	public insertTextRelative(
 		relativePos1: IRelativePosition,
@@ -165,42 +211,28 @@ export class SharedString
 	}
 
 	/**
-	 * Replaces a range with the provided text.
-	 * @param start - The inclusive start of the range to replace
-	 * @param end - The exclusive end of the range to replace
-	 * @param text - The text to replace the range with
-	 * @param props - Optional. The properties of the replacement text
+	 * {@inheritDoc ISharedString.replaceText}
 	 */
 	public replaceText(start: number, end: number, text: string, props?: PropertySet): void {
 		this.replaceRange(start, end, TextSegment.make(text, props));
 	}
 
 	/**
-	 * Removes the text in the given range.
-	 * @param start - The inclusive start of the range to remove
-	 * @param end - The exclusive end of the range to replace
-	 * @returns the message sent.
+	 * {@inheritDoc ISharedString.removeText}
 	 */
 	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
+	 * {@inheritDoc ISharedString.annotateMarker}
 	 */
-	public annotateMarker(marker: Marker, props: PropertySet) {
+	public annotateMarker(marker: Marker, props: PropertySet): void {
 		this.guardReentrancy(() => this.client.annotateMarker(marker, props));
 	}
 
 	/**
-	 * Searches a string for the nearest marker in either direction to a given start position.
-	 * The search will include the start position, so markers at the start position are valid
-	 * results of the search.
-	 * @param startPos - Position at which to start the search
-	 * @param markerLabel - Label of the marker to search for
-	 * @param forwards - Whether the desired marker comes before (false) or after (true) `startPos`
+	 * {@inheritDoc ISharedString.searchForMarker}
 	 */
 	public searchForMarker(
 		startPos: number,
@@ -211,10 +243,7 @@ export class SharedString
 	}
 
 	/**
-	 * Retrieve text from the SharedString in string format.
-	 * @param start - The starting index of the text to retrieve, or 0 if omitted.
-	 * @param end - The ending index of the text to retrieve, or the end of the string if omitted
-	 * @returns The requested text content as a string.
+	 * {@inheritDoc ISharedString.getText}
 	 */
 	public getText(start?: number, end?: number) {
 		const segmentWindow = this.client.getCollabWindow();
@@ -228,7 +257,7 @@ export class SharedString
 	}
 
 	/**
-	 * Adds spaces for markers and handles, so that position calculations account for them.
+	 * {@inheritDoc ISharedString.getTextWithPlaceholders}
 	 */
 	public getTextWithPlaceholders(start?: number, end?: number) {
 		const segmentWindow = this.client.getCollabWindow();
@@ -241,6 +270,9 @@ export class SharedString
 		);
 	}
 
+	/**
+	 * {@inheritDoc ISharedString.getTextRangeWithMarkers}
+	 */
 	public getTextRangeWithMarkers(start: number, end: number) {
 		const segmentWindow = this.client.getCollabWindow();
 		return this.mergeTreeTextHelper.getText(
@@ -253,8 +285,7 @@ export class SharedString
 	}
 
 	/**
-	 * Looks up and returns a `Marker` using its id. Returns `undefined` if there is no marker with the provided
-	 * id in this `SharedString`.
+	 * {@inheritDoc ISharedString.getMarkerFromId}
 	 */
 	public getMarkerFromId(id: string): ISegment | undefined {
 		return this.client.getMarkerFromId(id);
@@ -297,7 +328,7 @@ interface ITextAndMarkerAccumulator {
  * @internal
  */
 export function getTextAndMarkers(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	label: string,
 	start?: number,
 	end?: number,