@fluidframework/sequence 2.10.0-307399 → 2.11.0

package/src/sequence.ts

@@ -46,7 +46,9 @@ import {
 	createObliterateRangeOp,
 	createRemoveRangeOp,
 	matchProperties,
+	type AdjustParams,
 	type InteriorSequencePlace,
+	type MapLike,
 } from "@fluidframework/merge-tree/internal";
 import {
 	ISummaryTreeWithStats,
@@ -300,6 +302,21 @@ export interface ISharedSegmentSequence<T extends ISegment>
 	 */
 	annotateRange(start: number, end: number, props: PropertySet): void;
 
+	/**
+	 * Annotates a specified range within the sequence by applying the provided adjustments.
+	 *
+	 * @param start - The inclusive start position of the range to annotate. This is a zero-based index.
+	 * @param end - The exclusive end position of the range to annotate. This is a zero-based index.
+	 * @param adjust - A map-like object specifying the properties to adjust. Each key-value pair represents a property and its corresponding adjustment to be applied over the range.
+	 * An adjustment is defined by an object containing a `delta` to be added to the current property value, and optional `min` and `max` constraints to limit the adjusted value.
+	 *
+	 * @remarks
+	 * The range is defined by the start and end positions, where the start position is inclusive and the end position is exclusive.
+	 * The properties provided in the adjust parameter will be applied to the specified range. Each adjustment modifies the current value of the property by adding the specified `value`.
+	 * If the current value is not a number, the `delta` will be summed with 0 to compute the new value. The optional `min` and `max` constraints are applied after the adjustment to ensure the final value falls within the specified bounds.
+	 */
+	annotateAdjustRange(start: number, end: number, adjust: MapLike<AdjustParams>): void;
+
 	/**
 	 * @param start - The inclusive start of the range to remove
 	 * @param end - The exclusive end of the range to remove
@@ -521,6 +538,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				mergeTreeEnableSidedObliterate: (c, n) => c.getBoolean(n),
 				intervalStickinessEnabled: (c, n) => c.getBoolean(n),
 				mergeTreeReferencesCanSlideToEndpoint: (c, n) => c.getBoolean(n),
+				mergeTreeEnableAnnotateAdjust: (c, n) => c.getBoolean(n),
 			},
 			dataStoreRuntime.options,
 		);
@@ -605,6 +623,10 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		this.guardReentrancy(() => this.client.annotateRangeLocal(start, end, props));
 	}
 
+	public annotateAdjustRange(start: number, end: number, adjust: MapLike<AdjustParams>): void {
+		this.guardReentrancy(() => this.client.annotateAdjustRangeLocal(start, end, adjust));
+	}
+
 	public getPropertiesAtPosition(pos: number): PropertySet | undefined {
 		return this.client.getPropertiesAtPosition(pos);
 	}