@fluidframework/sequence 2.0.2 → 2.1.0-276326

package/src/intervalCollectionMapInterfaces.ts

@@ -5,6 +5,7 @@
 
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
 import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { IMergeTreeOptions } from "@fluidframework/merge-tree/internal";
 import { ISharedObjectEvents } from "@fluidframework/shared-object-base/internal";
 
 import type { IntervalCollection } from "./intervalCollection.js";
@@ -63,7 +64,11 @@ export interface IMapMessageLocalMetadata {
  * Optional flags that configure options for sequence DDSs
  * @internal
  */
-export interface SequenceOptions {
+export interface SequenceOptions
+	extends Pick<
+		IMergeTreeOptions,
+		"mergeTreeReferencesCanSlideToEndpoint" | "mergeTreeEnableObliterate"
+	> {
 	/**
 	 * Enable the ability to use interval APIs that rely on positions before and
 	 * after individual characters, referred to as "sides". See {@link SequencePlace}
@@ -78,21 +83,11 @@ export interface SequenceOptions {
 	 * The default value is false.
 	 */
 	intervalStickinessEnabled: boolean;
-	/**
-	 * Enable the ability for interval endpoints to slide to the special endpoint
-	 * segments that exist before and after the bounds of the string. This is
-	 * primarily useful for workflows involving interval stickiness, and it is
-	 * suggested to enable both this flag and `intervalStickinessEnabled` at the
-	 * same time.
-	 *
-	 * The default value is false.
-	 */
-	mergeTreeReferencesCanSlideToEndpoint: boolean;
-	[key: string]: boolean;
 }
 
 /**
  * A value factory is used to serialize/deserialize value types to a map
+ * @legacy
  * @alpha
  */
 export interface IIntervalCollectionFactory<T extends ISerializableInterval> {
@@ -120,6 +115,7 @@ export interface IIntervalCollectionFactory<T extends ISerializableInterval> {
 
 /**
  * Defines an operation that a value type is able to handle.
+ * @legacy
  * @alpha
  */
 export interface IIntervalCollectionOperation<T extends ISerializableInterval> {
@@ -228,6 +224,7 @@ export interface ISerializedIntervalCollection {
  * value is whatever params the ValueType needs to complete that operation.  Similar to ISerializableValue, it is
  * serializable via JSON.stringify/parse but differs in that it has no equivalency with an in-memory value - rather
  * it just describes an operation to be applied to an already-in-memory value.
+ * @legacy
  * @alpha
  */
 export interface IIntervalCollectionTypeOperationValue {

package/src/intervalIndex/intervalIndex.ts

@@ -13,6 +13,7 @@ import { ISerializableInterval } from "../intervals/index.js";
  * - "find all intervals with start endpoint between these two points"
  * - "find all intervals which overlap this range"
  * etc.
+ * @legacy
  * @alpha
  */
 export interface IntervalIndex<TInterval extends ISerializableInterval> {

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -21,6 +21,7 @@ import { ISharedString } from "../sharedString.js";
 import { IntervalIndex } from "./intervalIndex.js";
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval>
@@ -179,6 +180,7 @@ export class OverlappingIntervalsIndex<TInterval extends ISerializableInterval>
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export function createOverlappingIntervalsIndex(

package/src/intervals/intervalUtils.ts

@@ -18,6 +18,7 @@ import { SequencePlace, Side } from "../intervalCollection.js";
 
 /**
  * Basic interval abstraction
+ * @legacy
  * @alpha
  */
 export interface IInterval {
@@ -84,6 +85,7 @@ export type IntervalDeltaOpType =
 
 /**
  * Values are used in revertibles.
+ * @legacy
  * @alpha
  */
 export const IntervalOpType = {
@@ -92,11 +94,13 @@ export const IntervalOpType = {
 	POSITION_REMOVE: "positionRemove",
 } as const;
 /**
+ * @legacy
  * @alpha
  */
 export type IntervalOpType = (typeof IntervalOpType)[keyof typeof IntervalOpType];
 
 /**
+ * @legacy
  * @alpha
  */
 export enum IntervalType {
@@ -120,6 +124,7 @@ export enum IntervalType {
 /**
  * Serialized object representation of an interval.
  * This representation is used for ops that create or change intervals.
+ * @legacy
  * @alpha
  */
 export interface ISerializedInterval {
@@ -148,6 +153,7 @@ export interface ISerializedInterval {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISerializableInterval extends IInterval {
@@ -253,6 +259,7 @@ export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
  * Note that interval stickiness is currently an experimental feature and must
  * be explicitly enabled with the `intervalStickinessEnabled` flag
  *
+ * @legacy
  * @alpha
  */
 export const IntervalStickiness = {
@@ -285,6 +292,7 @@ export const IntervalStickiness = {
  *
  * Note that interval stickiness is currently an experimental feature and must
  * be explicitly enabled with the `intervalStickinessEnabled` flag
+ * @legacy
  * @alpha
  */
 export type IntervalStickiness = (typeof IntervalStickiness)[keyof typeof IntervalStickiness];

package/src/intervals/sequenceInterval.ts

@@ -100,6 +100,7 @@ function maxSide(sideA: Side, sideB: Side): Side {
  * `mergeTreeReferencesCanSlideToEndpoint` feature flag set to true, the endpoints
  * of the interval that are exclusive will have the ability to slide to these
  * special endpoint segments.
+ * @legacy
  * @alpha
  */
 export class SequenceInterval implements ISerializableInterval {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.0.2";
+export const pkgVersion = "2.1.0-276326";

package/src/revertibles.ts

@@ -30,6 +30,7 @@ import { ISharedString, SharedStringSegment } from "./sharedString.js";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
+ * @legacy
  * @alpha
  */
 export type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertible;
@@ -38,6 +39,7 @@ const idMap = new Map<string, string>();
 
 /**
  * Data for undoing edits affecting Intervals.
+ * @legacy
  * @alpha
  */
 export type IntervalRevertible =
@@ -94,6 +96,7 @@ function getUpdatedId(intervalId: string): string {
 
 /**
  * Create revertibles for adding an interval
+ * @legacy
  * @alpha
  */
 export function appendAddIntervalToRevertibles(
@@ -110,6 +113,7 @@ export function appendAddIntervalToRevertibles(
 
 /**
  * Create revertibles for deleting an interval
+ * @legacy
  * @alpha
  */
 export function appendDeleteIntervalToRevertibles(
@@ -162,6 +166,7 @@ export function appendDeleteIntervalToRevertibles(
 
 /**
  * Create revertibles for moving endpoints of an interval
+ * @legacy
  * @alpha
  */
 export function appendChangeIntervalToRevertibles(
@@ -212,6 +217,7 @@ export function appendChangeIntervalToRevertibles(
 
 /**
  * Create revertibles for changing properties of an interval
+ * @legacy
  * @alpha
  */
 export function appendIntervalPropertyChangedToRevertibles(
@@ -272,6 +278,7 @@ function addIfRevertibleRef(
 /**
  * Create revertibles for SharedStringDeltas, handling indirectly modified intervals
  * (e.g. reverting remove of a range that contains an interval will move the interval back)
+ * @legacy
  * @alpha
  */
 export function appendSharedStringDeltaToRevertibles(
@@ -368,6 +375,7 @@ export function appendSharedStringDeltaToRevertibles(
 
 /**
  * Clean up resources held by revertibles that are no longer needed.
+ * @legacy
  * @alpha
  */
 export function discardSharedStringRevertibles(
@@ -662,6 +670,7 @@ function revertLocalSequenceRemove(
 
 /**
  * Invoke revertibles to reverse prior edits
+ * @legacy
  * @alpha
  */
 export function revertSharedStringRevertibles(

package/src/sequence.ts

@@ -61,7 +61,12 @@ import {
 	SharedObject,
 	type ISharedObject,
 } from "@fluidframework/shared-object-base/internal";
-import { LoggingError, createChildLogger } from "@fluidframework/telemetry-utils/internal";
+import {
+	LoggingError,
+	createChildLogger,
+	createConfigBasedOptionsProxy,
+	loggerToMonitoringContext,
+} from "@fluidframework/telemetry-utils/internal";
 import Deque from "double-ended-queue";
 
 import {
@@ -69,7 +74,11 @@ import {
 	SequenceIntervalCollectionValueType,
 } from "./intervalCollection.js";
 import { IMapOperation, IntervalCollectionMap } from "./intervalCollectionMap.js";
-import { IMapMessageLocalMetadata, IValueChanged } from "./intervalCollectionMapInterfaces.js";
+import {
+	IMapMessageLocalMetadata,
+	IValueChanged,
+	type SequenceOptions,
+} from "./intervalCollectionMapInterfaces.js";
 import { SequenceInterval } from "./intervals/index.js";
 import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent.js";
 import { ISharedIntervalCollection } from "./sharedIntervalCollection.js";
@@ -109,6 +118,7 @@ const contentPath = "content";
  * - `event` - Various information on the segments that were modified.
  *
  * - `target` - The sequence itself.
+ * @legacy
  * @alpha
  */
 export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
@@ -127,6 +137,7 @@ export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISharedSegmentSequence<T extends ISegment>
@@ -332,6 +343,7 @@ export interface ISharedSegmentSequence<T extends ISegment>
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export abstract class SharedSegmentSequence<T extends ISegment>
@@ -478,6 +490,17 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 						}
 					});
 
+		const options = createConfigBasedOptionsProxy<SequenceOptions>(
+			loggerToMonitoringContext(this.logger).config,
+			"Fluid.Sequence",
+			{
+				mergeTreeEnableObliterate: (c, n) => c.getBoolean(n),
+				intervalStickinessEnabled: (c, n) => c.getBoolean(n),
+				mergeTreeReferencesCanSlideToEndpoint: (c, n) => c.getBoolean(n),
+			},
+			dataStoreRuntime.options,
+		);
+
 		// eslint-disable-next-line import/no-deprecated
 		this.client = new Client(
 			segmentFromSpec,
@@ -485,7 +508,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				logger: this.logger,
 				namespace: "SharedSegmentSequence.MergeTreeClient",
 			}),
-			dataStoreRuntime.options,
+			options,
 			getMinInFlightRefSeq,
 		);
 
@@ -513,7 +536,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				this.submitLocalMessage(op, localOpMetadata);
 			},
 			new SequenceIntervalCollectionValueType(),
-			dataStoreRuntime.options,
+			options,
 		);
 	}
 

package/src/sequenceDeltaEvent.ts

@@ -24,6 +24,7 @@ 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.
+ * @legacy
  * @alpha
  */
 export abstract class SequenceEvent<
@@ -117,6 +118,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.
+ * @legacy
  * @alpha
  */
 export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
@@ -142,6 +144,7 @@ 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.
+ * @legacy
  * @alpha
  */
 export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
@@ -162,6 +165,7 @@ export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenance
 
 /**
  * A range that has changed corresponding to a segment modification.
+ * @legacy
  * @alpha
  */
 export interface ISequenceDeltaRange<

package/src/sequenceFactory.ts

@@ -74,12 +74,14 @@ export class SharedStringFactory implements IChannelFactory<ISharedString> {
 
 /**
  * Entrypoint for {@link ISharedString} creation.
+ * @legacy
  * @alpha
  */
 export const SharedString = createSharedObjectKind<ISharedString>(SharedStringFactory);
 
 /**
  * Alias for {@link ISharedString} for compatibility.
+ * @legacy
  * @alpha
  */
 export type SharedString = ISharedString;

package/src/sharedIntervalCollection.ts

@@ -76,6 +76,7 @@ export class SharedIntervalCollectionFactory implements IChannelFactory {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISharedIntervalCollection<TInterval extends ISerializableInterval> {

package/src/sharedString.ts

@@ -25,6 +25,7 @@ import { SharedStringFactory } from "./sequenceFactory.js";
 
 /**
  * Fluid object interface describing access methods on a SharedString
+ * @legacy
  * @alpha
  */
 export interface ISharedString extends ISharedSegmentSequence<SharedStringSegment> {
@@ -125,6 +126,7 @@ export interface ISharedString extends ISharedSegmentSequence<SharedStringSegmen
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export type SharedStringSegment = TextSegment | Marker;
@@ -137,6 +139,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.
+ * @legacy
  * @alpha
  */
 export class SharedStringClass