@fluidframework/sequence 1.2.0-77818 → 1.2.0-78837

package/README.md

@@ -1,10 +1,17 @@
 # @fluidframework/sequence
 
-The **@fluidframework/sequence** packages supports distributed data structures which are list-like.
-It includes [SharedString]({{< relref "string.md" >}}) for storing and simultaneously editing a sequence of text.
+The **@fluidframework/sequence** package supports distributed data structures which are list-like.
+Its main export is [SharedString][], a DDS for storing and simultaneously editing a sequence of text.
+
 Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for working with text.
 
-Sequence DDSes share a common base class, `SharedSegmentSequence`.
+This package historically contained several other sequence-based DDSes, but because they have unintuitive behaviors,
+they are deprecated and being moved to the *experimental* folder.
+
+The main reason for this is the lack of *move* semantics within the sequence, which becomes crucial when dealing with sequences of
+complex content.
+For that reason, all of the examples in this README use `SharedString`. However, the APIs discussed are available on the common base class: `SharedSegmentSequence`.
+
 For the remainder of this document, the term *sequence* will refer to this base class.
 
 *Item*s are the individual units that are stored within the sequence (e.g. in a SharedString, the items are characters),
@@ -43,8 +50,11 @@ farther position is closer to the length. -->
 
 ## Using a Sequence
 
