@fluidframework/sequence 2.0.0-internal.1.4.2 → 2.0.0-internal.2.0.0

package/lib/intervalTree.d.ts

@@ -0,0 +1,72 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IIntegerRange, RBNode, IRBAugmentation, IRBMatcher, RedBlackTree } from "@fluidframework/merge-tree";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+export interface AugmentedIntervalNode {
+    minmax: IInterval;
+}
+export declare const integerRangeToString: (range: IIntegerRange) => string;
+/**
+ * Basic interval abstraction
+ */
+export interface IInterval {
+    /**
+     * @returns a new interval object with identical semantics.
+     */
+    clone(): IInterval;
+    /**
+     * Compares this interval to `b` with standard comparator semantics:
+     * - returns -1 if this is less than `b`
+     * - returns 1 if this is greater than `b`
+     * - returns 0 if this is equivalent to `b`
+     * @param b - Interval to compare against
+     */
+    compare(b: IInterval): number;
+    /**
+     * Compares the start endpoint of this interval to `b`'s start endpoint.
+     * Standard comparator semantics apply.
+     * @param b - Interval to compare against
+     */
+    compareStart(b: IInterval): number;
+    /**
+     * Compares the end endpoint of this interval to `b`'s end endpoint.
+     * Standard comparator semantics apply.
+     * @param b - Interval to compare against
+     */
+    compareEnd(b: IInterval): number;
+    /**
+     * Modifies one or more of the endpoints of this interval, returning a new interval representing the result.
+     * @internal
+     */
+    modify(label: string, start: number | undefined, end: number | undefined, op?: ISequencedDocumentMessage, localSeq?: number): IInterval | undefined;
+    /**
+     * @returns whether this interval overlaps with `b`.
+     * Since intervals are inclusive, this includes cases where endpoints are equal.
+     */
+    overlaps(b: IInterval): boolean;
+    /**
+     * Unions this interval with `b`, returning a new interval.
+     * The union operates as a convex hull, i.e. if the two intervals are disjoint, the return value includes
+     * intermediate values between the two intervals.
+     * @internal
+     */
+    union(b: IInterval): IInterval;
+}
+export declare type IntervalNode<T extends IInterval> = RBNode<T, AugmentedIntervalNode>;
+export declare type IntervalConflictResolver<TInterval> = (a: TInterval, b: TInterval) => TInterval;
+export declare class IntervalTree<T extends IInterval> implements IRBAugmentation<T, AugmentedIntervalNode>, IRBMatcher<T, AugmentedIntervalNode> {
+    intervals: RedBlackTree<T, AugmentedIntervalNode>;
+    remove(x: T): void;
+    removeExisting(x: T): void;
+    put(x: T, conflict?: IntervalConflictResolver<T>): void;
+    map(fn: (x: T) => void): void;
+    mapUntil(fn: (X: T) => boolean): void;
+    mapBackward(fn: (x: T) => void): void;
+    match(x: T): RBNode<T, AugmentedIntervalNode>[];
+    matchNode(node: IntervalNode<T> | undefined, key: T): boolean;
+    continueSubtree(node: IntervalNode<T> | undefined, key: T): boolean;
+    update(node: IntervalNode<T>): void;
+}
+//# sourceMappingURL=intervalTree.d.ts.map

package/lib/intervalTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intervalTree.d.ts","sourceRoot":"","sources":["../src/intervalTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,aAAa,EACb,MAAM,EACN,eAAe,EACf,UAAU,EACV,YAAY,EAGf,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,SAAS,CAAC;CACrB;AAED,eAAO,MAAM,oBAAoB,UAAW,aAAa,WAAoC,CAAC;AAE9F;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,KAAK,IAAI,SAAS,CAAC;IACnB;;;;;;OAMG;IACH,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC9B;;;;OAIG;IACH,YAAY,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IACnC;;;;OAIG;IACH,UAAU,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IACjC;;;OAGG;IACH,MAAM,CACF,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,EAAE,CAAC,EAAE,yBAAyB,EAC9B,QAAQ,CAAC,EAAE,MAAM,GAClB,SAAS,GAAG,SAAS,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAChC;;;;;OAKG;IACH,KAAK,CAAC,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAClC;AAID,oBAAY,YAAY,CAAC,CAAC,SAAS,SAAS,IAAI,MAAM,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AAEjF,oBAAY,wBAAwB,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,SAAS,CAAC;AAE5F,qBAAa,YAAY,CAAC,CAAC,SAAS,SAAS,CAAE,YAAW,eAAe,CAAC,CAAC,EAAE,qBAAqB,CAAC,EAC/F,UAAU,CAAC,CAAC,EAAE,qBAAqB,CAAC;IAC7B,SAAS,yCAAsE;IAE/E,MAAM,CAAC,CAAC,EAAE,CAAC;IAIX,cAAc,CAAC,CAAC,EAAE,CAAC;IAInB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC;IAahD,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI;IAWtB,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO;IAU9B,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI;IAY9B,KAAK,CAAC,CAAC,EAAE,CAAC;IAIV,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,CAAC;IAInD,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,CAAC;IAIzD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;CActC"}

