@fluidframework/sequence 1.2.7 → 2.0.0-dev.1.3.0.96595

package/src/sequenceDeltaEvent.ts

@@ -25,12 +25,6 @@ import {
  * They will not take into any future modifications performed to the underlying sequence and merge tree.
  */
 export abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {
-    /**
-     * @deprecated - Events no longer fire when the change they correspond to had no impact (e.g. a remote delete
-     * event for a range that had already been deleted locally).
-     * Clients can therefore assume this property is false.
-     */
-    public readonly isEmpty: boolean;
     public readonly deltaOperation: TOperation;
     private readonly sortedRanges: Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>;
     private readonly pFirst: Lazy<ISequenceDeltaRange<TOperation>>;
@@ -41,7 +35,6 @@ export abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTy
         private readonly mergeTreeClient: Client,
     ) {
         assert(deltaArgs.deltaSegments.length > 0, 0x2d8 /* "Empty change event should not be emitted." */);
-        this.isEmpty = false;
         this.deltaOperation = deltaArgs.operation;
 
         this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(

package/src/sharedIntervalCollection.ts

@@ -31,8 +31,8 @@ import { IMapMessageLocalMetadata } from "./defaultMapInterfaces";
 const snapshotFileName = "header";
 
 /**
- * The factory that defines the SharedIntervalCollection
- * @deprecated - SharedIntervalCollection is not maintained and is planned to be removed.
+ * The factory that defines the SharedIntervalCollection.
+ * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
  */
 export class SharedIntervalCollectionFactory implements IChannelFactory {
     public static readonly Type = "https://graph.microsoft.com/types/sharedIntervalCollection";
@@ -82,7 +82,7 @@ export interface ISharedIntervalCollection<TInterval extends ISerializableInterv
 }
 
 /**
- * @deprecated - SharedIntervalCollection is not maintained and is planned to be removed.
+ * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
  */
 export class SharedIntervalCollection
     extends SharedObject implements ISharedIntervalCollection<Interval> {
@@ -128,8 +128,8 @@ export class SharedIntervalCollection
     }
 
     /**
-     * @deprecated - IntervalCollections are created on a first-write wins basis, and concurrent creates
-     * are supported. Use `getIntervalCollection` instead.
+     * @deprecated `IntervalCollection`s are created on a first-write wins basis, and concurrent creates
+     * are supported. Use {@link SharedIntervalCollection.getIntervalCollection} instead.
      */
     public async waitIntervalCollection(
         label: string,

package/src/sharedString.ts

@@ -7,10 +7,10 @@ import {
     ICombiningOp,
     IMergeTreeInsertMsg,
     IMergeTreeRemoveMsg,
+    IMergeTreeTextHelper,
     IRelativePosition,
     ISegment,
     Marker,
-    MergeTreeTextHelper,
     PropertySet,
     ReferencePosition,
     ReferenceType,
@@ -81,7 +81,7 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
         return this;
     }
 
-    private readonly mergeTreeTextHelper: MergeTreeTextHelper;
+    private readonly mergeTreeTextHelper: IMergeTreeTextHelper;
 
     constructor(document: IFluidDataStoreRuntime, public id: string, attributes: IChannelAttributes) {
         super(document, id, attributes, SharedStringFactory.segmentFromSpec);
@@ -223,6 +223,9 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
         return this.client.findTile(startPos, tileLabel, preceding);
     }
 
+    /**
+     * @deprecated Use the free function {@link getTextAndMarkers} exported by this package instead.
+     */
     public getTextAndMarkers(label: string) {
         const segmentWindow = this.client.getCollabWindow();
         return this.mergeTreeTextHelper.getTextAndMarkers(segmentWindow.currentSeq, segmentWindow.clientId, label);
@@ -242,14 +245,16 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
     /**
      * Adds spaces for markers and handles, so that position calculations account for them.
      */
-    public getTextWithPlaceholders() {
+    public getTextWithPlaceholders(start?: number, end?: number) {
         const segmentWindow = this.client.getCollabWindow();
-        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ");
+        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ", start, end);
     }
 
+    /**
+     * @deprecated Use {@link SharedString.getTextWithPlaceholders} instead.
+     */
     public getTextRangeWithPlaceholders(start: number, end: number) {
-        const segmentWindow = this.client.getCollabWindow();
-        return this.mergeTreeTextHelper.getText(segmentWindow.currentSeq, segmentWindow.clientId, " ", start, end);
+        return this.getTextWithPlaceholders(start, end);
     }
 
     public getTextRangeWithMarkers(start: number, end: number) {
@@ -260,4 +265,37 @@ export class SharedString extends SharedSegmentSequence<SharedStringSegment> imp
     public getMarkerFromId(id: string): ISegment {
         return this.client.getMarkerFromId(id);
     }
+
+    /**
+     * Revert an op
+     */
+    protected rollback(content: any, localOpMetadata: unknown): void {
+        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: SharedString, label: string): {
+    parallelText: string[];
+    parallelMarkers: Marker[];
+} {
+    return sharedString.getTextAndMarkers(label);
 }

package/src/sparsematrix.ts

@@ -25,10 +25,11 @@ 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 {
     public static readonly typeString = "PaddingSegment";
@@ -98,12 +99,14 @@ export class PaddingSegment extends BaseSegment {
 }
 
 /**
- * @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 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 class RunSegment extends SubSequence<SparseMatrixItem> {
     public static readonly typeString = "RunSegment";
@@ -183,43 +186,51 @@ export class RunSegment extends SubSequence<SparseMatrixItem> {
 }
 
 /**
- * @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 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 const maxCol = 0x200000;         // X128 Excel maximum of 16,384 columns
 
 /**
- * @deprecated maxCols is part of an abandoned prototype.  Use SharedMatrix instead.
- */
-export const maxCols = maxCol + 1;
-
-/**
- * @deprecated maxRow is part of an abandoned prototype.  Use 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.
- */
-export const maxRows = maxRow + 1;
-
-/**
- * @deprecated maxCellPosition is part of an abandoned prototype.  Use SharedMatrix instead.
- */
-export const maxCellPosition = maxCol * maxRow;
-
-/**
- * @deprecated positionToRowCol is part of an abandoned prototype.  Use SharedMatrix instead.
- */
-export const rowColToPosition = (row: number, col: number) => row * maxCols + col;
-
-/**
- * @deprecated positionToRowCol 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 {@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 {@link @fluidframework/matrix#SharedMatrix} instead.
+  */
+ export const maxRows = maxRow + 1;
+
+ /**
+  * @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 {@link @fluidframework/matrix#SharedMatrix} instead.
+  */
+ export const rowColToPosition = (row: number, col: number) => row * maxCols + col;
+
+ /**
+  * @deprecated `positionToRowCol` is part of an abandoned prototype.
+  * Use {@link @fluidframework/matrix#SharedMatrix} instead.
+  */
 export function positionToRowCol(position: number) {
     const row = Math.floor(position / maxCols);
     const col = position - (row * maxCols);
@@ -227,7 +238,8 @@ export function positionToRowCol(position: number) {
 }
 
 /**
- * @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<MatrixSegment> {
     /**
@@ -366,7 +378,8 @@ export class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
 }
 
 /**
- * @deprecated SparseMatrixFactory is an abandoned prototype.  Use SharedMatrixFactory instead.
+ * @deprecated `SparseMatrixFactory` is an abandoned prototype.
+ * Use {@link @fluidframework/matrix#SharedMatrixFactory} instead.
  */
 export class SparseMatrixFactory implements IChannelFactory {
     public static Type = "https://graph.microsoft.com/types/mergeTree/sparse-matrix";