@fluidframework/map 2.80.0 → 2.81.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.80.0",
+  "version": "2.81.0",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -81,32 +81,32 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.80.0",
-    "@fluidframework/core-interfaces": "~2.80.0",
-    "@fluidframework/core-utils": "~2.80.0",
-    "@fluidframework/datastore-definitions": "~2.80.0",
-    "@fluidframework/driver-definitions": "~2.80.0",
-    "@fluidframework/driver-utils": "~2.80.0",
-    "@fluidframework/runtime-definitions": "~2.80.0",
-    "@fluidframework/runtime-utils": "~2.80.0",
-    "@fluidframework/shared-object-base": "~2.80.0",
-    "@fluidframework/telemetry-utils": "~2.80.0",
+    "@fluid-internal/client-utils": "~2.81.0",
+    "@fluidframework/core-interfaces": "~2.81.0",
+    "@fluidframework/core-utils": "~2.81.0",
+    "@fluidframework/datastore-definitions": "~2.81.0",
+    "@fluidframework/driver-definitions": "~2.81.0",
+    "@fluidframework/driver-utils": "~2.81.0",
+    "@fluidframework/runtime-definitions": "~2.81.0",
+    "@fluidframework/runtime-utils": "~2.81.0",
+    "@fluidframework/shared-object-base": "~2.81.0",
+    "@fluidframework/telemetry-utils": "~2.81.0",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.80.0",
-    "@fluid-private/stochastic-test-utils": "~2.80.0",
-    "@fluid-private/test-dds-utils": "~2.80.0",
-    "@fluid-tools/benchmark": "^0.51.0",
-    "@fluid-tools/build-cli": "^0.62.0",
+    "@fluid-internal/mocha-test-setup": "~2.81.0",
+    "@fluid-private/stochastic-test-utils": "~2.81.0",
+    "@fluid-private/test-dds-utils": "~2.81.0",
+    "@fluid-tools/benchmark": "^0.52.0",
+    "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.62.0",
-    "@fluidframework/container-definitions": "~2.80.0",
-    "@fluidframework/eslint-config-fluid": "~2.80.0",
-    "@fluidframework/map-previous": "npm:@fluidframework/map@2.74.0",
-    "@fluidframework/test-runtime-utils": "~2.80.0",
+    "@fluidframework/build-tools": "^0.63.0",
+    "@fluidframework/container-definitions": "~2.81.0",
+    "@fluidframework/eslint-config-fluid": "~2.81.0",
+    "@fluidframework/map-previous": "npm:@fluidframework/map@2.80.0",
+    "@fluidframework/test-runtime-utils": "~2.81.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",

package/src/directory.ts

@@ -3,6 +3,9 @@
  * Licensed under the MIT License.
  */
 
