@fluidframework/sequence 1.3.0 → 2.0.0-dev.1.4.5.105745

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 {@link 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 {@link SharedString.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();
@@ -179,5 +184,34 @@ export class SharedString extends SharedSegmentSequence {
     getMarkerFromId(id) {
         return this.client.getMarkerFromId(id);
     }
+    /**
+     * Revert an op
+     */
+    rollback(content, localOpMetadata) {
+        if (this.client.rollback !== undefined) {
+            this.client.rollback(content, localOpMetadata);
+        }
+        else {
+            super.rollback(content, localOpMetadata);
+        }
+    }
+}
+/**
+ * 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,EAMH,MAAM,EAKN,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;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    IRelativePosition,\n    ISegment,\n    Marker,\n    MergeTreeTextHelper,\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: MergeTreeTextHelper;\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"]}
+{"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 {@link 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 {@link SharedString.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/lib/sparsematrix.d.ts

@@ -8,10 +8,11 @@ import { IChannelAttributes, IFluidDataStoreRuntime, IChannelServices, IChannelF
 import { ISharedObject } from "@fluidframework/shared-object-base";
 import { SharedSegmentSequence, SubSequence } from "./";
 /**
- * An empty segment that occupies 'cachedLength' positions.  SparseMatrix uses PaddingSegment
- * to "pad" a run of unoccupied cells.
+ * An empty segment that occupies 'cachedLength' positions.
+ * {@link SparseMatrix} uses `PaddingSegment` to "pad" a run of unoccupied cells.
  *
- * @deprecated PaddingSegment is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `PaddingSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare class PaddingSegment extends BaseSegment {
     static readonly typeString = "PaddingSegment";
@@ -31,11 +32,13 @@ export declare class PaddingSegment extends BaseSegment {
     protected createSplitSegmentAt(pos: number): PaddingSegment;
 }
 /**
- * @deprecated SparseMatrixItem is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `SparseMatrixItem` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare type SparseMatrixItem = Serializable;
 /**
- * @deprecated RunSegment is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `RunSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare class RunSegment extends SubSequence<SparseMatrixItem> {
     items: SparseMatrixItem[];
@@ -53,42 +56,51 @@ export declare class RunSegment extends SubSequence<SparseMatrixItem> {
     protected createSplitSegmentAt(pos: number): RunSegment;
 }
 /**
- * @deprecated MatrixSegment is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `MatrixSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare type MatrixSegment = RunSegment | PaddingSegment;
 /**
- * @deprecated maxCol is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare const maxCol = 2097152;
 /**
- * @deprecated maxCols is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxCols` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare const maxCols: number;
 /**
- * @deprecated maxRow is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxRow` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare const maxRow = 4294967295;
 /**
- * @deprecated maxRows is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxRows` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare const maxRows: number;
 /**
- * @deprecated maxCellPosition is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxCellPosition` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare const maxCellPosition: number;
 /**
- * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare const rowColToPosition: (row: number, col: number) => number;
 /**
- * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare function positionToRowCol(position: number): {
     row: number;
     col: number;
 };
 /**
- * @deprecated SparseMatrix is an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `SparseMatrix` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export declare class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
     id: string;
@@ -122,7 +134,8 @@ export declare class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
     private getSegment;
 }
 /**
- * @deprecated SparseMatrixFactory is an abandoned prototype.  Use SharedMatrixFactory instead.
+ * @deprecated `SparseMatrixFactory` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.
  */
 export declare class SparseMatrixFactory implements IChannelFactory {
     static Type: string;

package/lib/sparsematrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sparsematrix.d.ts","sourceRoot":"","sources":["../src/sparsematrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,WAAW,EAEX,YAAY,EACZ,QAAQ,EAER,WAAW,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,QAAQ,EACX,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAExD;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC3C,gBAAuB,UAAU,oBAAoB;WACvC,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,IAAI,cAAc;WAGhD,cAAc,CAAC,IAAI,EAAE,GAAG;IAUtC,SAAgB,IAAI,oBAA6B;gBAErC,IAAI,EAAE,MAAM;IAKjB,YAAY;;;;IAIZ,KAAK,CAAC,KAAK,SAAI,EAAE,GAAG,CAAC,EAAE,MAAM;IAM7B,SAAS,CAAC,OAAO,EAAE,QAAQ;IAI3B,QAAQ;IAIR,MAAM,CAAC,OAAO,EAAE,QAAQ;IAaxB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAK7C,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAO7C;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,gBAAgB,CAAC;IAmBtC,KAAK,EAAE,gBAAgB,EAAE;IAlB5C,gBAAuB,UAAU,gBAAgB;WACnC,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,IAAI,UAAU;WAG5C,cAAc,CAAC,IAAI,EAAE,GAAG;IAUtC,SAAgB,IAAI,gBAAyB;IAE7C,OAAO,CAAC,IAAI,CAAQ;gBAED,KAAK,EAAE,gBAAgB,EAAE;IAKrC,KAAK,CAAC,KAAK,SAAI,EAAE,GAAG,CAAC,EAAE,MAAM;IAS7B,MAAM,CAAC,OAAO,EAAE,QAAQ;IAexB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKtC,MAAM,CAAC,GAAG,EAAE,MAAM;IAKlB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IAInC,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAa7C;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,UAAU,GAAG,cAAc,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,MAAM,UAAW,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,OAAO,QAAa,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,OAAO,QAAa,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,eAAe,QAAkB,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAS,MAAM,OAAO,MAAM,WAAwB,CAAC;AAElF;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM;;;EAIhD;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,qBAAqB,CAAC,aAAa,CAAC;IAqBb,EAAE,EAAE,MAAM;IApB/D;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;gBAI/B,QAAQ,EAAE,sBAAsB,EAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB;IAI/F,IAAW,OAAO,WAEjB;IAEM,QAAQ,CACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,gBAAgB,EAAE,EAC1B,KAAK,CAAC,EAAE,WAAW;IAYhB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAEnC,QAAQ,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,CAAC;IAa/C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAS/B,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IASzC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAWvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIvC,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAK7D,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAOrD,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,UAAU;CAIrB;AAED;;GAEG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IACvD,OAAc,IAAI,SAA+D;IAEjF,OAAc,UAAU,EAAE,kBAAkB,CAI1C;WAEY,eAAe,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ;IAc3D,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC/B,OAAO,CAAC,aAAa,CAAC;IAMlB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa;CAK7E"}
+{"version":3,"file":"sparsematrix.d.ts","sourceRoot":"","sources":["../src/sparsematrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EACH,WAAW,EAEX,YAAY,EACZ,QAAQ,EAER,WAAW,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,QAAQ,EACX,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAExD;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC3C,gBAAuB,UAAU,oBAAoB;WACvC,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,IAAI,cAAc;WAGhD,cAAc,CAAC,IAAI,EAAE,GAAG;IAUtC,SAAgB,IAAI,oBAA6B;gBAErC,IAAI,EAAE,MAAM;IAKjB,YAAY;;;;IAIZ,KAAK,CAAC,KAAK,SAAI,EAAE,GAAG,CAAC,EAAE,MAAM;IAM7B,SAAS,CAAC,OAAO,EAAE,QAAQ;IAI3B,QAAQ;IAIR,MAAM,CAAC,OAAO,EAAE,QAAQ;IAaxB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAK7C,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAO7C;AAED;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,YAAY,CAAC;AAE5C;;;GAGG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,gBAAgB,CAAC;IAmBtC,KAAK,EAAE,gBAAgB,EAAE;IAlB5C,gBAAuB,UAAU,gBAAgB;WACnC,EAAE,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,IAAI,UAAU;WAG5C,cAAc,CAAC,IAAI,EAAE,GAAG;IAUtC,SAAgB,IAAI,gBAAyB;IAE7C,OAAO,CAAC,IAAI,CAAQ;gBAED,KAAK,EAAE,gBAAgB,EAAE;IAKrC,KAAK,CAAC,KAAK,SAAI,EAAE,GAAG,CAAC,EAAE,MAAM;IAS7B,MAAM,CAAC,OAAO,EAAE,QAAQ;IAexB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKtC,MAAM,CAAC,GAAG,EAAE,MAAM;IAKlB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IAInC,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAa7C;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,UAAU,GAAG,cAAc,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,MAAM,UAAW,CAAC;AAE/B;;;GAGG;AACF,eAAO,MAAM,OAAO,QAAa,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,MAAM,aAAa,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,OAAO,QAAa,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAkB,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,gBAAgB,QAAS,MAAM,OAAO,MAAM,WAAwB,CAAC;AAElF;;;GAGG;AACJ,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM;;;EAIhD;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,qBAAqB,CAAC,aAAa,CAAC;IAqBb,EAAE,EAAE,MAAM;IApB/D;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;gBAI/B,QAAQ,EAAE,sBAAsB,EAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB;IAI/F,IAAW,OAAO,WAEjB;IAEM,QAAQ,CACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,gBAAgB,EAAE,EAC1B,KAAK,CAAC,EAAE,WAAW;IAYhB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAEnC,QAAQ,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,CAAC;IAa/C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAS/B,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IASzC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAWvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIvC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIvC,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAK7D,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAOrD,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,UAAU;CAIrB;AAED;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IACvD,OAAc,IAAI,SAA+D;IAEjF,OAAc,UAAU,EAAE,kBAAkB,CAI1C;WAEY,eAAe,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ;IAc3D,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC/B,OAAO,CAAC,aAAa,CAAC;IAMlB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,aAAa;CAK7E"}

package/lib/sparsematrix.js

@@ -6,10 +6,11 @@ import { BaseSegment, createGroupOp, LocalReferenceCollection, } from "@fluidfra
 import { pkgVersion } from "./packageVersion";
 import { SharedSegmentSequence, SubSequence } from "./";
 /**
- * An empty segment that occupies 'cachedLength' positions.  SparseMatrix uses PaddingSegment
- * to "pad" a run of unoccupied cells.
+ * An empty segment that occupies 'cachedLength' positions.
+ * {@link SparseMatrix} uses `PaddingSegment` to "pad" a run of unoccupied cells.
  *
- * @deprecated PaddingSegment is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `PaddingSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export class PaddingSegment extends BaseSegment {
     constructor(size) {
@@ -67,7 +68,8 @@ export class PaddingSegment extends BaseSegment {
 }
 PaddingSegment.typeString = "PaddingSegment";
 /**
- * @deprecated RunSegment is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `RunSegment` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export class RunSegment extends SubSequence {
     constructor(items) {
@@ -134,31 +136,38 @@ export class RunSegment extends SubSequence {
 }
 RunSegment.typeString = "RunSegment";
 /**
- * @deprecated maxCol is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export const maxCol = 0x200000; // X128 Excel maximum of 16,384 columns
 /**
- * @deprecated maxCols is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxCols` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export const maxCols = maxCol + 1;
 /**
- * @deprecated maxRow is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxRow` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export const maxRow = 0xFFFFFFFF; // X4096 Excel maximum of 1,048,576 rows
 /**
- * @deprecated maxRows is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxRows` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export const maxRows = maxRow + 1;
 /**
- * @deprecated maxCellPosition is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `maxCellPosition` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export const maxCellPosition = maxCol * maxRow;
 /**
- * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export const rowColToPosition = (row, col) => row * maxCols + col;
 /**
- * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `positionToRowCol` is part of an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export function positionToRowCol(position) {
     const row = Math.floor(position / maxCols);
@@ -166,7 +175,8 @@ export function positionToRowCol(position) {
     return { row, col };
 }
 /**
- * @deprecated SparseMatrix is an abandoned prototype.  Use SharedMatrix instead.
+ * @deprecated `SparseMatrix` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrix} instead.
  */
 export class SparseMatrix extends SharedSegmentSequence {
     constructor(document, id, attributes) {
@@ -280,7 +290,8 @@ export class SparseMatrix extends SharedSegmentSequence {
     }
 }
 /**
- * @deprecated SparseMatrixFactory is an abandoned prototype.  Use SharedMatrixFactory instead.
+ * @deprecated `SparseMatrixFactory` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.
  */
 export class SparseMatrixFactory {
     static segmentFromSpec(spec) {

package/lib/sparsematrix.js.map

@@ -1 +1 @@
-{"version":3,"file":"sparsematrix.js","sourceRoot":"","sources":["../src/sparsematrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,WAAW,EACX,aAAa,EAGb,wBAAwB,GAE3B,MAAM,4BAA4B,CAAC;AAUpC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAExD;;;;;GAKG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAiB3C,YAAY,IAAY;QACpB,KAAK,EAAE,CAAC;QAHI,SAAI,GAAG,cAAc,CAAC,UAAU,CAAC;QAI7C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAlBM,MAAM,CAAC,EAAE,CAAC,OAAiB;QAC9B,OAAO,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,IAAS;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrC;YACD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAQM,YAAY;QACf,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAY;QAChC,MAAM,CAAC,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACb,CAAC;IAEM,SAAS,CAAC,OAAiB;QAC9B,OAAO,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,QAAQ;QACX,OAAO,aAAa,IAAI,CAAC,YAAY,GAAG,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAC,OAAiB;QAC3B,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACtD;QAED,8EAA8E;QAC9E,6EAA6E;QAC7E,wBAAwB,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC;IAC9C,CAAC;IAED,qCAAqC;IAC9B,WAAW,CAAC,KAAa,EAAE,GAAW;QACzC,IAAI,CAAC,YAAY,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;IAES,oBAAoB,CAAC,GAAW;QACtC,MAAM,UAAU,GAAG,GAAG,CAAC;QACvB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QAE5C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;QAC/B,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;;AA/DsB,yBAAU,GAAG,gBAAgB,CAAC;AAuEzD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAA6B;IAmBzD,YAAmB,KAAyB;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;QADE,UAAK,GAAL,KAAK,CAAoB;QAJ5B,SAAI,GAAG,UAAU,CAAC,UAAU,CAAC;QAMzC,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IApBM,MAAM,CAAC,EAAE,CAAC,OAAiB;QAC9B,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,UAAU,CAAC;IAClD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,IAAS;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI,EAAE;YACrD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrC;YACD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAUM,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAY;QAChC,MAAM,CAAC,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,IAAI,EAAE;YACX,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,OAAiB;QAC3B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEtB,MAAM,KAAK,GAAG,OAAqB,CAAC;QACpC,IAAI,KAAK,CAAC,IAAI,EAAE;YACZ,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;aACzD;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,sCAAsC;IACtC,qCAAqC;IAC9B,WAAW,CAAC,KAAa,EAAE,GAAW;QACzC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC;QACrC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,GAAW;QACrB,+DAA+D;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAQ;QAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACzB,CAAC;IAES,oBAAoB,CAAC,GAAW;QACtC,IAAI,GAAG,GAAG,CAAC,EAAE;YACT,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEtC,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAC;YACnD,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAEvB,OAAO,WAAW,CAAC;SACtB;IACL,CAAC;;AAzEsB,qBAAU,GAAG,YAAY,CAAC;AAiFrD;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAS,uCAAuC;AAE/E;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,CAAC,CAAO,wCAAwC;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;AAElF;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,QAAQ,GAAG,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC;IACvC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAAoC;IAqBlE,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;IAE/D,CAAC;IAtBD;;;;;;OAMG;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;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,mBAAmB,EAAE,CAAC;IACrC,CAAC;IAMD,IAAW,OAAO;QACd,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC;IAClD,CAAC;IAEM,QAAQ,CACX,GAAW,EACX,GAAW,EACX,MAA0B,EAC1B,KAAmB;QAEnB,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,GAAW;QAGnC,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACnC,+DAA+D;YAC/D,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SAChC;aAAM,IAAI,OAAO,IAAI,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YAC9C,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAW;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACxB,+DAA+D;YAC/D,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACjC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAW,EAAE,GAAQ;QAC5C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACxB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC/B;aAAM,IAAI,GAAG,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,oCAAoC,OAAO,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC;SACrF;IACL,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAEzC,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;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,gBAAgB,CAAC,GAAW,EAAE,GAAW,EAAE,KAAkB;QAChE,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,qBAAqB,CAAC,GAAW,EAAE,GAAW;QACjD,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,2FAA2F;IAC3F,oDAAoD;IAC5C,aAAa,CAAC,MAAc,EAAE,OAAe,EAAE,OAAe;QAClE,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QACtC,MAAM,GAAG,GAAG,EAAE,CAAC;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,IAAI,OAAO,EAAE;YACtE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,GAAG,cAAc,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC;YAC3F,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;YACrC,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;YAC5C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;SAChE;QAED,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,UAAU,CAAC,GAAW,EAAE,GAAW;QACvC,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,mBAAmB;IASrB,MAAM,CAAC,eAAe,CAAC,IAAkB;QAC5C,MAAM,YAAY,GAAG,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,YAAY,EAAE;YACd,OAAO,YAAY,CAAC;SACvB;QAED,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,QAAQ,EAAE;YACV,OAAO,QAAQ,CAAC;SACnB;QAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC;IAED,IAAW,IAAI;QACX,OAAO,mBAAmB,CAAC,IAAI,CAAC;IACpC,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,mBAAmB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/D,MAAM,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,YAAY,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACtD,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,YAAY,CAAC,eAAe,EAAE,CAAC;QAC/B,OAAO,YAAY,CAAC;IACxB,CAAC;;AAhDa,wBAAI,GAAG,2DAA2D,CAAC;AAEnE,8BAAU,GAAuB;IAC3C,IAAI,EAAE,mBAAmB,CAAC,IAAI;IAC9B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    BaseSegment,\n    createGroupOp,\n    IJSONSegment,\n    ISegment,\n    LocalReferenceCollection,\n    PropertySet,\n} from \"@fluidframework/merge-tree\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelFactory,\n    Serializable,\n    Jsonable,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { SharedSegmentSequence, SubSequence } from \"./\";\n\n/**\n * An empty segment that occupies 'cachedLength' positions.  SparseMatrix uses PaddingSegment\n * to \"pad\" a run of unoccupied cells.\n *\n * @deprecated PaddingSegment is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport class PaddingSegment extends BaseSegment {\n    public static readonly typeString = \"PaddingSegment\";\n    public static is(segment: ISegment): segment is PaddingSegment {\n        return segment.type === PaddingSegment.typeString;\n    }\n    public static fromJSONObject(spec: any) {\n        if (spec && typeof spec === \"object\" && \"pad\" in spec) {\n            const segment = new PaddingSegment(spec.pad);\n            if (spec.props) {\n                segment.addProperties(spec.props);\n            }\n            return segment;\n        }\n        return undefined;\n    }\n    public readonly type = PaddingSegment.typeString;\n\n    constructor(size: number) {\n        super();\n        this.cachedLength = size;\n    }\n\n    public toJSONObject() {\n        return { pad: this.cachedLength, props: this.properties };\n    }\n\n    public clone(start = 0, end?: number) {\n        const b = new PaddingSegment(this.cachedLength);\n        this.cloneInto(b);\n        return b;\n    }\n\n    public canAppend(segment: ISegment) {\n        return PaddingSegment.is(segment);\n    }\n\n    public toString() {\n        return `[padding: ${this.cachedLength}]`;\n    }\n\n    public append(segment: ISegment) {\n        if (!PaddingSegment.is(segment)) {\n            throw new Error(\"can only append padding segment\");\n        }\n\n        // Note: Must call 'appendLocalRefs' before modifying this segment's length as\n        //       'this.cachedLength' is used to adjust the offsets of the local refs.\n        LocalReferenceCollection.append(this, segment);\n\n        this.cachedLength += segment.cachedLength;\n    }\n\n    // Returns true if entire run removed\n    public removeRange(start: number, end: number) {\n        this.cachedLength -= (end - start);\n        return (this.cachedLength === 0);\n    }\n\n    protected createSplitSegmentAt(pos: number) {\n        const leftLength = pos;\n        const rightLength = this.cachedLength - pos;\n\n        this.cachedLength = leftLength;\n        return new PaddingSegment(rightLength);\n    }\n}\n\n/**\n * @deprecated SparseMatrixItem is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport type SparseMatrixItem = Serializable;\n\n/**\n * @deprecated RunSegment is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport class RunSegment extends SubSequence<SparseMatrixItem> {\n    public static readonly typeString = \"RunSegment\";\n    public static is(segment: ISegment): segment is RunSegment {\n        return segment.type === RunSegment.typeString;\n    }\n    public static fromJSONObject(spec: any) {\n        if (spec && typeof spec === \"object\" && \"items\" in spec) {\n            const segment = new RunSegment(spec.items);\n            if (spec.props) {\n                segment.addProperties(spec.props);\n            }\n            return segment;\n        }\n        return undefined;\n    }\n    public readonly type = RunSegment.typeString;\n\n    private tags: any[];\n\n    constructor(public items: SparseMatrixItem[]) {\n        super(items);\n        this.tags = new Array(items.length).fill(undefined);\n    }\n\n    public clone(start = 0, end?: number) {\n        const b = new RunSegment(this.items.slice(start, end));\n        if (this.tags) {\n            b.tags = this.tags.slice(start, end);\n        }\n        this.cloneInto(b);\n        return b;\n    }\n\n    public append(segment: ISegment) {\n        super.append(segment);\n\n        const asRun = segment as RunSegment;\n        if (asRun.tags) {\n            if (this.tags) {\n                this.tags.splice(this.items.length, 0, ...asRun.tags);\n            }\n        }\n\n        return this;\n    }\n\n    // TODO: retain removed items for undo\n    // returns true if entire run removed\n    public removeRange(start: number, end: number) {\n        this.tags.splice(start, end - start);\n        return super.removeRange(start, end);\n    }\n\n    public getTag(pos: number) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return this.tags[pos];\n    }\n\n    public setTag(pos: number, tag: any) {\n        this.tags[pos] = tag;\n    }\n\n    protected createSplitSegmentAt(pos: number) {\n        if (pos > 0) {\n            const remainingItems = this.items.slice(pos);\n            this.items = this.items.slice(0, pos);\n            this.cachedLength = this.items.length;\n\n            const leafSegment = new RunSegment(remainingItems);\n            leafSegment.tags = this.tags.slice(pos);\n            this.tags.length = pos;\n\n            return leafSegment;\n        }\n    }\n}\n\n/**\n * @deprecated MatrixSegment is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport type MatrixSegment = RunSegment | PaddingSegment;\n\n/**\n * @deprecated maxCol is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport const maxCol = 0x200000;         // X128 Excel maximum of 16,384 columns\n\n/**\n * @deprecated maxCols is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport const maxCols = maxCol + 1;\n\n/**\n * @deprecated maxRow is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport const maxRow = 0xFFFFFFFF;       // X4096 Excel maximum of 1,048,576 rows\n\n/**\n * @deprecated maxRows is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport const maxRows = maxRow + 1;\n\n/**\n * @deprecated maxCellPosition is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport const maxCellPosition = maxCol * maxRow;\n\n/**\n * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport const rowColToPosition = (row: number, col: number) => row * maxCols + col;\n\n/**\n * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.\n */\nexport function positionToRowCol(position: number) {\n    const row = Math.floor(position / maxCols);\n    const col = position - (row * maxCols);\n    return { row, col };\n}\n\n/**\n * @deprecated SparseMatrix is an abandoned prototype.  Use SharedMatrix instead.\n */\nexport class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {\n    /**\n     * Create a new sparse matrix\n     *\n     * @param runtime - data store runtime the new sparse matrix belongs to\n     * @param id - optional name of the sparse matrix\n     * @returns newly create sparse matrix (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, SparseMatrixFactory.Type) as SparseMatrix;\n    }\n\n    /**\n     * Get a factory for SharedMap to register with the data store.\n     *\n     * @returns a factory that creates and load SharedMap\n     */\n    public static getFactory(): IChannelFactory {\n        return new SparseMatrixFactory();\n    }\n\n    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {\n        super(document, id, attributes, SparseMatrixFactory.segmentFromSpec);\n    }\n\n    public get numRows() {\n        return positionToRowCol(this.getLength()).row;\n    }\n\n    public setItems(\n        row: number,\n        col: number,\n        values: SparseMatrixItem[],\n        props?: PropertySet,\n    ) {\n        const start = rowColToPosition(row, col);\n        const end = start + values.length;\n        const segment = new RunSegment(values);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        this.replaceRange(start, end, segment);\n    }\n\n    public getItem(row: number, col: number):\n        // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports\n        Jsonable<string | number | boolean | IFluidHandle> {\n        const pos = rowColToPosition(row, col);\n        const { segment, offset } = this.getContainingSegment(pos);\n        if (segment && RunSegment.is(segment)) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return segment.items[offset];\n        } else if (segment && PaddingSegment.is(segment)) {\n            return undefined;\n        }\n\n        throw new Error(`Unrecognized Segment type`);\n    }\n\n    public getTag(row: number, col: number) {\n        const { segment, offset } = this.getSegment(row, col);\n        if (RunSegment.is(segment)) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return segment.getTag(offset);\n        }\n        return undefined;\n    }\n\n    public setTag(row: number, col: number, tag: any) {\n        const { segment, offset } = this.getSegment(row, col);\n        if (RunSegment.is(segment)) {\n            segment.setTag(offset, tag);\n        } else if (tag !== undefined) {\n            throw new Error(`Must not attempt to set tags on '${segment.constructor.name}'.`);\n        }\n    }\n\n    public insertRows(row: number, numRows: number) {\n        const pos = rowColToPosition(row, 0);\n        const size = maxCols * numRows;\n        const segment = new PaddingSegment(size);\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    public removeRows(row: number, numRows: number) {\n        const pos = rowColToPosition(row, 0);\n        const size = maxCols * numRows;\n        this.removeRange(pos, pos + size);\n    }\n\n    public insertCols(col: number, numCols: number) {\n        this.moveAsPadding(maxCol - numCols, col, numCols);\n    }\n\n    public removeCols(col: number, numCols: number) {\n        this.moveAsPadding(col, maxCol - numCols, numCols);\n    }\n\n    public annotatePosition(row: number, col: number, props: PropertySet) {\n        const pos = rowColToPosition(row, col);\n        this.annotateRange(pos, pos + 1, props);\n    }\n\n    public getPositionProperties(row: number, col: number) {\n        const pos = rowColToPosition(row, col);\n        return this.getPropertiesAtPosition(pos);\n    }\n\n    // For each row, moves 'numCols' items starting from 'srcCol' and inserts 'numCols' padding\n    // at 'destCol'.  Used by insertCols and removeCols.\n    private moveAsPadding(srcCol: number, destCol: number, numCols: number) {\n        const removeColStart = srcCol;\n        const removeColEnd = srcCol + numCols;\n        const ops = [];\n\n        for (let r = 0, rowStart = 0; r < this.numRows; r++, rowStart += maxCols) {\n            ops.push(this.client.removeRangeLocal(rowStart + removeColStart, rowStart + removeColEnd));\n            const insertPos = rowStart + destCol;\n            const segment = new PaddingSegment(numCols);\n            ops.push(this.client.insertSegmentLocal(insertPos, segment));\n        }\n\n        this.submitSequenceMessage(createGroupOp(...ops));\n    }\n\n    private getSegment(row: number, col: number) {\n        const pos = rowColToPosition(row, col);\n        return this.getContainingSegment(pos);\n    }\n}\n\n/**\n * @deprecated SparseMatrixFactory is an abandoned prototype.  Use SharedMatrixFactory instead.\n */\nexport class SparseMatrixFactory implements IChannelFactory {\n    public static Type = \"https://graph.microsoft.com/types/mergeTree/sparse-matrix\";\n\n    public static Attributes: IChannelAttributes = {\n        type: SparseMatrixFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: pkgVersion,\n    };\n\n    public static segmentFromSpec(spec: IJSONSegment): ISegment {\n        const maybePadding = PaddingSegment.fromJSONObject(spec);\n        if (maybePadding) {\n            return maybePadding;\n        }\n\n        const maybeRun = RunSegment.fromJSONObject(spec);\n        if (maybeRun) {\n            return maybeRun;\n        }\n\n        throw new Error(`Unrecognized IJSONObject: '${JSON.stringify(spec)}'`);\n    }\n\n    public get type() {\n        return SparseMatrixFactory.Type;\n    }\n\n    public get attributes() {\n        return SparseMatrixFactory.Attributes;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n    ): Promise<ISharedObject> {\n        const sharedObject = new SparseMatrix(runtime, id, attributes);\n        await sharedObject.load(services);\n        return sharedObject;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string): ISharedObject {\n        const sharedObject = new SparseMatrix(document, id, this.attributes);\n        sharedObject.initializeLocal();\n        return sharedObject;\n    }\n}\n"]}
+{"version":3,"file":"sparsematrix.js","sourceRoot":"","sources":["../src/sparsematrix.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,WAAW,EACX,aAAa,EAGb,wBAAwB,GAE3B,MAAM,4BAA4B,CAAC;AAUpC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAiB3C,YAAY,IAAY;QACpB,KAAK,EAAE,CAAC;QAHI,SAAI,GAAG,cAAc,CAAC,UAAU,CAAC;QAI7C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAlBM,MAAM,CAAC,EAAE,CAAC,OAAiB;QAC9B,OAAO,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,IAAS;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrC;YACD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAQM,YAAY;QACf,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAY;QAChC,MAAM,CAAC,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACb,CAAC;IAEM,SAAS,CAAC,OAAiB;QAC9B,OAAO,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,QAAQ;QACX,OAAO,aAAa,IAAI,CAAC,YAAY,GAAG,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAC,OAAiB;QAC3B,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACtD;QAED,8EAA8E;QAC9E,6EAA6E;QAC7E,wBAAwB,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC;IAC9C,CAAC;IAED,qCAAqC;IAC9B,WAAW,CAAC,KAAa,EAAE,GAAW;QACzC,IAAI,CAAC,YAAY,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;IAES,oBAAoB,CAAC,GAAW;QACtC,MAAM,UAAU,GAAG,GAAG,CAAC;QACvB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QAE5C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;QAC/B,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;;AA/DsB,yBAAU,GAAG,gBAAgB,CAAC;AAwEzD;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,WAA6B;IAmBzD,YAAmB,KAAyB;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;QADE,UAAK,GAAL,KAAK,CAAoB;QAJ5B,SAAI,GAAG,UAAU,CAAC,UAAU,CAAC;QAMzC,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IApBM,MAAM,CAAC,EAAE,CAAC,OAAiB;QAC9B,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,UAAU,CAAC;IAClD,CAAC;IACM,MAAM,CAAC,cAAc,CAAC,IAAS;QAClC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI,EAAE;YACrD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrC;YACD,OAAO,OAAO,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAUM,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAY;QAChC,MAAM,CAAC,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,IAAI,EAAE;YACX,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,OAAO,CAAC,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,OAAiB;QAC3B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEtB,MAAM,KAAK,GAAG,OAAqB,CAAC;QACpC,IAAI,KAAK,CAAC,IAAI,EAAE;YACZ,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;aACzD;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,sCAAsC;IACtC,qCAAqC;IAC9B,WAAW,CAAC,KAAa,EAAE,GAAW;QACzC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC;QACrC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,GAAW;QACrB,+DAA+D;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAQ;QAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACzB,CAAC;IAES,oBAAoB,CAAC,GAAW;QACtC,IAAI,GAAG,GAAG,CAAC,EAAE;YACT,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEtC,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAC;YACnD,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAEvB,OAAO,WAAW,CAAC;SACtB;IACL,CAAC;;AAzEsB,qBAAU,GAAG,YAAY,CAAC;AAkFrD;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAS,uCAAuC;AAE/E;;;GAGG;AACF,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,CAAC,CAAO,wCAAwC;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,CAAC;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;AAElF;;;GAGG;AACJ,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,QAAQ,GAAG,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC;IACvC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAAoC;IAqBlE,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;IAE/D,CAAC;IAtBD;;;;;;OAMG;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;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,mBAAmB,EAAE,CAAC;IACrC,CAAC;IAMD,IAAW,OAAO;QACd,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC;IAClD,CAAC;IAEM,QAAQ,CACX,GAAW,EACX,GAAW,EACX,MAA0B,EAC1B,KAAmB;QAEnB,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,GAAW;QAGnC,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACnC,+DAA+D;YAC/D,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SAChC;aAAM,IAAI,OAAO,IAAI,cAAc,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YAC9C,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAW;QAClC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACxB,+DAA+D;YAC/D,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACjC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,GAAW,EAAE,GAAQ;QAC5C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;YACxB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC/B;aAAM,IAAI,GAAG,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,oCAAoC,OAAO,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC;SACrF;IACL,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAEzC,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;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,UAAU,CAAC,GAAW,EAAE,OAAe;QAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,gBAAgB,CAAC,GAAW,EAAE,GAAW,EAAE,KAAkB;QAChE,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEM,qBAAqB,CAAC,GAAW,EAAE,GAAW;QACjD,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,2FAA2F;IAC3F,oDAAoD;IAC5C,aAAa,CAAC,MAAc,EAAE,OAAe,EAAE,OAAe;QAClE,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;QACtC,MAAM,GAAG,GAAG,EAAE,CAAC;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,IAAI,OAAO,EAAE;YACtE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,GAAG,cAAc,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC;YAC3F,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;YACrC,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;YAC5C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;SAChE;QAED,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,UAAU,CAAC,GAAW,EAAE,GAAW;QACvC,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IASrB,MAAM,CAAC,eAAe,CAAC,IAAkB;QAC5C,MAAM,YAAY,GAAG,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,YAAY,EAAE;YACd,OAAO,YAAY,CAAC;SACvB;QAED,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,QAAQ,EAAE;YACV,OAAO,QAAQ,CAAC;SACnB;QAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC;IAED,IAAW,IAAI;QACX,OAAO,mBAAmB,CAAC,IAAI,CAAC;IACpC,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,mBAAmB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/D,MAAM,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,YAAY,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACtD,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,YAAY,CAAC,eAAe,EAAE,CAAC;QAC/B,OAAO,YAAY,CAAC;IACxB,CAAC;;AAhDa,wBAAI,GAAG,2DAA2D,CAAC;AAEnE,8BAAU,GAAuB;IAC3C,IAAI,EAAE,mBAAmB,CAAC,IAAI;IAC9B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    BaseSegment,\n    createGroupOp,\n    IJSONSegment,\n    ISegment,\n    LocalReferenceCollection,\n    PropertySet,\n} from \"@fluidframework/merge-tree\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelFactory,\n    Serializable,\n    Jsonable,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { SharedSegmentSequence, SubSequence } from \"./\";\n\n/**\n * An empty segment that occupies 'cachedLength' positions.\n * {@link SparseMatrix} uses `PaddingSegment` to \"pad\" a run of unoccupied cells.\n *\n * @deprecated `PaddingSegment` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport class PaddingSegment extends BaseSegment {\n    public static readonly typeString = \"PaddingSegment\";\n    public static is(segment: ISegment): segment is PaddingSegment {\n        return segment.type === PaddingSegment.typeString;\n    }\n    public static fromJSONObject(spec: any) {\n        if (spec && typeof spec === \"object\" && \"pad\" in spec) {\n            const segment = new PaddingSegment(spec.pad);\n            if (spec.props) {\n                segment.addProperties(spec.props);\n            }\n            return segment;\n        }\n        return undefined;\n    }\n    public readonly type = PaddingSegment.typeString;\n\n    constructor(size: number) {\n        super();\n        this.cachedLength = size;\n    }\n\n    public toJSONObject() {\n        return { pad: this.cachedLength, props: this.properties };\n    }\n\n    public clone(start = 0, end?: number) {\n        const b = new PaddingSegment(this.cachedLength);\n        this.cloneInto(b);\n        return b;\n    }\n\n    public canAppend(segment: ISegment) {\n        return PaddingSegment.is(segment);\n    }\n\n    public toString() {\n        return `[padding: ${this.cachedLength}]`;\n    }\n\n    public append(segment: ISegment) {\n        if (!PaddingSegment.is(segment)) {\n            throw new Error(\"can only append padding segment\");\n        }\n\n        // Note: Must call 'appendLocalRefs' before modifying this segment's length as\n        //       'this.cachedLength' is used to adjust the offsets of the local refs.\n        LocalReferenceCollection.append(this, segment);\n\n        this.cachedLength += segment.cachedLength;\n    }\n\n    // Returns true if entire run removed\n    public removeRange(start: number, end: number) {\n        this.cachedLength -= (end - start);\n        return (this.cachedLength === 0);\n    }\n\n    protected createSplitSegmentAt(pos: number) {\n        const leftLength = pos;\n        const rightLength = this.cachedLength - pos;\n\n        this.cachedLength = leftLength;\n        return new PaddingSegment(rightLength);\n    }\n}\n\n/**\n * @deprecated `SparseMatrixItem` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport type SparseMatrixItem = Serializable;\n\n/**\n * @deprecated `RunSegment` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport class RunSegment extends SubSequence<SparseMatrixItem> {\n    public static readonly typeString = \"RunSegment\";\n    public static is(segment: ISegment): segment is RunSegment {\n        return segment.type === RunSegment.typeString;\n    }\n    public static fromJSONObject(spec: any) {\n        if (spec && typeof spec === \"object\" && \"items\" in spec) {\n            const segment = new RunSegment(spec.items);\n            if (spec.props) {\n                segment.addProperties(spec.props);\n            }\n            return segment;\n        }\n        return undefined;\n    }\n    public readonly type = RunSegment.typeString;\n\n    private tags: any[];\n\n    constructor(public items: SparseMatrixItem[]) {\n        super(items);\n        this.tags = new Array(items.length).fill(undefined);\n    }\n\n    public clone(start = 0, end?: number) {\n        const b = new RunSegment(this.items.slice(start, end));\n        if (this.tags) {\n            b.tags = this.tags.slice(start, end);\n        }\n        this.cloneInto(b);\n        return b;\n    }\n\n    public append(segment: ISegment) {\n        super.append(segment);\n\n        const asRun = segment as RunSegment;\n        if (asRun.tags) {\n            if (this.tags) {\n                this.tags.splice(this.items.length, 0, ...asRun.tags);\n            }\n        }\n\n        return this;\n    }\n\n    // TODO: retain removed items for undo\n    // returns true if entire run removed\n    public removeRange(start: number, end: number) {\n        this.tags.splice(start, end - start);\n        return super.removeRange(start, end);\n    }\n\n    public getTag(pos: number) {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n        return this.tags[pos];\n    }\n\n    public setTag(pos: number, tag: any) {\n        this.tags[pos] = tag;\n    }\n\n    protected createSplitSegmentAt(pos: number) {\n        if (pos > 0) {\n            const remainingItems = this.items.slice(pos);\n            this.items = this.items.slice(0, pos);\n            this.cachedLength = this.items.length;\n\n            const leafSegment = new RunSegment(remainingItems);\n            leafSegment.tags = this.tags.slice(pos);\n            this.tags.length = pos;\n\n            return leafSegment;\n        }\n    }\n}\n\n/**\n * @deprecated `MatrixSegment` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport type MatrixSegment = RunSegment | PaddingSegment;\n\n/**\n * @deprecated `maxCol` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport const maxCol = 0x200000;         // X128 Excel maximum of 16,384 columns\n\n/**\n * @deprecated `maxCols` is part of an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\n export const maxCols = maxCol + 1;\n\n /**\n  * @deprecated `maxRow` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const maxRow = 0xFFFFFFFF;       // X4096 Excel maximum of 1,048,576 rows\n\n /**\n  * @deprecated `maxRows` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const maxRows = maxRow + 1;\n\n /**\n  * @deprecated `maxCellPosition` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const maxCellPosition = maxCol * maxRow;\n\n /**\n  * @deprecated `positionToRowCol` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\n export const rowColToPosition = (row: number, col: number) => row * maxCols + col;\n\n /**\n  * @deprecated `positionToRowCol` is part of an abandoned prototype.\n  * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n  */\nexport function positionToRowCol(position: number) {\n    const row = Math.floor(position / maxCols);\n    const col = position - (row * maxCols);\n    return { row, col };\n}\n\n/**\n * @deprecated `SparseMatrix` is an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrix} instead.\n */\nexport class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {\n    /**\n     * Create a new sparse matrix\n     *\n     * @param runtime - data store runtime the new sparse matrix belongs to\n     * @param id - optional name of the sparse matrix\n     * @returns newly create sparse matrix (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, SparseMatrixFactory.Type) as SparseMatrix;\n    }\n\n    /**\n     * Get a factory for SharedMap to register with the data store.\n     *\n     * @returns a factory that creates and load SharedMap\n     */\n    public static getFactory(): IChannelFactory {\n        return new SparseMatrixFactory();\n    }\n\n    constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {\n        super(document, id, attributes, SparseMatrixFactory.segmentFromSpec);\n    }\n\n    public get numRows() {\n        return positionToRowCol(this.getLength()).row;\n    }\n\n    public setItems(\n        row: number,\n        col: number,\n        values: SparseMatrixItem[],\n        props?: PropertySet,\n    ) {\n        const start = rowColToPosition(row, col);\n        const end = start + values.length;\n        const segment = new RunSegment(values);\n        if (props) {\n            segment.addProperties(props);\n        }\n\n        this.replaceRange(start, end, segment);\n    }\n\n    public getItem(row: number, col: number):\n        // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports\n        Jsonable<string | number | boolean | IFluidHandle> {\n        const pos = rowColToPosition(row, col);\n        const { segment, offset } = this.getContainingSegment(pos);\n        if (segment && RunSegment.is(segment)) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return segment.items[offset];\n        } else if (segment && PaddingSegment.is(segment)) {\n            return undefined;\n        }\n\n        throw new Error(`Unrecognized Segment type`);\n    }\n\n    public getTag(row: number, col: number) {\n        const { segment, offset } = this.getSegment(row, col);\n        if (RunSegment.is(segment)) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n            return segment.getTag(offset);\n        }\n        return undefined;\n    }\n\n    public setTag(row: number, col: number, tag: any) {\n        const { segment, offset } = this.getSegment(row, col);\n        if (RunSegment.is(segment)) {\n            segment.setTag(offset, tag);\n        } else if (tag !== undefined) {\n            throw new Error(`Must not attempt to set tags on '${segment.constructor.name}'.`);\n        }\n    }\n\n    public insertRows(row: number, numRows: number) {\n        const pos = rowColToPosition(row, 0);\n        const size = maxCols * numRows;\n        const segment = new PaddingSegment(size);\n\n        const insertOp = this.client.insertSegmentLocal(pos, segment);\n        if (insertOp) {\n            this.submitSequenceMessage(insertOp);\n        }\n    }\n\n    public removeRows(row: number, numRows: number) {\n        const pos = rowColToPosition(row, 0);\n        const size = maxCols * numRows;\n        this.removeRange(pos, pos + size);\n    }\n\n    public insertCols(col: number, numCols: number) {\n        this.moveAsPadding(maxCol - numCols, col, numCols);\n    }\n\n    public removeCols(col: number, numCols: number) {\n        this.moveAsPadding(col, maxCol - numCols, numCols);\n    }\n\n    public annotatePosition(row: number, col: number, props: PropertySet) {\n        const pos = rowColToPosition(row, col);\n        this.annotateRange(pos, pos + 1, props);\n    }\n\n    public getPositionProperties(row: number, col: number) {\n        const pos = rowColToPosition(row, col);\n        return this.getPropertiesAtPosition(pos);\n    }\n\n    // For each row, moves 'numCols' items starting from 'srcCol' and inserts 'numCols' padding\n    // at 'destCol'.  Used by insertCols and removeCols.\n    private moveAsPadding(srcCol: number, destCol: number, numCols: number) {\n        const removeColStart = srcCol;\n        const removeColEnd = srcCol + numCols;\n        const ops = [];\n\n        for (let r = 0, rowStart = 0; r < this.numRows; r++, rowStart += maxCols) {\n            ops.push(this.client.removeRangeLocal(rowStart + removeColStart, rowStart + removeColEnd));\n            const insertPos = rowStart + destCol;\n            const segment = new PaddingSegment(numCols);\n            ops.push(this.client.insertSegmentLocal(insertPos, segment));\n        }\n\n        this.submitSequenceMessage(createGroupOp(...ops));\n    }\n\n    private getSegment(row: number, col: number) {\n        const pos = rowColToPosition(row, col);\n        return this.getContainingSegment(pos);\n    }\n}\n\n/**\n * @deprecated `SparseMatrixFactory` is an abandoned prototype.\n * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.\n */\nexport class SparseMatrixFactory implements IChannelFactory {\n    public static Type = \"https://graph.microsoft.com/types/mergeTree/sparse-matrix\";\n\n    public static Attributes: IChannelAttributes = {\n        type: SparseMatrixFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: pkgVersion,\n    };\n\n    public static segmentFromSpec(spec: IJSONSegment): ISegment {\n        const maybePadding = PaddingSegment.fromJSONObject(spec);\n        if (maybePadding) {\n            return maybePadding;\n        }\n\n        const maybeRun = RunSegment.fromJSONObject(spec);\n        if (maybeRun) {\n            return maybeRun;\n        }\n\n        throw new Error(`Unrecognized IJSONObject: '${JSON.stringify(spec)}'`);\n    }\n\n    public get type() {\n        return SparseMatrixFactory.Type;\n    }\n\n    public get attributes() {\n        return SparseMatrixFactory.Attributes;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n     */\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n    ): Promise<ISharedObject> {\n        const sharedObject = new SparseMatrix(runtime, id, attributes);\n        await sharedObject.load(services);\n        return sharedObject;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string): ISharedObject {\n        const sharedObject = new SparseMatrix(document, id, this.attributes);\n        sharedObject.initializeLocal();\n        return sharedObject;\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "1.3.0",
+  "version": "2.0.0-dev.1.4.5.105745",
   "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": "^1.3.0",
-    "@fluidframework/core-interfaces": "^1.3.0",
-    "@fluidframework/datastore-definitions": "^1.3.0",
-    "@fluidframework/merge-tree": "^1.3.0",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^1.3.0",
-    "@fluidframework/runtime-utils": "^1.3.0",
-    "@fluidframework/shared-object-base": "^1.3.0",
-    "@fluidframework/telemetry-utils": "^1.3.0",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/container-utils": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/core-interfaces": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/merge-tree": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/protocol-definitions": "^1.0.0",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/runtime-utils": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/shared-object-base": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.1.4.5.105745",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/stochastic-test-utils": "^1.3.0",
-    "@fluid-internal/test-dds-utils": "^1.3.0",
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.2.74327",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/gitresources": "^0.1036.5000",
-    "@fluidframework/mocha-test-setup": "^1.3.0",
-    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@^1.2.0",
-    "@fluidframework/server-services-client": "^0.1036.5000",
-    "@fluidframework/test-runtime-utils": "^1.3.0",
+    "@fluid-internal/stochastic-test-utils": "2.0.0-dev.1.4.5.105745",
+    "@fluid-internal/test-dds-utils": "2.0.0-dev.1.4.5.105745",
+    "@fluid-tools/benchmark": "^0.43.0",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.4000",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/gitresources": "^0.1037.2001",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.1.4.5.105745",
+    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@^1.0.0",
+    "@fluidframework/server-services-client": "^0.1037.2001",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.1.4.5.105745",
     "@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",
@@ -105,7 +110,47 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.3.0",
-    "broken": {}
+    "version": "2.0.0",
+    "broken": {
+      "ClassDeclaration_IntervalCollection": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SequenceInterval": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_ISharedString": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SequenceEvent": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SequenceDeltaEvent": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SequenceMaintenanceEvent": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedNumberSequence": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedObjectSequence": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedSegmentSequence": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedSequence": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedString": {
+        "backCompat": false
+      },
+      "TypeAliasDeclaration_SharedStringSegment": {
+        "backCompat": false
+      },
+      "ClassDeclaration_SparseMatrix": {
+        "backCompat": false
+      }
+    }
   }
 }

package/src/index.ts

@@ -6,7 +6,7 @@
 /**
  * Supports distributed data structures which are list-like.
  *
- * This package's main export is {@link SharedSequence}, a DDS for storing and simultaneously editing a sequence of
+ * This library's main export is {@link SharedSequence}, a DDS for storing and simultaneously editing a sequence of
  * text.
  *
  * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
@@ -22,6 +22,8 @@ export {
     Interval,
     IntervalCollection,
     IntervalCollectionIterator,
+    IntervalLocator,
+    intervalLocatorFromEndpoint,
     IntervalType,
     ISerializableInterval,
     ISerializedInterval,