@fluidframework/sequence 2.20.0 → 2.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -52,6 +52,18 @@
         "types": "./dist/intervalCollection.d.ts",
         "default": "./dist/intervalCollection.js"
       }
+    },
+    "./internal/test": {
+      "allow-ff-test-exports": {
+        "import": {
+          "types": "./lib/test/index.d.ts",
+          "default": "./lib/test/index.js"
+        },
+        "require": {
+          "types": "./dist/test/index.d.ts",
+          "default": "./dist/test/index.js"
+        }
+      }
     }
   },
   "main": "lib/index.js",
@@ -79,33 +91,33 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.20.0",
-    "@fluidframework/core-interfaces": "~2.20.0",
-    "@fluidframework/core-utils": "~2.20.0",
-    "@fluidframework/datastore-definitions": "~2.20.0",
-    "@fluidframework/driver-definitions": "~2.20.0",
-    "@fluidframework/merge-tree": "~2.20.0",
-    "@fluidframework/runtime-definitions": "~2.20.0",
-    "@fluidframework/runtime-utils": "~2.20.0",
-    "@fluidframework/shared-object-base": "~2.20.0",
-    "@fluidframework/telemetry-utils": "~2.20.0",
+    "@fluid-internal/client-utils": "~2.21.0",
+    "@fluidframework/core-interfaces": "~2.21.0",
+    "@fluidframework/core-utils": "~2.21.0",
+    "@fluidframework/datastore-definitions": "~2.21.0",
+    "@fluidframework/driver-definitions": "~2.21.0",
+    "@fluidframework/merge-tree": "~2.21.0",
+    "@fluidframework/runtime-definitions": "~2.21.0",
+    "@fluidframework/runtime-utils": "~2.21.0",
+    "@fluidframework/shared-object-base": "~2.21.0",
+    "@fluidframework/telemetry-utils": "~2.21.0",
     "double-ended-queue": "^2.1.0-0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.20.0",
-    "@fluid-private/stochastic-test-utils": "~2.20.0",
-    "@fluid-private/test-dds-utils": "~2.20.0",
+    "@fluid-internal/mocha-test-setup": "~2.21.0",
+    "@fluid-private/stochastic-test-utils": "~2.21.0",
+    "@fluid-private/test-dds-utils": "~2.21.0",
     "@fluid-tools/benchmark": "^0.50.0",
     "@fluid-tools/build-cli": "^0.51.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.51.0",
-    "@fluidframework/container-definitions": "~2.20.0",
-    "@fluidframework/eslint-config-fluid": "^5.6.0",
-    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.13.0",
-    "@fluidframework/test-runtime-utils": "~2.20.0",
+    "@fluidframework/container-definitions": "~2.21.0",
+    "@fluidframework/eslint-config-fluid": "^5.7.3",
+    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.20.0",
+    "@fluidframework/test-runtime-utils": "~2.21.0",
     "@microsoft/api-extractor": "7.47.8",
     "@types/diff": "^3.5.1",
     "@types/double-ended-queue": "^2.1.0",