+// TODO: Fix prefer-nullish-coalescing and prefer-optional-chain lint violations
+/* eslint-disable @typescript-eslint/prefer-nullish-coalescing, @typescript-eslint/prefer-optional-chain */
+
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import type {
@@ -40,7 +43,7 @@ import type {
 	IDirectoryEvents,
 	IDirectoryValueChanged,
 	ISharedDirectory,
-	ISharedDirectoryEventsInternal,
+	ISharedDirectoryEvents,
 	IValueChanged,
 } from "./interfaces.js";
 import type {
@@ -402,7 +405,7 @@ interface SequenceData {
  * @sealed
  */
 export class SharedDirectory
-	extends SharedObject<ISharedDirectoryEventsInternal>
+	extends SharedObject<ISharedDirectoryEvents>
 	implements ISharedDirectory
 {
 	/**
@@ -525,7 +528,7 @@ export class SharedDirectory
 	// TODO: Use `unknown` instead (breaking change).
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public forEach(callback: (value: any, key: string, map: Map<string, any>) => void): void {
-		// eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
+		// eslint-disable-next-line unicorn/no-array-for-each
 		this.root.forEach(callback);
 	}
 
@@ -1574,7 +1577,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		if (!this.directory.isAttached()) {
 			this.sequencedStorageData.clear();
 			this.directory.emit("clear", true, this.directory);
-			this.directory.emit("clearInternal", this.absolutePath, true, this.directory);
+			this.directory.emit("cleared", this.absolutePath, true, this.directory);
 			return;
 		}
 
@@ -1586,7 +1589,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 		this.pendingStorageData.push(pendingClear);
 
 		this.directory.emit("clear", true, this.directory);
-		this.directory.emit("clearInternal", this.absolutePath, true, this.directory);
+		this.directory.emit("cleared", this.absolutePath, true, this.directory);
 		const op: IDirectoryOperation = {
 			type: "clear",
 			path: this.absolutePath,
@@ -1937,7 +1940,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 			// Don't emit events if this directory has been disposed or no longer exists
 			if (!this.pendingStorageData.some((entry) => entry.type === "clear")) {
 				this.directory.emit("clear", local, this.directory);
-				this.directory.emit("clearInternal", this.absolutePath, local, this.directory);
+				this.directory.emit("cleared", this.absolutePath, local, this.directory);
 			}
 
 			// For pending set operations, emit valueChanged events

package/src/interfaces.ts

@@ -153,6 +153,8 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	/**
 	 * Emitted when the {@link ISharedDirectory} is cleared.
 	 *
+	 * @deprecated Use the "cleared" event instead which provides the path that was cleared.
+	 *
 	 * @remarks Listener parameters:
 	 *
 	 * - `local` - Whether the clear originated from this client.
@@ -161,6 +163,22 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	 */
 	(event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void);
 
+	/**
+	 * Emitted when the {@link ISharedDirectory} is cleared.
+	 *
+	 * @remarks Listener parameters:
+	 *
+	 * - `path` - The absolute path to the directory that was cleared.
+	 *
+	 * - `local` - Whether the clear originated from this client.
+	 *
+	 * - `target` - The {@link ISharedDirectory} itself.
+	 */
+	(
+		event: "cleared",
+		listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void,
+	);
+
 	/**
 	 * Emitted when a subdirectory is created.
 	 *
@@ -277,28 +295,6 @@ export interface IDirectoryEvents extends IEvent {
 	(event: "undisposed", listener: (target: IEventThisPlaceHolder) => void);
 }
 
-/**
- * Internal events for {@link ISharedDirectory}.
- * @internal
- */
-export interface ISharedDirectoryEventsInternal extends ISharedDirectoryEvents {
-	/**
-	 * Emitted when the {@link ISharedDirectory} is cleared.
-	 *
-	 * @remarks Listener parameters:
-	 *
-	 * - `path` - The absolute path to the directory that was cleared.
-	 *
-	 * - `local` - Whether the clear originated from this client.
-	 *
-	 * - `target` - The {@link ISharedDirectory} itself.
-	 */
-	(
-		event: "clearInternal",
-		listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void,
-	);
-}
-
 /**
  * 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.

package/src/map.ts

@@ -124,7 +124,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 	// TODO: Use `unknown` instead (breaking change).
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public forEach(callbackFn: (value: any, key: string, map: Map<string, any>) => void): void {
-		// eslint-disable-next-line unicorn/no-array-for-each, unicorn/no-array-callback-reference
+		// eslint-disable-next-line unicorn/no-array-for-each
 		this.kernel.forEach(callbackFn);
 	}
 

package/src/mapKernel.ts

@@ -641,6 +641,7 @@ export class MapKernel {
 			// A pending clear will be last in the list, since it terminates all prior lifetimes.
 			const pendingClear = this.pendingData.pop();
 			assert(
+				// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 				pendingClear !== undefined &&
 					pendingClear.type === "clear" &&
 					pendingClear === typedLocalOpMetadata,
@@ -714,6 +715,7 @@ export class MapKernel {
 					this.sequencedData.clear();
 					const pendingClear = this.pendingData.shift();
 					assert(
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						pendingClear !== undefined &&
 							pendingClear.type === "clear" &&
 							pendingClear === localOpMetadata,
@@ -770,6 +772,7 @@ export class MapKernel {
 					);
 					const pendingEntry = this.pendingData[pendingEntryIndex];
 					assert(
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						pendingEntry !== undefined &&
 							pendingEntry.type === "delete" &&
 							pendingEntry === localOpMetadata,
@@ -810,6 +813,7 @@ export class MapKernel {
 					);
 					const pendingEntry = this.pendingData[pendingEntryIndex];
 					assert(
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						pendingEntry !== undefined && pendingEntry.type === "lifetime",
 						0xbf8 /* Couldn't match local set message to pending lifetime */,
 					);

package/src/packageVersion.ts

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

package/.eslintrc.cjs

@@ -1,28 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
-	parserOptions: {
-		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
-	},
-	rules: {
-		"@typescript-eslint/no-use-before-define": "off",
-		"@typescript-eslint/strict-boolean-expressions": "off",
-
-		// TODO: consider re-enabling once we have addressed how this rule conflicts with our error codes.
-		"unicorn/numeric-separators-style": "off",
-		"@fluid-internal/fluid/no-unchecked-record-access": "warn",
-	},
-	overrides: [
-		{
-			files: ["src/test/**"],
-			rules: {
-				// Allow tests (which only run in Node.js) use `__dirname`
-				"unicorn/prefer-module": "off",
-			},
-		},
-	],
-};