@fluidframework/sequence 0.48.2 → 0.49.0-39313

package/lib/sequenceDeltaEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"sequenceDeltaEvent.js","sourceRoot":"","sources":["../src/sequenceDeltaEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAUH,gBAAgB,GACnB,MAAM,4BAA4B,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,OAAgB,aAAa;IAO/B,YACoB,SAAkD,EACjD,eAAuB;QADxB,cAAS,GAAT,SAAS,CAAyC;QACjD,oBAAe,GAAf,eAAe,CAAQ;QAExC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC;QACpD,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,SAAS,CAAC;QAE1C,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,CACxB,GAAG,EAAE;YACD,MAAM,GAAG,GAAG,IAAI,gBAAgB,EAAmC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC3C,MAAM,QAAQ,GAAoC;oBAC9C,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS;oBACnC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;oBACzD,cAAc,EAAE,KAAK,CAAC,cAAc;oBACpC,OAAO,EAAE,KAAK,CAAC,OAAO;iBACzB,CAAC;gBACF,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;QAEP,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAClB,GAAG,EAAE;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,OAAO,SAAS,CAAC;aACpB;YACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,CACjB,GAAG,EAAE;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,OAAO,SAAS,CAAC;aACpB;YACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IAC7C,CAAC;IAED,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAO,kBAAmB,SAAQ,aAA0C;IAG9E,YACoB,MAA6B,EAC7C,SAAsC,EACtC,eAAuB;QAEvB,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAJlB,WAAM,GAAN,MAAM,CAAuB;QAK7C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC;IACzD,CAAC;CACJ;AAED;;;;;;GAMG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAuC;IACjF,YACoB,MAAyC,EACzD,SAA4C,EAC5C,eAAuB;QAEvB,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAJlB,WAAM,GAAN,MAAM,CAAmC;IAK7D,CAAC;CACJ;AASD,MAAM,IAAI;IAGN,YAA6B,cAAuB;QAAvB,mBAAc,GAAd,cAAc,CAAS;QAChD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAW,KAAK;QACZ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;SACvC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    Client,\n    IMergeTreeDeltaCallbackArgs,\n    IMergeTreeDeltaOpArgs,\n    IMergeTreeMaintenanceCallbackArgs,\n    ISegment,\n    MergeTreeDeltaOperationType,\n    MergeTreeDeltaOperationTypes,\n    MergeTreeMaintenanceType,\n    PropertySet,\n    SortedSegmentSet,\n} from \"@fluidframework/merge-tree\";\n\n/**\n * Base class for SequenceDeltaEvent and SequenceMaintenanceEvent.\n *\n * The properties of this object and its sub-objects represent a point in time state\n * at the time the operation was applied. They will not take into any future modifications\n * performed to the underlying sequence and merge tree.\n */\nexport abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {\n    public readonly isEmpty: boolean;\n    public readonly deltaOperation: TOperation;\n    private readonly sortedRanges: Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>;\n    private readonly pFirst: Lazy<ISequenceDeltaRange<TOperation>>;\n    private readonly pLast: Lazy<ISequenceDeltaRange<TOperation>>;\n\n    constructor(\n        public readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>,\n        private readonly mergeTreeClient: Client,\n    ) {\n        this.isEmpty = deltaArgs.deltaSegments.length === 0;\n        this.deltaOperation = deltaArgs.operation;\n\n        this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(\n            () => {\n                const set = new SortedSegmentSet<ISequenceDeltaRange<TOperation>>();\n                this.deltaArgs.deltaSegments.forEach((delta) => {\n                    const newRange: ISequenceDeltaRange<TOperation> = {\n                        operation: this.deltaArgs.operation,\n                        position: this.mergeTreeClient.getPosition(delta.segment),\n                        propertyDeltas: delta.propertyDeltas,\n                        segment: delta.segment,\n                    };\n                    set.addOrUpdate(newRange);\n                });\n                return set;\n            });\n\n        this.pFirst = new Lazy<ISequenceDeltaRange<TOperation>>(\n            () => {\n                if (this.isEmpty) {\n                    return undefined;\n                }\n                return this.sortedRanges.value.items[0];\n            });\n\n        this.pLast = new Lazy<ISequenceDeltaRange<TOperation>>(\n            () => {\n                if (this.isEmpty) {\n                    return undefined;\n                }\n                return this.sortedRanges.value.items[this.sortedRanges.value.size - 1];\n            });\n    }\n\n    /**\n     * The in-order ranges affected by this delta.\n     * These may not be continous.\n     */\n    public get ranges(): readonly Readonly<ISequenceDeltaRange<TOperation>>[] {\n        return this.sortedRanges.value.items;\n    }\n\n    /**\n     * The client id of the client that made the change which caused the delta event\n     */\n    public get clientId(): string {\n        return this.mergeTreeClient.longClientId;\n    }\n\n    public get first(): Readonly<ISequenceDeltaRange<TOperation>> {\n        return this.pFirst.value;\n    }\n\n    public get last(): Readonly<ISequenceDeltaRange<TOperation>> {\n        return this.pLast.value;\n    }\n}\n\n/**\n * The event object returned on sequenceDelta events.\n *\n * The properties of this object and its sub-objects represent a point in time state\n * at the time the operation was applied. They will not take into any future modifications\n * performed to the underlying sequence and merge tree.\n *\n * For group ops, each op will get it's own event, and the group op property will be set on the op args.\n *\n * Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.\n */\nexport class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {\n    public readonly isLocal: boolean;\n\n    constructor(\n        public readonly opArgs: IMergeTreeDeltaOpArgs,\n        deltaArgs: IMergeTreeDeltaCallbackArgs,\n        mergeTreeClient: Client,\n    ) {\n        super(deltaArgs, mergeTreeClient);\n        this.isLocal = opArgs.sequencedMessage === undefined;\n    }\n}\n\n/**\n * The event object returned on maintenance events.\n *\n * The properties of this object and its sub-objects represent a point in time state\n * at the time the operation was applied. They will not take into any future modifications\n * performed to the underlying sequence and merge tree.\n */\nexport class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {\n    constructor(\n        public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,\n        deltaArgs: IMergeTreeMaintenanceCallbackArgs,\n        mergeTreeClient: Client,\n    ) {\n        super(deltaArgs, mergeTreeClient);\n    }\n}\n\nexport interface ISequenceDeltaRange<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {\n    operation: TOperation;\n    position: number;\n    segment: ISegment;\n    propertyDeltas: PropertySet;\n}\n\nclass Lazy<T> {\n    private pValue: T;\n    private pEvaluated: boolean;\n    constructor(private readonly valueGenerator: () => T) {\n        this.pEvaluated = false;\n    }\n\n    public get evaluated(): boolean {\n        return this.pEvaluated;\n    }\n\n    public get value(): T {\n        if (!this.pEvaluated) {\n            this.pEvaluated = true;\n            this.pValue = this.valueGenerator();\n        }\n        return this.pValue;\n    }\n}\n"]}
+{"version":3,"file":"sequenceDeltaEvent.js","sourceRoot":"","sources":["../src/sequenceDeltaEvent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAUH,gBAAgB,GACnB,MAAM,4BAA4B,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,OAAgB,aAAa;IAO/B,YACoB,SAAkD,EACjD,eAAuB;QADxB,cAAS,GAAT,SAAS,CAAyC;QACjD,oBAAe,GAAf,eAAe,CAAQ;QAExC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC;QACpD,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,SAAS,CAAC;QAE1C,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,CACxB,GAAG,EAAE;YACD,MAAM,GAAG,GAAG,IAAI,gBAAgB,EAAmC,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC3C,MAAM,QAAQ,GAAoC;oBAC9C,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS;oBACnC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC;oBACzD,cAAc,EAAE,KAAK,CAAC,cAAc;oBACpC,OAAO,EAAE,KAAK,CAAC,OAAO;iBACzB,CAAC;gBACF,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;QAEP,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAClB,GAAG,EAAE;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,OAAO,SAAS,CAAC;aACpB;YACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,CACjB,GAAG,EAAE;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,OAAO,SAAS,CAAC;aACpB;YACD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAO,kBAAmB,SAAQ,aAA0C;IAM9E,YACoB,MAA6B,EAC7C,SAAsC,EACtC,eAAuB;QAEvB,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAJlB,WAAM,GAAN,MAAM,CAAuB;QAK7C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC;IACzD,CAAC;CACJ;AAED;;;;;;GAMG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAuC;IACjF,YACoB,MAAyC,EACzD,SAA4C,EAC5C,eAAuB;QAEvB,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QAJlB,WAAM,GAAN,MAAM,CAAmC;IAK7D,CAAC;CACJ;AAkBD,MAAM,IAAI;IAGN,YAA6B,cAAuB;QAAvB,mBAAc,GAAd,cAAc,CAAS;QAChD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAW,KAAK;QACZ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;SACvC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    Client,\n    IMergeTreeDeltaCallbackArgs,\n    IMergeTreeDeltaOpArgs,\n    IMergeTreeMaintenanceCallbackArgs,\n    ISegment,\n    MergeTreeDeltaOperationType,\n    MergeTreeDeltaOperationTypes,\n    MergeTreeMaintenanceType,\n    PropertySet,\n    SortedSegmentSet,\n} from \"@fluidframework/merge-tree\";\n\n/**\n * Base class for SequenceDeltaEvent and SequenceMaintenanceEvent.\n *\n * The properties of this object and its sub-objects represent a point in time state\n * at the time the operation was applied. They will not take into any future modifications\n * performed to the underlying sequence and merge tree.\n */\nexport abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {\n    public readonly isEmpty: boolean;\n    public readonly deltaOperation: TOperation;\n    private readonly sortedRanges: Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>;\n    private readonly pFirst: Lazy<ISequenceDeltaRange<TOperation>>;\n    private readonly pLast: Lazy<ISequenceDeltaRange<TOperation>>;\n\n    constructor(\n        public readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>,\n        private readonly mergeTreeClient: Client,\n    ) {\n        this.isEmpty = deltaArgs.deltaSegments.length === 0;\n        this.deltaOperation = deltaArgs.operation;\n\n        this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(\n            () => {\n                const set = new SortedSegmentSet<ISequenceDeltaRange<TOperation>>();\n                this.deltaArgs.deltaSegments.forEach((delta) => {\n                    const newRange: ISequenceDeltaRange<TOperation> = {\n                        operation: this.deltaArgs.operation,\n                        position: this.mergeTreeClient.getPosition(delta.segment),\n                        propertyDeltas: delta.propertyDeltas,\n                        segment: delta.segment,\n                    };\n                    set.addOrUpdate(newRange);\n                });\n                return set;\n            });\n\n        this.pFirst = new Lazy<ISequenceDeltaRange<TOperation>>(\n            () => {\n                if (this.isEmpty) {\n                    return undefined;\n                }\n                return this.sortedRanges.value.items[0];\n            });\n\n        this.pLast = new Lazy<ISequenceDeltaRange<TOperation>>(\n            () => {\n                if (this.isEmpty) {\n                    return undefined;\n                }\n                return this.sortedRanges.value.items[this.sortedRanges.value.size - 1];\n            });\n    }\n\n    /**\n     * The in-order ranges affected by this delta.\n     * These may not be continous.\n     */\n    public get ranges(): readonly Readonly<ISequenceDeltaRange<TOperation>>[] {\n        return this.sortedRanges.value.items;\n    }\n\n    /**\n     * The client id of the client that made the change which caused the delta event\n     */\n    public get clientId(): string {\n        return this.mergeTreeClient.longClientId;\n    }\n\n    /**\n     * The first of the modified ranges.\n     */\n    public get first(): Readonly<ISequenceDeltaRange<TOperation>> {\n        return this.pFirst.value;\n    }\n\n    /**\n     * The last of the modified ranges.\n     */\n    public get last(): Readonly<ISequenceDeltaRange<TOperation>> {\n        return this.pLast.value;\n    }\n}\n\n/**\n * The event object returned on sequenceDelta events.\n *\n * The properties of this object and its sub-objects represent a point in time state\n * at the time the operation was applied. They will not take into any future modifications\n * performed to the underlying sequence and merge tree.\n *\n * For group ops, each op will get it's own event, and the group op property will be set on the op args.\n *\n * Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.\n */\nexport class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {\n    /**\n     * Whether the event was caused by a locally-made change.\n     */\n    public readonly isLocal: boolean;\n\n    constructor(\n        public readonly opArgs: IMergeTreeDeltaOpArgs,\n        deltaArgs: IMergeTreeDeltaCallbackArgs,\n        mergeTreeClient: Client,\n    ) {\n        super(deltaArgs, mergeTreeClient);\n        this.isLocal = opArgs.sequencedMessage === undefined;\n    }\n}\n\n/**\n * The event object returned on maintenance events.\n *\n * The properties of this object and its sub-objects represent a point in time state\n * at the time the operation was applied. They will not take into any future modifications\n * performed to the underlying sequence and merge tree.\n */\nexport class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {\n    constructor(\n        public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,\n        deltaArgs: IMergeTreeMaintenanceCallbackArgs,\n        mergeTreeClient: Client,\n    ) {\n        super(deltaArgs, mergeTreeClient);\n    }\n}\n\n/**\n * A range that has changed corresponding to a segment modification.\n */\nexport interface ISequenceDeltaRange<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {\n    operation: TOperation;\n    /**\n     * The index of the start of the range.\n     */\n    position: number;\n    /**\n     * The segment that corresponds to the range.\n     */\n    segment: ISegment;\n    propertyDeltas: PropertySet;\n}\n\nclass Lazy<T> {\n    private pValue: T;\n    private pEvaluated: boolean;\n    constructor(private readonly valueGenerator: () => T) {\n        this.pEvaluated = false;\n    }\n\n    public get evaluated(): boolean {\n        return this.pEvaluated;\n    }\n\n    public get value(): T {\n        if (!this.pEvaluated) {\n            this.pEvaluated = true;\n            this.pValue = this.valueGenerator();\n        }\n        return this.pValue;\n    }\n}\n"]}