package/lib/intervalTree.js

@@ -0,0 +1,86 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { RedBlackTree, } from "@fluidframework/merge-tree";
+export const integerRangeToString = (range) => `[${range.start},${range.end})`;
+const intervalComparer = (a, b) => a.compare(b);
+export class IntervalTree {
+    constructor() {
+        this.intervals = new RedBlackTree(intervalComparer, this);
+    }
+    remove(x) {
+        this.intervals.remove(x);
+    }
+    removeExisting(x) {
+        this.intervals.removeExisting(x);
+    }
+    put(x, conflict) {
+        let rbConflict;
+        if (conflict) {
+            rbConflict = (key, currentKey) => {
+                const ival = conflict(key, currentKey);
+                return {
+                    key: ival,
+                };
+            };
+        }
+        this.intervals.put(x, { minmax: x.clone() }, rbConflict);
+    }
+    map(fn) {
+        const actions = {
+            infix: (node) => {
+                fn(node.key);
+                return true;
+            },
+            showStructure: true,
+        };
+        this.intervals.walk(actions);
+    }
+    mapUntil(fn) {
+        const actions = {
+            infix: (node) => {
+                return fn(node.key);
+            },
+            showStructure: true,
+        };
+        this.intervals.walk(actions);
+    }
+    mapBackward(fn) {
+        const actions = {
+            infix: (node) => {
+                fn(node.key);
+                return true;
+            },
+            showStructure: true,
+        };
+        this.intervals.walkBackward(actions);
+    }
+    // TODO: toString()
+    match(x) {
+        return this.intervals.gather(x, this);
+    }
+    matchNode(node, key) {
+        return !!node && node.key.overlaps(key);
+    }
+    continueSubtree(node, key) {
+        return !!node && node.data.minmax.overlaps(key);
+    }
+    update(node) {
+        if (node.left && node.right) {
+            node.data.minmax = node.key.union(node.left.data.minmax.union(node.right.data.minmax));
+        }
+        else {
+            if (node.left) {
+                node.data.minmax = node.key.union(node.left.data.minmax);
+            }
+            else if (node.right) {
+                node.data.minmax = node.key.union(node.right.data.minmax);
+            }
+            else {
+                node.data.minmax = node.key.clone();
+            }
+        }
+    }
+}
+//# sourceMappingURL=intervalTree.js.map