-Sequences support three basic operations: insert, remove, and annotate. Insert and remove are used to add and remove
-items from the sequence, while annotate is used to add metadata to items.
+Sequences support three basic operations: insert, remove, and annotate.
+Insert and remove are used to add and remove items from the sequence, while annotate is used to add metadata to items.
+Notably, sequences do not support a notion of "moving" a range of content.
+
+If "move" semantics are a hard requirement for your scenario, [this github issue](https://github.com/microsoft/FluidFramework/issues/8518) outlines some reasonable alternatives.
 
 ### Insert
 
@@ -148,6 +158,27 @@ specified range. Setting a property key to null will remove that property from t
 Whenever an operation is performed on a sequence a *sequenceDelta* event will be raised. This event provides the ranges
 affected by the operation, the type of the operation, and the properties that were changes by the operation.
 
+```typescript
+sharedString.on("sequenceDelta", ({ deltaOperation, ranges, isLocal }) => {
+    if (isLocal) {
+        // undo-redo implementations frequently will only concern themselves with local ops: only operations submitted
+        // by the local client should be undoable by the current user
+        addOperationToUndoStack(deltaOperation, ranges);
+    }
+
+    if (deltaOperation === MergeTreeDeltaType.INSERT) {
+        syncInsertSegmentToModel(deltaOperation, ranges);
+    }
+
+    // realistic app code would likely handle the other deltaOperation types as well here.
+});
+```
+
+Internally, the sequence package depends on `@fluidframework/merge-tree`, and also raises `MergeTreeMaintenance` events on that tree as *maintenance* events.
+These events don't correspond directly to APIs invoked on a sequence DDS, but may be useful for advanced users.
+
+Both sequenceDelta and maintenance events are commonly used to synchronize or invalidate a view an application might have over a backing sequence DDS.
+
 ## Sequence merge strategy
 
 The Fluid sequence data structures are eventually consistent, which means all editors will end up in the same
@@ -245,6 +276,124 @@ As mentioned above, annotate operations behave like operations on SharedMaps. Th
 wins. If two collaborators set the same key on the annotate properties the operation that gets ordered last will
 determine the value.
 
+## Local references
+
+Sequences support addition and manipulation of *local references* to locally track positions in the sequence over time.
+As the name suggests, any created references will only exist locally; other clients will not see them.
+This can be used to implement user interactions with sequence data in a way that is robust to concurrent editing.
+For example, consider a text editor which tracks a user's cursor state.
+The application can store a local reference to the character after the cursor position:
+
+```typescript
+    //   content: hi world!
+    // positions: 012345678
+    const { segment, offset } = sharedString.getContainingSegment(5)
+    const cursor = sharedString.createLocalReferencePosition(
+        segment,
+        offset,
+        ReferenceType.SlideOnRemove,
+        /* any additional properties */ { cursorColor: 'blue' }
+    );
+
+    //    cursor:      x
+    //   content: hi world!
+    // positions: 012345678
+
+    // ... in some view code, retrieve the position of the local reference for rendering:
+    const pos = sharedString.localReferencePositionToPosition(cursor); // 5
+
+    // meanwhile, some other client submits an edit which gets applied to our string:
+    otherSharedString.replaceText(1, 2, "ello");
+
+    // The local sharedString state will now look like this:
+    //    cursor:         x
+    //   content: hello world!
+    // positions: 0123456789AB (hex)
+
+    // ... in some view code, retrieve the position of the local reference for rendering:
+    const pos = sharedString.localReferencePositionToPosition(cursor); // 8
+```
+
+Notice that even though another client concurrently edited the string, the local reference representing the cursor is still in the correct location with no further work for the API consumer.
+The `ReferenceType.SlideOnRemove` parameter changes what happens when the segment that reference is associated with is removed.
+`SlideOnRemove` instructs the sequence to attempt to *slide* the reference to the start of the next furthest segment, or if no such segment exists (i.e. the end of the string has been removed), the end of the next nearest one.
+
+The [webflow](https://github.com/microsoft/FluidFramework/blob/main/examples/data-objects/webflow/src/editor/caret.ts) example demonstrates this idea in more detail.
+
+Unlike segments, it *is* safe to persist local references in auxiliary data structures, such as an undo-redo stack.
+
+## Interval collections
+
+Sequences support creation of *interval collections*, an auxiliary collection of intervals associated with positions in the sequence.
+Like segments, intervals support adding arbitrary properties, including handles (references) to other DDSes.
+The interval collection implementation uses local references, and so benefits from all of the robustness to concurrent editing
+described in the previous section.
+Unlike local references, operations on interval collections are sent to all clients and updated in an eventually consistent way.
+This makes them suitable for implementing features like comment threads on a text-based documents.
+The following example illustrates these properties and highlights the major APIs supported by IntervalCollection.
+
+
+```typescript
+    //   content: hi world!
+    // positions: 012345678
+
+    const comments = sharedString.getIntervalCollection("comments");
+    const comment = comments.add(
+        3,
+        7, // (inclusive range): references "world"
+        IntervalType.SlideOnRemove,
+        {
+            creator: 'my-user-id',
+            handle: myCommentThreadDDS.handle
+        }
+    );
+    //   content: hi world!
+    // positions: 012345678
+    //   comment:    [   ]
+
+    // Interval collection supports iterating over all intervals via Symbol.iterator or `.map()`:
+    const allIntervalsInCollection = Array.from(comments);
+    const allProperties = comments.map((comment) => comment.properties);
+    // or iterating over intervals overlapping a region:
+    const intervalsOverlappingFirstHalf = comments.findOverlappingIntervals(0, 4);
+
+    // Interval endpoints are LocalReferencePositions, so all APIs in the above section can be used:
+    const startPosition = sharedString.localReferencePositionToPosition(comment.start);
+    const endPosition = sharedString.localReferencePositionToPosition(comment.end);
+
+    // Intervals can be modified:
+    comments.change(comment.getIntervalId(), 0, 1);
+    //   content: hi world!
+    // positions: 012345678
+    //   comment: []
+
+    // their properties can be changed:
+    comments.changeProperties(comment.getIntervalId(), { status: "resolved" });
+    // comment.properties === { creator: 'my-user-id', handle: <some DDS handle object>, status: "resolved" }
+
+    // and they can be removed:
+    comments.removeIntervalById(comment.getIntervalId());
+```
+
+### Intervals vs. markers
+
+Interval endpoints and markers both implement *ReferencePosition* and seem to serve a similar function so it's not obvious how they differ and why you would choose one or the other.
+
+Using the interval collection API has two main benefits:
+
+1. Efficient spatial querying
+    - Interval collections support iterating all intervals overlapping the region `[start, end]` in `O(log N) + O(overlap size)` time, where `N` is the total number of intervals in the collection.
+    This may be critical for applications that display only a small view of the document contents.
+    On the other hand, using markers to implement intervals would require a linear scan from the start or end of the sequence to determine which intervals overlap.
+
+2. More ergonomic modification APIs
+    - Interval collections natively support a modify operation on the intervals, which allows moving the endpoints of the interval to a different place in the sequence.
+    This operation is atomic, whereas with markers one would have to submit a delete operation for the existing position and an insert for the new one.
+    In order to achieve the same atomicity, those operations would need to leverage the `SharedSegmentSequence.groupOperation` API,
+    which is less user-friendly.
+    If the ops were submitted using standard insert and delete APIs instead, there would be some potential for data loss if the delete
+    operation ended up acknowledged by the server but the insert operation did not.
+
 ## SharedString
 
 The SharedString is a specialized data structure for handling collaborative text. It is based on a more general
@@ -266,15 +415,15 @@ to 0, and the farther position is closer to the length.
 
 - Rich Text Editor Implementations
   - [webflow](https://github.com/microsoft/FluidFramework/tree/main/examples/data-objects/webflow)
-  - [flowView](https://github.com/microsoft/FluidFramework/blob/main/examples/data-objects/client-ui-lib/src/controls/flowView.ts)
+  - [flowView](https://github.com/microsoft/FluidFramework/blob/main/examples/data-objects/shared-text/src/client-ui-lib/controls/flowView.ts)
 
 - Integrations with Open Source Rich Text Editors
   - [prosemirror](https://github.com/microsoft/FluidFramework/tree/main/examples/data-objects/prosemirror)
   - [smde](https://github.com/microsoft/FluidFramework/tree/main/examples/data-objects/smde)
-  - [draft-js](https://github.com/microsoft/FluidExamples/tree/main/draft-js)
 
 - Plain Text Editor Implementations
-  - [collaborativeTextArea](https://github.com/microsoft/FluidFramework/blob/main/examples/data-objects/react-inputs/src/CollaborativeTextArea.tsx)
-  - [collaborativeInput](https://github.com/microsoft/FluidFramework/blob/main/examples/data-objects/react-inputs/src/collaborativeInput.tsx)
+  - [collaborativeTextArea](https://github.com/microsoft/FluidFramework/blob/main/experimental/framework/react-inputs/src/CollaborativeTextArea.tsx)
+  - [collaborativeInput](https://github.com/microsoft/FluidFramework/blob/main/experimental/framework/react-inputs/src/CollaborativeInput.tsx)
 
 [SharedMap]: https://fluidframework.com/docs/data-structures/map/
+[SharedString]: https://github.com/microsoft/FluidFramework/blob/main/packages/dds/sequence/src/sharedString.ts

package/api-extractor.json

@@ -1,12 +1,4 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json",
-  "messages": {
-    "extractorMessageReporting": {
-      "ae-internal-missing-underscore": {
-        "logLevel": "none",
-        "addToApiReportFile": false
-      }
-    }
-  }
+  "extends": "@fluidframework/build-common/api-extractor-common-strict.json"
 }

package/dist/index.d.ts

@@ -2,6 +2,17 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * 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
+ * text.
+ *
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
 export { DeserializeCallback, IIntervalCollectionEvent, IIntervalHelpers, Interval, IntervalCollection, IntervalCollectionIterator, IntervalType, ISerializableInterval, ISerializedInterval, SequenceInterval, ISerializedIntervalCollectionV2, CompressedSerializedInterval, } from "./intervalCollection";
 export { IMapMessageLocalMetadata, IValueOpEmitter, } from "./defaultMapInterfaces";
 export * from "./sharedString";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,+BAA+B,EAC/B,4BAA4B,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,wBAAwB,EACxB,eAAe,GAClB,MAAM,wBAAwB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;GAUG;AAEH,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,+BAA+B,EAC/B,4BAA4B,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,wBAAwB,EACxB,eAAe,GAClB,MAAM,wBAAwB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}

package/dist/index.js

@@ -15,6 +15,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SequenceInterval = exports.IntervalType = exports.IntervalCollectionIterator = exports.IntervalCollection = exports.Interval = void 0;
+/**
+ * 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
+ * text.
+ *
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
 var intervalCollection_1 = require("./intervalCollection");
 Object.defineProperty(exports, "Interval", { enumerable: true, get: function () { return intervalCollection_1.Interval; } });
 Object.defineProperty(exports, "IntervalCollection", { enumerable: true, get: function () { return intervalCollection_1.IntervalCollection; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAEH,2DAa8B;AAT1B,8GAAA,QAAQ,OAAA;AACR,wHAAA,kBAAkB,OAAA;AAClB,gIAAA,0BAA0B,OAAA;AAC1B,kHAAA,YAAY,OAAA;AAGZ,sHAAA,gBAAgB,OAAA;AAQpB,iDAA+B;AAC/B,6CAA2B;AAC3B,oDAAkC;AAClC,uDAAqC;AACrC,mDAAiC;AACjC,yDAAuC;AACvC,yDAAuC;AACvC,iDAA+B;AAC/B,6DAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    DeserializeCallback,\n    IIntervalCollectionEvent,\n    IIntervalHelpers,\n    Interval,\n    IntervalCollection,\n    IntervalCollectionIterator,\n    IntervalType,\n    ISerializableInterval,\n    ISerializedInterval,\n    SequenceInterval,\n    ISerializedIntervalCollectionV2,\n    CompressedSerializedInterval,\n} from \"./intervalCollection\";\nexport {\n    IMapMessageLocalMetadata,\n    IValueOpEmitter,\n} from \"./defaultMapInterfaces\";\nexport * from \"./sharedString\";\nexport * from \"./sequence\";\nexport * from \"./sequenceFactory\";\nexport * from \"./sequenceDeltaEvent\";\nexport * from \"./sharedSequence\";\nexport * from \"./sharedObjectSequence\";\nexport * from \"./sharedNumberSequence\";\nexport * from \"./sparsematrix\";\nexport * from \"./sharedIntervalCollection\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAEH;;;;;;;;;;GAUG;AAEH,2DAa8B;AAT1B,8GAAA,QAAQ,OAAA;AACR,wHAAA,kBAAkB,OAAA;AAClB,gIAAA,0BAA0B,OAAA;AAC1B,kHAAA,YAAY,OAAA;AAGZ,sHAAA,gBAAgB,OAAA;AAQpB,iDAA+B;AAC/B,6CAA2B;AAC3B,oDAAkC;AAClC,uDAAqC;AACrC,mDAAiC;AACjC,yDAAuC;AACvC,yDAAuC;AACvC,iDAA+B;AAC/B,6DAA2C","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Supports distributed data structures which are list-like.\n *\n * This package's main export is {@link SharedSequence}, a DDS for storing and simultaneously editing a sequence of\n * text.\n *\n * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for\n * working with text.\n *\n * @packageDocumentation\n */\n\nexport {\n    DeserializeCallback,\n    IIntervalCollectionEvent,\n    IIntervalHelpers,\n    Interval,\n    IntervalCollection,\n    IntervalCollectionIterator,\n    IntervalType,\n    ISerializableInterval,\n    ISerializedInterval,\n    SequenceInterval,\n    ISerializedIntervalCollectionV2,\n    CompressedSerializedInterval,\n} from \"./intervalCollection\";\nexport {\n    IMapMessageLocalMetadata,\n    IValueOpEmitter,\n} from \"./defaultMapInterfaces\";\nexport * from \"./sharedString\";\nexport * from \"./sequence\";\nexport * from \"./sequenceFactory\";\nexport * from \"./sequenceDeltaEvent\";\nexport * from \"./sharedSequence\";\nexport * from \"./sharedObjectSequence\";\nexport * from \"./sharedNumberSequence\";\nexport * from \"./sparsematrix\";\nexport * from \"./sharedIntervalCollection\";\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/sequence";
-export declare const pkgVersion = "1.2.0-77818";
+export declare const pkgVersion = "1.2.0-78837";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/sequence";
-exports.pkgVersion = "1.2.0-77818";
+exports.pkgVersion = "1.2.0-78837";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,0BAA0B,CAAC;AACrC,QAAA,UAAU,GAAG,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"1.2.0-77818\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,0BAA0B,CAAC;AACrC,QAAA,UAAU,GAAG,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"1.2.0-78837\";\n"]}

package/lib/index.d.ts

@@ -2,6 +2,17 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * 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
+ * text.
+ *
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
 export { DeserializeCallback, IIntervalCollectionEvent, IIntervalHelpers, Interval, IntervalCollection, IntervalCollectionIterator, IntervalType, ISerializableInterval, ISerializedInterval, SequenceInterval, ISerializedIntervalCollectionV2, CompressedSerializedInterval, } from "./intervalCollection";
 export { IMapMessageLocalMetadata, IValueOpEmitter, } from "./defaultMapInterfaces";
 export * from "./sharedString";

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,+BAA+B,EAC/B,4BAA4B,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,wBAAwB,EACxB,eAAe,GAClB,MAAM,wBAAwB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;GAUG;AAEH,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EACZ,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,+BAA+B,EAC/B,4BAA4B,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,wBAAwB,EACxB,eAAe,GAClB,MAAM,wBAAwB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC"}

package/lib/index.js

@@ -2,6 +2,17 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * 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
+ * text.
+ *
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
 export { Interval, IntervalCollection, IntervalCollectionIterator, IntervalType, SequenceInterval, } from "./intervalCollection";
 export * from "./sharedString";
 export * from "./sequence";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAIH,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EAGZ,gBAAgB,GAGnB,MAAM,sBAAsB,CAAC;AAK9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    DeserializeCallback,\n    IIntervalCollectionEvent,\n    IIntervalHelpers,\n    Interval,\n    IntervalCollection,\n    IntervalCollectionIterator,\n    IntervalType,\n    ISerializableInterval,\n    ISerializedInterval,\n    SequenceInterval,\n    ISerializedIntervalCollectionV2,\n    CompressedSerializedInterval,\n} from \"./intervalCollection\";\nexport {\n    IMapMessageLocalMetadata,\n    IValueOpEmitter,\n} from \"./defaultMapInterfaces\";\nexport * from \"./sharedString\";\nexport * from \"./sequence\";\nexport * from \"./sequenceFactory\";\nexport * from \"./sequenceDeltaEvent\";\nexport * from \"./sharedSequence\";\nexport * from \"./sharedObjectSequence\";\nexport * from \"./sharedNumberSequence\";\nexport * from \"./sparsematrix\";\nexport * from \"./sharedIntervalCollection\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;GAUG;AAEH,OAAO,EAIH,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC1B,YAAY,EAGZ,gBAAgB,GAGnB,MAAM,sBAAsB,CAAC;AAK9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Supports distributed data structures which are list-like.\n *\n * This package's main export is {@link SharedSequence}, a DDS for storing and simultaneously editing a sequence of\n * text.\n *\n * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for\n * working with text.\n *\n * @packageDocumentation\n */\n\nexport {\n    DeserializeCallback,\n    IIntervalCollectionEvent,\n    IIntervalHelpers,\n    Interval,\n    IntervalCollection,\n    IntervalCollectionIterator,\n    IntervalType,\n    ISerializableInterval,\n    ISerializedInterval,\n    SequenceInterval,\n    ISerializedIntervalCollectionV2,\n    CompressedSerializedInterval,\n} from \"./intervalCollection\";\nexport {\n    IMapMessageLocalMetadata,\n    IValueOpEmitter,\n} from \"./defaultMapInterfaces\";\nexport * from \"./sharedString\";\nexport * from \"./sequence\";\nexport * from \"./sequenceFactory\";\nexport * from \"./sequenceDeltaEvent\";\nexport * from \"./sharedSequence\";\nexport * from \"./sharedObjectSequence\";\nexport * from \"./sharedNumberSequence\";\nexport * from \"./sparsematrix\";\nexport * from \"./sharedIntervalCollection\";\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/sequence";
-export declare const pkgVersion = "1.2.0-77818";
+export declare const pkgVersion = "1.2.0-78837";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "1.2.0-77818";
+export const pkgVersion = "1.2.0-78837";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"1.2.0-77818\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"1.2.0-78837\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "1.2.0-77818",
+  "version": "1.2.0-78837",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -64,28 +64,28 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-utils": "1.2.0-77818",
-    "@fluidframework/core-interfaces": "1.2.0-77818",
-    "@fluidframework/datastore-definitions": "1.2.0-77818",
-    "@fluidframework/merge-tree": "1.2.0-77818",
+    "@fluidframework/container-utils": "1.2.0-78837",
+    "@fluidframework/core-interfaces": "1.2.0-78837",
+    "@fluidframework/datastore-definitions": "1.2.0-78837",
+    "@fluidframework/merge-tree": "1.2.0-78837",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "1.2.0-77818",
-    "@fluidframework/runtime-utils": "1.2.0-77818",
-    "@fluidframework/shared-object-base": "1.2.0-77818",
-    "@fluidframework/telemetry-utils": "1.2.0-77818",
+    "@fluidframework/runtime-definitions": "1.2.0-78837",
+    "@fluidframework/runtime-utils": "1.2.0-78837",
+    "@fluidframework/shared-object-base": "1.2.0-78837",
+    "@fluidframework/telemetry-utils": "1.2.0-78837",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/stochastic-test-utils": "1.2.0-77818",
-    "@fluid-internal/test-dds-utils": "1.2.0-77818",
+    "@fluid-internal/stochastic-test-utils": "1.2.0-78837",
+    "@fluid-internal/test-dds-utils": "1.2.0-78837",
     "@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.2.0-77818",
+    "@fluidframework/mocha-test-setup": "1.2.0-78837",
     "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@1.1.0",
     "@fluidframework/server-services-client": "^0.1036.5000",
-    "@fluidframework/test-runtime-utils": "1.2.0-77818",
+    "@fluidframework/test-runtime-utils": "1.2.0-78837",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/diff": "^3.5.1",

package/src/index.ts

@@ -3,6 +3,18 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * 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
+ * text.
+ *
+ * @remarks Note that SharedString is a sequence DDS but it has additional specialized features and behaviors for
+ * working with text.
+ *
+ * @packageDocumentation
+ */
+
 export {
     DeserializeCallback,
     IIntervalCollectionEvent,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "1.2.0-77818";
+export const pkgVersion = "1.2.0-78837";