@fluidframework/sequence 2.0.0-internal.6.4.0 → 2.0.0-internal.7.1.0

package/CHANGELOG.md

@@ -1,5 +1,96 @@
 # @fluidframework/sequence
 
+## 2.0.0-internal.7.1.0
+
+### Minor Changes
+
+-   sequence: IntervalCollection.add's intervalType is now deprecated ([#17165](https://github.com/microsoft/FluidFramework/issues/17165)) [a8ea26c9d6](https://github.com/microsoft/FluidFramework/commits/a8ea26c9d61e4938f10c87a8757734f8772fbce6)
+
+    The `intervalType` parameter is being removed from `IntervalCollection.add`. The new usage requires calling add with an object containing each of the desired parameters.
+    Example: `add({start: 0, end: 1, props: { a: b }})`
+
+    The signature of `IntervalCollection.change` is also being updated to an object containing the desired parameters,
+    instead of the existing list of parameters. In addition, `changeProperties` will be removed, so in order to change the
+    properties of an interval, the `change` method (with the updated signature) will be used. The id of the interval is not
+    included in the object passed to `change`, but is instead passed as the first parameter to `change`.
+
+    Examples:
+
+    -   Change interval endpoints: `change(intervalId, { start: 3, end: 4 })`
+    -   Change interval properties: `change(intervalId, { props: { a: c } })`
+
+-   merge-tree: Deprecate IntervalType.Nest, internedSpaces, RangeStackMap, refGetRangeLabels, refHasRangeLabel, and refHasRangeLabels ([#17555](https://github.com/microsoft/FluidFramework/issues/17555)) [e4c11874ef](https://github.com/microsoft/FluidFramework/commits/e4c11874ef7c62b7cde7c282bc7997519d35fbbc)
+
+    The following classes and functions have been deprecated. The functionality has poor test coverage and is largely
+    unused. They will be removed in a future release.
+
+    -   IntervalType.Nest
+    -   internedSpaces
+    -   RangeStackMap
+    -   refGetRangeLabels
+    -   refHasRangeLabel
+    -   refHasRangeLabels
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   sequence: New API for specifying spatial positioning of intervals [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Previously intervals were specified with only an index. Now the model is a bit more nuanced in that you can specify positions that lie before or after a given index. This makes it more clear how interval endpoints should interact with changes to the sequence. See the docs for SequencePlace for additional context.
+
+-   sequence: IIntervalCollection.change must specify both endpoints [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    IIntervalCollection.change no longer allows an endpoint to be undefined. undefined can unintentionally result in end < start. To adapt to this change, simply use the current position of the endpoint that is not intended to change.
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+-   sequence: Remove `compareStarts` and `compareEnds` from `IIntervalHelpers` [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    These methods are redudant with the functions `IInterval.compareStart` and `IInterval.compareEnd` respectively.
+
+-   sequence: Remove the mergeTreeUseNewLengthCalculations flag [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The `mergeTreeUseNewLengthCalculations` flag has been removed, because the feature was enabled by default in 2.0.0-internal.6.0.0.
+
 ## 2.0.0-internal.6.4.0
 
 Dependency updates only.

package/README.md

@@ -387,6 +387,132 @@ comments.changeProperties(comment.getIntervalId(), { status: "resolved" });
 comments.removeIntervalById(comment.getIntervalId());
 ```
 
+### Interval stickiness
+
+"Stickiness" refers to the behavior of intervals when text is inserted on either
+side of the interval. A "sticky" interval is one which expands to include text
+inserted directly adjacent to it.
+
+A "start sticky" interval is one which expands only to include text inserted to
+the start of it. An "end sticky" interval is the same, but with regard to text
+inserted adjacent to the end.
+
+For example, let's look at the string "abc". If we have an interval on the
+character "b", what happens when we insert text on either side of it? In the
+below diagrams, we represent an interval by putting a caret directly underneath
+the characters it contains.
+
+#### Example
+
+##### Original string
+
+```typescript
+abc
+ ^
+```
+
+##### No stickiness
+
+```typescript
+aXbYc
+  ^
+```
+
+The interval does not expand to include the newly inserted characters `X` and `Y`.
+
+##### Start stickiness
+
+```typescript
+aXbYc
+ ^^
+```
+
+##### End stickiness
+
+```typescript
+aXbYc
+  ^^
+```
+
+##### Full stickiness
+
+```typescript
+aXbYc
+ ^^^
+```
+
+#### Concrete Implementation
+
+The above is a description of the abstract semantics of the concept of stickiness.
+In practice, this is implemented using the concept of "sides."
+
+For a given sequence of N characters, there are 2N + 2 positions which can be
+referenced: the position immediately before and after each character, and two
+special endpoint segments denoting the position before and after the start and
+end of the sequence respectively.
+
+By placing the endpoints of an interval either before or after a character, it
+is possible to make the endpoints inclusive or exclusive. An exclusive endpoint
+in a given direction implies stickiness in that direction. Whether an endpoint
+is inclusive or exclusive depends on both the Side and if it is the start or the
+end.
+
+Given the string "ABCD":
+
+```typescript
+// Refers to "BC". If any content is inserted before B or after C, this
+// interval will include that content
+//
+// Picture:
+// {start} - A[- B - C -]D - {end}
+// {start} - A - B - C - D - {end}
+collection.add(
+	{ pos: 0, side: Side.After },
+	{ pos: 3, side: Side.Before },
+	IntervalType.SlideOnRemove,
+);
+// Equivalent to specifying the same positions and Side.Before.
+// Refers to "ABC". Content inserted after C will be included in the
+// interval, but content inserted before A will not.
+// {start} -[A - B - C -]D - {end}
+// {start} - A - B - C - D - {end}
+collection.add(0, 3, IntervalType.SlideOnRemove);
+```
+
+In the case of the first interval shown, if text is deleted,
+
+```typescript
+// Delete the character "B"
+string.removeRange(1, 2);
+```
+
+The start point of the interval will slide to the position immediately before
+"C", and the same will be true.
+
+```typescript
+{start} - A[- C -]D - {end}
+```
+
+In this case, text inserted immediately before "C" would be included in the
+interval.
+
+```typescript
+string.insertText(1, "EFG");
+```
+
+With the string now being,
+
+```typescript
+{start} - A[- E - F - G - C -]D - {end}
+```
+
+Note that the endpoint continues to remain with the associated character, except
+when the character is removed. When content containing endpoints is removed,
+`After` endpoints move backward and `Before` endpoints move forward to maintain their
+side value and inclusive/exclusive behavior.
+
+<!-- This line ends the content that is copied to the sequences.md README -->
+
 ## SharedString
 
 SharedString is a specialized data structure for handling collaborative text. It is based on a more general
@@ -460,6 +586,8 @@ For further reading on attribution, see the [@fluid-experimental/attributor READ
 
 There are plans to make attribution policies more flexible, for example tracking attribution of property changes separately from segment insertion.
 
+<!-- This line begins the content that is copied to the string.md README -->
+
 ### Examples
 
 -   Rich Text Editor Implementations
@@ -476,5 +604,7 @@ There are plans to make attribution policies more flexible, for example tracking
     -   [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)
 
+<!-- This line ends the content that is copied to the string.md README -->
+
 [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,4 +1,19 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common-strict.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json",
+
+	// Configures how the .d.ts rollup file will be generated.
+	"dtsRollup": {
+		// This package has a root module named "sequence" which conflicts with the default naming here.
+		// TODO: remove this override once the base config has been updated to append `-untrimmed` globally.
+		"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-untrimmed.d.ts"
+	},
+	"messages": {
+		"extractorMessageReporting": {
+			"ae-missing-release-tag": {
+				// TODO: Fix violations and remove this rule override
+				"logLevel": "none"
+			}
+		}
+	}
 }