@@ -136,56 +148,7 @@
     }
   },
   "typeValidation": {
-    "broken": {
-      "Class_BaseSegment": {
-        "backCompat": false
-      },
-      "Class_Marker": {
-        "backCompat": false
-      },
-      "Class_TextSegment": {
-        "backCompat": false
-      },
-      "Class_TrackingGroup": {
-        "backCompat": false
-      },
-      "ClassStatics_BaseSegment": {
-        "backCompat": false
-      },
-      "ClassStatics_Marker": {
-        "backCompat": false
-      },
-      "ClassStatics_TextSegment": {
-        "backCompat": false
-      },
-      "ClassStatics_TrackingGroup": {
-        "backCompat": false
-      },
-      "Interface_ISegment": {
-        "backCompat": false
-      },
-      "Interface_ISequenceDeltaRange": {
-        "backCompat": false
-      },
-      "Interface_SequenceDeltaEvent": {
-        "backCompat": false
-      },
-      "Interface_SequenceEvent": {
-        "backCompat": false
-      },
-      "Interface_SequenceMaintenanceEvent": {
-        "backCompat": false
-      },
-      "TypeAlias_IntervalRevertible": {
-        "backCompat": false
-      },
-      "TypeAlias_SharedStringRevertible": {
-        "backCompat": false
-      },
-      "TypeAlias_SharedStringSegment": {
-        "backCompat": false
-      }
-    },
+    "broken": {},
     "entrypoint": "legacy"
   },
   "scripts": {
@@ -204,7 +167,7 @@
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./internal/test/intervalCollection",
+    "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints ./internal/test/intervalCollection ./internal/test",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
@@ -218,7 +181,7 @@
     "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",

package/src/index.ts

@@ -84,11 +84,7 @@ export {
 	SharedStringSegment,
 	SharedStringClass,
 } from "./sharedString.js";
-export {
-	ISharedIntervalCollection,
-	SharedIntervalCollection,
-	SharedIntervalCollectionFactory,
-} from "./sharedIntervalCollection.js";
+export { ISharedIntervalCollection } from "./sharedIntervalCollection.js";
 export { IJSONRunSegment, SharedSequence, SubSequence } from "./sharedSequence.js";
 
 export {

package/src/intervalCollectionMap.ts

@@ -283,7 +283,14 @@ export class IntervalCollectionMap<T extends ISerializableInterval> {
 	 * @param local - Whether the message originated from the local client
 	 * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
 	 * For messages from a remote client, this will be undefined.
-	 * @returns True if the operation was processed, false otherwise.
+	 * @returns True if the operation was recognized and thus processed, false otherwise.
+	 *
+	 * @remarks
+	 * When this returns false and the caller doesn't handle the op itself, then the op could be from a different version of this code.
+	 * In such a case, not applying the op would result in this client becoming out of sync with clients that do handle the op
+	 * and could result in data corruption or data loss as well.
+	 * Therefore, in such cases the caller should typically throw an error, ensuring that this client treats the situation as data corruption
+	 * (since its data no longer matches what other clients think the data should be) and will avoid overriding document content or misleading the users into thinking their current state is accurate.
 	 */
 	public tryProcessMessage(
 		op: unknown,

package/src/intervalCollectionMapInterfaces.ts

@@ -35,7 +35,6 @@ export interface IValueChanged {
 /**
  * Value types are given an IValueOpEmitter to emit their ops through the container type that holds them.
  * @internal
- * @deprecated - will be remove from public api as there is no public used of this type
  */
 export interface IValueOpEmitter {
 	/**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.20.0";
+export const pkgVersion = "2.21.0";

package/src/sequence.ts

@@ -387,15 +387,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	extends SharedObject<ISharedSegmentSequenceEvents>
 	implements ISharedSegmentSequence<T>
 {
-	/**
-	 * This promise is always immediately resolved, and awaiting it has no effect.
-	 * @deprecated SharedSegmentSequence no longer supports partial loading.
-	 * References to this promise may safely be deleted without affecting behavior.
-	 */
-	get loaded(): Promise<void> {
-		return Promise.resolve();
-	}
-
 	/**
 	 * This is a safeguard to avoid problematic reentrancy of local ops. This type of scenario occurs if the user of SharedString subscribes
 	 * to the `sequenceDelta` event and uses the callback for a local op to submit further local ops.

package/src/sharedIntervalCollection.ts

@@ -4,6 +4,7 @@
  */
 
 import { bufferToString } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
 	IChannelAttributes,
 	IChannelFactory,
@@ -169,11 +170,14 @@ export class SharedIntervalCollection
 		localOpMetadata: unknown,
 	) {
 		if (message.type === MessageType.Operation) {
-			this.intervalCollections.tryProcessMessage(
-				message.contents as IMapOperation,
-				local,
-				message,
-				localOpMetadata,
+			assert(
+				this.intervalCollections.tryProcessMessage(
+					message.contents as IMapOperation,
+					local,
+					message,
+					localOpMetadata,
+				),
+				0xab3 /* SharedIntervalCollection received an unrecognized op, possibly from a newer version */,
 			);
 		}
 	}