@fluidframework/sequence 2.0.0-internal.1.0.0.83139 → 2.0.0-internal.1.1.1

package/lib/sharedString.js

@@ -147,6 +147,9 @@ export class SharedString extends SharedSegmentSequence {
     findTile(startPos, tileLabel, preceding = true) {
         return this.client.findTile(startPos, tileLabel, preceding);
     }
+    /**
+     * @deprecated - use the free function `getTextAndMarkers` exported by this package instead.
+     */
     getTextAndMarkers(label) {
         const segmentWindow = this.client.getCollabWindow();
         return this.mergeTreeTextHelper.getTextAndMarkers(segmentWindow.currentSeq, segmentWindow.clientId, label);
@@ -164,13 +167,15 @@ export class SharedString extends SharedSegmentSequence {
     /**
      * Adds spaces for markers and handles, so that position calculations account for them.
      */
-    getTextWithPlaceholders() {
+    getTextWithPlaceholders(start, end) {
         const segmentWindow = this.client.getCollabWindow();
-        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ");
+        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ", start, end);
     }
+    /**
+     * @deprecated - use `getTextWithPlaceholders` instead.
+     */
     getTextRangeWithPlaceholders(start, end) {
-        const segmentWindow = this.client.getCollabWindow();
-        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ", start, end);
+        return this.getTextWithPlaceholders(start, end);
     }
     getTextRangeWithMarkers(start, end) {
         const segmentWindow = this.client.getCollabWindow();
@@ -191,4 +196,22 @@ export class SharedString extends SharedSegmentSequence {
         }
     }
 }
+/**
+ * Splits the text into regions ending with markers with the given `label`.
+ * @param sharedString - String to retrieve text and markers from
+ * @param label - label to split on
+ * @returns Two parallel lists of text and markers, split by markers with the provided `label`.
+ *
+ * For example:
+ * ```typescript
+ * // Say sharedstring has contents "hello<paragraph marker 1>world<paragraph marker 2>missing".
+ * const { parallelText, parallelMarkers } = getTextAndMarkers(sharedString, "paragraph");
+ * // parallelText === ["hello", "world"]
+ * // parallelMarkers === [<paragraph marker 1 object>, <paragraph marker 2 object>]
+ * // Note parallelText does not include "missing".
+ * ```
+ */
+export function getTextAndMarkers(sharedString, label) {
+    return sharedString.getTextAndMarkers(label);
+}
 //# sourceMappingURL=sharedString.js.map

package/lib/sharedString.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedString.js","sourceRoot":"","sources":["../src/sharedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAOH,MAAM,EAIN,WAAW,GACd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AA8BxD;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAA0C;IAyBxE,YAAY,QAAgC,EAAS,EAAU,EAAE,UAA8B;QAC3F,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;QADpB,OAAE,GAAF,EAAE,CAAQ;QAE3D,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAC9D,CAAC;IA3BD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,mBAAmB,CAAC,IAAI,CAAiB,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,mBAAmB,EAAE,CAAC;IACrC,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IASD;;;;;OAKG;IACI,oBAAoB,CACvB,YAA+B,EAC/B,OAAsB,EACtB,KAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACI,YAAY,CACf,GAAW,EACX,OAAsB,EACtB,KAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,YAA+B,EAAE,IAAY,EAAE,KAAmB;QACxF,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,GAAW,EAAE,IAAY,EAAE,KAAmB;QAC5D,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,KAAa,EAAE,GAAW,EAAE,IAAY,EAAE,KAAmB;QAC5E,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,KAAa,EAAE,GAAW;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,6BAA6B,CAChC,MAAc,EACd,KAAkB,EAClB,QAA6B;QAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtF,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;SAC1C;IACL,CAAC;IAED;;;;;OAKG;IACI,cAAc,CACjB,MAAc,EACd,KAAkB,EAClB,WAA0B;QAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC1E,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;SAC1C;IACL,CAAC;IAEM,QAAQ,CAAC,QAA4B,EAAE,SAAiB,EAAE,SAAS,GAAG,IAAI;QAI7E,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;IAEM,iBAAiB,CAAC,KAAa;QAClC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,KAAc,EAAE,GAAY;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9G,CAAC;IAED;;OAEG;IACI,uBAAuB;QAC1B,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnG,CAAC;IAEM,4BAA4B,CAAC,KAAa,EAAE,GAAW;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/G,CAAC;IAEM,uBAAuB,CAAC,KAAa,EAAE,GAAW;QACrD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/G,CAAC;IAEM,eAAe,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;SAClD;aAAM;YACH,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;SAC5C;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ICombiningOp,\n    IMergeTreeInsertMsg,\n    IMergeTreeRemoveMsg,\n    IMergeTreeTextHelper,\n    IRelativePosition,\n    ISegment,\n    Marker,\n    PropertySet,\n    ReferencePosition,\n    ReferenceType,\n    TextSegment,\n} from \"@fluidframework/merge-tree\";\nimport { IFluidDataStoreRuntime, IChannelAttributes } from \"@fluidframework/datastore-definitions\";\nimport { SharedSegmentSequence } from \"./sequence\";\nimport { SharedStringFactory } from \"./sequenceFactory\";\n\n/**\n * Fluid object interface describing access methods on a SharedString\n */\nexport interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {\n    /**\n     * Inserts the text at the position.\n     * @param pos - The position to insert the text at\n     * @param text - The text to insert\n     * @param props - The properties of the text\n     */\n    insertText(pos: number, text: string, props?: PropertySet): void;\n\n    /**\n     * Inserts a marker at the position.\n     * @param pos - The position to insert the marker at\n     * @param refType - The reference type of the marker\n     * @param props - The properties of the marker\n     */\n    insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): IMergeTreeInsertMsg;\n\n    /**\n     * {@inheritDoc SharedSegmentSequence.posFromRelativePos}\n     */\n    posFromRelativePos(relativePos: IRelativePosition): number;\n}\n\nexport type SharedStringSegment = TextSegment | Marker;\n\n/**\n * The Shared String is a specialized data structure for handling collaborative\n * text. It is based on a more general Sequence data structure but has\n * additional features that make working with text easier.\n *\n * In addition to text, a Shared String can also contain markers. Markers can be\n * used to store metadata at positions within the text, like the details of an\n * image or Fluid object that should be rendered with the text.\n *\n */\nexport class SharedString extends SharedSegmentSequence<SharedStringSegment> implements ISharedString {\n    /**\n     * Create a new shared string.\n     * @param runtime - data store runtime the new shared string belongs to\n     * @param id - optional name of the shared string\n     * @returns newly create shared string (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, SharedStringFactory.Type) as SharedString;\n    }\n\n    /**\n     * Get a factory for SharedString to register with the data store.\n     * @returns a factory that creates and load SharedString\n     */\n    public static getFactory() {\n        return new SharedStringFactory();\n    }\n\n    public get ISharedString(): ISharedString {\n        return this;\n    }\n\n    private readonly mergeTreeTextHelper: IMergeTreeTextHelper;\n\n    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {\n        super(document, id, attributes, SharedStringFactory.segmentFromSpec);\n        this.mergeTreeTextHelper = this.client.createTextHelper();\n    }\n\n    /**\n     * Inserts a marker at a relative position.\n     * @param relativePos1 - The relative position to insert the marker at\n     * @param refType - The reference type of the marker\n     * @param props - The properties of the marker\n     */\n    public insertMarkerRelative(\n        relativePos1: IRelativePosition,\n        refType: ReferenceType,\n        props?: PropertySet) {\n        const segment = new Marker(refType);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const pos = this.posFromRelativePos(relativePos1);\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    /**\n     * {@inheritDoc ISharedString.insertMarker}\n     */\n    public insertMarker(\n        pos: number,\n        refType: ReferenceType,\n        props?: PropertySet): IMergeTreeInsertMsg {\n        const segment = new Marker(refType);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n        return insertOp;\n    }\n\n    /**\n     * Inserts the text at the position.\n     * @param relativePos1 - The relative position to insert the text at\n     * @param text - The text to insert\n     * @param props - The properties of text\n     */\n    public insertTextRelative(relativePos1: IRelativePosition, text: string, props?: PropertySet) {\n        const segment = new TextSegment(text);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const pos = this.posFromRelativePos(relativePos1);\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    /**\n     * {@inheritDoc ISharedString.insertText}\n     */\n    public insertText(pos: number, text: string, props?: PropertySet) {\n        const segment = new TextSegment(text);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    /**\n     * Replaces a range with the provided text.\n     * @param start - The inclusive start of the range to replace\n     * @param end - The exclusive end of the range to replace\n     * @param text - The text to replace the range with\n     * @param props - Optional. The properties of the replacement text\n     */\n    public replaceText(start: number, end: number, text: string, props?: PropertySet) {\n        this.replaceRange(start, end, TextSegment.make(text, props));\n    }\n\n    /**\n     * Removes the text in the given range.\n     * @param start - The inclusive start of the range to remove\n     * @param end - The exclusive end of the range to replace\n     * @returns the message sent.\n     */\n    public removeText(start: number, end: number): IMergeTreeRemoveMsg {\n        return this.removeRange(start, end);\n    }\n\n    /**\n     * Annotates the marker with the provided properties and calls the callback on consensus.\n     * @param marker - The marker to annotate\n     * @param props - The properties to annotate the marker with\n     * @param consensusCallback - The callback called when consensus is reached\n     */\n    public annotateMarkerNotifyConsensus(\n        marker: Marker,\n        props: PropertySet,\n        callback: (m: Marker) => void) {\n        const annotateOp = this.client.annotateMarkerNotifyConsensus(marker, props, callback);\n        if (annotateOp) {\n            this.submitSequenceMessage(annotateOp);\n        }\n    }\n\n    /**\n     * Annotates the marker with the provided properties.\n     * @param marker - The marker to annotate\n     * @param props - The properties to annotate the marker with\n     * @param combiningOp - Optional. Specifies how to combine values for the property, such as \"incr\" for increment.\n     */\n    public annotateMarker(\n        marker: Marker,\n        props: PropertySet,\n        combiningOp?: ICombiningOp) {\n        const annotateOp = this.client.annotateMarker(marker, props, combiningOp);\n        if (annotateOp) {\n            this.submitSequenceMessage(annotateOp);\n        }\n    }\n\n    public findTile(startPos: number | undefined, tileLabel: string, preceding = true): {\n        tile: ReferencePosition;\n        pos: number;\n    } {\n        return this.client.findTile(startPos, tileLabel, preceding);\n    }\n\n    public getTextAndMarkers(label: string) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getTextAndMarkers(segmentWindow.currentSeq, segmentWindow.clientId, label);\n    }\n\n    /**\n     * Retrieve text from the SharedString in string format.\n     * @param start - The starting index of the text to retrieve, or 0 if omitted.\n     * @param end - The ending index of the text to retrieve, or the end of the string if omitted\n     * @returns The requested text content as a string.\n     */\n    public getText(start?: number, end?: number) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \"\", start, end);\n    }\n\n    /**\n     * Adds spaces for markers and handles, so that position calculations account for them.\n     */\n    public getTextWithPlaceholders() {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \" \");\n    }\n\n    public getTextRangeWithPlaceholders(start: number, end: number) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \" \", start, end);\n    }\n\n    public getTextRangeWithMarkers(start: number, end: number) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \"*\", start, end);\n    }\n\n    public getMarkerFromId(id: string): ISegment {\n        return this.client.getMarkerFromId(id);\n    }\n\n    /**\n     * Revert an op\n     */\n    protected rollback(content: any, localOpMetadata: unknown): void {\n        if (this.client.rollback !== undefined) {\n            this.client.rollback(content, localOpMetadata);\n        } else {\n            super.rollback(content, localOpMetadata);\n        }\n    }\n}\n"]}
+{"version":3,"file":"sharedString.js","sourceRoot":"","sources":["../src/sharedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAOH,MAAM,EAIN,WAAW,GACd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AA8BxD;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAA0C;IAyBxE,YAAY,QAAgC,EAAS,EAAU,EAAE,UAA8B;QAC3F,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;QADpB,OAAE,GAAF,EAAE,CAAQ;QAE3D,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAC9D,CAAC;IA3BD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,mBAAmB,CAAC,IAAI,CAAiB,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,mBAAmB,EAAE,CAAC;IACrC,CAAC;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IASD;;;;;OAKG;IACI,oBAAoB,CACvB,YAA+B,EAC/B,OAAsB,EACtB,KAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACI,YAAY,CACf,GAAW,EACX,OAAsB,EACtB,KAAmB;QACnB,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,YAA+B,EAAE,IAAY,EAAE,KAAmB;QACxF,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,GAAW,EAAE,IAAY,EAAE,KAAmB;QAC5D,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;IACL,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,KAAa,EAAE,GAAW,EAAE,IAAY,EAAE,KAAmB;QAC5E,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,KAAa,EAAE,GAAW;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,6BAA6B,CAChC,MAAc,EACd,KAAkB,EAClB,QAA6B;QAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtF,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;SAC1C;IACL,CAAC;IAED;;;;;OAKG;IACI,cAAc,CACjB,MAAc,EACd,KAAkB,EAClB,WAA0B;QAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAC1E,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;SAC1C;IACL,CAAC;IAEM,QAAQ,CAAC,QAA4B,EAAE,SAAiB,EAAE,SAAS,GAAG,IAAI;QAI7E,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,KAAa;QAClC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,KAAc,EAAE,GAAY;QACvC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9G,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,KAAc,EAAE,GAAY;QACvD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACI,4BAA4B,CAAC,KAAa,EAAE,GAAW;QAC1D,OAAO,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpD,CAAC;IAEM,uBAAuB,CAAC,KAAa,EAAE,GAAW;QACrD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/G,CAAC;IAEM,eAAe,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAY,EAAE,eAAwB;QACrD,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;SAClD;aAAM;YACH,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;SAC5C;IACL,CAAC;CACJ;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAA0B,EAAE,KAAa;IAIvE,OAAO,YAAY,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ICombiningOp,\n    IMergeTreeInsertMsg,\n    IMergeTreeRemoveMsg,\n    IMergeTreeTextHelper,\n    IRelativePosition,\n    ISegment,\n    Marker,\n    PropertySet,\n    ReferencePosition,\n    ReferenceType,\n    TextSegment,\n} from \"@fluidframework/merge-tree\";\nimport { IFluidDataStoreRuntime, IChannelAttributes } from \"@fluidframework/datastore-definitions\";\nimport { SharedSegmentSequence } from \"./sequence\";\nimport { SharedStringFactory } from \"./sequenceFactory\";\n\n/**\n * Fluid object interface describing access methods on a SharedString\n */\nexport interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {\n    /**\n     * Inserts the text at the position.\n     * @param pos - The position to insert the text at\n     * @param text - The text to insert\n     * @param props - The properties of the text\n     */\n    insertText(pos: number, text: string, props?: PropertySet): void;\n\n    /**\n     * Inserts a marker at the position.\n     * @param pos - The position to insert the marker at\n     * @param refType - The reference type of the marker\n     * @param props - The properties of the marker\n     */\n    insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): IMergeTreeInsertMsg;\n\n    /**\n     * {@inheritDoc SharedSegmentSequence.posFromRelativePos}\n     */\n    posFromRelativePos(relativePos: IRelativePosition): number;\n}\n\nexport type SharedStringSegment = TextSegment | Marker;\n\n/**\n * The Shared String is a specialized data structure for handling collaborative\n * text. It is based on a more general Sequence data structure but has\n * additional features that make working with text easier.\n *\n * In addition to text, a Shared String can also contain markers. Markers can be\n * used to store metadata at positions within the text, like the details of an\n * image or Fluid object that should be rendered with the text.\n *\n */\nexport class SharedString extends SharedSegmentSequence<SharedStringSegment> implements ISharedString {\n    /**\n     * Create a new shared string.\n     * @param runtime - data store runtime the new shared string belongs to\n     * @param id - optional name of the shared string\n     * @returns newly create shared string (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, SharedStringFactory.Type) as SharedString;\n    }\n\n    /**\n     * Get a factory for SharedString to register with the data store.\n     * @returns a factory that creates and load SharedString\n     */\n    public static getFactory() {\n        return new SharedStringFactory();\n    }\n\n    public get ISharedString(): ISharedString {\n        return this;\n    }\n\n    private readonly mergeTreeTextHelper: IMergeTreeTextHelper;\n\n    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {\n        super(document, id, attributes, SharedStringFactory.segmentFromSpec);\n        this.mergeTreeTextHelper = this.client.createTextHelper();\n    }\n\n    /**\n     * Inserts a marker at a relative position.\n     * @param relativePos1 - The relative position to insert the marker at\n     * @param refType - The reference type of the marker\n     * @param props - The properties of the marker\n     */\n    public insertMarkerRelative(\n        relativePos1: IRelativePosition,\n        refType: ReferenceType,\n        props?: PropertySet) {\n        const segment = new Marker(refType);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const pos = this.posFromRelativePos(relativePos1);\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    /**\n     * {@inheritDoc ISharedString.insertMarker}\n     */\n    public insertMarker(\n        pos: number,\n        refType: ReferenceType,\n        props?: PropertySet): IMergeTreeInsertMsg {\n        const segment = new Marker(refType);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n        return insertOp;\n    }\n\n    /**\n     * Inserts the text at the position.\n     * @param relativePos1 - The relative position to insert the text at\n     * @param text - The text to insert\n     * @param props - The properties of text\n     */\n    public insertTextRelative(relativePos1: IRelativePosition, text: string, props?: PropertySet) {\n        const segment = new TextSegment(text);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const pos = this.posFromRelativePos(relativePos1);\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    /**\n     * {@inheritDoc ISharedString.insertText}\n     */\n    public insertText(pos: number, text: string, props?: PropertySet) {\n        const segment = new TextSegment(text);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    /**\n     * Replaces a range with the provided text.\n     * @param start - The inclusive start of the range to replace\n     * @param end - The exclusive end of the range to replace\n     * @param text - The text to replace the range with\n     * @param props - Optional. The properties of the replacement text\n     */\n    public replaceText(start: number, end: number, text: string, props?: PropertySet) {\n        this.replaceRange(start, end, TextSegment.make(text, props));\n    }\n\n    /**\n     * Removes the text in the given range.\n     * @param start - The inclusive start of the range to remove\n     * @param end - The exclusive end of the range to replace\n     * @returns the message sent.\n     */\n    public removeText(start: number, end: number): IMergeTreeRemoveMsg {\n        return this.removeRange(start, end);\n    }\n\n    /**\n     * Annotates the marker with the provided properties and calls the callback on consensus.\n     * @param marker - The marker to annotate\n     * @param props - The properties to annotate the marker with\n     * @param consensusCallback - The callback called when consensus is reached\n     */\n    public annotateMarkerNotifyConsensus(\n        marker: Marker,\n        props: PropertySet,\n        callback: (m: Marker) => void) {\n        const annotateOp = this.client.annotateMarkerNotifyConsensus(marker, props, callback);\n        if (annotateOp) {\n            this.submitSequenceMessage(annotateOp);\n        }\n    }\n\n    /**\n     * Annotates the marker with the provided properties.\n     * @param marker - The marker to annotate\n     * @param props - The properties to annotate the marker with\n     * @param combiningOp - Optional. Specifies how to combine values for the property, such as \"incr\" for increment.\n     */\n    public annotateMarker(\n        marker: Marker,\n        props: PropertySet,\n        combiningOp?: ICombiningOp) {\n        const annotateOp = this.client.annotateMarker(marker, props, combiningOp);\n        if (annotateOp) {\n            this.submitSequenceMessage(annotateOp);\n        }\n    }\n\n    public findTile(startPos: number | undefined, tileLabel: string, preceding = true): {\n        tile: ReferencePosition;\n        pos: number;\n    } {\n        return this.client.findTile(startPos, tileLabel, preceding);\n    }\n\n    /**\n     * @deprecated - use the free function `getTextAndMarkers` exported by this package instead.\n     */\n    public getTextAndMarkers(label: string) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getTextAndMarkers(segmentWindow.currentSeq, segmentWindow.clientId, label);\n    }\n\n    /**\n     * Retrieve text from the SharedString in string format.\n     * @param start - The starting index of the text to retrieve, or 0 if omitted.\n     * @param end - The ending index of the text to retrieve, or the end of the string if omitted\n     * @returns The requested text content as a string.\n     */\n    public getText(start?: number, end?: number) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \"\", start, end);\n    }\n\n    /**\n     * Adds spaces for markers and handles, so that position calculations account for them.\n     */\n    public getTextWithPlaceholders(start?: number, end?: number) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \" \", start, end);\n    }\n\n    /**\n     * @deprecated - use `getTextWithPlaceholders` instead.\n     */\n    public getTextRangeWithPlaceholders(start: number, end: number) {\n        return this.getTextWithPlaceholders(start, end);\n    }\n\n    public getTextRangeWithMarkers(start: number, end: number) {\n        const segmentWindow = this.client.getCollabWindow();\n        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, \"*\", start, end);\n    }\n\n    public getMarkerFromId(id: string): ISegment {\n        return this.client.getMarkerFromId(id);\n    }\n\n    /**\n     * Revert an op\n     */\n    protected rollback(content: any, localOpMetadata: unknown): void {\n        if (this.client.rollback !== undefined) {\n            this.client.rollback(content, localOpMetadata);\n        } else {\n            super.rollback(content, localOpMetadata);\n        }\n    }\n}\n\n/**\n * Splits the text into regions ending with markers with the given `label`.\n * @param sharedString - String to retrieve text and markers from\n * @param label - label to split on\n * @returns Two parallel lists of text and markers, split by markers with the provided `label`.\n *\n * For example:\n * ```typescript\n * // Say sharedstring has contents \"hello<paragraph marker 1>world<paragraph marker 2>missing\".\n * const { parallelText, parallelMarkers } = getTextAndMarkers(sharedString, \"paragraph\");\n * // parallelText === [\"hello\", \"world\"]\n * // parallelMarkers === [<paragraph marker 1 object>, <paragraph marker 2 object>]\n * // Note parallelText does not include \"missing\".\n * ```\n */\nexport function getTextAndMarkers(sharedString: SharedString, label: string): {\n    parallelText: string[];\n    parallelMarkers: Marker[];\n} {\n    return sharedString.getTextAndMarkers(label);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.0.0-internal.1.0.0.83139",
+  "version": "2.0.0-internal.1.1.1",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -30,11 +30,15 @@
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
+    "postpack": "cd dist && tar -cvf ../sequence.test-files.tar ./test",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --recursive dist/test/**/*.spec.js -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:memory": "mocha --config src/test/memory/.mocharc.js",
+    "test:memory-profiling:report": "mocha --config src/test/memory/.mocharc.js",
+    "test:mocha": "mocha --ignore 'dist/test/memory/**/*' --recursive 'dist/test/**/*.spec.js' -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "test:newsnapfiles": "node dist/test/createSnapshotFiles.js",
+    "test:stress": "cross-env FUZZ_TEST_COUNT=100 FUZZ_STRESS_RUN=true npm run test:mocha",
     "testfarm": "node dist/test/testFarm.js",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
@@ -63,29 +67,30 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-utils": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/core-interfaces": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/datastore-definitions": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/merge-tree": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/protocol-definitions": "^0.1029.1000-0",
-    "@fluidframework/runtime-definitions": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/runtime-utils": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/shared-object-base": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/telemetry-utils": "2.0.0-internal.1.0.0.83139",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/container-utils": "^2.0.0-internal.1.1.1",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.1.1.1",
+    "@fluidframework/datastore-definitions": "^2.0.0-internal.1.1.1",
+    "@fluidframework/merge-tree": "^2.0.0-internal.1.1.1",
+    "@fluidframework/protocol-definitions": "^1.0.0",
+    "@fluidframework/runtime-definitions": "^2.0.0-internal.1.1.1",
+    "@fluidframework/runtime-utils": "^2.0.0-internal.1.1.1",
+    "@fluidframework/shared-object-base": "^2.0.0-internal.1.1.1",
+    "@fluidframework/telemetry-utils": "^2.0.0-internal.1.1.1",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/stochastic-test-utils": "2.0.0-internal.1.0.0.83139",
-    "@fluid-internal/test-dds-utils": "2.0.0-internal.1.0.0.83139",
+    "@fluid-internal/stochastic-test-utils": "^2.0.0-internal.1.1.1",
+    "@fluid-internal/test-dds-utils": "^2.0.0-internal.1.1.1",
+    "@fluid-tools/benchmark": "^0.43.0",
     "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.3.0-0",
+    "@fluidframework/build-tools": "^0.3.1000",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/gitresources": "^0.1037.1000-0",
-    "@fluidframework/mocha-test-setup": "2.0.0-internal.1.0.0.83139",
+    "@fluidframework/gitresources": "^0.1037.1000",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.1.1",
     "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@^1.0.0",
-    "@fluidframework/server-services-client": "^0.1037.1000-0",
-    "@fluidframework/test-runtime-utils": "2.0.0-internal.1.0.0.83139",
+    "@fluidframework/server-services-client": "^0.1037.1000",
+    "@fluidframework/test-runtime-utils": "^2.0.0-internal.1.1.1",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/diff": "^3.5.1",
@@ -93,7 +98,7 @@
     "@types/node": "^14.18.0",
     "@types/random-js": "^1.0.31",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.2",
     "diff": "^3.5.0",
     "eslint": "~8.6.0",

package/src/index.ts

@@ -22,6 +22,8 @@ export {
     Interval,
     IntervalCollection,
     IntervalCollectionIterator,
+    IntervalLocator,
+    intervalLocatorFromEndpoint,
     IntervalType,
     ISerializableInterval,
     ISerializedInterval,

package/src/intervalCollection.ts

@@ -32,6 +32,7 @@ import {
     UnassignedSequenceNumber,
     maxReferencePosition,
     createDetachedLocalReferencePosition,
+    DetachedReferencePosition,
 } from "@fluidframework/merge-tree";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { LoggingError } from "@fluidframework/telemetry-utils";
@@ -99,7 +100,7 @@ function decompressInterval(interval: CompressedSerializedInterval, label?: stri
         end: interval[1],
         sequenceNumber: interval[2],
         intervalType: interval[3],
-        properties: { ...interval[4], [reservedRangeLabelsKey]: label },
+        properties: { ...interval[4], [reservedRangeLabelsKey]: [label] },
     };
 }
 
@@ -191,11 +192,7 @@ export class Interval implements ISerializableInterval {
     }
 
     public serialize(client: Client): ISerializedInterval {
-        let seq = 0;
-        if (client) {
-            seq = client.getCurrentSeq();
-        }
-
+        const seq = client?.getCurrentSeq() ?? 0;
         const serializedInterval: ISerializedInterval = {
             end: this.end,
             intervalType: 0,
@@ -431,7 +428,7 @@ export class SequenceInterval implements ISerializableInterval {
         return (endPos > bstart) && (startPos < bend);
     }
 
-    public modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage) {
+    public modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage, localSeq?: number) {
         const getRefType = (baseType: ReferenceType): ReferenceType => {
             let refType = baseType;
             if (op === undefined) {
@@ -443,13 +440,17 @@ export class SequenceInterval implements ISerializableInterval {
 
         let startRef = this.start;
         if (start !== undefined) {
-            startRef = createPositionReference(this.client, start, getRefType(this.start.refType), op);
+            startRef = createPositionReference(
+                this.client, start, getRefType(this.start.refType), op, undefined, localSeq,
+            );
             startRef.addProperties(this.start.properties);
         }
 
         let endRef = this.end;
         if (end !== undefined) {
-            endRef = createPositionReference(this.client, end, getRefType(this.end.refType), op);
+            endRef = createPositionReference(
+                this.client, end, getRefType(this.end.refType), op, undefined, localSeq,
+            );
             endRef.addProperties(this.end.properties);
         }
 
@@ -479,11 +480,13 @@ function createPositionReferenceFromSegoff(
     if (segoff.segment) {
         const ref = client.createLocalReferencePosition(segoff.segment, segoff.offset, refType, undefined);
         return ref;
-    } else {
-        if (!op && !refTypeIncludesFlag(refType, ReferenceType.Transient)) {
-            throw new UsageError("Non-transient references need segment");
-        }
     }
+
+    if (!op && !refTypeIncludesFlag(refType, ReferenceType.Transient)) {
+        // reference to segment that dne locally
+        throw new UsageError("Non-transient references need segment");
+    }
+
     return createDetachedLocalReferencePosition(refType);
 }
 
@@ -492,7 +495,9 @@ function createPositionReference(
     pos: number,
     refType: ReferenceType,
     op?: ISequencedDocumentMessage,
-    fromSnapshot?: boolean): LocalReferencePosition {
+    fromSnapshot?: boolean,
+    localSeq?: number,
+): LocalReferencePosition {
     let segoff;
     if (op) {
         assert((refType & ReferenceType.SlideOnRemove) !== 0, 0x2f5 /* op create references must be SlideOnRemove */);
@@ -501,7 +506,7 @@ function createPositionReference(
     } else {
         assert((refType & ReferenceType.SlideOnRemove) === 0 || fromSnapshot,
             0x2f6 /* SlideOnRemove references must be op created */);
-        segoff = client.getContainingSegment(pos);
+        segoff = client.getContainingSegment(pos, undefined, localSeq);
     }
     return createPositionReferenceFromSegoff(client, segoff, refType, op);
 }
@@ -793,18 +798,23 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
             if (!interval.properties) {
                 interval.properties = createMap<any>();
             }
+
             if (props) {
                 interval.addProperties(props);
             }
-            if (interval.properties[reservedIntervalIdKey] === undefined) {
-                // Create a new ID.
-                interval.properties[reservedIntervalIdKey] = uuid();
-            }
+            interval.properties[reservedIntervalIdKey] ??= uuid();
             this.add(interval);
         }
         return interval;
     }
 
+    private linkEndpointsToInterval(interval: TInterval): void {
+        if (interval instanceof SequenceInterval) {
+            interval.start.addProperties({ interval });
+            interval.end.addProperties({ interval });
+        }
+    }
+
     private addIntervalToIndex(interval: TInterval) {
         const id = interval.getIntervalId();
         assert(id !== undefined, 0x2c0 /* "ID must be created before adding interval to collection" */);
@@ -820,6 +830,7 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
     }
 
     public add(interval: TInterval) {
+        this.linkEndpointsToInterval(interval);
         this.addIntervalToIndex(interval);
         this.addIntervalListeners(interval);
     }
@@ -828,8 +839,14 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
         return this.intervalIdMap.get(id);
     }
 
-    public changeInterval(interval: TInterval, start: number, end: number, op?: ISequencedDocumentMessage) {
-        const newInterval = interval.modify(this.label, start, end, op) as TInterval | undefined;
+    public changeInterval(
+        interval: TInterval,
+        start: number,
+        end: number,
+        op?: ISequencedDocumentMessage,
+        localSeq?: number,
+    ) {
+        const newInterval = interval.modify(this.label, start, end, op, localSeq) as TInterval | undefined;
         if (newInterval) {
             this.removeExistingInterval(interval);
             this.add(newInterval);
@@ -980,6 +997,11 @@ function makeOpsMap<T extends ISerializableInterval>(): Map<string, IValueOperat
             "add",
             {
                 process: (collection, params, local, op) => {
+                    // if params is undefined, the interval was deleted during
+                    // rebasing
+                    if (!params) {
+                        return;
+                    }
                     collection.ackAdd(params, local, op);
                 },
                 rebase,
@@ -1001,6 +1023,11 @@ function makeOpsMap<T extends ISerializableInterval>(): Map<string, IValueOperat
             "change",
             {
                 process: (collection, params, local, op) => {
+                    // if params is undefined, the interval was deleted during
+                    // rebasing
+                    if (!params) {
+                        return;
+                    }
                     collection.ackChange(params, local, op);
                 },
                 rebase,
@@ -1063,7 +1090,7 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
     private savedSerializedIntervals?: ISerializedInterval[];
     private localCollection: LocalIntervalCollection<TInterval>;
     private onDeserialize: DeserializeCallback | undefined;
-    private client: Client;
+    private client: Client | undefined;
     private readonly pendingChangesStart: Map<string, ISerializedInterval[]> = new Map<string, ISerializedInterval[]>();
     private readonly pendingChangesEnd: Map<string, ISerializedInterval[]> = new Map<string, ISerializedInterval[]>();
 
@@ -1129,7 +1156,11 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
      * Gets the next local sequence number, modifying this client's collab window in doing so.
      */
     private getNextLocalSeq(): number {
-        return ++this.client.getCollabWindow().localSeq;
+        if (this.client) {
+            return ++this.client.getCollabWindow().localSeq;
+        }
+
+        return 0;
     }
 
     public getIntervalById(id: string) {
@@ -1411,12 +1442,22 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
         });
     }
 
-    /** @internal */
+    /**
+     * @internal
+     *
+     * Returns new interval after rebasing. If undefined, the interval was
+     * deleted as a result of rebasing. This can occur if the interval applies
+     * to a range that no longer exists, and the interval was unable to slide.
+     */
     public rebaseLocalInterval(
         opName: string,
         serializedInterval: ISerializedInterval,
         localSeq: number,
-    ) {
+    ): ISerializedInterval | undefined {
+        if (!this.client) {
+            // If there's no associated mergeTree client, the originally submitted op is still correct.
+            return serializedInterval;
+        }
         if (!this.attached) {
             throw new LoggingError("attachSequence must be called");
         }
@@ -1428,6 +1469,8 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
             this.client.rebasePosition(end, sequenceNumber, localSeq);
 
         const intervalId = properties?.[reservedIntervalIdKey];
+        const localInterval = this.localCollection.getIntervalById(intervalId);
+
         const rebased: ISerializedInterval = {
             start: startRebased,
             end: endRebased,
@@ -1435,10 +1478,44 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
             sequenceNumber: this.client?.getCurrentSeq() ?? 0,
             properties,
         };
+
         if (opName === "change" && (this.hasPendingChangeStart(intervalId) || this.hasPendingChangeEnd(intervalId))) {
             this.removePendingChange(serializedInterval);
             this.addPendingChange(intervalId, rebased);
         }
+
+        // if the interval slid off the string, rebase the op to be a noop and
+        // delete the interval
+        if (startRebased === DetachedReferencePosition || endRebased === DetachedReferencePosition) {
+            if (localInterval) {
+                this.localCollection.removeExistingInterval(localInterval);
+            }
+            return undefined;
+        }
+
+        if (!localInterval) {
+            return rebased;
+        }
+
+        // we know we must be using `SequenceInterval` because `this.client` exists
+        assert(
+            localInterval instanceof SequenceInterval,
+            0x3a0 /* localInterval must be `SequenceInterval` when used with client */,
+        );
+
+        const startSegment = this.getSlideToSegment(localInterval.start);
+        const endSegment = this.getSlideToSegment(localInterval.end);
+
+        // we need to slide because the reference has been removed
+        if (startSegment || endSegment) {
+            const newStart =
+                startSegment && this.client.getPosition(startSegment.segment, localSeq) + startSegment.offset;
+            const newEnd =
+                endSegment && this.client.getPosition(endSegment.segment, localSeq) + endSegment.offset;
+
+            this.localCollection.changeInterval(localInterval, newStart, newEnd, undefined, localSeq);
+        }
+
         return rebased;
     }
 
@@ -1458,7 +1535,7 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
     }
 
     private ackInterval(interval: TInterval, op: ISequencedDocumentMessage) {
-        // in current usage, interval is always a SequenceInterval
+        // Only SequenceIntervals need potential sliding
         if (!(interval instanceof SequenceInterval)) {
             return;
         }
@@ -1653,3 +1730,31 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
         return this.localCollection.nextInterval(pos);
     }
 }
+
+/**
+ * Information that identifies an interval within a `Sequence`.
+ */
+export interface IntervalLocator {
+    /**
+     * Label for the collection the interval is a part of
+     */
+    label: string;
+    /**
+     * Interval within that collection
+     */
+    interval: SequenceInterval;
+}
+
+/**
+ * Returns an object that can be used to find the interval a given LocalReferencePosition belongs to.
+ * @returns undefined if the reference position is not the endpoint of any interval (e.g. it was created
+ * on the merge tree directly by app code), otherwise an {@link IntervalLocator} for the interval this
+ * endpoint is a part of.
+ */
+export function intervalLocatorFromEndpoint(potentialEndpoint: LocalReferencePosition): IntervalLocator | undefined {
+    const {
+        interval,
+        [reservedRangeLabelsKey]: collectionNameArray,
+    } = potentialEndpoint.properties ?? {};
+    return (interval && collectionNameArray?.length === 1) ? { label: collectionNameArray[0], interval } : undefined;
+}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.0.0-internal.1.0.0.83139";
+export const pkgVersion = "2.0.0-internal.1.1.1";

package/src/sharedString.ts

@@ -223,6 +223,9 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
         return this.client.findTile(startPos, tileLabel, preceding);
     }
 
+    /**
+     * @deprecated - use the free function `getTextAndMarkers` exported by this package instead.
+     */
     public getTextAndMarkers(label: string) {
         const segmentWindow = this.client.getCollabWindow();
         return this.mergeTreeTextHelper.getTextAndMarkers(segmentWindow.currentSeq, segmentWindow.clientId, label);
@@ -242,14 +245,16 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
     /**
      * Adds spaces for markers and handles, so that position calculations account for them.
      */
-    public getTextWithPlaceholders() {
+    public getTextWithPlaceholders(start?: number, end?: number) {
         const segmentWindow = this.client.getCollabWindow();
-        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ");
+        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ", start, end);
     }
 
+    /**
+     * @deprecated - use `getTextWithPlaceholders` instead.
+     */
     public getTextRangeWithPlaceholders(start: number, end: number) {
-        const segmentWindow = this.client.getCollabWindow();
-        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ", start, end);
+        return this.getTextWithPlaceholders(start, end);
     }
 
     public getTextRangeWithMarkers(start: number, end: number) {
@@ -272,3 +277,25 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
         }
     }
 }
+
+/**
+ * Splits the text into regions ending with markers with the given `label`.
+ * @param sharedString - String to retrieve text and markers from
+ * @param label - label to split on
+ * @returns Two parallel lists of text and markers, split by markers with the provided `label`.
+ *
+ * For example:
+ * ```typescript
+ * // Say sharedstring has contents "hello<paragraph marker 1>world<paragraph marker 2>missing".
+ * const { parallelText, parallelMarkers } = getTextAndMarkers(sharedString, "paragraph");
+ * // parallelText === ["hello", "world"]
+ * // parallelMarkers === [<paragraph marker 1 object>, <paragraph marker 2 object>]
+ * // Note parallelText does not include "missing".
+ * ```
+ */
+export function getTextAndMarkers(sharedString: SharedString, label: string): {
+    parallelText: string[];
+    parallelMarkers: Marker[];
+} {
+    return sharedString.getTextAndMarkers(label);
+}