@fluidframework/map 2.1.0-276985 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.1.0-276985",
+  "version": "2.1.0",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -67,33 +67,33 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.1.0-276985",
-    "@fluidframework/core-interfaces": "2.1.0-276985",
-    "@fluidframework/core-utils": "2.1.0-276985",
-    "@fluidframework/datastore-definitions": "2.1.0-276985",
-    "@fluidframework/driver-definitions": "2.1.0-276985",
-    "@fluidframework/driver-utils": "2.1.0-276985",
-    "@fluidframework/merge-tree": "2.1.0-276985",
-    "@fluidframework/runtime-definitions": "2.1.0-276985",
-    "@fluidframework/runtime-utils": "2.1.0-276985",
-    "@fluidframework/shared-object-base": "2.1.0-276985",
-    "@fluidframework/telemetry-utils": "2.1.0-276985",
+    "@fluid-internal/client-utils": "~2.1.0",
+    "@fluidframework/core-interfaces": "~2.1.0",
+    "@fluidframework/core-utils": "~2.1.0",
+    "@fluidframework/datastore-definitions": "~2.1.0",
+    "@fluidframework/driver-definitions": "~2.1.0",
+    "@fluidframework/driver-utils": "~2.1.0",
+    "@fluidframework/merge-tree": "~2.1.0",
+    "@fluidframework/runtime-definitions": "~2.1.0",
+    "@fluidframework/runtime-utils": "~2.1.0",
+    "@fluidframework/shared-object-base": "~2.1.0",
+    "@fluidframework/telemetry-utils": "~2.1.0",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-276985",
-    "@fluid-private/stochastic-test-utils": "2.1.0-276985",
-    "@fluid-private/test-dds-utils": "2.1.0-276985",
+    "@biomejs/biome": "~1.8.3",
+    "@fluid-internal/mocha-test-setup": "~2.1.0",
+    "@fluid-private/stochastic-test-utils": "~2.1.0",
+    "@fluid-private/test-dds-utils": "~2.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.39.0",
+    "@fluid-tools/build-cli": "^0.41.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.39.0",
-    "@fluidframework/container-definitions": "2.1.0-276985",
+    "@fluidframework/build-tools": "^0.41.0",
+    "@fluidframework/container-definitions": "~2.1.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0-rc.5.0.0",
-    "@fluidframework/test-runtime-utils": "2.1.0-276985",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@2.0.0",
+    "@fluidframework/test-runtime-utils": "~2.1.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
@@ -113,25 +113,33 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "Variable_SharedMap": {
+        "forwardCompat": false
+      },
+      "Variable_SharedDirectory": {
+        "forwardCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
     "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
     "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
+    "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "concurrently \"npm:build:docs:*\"",
-    "build:docs:current": "api-extractor run --local",
-    "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "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 .",
-    "check:biome": "biome check . --formatter-enabled=true",
+    "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",
     "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
@@ -140,14 +148,15 @@
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
-    "ci:build:docs:current": "api-extractor run",
-    "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
+    "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",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
-    "format:biome": "biome check . --formatter-enabled=true --apply",
+    "format:biome": "biome check . --write",
     "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",

package/src/directory.ts

@@ -867,7 +867,9 @@ export class SharedDirectory
 		const nodeList = absolutePath.split(posix.sep);
 		let start = 1;
 		while (start < nodeList.length) {
-			const subDirName = nodeList[start];
+			// Non null asserting, this loop only runs while start in in the bounds of the array
+			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			const subDirName = nodeList[start]!;
 			if (currentParent.isSubDirectoryDeletePending(subDirName)) {
 				return true;
 			}
@@ -1492,7 +1494,10 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 			dirs: this._subdirectories,
 			next(): IteratorResult<[string, IDirectory]> {
 				if (this.index < subdirNames.length) {
-					const subdirName = subdirNames[this.index++];
+					// Non null asserting, we've checked that the index is inside the bounds of the array.
+					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+					const subdirName = subdirNames[this.index]!;
+					this.index++;
 					const subdir = this.dirs.get(subdirName);
 					assert(subdir !== undefined, 0x8ac /* Could not find expected sub-directory. */);
 					return { value: [subdirName, subdir], done: false };
@@ -2183,18 +2188,22 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 	): boolean {
 		if (this.pendingClearMessageIds.length > 0) {
 			if (local) {
+				// Remove all pendingMessageIds lower than first pendingClearMessageId.
+				// Non null asserting, because of pendingClearMessageIds length check above
+				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+				const firstPendingClearMessageId = this.pendingClearMessageIds[0]!;
 				assert(
 					localOpMetadata !== undefined &&
 						isKeyEditLocalOpMetadata(localOpMetadata) &&
-						localOpMetadata.pendingMessageId < this.pendingClearMessageIds[0],
+						localOpMetadata.pendingMessageId < firstPendingClearMessageId,
 					0x010 /* "Received out of order storage op when there is an unackd clear message" */,
 				);
-				// Remove all pendingMessageIds lower than first pendingClearMessageId.
-				const lowestPendingClearMessageId = this.pendingClearMessageIds[0];
 				const pendingKeyMessageIdArray = this.pendingKeys.get(op.key);
 				if (pendingKeyMessageIdArray !== undefined) {
 					let index = 0;
-					while (pendingKeyMessageIdArray[index] < lowestPendingClearMessageId) {
+					// Non-null asserting because we maintain that the pendingKeyMessageIdArray will only exist if it is non-empty.
+					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+					while (pendingKeyMessageIdArray[index]! < firstPendingClearMessageId) {
 						index += 1;
 					}
 					const newPendingKeyMessageId = pendingKeyMessageIdArray.splice(index);

package/src/interfaces.ts

@@ -18,7 +18,7 @@ import type {
  * Type of "valueChanged" event parameter.
  * @sealed
  * @legacy
- * @alpha
+ * @public
  */
 export interface IValueChanged {
 	/**
@@ -38,8 +38,9 @@ export interface IValueChanged {
  * Interface describing actions on a directory.
  *
  * @remarks When used as a Map, operates on its keys.
+ * @sealed
  * @legacy
- * @alpha
+ * @public
  */
 export interface IDirectory
 	// TODO: Use `unknown` instead (breaking change).
@@ -123,6 +124,7 @@ export interface IDirectory
  *
  * @remarks
  * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
+ * @sealed
  * @legacy
  * @alpha
  */
@@ -197,8 +199,9 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 
 /**
  * Events emitted in response to changes to the directory data.
+ * @sealed
  * @legacy
- * @alpha
+ * @public
  */
 export interface IDirectoryEvents extends IEvent {
 	/**
@@ -279,6 +282,7 @@ export interface IDirectoryEvents extends IEvent {
  * Provides a hierarchical organization of map-like data structures as SubDirectories.
  * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.
  * SubDirectories can be retrieved for use as working directories.
+ * @sealed
  * @legacy
  * @alpha
  */
@@ -295,12 +299,16 @@ export interface ISharedDirectory
 
 /**
  * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
+ * @sealed
  * @legacy
- * @alpha
+ * @public
  */
 export interface IDirectoryValueChanged extends IValueChanged {
 	/**
 	 * The absolute path to the IDirectory storing the key which changed.
+	 * @readonly
+	 * @privateRemarks
+	 * When breaking changes can be made, `readonly` should be added.
 	 */
 	path: string;
 }

package/src/map.ts

@@ -202,23 +202,22 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 		//    and result in non-incremental snapshot.
 		//    This can be improved in the future, without being format breaking change, as loading sequence
 		//    loads all blobs at once and partitioning schema has no impact on that process.
-		for (const key of Object.keys(data)) {
-			const value = data[key];
-			if (value.value && value.value.length >= MinValueSizeSeparateSnapshotBlob) {
+		for (const [key, { value, type }] of Object.entries(data)) {
+			if (value && value.length >= MinValueSizeSeparateSnapshotBlob) {
 				const blobName = `blob${counter}`;
 				counter++;
 				blobs.push(blobName);
 				const content: IMapDataObjectSerializable = {
 					[key]: {
-						type: value.type,
-						value: JSON.parse(value.value) as unknown,
+						type,
+						value: JSON.parse(value) as unknown,
 					},
 				};
 				builder.addBlob(blobName, JSON.stringify(content));
 			} else {
-				currentSize += value.type.length + 21; // Approximation cost of property header
-				if (value.value) {
-					currentSize += value.value.length;
+				currentSize += type.length + 21; // Approximation cost of property header
+				if (value) {
+					currentSize += value.length;
 				}
 
 				if (currentSize > MaxSnapshotBlobSize) {
@@ -230,8 +229,8 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 					currentSize = 0;
 				}
 				headerBlob[key] = {
-					type: value.type,
-					value: value.value === undefined ? undefined : (JSON.parse(value.value) as unknown),
+					type,
+					value: value === undefined ? undefined : (JSON.parse(value) as unknown),
 				};
 			}
 		}

package/src/mapKernel.ts

@@ -612,7 +612,9 @@ export class MapKernel {
 				assert(
 					localOpMetadata !== undefined &&
 						isMapKeyLocalOpMetadata(localOpMetadata) &&
-						localOpMetadata.pendingMessageId < this.pendingClearMessageIds[0],
+						// Non null asserting, above we checked that the length is greater than 0.
+						// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+						localOpMetadata.pendingMessageId < this.pendingClearMessageIds[0]!,
 					0x013 /* "Received out of order op when there is an unackd clear message" */,
 				);
 			}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.1.0-276985";
+export const pkgVersion = "2.1.0";

package/tsconfig.json

@@ -5,7 +5,6 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
-		"noUncheckedIndexedAccess": false,
 		"exactOptionalPropertyTypes": false,
 	},
 }