package/lib/sharedString.d.ts

@@ -10,14 +10,29 @@ import { SharedStringFactory } from "./sequenceFactory";
  * Fluid object interface describing access methods on a SharedString
  */
 export interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {
+    /**
+     * Inserts the text at the position.
+     * @param pos - The position to insert the text at
+     * @param text - The text to insert
+     * @param props - The properties of text
+     */
     insertText(pos: number, text: string, props?: MergeTree.PropertySet): any;
+    /**
+     * Inserts a marker at the position.
+     * @param pos - The position to insert the marker at
+     * @param refType - The reference type of the marker
+     * @param props - The properties of the marker
+     */
     insertMarker(pos: number, refType: MergeTree.ReferenceType, props?: MergeTree.PropertySet): any;
+    /**
+     * {@inheritDoc SharedSegmentSequence.posFromRelativePos}
+     */
     posFromRelativePos(relativePos: MergeTree.IRelativePosition): any;
 }
 export declare type SharedStringSegment = MergeTree.TextSegment | MergeTree.Marker;
 /**
  * The Shared String is a specialized data structure for handling collaborative
- *  text. It is based on a more general Sequence data structure but has
+ * text. It is based on a more general Sequence data structure but has
  * additional features that make working with text easier.
  *
  * In addition to text, a Shared String can also contain markers. Markers can be
@@ -28,8 +43,7 @@ export declare type SharedStringSegment = MergeTree.TextSegment | MergeTree.Mark
 export declare class SharedString extends SharedSegmentSequence<SharedStringSegment> implements ISharedString {
     id: string;
     /**
-     * Create a new shared string
-     *
+     * Create a new shared string.
      * @param runtime - data store runtime the new shared string belongs to
      * @param id - optional name of the shared string
      * @returns newly create shared string (but not attached yet)
@@ -37,7 +51,6 @@ export declare class SharedString extends SharedSegmentSequence<SharedStringSegm
     static create(runtime: IFluidDataStoreRuntime, id?: string): SharedString;
     /**
      * Get a factory for SharedString to register with the data store.
-     *
      * @returns a factory that creates and load SharedString
      */
     static getFactory(): SharedStringFactory;
