@fluidframework/merge-tree 2.0.0-internal.2.4.0 → 2.0.0-internal.3.0.1

package/dist/client.d.ts

@@ -7,31 +7,32 @@ import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
 import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import type { IEventThisPlaceHolder, ITelemetryLogger } from "@fluidframework/common-definitions";
+import { TypedEventEmitter } from "@fluidframework/common-utils";
 import { LocalReferencePosition } from "./localReference";
 import { CollaborationWindow, ISegment, ISegmentAction, Marker, SegmentGroup } from "./mergeTreeNodes";
-import { MergeTreeDeltaCallback } from "./mergeTreeDeltaCallback";
+import { IMergeTreeDeltaCallbackArgs, IMergeTreeMaintenanceCallbackArgs } from "./mergeTreeDeltaCallback";
 import { ICombiningOp, IJSONSegment, IMergeTreeAnnotateMsg, IMergeTreeDeltaOp, IMergeTreeGroupMsg, IMergeTreeInsertMsg, IMergeTreeRemoveMsg, IMergeTreeOp, IRelativePosition, ReferenceType } from "./ops";
 import { PropertySet } from "./properties";
 import { IMergeTreeTextHelper } from "./textSegment";
 import { ReferencePosition, RangeStackMap } from "./referencePositions";
-import { MergeTreeMaintenanceCallback } from "./index";
-export declare class Client {
+import { IMergeTreeDeltaOpArgs } from "./index";
+/**
+ * Emitted before this client's merge-tree normalizes its segments on reconnect, potentially
+ * ordering them. Useful for DDS-like consumers built atop the merge-tree to compute any information
+ * they need for rebasing their ops on reconnection.
+ *
+ * @internal
+ */
+export interface IClientEvents {
+    (event: "normalize", listener: (target: IEventThisPlaceHolder) => void): any;
+    (event: "delta", listener: (opArgs: IMergeTreeDeltaOpArgs, deltaArgs: IMergeTreeDeltaCallbackArgs, target: IEventThisPlaceHolder) => void): any;
+    (event: "maintenance", listener: (args: IMergeTreeMaintenanceCallbackArgs, deltaArgs: IMergeTreeDeltaOpArgs | undefined, target: IEventThisPlaceHolder) => void): any;
+}
+export declare class Client extends TypedEventEmitter<IClientEvents> {
     readonly specToSegment: (spec: IJSONSegment) => ISegment;
     readonly logger: ITelemetryLogger;
-    measureOps: boolean;
-    accumTime: number;
-    localTime: number;
-    localOps: number;
-    accumWindowTime: number;
-    accumWindow: number;
-    accumOps: number;
-    maxWindowTime: number;
     longClientId: string | undefined;
-    get mergeTreeDeltaCallback(): MergeTreeDeltaCallback | undefined;
-    set mergeTreeDeltaCallback(callback: MergeTreeDeltaCallback | undefined);
-    get mergeTreeMaintenanceCallback(): MergeTreeMaintenanceCallback | undefined;
-    set mergeTreeMaintenanceCallback(callback: MergeTreeMaintenanceCallback | undefined);
     private readonly _mergeTree;
     private readonly clientNameToIds;
     private readonly shortClientIdMap;
@@ -87,7 +88,6 @@ export declare class Client {
      * @param segment - The segment to insert
      */
     insertAtReferencePositionLocal(refPos: ReferencePosition, segment: ISegment): IMergeTreeInsertMsg | undefined;
-    private traceOp;
     walkSegments<TClientData>(handler: ISegmentAction<TClientData>, start: number | undefined, end: number | undefined, accum: TClientData, splitRange?: boolean): void;
     walkSegments<undefined>(handler: ISegmentAction<undefined>, start?: number, end?: number, accum?: undefined, splitRange?: boolean): void;
     protected walkAllSegments<TClientData>(action: (segment: ISegment, accum?: TClientData) => boolean, accum?: TClientData): boolean;
@@ -150,14 +150,6 @@ export declare class Client {
      * @returns True if the insert was applied. False if it could not be.
      */
     private applyInsertOp;
-    /**
-     *
-     * @param opArgs - The op args of the op to complete
-     * @param clientArgs - The client args for the op
-     * @param range - The range the op applied to
-     * @param clockStart - Optional. The clock start if timing data should be updated.
-     */
-    private completeAndLogOp;
     /**
      * Returns a valid range for the op, or undefined
      * @param op - The op to generate the range for
@@ -189,30 +181,7 @@ export declare class Client {
      * @param segment - The segment to find the position for
      * @param localSeq - The localSeq to find the position of the segment at
      */
-    protected findReconnectionPosition(segment: ISegment, localSeq: number): number;
-    /**
-     * Rebases a (local) position from the perspective `{ seq: seqNumberFrom, localSeq }` to the perspective
-     * of the current sequence number. This is desirable when rebasing operations for reconnection.
-     *
-     * If the position refers to a segment/offset that was removed by some operation between `seqNumberFrom` and
-     * the current sequence number, returns undefined.
-     */
-    rebasePositionWithoutSegmentSlide(pos: number, seqNumberFrom: number, localSeq: number): number | undefined;
-    /**
-     * Rebases a (local) position from the perspective `{ seq: seqNumberFrom, localSeq }` to the perspective
-     * of the current sequence number. This is desirable when rebasing operations for reconnection.
-     *
-     * If the position refers to a segment/offset that was removed by some operation between `seqNumberFrom` and
-     * the current sequence number, the returned position will align with the position of a reference given
-     * `SlideOnRemove` semantics.
-     *
-     * If a reference was initially given `StayOnRemove` semantics, with intent to later change to `SlideOnRemove`,
-     * that isn't equivalent, and so local bookkeeping needs to be updated.
-     *
-     * If the position has slid off and there is no nearest position (i.e. the
-     * tree is empty), returns `DetachedReferencePosition`
-     */
-    rebasePosition(pos: number, seqNumberFrom: number, localSeq: number): number;
+    findReconnectionPosition(segment: ISegment, localSeq: number): number;
     private resetPendingDeltaToOps;
     private applyRemoteOp;
     applyStashedOp(op: IMergeTreeDeltaOp): SegmentGroup;
@@ -229,6 +198,7 @@ export declare class Client {
      * @param remoteClientId - The client id of the remote client
      */
     resolveRemoteClientPosition(remoteClientPosition: number, remoteClientRefSeq: number, remoteClientId: string): number | undefined;
+    private lastNormalizationRefSeq;
     /**
      * Given an pending operation and segment group, regenerate the op, so it
      * can be resubmitted
@@ -246,7 +216,7 @@ export declare class Client {
     localTransaction(groupOp: IMergeTreeGroupMsg): void;
     updateConsensusProperty(op: IMergeTreeAnnotateMsg, msg: ISequencedDocumentMessage): void;
     updateMinSeq(minSeq: number): void;
-    getContainingSegment<T extends ISegment>(pos: number, op?: ISequencedDocumentMessage, localSeq?: number): {
+    getContainingSegment<T extends ISegment>(pos: number, sequenceArgs?: Pick<ISequencedDocumentMessage, "referenceSequenceNumber" | "clientId">, localSeq?: number): {
         segment: T | undefined;
         offset: 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,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EACH,mBAAmB,EAInB,QAAQ,EACR,cAAc,EACd,MAAM,EACN,YAAY,EACf,MAAM,kBAAkB,CAAC;AAC1B,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,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAA6B,MAAM,sBAAsB,CAAC;AAInG,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,CAAmD;IACnH,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,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IAEvC,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,GAAG,YAAY,GAAG,YAAY,EAAE,GAAG,SAAS;IAc7F;;;;;;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;IAMlE;;;;;;;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,GAAG,mBAAmB;IAMxE;;;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;IAsBlC,OAAO,CAAC,OAAO;IAWR,YAAY,CAAC,WAAW,EAC3B,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,EACpC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,KAAK,EAAE,WAAW,EAClB,UAAU,CAAC,EAAE,OAAO,GACrB,IAAI;IACA,YAAY,CAAC,SAAS,EACzB,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAClC,KAAK,CAAC,EAAE,MAAM,EACd,GAAG,CAAC,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,SAAS,EACjB,UAAU,CAAC,EAAE,OAAO,GACrB,IAAI;IAcP,SAAS,CAAC,eAAe,CAAC,WAAW,EACjC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,WAAW,KAAK,OAAO,EAC3D,KAAK,CAAC,EAAE,WAAW,GACpB,OAAO;IAOV;;;;OAIG;IACI,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,GAAG,IAAI;IA2BzF,eAAe,IAAI,mBAAmB;IAI7C;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAO5E;;;;;;;OAOG;IACI,4BAA4B,CAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,GAAG,SAAS,GAC3G,sBAAsB;IAIzB;;OAEG;IACI,4BAA4B,CAAC,IAAI,EAAE,sBAAsB;IAIhE;;OAEG;IACI,gCAAgC,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAIxE;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIjD,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAIxD;;OAEG;IACI,QAAQ,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIlD;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAqB1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IA2B5B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAkCrB;;;;;;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;IAGrC,eAAe,CAAC,YAAY,EAAE,MAAM;IAKpC;;;;;;;;OAQG;IACH,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM;IAMtE;;;;;;OAMG;IACI,iCAAiC,CACpC,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACjB,MAAM,GAAG,SAAS;IAerB;;;;;;;;;;;;;OAaG;IACI,cAAc,CACjB,GAAG,EAAE,MAAM,EACX,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACjB,MAAM;IA6BT,OAAO,CAAC,sBAAsB;IA0E9B,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,IAAI,oBAAoB;IAIxC,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;IAI9B,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,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;IAKvG;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;KAAE;iBAAnD,QAAQ,GAAG,SAAS;gBAAU,MAAM,GAAG,SAAS;;IAgBrF,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,KAAK,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAClG,OAAO,EAAU,iBAAiB,EAAmB,MAAM,8BAA8B,CAAC;AAK1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EACH,mBAAmB,EAGnB,QAAQ,EACR,cAAc,EACd,MAAM,EACN,YAAY,EACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,2BAA2B,EAAE,iCAAiC,EAAE,MAAM,0BAA0B,CAAC;AAQ1G,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,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAA6B,MAAM,sBAAsB,CAAC;AAInG,OAAO,EAEH,qBAAqB,EACxB,MAAM,SAAS,CAAC;AAIjB;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC1B,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IACxE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,EAAE,SAAS,EAAE,2BAA2B,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IAC3I,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,iCAAiC,EAAE,SAAS,EAAE,qBAAqB,GAAG,SAAS,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CACpK;AAED,qBAAa,MAAO,SAAQ,iBAAiB,CAAC,aAAa,CAAC;aAWpC,aAAa,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;aAC/C,MAAM,EAAE,gBAAgB;IAXrC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IAEvC,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;IAYzB;;;;;;OAMG;IACI,wBAAwB,CAAC,KAAK,GAAE,MAAU,GAAG,YAAY,GAAG,YAAY,EAAE,GAAG,SAAS;IAc7F;;;;;;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;IAMlE;;;;;;;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,GAAG,mBAAmB;IAMxE;;;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;IAkB3B,YAAY,CAAC,WAAW,EAC3B,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,EACpC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,KAAK,EAAE,WAAW,EAClB,UAAU,CAAC,EAAE,OAAO,GACrB,IAAI;IACA,YAAY,CAAC,SAAS,EACzB,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAClC,KAAK,CAAC,EAAE,MAAM,EACd,GAAG,CAAC,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,SAAS,EACjB,UAAU,CAAC,EAAE,OAAO,GACrB,IAAI;IAcP,SAAS,CAAC,eAAe,CAAC,WAAW,EACjC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,WAAW,KAAK,OAAO,EAC3D,KAAK,CAAC,EAAE,WAAW,GACpB,OAAO;IAOV;;;;OAIG;IACI,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,GAAG,IAAI;IA2BzF,eAAe,IAAI,mBAAmB;IAI7C;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAO5E;;;;;;;OAOG;IACI,4BAA4B,CAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,GAAG,SAAS,GAC3G,sBAAsB;IAIzB;;OAEG;IACI,4BAA4B,CAAC,IAAI,EAAE,sBAAsB;IAIhE;;OAEG;IACI,gCAAgC,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAIxE;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIjD,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAIxD;;OAEG;IACI,QAAQ,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIlD;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAmB1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAwB5B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAiCrB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAiEvB;;;OAGG;IACH,OAAO,CAAC,+BAA+B;IAwBvC;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,iBAAiB;IA0BzB,iBAAiB;IAOjB,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAM1C,gBAAgB,CAAC,YAAY,EAAE,MAAM;IAGrC,eAAe,CAAC,aAAa,EAAE,MAAM;IAGrC,eAAe,CAAC,YAAY,EAAE,MAAM;IAKpC;;;;;;;;OAQG;IACI,wBAAwB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM;IAMnE,OAAO,CAAC,sBAAsB;IA8E9B,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,OAAO,CAAC,uBAAuB,CAAK;IACpC;;;;;OAKG;IACI,mBAAmB,CACtB,OAAO,EAAE,YAAY,EACrB,YAAY,EAAE,YAAY,GAAG,YAAY,EAAE,GAC5C,YAAY;IAoCR,gBAAgB,IAAI,oBAAoB;IAIxC,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;IAI9B,gBAAgB,CAAC,OAAO,EAAE,kBAAkB;IAqB5C,uBAAuB,CAAC,EAAE,EAAE,qBAAqB,EAAE,GAAG,EAAE,yBAAyB;IASjF,YAAY,CAAC,MAAM,EAAE,MAAM;IAI3B,oBAAoB,CAAC,CAAC,SAAS,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,yBAAyB,GAAG,UAAU,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;IAK/J;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;KAAE;iBAAnD,QAAQ,GAAG,SAAS;gBAAU,MAAM,GAAG,SAAS;;IAgBrF,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

@@ -20,37 +20,24 @@ const referencePositions_1 = require("./referencePositions");
 const mergeTree_1 = require("./mergeTree");
 const MergeTreeTextHelper_1 = require("./MergeTreeTextHelper");
 const mergeTreeNodeWalk_1 = require("./mergeTreeNodeWalk");
-function elapsedMicroseconds(trace) {
-    return trace.trace().duration * 1000;
-}
-class Client {
+class Client extends common_utils_1.TypedEventEmitter {
     constructor(
     // Passing this callback would be unnecessary if Client were merged with SharedSegmentSequence
     specToSegment, logger, options) {
+        super();
         this.specToSegment = specToSegment;
         this.logger = logger;
-        this.measureOps = false;
-        this.accumTime = 0;
-        this.localTime = 0;
-        this.localOps = 0;
-        this.accumWindowTime = 0;
-        this.accumWindow = 0;
-        this.accumOps = 0;
-        this.maxWindowTime = 0;
         this.clientNameToIds = new collections_1.RedBlackTree(mergeTreeNodes_1.compareStrings);
         this.shortClientIdMap = [];
         this.pendingConsensus = new Map();
+        this.lastNormalizationRefSeq = 0;
         this._mergeTree = new mergeTree_1.MergeTree(options);
-    }
-    get mergeTreeDeltaCallback() { return this._mergeTree.mergeTreeDeltaCallback; }
-    set mergeTreeDeltaCallback(callback) {
-        this._mergeTree.mergeTreeDeltaCallback = callback;
-    }
-    get mergeTreeMaintenanceCallback() {
-        return this._mergeTree.mergeTreeMaintenanceCallback;
-    }
-    set mergeTreeMaintenanceCallback(callback) {
-        this._mergeTree.mergeTreeMaintenanceCallback = callback;
+        this._mergeTree.mergeTreeDeltaCallback = (opArgs, deltaArgs) => {
+            this.emit("delta", opArgs, deltaArgs, this);
+        };
+        this._mergeTree.mergeTreeMaintenanceCallback = (args, opArgs) => {
+            this.emit("maintenance", args, opArgs, this);
+        };
     }
     /**
      * The merge tree maintains a queue of segment groups for each local operation.
@@ -158,17 +145,9 @@ class Client {
         }
         const op = (0, opBuilder_1.createInsertSegmentOp)(pos, segment);
         const opArgs = { op };
-        this.traceOp(opArgs, () => this._mergeTree.insertAtReferencePosition(refPos, segment, opArgs));
+        this._mergeTree.insertAtReferencePosition(refPos, segment, opArgs);
         return op;
     }
-    traceOp(opArgs, applyOp) {
-        let traceStart;
-        if (this.measureOps) {
-            traceStart = common_utils_1.Trace.start();
-        }
-        applyOp();
-        this.completeAndLogOp(opArgs, traceStart);
-    }
     walkSegments(handler, start, end, accum, splitRange = false) {
         this._mergeTree.mapRange(handler, this.getCurrentSeq(), this.getClientId(), accum, start, end, splitRange);
     }
@@ -264,7 +243,7 @@ class Client {
         const op = opArgs.op;
         const clientArgs = this.getClientSequenceArgs(opArgs);
         const range = this.getValidOpRange(op, clientArgs);
-        this.traceOp(opArgs, () => this._mergeTree.markRangeRemoved(range.start, range.end, clientArgs.referenceSequenceNumber, clientArgs.clientId, clientArgs.sequenceNumber, false, opArgs));
+        this._mergeTree.markRangeRemoved(range.start, range.end, clientArgs.referenceSequenceNumber, clientArgs.clientId, clientArgs.sequenceNumber, false, opArgs);
         return true;
     }
     /**
@@ -280,7 +259,7 @@ class Client {
         if (!range) {
             return false;
         }
-        this.traceOp(opArgs, () => this._mergeTree.annotateRange(range.start, range.end, op.props, op.combiningOp, clientArgs.referenceSequenceNumber, clientArgs.clientId, clientArgs.sequenceNumber, opArgs));
+        this._mergeTree.annotateRange(range.start, range.end, op.props, op.combiningOp, clientArgs.referenceSequenceNumber, clientArgs.clientId, clientArgs.sequenceNumber, opArgs);
         return true;
     }
     /**
@@ -303,35 +282,9 @@ class Client {
         if (!segments || segments.length === 0) {
             return false;
         }
-        this.traceOp(opArgs, () => this._mergeTree.insertSegments(range.start, segments, clientArgs.referenceSequenceNumber, clientArgs.clientId, clientArgs.sequenceNumber, opArgs));
+        this._mergeTree.insertSegments(range.start, segments, clientArgs.referenceSequenceNumber, clientArgs.clientId, clientArgs.sequenceNumber, opArgs);
         return true;
     }
-    /**
-     *
-     * @param opArgs - The op args of the op to complete
-     * @param clientArgs - The client args for the op
-     * @param range - The range the op applied to
-     * @param clockStart - Optional. The clock start if timing data should be updated.
-     */
-    completeAndLogOp(opArgs, traceStart) {
-        if (!opArgs.sequencedMessage) {
-            if (traceStart) {
-                this.localTime += elapsedMicroseconds(traceStart);
-                this.localOps++;
-            }
-        }
-        else {
-            const { currentSeq, minSeq } = this.getCollabWindow();
-            const { minimumSequenceNumber, sequenceNumber } = opArgs.sequencedMessage;
-            (0, common_utils_1.assert)(currentSeq < sequenceNumber, 0x030 /* "Incoming remote op sequence# <= local collabWindow's currentSequence#" */);
-            (0, common_utils_1.assert)(minSeq <= minimumSequenceNumber, 0x031 /* "Incoming remote op minSequence# < local collabWindow's minSequence#" */);
-            if (traceStart) {
-                this.accumTime += elapsedMicroseconds(traceStart);
-                this.accumOps++;
-                this.accumWindow += (this.getCurrentSeq() - this.getCollabWindow().minSeq);
-            }
-        }
-    }
     /**
      * Returns a valid range for the op, or undefined
      * @param op - The op to generate the range for
@@ -384,10 +337,6 @@ class Client {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         return { start, end };
     }
-    /**
-     * 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
-     */
     getClientSequenceArgsForMessage(sequencedMessage) {
         // If there this no sequenced message, then the op is local
         // and unacked, so use this clients sequenced args
@@ -404,6 +353,8 @@ class Client {
             return {
                 clientId: this.getOrAddShortClientId(sequencedMessage.clientId),
                 referenceSequenceNumber: sequencedMessage.referenceSequenceNumber,
+                // Note: return value satisfies overload signatures despite the cast, as if input argument doesn't contain sequenceNumber,
+                // return value isn't expected to have it either.
                 sequenceNumber: sequencedMessage.sequenceNumber,
             };
         }
@@ -417,21 +368,12 @@ class Client {
     }
     ackPendingSegment(opArgs) {
         const ackOp = (deltaOpArgs) => {
-            let trace;
-            if (this.measureOps) {
-                trace = common_utils_1.Trace.start();
-            }
             this._mergeTree.ackPendingSegment(deltaOpArgs);
             if (deltaOpArgs.op.type === ops_1.MergeTreeDeltaType.ANNOTATE) {
                 if (deltaOpArgs.op.combiningOp && (deltaOpArgs.op.combiningOp.name === "consensus")) {
                     this.updateConsensusProperty(deltaOpArgs.op, deltaOpArgs.sequencedMessage);
                 }
             }
-            if (trace) {
-                this.accumTime += elapsedMicroseconds(trace);
-                this.accumOps++;
-                this.accumWindow += (this.getCurrentSeq() - this.getCollabWindow().minSeq);
-            }
         };
         if (opArgs.op.type === ops_1.MergeTreeDeltaType.GROUP) {
             for (const memberOp of opArgs.op.ops) {
@@ -484,64 +426,6 @@ class Client {
         const { currentSeq, clientId } = this.getCollabWindow();
         return this._mergeTree.getPosition(segment, currentSeq, clientId, localSeq);
     }
-    /**
-     * Rebases a (local) position from the perspective `{ seq: seqNumberFrom, localSeq }` to the perspective
-     * of the current sequence number. This is desirable when rebasing operations for reconnection.
-     *
-     * If the position refers to a segment/offset that was removed by some operation between `seqNumberFrom` and
-     * the current sequence number, returns undefined.
-     */
-    rebasePositionWithoutSegmentSlide(pos, seqNumberFrom, localSeq) {
-        (0, common_utils_1.assert)(localSeq <= this._mergeTree.collabWindow.localSeq, 0x424 /* localSeq greater than collab window */);
-        const { clientId } = this.getCollabWindow();
-        const { segment, offset } = this._mergeTree.getContainingSegment(pos, seqNumberFrom, clientId, localSeq);
-        if (segment === undefined && offset === undefined) {
-            return;
-        }
-        // if segment is undefined, it slid off the string
-        (0, common_utils_1.assert)(segment !== undefined, 0x425 /* No segment found */);
-        (0, common_utils_1.assert)(offset !== undefined && 0 <= offset && offset < segment.cachedLength, 0x426 /* Invalid offset */);
-        return this.findReconnectionPosition(segment, localSeq) + offset;
-    }
-    /**
-     * Rebases a (local) position from the perspective `{ seq: seqNumberFrom, localSeq }` to the perspective
-     * of the current sequence number. This is desirable when rebasing operations for reconnection.
-     *
-     * If the position refers to a segment/offset that was removed by some operation between `seqNumberFrom` and
-     * the current sequence number, the returned position will align with the position of a reference given
-     * `SlideOnRemove` semantics.
-     *
-     * If a reference was initially given `StayOnRemove` semantics, with intent to later change to `SlideOnRemove`,
-     * that isn't equivalent, and so local bookkeeping needs to be updated.
-     *
-     * If the position has slid off and there is no nearest position (i.e. the
-     * tree is empty), returns `DetachedReferencePosition`
-     */
-    rebasePosition(pos, seqNumberFrom, localSeq) {
-        var _a;
-        (0, common_utils_1.assert)(localSeq <= this._mergeTree.collabWindow.localSeq, 0x300 /* localSeq greater than collab window */);
-        const { clientId } = this.getCollabWindow();
-        let { segment, offset } = this._mergeTree.getContainingSegment(pos, seqNumberFrom, clientId, localSeq);
-        if (segment === undefined && offset === undefined) {
-            // getContainingSegment will only return non-removed segments. This means the position was past
-            // all non-removed segments in the tree, so we take the last one instead as an approximation.
-            let finalSegment = this._mergeTree.root;
-            while (!finalSegment.isLeaf()) {
-                finalSegment = finalSegment.children[finalSegment.childCount - 1];
-            }
-            segment = finalSegment;
-            offset = 0;
-        }
-        // if segment is undefined, it slid off the string
-        (0, common_utils_1.assert)(segment !== undefined, 0x302 /* No segment found */);
-        const segoff = (_a = this.getSlideToSegment({ segment, offset })) !== null && _a !== void 0 ? _a : segment;
-        // case happens when rebasing op, but concurrently entire string has been deleted
-        if (segoff.segment === undefined || segoff.offset === undefined) {
-            return referencePositions_1.DetachedReferencePosition;
-        }
-        (0, common_utils_1.assert)(offset !== undefined && 0 <= offset && offset < segment.cachedLength, 0x303 /* Invalid offset */);
-        return this.findReconnectionPosition(segoff.segment, localSeq) + segoff.offset;
-    }
     resetPendingDeltaToOps(resetOp, segmentGroup) {
         var _a, _b, _c;
         (0, common_utils_1.assert)(!!segmentGroup, 0x033 /* "Segment group undefined" */);
@@ -587,7 +471,11 @@ class Client {
                     throw new Error(`Invalid op type`);
             }
             if (newOp) {
-                const newSegmentGroup = { segments: [], localSeq: segmentGroup.localSeq };
+                const newSegmentGroup = {
+                    segments: [],
+                    localSeq: segmentGroup.localSeq,
+                    refSeq: this.getCollabWindow().currentSeq,
+                };
                 segment.segmentGroups.enqueue(newSegmentGroup);
                 this._mergeTree.pendingSegments.push(newSegmentGroup);
                 opList.push(newOp);
@@ -692,6 +580,12 @@ class Client {
      * @param segmentGroup - The segment group associated with the op
      */
     regeneratePendingOp(resetOp, segmentGroup) {
+        const rebaseTo = this.getCollabWindow().currentSeq;
+        if (rebaseTo !== this.lastNormalizationRefSeq) {
+            this.emit("normalize", this);
+            this._mergeTree.normalizeSegmentsOnRebase();
+            this.lastNormalizationRefSeq = rebaseTo;
+        }
         const opList = [];
         if (resetOp.type === ops_1.MergeTreeDeltaType.GROUP) {
             if (Array.isArray(segmentGroup)) {
@@ -783,22 +677,11 @@ class Client {
         this._mergeTree.addMinSeqListener(msg.sequenceNumber, () => consensusInfo.callback(consensusInfo.marker));
     }
     updateMinSeq(minSeq) {
-        let trace;
-        if (this.measureOps) {
-            trace = common_utils_1.Trace.start();
-        }
         this._mergeTree.setMinSeq(minSeq);
-        if (trace) {
-            const elapsed = elapsedMicroseconds(trace);
-            this.accumWindowTime += elapsed;
-            if (elapsed > this.maxWindowTime) {
-                this.maxWindowTime = elapsed;
-            }
-        }
     }
-    getContainingSegment(pos, op, localSeq) {
-        const args = this.getClientSequenceArgsForMessage(op);
-        return this._mergeTree.getContainingSegment(pos, args.referenceSequenceNumber, args.clientId, localSeq);
+    getContainingSegment(pos, sequenceArgs, localSeq) {
+        const { referenceSequenceNumber, clientId } = this.getClientSequenceArgsForMessage(sequenceArgs);
+        return this._mergeTree.getContainingSegment(pos, referenceSequenceNumber, clientId, localSeq);
     }
     /**
      * Returns the position to slide a reference to if a slide is required.