package/lib/intervalTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"intervalTree.js","sourceRoot":"","sources":["../src/intervalTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAKH,YAAY,GAGf,MAAM,4BAA4B,CAAC;AAOpC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAoB,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC;AAuD9F,MAAM,gBAAgB,GAAG,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAMtE,MAAM,OAAO,YAAY;IAAzB;QAEW,cAAS,GAAG,IAAI,YAAY,CAA2B,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAkF1F,CAAC;IAhFU,MAAM,CAAC,CAAI;QACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,CAAI;QACtB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAEM,GAAG,CAAC,CAAI,EAAE,QAAsC;QACnD,IAAI,UAAgE,CAAC;QACrE,IAAI,QAAQ,EAAE;YACV,UAAU,GAAG,CAAC,GAAM,EAAE,UAAa,EAAE,EAAE;gBACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;gBACvC,OAAO;oBACH,GAAG,EAAE,IAAI;iBACZ,CAAC;YACN,CAAC,CAAC;SACL;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IAEM,GAAG,CAAC,EAAkB;QACzB,MAAM,OAAO,GAA4C;YACrD,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;gBACZ,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACb,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,aAAa,EAAE,IAAI;SACtB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAEM,QAAQ,CAAC,EAAqB;QACjC,MAAM,OAAO,GAA4C;YACrD,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;gBACZ,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC;YACD,aAAa,EAAE,IAAI;SACtB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAEM,WAAW,CAAC,EAAkB;QACjC,MAAM,OAAO,GAA4C;YACrD,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;gBACZ,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACb,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,aAAa,EAAE,IAAI;SACtB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,mBAAmB;IACZ,KAAK,CAAC,CAAI;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAEM,SAAS,CAAC,IAAiC,EAAE,GAAM;QACtD,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAEM,eAAe,CAAC,IAAiC,EAAE,GAAM;QAC5D,OAAO,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,IAAqB;QAC/B,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SAC5D;aAAM;YACH,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAC5D;iBAAM,IAAI,IAAI,CAAC,KAAK,EAAE;gBACnB,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAC7D;iBAAM;gBACH,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;aACvC;SACJ;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IIntegerRange,\n    RBNode,\n    IRBAugmentation,\n    IRBMatcher,\n    RedBlackTree,\n    ConflictAction,\n    RBNodeActions,\n} from \"@fluidframework/merge-tree\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\n\nexport interface AugmentedIntervalNode {\n    minmax: IInterval;\n}\n\nexport const integerRangeToString = (range: IIntegerRange) => `[${range.start},${range.end})`;\n\n/**\n * Basic interval abstraction\n */\nexport interface IInterval {\n    /**\n     * @returns a new interval object with identical semantics.\n     */\n    clone(): IInterval;\n    /**\n     * Compares this interval to `b` with standard comparator semantics:\n     * - returns -1 if this is less than `b`\n     * - returns 1 if this is greater than `b`\n     * - returns 0 if this is equivalent to `b`\n     * @param b - Interval to compare against\n     */\n    compare(b: IInterval): number;\n    /**\n     * Compares the start endpoint of this interval to `b`'s start endpoint.\n     * Standard comparator semantics apply.\n     * @param b - Interval to compare against\n     */\n    compareStart(b: IInterval): number;\n    /**\n     * Compares the end endpoint of this interval to `b`'s end endpoint.\n     * Standard comparator semantics apply.\n     * @param b - Interval to compare against\n     */\n    compareEnd(b: IInterval): number;\n    /**\n     * Modifies one or more of the endpoints of this interval, returning a new interval representing the result.\n     * @internal\n     */\n    modify(\n        label: string,\n        start: number | undefined,\n        end: number | undefined,\n        op?: ISequencedDocumentMessage,\n        localSeq?: number\n    ): IInterval | undefined;\n    /**\n     * @returns whether this interval overlaps with `b`.\n     * Since intervals are inclusive, this includes cases where endpoints are equal.\n     */\n    overlaps(b: IInterval): boolean;\n    /**\n     * Unions this interval with `b`, returning a new interval.\n     * The union operates as a convex hull, i.e. if the two intervals are disjoint, the return value includes\n     * intermediate values between the two intervals.\n     * @internal\n     */\n    union(b: IInterval): IInterval;\n}\n\nconst intervalComparer = (a: IInterval, b: IInterval) => a.compare(b);\n\nexport type IntervalNode<T extends IInterval> = RBNode<T, AugmentedIntervalNode>;\n\nexport type IntervalConflictResolver<TInterval> = (a: TInterval, b: TInterval) => TInterval;\n\nexport class IntervalTree<T extends IInterval> implements IRBAugmentation<T, AugmentedIntervalNode>,\n    IRBMatcher<T, AugmentedIntervalNode> {\n    public intervals = new RedBlackTree<T, AugmentedIntervalNode>(intervalComparer, this);\n\n    public remove(x: T) {\n        this.intervals.remove(x);\n    }\n\n    public removeExisting(x: T) {\n        this.intervals.removeExisting(x);\n    }\n\n    public put(x: T, conflict?: IntervalConflictResolver<T>) {\n        let rbConflict: ConflictAction<T, AugmentedIntervalNode> | undefined;\n        if (conflict) {\n            rbConflict = (key: T, currentKey: T) => {\n                const ival = conflict(key, currentKey);\n                return {\n                    key: ival,\n                };\n            };\n        }\n        this.intervals.put(x, { minmax: x.clone() }, rbConflict);\n    }\n\n    public map(fn: (x: T) => void) {\n        const actions: RBNodeActions<T, AugmentedIntervalNode> = {\n            infix: (node) => {\n                fn(node.key);\n                return true;\n            },\n            showStructure: true,\n        };\n        this.intervals.walk(actions);\n    }\n\n    public mapUntil(fn: (X: T) => boolean) {\n        const actions: RBNodeActions<T, AugmentedIntervalNode> = {\n            infix: (node) => {\n                return fn(node.key);\n            },\n            showStructure: true,\n        };\n        this.intervals.walk(actions);\n    }\n\n    public mapBackward(fn: (x: T) => void) {\n        const actions: RBNodeActions<T, AugmentedIntervalNode> = {\n            infix: (node) => {\n                fn(node.key);\n                return true;\n            },\n            showStructure: true,\n        };\n        this.intervals.walkBackward(actions);\n    }\n\n    // TODO: toString()\n    public match(x: T) {\n        return this.intervals.gather(x, this);\n    }\n\n    public matchNode(node: IntervalNode<T> | undefined, key: T) {\n        return !!node && node.key.overlaps(key);\n    }\n\n    public continueSubtree(node: IntervalNode<T> | undefined, key: T) {\n        return !!node && node.data.minmax.overlaps(key);\n    }\n\n    public update(node: IntervalNode<T>) {\n        if (node.left && node.right) {\n            node.data.minmax = node.key.union(\n                node.left.data.minmax.union(node.right.data.minmax));\n        } else {\n            if (node.left) {\n                node.data.minmax = node.key.union(node.left.data.minmax);\n            } else if (node.right) {\n                node.data.minmax = node.key.union(node.right.data.minmax);\n            } else {\n                node.data.minmax = node.key.clone();\n            }\n        }\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/sequence";
-export declare const pkgVersion = "2.0.0-internal.1.4.2";
+export declare const pkgVersion = "2.0.0-internal.2.0.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.0.0-internal.1.4.2";
+export const pkgVersion = "2.0.0-internal.2.0.0";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.0.0-internal.1.4.2\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.0.0-internal.2.0.0\";\n"]}