@@ -45,59 +58,51 @@ export declare class SharedString extends SharedSegmentSequence<SharedStringSegm
     private readonly mergeTreeTextHelper;
     constructor(document: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
     /**
-     * Inserts a marker at a relative postition
-     *
-     * @param relativePos1 - The relative postition to insert the marker at
+     * Inserts a marker at a relative position.
+     * @param relativePos1 - The relative position to insert the marker at
      * @param refType - The reference type of the marker
      * @param props - The properties of the marker
      */
     insertMarkerRelative(relativePos1: MergeTree.IRelativePosition, refType: MergeTree.ReferenceType, props?: MergeTree.PropertySet): void;
     /**
-     * Inserts a marker at the postition
-     *
-     * @param pos - The postition to insert the marker at
-     * @param refType - The reference type of the marker
-     * @param props - The properties of the marker
+     * {@inheritDoc ISharedString.insertMarker}
      */
     insertMarker(pos: number, refType: MergeTree.ReferenceType, props?: MergeTree.PropertySet): MergeTree.IMergeTreeInsertMsg;
     /**
-     * Inserts the text at the postition
-     *
-     * @param relativePos1 - The relative postition to insert the text at
+     * Inserts the text at the position.
+     * @param relativePos1 - The relative position to insert the text at
      * @param text - The text to insert
      * @param props - The properties of text
      */
     insertTextRelative(relativePos1: MergeTree.IRelativePosition, text: string, props?: MergeTree.PropertySet): void;
     /**
-     * Inserts the text at the postition
-     *
-     * @param pos - The  postition to insert the text at
-     * @param text - The text to insert
-     * @param props - The properties of text
+     * {@inheritDoc ISharedString.insertText}
      */
     insertText(pos: number, text: string, props?: MergeTree.PropertySet): void;
     /**
      * Replaces a range with the provided text.
-     *
      * @param start - The inclusive start of the range to replace
      * @param end - The exclusive end of the range to replace
      * @param text - The text to replace the range with
      * @param props - Optional. The properties of the replacement text
      */
     replaceText(start: number, end: number, text: string, props?: MergeTree.PropertySet): void;
+    /**
+     * Removes the text in the given range.
+     * @param start - The inclusive start of the range to remove
+     * @param end - The exclusive end of the range to replace
+     * @returns the message sent.
+     */
     removeText(start: number, end: number): MergeTree.IMergeTreeRemoveMsg;
     /**
-     * Annotates the marker with the provided properties
-     * and calls the callback on concensus.
-     *
+     * Annotates the marker with the provided properties and calls the callback on consensus.
      * @param marker - The marker to annotate
      * @param props - The properties to annotate the marker with
      * @param consensusCallback - The callback called when consensus is reached
      */
     annotateMarkerNotifyConsensus(marker: MergeTree.Marker, props: MergeTree.PropertySet, callback: (m: MergeTree.Marker) => void): void;
     /**
-     * Annotates the marker with the provided properties
-     *
+     * Annotates the marker with the provided properties.
      * @param marker - The marker to annotate
      * @param props - The properties to annotate the marker with
      * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.
@@ -111,9 +116,15 @@ export declare class SharedString extends SharedSegmentSequence<SharedStringSegm
         parallelText: string[];
         parallelMarkers: MergeTree.Marker[];
     };
+    /**
+     * Retrieve text from the SharedString in string format.
+     * @param start - The starting index of the text to retrieve, or 0 if omitted.
+     * @param end - The ending index of the text to retrieve, or the end of the string if omitted
+     * @returns The requested text content as a string.
+     */
     getText(start?: number, end?: number): string;
     /**
-     * Adds spaces for markers and handles, so that position calculations account for them
+     * Adds spaces for markers and handles, so that position calculations account for them.
      */
     getTextWithPlaceholders(): string;
     getTextRangeWithPlaceholders(start: number, end: number): string;

package/lib/sharedString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedString.d.ts","sourceRoot":"","sources":["../src/sharedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,SAAS,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AACnG,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,qBAAqB,CAAC,mBAAmB,CAAC;IAC7E,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW,OAAE;IAErE,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW,OAAE;IAE3F,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,iBAAiB,OAAE;CAChE;AAED,oBAAY,mBAAmB,GAAG,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC;AAE3E;;;;;;;;;GASG;AACH,qBAAa,YAAa,SAAQ,qBAAqB,CAAC,mBAAmB,CAAE,YAAW,aAAa;IA2B5C,EAAE,EAAE,MAAM;IA1B/D;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU;IAIxB,IAAW,aAAa,IAAI,aAAa,CAExC;IAED,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAgC;gBAExD,QAAQ,EAAE,sBAAsB,EAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB;IAK/F;;;;;;OAMG;IACI,oBAAoB,CACvB,YAAY,EAAE,SAAS,CAAC,iBAAiB,EACzC,OAAO,EAAE,SAAS,CAAC,aAAa,EAChC,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAajC;;;;;;OAMG;IACI,YAAY,CACf,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,SAAS,CAAC,aAAa,EAChC,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAajC;;;;;;OAMG;IACI,kBAAkB,CAAC,YAAY,EAAE,SAAS,CAAC,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAahH;;;;;;OAMG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAW1E;;;;;;;OAOG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAInF,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAI5C;;;;;;;OAOG;IACI,6BAA6B,CAChC,MAAM,EAAE,SAAS,CAAC,MAAM,EACxB,KAAK,EAAE,SAAS,CAAC,WAAW,EAC5B,QAAQ,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,KAAK,IAAI;IAO3C;;;;;;OAMG;IACI,cAAc,CACjB,MAAM,EAAE,SAAS,CAAC,MAAM,EACxB,KAAK,EAAE,SAAS,CAAC,WAAW,EAC5B,WAAW,CAAC,EAAE,SAAS,CAAC,YAAY;IAOjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,UAAO;;;;IAI1E,iBAAiB,CAAC,KAAK,EAAE,MAAM;;;;IAI/B,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IAI3C;;OAEG;IACI,uBAAuB;IAIvB,4BAA4B,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAIvD,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKlD,eAAe,CAAC,EAAE,EAAE,MAAM;CAGpC"}
+{"version":3,"file":"sharedString.d.ts","sourceRoot":"","sources":["../src/sharedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,SAAS,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AACnG,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,qBAAqB,CAAC,mBAAmB,CAAC;IAC7E;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW,OAAE;IAErE;;;;;OAKG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW,OAAE;IAE3F;;OAEG;IACH,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,iBAAiB,OAAE;CAChE;AAED,oBAAY,mBAAmB,GAAG,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC;AAE3E;;;;;;;;;GASG;AACH,qBAAa,YAAa,SAAQ,qBAAqB,CAAC,mBAAmB,CAAE,YAAW,aAAa;IAyB5C,EAAE,EAAE,MAAM;IAxB/D;;;;;OAKG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;OAGG;WACW,UAAU;IAIxB,IAAW,aAAa,IAAI,aAAa,CAExC;IAED,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAgC;gBAExD,QAAQ,EAAE,sBAAsB,EAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB;IAK/F;;;;;OAKG;IACI,oBAAoB,CACvB,YAAY,EAAE,SAAS,CAAC,iBAAiB,EACzC,OAAO,EAAE,SAAS,CAAC,aAAa,EAChC,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAajC;;OAEG;IACI,YAAY,CACf,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,SAAS,CAAC,aAAa,EAChC,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAajC;;;;;OAKG;IACI,kBAAkB,CAAC,YAAY,EAAE,SAAS,CAAC,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAahH;;OAEG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAY1E;;;;;;OAMG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,WAAW;IAI1F;;;;;OAKG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAI5C;;;;;OAKG;IACI,6BAA6B,CAChC,MAAM,EAAE,SAAS,CAAC,MAAM,EACxB,KAAK,EAAE,SAAS,CAAC,WAAW,EAC5B,QAAQ,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,KAAK,IAAI;IAO3C;;;;;OAKG;IACI,cAAc,CACjB,MAAM,EAAE,SAAS,CAAC,MAAM,EACxB,KAAK,EAAE,SAAS,CAAC,WAAW,EAC5B,WAAW,CAAC,EAAE,SAAS,CAAC,YAAY;IAOjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,UAAO;;;;IAI1E,iBAAiB,CAAC,KAAK,EAAE,MAAM;;;;IAKtC;;;;;OAKG;IACI,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IAK3C;;OAEG;IACI,uBAAuB;IAKvB,4BAA4B,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKvD,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKlD,eAAe,CAAC,EAAE,EAAE,MAAM;CAGpC"}

package/lib/sharedString.js

@@ -7,7 +7,7 @@ import { SharedSegmentSequence } from "./sequence";
 import { SharedStringFactory } from "./sequenceFactory";
 /**
  * The Shared String is a specialized data structure for handling collaborative
- *  text. It is based on a more general Sequence data structure but has
+ * text. It is based on a more general Sequence data structure but has
  * additional features that make working with text easier.
  *
  * In addition to text, a Shared String can also contain markers. Markers can be
@@ -22,8 +22,7 @@ export class SharedString extends SharedSegmentSequence {
         this.mergeTreeTextHelper = this.client.createTextHelper();
     }
     /**
-     * Create a new shared string
-     *
+     * Create a new shared string.
      * @param runtime - data store runtime the new shared string belongs to
      * @param id - optional name of the shared string
      * @returns newly create shared string (but not attached yet)
@@ -33,7 +32,6 @@ export class SharedString extends SharedSegmentSequence {
     }
     /**
      * Get a factory for SharedString to register with the data store.
-     *
      * @returns a factory that creates and load SharedString
      */
     static getFactory() {
@@ -43,9 +41,8 @@ export class SharedString extends SharedSegmentSequence {
         return this;
     }
     /**
-     * Inserts a marker at a relative postition
-     *
-     * @param relativePos1 - The relative postition to insert the marker at
+     * Inserts a marker at a relative position.
+     * @param relativePos1 - The relative position to insert the marker at
      * @param refType - The reference type of the marker
      * @param props - The properties of the marker
      */
@@ -61,11 +58,7 @@ export class SharedString extends SharedSegmentSequence {
         }
     }
     /**
-     * Inserts a marker at the postition
-     *
-     * @param pos - The postition to insert the marker at
-     * @param refType - The reference type of the marker
-     * @param props - The properties of the marker
+     * {@inheritDoc ISharedString.insertMarker}
      */
     insertMarker(pos, refType, props) {
         const segment = new MergeTree.Marker(refType);
@@ -79,9 +72,8 @@ export class SharedString extends SharedSegmentSequence {
         return insertOp;
     }
     /**
-     * Inserts the text at the postition
-     *
-     * @param relativePos1 - The relative postition to insert the text at
+     * Inserts the text at the position.
+     * @param relativePos1 - The relative position to insert the text at
      * @param text - The text to insert
      * @param props - The properties of text
      */
@@ -97,11 +89,7 @@ export class SharedString extends SharedSegmentSequence {
         }
     }
     /**
-     * Inserts the text at the postition
-     *
-     * @param pos - The  postition to insert the text at
-     * @param text - The text to insert
-     * @param props - The properties of text
+     * {@inheritDoc ISharedString.insertText}
      */
     insertText(pos, text, props) {
         const segment = new MergeTree.TextSegment(text);
@@ -115,7 +103,6 @@ export class SharedString extends SharedSegmentSequence {
     }
     /**
      * Replaces a range with the provided text.
-     *
      * @param start - The inclusive start of the range to replace
      * @param end - The exclusive end of the range to replace
      * @param text - The text to replace the range with
@@ -124,13 +111,17 @@ export class SharedString extends SharedSegmentSequence {
     replaceText(start, end, text, props) {
         this.replaceRange(start, end, MergeTree.TextSegment.make(text, props));
     }
+    /**
+     * Removes the text in the given range.
+     * @param start - The inclusive start of the range to remove
+     * @param end - The exclusive end of the range to replace
+     * @returns the message sent.
+     */
     removeText(start, end) {
         return this.removeRange(start, end);
     }
     /**
-     * Annotates the marker with the provided properties
-     * and calls the callback on concensus.
-     *
+     * Annotates the marker with the provided properties and calls the callback on consensus.
      * @param marker - The marker to annotate
      * @param props - The properties to annotate the marker with
      * @param consensusCallback - The callback called when consensus is reached
@@ -142,8 +133,7 @@ export class SharedString extends SharedSegmentSequence {
         }
     }
     /**
-     * Annotates the marker with the provided properties
-     *
+     * Annotates the marker with the provided properties.
      * @param marker - The marker to annotate
      * @param props - The properties to annotate the marker with
      * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.
@@ -161,12 +151,18 @@ export class SharedString extends SharedSegmentSequence {
         const segmentWindow = this.client.getCollabWindow();
         return this.mergeTreeTextHelper.getTextAndMarkers(segmentWindow.currentSeq, segmentWindow.clientId, label);
     }
+    /**
+     * Retrieve text from the SharedString in string format.
+     * @param start - The starting index of the text to retrieve, or 0 if omitted.
+     * @param end - The ending index of the text to retrieve, or the end of the string if omitted
+     * @returns The requested text content as a string.
+     */
     getText(start, end) {
         const segmentWindow = this.client.getCollabWindow();
         return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, "", start, end);
     }
     /**
-     * Adds spaces for markers and handles, so that position calculations account for them
+     * Adds spaces for markers and handles, so that position calculations account for them.
      */
     getTextWithPlaceholders() {
         const segmentWindow = this.client.getCollabWindow();

package/lib/sharedString.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedString.js","sourceRoot":"","sources":["../src/sharedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,SAAS,MAAM,4BAA4B,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAexD;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAa,SAAQ,qBAA0C;IA2BxE,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;IA7BD;;;;;;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;IAED,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IASD;;;;;;OAMG;IACI,oBAAoB,CACvB,YAAyC,EACzC,OAAgC,EAChC,KAA6B;QAC7B,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,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;;;;;;OAMG;IACI,YAAY,CACf,GAAW,EACX,OAAgC,EAChC,KAA6B;QAC7B,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,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;;;;;;OAMG;IACI,kBAAkB,CAAC,YAAyC,EAAE,IAAY,EAAE,KAA6B;QAC5G,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,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;;;;;;OAMG;IACI,UAAU,CAAC,GAAW,EAAE,IAAY,EAAE,KAA6B;QACtE,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,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;IACD;;;;;;;OAOG;IACI,WAAW,CAAC,KAAa,EAAE,GAAW,EAAE,IAAY,EAAE,KAA6B;QACtF,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,UAAU,CAAC,KAAa,EAAE,GAAW;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACI,6BAA6B,CAChC,MAAwB,EACxB,KAA4B,EAC5B,QAAuC;QACvC,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;;;;;;OAMG;IACI,cAAc,CACjB,MAAwB,EACxB,KAA4B,EAC5B,WAAoC;QACpC,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;QAC7E,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;IACM,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;IACD;;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;IACM,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;IACM,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\n// eslint-disable-next-line import/no-unassigned-import\nimport { } from \"@fluidframework/core-interfaces\";\nimport * as MergeTree 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    insertText(pos: number, text: string, props?: MergeTree.PropertySet);\n\n    insertMarker(pos: number, refType: MergeTree.ReferenceType, props?: MergeTree.PropertySet);\n\n    posFromRelativePos(relativePos: MergeTree.IRelativePosition);\n}\n\nexport type SharedStringSegment = MergeTree.TextSegment | MergeTree.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     *\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     *\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: MergeTree.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 postition\n     *\n     * @param relativePos1 - The relative postition 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: MergeTree.IRelativePosition,\n        refType: MergeTree.ReferenceType,\n        props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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     * Inserts a marker at the postition\n     *\n     * @param pos - The postition 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 insertMarker(\n        pos: number,\n        refType: MergeTree.ReferenceType,\n        props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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 postition\n     *\n     * @param relativePos1 - The relative postition to insert the text at\n     * @param text - The text to insert\n     * @param props - The properties of text\n     */\n    public insertTextRelative(relativePos1: MergeTree.IRelativePosition, text: string, props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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     * Inserts the text at the postition\n     *\n     * @param pos - The  postition to insert the text at\n     * @param text - The text to insert\n     * @param props - The properties of text\n     */\n    public insertText(pos: number, text: string, props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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     * Replaces a range with the provided text.\n     *\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?: MergeTree.PropertySet) {\n        this.replaceRange(start, end, MergeTree.TextSegment.make(text, props));\n    }\n\n    public removeText(start: number, end: number) {\n        return this.removeRange(start, end);\n    }\n\n    /**\n     * Annotates the marker with the provided properties\n     * and calls the callback on concensus.\n     *\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: MergeTree.Marker,\n        props: MergeTree.PropertySet,\n        callback: (m: MergeTree.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     *\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: MergeTree.Marker,\n        props: MergeTree.PropertySet,\n        combiningOp?: MergeTree.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        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    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     * 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    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    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) {\n        return this.client.getMarkerFromId(id);\n    }\n}\n"]}
+{"version":3,"file":"sharedString.js","sourceRoot":"","sources":["../src/sharedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,SAAS,MAAM,4BAA4B,CAAC;AAExD,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,YAAyC,EACzC,OAAgC,EAChC,KAA6B;QAC7B,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,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,OAAgC,EAChC,KAA6B;QAC7B,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,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,YAAyC,EAAE,IAAY,EAAE,KAA6B;QAC5G,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,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,KAA6B;QACtE,MAAM,OAAO,GAAG,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,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,KAA6B;QACtF,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3E,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,MAAwB,EACxB,KAA4B,EAC5B,QAAuC;QACvC,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,MAAwB,EACxB,KAA4B,EAC5B,WAAoC;QACpC,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;QAC7E,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\n// eslint-disable-next-line import/no-unassigned-import\nimport { } from \"@fluidframework/core-interfaces\";\nimport * as MergeTree 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 text\n     */\n    insertText(pos: number, text: string, props?: MergeTree.PropertySet);\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: MergeTree.ReferenceType, props?: MergeTree.PropertySet);\n\n    /**\n     * {@inheritDoc SharedSegmentSequence.posFromRelativePos}\n     */\n    posFromRelativePos(relativePos: MergeTree.IRelativePosition);\n}\n\nexport type SharedStringSegment = MergeTree.TextSegment | MergeTree.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: MergeTree.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: MergeTree.IRelativePosition,\n        refType: MergeTree.ReferenceType,\n        props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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: MergeTree.ReferenceType,\n        props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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: MergeTree.IRelativePosition, text: string, props?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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?: MergeTree.PropertySet) {\n        const segment = new MergeTree.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?: MergeTree.PropertySet) {\n        this.replaceRange(start, end, MergeTree.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) {\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: MergeTree.Marker,\n        props: MergeTree.PropertySet,\n        callback: (m: MergeTree.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: MergeTree.Marker,\n        props: MergeTree.PropertySet,\n        combiningOp?: MergeTree.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        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) {\n        return this.client.getMarkerFromId(id);\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "0.48.2",
+  "version": "0.49.0-39313",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -60,23 +60,23 @@
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/core-interfaces": "^0.39.7",
-    "@fluidframework/datastore-definitions": "^0.48.2",
-    "@fluidframework/merge-tree": "^0.48.2",
-    "@fluidframework/protocol-definitions": "^0.1024.0",
-    "@fluidframework/runtime-definitions": "^0.48.2",
-    "@fluidframework/runtime-utils": "^0.48.2",
-    "@fluidframework/shared-object-base": "^0.48.2",
-    "@fluidframework/telemetry-utils": "^0.48.2",
+    "@fluidframework/datastore-definitions": "0.49.0-39313",
+    "@fluidframework/merge-tree": "0.49.0-39313",
+    "@fluidframework/protocol-definitions": "^0.1025.0-38844",
+    "@fluidframework/runtime-definitions": "0.49.0-39313",
+    "@fluidframework/runtime-utils": "0.49.0-39313",
+    "@fluidframework/shared-object-base": "0.49.0-39313",
+    "@fluidframework/telemetry-utils": "0.49.0-39313",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "^0.48.2",
+    "@fluid-internal/test-dds-utils": "0.49.0-39313",
     "@fluidframework/build-common": "^0.23.0",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@fluidframework/gitresources": "^0.1031.0",
-    "@fluidframework/mocha-test-setup": "^0.48.2",
-    "@fluidframework/server-services-client": "^0.1031.0",
-    "@fluidframework/test-runtime-utils": "^0.48.2",
+    "@fluidframework/gitresources": "^0.1031.0-37526",
+    "@fluidframework/mocha-test-setup": "0.49.0-39313",
+    "@fluidframework/server-services-client": "^0.1032.0-39277",
+    "@fluidframework/test-runtime-utils": "0.49.0-39313",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/diff": "^3.5.1",
     "@types/mocha": "^8.2.2",

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "0.48.2";
+export const pkgVersion = "0.49.0-39313";

package/src/sequence.ts

@@ -42,9 +42,36 @@ import { ISharedIntervalCollection } from "./sharedIntervalCollection";
 const snapshotFileName = "header";
 const contentPath = "content";
 
-export interface ISharedSegmentSequenceEvents
-    extends ISharedObjectEvents {
-
+/**
+ * Events emitted in response to changes to the sequence data.
+ *
+ * ### "sequenceDelta"
+ *
+ * The sequenceDelta event is emitted when segments are inserted, annotated, or removed.
+ *
+ * #### Listener signature
+ *
+ * ```typescript
+ * (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void
+ * ```
+ * - `event` - Various information on the segments that were modified.
+ *
+ * - `target` - The sequence itself.
+ *
+ * ### "maintenance"
+ *
+ * The maintenance event is emitted when segments are modified during merge-tree maintenance.
+ *
+ * #### Listener signature
+ *
+ * ```typescript
+ * (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void
+ * ```
+ * - `event` - Various information on the segments that were modified.
+ *
+ * - `target` - The sequence itself.
+ */
+export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
     (event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void);
     (event: "maintenance",
         listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void);
@@ -208,7 +235,7 @@ export abstract class SharedSegmentSequence<T extends MergeTree.ISegment>
     /**
      * Inserts the content of the register.
      *
-     * @param pos - The postition to insert the content at.
+     * @param pos - The position to insert the content at.
      * @param register - The name of the register to get the content from
      */
     public paste(pos: number, register: string) {
@@ -261,7 +288,7 @@ export abstract class SharedSegmentSequence<T extends MergeTree.ISegment>
     /**
      * Annotates the range with the provided properties
      *
-     * @param start - The inclusive start postition of the range to annotate
+     * @param start - The inclusive start position of the range to annotate
      * @param end - The exclusive end position of the range to annotate
      * @param props - The properties to annotate the range with
      * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.

package/src/sequenceDeltaEvent.ts

@@ -84,10 +84,16 @@ export abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTy
         return this.mergeTreeClient.longClientId;
     }
 
+    /**
+     * The first of the modified ranges.
+     */
     public get first(): Readonly<ISequenceDeltaRange<TOperation>> {
         return this.pFirst.value;
     }
 
+    /**
+     * The last of the modified ranges.
+     */
     public get last(): Readonly<ISequenceDeltaRange<TOperation>> {
         return this.pLast.value;
     }
@@ -105,6 +111,9 @@ export abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTy
  * Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.
  */
 export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
+    /**
+     * Whether the event was caused by a locally-made change.
+     */
     public readonly isLocal: boolean;
 
     constructor(
@@ -134,9 +143,18 @@ export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenance
     }
 }
 
+/**
+ * A range that has changed corresponding to a segment modification.
+ */
 export interface ISequenceDeltaRange<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {
     operation: TOperation;
+    /**
+     * The index of the start of the range.
+     */
     position: number;
+    /**
+     * The segment that corresponds to the range.
+     */
     segment: ISegment;
     propertyDeltas: PropertySet;
 }