@fluidframework/sequence 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/lib/{sequence-alpha.d.mts → sequence-alpha.d.ts}

@@ -1,3 +1,16 @@
+/**
+ * Supports distributed data structures which are list-like.
+ *
+ * This library's main export is {@link SharedString}, a DDS for storing and simultaneously editing a sequence of
+ * text.
+ *
+ * See the package's README for a high-level introduction to `SharedString`'s feature set.
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
+
 import { BaseSegment } from '@fluidframework/merge-tree';
 import { Client } from '@fluidframework/merge-tree';
 import { Deferred } from '@fluidframework/core-utils';
@@ -44,15 +57,37 @@ import { TextSegment } from '@fluidframework/merge-tree';
 import { TrackingGroup } from '@fluidframework/merge-tree';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
-/* Excluded from this release type: appendAddIntervalToRevertibles */
+/**
+ * Create revertibles for adding an interval
+ * @alpha
+ */
+export declare function appendAddIntervalToRevertibles(interval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
-/* Excluded from this release type: appendChangeIntervalToRevertibles */
+/**
+ * Create revertibles for moving endpoints of an interval
+ * @alpha
+ */
+export declare function appendChangeIntervalToRevertibles(string: SharedString, newInterval: SequenceInterval, previousInterval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
-/* Excluded from this release type: appendDeleteIntervalToRevertibles */
+/**
+ * Create revertibles for deleting an interval
+ * @alpha
+ */
+export declare function appendDeleteIntervalToRevertibles(string: SharedString, interval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
-/* Excluded from this release type: appendIntervalPropertyChangedToRevertibles */
+/**
+ * Create revertibles for changing properties of an interval
+ * @alpha
+ */
+export declare function appendIntervalPropertyChangedToRevertibles(interval: SequenceInterval, deltas: PropertySet, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
+
+/**
+ * Create revertibles for SharedStringDeltas, handling indirectly modified intervals
+ * (e.g. reverting remove of a range that contains an interval will move the interval back)
+ * @alpha
+ */
+export declare function appendSharedStringDeltaToRevertibles(string: SharedString, delta: SequenceDeltaEvent, revertibles: SharedStringRevertible[]): void;
 
-/* Excluded from this release type: appendSharedStringDeltaToRevertibles */
 export { BaseSegment }
 
 /* Excluded from this release type: createEndpointIndex */
@@ -61,7 +96,10 @@ export { BaseSegment }
 
 /* Excluded from this release type: createIdIntervalIndex */
 
-/* Excluded from this release type: createOverlappingIntervalsIndex */
+/**
+ * @alpha
+ */
+export declare function createOverlappingIntervalsIndex(sharedString: SharedString): IOverlappingIntervalsIndex<SequenceInterval>;
 
 /* Excluded from this release type: createOverlappingSequenceIntervalsIndex */
 
@@ -72,7 +110,11 @@ export { BaseSegment }
  */
 export declare type DeserializeCallback = (properties: PropertySet) => void;
 
-/* Excluded from this release type: discardSharedStringRevertibles */
+/**
+ * Clean up resources held by revertibles that are no longer needed.
+ * @alpha
+ */
+export declare function discardSharedStringRevertibles(sharedString: SharedString, revertibles: SharedStringRevertible[]): void;
 
 /* Excluded from this release type: getTextAndMarkers */
 
@@ -359,6 +401,19 @@ export declare interface IIntervalCollectionEvent<TInterval extends ISerializabl
      * `op` is defined if and only if the server has acked this change.
      */
     (event: "propertyChanged", listener: (interval: TInterval, propertyDeltas: PropertySet, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void;
+    /**
+     * This event is invoked whenever an interval's endpoints or properties (or both) have changed.
+     * `interval` reflects the state of the updated endpoints or properties.
+     * `propertyDeltas` is a map-like whose keys contain all values that were changed, and whose
+     * values contain all previous values of the property set.
+     * This object can be used directly in a call to `changeProperties` to revert the property change if desired.
+     * 'previousInterval' contains transient `ReferencePosition`s at the same location as the interval's original
+     * endpoints. These references should be used for position information only. In the case of a property change
+     * only, this argument should be undefined.
+     * `local` reflects whether the change originated locally.
+     * `slide` is true if the change is due to sliding on removal of position.
+     */
+    (event: "changed", listener: (interval: TInterval, propertyDeltas: PropertySet, previousInterval: TInterval | undefined, local: boolean, slide: boolean) => void): void;
 }
 
 /* Excluded from this release type: IIntervalHelpers */
@@ -409,9 +464,59 @@ export declare interface IntervalIndex<TInterval extends ISerializableInterval>
 
 /* Excluded from this release type: intervalLocatorFromEndpoint */
 
-/* Excluded from this release type: IntervalOpType */
+/**
+ * Values are used in revertibles.
+ * @alpha
+ */
+export declare const IntervalOpType: {
+    readonly PROPERTY_CHANGED: "propertyChanged";
+    readonly POSITION_REMOVE: "positionRemove";
+    readonly ADD: "add";
+    readonly DELETE: "delete";
+    readonly CHANGE: "change";
+};
 
-/* Excluded from this release type: IntervalRevertible */
+/**
+ * @alpha
+ */
+export declare type IntervalOpType = (typeof IntervalOpType)[keyof typeof IntervalOpType];
+
+/**
+ * Data for undoing edits affecting Intervals.
+ * @alpha
+ */
+export declare type IntervalRevertible = {
+    event: typeof IntervalOpType.CHANGE;
+    interval: SequenceInterval;
+    start: LocalReferencePosition;
+    end: LocalReferencePosition;
+} | {
+    event: typeof IntervalOpType.ADD;
+    interval: SequenceInterval;
+} | {
+    event: typeof IntervalOpType.DELETE;
+    interval: SequenceInterval;
+    start: LocalReferencePosition;
+    end: LocalReferencePosition;
+} | {
+    event: typeof IntervalOpType.PROPERTY_CHANGED;
+    interval: SequenceInterval;
+    propertyDeltas: PropertySet;
+} | {
+    event: typeof IntervalOpType.POSITION_REMOVE;
+    intervals: {
+        intervalId: string;
+        label: string;
+        startOffset?: number;
+        endOffset?: number;
+    }[];
+    revertibleRefs: {
+        revertible: IntervalRevertible;
+        offset: number;
+        isStart: boolean;
+    }[];
+    mergeTreeRevertible: MergeTreeDeltaRevertible;
+};
 
 /**
  * Determines how an interval should expand when segments are inserted adjacent
@@ -468,7 +573,20 @@ export declare enum IntervalType {
     /* Excluded from this release type: Transient */
 }
 
-/* Excluded from this release type: IOverlappingIntervalsIndex */
+/**
+ * @alpha
+ */
+export declare interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval> {
+    /**
+     * @returns an array of all intervals contained in this collection that overlap the range
+     * `[start end]`.
+     */
+    findOverlappingIntervals(start: SequencePlace, end: SequencePlace): TInterval[];
+    /**
+     * Gathers the interval results based on specified parameters.
+     */
+    gatherIterationResults(results: TInterval[], iteratesForward: boolean, start?: SequencePlace, end?: SequencePlace): void;
+}
 
 export { ISegment }
 
@@ -655,7 +773,11 @@ export { ReferenceType }
 
 /* Excluded from this release type: reservedTileLabelsKey */
 
-/* Excluded from this release type: revertSharedStringRevertibles */
+/**
+ * Invoke revertibles to reverse prior edits
+ * @alpha
+ */
+export declare function revertSharedStringRevertibles(sharedString: SharedString, revertibles: SharedStringRevertible[]): void;
 
 /**
  * The event object returned on sequenceDelta events.
@@ -906,6 +1028,35 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      */
     protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
     private static createOpsFromDelta;
+    /**
+     * Note: this field only provides a lower-bound on the reference sequence numbers for in-flight ops.
+     * The exact reason isn't understood, but some e2e tests suggest that the runtime may sometimes process
+     * incoming leave/join ops before putting an op that this DDS submits over the wire.
+     *
+     * E.g. SharedString submits an op while deltaManager has lastSequenceNumber = 10, but before the runtime
+     * puts this op over the wire, it processes a client join/leave op with sequence number 11, so the referenceSequenceNumber
+     * on the SharedString op is 11.
+     *
+     * The reference sequence numbers placed in this queue are also not accurate for stashed ops due to how the applyStashedOp
+     * flow works at the runtime level. This is a legitimate bug, and AB#6602 tracks one way to fix it (stop reaching all the way
+     * to deltaManager's lastSequenceNumber to obtain refSeq, instead leveraging some analogous notion on the container or datastore
+     * runtime).
+     */
+    private readonly inFlightRefSeqs;
+    private ongoingResubmitRefSeq;
+    /**
+     * Gets the reference sequence number (i.e. sequence number of the runtime's last processed op) for an op submitted
+     * in the current context.
+     *
+     * This value can be optionally overridden using `useResubmitRefSeq`.
+     * IntervalCollection's resubmit logic currently relies on preserving merge information from when the op was originally submitted,
+     * even if the op is resubmitted more than once. Thus during resubmit, `inFlightRefSeqs` gets populated with the
+     * original refSeq rather than the refSeq at the time of reconnection.
+     *
+     * @remarks - In some not fully understood cases, the runtime may process incoming ops before putting an op that this
+     * DDS submits over the wire. See `inFlightRefSeqs` for more details.
+     */
+    private get currentRefSeq();
     protected client: Client;
     /** `Deferred` that triggers once the object is loaded */
     protected loadedDeferred: Deferred<void>;
@@ -978,6 +1129,11 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     createLocalReferencePosition(segment: T, offset: number, refType: ReferenceType, properties: PropertySet | undefined, slidingPreference?: SlidingPreference, canSlideToEndpoint?: boolean): LocalReferencePosition;
     /**
      * Resolves a `ReferencePosition` into a character position using this client's perspective.
+     *
+     * Reference positions that point to a character that has been removed will
+     * always return the position of the nearest non-removed character, regardless
+     * of `ReferenceType`. To handle this case specifically, one may wish
+     * to look at the segment returned by `ReferencePosition.getSegment`.
      */
     localReferencePositionToPosition(lref: ReferencePosition): number;
     /**
@@ -1106,12 +1262,21 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
-    protected applyStashedOp(content: any): unknown;
+    protected applyStashedOp(content: any): void;
     private summarizeMergeTree;
+    /**
+     *
+     * @param message - Message with decoded and hydrated handles
+     */
     private processMergeTreeMsg;
     private processMinSequenceNumberChanged;
     private loadFinished;
     private initializeIntervalCollections;
+    /**
+     * Overrides the "currently applicable reference sequence number" for the duration of the callback.
+     * See remarks on `currentRefSeq` for more context.
+     */
+    private useResubmitRefSeq;
 }
 
 /* Excluded from this release type: SharedSequence */
@@ -1231,10 +1396,17 @@ export declare class SharedStringFactory implements IChannelFactory {
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
      */
     load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<SharedString>;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
     create(document: IFluidDataStoreRuntime, id: string): SharedString;
 }
 
-/* Excluded from this release type: SharedStringRevertible */
+/**
+ * Data for undoing edits on SharedStrings and Intervals.
+ * @alpha
+ */
+export declare type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertible;
 
 /**
  * @alpha

package/lib/{sequence-public.d.mts → sequence-beta.d.ts}

@@ -1,3 +1,16 @@
+/**
+ * Supports distributed data structures which are list-like.
+ *
+ * This library's main export is {@link SharedString}, a DDS for storing and simultaneously editing a sequence of
+ * text.
+ *
+ * See the package's README for a high-level introduction to `SharedString`'s feature set.
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
+
 import { BaseSegment } from '@fluidframework/merge-tree';
 import { Client } from '@fluidframework/merge-tree';
 import { Deferred } from '@fluidframework/core-utils';
@@ -206,6 +219,8 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: SharedIntervalCollectionFactory */
 
+/* Excluded from this release type: SharedObject */
+
 /* Excluded from this release type: SharedSegmentSequence */
 
 /* Excluded from this release type: SharedSequence */

package/lib/{sequence-beta.d.mts → sequence-public.d.ts}

@@ -1,3 +1,16 @@
+/**
+ * Supports distributed data structures which are list-like.
+ *
+ * This library's main export is {@link SharedString}, a DDS for storing and simultaneously editing a sequence of
+ * text.
+ *
+ * See the package's README for a high-level introduction to `SharedString`'s feature set.
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
+
 import { BaseSegment } from '@fluidframework/merge-tree';
 import { Client } from '@fluidframework/merge-tree';
 import { Deferred } from '@fluidframework/core-utils';
@@ -206,6 +219,8 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: SharedIntervalCollectionFactory */
 
+/* Excluded from this release type: SharedObject */
+
 /* Excluded from this release type: SharedSegmentSequence */
 
 /* Excluded from this release type: SharedSequence */

package/lib/{sequence-untrimmed.d.mts → sequence-untrimmed.d.ts}

@@ -1,3 +1,16 @@
+/**
+ * Supports distributed data structures which are list-like.
+ *
+ * This library's main export is {@link SharedString}, a DDS for storing and simultaneously editing a sequence of
+ * text.
+ *
+ * See the package's README for a high-level introduction to `SharedString`'s feature set.
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
+
 import { BaseSegment } from '@fluidframework/merge-tree';
 import { Client } from '@fluidframework/merge-tree';
 import { Deferred } from '@fluidframework/core-utils';
@@ -46,32 +59,32 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /**
  * Create revertibles for adding an interval
- * @internal
+ * @alpha
  */
 export declare function appendAddIntervalToRevertibles(interval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for moving endpoints of an interval
- * @internal
+ * @alpha
  */
 export declare function appendChangeIntervalToRevertibles(string: SharedString, newInterval: SequenceInterval, previousInterval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for deleting an interval
- * @internal
+ * @alpha
  */
 export declare function appendDeleteIntervalToRevertibles(string: SharedString, interval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for changing properties of an interval
- * @internal
+ * @alpha
  */
 export declare function appendIntervalPropertyChangedToRevertibles(interval: SequenceInterval, deltas: PropertySet, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for SharedStringDeltas, handling indirectly modified intervals
  * (e.g. reverting remove of a range that contains an interval will move the interval back)
- * @internal
+ * @alpha
  */
 export declare function appendSharedStringDeltaToRevertibles(string: SharedString, delta: SequenceDeltaEvent, revertibles: SharedStringRevertible[]): void;
 
@@ -93,7 +106,7 @@ export declare function createEndpointInRangeIndex(sharedString: SharedString):
 export declare function createIdIntervalIndex<TInterval extends ISerializableInterval>(): IIdIntervalIndex<TInterval>;
 
 /**
- * @internal
+ * @alpha
  */
 export declare function createOverlappingIntervalsIndex(sharedString: SharedString): IOverlappingIntervalsIndex<SequenceInterval>;
 
@@ -114,7 +127,7 @@ export declare type DeserializeCallback = (properties: PropertySet) => void;
 
 /**
  * Clean up resources held by revertibles that are no longer needed.
- * @internal
+ * @alpha
  */
 export declare function discardSharedStringRevertibles(sharedString: SharedString, revertibles: SharedStringRevertible[]): void;
 
@@ -452,6 +465,19 @@ export declare interface IIntervalCollectionEvent<TInterval extends ISerializabl
      * `op` is defined if and only if the server has acked this change.
      */
     (event: "propertyChanged", listener: (interval: TInterval, propertyDeltas: PropertySet, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void;
+    /**
+     * This event is invoked whenever an interval's endpoints or properties (or both) have changed.
+     * `interval` reflects the state of the updated endpoints or properties.
+     * `propertyDeltas` is a map-like whose keys contain all values that were changed, and whose
+     * values contain all previous values of the property set.
+     * This object can be used directly in a call to `changeProperties` to revert the property change if desired.
+     * 'previousInterval' contains transient `ReferencePosition`s at the same location as the interval's original
+     * endpoints. These references should be used for position information only. In the case of a property change
+     * only, this argument should be undefined.
+     * `local` reflects whether the change originated locally.
+     * `slide` is true if the change is due to sliding on removal of position.
+     */
+    (event: "changed", listener: (interval: TInterval, propertyDeltas: PropertySet, previousInterval: TInterval | undefined, local: boolean, slide: boolean) => void): void;
 }
 
 /**
@@ -629,7 +655,7 @@ export declare function intervalLocatorFromEndpoint(potentialEndpoint: LocalRefe
 
 /**
  * Values are used in revertibles.
- * @internal
+ * @alpha
  */
 export declare const IntervalOpType: {
     readonly PROPERTY_CHANGED: "propertyChanged";
@@ -640,13 +666,13 @@ export declare const IntervalOpType: {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export declare type IntervalOpType = (typeof IntervalOpType)[keyof typeof IntervalOpType];
 
 /**
  * Data for undoing edits affecting Intervals.
- * @internal
+ * @alpha
  */
 export declare type IntervalRevertible = {
     event: typeof IntervalOpType.CHANGE;
@@ -741,7 +767,7 @@ export declare enum IntervalType {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval> {
     /**
@@ -968,7 +994,7 @@ export { reservedTileLabelsKey }
 
 /**
  * Invoke revertibles to reverse prior edits
- * @internal
+ * @alpha
  */
 export declare function revertSharedStringRevertibles(sharedString: SharedString, revertibles: SharedStringRevertible[]): void;
 
@@ -1342,6 +1368,35 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      */
     protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
     private static createOpsFromDelta;
+    /**
+     * Note: this field only provides a lower-bound on the reference sequence numbers for in-flight ops.
+     * The exact reason isn't understood, but some e2e tests suggest that the runtime may sometimes process
+     * incoming leave/join ops before putting an op that this DDS submits over the wire.
+     *
+     * E.g. SharedString submits an op while deltaManager has lastSequenceNumber = 10, but before the runtime
+     * puts this op over the wire, it processes a client join/leave op with sequence number 11, so the referenceSequenceNumber
+     * on the SharedString op is 11.
+     *
+     * The reference sequence numbers placed in this queue are also not accurate for stashed ops due to how the applyStashedOp
+     * flow works at the runtime level. This is a legitimate bug, and AB#6602 tracks one way to fix it (stop reaching all the way
+     * to deltaManager's lastSequenceNumber to obtain refSeq, instead leveraging some analogous notion on the container or datastore
+     * runtime).
+     */
+    private readonly inFlightRefSeqs;
+    private ongoingResubmitRefSeq;
+    /**
+     * Gets the reference sequence number (i.e. sequence number of the runtime's last processed op) for an op submitted
+     * in the current context.
+     *
+     * This value can be optionally overridden using `useResubmitRefSeq`.
+     * IntervalCollection's resubmit logic currently relies on preserving merge information from when the op was originally submitted,
+     * even if the op is resubmitted more than once. Thus during resubmit, `inFlightRefSeqs` gets populated with the
+     * original refSeq rather than the refSeq at the time of reconnection.
+     *
+     * @remarks - In some not fully understood cases, the runtime may process incoming ops before putting an op that this
+     * DDS submits over the wire. See `inFlightRefSeqs` for more details.
+     */
+    private get currentRefSeq();
     protected client: Client;
     /** `Deferred` that triggers once the object is loaded */
     protected loadedDeferred: Deferred<void>;
@@ -1414,6 +1469,11 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     createLocalReferencePosition(segment: T, offset: number, refType: ReferenceType, properties: PropertySet | undefined, slidingPreference?: SlidingPreference, canSlideToEndpoint?: boolean): LocalReferencePosition;
     /**
      * Resolves a `ReferencePosition` into a character position using this client's perspective.
+     *
+     * Reference positions that point to a character that has been removed will
+     * always return the position of the nearest non-removed character, regardless
+     * of `ReferenceType`. To handle this case specifically, one may wish
+     * to look at the segment returned by `ReferencePosition.getSegment`.
      */
     localReferencePositionToPosition(lref: ReferencePosition): number;
     /**
@@ -1542,12 +1602,21 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
-    protected applyStashedOp(content: any): unknown;
+    protected applyStashedOp(content: any): void;
     private summarizeMergeTree;
+    /**
+     *
+     * @param message - Message with decoded and hydrated handles
+     */
     private processMergeTreeMsg;
     private processMinSequenceNumberChanged;
     private loadFinished;
     private initializeIntervalCollections;
+    /**
+     * Overrides the "currently applicable reference sequence number" for the duration of the callback.
+     * See remarks on `currentRefSeq` for more context.
+     */
+    private useResubmitRefSeq;
 }
 
 /**
@@ -1696,12 +1765,15 @@ export declare class SharedStringFactory implements IChannelFactory {
      * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
      */
     load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<SharedString>;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
+     */
     create(document: IFluidDataStoreRuntime, id: string): SharedString;
 }
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
- * @internal
+ * @alpha
  */
 export declare type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertible;
 

package/lib/{sequence.d.mts → sequence.d.ts}

@@ -9,10 +9,10 @@ import { Client, IJSONSegment, IMergeTreeGroupMsg, IRelativePosition, ISegment,
 import { IFluidSerializer, SharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
 import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
-import { SequenceInterval } from "./intervals/index.mjs";
-import { IIntervalCollection } from "./intervalCollection.mjs";
-import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent.mjs";
-import { ISharedIntervalCollection } from "./sharedIntervalCollection.mjs";
+import { SequenceInterval } from "./intervals/index.js";
+import { IIntervalCollection } from "./intervalCollection.js";
+import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent.js";
+import { ISharedIntervalCollection } from "./sharedIntervalCollection.js";
 /**
  * Events emitted in response to changes to the sequence data.
  *
@@ -74,6 +74,35 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      */
     protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
     private static createOpsFromDelta;
+    /**
+     * Note: this field only provides a lower-bound on the reference sequence numbers for in-flight ops.
+     * The exact reason isn't understood, but some e2e tests suggest that the runtime may sometimes process
+     * incoming leave/join ops before putting an op that this DDS submits over the wire.
+     *
+     * E.g. SharedString submits an op while deltaManager has lastSequenceNumber = 10, but before the runtime
+     * puts this op over the wire, it processes a client join/leave op with sequence number 11, so the referenceSequenceNumber
+     * on the SharedString op is 11.
+     *
+     * The reference sequence numbers placed in this queue are also not accurate for stashed ops due to how the applyStashedOp
+     * flow works at the runtime level. This is a legitimate bug, and AB#6602 tracks one way to fix it (stop reaching all the way
+     * to deltaManager's lastSequenceNumber to obtain refSeq, instead leveraging some analogous notion on the container or datastore
+     * runtime).
+     */
+    private readonly inFlightRefSeqs;
+    private ongoingResubmitRefSeq;
+    /**
+     * Gets the reference sequence number (i.e. sequence number of the runtime's last processed op) for an op submitted
+     * in the current context.
+     *
+     * This value can be optionally overridden using `useResubmitRefSeq`.
+     * IntervalCollection's resubmit logic currently relies on preserving merge information from when the op was originally submitted,
+     * even if the op is resubmitted more than once. Thus during resubmit, `inFlightRefSeqs` gets populated with the
+     * original refSeq rather than the refSeq at the time of reconnection.
+     *
+     * @remarks - In some not fully understood cases, the runtime may process incoming ops before putting an op that this
+     * DDS submits over the wire. See `inFlightRefSeqs` for more details.
+     */
+    private get currentRefSeq();
     protected client: Client;
     /** `Deferred` that triggers once the object is loaded */
     protected loadedDeferred: Deferred<void>;
@@ -146,6 +175,11 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     createLocalReferencePosition(segment: T, offset: number, refType: ReferenceType, properties: PropertySet | undefined, slidingPreference?: SlidingPreference, canSlideToEndpoint?: boolean): LocalReferencePosition;
     /**
      * Resolves a `ReferencePosition` into a character position using this client's perspective.
+     *
+     * Reference positions that point to a character that has been removed will
+     * always return the position of the nearest non-removed character, regardless
+     * of `ReferenceType`. To handle this case specifically, one may wish
+     * to look at the segment returned by `ReferencePosition.getSegment`.
      */
     localReferencePositionToPosition(lref: ReferencePosition): number;
     /**
@@ -274,15 +308,24 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
-    protected applyStashedOp(content: any): unknown;
+    protected applyStashedOp(content: any): void;
     private summarizeMergeTree;
+    /**
+     *
+     * @param message - Message with decoded and hydrated handles
+     */
     private processMergeTreeMsg;
     private processMinSequenceNumberChanged;
     private loadFinished;
     private initializeIntervalCollections;
+    /**
+     * Overrides the "currently applicable reference sequence number" for the duration of the callback.
+     * See remarks on `currentRefSeq` for more context.
+     */
+    private useResubmitRefSeq;
 }
 /**
  * Resets the reentrancy log counter. Test-only API.
  */
 export declare function resetReentrancyLogCounter(): void;
-//# sourceMappingURL=sequence.d.mts.map
+//# sourceMappingURL=sequence.d.ts.map

package/lib/sequence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sequence.d.ts","sourceRoot":"","sources":["../src/sequence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAU,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAG9D,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAEN,MAAM,EAMN,YAAY,EAGZ,kBAAkB,EAGlB,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,sBAAsB,EAGtB,WAAW,EACX,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EAIzB,iBAAiB,EACjB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACN,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACnB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAG/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACN,mBAAmB,EAGnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAK1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACxE,CACC,KAAK,EAAE,0BAA0B,EACjC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAC9E,IAAI,CAAC;IACR,CACC,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAC1E,IAAI,CAAC;IACR,CACC,KAAK,EAAE,aAAa,EACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,GAChF,IAAI,CAAC;CACR;AAED;;GAEG;AACH,8BAAsB,qBAAqB,CAAC,CAAC,SAAS,QAAQ,CAC7D,SAAQ,YAAY,CAAC,4BAA4B,CACjD,YAAW,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,yBAAyB;IA6IhF,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAC1B,EAAE,EAAE,MAAM;aAED,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IA9IlE,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAEhE,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAyEjC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD,OAAO,CAAC,qBAAqB,CAAqB;IAElD;;;;;;;;;;;OAWG;IACH,OAAO,KAAK,aAAa,GAExB;IAGD,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,SAAS,CAAC,cAAc,iBAAwB;IAEhD,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CACtC;IAEJ,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAmC;IAE7E,OAAO,CAAC,sBAAsB,CAAmC;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmD;gBAErE,gBAAgB,EAAE,sBAAsB,EAClD,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB,EACd,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IA6DlE;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpD;;;;;;OAMG;IACI,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAIxD;;;;OAIG;IACI,cAAc,CAAC,OAAO,EAAE,kBAAkB;IAIjD;;;;OAIG;IACI,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG;QACzC,OAAO,EAAE,CAAC,GAAG,SAAS,CAAC;QACvB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;KAC3B;IAID;;OAEG;IACI,SAAS;IAIhB;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,MAAM;IAI7C;;;;;;;OAOG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,IAAI;IAInE,uBAAuB,CAAC,GAAG,EAAE,MAAM;IAInC,yBAAyB,CAAC,GAAG,EAAE,MAAM;;;;IAI5C;;;;;;;OAOG;IACI,4BAA4B,CAClC,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,EACtB,UAAU,EAAE,WAAW,GAAG,SAAS,EACnC,iBAAiB,CAAC,EAAE,iBAAiB,EACrC,kBAAkB,CAAC,EAAE,OAAO,GAC1B,sBAAsB;IAWzB;;;;;;;OAOG;IACI,gCAAgC,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAIxE;;OAEG;IACI,4BAA4B,CAAC,IAAI,EAAE,sBAAsB;IAIhE;;;;;;;;;;;;;OAaG;IACI,2BAA2B,CACjC,oBAAoB,EAAE,MAAM,EAC5B,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,MAAM,GACpB,MAAM,GAAG,SAAS;IAQrB,OAAO,CAAC,qBAAqB;IAqB7B;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIxD;;;;;;;;;;;;;OAaG;IACI,YAAY,CAAC,WAAW,EAC9B,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,EACpC,KAAK,CAAC,EAAE,MAAM,EACd,GAAG,CAAC,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,WAAW,EACnB,UAAU,GAAE,OAAe,GACzB,IAAI;IAIP;;;OAGG;IACI,aAAa;IAIpB;;;;OAIG;IACI,yBAAyB,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI;IAG1E;;;;OAIG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI;IAK5D;;;OAGG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,mBAAmB,CAAC,gBAAgB,CAAC;IAIlF;;;;;;;;;;;OAWG;IACI,2BAA2B,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAI9D;;OAEG;IACH,SAAS,CAAC,aAAa,CACtB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAcxB;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB;IAQxD;;;;;;;;OAQG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAc3E;;OAEG;IACH,SAAS,CAAC,SAAS;IAKnB;;OAEG;IACH,SAAS,CAAC,YAAY;IAEtB;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAuB7D;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IA6DxD;;OAEG;IACH,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAsCzB;;OAEG;IACH,SAAS,CAAC,SAAS;IAQnB;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAK7B;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAM5C,OAAO,CAAC,kBAAkB;IAsB1B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAwC3B,OAAO,CAAC,+BAA+B;IAYvC,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,6BAA6B;IAwBrC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;CASzB;AA4BD;;GAEG;AACH,wBAAgB,yBAAyB,SAExC"}