package/lib/sequence.d.ts

@@ -5,7 +5,7 @@
 import { Deferred } from "@fluidframework/common-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 } from "@fluidframework/merge-tree";
+import { Client, ICombiningOp, IJSONSegment, IMergeTreeGroupMsg, IMergeTreeOp, IMergeTreeRemoveMsg, IRelativePosition, ISegment, ISegmentAction, LocalReferencePosition, PropertySet, RangeStackMap, ReferencePosition, ReferenceType, MergeTreeRevertibleDriver } from "@fluidframework/merge-tree";
 import { IFluidSerializer, SharedObject, ISharedObjectEvents, SummarySerializer } from "@fluidframework/shared-object-base";
 import { IEventThisPlaceHolder } from "@fluidframework/common-definitions";
 import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
@@ -50,13 +50,14 @@ export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
     (event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): any;
     (event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): any;
 }
-export declare abstract class SharedSegmentSequence<T extends ISegment> extends SharedObject<ISharedSegmentSequenceEvents> implements ISharedIntervalCollection<SequenceInterval> {
+export declare abstract class SharedSegmentSequence<T extends ISegment> extends SharedObject<ISharedSegmentSequenceEvents> implements ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver {
     private readonly dataStoreRuntime;
     id: string;
     readonly segmentFromSpec: (spec: IJSONSegment) => ISegment;
     get loaded(): Promise<void>;
     private static createOpsFromDelta;
     protected client: Client;
+    /** `Deferred` that triggers once the object is loaded */
     protected loadedDeferred: Deferred<void>;
     private readonly loadedDeferredOutgoingOps;
     private deferIncomingOps;
@@ -70,9 +71,14 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      */
     removeRange(start: number, end: number): IMergeTreeRemoveMsg;
     groupOperation(groupOp: IMergeTreeGroupMsg): void;
+    /**
+     * Finds the segment information (i.e. segment + offset) corresponding to a character position in the SharedString.
+     * If the position is past the end of the string, `segment` and `offset` on the returned object may be undefined.
+     * @param pos - Character position (index) into the current local view of the SharedString.
+     */
     getContainingSegment(pos: number): {
-        segment: T;
-        offset: number;
+        segment: T | undefined;
+        offset: number | undefined;
     };
     /**
      * Returns the length of the current sequence for the client
@@ -94,13 +100,28 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      *
      */
     annotateRange(start: number, end: number, props: PropertySet, combiningOp?: ICombiningOp): void;
-    getPropertiesAtPosition(pos: number): PropertySet;
+    getPropertiesAtPosition(pos: number): PropertySet | undefined;
     getRangeExtentsOfPosition(pos: number): {
-        posStart: number;
-        posAfterEnd: number;
+        posStart: number | undefined;
+        posAfterEnd: number | undefined;
     };
+    /**
+     * Creates a `LocalReferencePosition` on this SharedString. If the refType does not include
+     * ReferenceType.Transient, the returned reference will be added to the localRefs on the provided segment.
+     * @param segment - Segment to add the local reference on
+     * @param offset - Offset on the segment at which to place the local reference
+     * @param refType - ReferenceType for the created local reference
+     * @param properties - PropertySet to place on the created local reference
+     */
     createLocalReferencePosition(segment: T, offset: number, refType: ReferenceType, properties: PropertySet | undefined): LocalReferencePosition;
+    /**
+     * Resolves a `ReferencePosition` into a character position using this client's perspective.
+     */
     localReferencePositionToPosition(lref: ReferencePosition): number;
+    /**
+     * Removes a `LocalReferencePosition` from this SharedString.
+     */
+    removeLocalReferencePosition(lref: LocalReferencePosition): LocalReferencePosition | undefined;
     /**
      * Resolves a remote client's position against the local sequence
      * and returns the remote client's position relative to the local
@@ -115,9 +136,8 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * @param remoteClientRefSeq - The reference sequence number of the remote client
      * @param remoteClientId - The client id of the remote client
      */
-    resolveRemoteClientPosition(remoteClientPosition: number, remoteClientRefSeq: number, remoteClientId: string): number;
+    resolveRemoteClientPosition(remoteClientPosition: number, remoteClientRefSeq: number, remoteClientId: string): number | undefined;
     submitSequenceMessage(message: IMergeTreeOp): void;
-    removeLocalReferencePosition(lref: LocalReferencePosition): LocalReferencePosition;
     /**
      * Given a position specified relative to a marker id, lookup the marker
      * and convert the position to a character position.
@@ -138,18 +158,28 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * @param splitRange - Optional. Splits boundary segments on the range boundaries
      */
     walkSegments<TClientData>(handler: ISegmentAction<TClientData>, start?: number, end?: number, accum?: TClientData, splitRange?: boolean): void;
+    getStackContext(startPos: number, rangeLabels: string[]): RangeStackMap;
     /**
-     * @deprecated  for internal use only. public export will be removed.
-     * @internal
+     * @returns - The most recent sequence number which has been acked by the server and processed by this
+     * SharedSegmentSequence.
      */
-    getStackContext(startPos: number, rangeLabels: string[]): RangeStackMap;
     getCurrentSeq(): number;
+    /**
+     * Inserts a segment directly before a `ReferencePosition`.
+     * @param refPos - The reference position to insert the segment at
+     * @param segment - The segment to insert
+     */
     insertAtReferencePosition(pos: ReferencePosition, segment: T): void;
     /**
-     * @deprecated `IntervalCollection`s are created on a first-write wins basis, and concurrent creates
-     * are supported. Use {@link SharedSegmentSequence.getIntervalCollection} instead.
+     * Inserts a segment
+     * @param start - The position to insert the segment at
+     * @param spec - The segment to inserts spec
+     */
+    insertFromSpec(pos: number, spec: IJSONSegment): void;
+    /**
+     * Retrieves the interval collection keyed on `label`. If no such interval collection exists,
+     * creates one.
      */
-    waitIntervalCollection(label: string): Promise<IntervalCollection<SequenceInterval>>;
     getIntervalCollection(label: string): IntervalCollection<SequenceInterval>;
     /**
      * @returns An iterable object that enumerates the IntervalCollection labels.
@@ -163,6 +193,9 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * ```
     */
     getIntervalCollectionLabels(): IterableIterator<string>;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
+     */
     protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * Runs serializer over the GC data for this SharedMatrix.
@@ -179,15 +212,33 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      * @param segment - The segment that will replace the range
      */
     protected replaceRange(start: number, end: number, segment: ISegment): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onConnect}
+     */
     protected onConnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
+     */
     protected onDisconnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
+     */
     protected reSubmitCore(content: any, localOpMetadata: unknown): void;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
      */
     protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
+     */
     protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.didAttach}
