@fluidframework/merge-tree 0.59.4000 → 1.0.1

package/.eslintrc.js

@@ -5,7 +5,7 @@
 
 module.exports = {
     "extends": [
-        "@fluidframework/eslint-config-fluid"
+        require.resolve("@fluidframework/eslint-config-fluid")
     ],
     "parserOptions": {
         "project": ["./tsconfig.json", "./src/test/tsconfig.json"]

package/README.md

@@ -89,7 +89,7 @@ A segment was inserted and/or removed on the remote client at the time client se
 
 * The referenced sequence number is greater than or equal the server-assigned sequence number of the operation
   that inserted/removed the segment.
-* The client sent the operation that resulted in insertion/removal. (In which case, the client hadn't yet recieved
+* The client sent the operation that resulted in insertion/removal. (In which case, the client hadn't yet received
   their sequenced op from the server but was aware of the insertion/removal because the client produced it locally.)
 
 If both above conditions are false, then the insertion/removal happened "after" the remote operation, and

package/REFERENCEPOSITIONS.md

@@ -0,0 +1,127 @@
+# ReferencePosition Documentation
+
+ReferencePositions are used to indicates a MergeTree position which is stable as operations are performed. There are two
+types:
+
+1. LocalReferences refer to a segment and offset within that segment
+2. Markers are actual segments in the Merge Tree
+
+The function `Client.localReferencePositionToPosition` returns the numerical position of a reference in the client's
+current view.
+
+## LocalReference behavior on Remove
+
+By default, LocalReferences become detached when the segment they reference is removed.
+The ReferenceTypes SlideOnRemove, StayOnRemove, and Transient change this behavior.
+They are only valid for LocalReferences.
+They are exclusive - a reference may be at most one of these types.
+
+### SlideOnRemove
+
+The reference will slide to the next farthest segment when the segment is removed and the remove has been acknowledged.
+Sliding will look for the next valid segment.
+A valid segment is one whose creation has been acknowledged and either hasn't been removed
+or the remove is pending (not acknowledged).
+If a farther segment is found, then the LocalReference will be changed to refer to that segment and have offset 0.
+In the event that the slide is happening on the acknowledgement of a remove, the slide to a farther segment will not
+change the numerical position of the reference.
+If there is no there is no valid segment farther in the tree, then the slide will place the reference on the last valid segment.
+The offset will be set to the last position in that segment.
+In the event that the slide is happening on the acknowledgement of a remove, the reference would have been on the removed
+segment. This slide from the removed segment to a nearer segment does change the numerical position of the reference.
+If there is no valid position (all segments removed and acknowledged) then the reference is detached.
+
+### StayOnRemove
+
+The reference will stay on removed segments.
+This behavior is only defined until the removed segment is cleaned up by Zamboni.
+This is intended to be used only while collaborating (see below) while waiting for an acknowledgement.
+
+### Transient
+
+The reference is not tracked by the MergeTree.
+It will continue to reference removed segments.
+This behavior is only defined until the removed segment is cleaned up by Zamboni.
+This is intended to be used to create transient references which may be compared with other references.
+
+### Detached LocalReferences
+
+A detached LocalReference does not reference a segment in the MergeTree.
+It's position is defined to be `LocalReference.DetachedPosition` (-1).
+
+### LocalReferences on Removed Segments
+
+LocalReferences may reference removed segments:
+
+* SlideOnRemove references may reference a removed segment which is pending (not acknoweldged)
+* StayOnRemove references may reference removed segments
+* Transient references may reference removed segments
+
+The numerical position of a reference which is on a removed segment will be one more than the previous (nearer) segment.
+If there is a farther segment that is not removed, this will be the same as the position of the start of that segment.
+If there is no farther segment, then the reference position will be the length of the tree (one more than the last valid
+position in the tree).
+
+## Eventually Consistent References
+
+Markers are segments in the MergeTree and are eventually consistent.
+LocalReferences may be used as part of an eventually consistent feature.
+For example, SharedIntervals are built using LocalReferences.
+
+### Implementing Eventually Consistent LocalReferences
+
+To implement an operation which creates LocalReferences which will be have an eventually consistent position:
+
+1. Locally create the reference as StayOnRemove
+2. Send the reference numerical position in an op
+3. On acknowledgement of the local create:
+   1. set the `refType` of the reference to include `SlideOnRemove`
+   2. call `Client.getSlideToSegment` with the references current segment and offset to get the proper new location
+   3. Delete the old reference and create a new one with the returned values
+4. Remote clients, on receiving the op, call `Client.getContainingSegment` followed by `Client.getSlideToSegment`
+on the result. Call `Client.createLocalReferencePosition` with the result to create a `SlideOnRemove` reference.
+
+### Implementation Notes
+
+This algorithm works because it ensures that slid reference slide to the same segment.
+The slide only happens when both the creation of the reference and removal of the segment have been acknowledged.
+When sliding we do not consider any local (unacknowledged) ops.
+
+Keeping references on removed segments until they can be slid works well in most cases because of these properties:
+
+1. Interval positions on removed segments appear as if they were on the following position in the string.
+If the removed segment is between positions 5 and 6, the interval positions on the removed segment appear to be at
+position 6. This matches where they will eventually slide, so slide will not cause a change in position as long as
+segments are not slid over and it is not necessary to slide to the near end of the string.
+2. Text inserted at the same location as the removed segment is inserted before the removed segment.
+So if the removed segment is between 0 and 1 (“A[removed]B”), insertText(1, “X”) inserts before the removed segment
+(“AX[removed]B”). This makes it hard to end up with local only segments to be slid over, which will mean it is rare
+that slide visibly changes the interval position. It can still happen if there is a conflicting remove, but that is
+much less likely.
+
+#### Conflict Scenarios
+
+Considering Create Interval / Remove Range conflicts, here are the scenarios
+(before indicates the relative sequence order):
+
+1. Local create before local remove. Interval position needs to slide on ack of the local remove.
+2. Remote create before remote remove. Slide on receiving the remove.
+3. Local remove before local create. This is impossible – once the segment is removed locally an
+interval position can’t be created on it.
+4. Remote remove before remote create. (Possible if ops are from different remote clients).
+Slide on receiving the remote create.
+5. Remote create before local remove. Slide on the ack of the local remove.
+6. Local create before remote remove. Slide on receiving the remove.
+7. Local remove before remote create. Slide on receiving the create.
+8. Remote remove before local create. Slide on receiving the ack of the create.
+
+## Tests
+
+* `packages\dds\merge-tree\src\test\client.localReference.spec.ts`
+unit tests for LocalReferences
+* `packages\dds\sequence\src\test\intervalCollection.spec.ts`
+test LocalReferences as used in interval collections (including eventual consistency)
+* `packages\test\test-end-to-end-tests\src\test\sharedInterval.spec.ts`
+end-to-end tests using LocalReferences for interval collections.
+These tests have only been minimally updated to reflect this implementation,
+so they do not comprehensively test LocalReferences.

package/dist/client.d.ts

@@ -152,6 +152,11 @@ export declare class Client {
      * @param clientArgs - The client args for the op
      */
     private getValidOpRange;
+    /**
+     * Gets the client args from the op if remote, otherwise uses the local clients info
+     * @param sequencedMessage - The sequencedMessage to get the client sequence args for
+     */
+    private getClientSequenceArgsForMessage;
     /**
      * Gets the client args from the op if remote, otherwise uses the local clients info
      * @param opArgs - The op arg to get the client sequence args for
@@ -210,6 +215,18 @@ export declare class Client {
         segment: T | undefined;
         offset: number | undefined;
     };
+    /**
+     * Returns the position to slide a reference to if a slide is required.
+     * @param segoff - The segment and offset to slide from
+     * @returns - segment and offset to slide the reference to
+     */
+    getSlideToSegment(segoff: {
+        segment: ISegment | undefined;
+        offset: number | undefined;
+    }): {
+        segment: ISegment | undefined;
+        offset: number | undefined;
+    };
     getPropertiesAtPosition(pos: number): PropertySet | undefined;
     getRangeExtentsOfPosition(pos: number): {
         posStart: number | undefined;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AACvG,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAMtE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACH,mBAAmB,EAGnB,QAAQ,EACR,cAAc,EACd,MAAM,EACN,SAAS,EACT,YAAY,EACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAQlE,OAAO,EACH,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,EAEjB,aAAa,EAChB,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAA6B,MAAM,sBAAsB,CAAC;AACnG,OAAO,EAGH,4BAA4B,EAC/B,MAAM,SAAS,CAAC;AAMjB,qBAAa,MAAM;aAgCK,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;aAC/C,MAAM,EAAE,gBAAgB;IAhCrC,UAAU,UAAS;IACnB,SAAS,SAAK;IACd,SAAS,SAAK;IACd,QAAQ,SAAK;IACb,eAAe,SAAK;IACpB,WAAW,SAAK;IAChB,QAAQ,SAAK;IACb,aAAa,SAAK;IAClB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,IAAI,sBAAsB,IAAI,sBAAsB,GAAG,SAAS,CAAkD;IAClH,IAAI,sBAAsB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,SAAS,EAEtE;IAED,IAAI,4BAA4B,IAAI,4BAA4B,GAAG,SAAS,CAE3E;IAED,IAAI,4BAA4B,CAAC,QAAQ,EAAE,4BAA4B,GAAG,SAAS,EAElF;IAED,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAExC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAoD;IACpF,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqC;gBAIlD,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ,EAC/C,MAAM,EAAE,gBAAgB,EACxC,OAAO,CAAC,EAAE,WAAW;IAKzB;;;;;;OAMG;IACI,wBAAwB,CAAC,KAAK,GAAE,MAAU;IAcjD;;;;;;OAMG;IACI,6BAA6B,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,WAAW,EAClB,iBAAiB,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,qBAAqB,GAAG,SAAS;IAmB9E;;;;;;OAMG;IACI,cAAc,CACjB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,WAAW,EAClB,WAAW,CAAC,EAAE,YAAY,GAAG,qBAAqB,GAAG,SAAS;IAUlE;;;;;;;OAOG;IACI,kBAAkB,CACrB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,YAAY,GAAG,SAAS,GAAG,qBAAqB,GAAG,SAAS;IAa7E;;;;;OAKG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IASlD;;;OAGG;IACI,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,mBAAmB,GAAG,SAAS;IAW1F;;;OAGG;IACI,8BAA8B,CACjC,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,QAAQ,GAClB,mBAAmB,GAAG,SAAS;IAiC3B,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,EACjE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI;IAChG,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAC7D,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI;IAYhF;;;;OAIG;IACI,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,GAAG,IAAI;IAezF,eAAe,IAAI,mBAAmB;IAI7C;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,MAAM;IAM7C;;OAEG;IACI,iBAAiB,CAAC,IAAI,EAAE,cAAc;IAI7C;;OAEG;IACI,oBAAoB,CAAC,IAAI,EAAE,cAAc;IAIzC,4BAA4B,CAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,GAAG,SAAS,GAC/F,iBAAiB;IAIb,4BAA4B,CAAC,IAAI,EAAE,iBAAiB;IAIpD,gCAAgC,CAAC,IAAI,EAAE,iBAAiB;IAQ/D;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIjD,eAAe,CAAC,EAAE,EAAE,MAAM;IAIjC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IA4B1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IA8B5B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAqCrB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAiEvB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,iBAAiB;IAoCzB,iBAAiB;IAOjB,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAM1C,gBAAgB,CAAC,YAAY,EAAE,MAAM;IAGrC,eAAe,CAAC,aAAa,EAAE,MAAM;IAOrC,eAAe,CAAC,YAAY,EAAE,MAAM;IAKpC;;;;;;;;OAQG;IACH,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM;IAkCtE,OAAO,CAAC,sBAAsB;IAmE9B,OAAO,CAAC,aAAa;IA6Bd,cAAc,CAAC,EAAE,EAAE,iBAAiB,GAAG,YAAY;IACnD,cAAc,CAAC,EAAE,EAAE,kBAAkB,GAAG,YAAY,EAAE;IACtD,cAAc,CAAC,EAAE,EAAE,YAAY,GAAG,YAAY,GAAG,YAAY,EAAE;IAyB/D,QAAQ,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,GAAE,OAAe;IAmB/D,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAUhD;;;;;;;OAOG;IACI,2BAA2B,CAC9B,oBAAoB,EAAE,MAAM,EAC5B,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAQ/C;;;;;OAKG;IACI,mBAAmB,CACtB,OAAO,EAAE,YAAY,EACrB,YAAY,EAAE,YAAY,GAAG,YAAY,EAAE,GAC5C,YAAY;IA6BR,gBAAgB;IAIhB,SAAS,CACZ,OAAO,EAAE,sBAAsB,EAC/B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,gBAAgB,EAC5B,WAAW,EAAE,yBAAyB,EAAE,GACzC,qBAAqB;IA+BX,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,gBAAgB,GAC7B,OAAO,CAAC;QAAE,WAAW,EAAE,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;KAAE,CAAC;IAMlE,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,aAAa;IAIvE,OAAO,CAAC,sBAAsB;IAQ9B,gBAAgB,CAAC,OAAO,EAAE,kBAAkB;IAqB5C,uBAAuB,CAAC,EAAE,EAAE,qBAAqB,EAAE,GAAG,EAAE,yBAAyB;IASjF,YAAY,CAAC,MAAM,EAAE,MAAM;IAe3B,oBAAoB,CAAC,CAAC,SAAS,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,yBAAyB;;;;IAcpF,uBAAuB,CAAC,GAAG,EAAE,MAAM;IASnC,yBAAyB,CAAC,GAAG,EAAE,MAAM;;;;IAYrC,aAAa;IAGb,WAAW;IAIX,SAAS;IAET,0BAA0B,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,SAAI,EAAE,UAAU,SAAI;IAsBvF,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,UAAO;;;;CAIjE"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AACvG,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAMtE,OAAO,EAAE,cAAc,EAA0B,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EACH,mBAAmB,EAGnB,QAAQ,EACR,cAAc,EACd,MAAM,EACN,SAAS,EACT,YAAY,EACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAQlE,OAAO,EACH,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,EAEjB,aAAa,EAChB,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAA6B,MAAM,sBAAsB,CAAC;AACnG,OAAO,EAGH,4BAA4B,EAC/B,MAAM,SAAS,CAAC;AAMjB,qBAAa,MAAM;aAgCK,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;aAC/C,MAAM,EAAE,gBAAgB;IAhCrC,UAAU,UAAS;IACnB,SAAS,SAAK;IACd,SAAS,SAAK;IACd,QAAQ,SAAK;IACb,eAAe,SAAK;IACpB,WAAW,SAAK;IAChB,QAAQ,SAAK;IACb,aAAa,SAAK;IAClB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,IAAI,sBAAsB,IAAI,sBAAsB,GAAG,SAAS,CAAkD;IAClH,IAAI,sBAAsB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,SAAS,EAEtE;IAED,IAAI,4BAA4B,IAAI,4BAA4B,GAAG,SAAS,CAE3E;IAED,IAAI,4BAA4B,CAAC,QAAQ,EAAE,4BAA4B,GAAG,SAAS,EAElF;IAED,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAExC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAoD;IACpF,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqC;gBAIlD,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ,EAC/C,MAAM,EAAE,gBAAgB,EACxC,OAAO,CAAC,EAAE,WAAW;IAKzB;;;;;;OAMG;IACI,wBAAwB,CAAC,KAAK,GAAE,MAAU;IAcjD;;;;;;OAMG;IACI,6BAA6B,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,WAAW,EAClB,iBAAiB,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,qBAAqB,GAAG,SAAS;IAmB9E;;;;;;OAMG;IACI,cAAc,CACjB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,WAAW,EAClB,WAAW,CAAC,EAAE,YAAY,GAAG,qBAAqB,GAAG,SAAS;IAUlE;;;;;;;OAOG;IACI,kBAAkB,CACrB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,YAAY,GAAG,SAAS,GAAG,qBAAqB,GAAG,SAAS;IAa7E;;;;;OAKG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IASlD;;;OAGG;IACI,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,mBAAmB,GAAG,SAAS;IAW1F;;;OAGG;IACI,8BAA8B,CACjC,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,QAAQ,GAClB,mBAAmB,GAAG,SAAS;IAiC3B,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,EACjE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI;IAChG,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAC7D,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI;IAYhF;;;;OAIG;IACI,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,GAAG,IAAI;IAezF,eAAe,IAAI,mBAAmB;IAI7C;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,MAAM;IAM7C;;OAEG;IACI,iBAAiB,CAAC,IAAI,EAAE,cAAc;IAI7C;;OAEG;IACI,oBAAoB,CAAC,IAAI,EAAE,cAAc;IAIzC,4BAA4B,CAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,GAAG,SAAS,GAC/F,iBAAiB;IAIb,4BAA4B,CAAC,IAAI,EAAE,iBAAiB;IAIpD,gCAAgC,CAAC,IAAI,EAAE,iBAAiB;IAQ/D;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIjD,eAAe,CAAC,EAAE,EAAE,MAAM;IAIjC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IA4B1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IA8B5B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAqCrB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAiEvB;;;OAGG;IACF,OAAO,CAAC,+BAA+B;IAqBxC;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,iBAAiB;IAoCzB,iBAAiB;IAOjB,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAM1C,gBAAgB,CAAC,YAAY,EAAE,MAAM;IAGrC,eAAe,CAAC,aAAa,EAAE,MAAM;IAOrC,eAAe,CAAC,YAAY,EAAE,MAAM;IAKpC;;;;;;;;OAQG;IACH,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM;IAkCtE,OAAO,CAAC,sBAAsB;IAmE9B,OAAO,CAAC,aAAa;IA6Bd,cAAc,CAAC,EAAE,EAAE,iBAAiB,GAAG,YAAY;IACnD,cAAc,CAAC,EAAE,EAAE,kBAAkB,GAAG,YAAY,EAAE;IACtD,cAAc,CAAC,EAAE,EAAE,YAAY,GAAG,YAAY,GAAG,YAAY,EAAE;IAyB/D,QAAQ,CAAC,GAAG,EAAE,yBAAyB,EAAE,KAAK,GAAE,OAAe;IAmB/D,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAUhD;;;;;;;OAOG;IACI,2BAA2B,CAC9B,oBAAoB,EAAE,MAAM,EAC5B,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAQ/C;;;;;OAKG;IACI,mBAAmB,CACtB,OAAO,EAAE,YAAY,EACrB,YAAY,EAAE,YAAY,GAAG,YAAY,EAAE,GAC5C,YAAY;IA6BR,gBAAgB;IAIhB,SAAS,CACZ,OAAO,EAAE,sBAAsB,EAC/B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,gBAAgB,EAC5B,WAAW,EAAE,yBAAyB,EAAE,GACzC,qBAAqB;IA+BX,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,gBAAgB,GAC7B,OAAO,CAAC;QAAE,WAAW,EAAE,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;KAAE,CAAC;IAMlE,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,aAAa;IAIvE,OAAO,CAAC,sBAAsB;IAQ9B,gBAAgB,CAAC,OAAO,EAAE,kBAAkB;IAqB5C,uBAAuB,CAAC,EAAE,EAAE,qBAAqB,EAAE,GAAG,EAAE,yBAAyB;IASjF,YAAY,CAAC,MAAM,EAAE,MAAM;IAe3B,oBAAoB,CAAC,CAAC,SAAS,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,yBAAyB;;;;IAKpF;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;KAAE;;;;IAIxF,uBAAuB,CAAC,GAAG,EAAE,MAAM;IASnC,yBAAyB,CAAC,GAAG,EAAE,MAAM;;;;IAYrC,aAAa;IAGb,WAAW;IAIX,SAAS;IAET,0BAA0B,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,SAAI,EAAE,UAAU,SAAI;IAsBvF,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,UAAO;;;;CAIjE"}

package/dist/client.js

@@ -13,6 +13,7 @@ const constants_1 = require("./constants");
 const localReference_1 = require("./localReference");
 const mergeTree_1 = require("./mergeTree");
 const opBuilder_1 = require("./opBuilder");
+const ops_1 = require("./ops");
 const snapshotlegacy_1 = require("./snapshotlegacy");
 const snapshotLoader_1 = require("./snapshotLoader");
 const textSegment_1 = require("./textSegment");
@@ -247,7 +248,7 @@ class Client {
      * @returns True if the remove was applied. False if it could not be.
      */
     applyRemoveRangeOp(opArgs) {
-        (0, common_utils_1.assert)(opArgs.op.type === 1 /* REMOVE */, 0x02d /* "Unexpected op type on range remove!" */);
+        (0, common_utils_1.assert)(opArgs.op.type === ops_1.MergeTreeDeltaType.REMOVE, 0x02d /* "Unexpected op type on range remove!" */);
         const op = opArgs.op;
         const clientArgs = this.getClientSequenceArgs(opArgs);
         const range = this.getValidOpRange(op, clientArgs);
@@ -268,7 +269,7 @@ class Client {
      * @returns True if the annotate was applied. False if it could not be.
      */
     applyAnnotateRangeOp(opArgs) {
-        (0, common_utils_1.assert)(opArgs.op.type === 2 /* ANNOTATE */, 0x02e /* "Unexpected op type on range annotate!" */);
+        (0, common_utils_1.assert)(opArgs.op.type === ops_1.MergeTreeDeltaType.ANNOTATE, 0x02e /* "Unexpected op type on range annotate!" */);
         const op = opArgs.op;
         const clientArgs = this.getClientSequenceArgs(opArgs);
         const range = this.getValidOpRange(op, clientArgs);
@@ -289,7 +290,7 @@ class Client {
      * @returns True if the insert was applied. False if it could not be.
      */
     applyInsertOp(opArgs) {
-        (0, common_utils_1.assert)(opArgs.op.type === 0 /* INSERT */, 0x02f /* "Unexpected op type on range insert!" */);
+        (0, common_utils_1.assert)(opArgs.op.type === ops_1.MergeTreeDeltaType.INSERT, 0x02f /* "Unexpected op type on range insert!" */);
         const op = opArgs.op;
         const clientArgs = this.getClientSequenceArgs(opArgs);
         const range = this.getValidOpRange(op, clientArgs);
@@ -358,12 +359,12 @@ class Client {
             if (start === undefined
                 || start < 0
                 || start > length
-                || start === length && op.type !== 0 /* INSERT */) {
+                || start === length && op.type !== ops_1.MergeTreeDeltaType.INSERT) {
                 invalidPositions.push("start");
             }
             // Validate end if not insert, or insert has end
             //
-            if (op.type !== 0 /* INSERT */ || end !== undefined) {
+            if (op.type !== ops_1.MergeTreeDeltaType.INSERT || end !== undefined) {
                 if (end === undefined || end <= start) {
                     invalidPositions.push("end");
                 }
@@ -389,13 +390,13 @@ class Client {
     }
     /**
      * Gets the client args from the op if remote, otherwise uses the local clients info
-     * @param opArgs - The op arg to get the client sequence args for
+     * @param sequencedMessage - The sequencedMessage to get the client sequence args for
      */
-    getClientSequenceArgs(opArgs) {
+    getClientSequenceArgsForMessage(sequencedMessage) {
         // If there this no sequenced message, then the op is local
         // and unacked, so use this clients sequenced args
         //
-        if (!opArgs.sequencedMessage) {
+        if (!sequencedMessage) {
             const segWindow = this.getCollabWindow();
             return {
                 clientId: segWindow.clientId,
@@ -405,12 +406,19 @@ class Client {
         }
         else {
             return {
-                clientId: this.getShortClientId(opArgs.sequencedMessage.clientId),
-                referenceSequenceNumber: opArgs.sequencedMessage.referenceSequenceNumber,
-                sequenceNumber: opArgs.sequencedMessage.sequenceNumber,
+                clientId: this.getOrAddShortClientId(sequencedMessage.clientId),
+                referenceSequenceNumber: sequencedMessage.referenceSequenceNumber,
+                sequenceNumber: sequencedMessage.sequenceNumber,
             };
         }
     }
+    /**
+     * Gets the client args from the op if remote, otherwise uses the local clients info
+     * @param opArgs - The op arg to get the client sequence args for
+     */
+    getClientSequenceArgs(opArgs) {
+        return this.getClientSequenceArgsForMessage(opArgs.sequencedMessage);
+    }
     ackPendingSegment(opArgs) {
         const ackOp = (deltaOpArgs) => {
             let trace;
@@ -418,7 +426,7 @@ class Client {
                 trace = common_utils_1.Trace.start();
             }
             this.mergeTree.ackPendingSegment(deltaOpArgs);
-            if (deltaOpArgs.op.type === 2 /* ANNOTATE */) {
+            if (deltaOpArgs.op.type === ops_1.MergeTreeDeltaType.ANNOTATE) {
                 if (deltaOpArgs.op.combiningOp && (deltaOpArgs.op.combiningOp.name === "consensus")) {
                     this.updateConsensusProperty(deltaOpArgs.op, deltaOpArgs.sequencedMessage);
                 }
@@ -429,7 +437,7 @@ class Client {
                 this.accumWindow += (this.getCurrentSeq() - this.getCollabWindow().minSeq);
             }
         };
-        if (opArgs.op.type === 3 /* GROUP */) {
+        if (opArgs.op.type === ops_1.MergeTreeDeltaType.GROUP) {
             for (const memberOp of opArgs.op.ops) {
                 ackOp({
                     groupOp: opArgs.op,
@@ -527,7 +535,7 @@ class Client {
             const segmentPosition = this.findReconnectionPosition(segment, segmentGroup.localSeq);
             let newOp;
             switch (resetOp.type) {
-                case 2 /* ANNOTATE */:
+                case ops_1.MergeTreeDeltaType.ANNOTATE:
                     (0, common_utils_1.assert)(((_b = segment.propertyManager) === null || _b === void 0 ? void 0 : _b.hasPendingProperties()) === true, 0x036 /* "Segment has no pending properties" */);
                     // if the segment has been removed, there's no need to send the annotate op
                     // unless the remove was local, in which case the annotate must have come
@@ -536,11 +544,11 @@ class Client {
                         newOp = (0, opBuilder_1.createAnnotateRangeOp)(segmentPosition, segmentPosition + segment.cachedLength, resetOp.props, resetOp.combiningOp);
                     }
                     break;
-                case 0 /* INSERT */:
+                case ops_1.MergeTreeDeltaType.INSERT:
                     (0, common_utils_1.assert)(segment.seq === constants_1.UnassignedSequenceNumber, 0x037 /* "Segment already has assigned sequence number" */);
                     newOp = (0, opBuilder_1.createInsertSegmentOp)(segmentPosition, segment);
                     break;
-                case 1 /* REMOVE */:
+                case ops_1.MergeTreeDeltaType.REMOVE:
                     if (segment.localRemovedSeq !== undefined) {
                         newOp = (0, opBuilder_1.createRemoveRangeOp)(segmentPosition, segmentPosition + segment.cachedLength);
                     }
@@ -562,16 +570,16 @@ class Client {
         const msg = opArgs.sequencedMessage;
         this.getOrAddShortClientId(msg.clientId);
         switch (op.type) {
-            case 0 /* INSERT */:
+            case ops_1.MergeTreeDeltaType.INSERT:
                 this.applyInsertOp(opArgs);
                 break;
-            case 1 /* REMOVE */:
+            case ops_1.MergeTreeDeltaType.REMOVE:
                 this.applyRemoveRangeOp(opArgs);
                 break;
-            case 2 /* ANNOTATE */:
+            case ops_1.MergeTreeDeltaType.ANNOTATE:
                 this.applyAnnotateRangeOp(opArgs);
                 break;
-            case 3 /* GROUP */: {
+            case ops_1.MergeTreeDeltaType.GROUP: {
                 for (const memberOp of op.ops) {
                     this.applyRemoteOp({
                         op: memberOp,
@@ -588,19 +596,19 @@ class Client {
     applyStashedOp(op) {
         let metadata;
         switch (op.type) {
-            case 0 /* INSERT */:
+            case ops_1.MergeTreeDeltaType.INSERT:
                 this.applyInsertOp({ op });
                 metadata = this.peekPendingSegmentGroups();
                 break;
-            case 1 /* REMOVE */:
+            case ops_1.MergeTreeDeltaType.REMOVE:
                 this.applyRemoveRangeOp({ op });
                 metadata = this.peekPendingSegmentGroups();
                 break;
-            case 2 /* ANNOTATE */:
+            case ops_1.MergeTreeDeltaType.ANNOTATE:
                 this.applyAnnotateRangeOp({ op });
                 metadata = this.peekPendingSegmentGroups();
                 break;
-            case 3 /* GROUP */:
+            case ops_1.MergeTreeDeltaType.GROUP:
                 return op.ops.map((o) => this.applyStashedOp(o));
             default:
                 (0, common_utils_1.unreachableCase)(op, "unrecognized op type");
@@ -655,7 +663,7 @@ class Client {
      */
     regeneratePendingOp(resetOp, segmentGroup) {
         const opList = [];
-        if (resetOp.type === 3 /* GROUP */) {
+        if (resetOp.type === ops_1.MergeTreeDeltaType.GROUP) {
             if (Array.isArray(segmentGroup)) {
                 (0, common_utils_1.assert)(resetOp.ops.length === segmentGroup.length, 0x03a /* "Number of ops in 'resetOp' must match the number of segment groups provided." */);
                 for (let i = 0; i < resetOp.ops.length; i++) {
@@ -670,7 +678,7 @@ class Client {
             }
         }
         else {
-            (0, common_utils_1.assert)(resetOp.type !== 3 /* GROUP */, 0x03c /* "Reset op has 'group' delta type!" */);
+            (0, common_utils_1.assert)(resetOp.type !== ops_1.MergeTreeDeltaType.GROUP, 0x03c /* "Reset op has 'group' delta type!" */);
             (0, common_utils_1.assert)(!Array.isArray(segmentGroup), 0x03d /* "segmentGroup is array rather than singleton!" */);
             opList.push(...this.resetPendingDeltaToOps(resetOp, segmentGroup));
         }
@@ -727,13 +735,13 @@ class Client {
                 groupOp,
             };
             switch (op.type) {
-                case 0 /* INSERT */:
+                case ops_1.MergeTreeDeltaType.INSERT:
                     this.applyInsertOp(opArgs);
                     break;
-                case 2 /* ANNOTATE */:
+                case ops_1.MergeTreeDeltaType.ANNOTATE:
                     this.applyAnnotateRangeOp(opArgs);
                     break;
-                case 1 /* REMOVE */:
+                case ops_1.MergeTreeDeltaType.REMOVE:
                     this.applyRemoveRangeOp(opArgs);
                     break;
                 default:
@@ -764,18 +772,16 @@ class Client {
         }
     }
     getContainingSegment(pos, op) {
-        let seq;
-        let clientId;
-        if (op) {
-            clientId = this.getOrAddShortClientId(op.clientId);
-            seq = op.referenceSequenceNumber;
-        }
-        else {
-            const segWindow = this.mergeTree.getCollabWindow();
-            seq = segWindow.currentSeq;
-            clientId = segWindow.clientId;
-        }
-        return this.mergeTree.getContainingSegment(pos, seq, clientId);
+        const args = this.getClientSequenceArgsForMessage(op);
+        return this.mergeTree.getContainingSegment(pos, args.referenceSequenceNumber, args.clientId);
+    }
+    /**
+     * Returns the position to slide a reference to if a slide is required.
+     * @param segoff - The segment and offset to slide from
+     * @returns - segment and offset to slide the reference to
+     */
+    getSlideToSegment(segoff) {
+        return this.mergeTree._getSlideToSegment(segoff);
     }
     getPropertiesAtPosition(pos) {
         let propertiesAtPosition;