@fluidframework/sequence 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.0.0-internal.7.3.0",
+  "version": "2.0.0-internal.8.0.0",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,34 +35,35 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/core-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/merge-tree": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/merge-tree": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/shared-object-base": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/shared-object-base": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluid-private/stochastic-test-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluid-private/test-dds-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-private/stochastic-test-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
+    "@fluid-private/test-dds-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
     "@fluid-tools/build-cli": "^0.28.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
     "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.0.0-internal.7.2.0",
-    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/diff": "^3.5.1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^16.18.38",
-    "@types/random-js": "^1.0.31",
+    "@types/node": "^18.19.0",
+    "@types/uuid": "^9.0.2",
     "c8": "^7.7.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -73,7 +74,7 @@
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
     "prettier": "~3.0.3",
-    "random-js": "^1.0.8",
+    "random-js": "^2.1.0",
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
@@ -94,7 +95,27 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "InterfaceDeclaration_ISharedString": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedSegmentSequence": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedSequence": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "ClassDeclaration_SharedString": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "TypeAliasDeclaration_SharedStringSegment": {
+        "backCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
@@ -107,17 +128,19 @@
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.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 prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
     "perf": "cross-env FLUID_TEST_VERBOSE=1 mocha \"dist/**/*.spec.js\" --node-option unhandled-rejections=strict,expose-gc --exit -r node_modules/@fluidframework/mocha-test-setup --perfMode --fgrep @Benchmark --reporter @fluid-tools/benchmark/dist/MochaReporter.js --timeout 30000",
     "perf:measure": "npm run perf -- --fgrep @Measurement",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
     "test:benchmark:report": "mocha \"dist/test/*.perf.spec.js\" --node-option unhandled-rejections=strict,expose-gc --exit --perfMode --fgrep @Benchmark -r @fluidframework/mocha-test-setup --reporter @fluid-tools/benchmark/dist/MochaReporter.js --timeout 60000",
     "test:coverage": "c8 npm test",
@@ -127,7 +150,6 @@
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "test:newsnapfiles": "node dist/test/createSnapshotFiles.js",
     "test:stress": "cross-env FUZZ_TEST_COUNT=100 FUZZ_STRESS_RUN=true mocha --ignore \"dist/test/memory/**/*\" --recursive \"dist/test/**/*.fuzz.spec.js\" -r @fluidframework/mocha-test-setup",
-    "testfarm": "node dist/test/testFarm.js",
     "tsc": "tsc",
     "typetests:gen": "fluid-type-test-generator",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

package/src/defaultMap.ts

@@ -18,6 +18,7 @@ import {
 	ISerializableValue,
 	ISerializedValue,
 	IValueChanged,
+	// eslint-disable-next-line import/no-deprecated
 	IValueOpEmitter,
 	IValueType,
 	IValueTypeOperationValue,
@@ -25,6 +26,7 @@ import {
 	IMapMessageLocalMetadata,
 	SequenceOptions,
 } from "./defaultMapInterfaces";
+import { IntervalOpType, SerializedIntervalDelta } from "./intervals";
 
 /**
  * Defines the means to process and submit a given op on a map.
@@ -131,7 +133,7 @@ export class DefaultMap<T> {
 		private readonly serializer: IFluidSerializer,
 		private readonly handle: IFluidHandle,
 		private readonly submitMessage: (
-			op: any,
+			op: IMapValueTypeOperation,
 			localOpMetadata: IMapMessageLocalMetadata,
 		) => void,
 		private readonly type: IValueType<T>,
@@ -292,21 +294,24 @@ export class DefaultMap<T> {
 	 * also sent if we are asked to resubmit the message.
 	 * @returns True if the operation was submitted, false otherwise.
 	 */
-	public tryResubmitMessage(op: any, localOpMetadata: IMapMessageLocalMetadata): boolean {
+	public tryResubmitMessage(
+		op: IMapOperation,
+		localOpMetadata: IMapMessageLocalMetadata,
+	): boolean {
 		const type: string = op.type;
 		const handler = this.messageHandlers.get(type);
 		if (handler !== undefined) {
-			handler.resubmit(op as IMapOperation, localOpMetadata);
+			handler.resubmit(op, localOpMetadata);
 			return true;
 		}
 		return false;
 	}
 
-	public tryGetStashedOpLocalMetadata(op: any): unknown {
+	public tryGetStashedOpLocalMetadata(op: IMapOperation): unknown {
 		const type: string = op.type;
 		if (this.messageHandlers.has(type)) {
 			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			return this.messageHandlers.get(type)!.getStashedOpLocalMetadata(op as IMapOperation);
+			return this.messageHandlers.get(type)!.getStashedOpLocalMetadata(op);
 		}
 		throw new Error("no apply stashed op handler");
 	}
@@ -406,12 +411,11 @@ export class DefaultMap<T> {
 				assert(localValue !== undefined, 0x3f8 /* Local value expected on resubmission */);
 
 				const handler = localValue.getOpHandler(op.value.opName);
-				const { rebasedOp, rebasedLocalOpMetadata } = handler.rebase(
-					localValue.value,
-					op.value,
-					localOpMetadata,
-				);
-				this.submitMessage({ ...op, value: rebasedOp }, rebasedLocalOpMetadata);
+				const rebased = handler.rebase(localValue.value, op.value, localOpMetadata);
+				if (rebased !== undefined) {
+					const { rebasedOp, rebasedLocalOpMetadata } = rebased;
+					this.submitMessage({ ...op, value: rebasedOp }, rebasedLocalOpMetadata);
+				}
 			},
 			getStashedOpLocalMetadata: (op: IMapValueTypeOperation) => {
 				assert(
@@ -430,13 +434,15 @@ export class DefaultMap<T> {
 	 * @param key - The key of the map that the value type will be stored on
 	 * @returns A value op emitter for the given key
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	private makeMapValueOpEmitter(key: string): IValueOpEmitter {
-		const emit = (
-			opName: string,
-			previousValue: any,
-			params: any,
+		// eslint-disable-next-line import/no-deprecated
+		const emit: IValueOpEmitter["emit"] = (
+			opName: IntervalOpType,
+			previousValue: unknown,
+			params: SerializedIntervalDelta,
 			localOpMetadata: IMapMessageLocalMetadata,
-		) => {
+		): void => {
 			const translatedParams = makeHandlesSerializable(params, this.serializer, this.handle);
 
 			const op: IMapValueTypeOperation = {

package/src/defaultMapInterfaces.ts

@@ -6,6 +6,7 @@
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { ISharedObjectEvents } from "@fluidframework/shared-object-base";
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
+import { ISerializedInterval, IntervalOpType, SerializedIntervalDelta } from "./intervals";
 
 /**
  * Type of "valueChanged" event parameter.
@@ -25,20 +26,20 @@ 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 {
 	/**
 	 * Called by the value type to emit a value type operation through the container type holding it.
 	 * @param opName - Name of the emitted operation
-	 * @param previousValue - JSONable previous value as defined by the value type
+	 * @param previousValue - JSONable previous value as defined by the value type @deprecated unused
 	 * @param params - JSONable params for the operation as defined by the value type
 	 * @param localOpMetadata - JSONable local metadata which should be submitted with the op
-	 * @internal
 	 */
 	emit(
-		opName: string,
-		previousValue: any,
-		params: any,
+		opName: IntervalOpType,
+		previousValue: undefined,
+		params: SerializedIntervalDelta,
 		localOpMetadata: IMapMessageLocalMetadata,
 	): void;
 }
@@ -52,7 +53,7 @@ export interface IMapMessageLocalMetadata {
 
 /**
  * Optional flags that configure options for sequence DDSs
- * @public
+ * @internal
  */
 export interface SequenceOptions {
 	/**
@@ -123,11 +124,11 @@ export interface IValueOperation<T> {
 	 */
 	process(
 		value: T,
-		params: any,
+		params: ISerializedInterval,
 		local: boolean,
 		message: ISequencedDocumentMessage | undefined,
 		localOpMetadata: IMapMessageLocalMetadata | undefined,
-	);
+	): void;
 
 	/**
 	 * Rebases an `op` on `value` from its original perspective (ref/local seq) to the current
@@ -141,7 +142,9 @@ export interface IValueOperation<T> {
 		value: T,
 		op: IValueTypeOperationValue,
 		localOpMetadata: IMapMessageLocalMetadata,
-	): { rebasedOp: IValueTypeOperationValue; rebasedLocalOpMetadata: IMapMessageLocalMetadata };
+	):
+		| { rebasedOp: IValueTypeOperationValue; rebasedLocalOpMetadata: IMapMessageLocalMetadata }
+		| undefined;
 }
 
 /**
@@ -164,14 +167,14 @@ export interface IValueType<T> {
 	 * Operations that can be applied to the value type.
 	 * @alpha
 	 */
-	ops: Map<string, IValueOperation<T>>;
+	ops: Map<IntervalOpType, IValueOperation<T>>;
 }
 
 export interface ISharedDefaultMapEvents extends ISharedObjectEvents {
 	(
 		event: "valueChanged" | "create",
 		listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void,
-	);
+	): void;
 }
 
 /**
@@ -182,7 +185,7 @@ export interface ISharedDefaultMapEvents extends ISharedObjectEvents {
  * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)
  * and ops (set).
  *
- * The DefaultMap impelmentation for sequence has been specialized to only support a single ValueType, which serializes
+ * The DefaultMap implementation for sequence has been specialized to only support a single ValueType, which serializes
  * and deserializes via .store() and .load().
  */
 export interface ISerializableValue {
@@ -222,10 +225,10 @@ export interface IValueTypeOperationValue {
 	/**
 	 * The name of the operation.
 	 */
-	opName: string;
+	opName: IntervalOpType;
 
 	/**
 	 * The payload that is submitted along with the operation.
 	 */
-	value: any;
+	value: SerializedIntervalDelta;
 }

package/src/index.ts

@@ -85,3 +85,20 @@ export {
 	SharedIntervalCollectionFactory,
 } from "./sharedIntervalCollection";
 export { IJSONRunSegment, SharedSequence, SubSequence } from "./sharedSequence";
+
+export {
+	ISegment,
+	Marker,
+	BaseSegment,
+	ReferencePosition,
+	ReferenceType,
+	PropertySet,
+	MapLike,
+	TextSegment,
+	MergeTreeDeltaType,
+	reservedMarkerIdKey,
+	reservedTileLabelsKey,
+	reservedRangeLabelsKey,
+	TrackingGroup,
+	LocalReferencePosition,
+} from "@fluidframework/merge-tree";