+     */
     protected didAttach(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.initializeLocalCore}
+     */
     protected initializeLocalCore(): void;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}

package/lib/sequence.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sequence.d.ts","sourceRoot":"","sources":["../src/sequence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAA0B,MAAM,8BAA8B,CAAC;AAEhF,OAAO,EACH,yBAAyB,EAE5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,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,EAEhB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACH,gBAAgB,EAGhB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACpB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAE/F,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAEnB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAKvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACrE,CAAC,KAAK,EAAE,0BAA0B,EAC9B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IACvG,CAAC,KAAK,EAAE,aAAa,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CAC3F;AAED,8BAAsB,qBAAqB,CAAC,CAAC,SAAS,QAAQ,CAC1D,SAAQ,YAAY,CAAC,4BAA4B,CACjD,YAAW,yBAAyB,CAAC,gBAAgB,CAAC;IAiElD,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAC1B,EAAE,EAAE,MAAM;aAED,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IAnErE,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IAED,OAAO,CAAC,MAAM,CAAC,kBAAkB;IA+CjC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAEzB,SAAS,CAAC,cAAc,iBAAwB;IAEhD,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CACe;IAEzD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAmC;IAE7E,OAAO,CAAC,sBAAsB,CAAmC;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmD;gBAElE,gBAAgB,EAAE,sBAAsB,EAClD,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB,EACd,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IAyDrE;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,mBAAmB;IAQ5D,cAAc,CAAC,OAAO,EAAE,kBAAkB;IAK1C,oBAAoB,CAAC,GAAG,EAAE,MAAM;;;;IAIvC;;OAEG;IACI,SAAS;IAIhB;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,MAAM;IAI7C;;;;;;;;OAQG;IACI,aAAa,CAChB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,WAAW,EAClB,WAAW,CAAC,EAAE,YAAY;IAQvB,uBAAuB,CAAC,GAAG,EAAE,MAAM;IAInC,yBAAyB,CAAC,GAAG,EAAE,MAAM;;;;IAIrC,4BAA4B,CAC/B,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,EACtB,UAAU,EAAE,WAAW,GAAG,SAAS,GAAG,sBAAsB;IAQzD,gCAAgC,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAIxE;;;;;;;;;;;;;OAaG;IACI,2BAA2B,CAC9B,oBAAoB,EAAE,MAAM,EAC5B,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,MAAM,GAAG,MAAM;IAO5B,qBAAqB,CAAC,OAAO,EAAE,YAAY;IAkB3C,4BAA4B,CAAC,IAAI,EAAE,sBAAsB;IAIhE;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIxD;;;;;;;;;;;;OAYG;IACI,YAAY,CAAC,WAAW,EAC3B,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,EACpC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EACjD,UAAU,GAAE,OAAe;IAI/B;;;OAGG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,aAAa;IAIvE,aAAa;IAIb,yBAAyB,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC;IAOnE;;;OAGG;IACU,sBAAsB,CAC/B,KAAK,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAIzC,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC,gBAAgB,CAAC;IAIjF;;;;;;;;;;MAUE;IACK,2BAA2B,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAI9D,SAAS,CAAC,aAAa,CACnB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,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;IAgBpE,SAAS,CAAC,SAAS;IAKnB,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAS7D;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IAuDxD,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAsBlG,SAAS,CAAC,SAAS;IAQnB,SAAS,CAAC,mBAAmB;IAK7B;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAI/C,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,mBAAmB;IAuC3B,OAAO,CAAC,+BAA+B;IAYvC,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,6BAA6B;CAiBxC"}
+{"version":3,"file":"sequence.d.ts","sourceRoot":"","sources":["../src/sequence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAA0B,MAAM,8BAA8B,CAAC;AAEhF,OAAO,EACH,yBAAyB,EAE5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,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,EAE5B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACH,gBAAgB,EAGhB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACpB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAI/F,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAEnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAKvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACrE,CAAC,KAAK,EAAE,0BAA0B,EAC9B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IACvG,CAAC,KAAK,EAAE,aAAa,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CAC3F;AAED,8BAAsB,qBAAqB,CAAC,CAAC,SAAS,QAAQ,CAC1D,SAAQ,YAAY,CAAC,4BAA4B,CACjD,YAAW,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,yBAAyB;IAkE7E,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAC1B,EAAE,EAAE,MAAM;aAED,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IApErE,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IAED,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAgDjC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,SAAS,CAAC,cAAc,iBAAwB;IAEhD,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CACe;IAEzD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAmC;IAE7E,OAAO,CAAC,sBAAsB,CAAmC;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmD;gBAElE,gBAAgB,EAAE,sBAAsB,EAClD,EAAE,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB,EACd,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,QAAQ;IAyDrE;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,mBAAmB;IAM5D,cAAc,CAAC,OAAO,EAAE,kBAAkB;IAKjD;;;;OAIG;IACI,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,OAAO,EAAE,CAAC,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;KAAE;IAIjG;;OAEG;IACI,SAAS;IAIhB;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,MAAM;IAI7C;;;;;;;;OAQG;IACI,aAAa,CAChB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,WAAW,EAClB,WAAW,CAAC,EAAE,YAAY;IAQvB,uBAAuB,CAAC,GAAG,EAAE,MAAM;IAInC,yBAAyB,CAAC,GAAG,EAAE,MAAM;;;;IAI5C;;;;;;;OAOG;IACI,4BAA4B,CAC/B,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,EACtB,UAAU,EAAE,WAAW,GAAG,SAAS,GAAG,sBAAsB;IAQhE;;OAEG;IACI,gCAAgC,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAIxE;;OAEG;IACI,4BAA4B,CAAC,IAAI,EAAE,sBAAsB;IAIhE;;;;;;;;;;;;;OAaG;IACI,2BAA2B,CAC9B,oBAAoB,EAAE,MAAM,EAC5B,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAQxC,qBAAqB,CAAC,OAAO,EAAE,YAAY;IAkBlD;;;;OAIG;IACI,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;IAIxD;;;;;;;;;;;;OAYG;IACI,YAAY,CAAC,WAAW,EAC3B,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,GAC5B,IAAI;IAIA,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;IAMnE;;;;OAIG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAQrD;;;OAGG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC,gBAAgB,CAAC;IAIjF;;;;;;;;;;MAUE;IACK,2BAA2B,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAI9D;;OAEG;IACH,SAAS,CAAC,aAAa,CACnB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,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;IAiBpE;;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;IAS7D;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IAuDxD;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAsBlG;;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;IAY1B,OAAO,CAAC,mBAAmB;IAuC3B,OAAO,CAAC,+BAA+B;IAYvC,OAAO,CAAC,YAAY;IA6BpB,OAAO,CAAC,6BAA6B;CAiBxC"}

package/lib/sequence.js

@@ -8,8 +8,8 @@ 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 { SequenceIntervalCollectionValueType, } from "./intervalCollection";
 import { DefaultMap } from "./defaultMap";
+import { SequenceIntervalCollectionValueType, } from "./intervalCollection";
 import { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent";
 const snapshotFileName = "header";
 const contentPath = "content";
@@ -19,7 +19,7 @@ export class SharedSegmentSequence extends SharedObject {
         this.dataStoreRuntime = dataStoreRuntime;
         this.id = id;
         this.segmentFromSpec = segmentFromSpec;
-        // Deferred that triggers once the object is loaded
+        /** `Deferred` that triggers once the object is loaded */
         this.loadedDeferred = new Deferred();
         // cache out going ops created when partial loading
         this.loadedDeferredOutgoingOps = [];
@@ -97,6 +97,7 @@ export class SharedSegmentSequence extends SharedObject {
                 case MergeTreeDeltaType.REMOVE: {
                     const lastRem = ops[ops.length - 1];
                     if ((lastRem === null || lastRem === void 0 ? void 0 : lastRem.pos1) === r.position) {
+                        assert(lastRem.pos2 !== undefined, 0x3ff /* pos2 should not be undefined here */);
                         lastRem.pos2 += r.segment.cachedLength;
                     }
                     else {
@@ -115,15 +116,18 @@ export class SharedSegmentSequence extends SharedObject {
      */
     removeRange(start, end) {
         const removeOp = this.client.removeRangeLocal(start, end);
-        if (removeOp) {
-            this.submitSequenceMessage(removeOp);
-        }
+        this.submitSequenceMessage(removeOp);
         return removeOp;
     }
     groupOperation(groupOp) {
         this.client.localTransaction(groupOp);
         this.submitSequenceMessage(groupOp);
     }
+    /**
+     * Finds the segment information (i.e. segment + offset) corresponding to a character position in the SharedString.
+     * If the position is past the end of the string, `segment` and `offset` on the returned object may be undefined.
+     * @param pos - Character position (index) into the current local view of the SharedString.
+     */
     getContainingSegment(pos) {
         return this.client.getContainingSegment(pos);
     }
@@ -162,12 +166,29 @@ export class SharedSegmentSequence extends SharedObject {
     getRangeExtentsOfPosition(pos) {
         return this.client.getRangeExtentsOfPosition(pos);
     }
+    /**
+     * Creates a `LocalReferencePosition` on this SharedString. If the refType does not include
+     * ReferenceType.Transient, the returned reference will be added to the localRefs on the provided segment.
+     * @param segment - Segment to add the local reference on
+     * @param offset - Offset on the segment at which to place the local reference
+     * @param refType - ReferenceType for the created local reference
+     * @param properties - PropertySet to place on the created local reference
+     */
     createLocalReferencePosition(segment, offset, refType, properties) {
         return this.client.createLocalReferencePosition(segment, offset, refType, properties);
     }
+    /**
+     * Resolves a `ReferencePosition` into a character position using this client's perspective.
+     */
     localReferencePositionToPosition(lref) {
         return this.client.localReferencePositionToPosition(lref);
     }
+    /**
+     * Removes a `LocalReferencePosition` from this SharedString.
+     */
+    removeLocalReferencePosition(lref) {
+        return this.client.removeLocalReferencePosition(lref);
+    }
     /**
      * Resolves a remote client's position against the local sequence
      * and returns the remote client's position relative to the local
@@ -195,15 +216,12 @@ export class SharedSegmentSequence extends SharedObject {
         // local ops until loading is complete, and then
         // they will be resent
         if (!this.loadedDeferred.isCompleted) {
-            this.loadedDeferredOutgoingOps.push([translated, metadata]);
+            this.loadedDeferredOutgoingOps.push(metadata ? [translated, metadata] : translated);
         }
         else {
             this.submitLocalMessage(translated, metadata);
         }
     }
-    removeLocalReferencePosition(lref) {
-        return this.client.removeLocalReferencePosition(lref);
-    }
     /**
      * Given a position specified relative to a marker id, lookup the marker
      * and convert the position to a character position.
@@ -226,18 +244,23 @@ export class SharedSegmentSequence extends SharedObject {
      * @param splitRange - Optional. Splits boundary segments on the range boundaries
      */
     walkSegments(handler, start, end, accum, splitRange = false) {
-        return this.client.walkSegments(handler, start, end, accum, splitRange);
+        this.client.walkSegments(handler, start, end, accum, splitRange);
     }
-    /**
-     * @deprecated  for internal use only. public export will be removed.
-     * @internal
-     */
     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.
+     */
     getCurrentSeq() {
         return this.client.getCurrentSeq();
     }
+    /**
+     * Inserts a segment directly before a `ReferencePosition`.
+     * @param refPos - The reference position to insert the segment at
+     * @param segment - The segment to insert
+     */
     insertAtReferencePosition(pos, segment) {
         const insertOp = this.client.insertAtReferencePositionLocal(pos, segment);
         if (insertOp) {
@@ -245,12 +268,21 @@ export class SharedSegmentSequence extends SharedObject {
         }
     }
     /**
-     * @deprecated `IntervalCollection`s are created on a first-write wins basis, and concurrent creates
-     * are supported. Use {@link SharedSegmentSequence.getIntervalCollection} instead.
+     * Inserts a segment
+     * @param start - The position to insert the segment at
+     * @param spec - The segment to inserts spec
      */
-    async waitIntervalCollection(label) {
-        return this.intervalCollections.get(label);
+    insertFromSpec(pos, spec) {
+        const segment = this.segmentFromSpec(spec);
+        const insertOp = this.client.insertSegmentLocal(pos, segment);
+        if (insertOp) {
+            this.submitSequenceMessage(insertOp);
+        }
     }
+    /**
+     * Retrieves the interval collection keyed on `label`. If no such interval collection exists,
+     * creates one.
+     */
     getIntervalCollection(label) {
         return this.intervalCollections.get(label);
     }
@@ -268,6 +300,9 @@ export class SharedSegmentSequence extends SharedObject {
     getIntervalCollectionLabels() {
         return this.intervalCollections.keys();
     }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
+     */
     summarizeCore(serializer, telemetryContext) {
         const builder = new SummaryTreeBuilder();
         // conditionally write the interval collection blob
@@ -305,18 +340,28 @@ export class SharedSegmentSequence extends SharedObject {
         if (insert) {
             if (start < end) {
                 const remove = this.client.removeRangeLocal(start, end);
-                this.submitSequenceMessage(createGroupOp(insert, remove));
+                const op = remove ? createGroupOp(insert, remove) : insert;
+                this.submitSequenceMessage(op);
             }
             else {
                 this.submitSequenceMessage(insert);
             }
         }
     }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onConnect}
+     */
     onConnect() {
         // Update merge tree collaboration information with new client ID and then resend pending ops
         this.client.startOrUpdateCollaboration(this.runtime.clientId);
     }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
+     */
     onDisconnect() { }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
+     */
     reSubmitCore(content, localOpMetadata) {
         if (!this.intervalCollections.tryResubmitMessage(content, localOpMetadata)) {
             this.submitSequenceMessage(this.client.regeneratePendingOp(content, localOpMetadata));
@@ -376,6 +421,9 @@ export class SharedSegmentSequence extends SharedObject {
             this.loadFinished(error);
         }
     }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
+     */
     processCore(message, local, localOpMetadata) {
         // if loading isn't complete, we need to cache all
         // incoming ops to be applied after loading is complete
@@ -391,6 +439,9 @@ export class SharedSegmentSequence extends SharedObject {
             }
         }
     }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.didAttach}
+     */
     didAttach() {
         var _a;
         // If we are not local, and we've attached we need to start generating and sending ops
@@ -399,6 +450,9 @@ export class SharedSegmentSequence extends SharedObject {
             this.client.startOrUpdateCollaboration((_a = this.runtime.clientId) !== null && _a !== void 0 ? _a : "attached");
         }
     }
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.initializeLocalCore}
+     */
     initializeLocalCore() {
         super.initializeLocalCore();
         this.loadFinished();