@fluidframework/sequence 0.57.0 → 0.58.0-55983

package/src/sequence.ts

@@ -156,7 +156,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
     protected client: Client;
     // Deferred that triggers once the object is loaded
     protected loadedDeferred = new Deferred<void>();
-    // cache out going ops created when parital loading
+    // cache out going ops created when partial loading
     private readonly loadedDeferredOutgoingOps:
         [IMergeTreeOp, SegmentGroup | SegmentGroup[]][] = [];
     // cache incoming ops that arrive when partial loading
@@ -314,7 +314,13 @@ export abstract class SharedSegmentSequence<T extends ISegment>
     /**
      * Resolves a remote client's position against the local sequence
      * and returns the remote client's position relative to the local
-     * sequence
+     * sequence. The client ref seq must be above the minimum sequence number
+     * or the return value will be undefined.
+     * Generally this method is used in conjunction with signals which provide
+     * point in time values for the below parameters, and is useful for things
+     * like displaying user position. It should not be used with persisted values
+     * as persisted values will quickly become invalid as the remoteClientRefSeq
+     * moves below the minimum sequence number
      * @param remoteClientPosition - The remote client's position to resolve
      * @param remoteClientRefSeq - The reference sequence number of the remote client
      * @param remoteClientId - The client id of the remote client
@@ -538,7 +544,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                     this.loadFinished(error);
                 });
             if (this.dataStoreRuntime.options?.sequenceInitializeFromHeaderOnly !== true) {
-                // if we not doing parital load, await the catch up ops,
+                // if we not doing partial load, await the catch up ops,
                 // and the finalization of the load
                 await loadCatchUpOps;
             }
@@ -594,14 +600,14 @@ export abstract class SharedSegmentSequence<T extends ISegment>
         const message = parseHandles(rawMessage, this.serializer);
 
         const ops: IMergeTreeDeltaOp[] = [];
-        function transfromOps(event: SequenceDeltaEvent) {
+        function transformOps(event: SequenceDeltaEvent) {
             ops.push(...SharedSegmentSequence.createOpsFromDelta(event));
         }
         const needsTransformation = message.referenceSequenceNumber !== message.sequenceNumber - 1;
         let stashMessage: Readonly<ISequencedDocumentMessage> = message;
         if (this.runtime.options?.newMergeTreeSnapshotFormat !== true) {
             if (needsTransformation) {
-                this.on("sequenceDelta", transfromOps);
+                this.on("sequenceDelta", transformOps);
             }
         }
 
@@ -609,7 +615,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 
         if (this.runtime.options?.newMergeTreeSnapshotFormat !== true) {
             if (needsTransformation) {
-                this.removeListener("sequenceDelta", transfromOps);
+                this.removeListener("sequenceDelta", transformOps);
                 // shallow clone the message as we only overwrite top level properties,
                 // like referenceSequenceNumber and content only
                 stashMessage = {
@@ -654,7 +660,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
                 throw error;
             } else {
                 // it is important this series remains synchronous
-                // first we stop defering incoming ops, and apply then all
+                // first we stop deferring incoming ops, and apply then all
                 this.deferIncomingOps = false;
                 while (this.loadedDeferredIncomingOps.length > 0) {
                     this.processCore(this.loadedDeferredIncomingOps.shift(), false, undefined);

package/src/sequenceFactory.ts

@@ -94,10 +94,10 @@ export class SharedObjectSequenceFactory implements IChannelFactory {
      * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
      */
     public static segmentFromSpec(segSpec: IJSONSegment) {
-        // eslint-disable-next-line @typescript-eslint/ban-types
+
         const runSegment = segSpec as IJSONRunSegment<object>;
         if (runSegment.items) {
-            // eslint-disable-next-line @typescript-eslint/ban-types
+
             const seg = new SubSequence<object>(runSegment.items);
             if (runSegment.props) {
                 seg.addProperties(runSegment.props);
@@ -133,7 +133,7 @@ export class SharedObjectSequenceFactory implements IChannelFactory {
         id: string,
         services: IChannelServices,
         attributes: IChannelAttributes): Promise<ISharedObject> {
-        // eslint-disable-next-line @typescript-eslint/ban-types
+
         const sharedSeq = new SharedObjectSequence<object>(runtime, id, attributes);
         await sharedSeq.load(services);
         return sharedSeq;

package/src/sharedIntervalCollection.ts

@@ -172,7 +172,7 @@ export class SharedIntervalCollection<TInterval extends ISerializableInterval =
 
     /**
      * Creates the full path of the intervalCollection label
-     * @param label - the incoming lable
+     * @param label - the incoming label
      */
     protected getIntervalCollectionPath(label: string): string {
         return label;

package/src/sharedObjectSequence.ts

@@ -27,7 +27,7 @@ export class SharedObjectSequence<T> extends SharedSequence<T> {
      * @deprecated SharedObjectSequence is not recommended for use and will be removed in an upcoming release.
      * For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)
      */
-    // eslint-disable-next-line @typescript-eslint/no-shadow
+
     public static create<T>(runtime: IFluidDataStoreRuntime, id?: string) {
         return runtime.createChannel(id, SharedObjectSequenceFactory.Type) as SharedObjectSequence<T>;
     }

package/src/sharedString.ts

@@ -3,8 +3,6 @@
  * Licensed under the MIT License.
  */
 
-// eslint-disable-next-line import/no-unassigned-import
-import { } from "@fluidframework/core-interfaces";
 import {
     ICombiningOp,
     IMergeTreeInsertMsg,
@@ -30,7 +28,7 @@ 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
+     * @param props - The properties of the text
      */
     insertText(pos: number, text: string, props?: PropertySet): void;
 

package/src/sparsematrix.ts

@@ -159,7 +159,7 @@ export class RunSegment extends SubSequence<SparseMatrixItem> {
     }
 
     public getTag(pos: number) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
         return this.tags[pos];
     }
 
@@ -276,13 +276,13 @@ export class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
 
     public getItem(row: number, col: number):
         // The return type is defined explicitly here to prevent TypeScript from generating dynamic imports
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
+
         Jsonable<string | number | boolean | IFluidHandle<IFluidObject & FluidObject & IFluidLoadable>> {
         const pos = rowColToPosition(row, col);
         const { segment, offset } =
             this.getContainingSegment(pos);
         if (RunSegment.is(segment)) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
             return segment.items[offset];
         } else if (PaddingSegment.is(segment)) {
             return undefined;
@@ -294,7 +294,7 @@ export class SparseMatrix extends SharedSegmentSequence<MatrixSegment> {
     public getTag(row: number, col: number) {
         const { segment, offset } = this.getSegment(row, col);
         if (RunSegment.is(segment)) {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
             return segment.getTag(offset);
         }
         return undefined;