@fluidframework/map 2.117.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/map",
-  "version": "2.117.0",
+  "version": "3.0.0",
   "description": "Distributed map",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,50 +14,30 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./lib/public.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/public.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/public.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/public.d.ts"
       }
     },
     "./legacy": {
-      "import": {
-        "types": "./lib/legacy.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/legacy.d.ts",
-        "default": "./dist/index.js"
+      "types": "./lib/legacy.d.ts",
+      "default": "./lib/index.js",
+      "internal-entrypoint-generation": {
+        "types": "./dist/legacy.d.ts"
       }
     },
     "./internal": {
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.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"
-        }
+        "types": "./lib/test/index.d.ts",
+        "default": "./lib/test/index.js"
       }
     }
   },
-  "main": "lib/index.js",
-  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -81,32 +61,32 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.117.0",
-    "@fluidframework/core-interfaces": "~2.117.0",
-    "@fluidframework/core-utils": "~2.117.0",
-    "@fluidframework/datastore-definitions": "~2.117.0",
-    "@fluidframework/driver-definitions": "~2.117.0",
-    "@fluidframework/driver-utils": "~2.117.0",
-    "@fluidframework/runtime-definitions": "~2.117.0",
-    "@fluidframework/runtime-utils": "~2.117.0",
-    "@fluidframework/shared-object-base": "~2.117.0",
-    "@fluidframework/telemetry-utils": "~2.117.0",
+    "@fluid-internal/client-utils": "~3.0.0",
+    "@fluidframework/core-interfaces": "~3.0.0",
+    "@fluidframework/core-utils": "~3.0.0",
+    "@fluidframework/datastore-definitions": "~3.0.0",
+    "@fluidframework/driver-definitions": "~3.0.0",
+    "@fluidframework/driver-utils": "~3.0.0",
+    "@fluidframework/runtime-definitions": "~3.0.0",
+    "@fluidframework/runtime-utils": "~3.0.0",
+    "@fluidframework/shared-object-base": "~3.0.0",
+    "@fluidframework/telemetry-utils": "~3.0.0",
     "path-browserify": "^1.0.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-internal/mocha-test-setup": "~2.117.0",
-    "@fluid-private/stochastic-test-utils": "~2.117.0",
-    "@fluid-private/test-dds-utils": "~2.117.0",
+    "@fluid-internal/mocha-test-setup": "~3.0.0",
+    "@fluid-private/stochastic-test-utils": "~3.0.0",
+    "@fluid-private/test-dds-utils": "~3.0.0",
     "@fluid-tools/benchmark": "^0.59.0",
     "@fluid-tools/build-cli": "^0.67.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.67.0",
-    "@fluidframework/container-definitions": "~2.117.0",
+    "@fluidframework/container-definitions": "~3.0.0",
     "@fluidframework/eslint-config-fluid": "^14.0.0",
     "@fluidframework/map-previous": "npm:@fluidframework/map@2.116.0",
-    "@fluidframework/test-runtime-utils": "~2.117.0",
+    "@fluidframework/test-runtime-utils": "~3.0.0",
     "@microsoft/api-extractor": "7.58.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "~22.19.17",
@@ -120,30 +100,35 @@
     "mocha": "^11.7.5",
     "mocha-multi-reporters": "^1.5.1",
     "rimraf": "^6.1.3",
-    "typescript": "~5.4.5"
+    "typescript": "~6.0.3"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Interface_IDirectoryBeta": {
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {
     "bench": "cross-env FLUID_TEST_PERF_MODE=1 mocha --parentProcess",
     "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:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor-report.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor-report.legacy.json",
+    "build:cjs": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "api-extractor run --local --config api-extractor/api-extractor-model.json",
     "build:entrypoints": "fluid-build . --task build:entrypoints",
     "build:entrypoints:cjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist",
-    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
-    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib",
+    "build:esm": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "build:test": "concurrently npm:build:test:esm npm: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",
+    "check:are-the-types-wrong": "attw --pack . --profile esm-only --exclude-entrypoints ./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",
@@ -153,9 +138,9 @@
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "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",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor-report.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor-report.legacy.json",
+    "ci:build:docs": "api-extractor run --config api-extractor/api-extractor-model.json",
     "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --quiet --format stylish src",
     "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -172,7 +157,6 @@
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "test:snapshots:regen": "npm run test:mocha:esm -- --snapshot",
     "test:stress": "cross-env FUZZ_TEST_COUNT=100 FUZZ_STRESS_RUN=normal mocha --ignore \"lib/test/memory/**/*\" --recursive \"lib/test/**/*.spec.js\"",
-    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "flub generate typetests --dir . -v"
   }
 }

