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

package/lib/sequence.d.ts

@@ -5,7 +5,7 @@
 import { Deferred } from "@fluidframework/core-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
-import { Client, ICombiningOp, IJSONSegment, IMergeTreeGroupMsg, IMergeTreeOp, IMergeTreeRemoveMsg, IRelativePosition, ISegment, ISegmentAction, LocalReferencePosition, PropertySet, RangeStackMap, ReferencePosition, ReferenceType, MergeTreeRevertibleDriver, SlidingPreference } from "@fluidframework/merge-tree";
+import { Client, IJSONSegment, IMergeTreeGroupMsg, IRelativePosition, ISegment, ISegmentAction, LocalReferencePosition, PropertySet, ReferencePosition, ReferenceType, MergeTreeRevertibleDriver, SlidingPreference } from "@fluidframework/merge-tree";
 import { IFluidSerializer, SharedObject, ISharedObjectEvents, SummarySerializer } from "@fluidframework/shared-object-base";
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
 import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
@@ -45,15 +45,15 @@ import { ISharedIntervalCollection } from "./sharedIntervalCollection";
  * - `event` - Various information on the segments that were modified.
  *
  * - `target` - The sequence itself.
- * @public
+ * @alpha
  */
 export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
-    (event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
-    (event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): any;
-    (event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): any;
+    (event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): void;
+    (event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): void;
+    (event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): void;
 }
 /**
- * @public
+ * @alpha
  */
 export declare abstract class SharedSegmentSequence<T extends ISegment> extends SharedObject<ISharedSegmentSequenceEvents> implements ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver {
     private readonly dataStoreRuntime;
@@ -71,7 +71,6 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      *
      * An application using SharedString which explicitly wants to opt in to allowing reentrancy anyway can set `sharedStringPreventReentrancy`
      * on the data store options to `false`.
-     * @internal
      */
     protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
     private static createOpsFromDelta;
@@ -88,9 +87,19 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * @param start - The inclusive start of the range to remove
      * @param end - The exclusive end of the range to remove
      */
-    removeRange(start: number, end: number): IMergeTreeRemoveMsg;
+    removeRange(start: number, end: number): void;
     /**
-     * @deprecated The ability to create group ops will be removed in an upcoming release, as group ops are redundant with the native batching capabilities of the runtime
+     * Obliterate is similar to remove, but differs in that segments concurrently
+     * inserted into an obliterated range will also be removed
+     *
+     * @param start - The inclusive start of the range to obliterate
+     * @param end - The exclusive end of the range to obliterate
+     */
+    obliterateRange(start: number, end: number): void;
+    /**
+     * @deprecated The ability to create group ops will be removed in an upcoming
+     * release, as group ops are redundant with the native batching capabilities
+     * of the runtime
      */
     groupOperation(groupOp: IMergeTreeGroupMsg): void;
     /**
@@ -118,10 +127,9 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * @param start - The inclusive start position of the range to annotate
      * @param end - The exclusive end position of the range to annotate
      * @param props - The properties to annotate the range with
-     * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.
      *
      */
-    annotateRange(start: number, end: number, props: PropertySet, combiningOp?: ICombiningOp): void;
+    annotateRange(start: number, end: number, props: PropertySet): void;
     getPropertiesAtPosition(pos: number): PropertySet | undefined;
     getRangeExtentsOfPosition(pos: number): {
         posStart: number | undefined;
@@ -159,10 +167,7 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * @param remoteClientId - The client id of the remote client
      */
     resolveRemoteClientPosition(remoteClientPosition: number, remoteClientRefSeq: number, remoteClientId: string): number | undefined;
-    /**
-     * @deprecated This method will no longer be public in an upcoming release as it is not safe to use outside of this class
-     */
-    submitSequenceMessage(message: IMergeTreeOp): void;
+    private submitSequenceMessage;
     /**
      * Given a position specified relative to a marker id, lookup the marker
      * and convert the position to a character position.
@@ -171,22 +176,19 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
     posFromRelativePos(relativePos: IRelativePosition): number;
     /**
      * Walk the underlying segments of the sequence.
-     * The walked segments may extend beyond the range
-     * if the segments cross the ranges start or end boundaries.
-     * Set split range to true to ensure only segments within the
-     * range are walked.
+     * The walked segments may extend beyond the range if the segments cross the
+     * ranges start or end boundaries.
+     *
+     * Set split range to true to ensure only segments within the range are walked.
      *
-     * @param handler - The function to handle each segment
+     * @param handler - The function to handle each segment. Traversal ends if
+     * this function returns true.
      * @param start - Optional. The start of range walk.
      * @param end - Optional. The end of range walk
      * @param accum - Optional. An object that will be passed to the handler for accumulation
      * @param splitRange - Optional. Splits boundary segments on the range boundaries
      */
     walkSegments<TClientData>(handler: ISegmentAction<TClientData>, start?: number, end?: number, accum?: TClientData, splitRange?: boolean): void;
-    /**
-     * @deprecated this functionality is no longer supported and will be removed
-     */
-    getStackContext(startPos: number, rangeLabels: string[]): RangeStackMap;
     /**
      * @returns The most recent sequence number which has been acked by the server and processed by this
      * SharedSegmentSequence.

package/lib/sequence.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sequence.d.ts","sourceRoot":"","sources":["../src/sequence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,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,EACN,MAAM,EAKN,YAAY,EACZ,YAAY,EAGZ,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,sBAAsB,EAGtB,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EAEzB,iBAAiB,EACjB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACN,gBAAgB,EAGhB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,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,aAAa,CAAC;AAC/C,OAAO,EACN,mBAAmB,EAGnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAKvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,OAC/E;IACF,CACC,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAC3E;IACF,CACC,KAAK,EAAE,aAAa,EACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OACjF;CACF;AAED;;GAEG;AACH,8BAAsB,qBAAqB,CAAC,CAAC,SAAS,QAAQ,CAC7D,SAAQ,YAAY,CAAC,4BAA4B,CACjD,YAAW,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,yBAAyB;IAyFhF,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAC1B,EAAE,EAAE,MAAM;aAED,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IA1FlE,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAEhE,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAuDjC,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;IAmDlE;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,mBAAmB;IAInE;;OAEG;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;;;;;;;;OAQG;IACI,aAAa,CACnB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,WAAW,EAClB,WAAW,CAAC,EAAE,YAAY;IAKpB,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;;OAEG;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;;OAEG;IACI,qBAAqB,CAAC,OAAO,EAAE,YAAY;IAmBlD;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIxD;;;;;;;;;;;;OAYG;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;;OAEG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,aAAa;IAI9E;;;OAGG;IACI,aAAa;IAIpB;;;;OAIG;IACI,yBAAyB,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC;IAGnE;;;;OAIG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAKrD;;;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,iBAAiB;IAQzD;;;;;;;;OAQG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ;IAapE;;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;IAgB7D;;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;IA0BzB;;OAEG;IACH,SAAS,CAAC,SAAS;IAQnB;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAK7B;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAI/C,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,mBAAmB;IAyC3B,OAAO,CAAC,+BAA+B;IAYvC,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,6BAA6B;CAuBrC;AA4BD;;GAEG;AACH,wBAAgB,yBAAyB,SAExC"}
+{"version":3,"file":"sequence.d.ts","sourceRoot":"","sources":["../src/sequence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,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,EAGhB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,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,aAAa,CAAC;AAC/C,OAAO,EACN,mBAAmB,EAGnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAKvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IA2GhF,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAC1B,EAAE,EAAE,MAAM;aAED,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IA5GlE,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;IA0EjC,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;IAoDlE;;;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;;OAEG;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;IAmB7B;;;;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,iBAAiB;IAQzD;;;;;;;;OAQG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAa3E;;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;IAgB7D;;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;IA0BzB;;OAEG;IACH,SAAS,CAAC,SAAS;IAQnB;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAK7B;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAI/C,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,mBAAmB;IA0C3B,OAAO,CAAC,+BAA+B;IAYvC,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,6BAA6B;CAuBrC;AA4BD;;GAEG;AACH,wBAAgB,yBAAyB,SAExC"}

package/lib/sequence.js

@@ -1,24 +1,26 @@
+"use strict";
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-/* eslint-disable import/no-deprecated */
-import { assert, Deferred } from "@fluidframework/core-utils";
-import { bufferToString } from "@fluid-internal/client-utils";
-import { LoggingError, createChildLogger } from "@fluidframework/telemetry-utils";
-import { MessageType } from "@fluidframework/protocol-definitions";
-import { Client, createAnnotateRangeOp, createGroupOp, createInsertOp, createRemoveRangeOp, matchProperties, MergeTreeDeltaType, } from "@fluidframework/merge-tree";
-import { ObjectStoragePartition, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
-import { makeHandlesSerializable, parseHandles, SharedObject, } from "@fluidframework/shared-object-base";
-import { DefaultMap } from "./defaultMap";
-import { SequenceIntervalCollectionValueType, } from "./intervalCollection";
-import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetReentrancyLogCounter = exports.SharedSegmentSequence = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const client_utils_1 = require("@fluid-internal/client-utils");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
+const merge_tree_1 = require("@fluidframework/merge-tree");
+const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const shared_object_base_1 = require("@fluidframework/shared-object-base");
+const defaultMap_1 = require("./defaultMap");
+const intervalCollection_1 = require("./intervalCollection");
+const sequenceDeltaEvent_1 = require("./sequenceDeltaEvent");
 const snapshotFileName = "header";
 const contentPath = "content";
 /**
- * @public
+ * @alpha
  */
-export class SharedSegmentSequence extends SharedObject {
+class SharedSegmentSequence extends shared_object_base_1.SharedObject {
     get loaded() {
         return this.loadedDeferred.promise;
     }
@@ -26,7 +28,7 @@ export class SharedSegmentSequence extends SharedObject {
         const ops = [];
         for (const r of event.ranges) {
             switch (event.deltaOperation) {
-                case MergeTreeDeltaType.ANNOTATE: {
+                case merge_tree_1.MergeTreeDeltaType.ANNOTATE: {
                     const lastAnnotate = ops[ops.length - 1];
                     const props = {};
                     for (const key of Object.keys(r.propertyDeltas)) {
@@ -34,25 +36,36 @@ export class SharedSegmentSequence extends SharedObject {
                     }
                     if (lastAnnotate &&
                         lastAnnotate.pos2 === r.position &&
-                        matchProperties(lastAnnotate.props, props)) {
+                        (0, merge_tree_1.matchProperties)(lastAnnotate.props, props)) {
                         lastAnnotate.pos2 += r.segment.cachedLength;
                     }
                     else {
-                        ops.push(createAnnotateRangeOp(r.position, r.position + r.segment.cachedLength, props, undefined));
+                        ops.push((0, merge_tree_1.createAnnotateRangeOp)(r.position, r.position + r.segment.cachedLength, props));
                     }
                     break;
                 }
-                case MergeTreeDeltaType.INSERT:
-                    ops.push(createInsertOp(r.position, r.segment.clone().toJSONObject()));
+                case merge_tree_1.MergeTreeDeltaType.INSERT:
+                    ops.push((0, merge_tree_1.createInsertOp)(r.position, r.segment.clone().toJSONObject()));
                     break;
-                case MergeTreeDeltaType.REMOVE: {
+                case merge_tree_1.MergeTreeDeltaType.REMOVE: {
                     const lastRem = ops[ops.length - 1];
                     if (lastRem?.pos1 === r.position) {
-                        assert(lastRem.pos2 !== undefined, 0x3ff /* pos2 should not be undefined here */);
+                        (0, core_utils_1.assert)(lastRem.pos2 !== undefined, 0x3ff /* pos2 should not be undefined here */);
                         lastRem.pos2 += r.segment.cachedLength;
                     }
                     else {
-                        ops.push(createRemoveRangeOp(r.position, r.position + r.segment.cachedLength));
+                        ops.push((0, merge_tree_1.createRemoveRangeOp)(r.position, r.position + r.segment.cachedLength));
+                    }
+                    break;
+                }
+                case merge_tree_1.MergeTreeDeltaType.OBLITERATE: {
+                    const lastRem = ops[ops.length - 1];
+                    if (lastRem?.pos1 === r.position) {
+                        (0, core_utils_1.assert)(lastRem.pos2 !== undefined, 0x874 /* pos2 should not be undefined here */);
+                        lastRem.pos2 += r.segment.cachedLength;
+                    }
+                    else {
+                        ops.push((0, merge_tree_1.createObliterateRangeOp)(r.position, r.position + r.segment.cachedLength));
                     }
                     break;
                 }
@@ -67,7 +80,7 @@ export class SharedSegmentSequence extends SharedObject {
         this.id = id;
         this.segmentFromSpec = segmentFromSpec;
         /** `Deferred` that triggers once the object is loaded */
-        this.loadedDeferred = new Deferred();
+        this.loadedDeferred = new core_utils_1.Deferred();
         // cache out going ops created when partial loading
         this.loadedDeferredOutgoingOps = [];
         // cache incoming ops that arrive when partial loading
@@ -80,37 +93,50 @@ export class SharedSegmentSequence extends SharedObject {
                 : createReentrancyDetector((depth) => {
                     if (totalReentrancyLogs > 0) {
                         totalReentrancyLogs--;
-                        this.logger.sendTelemetryEvent({ eventName: "LocalOpReentry", depth }, new LoggingError(reentrancyErrorMessage));
+                        this.logger.sendTelemetryEvent({ eventName: "LocalOpReentry", depth }, new telemetry_utils_1.LoggingError(reentrancyErrorMessage));
                     }
                 });
         this.loadedDeferred.promise.catch((error) => {
             this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
         });
-        this.client = new Client(segmentFromSpec, createChildLogger({
+        // eslint-disable-next-line import/no-deprecated
+        this.client = new merge_tree_1.Client(segmentFromSpec, (0, telemetry_utils_1.createChildLogger)({
             logger: this.logger,
             namespace: "SharedSegmentSequence.MergeTreeClient",
         }), dataStoreRuntime.options);
         this.client.prependListener("delta", (opArgs, deltaArgs) => {
-            const event = new SequenceDeltaEvent(opArgs, deltaArgs, this.client);
+            const event = new sequenceDeltaEvent_1.SequenceDeltaEvent(opArgs, deltaArgs, this.client);
             if (opArgs.stashed !== true && event.isLocal) {
                 this.submitSequenceMessage(opArgs.op);
             }
             this.emit("sequenceDelta", event, this);
         });
         this.client.on("maintenance", (args, opArgs) => {
-            this.emit("maintenance", new SequenceMaintenanceEvent(opArgs, args, this.client), this);
+            this.emit("maintenance", new sequenceDeltaEvent_1.SequenceMaintenanceEvent(opArgs, args, this.client), this);
         });
-        this.intervalCollections = new DefaultMap(this.serializer, this.handle, (op, localOpMetadata) => this.submitLocalMessage(op, localOpMetadata), new SequenceIntervalCollectionValueType(), dataStoreRuntime.options);
+        this.intervalCollections = new defaultMap_1.DefaultMap(this.serializer, this.handle, (op, localOpMetadata) => this.submitLocalMessage(op, localOpMetadata), new intervalCollection_1.SequenceIntervalCollectionValueType(), dataStoreRuntime.options);
     }
     /**
      * @param start - The inclusive start of the range to remove
      * @param end - The exclusive end of the range to remove
      */
     removeRange(start, end) {
-        return this.guardReentrancy(() => this.client.removeRangeLocal(start, end));
+        this.guardReentrancy(() => this.client.removeRangeLocal(start, end));
+    }
+    /**
+     * Obliterate is similar to remove, but differs in that segments concurrently
+     * inserted into an obliterated range will also be removed
+     *
+     * @param start - The inclusive start of the range to obliterate
+     * @param end - The exclusive end of the range to obliterate
+     */
+    obliterateRange(start, end) {
+        this.guardReentrancy(() => this.client.obliterateRangeLocal(start, end));
     }
     /**
-     * @deprecated The ability to create group ops will be removed in an upcoming release, as group ops are redundant with the native batching capabilities of the runtime
+     * @deprecated The ability to create group ops will be removed in an upcoming
+     * release, as group ops are redundant with the native batching capabilities
+     * of the runtime
      */
     groupOperation(groupOp) {
         this.guardReentrancy(() => this.client.localTransaction(groupOp));
@@ -143,11 +169,10 @@ export class SharedSegmentSequence extends SharedObject {
      * @param start - The inclusive start position of the range to annotate
      * @param end - The exclusive end position of the range to annotate
      * @param props - The properties to annotate the range with
-     * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.
      *
      */
-    annotateRange(start, end, props, combiningOp) {
-        this.guardReentrancy(() => this.client.annotateRangeLocal(start, end, props, combiningOp));
+    annotateRange(start, end, props) {
+        this.guardReentrancy(() => this.client.annotateRangeLocal(start, end, props));
     }
     getPropertiesAtPosition(pos) {
         return this.client.getPropertiesAtPosition(pos);
@@ -195,18 +220,15 @@ export class SharedSegmentSequence extends SharedObject {
     resolveRemoteClientPosition(remoteClientPosition, remoteClientRefSeq, remoteClientId) {
         return this.client.resolveRemoteClientPosition(remoteClientPosition, remoteClientRefSeq, remoteClientId);
     }
-    /**
-     * @deprecated This method will no longer be public in an upcoming release as it is not safe to use outside of this class
-     */
     submitSequenceMessage(message) {
         if (!this.isAttached()) {
             return;
         }
-        const translated = makeHandlesSerializable(message, this.serializer, this.handle);
-        const metadata = this.client.peekPendingSegmentGroups(message.type === MergeTreeDeltaType.GROUP ? message.ops.length : 1);
+        const translated = (0, shared_object_base_1.makeHandlesSerializable)(message, this.serializer, this.handle);
+        const metadata = this.client.peekPendingSegmentGroups(message.type === merge_tree_1.MergeTreeDeltaType.GROUP ? message.ops.length : 1);
         // if loading isn't complete, we need to cache
         // local ops until loading is complete, and then
-        // they will be resent
+        // they will be present
         if (!this.loadedDeferred.isCompleted) {
             this.loadedDeferredOutgoingOps.push(metadata ? [translated, metadata] : translated);
         }
@@ -224,12 +246,13 @@ export class SharedSegmentSequence extends SharedObject {
     }
     /**
      * Walk the underlying segments of the sequence.
-     * The walked segments may extend beyond the range
-     * if the segments cross the ranges start or end boundaries.
-     * Set split range to true to ensure only segments within the
-     * range are walked.
+     * The walked segments may extend beyond the range if the segments cross the
+     * ranges start or end boundaries.
      *
-     * @param handler - The function to handle each segment
+     * Set split range to true to ensure only segments within the range are walked.
+     *
+     * @param handler - The function to handle each segment. Traversal ends if
+     * this function returns true.
      * @param start - Optional. The start of range walk.
      * @param end - Optional. The end of range walk
      * @param accum - Optional. An object that will be passed to the handler for accumulation
@@ -238,12 +261,6 @@ export class SharedSegmentSequence extends SharedObject {
     walkSegments(handler, start, end, accum, splitRange = false) {
         this.client.walkSegments(handler, start, end, accum, splitRange);
     }
-    /**
-     * @deprecated this functionality is no longer supported and will be removed
-     */
-    getStackContext(startPos, rangeLabels) {
-        return this.client.getStackContext(startPos, rangeLabels);
-    }
     /**
      * @returns The most recent sequence number which has been acked by the server and processed by this
      * SharedSegmentSequence.
@@ -294,7 +311,7 @@ export class SharedSegmentSequence extends SharedObject {
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      */
     summarizeCore(serializer, telemetryContext) {
-        const builder = new SummaryTreeBuilder();
+        const builder = new runtime_utils_1.SummaryTreeBuilder();
         // conditionally write the interval collection blob
         // only if it has entries
         if (this.intervalCollections.size > 0) {
@@ -358,14 +375,14 @@ export class SharedSegmentSequence extends SharedObject {
     async loadCore(storage) {
         if (await storage.contains(snapshotFileName)) {
             const blob = await storage.readBlob(snapshotFileName);
-            const header = bufferToString(blob, "utf8");
+            const header = (0, client_utils_1.bufferToString)(blob, "utf8");
             this.intervalCollections.populate(header);
         }
         try {
             // this will load the header, and return a promise
             // that will resolve when the body is loaded
             // and the catchup ops are available.
-            const { catchupOpsP } = await this.client.load(this.runtime, new ObjectStoragePartition(storage, contentPath), this.serializer);
+            const { catchupOpsP } = await this.client.load(this.runtime, new runtime_utils_1.ObjectStoragePartition(storage, contentPath), this.serializer);
             // setup a promise to process the
             // catch up ops, and finishing the loading process
             const loadCatchUpOps = catchupOpsP
@@ -413,11 +430,11 @@ export class SharedSegmentSequence extends SharedObject {
         // if loading isn't complete, we need to cache all
         // incoming ops to be applied after loading is complete
         if (this.deferIncomingOps) {
-            assert(!local, 0x072 /* "Unexpected local op when loading not finished" */);
+            (0, core_utils_1.assert)(!local, 0x072 /* "Unexpected local op when loading not finished" */);
             this.loadedDeferredIncomingOps.push(message);
         }
         else {
-            assert(message.type === MessageType.Operation, 0x073 /* "Sequence message not operation" */);
+            (0, core_utils_1.assert)(message.type === protocol_definitions_1.MessageType.Operation, 0x073 /* "Sequence message not operation" */);
             const handled = this.intervalCollections.tryProcessMessage(message.contents, local, message, localOpMetadata);
             if (!handled) {
                 this.processMergeTreeMsg(message, local);
@@ -445,11 +462,11 @@ export class SharedSegmentSequence extends SharedObject {
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
      */
     applyStashedOp(content) {
-        return this.client.applyStashedOp(parseHandles(content, this.serializer));
+        return this.client.applyStashedOp((0, shared_object_base_1.parseHandles)(content, this.serializer));
     }
     summarizeMergeTree(serializer) {
         // Are we fully loaded? If not, things will go south
-        assert(this.loadedDeferred.isCompleted, 0x074 /* "Snapshot called when not fully loaded" */);
+        (0, core_utils_1.assert)(this.loadedDeferred.isCompleted, 0x074 /* "Snapshot called when not fully loaded" */);
         const minSeq = this.runtime.deltaManager.minimumSequenceNumber;
         this.processMinSequenceNumberChanged(minSeq);
         this.messagesSinceMSNChange.forEach((m) => {
@@ -458,7 +475,7 @@ export class SharedSegmentSequence extends SharedObject {
         return this.client.summarize(this.runtime, this.handle, serializer, this.messagesSinceMSNChange);
     }
     processMergeTreeMsg(rawMessage, local) {
-        const message = parseHandles(rawMessage, this.serializer);
+        const message = (0, shared_object_base_1.parseHandles)(rawMessage, this.serializer);
         const ops = [];
         function transformOps(event) {
             ops.push(...SharedSegmentSequence.createOpsFromDelta(event));
@@ -479,7 +496,8 @@ export class SharedSegmentSequence extends SharedObject {
                 stashMessage = {
                     ...message,
                     referenceSequenceNumber: stashMessage.sequenceNumber - 1,
-                    contents: ops.length !== 1 ? createGroupOp(...ops) : ops[0],
+                    // eslint-disable-next-line import/no-deprecated
+                    contents: ops.length !== 1 ? (0, merge_tree_1.createGroupOp)(...ops) : ops[0],
                 };
             }
             this.messagesSinceMSNChange.push(stashMessage);
@@ -535,7 +553,7 @@ export class SharedSegmentSequence extends SharedObject {
             if (!intervalCollection.attached) {
                 intervalCollection.attachGraph(this.client, key);
             }
-            assert(previousValue === undefined, 0x2c1 /* "Creating an interval collection that already exists?" */);
+            (0, core_utils_1.assert)(previousValue === undefined, 0x2c1 /* "Creating an interval collection that already exists?" */);
             this.emit("createIntervalCollection", key, local, this);
         });
         // Initialize existing SharedIntervalCollections
@@ -545,6 +563,7 @@ export class SharedSegmentSequence extends SharedObject {
         }
     }
 }
+exports.SharedSegmentSequence = SharedSegmentSequence;
 function createReentrancyDetector(onReentrancy) {
     let depth = 0;
     function detectReentrancy(callback) {
@@ -570,11 +589,12 @@ let totalReentrancyLogs = 3;
 /**
  * Resets the reentrancy log counter. Test-only API.
  */
-export function resetReentrancyLogCounter() {
+function resetReentrancyLogCounter() {
     totalReentrancyLogs = 3;
 }
+exports.resetReentrancyLogCounter = resetReentrancyLogCounter;
 const reentrancyErrorMessage = "Reentrancy detected in sequence local ops";
 const ensureNoReentrancy = createReentrancyDetector(() => {
-    throw new LoggingError(reentrancyErrorMessage);
+    throw new telemetry_utils_1.LoggingError(reentrancyErrorMessage);
 });
 //# sourceMappingURL=sequence.js.map