package/src/index.ts

@@ -18,7 +18,6 @@
 export type {
 	FluidMapLegacy,
 	IDirectory,
-	IDirectoryBeta,
 	IDirectoryEvents,
 	IDirectoryValueChanged,
 	ISharedDirectory,

package/src/interfaces.ts

@@ -4,12 +4,13 @@
  */
 
 import type {
+	FluidIterableIterator,
+	FluidMap,
 	IDisposable,
 	IEvent,
 	IEventProvider,
 	IEventThisPlaceHolder,
 } from "@fluidframework/core-interfaces";
-import type { FluidMap } from "@fluidframework/core-interfaces/internal";
 import type {
 	ISharedObject,
 	ISharedObjectEvents,
@@ -46,7 +47,7 @@ export interface IValueChanged {
 export interface IDirectory
 	// TODO: Use `unknown` instead (breaking change).
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	extends Map<string, any>,
+	extends FluidMap<string, any>,
 		IEventProvider<IDirectoryEvents>,
 		Partial<IDisposable> {
 	/**
@@ -71,6 +72,18 @@ export interface IDirectory
 	 */
 	set<T = unknown>(key: string, value: T): this;
 
+	/**
+	 * Removes all entries from the directory.
+	 */
+	clear(): void;
+
+	/**
+	 * Removes the specified element from this directory by its key.
+	 * @param key - The key of the element to remove
+	 * @returns `true` if an element existed and has been removed, or `false` if the element does not exist
+	 */
+	delete(key: string): boolean;
+
 	/**
 	 * Get the number of sub directory within the directory.
 	 * @returns The number of sub directory within a directory.
@@ -110,7 +123,7 @@ export interface IDirectory
 	 * Gets an iterator over the IDirectory children of this IDirectory.
 	 * @returns The IDirectory iterator
 	 */
-	subdirectories(): IterableIterator<[string, IDirectory]>;
+	subdirectories(): FluidIterableIterator<[string, IDirectory]>;
 
 	/**
 	 * Get an IDirectory within the directory, in order to use relative paths from that location.
@@ -160,17 +173,6 @@ export interface FluidMapLegacy<K, V> extends Omit<FluidMap<K, V>, "get" | "set"
 	delete(key: K): boolean;
 }
 
-/**
- * Beta version of {@link IDirectory} which uses {@link FluidMapLegacy} for its map-like API.
- *
- * @sealed
- * @legacy @beta
- */
-export interface IDirectoryBeta
-	extends Omit<IDirectory, Exclude<keyof Map<string, unknown>, "get" | "set">>,
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		FluidMapLegacy<string, any> {}
-
 /**
  * Events emitted in response to changes to the directory data.
  *
@@ -361,7 +363,7 @@ export interface ISharedDirectory
 	// https://github.com/microsoft/TypeScript/issues/31671
 	// TODO: Use `unknown` instead (breaking change).
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	[Symbol.iterator](): IterableIterator<[string, any]>;
+	[Symbol.iterator](): FluidIterableIterator<[string, any]>;
 	readonly [Symbol.toStringTag]: string;
 }
 
@@ -434,7 +436,7 @@ export interface ISharedMap
 	extends ISharedObject<ISharedMapEvents>,
 		// TODO: Use `unknown` instead (breaking change).
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		Map<string, any> {
+		FluidMap<string, any> {
 	/**
 	 * Retrieves the given key from the map if it exists.
 	 * @param key - Key to retrieve from
@@ -451,6 +453,18 @@ export interface ISharedMap
 	 * @returns The {@link ISharedMap} itself
 	 */
 	set<T = unknown>(key: string, value: T): this;
+
+	/**
+	 * Removes all entries from the map.
+	 */
+	clear(): void;
+
+	/**
+	 * Removes the specified element from this map by its key.
+	 * @param key - The key of the element to remove
+	 * @returns `true` if an element existed and has been removed, or `false` if the element does not exist
+	 */
+	delete(key: string): boolean;
 }
 
 /**
@@ -460,6 +474,6 @@ export interface ISharedMap
  * @legacy @beta
  */
 export interface ISharedMapBeta
-	extends Omit<ISharedMap, Exclude<keyof Map<string, unknown>, "get" | "set">>,
+	extends Omit<ISharedMap, Exclude<keyof FluidMap<string, unknown>, "get" | "set">>,
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		FluidMapLegacy<string, any> {}

package/src/packageVersion.ts

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

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"extends": "../../../common/build/build-common/tsconfig.node20.json",
 	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {

package/internal.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/index.js";

package/legacy.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/legacy.js";