fluid-framework 2.1.0-281041 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # fluid-framework
 
+## 2.1.0
+
+### Minor Changes
+
+-   Detect arrayNode iterator invalidation ([#21760](https://github.com/microsoft/FluidFramework/pull/21760)) [6fd320c385](https://github.com/microsoft/FluidFramework/commit/6fd320c38561e272a1acaf4248f47fc386c650e4)
+
+    When `arrayNode`s are edited concurrently during iteration, an error will be thrown.
+
+-   Some SharedDirectory/SharedMap-related APIs have been sealed ([#21836](https://github.com/microsoft/FluidFramework/pull/21836)) [b1d0427eab](https://github.com/microsoft/FluidFramework/commit/b1d0427eab3fcd55588dd80996967133db66f1b8)
+
+    Note that this is a _documentation only change._ There is no runtime or type-level impact.
+
+    Some top-level APIs within `@fluidframework/map` and `fluid-framework` have been updated to reflect their
+    sealed/readonly nature. That is, they are not to be implemented externally to Fluid Framework and not changed. This was
+    already the case, but the documentation was not clear.
+
+    Updated APIs:
+
+    -   [IDirectory](https://fluidframework.com/docs/api/v2/fluid-framework/idirectory-interface) sealed
+    -   [IDirectoryEvents](https://fluidframework.com/docs/api/v2/fluid-framework/idirectoryevents-interface) sealed
+    -   [IDirectoryValueChanged](https://fluidframework.com/docs/api/v2/fluid-framework/idirectoryvaluechanged-interface) sealed and path property is readonly
+    -   [ISharedDirectory](https://fluidframework.com/docs/api/v2/fluid-framework/ishareddirectory-interface) sealed
+    -   [ISharedDirectoryEvents](https://fluidframework.com/docs/api/v2/fluid-framework/ishareddirectoryevents-interface) sealed
+    -   [IValueChanged](https://fluidframework.com/docs/api/v2/fluid-framework/ivaluechanged-interface) sealed
+
+-   tree: Improved performance for accessing identifiers in shortId API ([#21944](https://github.com/microsoft/FluidFramework/pull/21944)) [6b4cf26d9c](https://github.com/microsoft/FluidFramework/commit/6b4cf26d9cc14c1a36cf07fd7408f1d1227e373a)
+
+    Users should see improved performance when calling the `Tree.shortId` API. Identifier field keys are now cached in the schema for faster access.
+
+-   ✨ New! Debug visualizers for TreeNodes in NodeJS and browsers ([#21895](https://github.com/microsoft/FluidFramework/pull/21895)) [0d197fefec](https://github.com/microsoft/FluidFramework/commit/0d197fefec852df2911151217ac1b71cde528a70)
+
+    TreeNodes now have custom debug visualizers to improve the debug experience in NodeJS and in browsers. Note that custom formatters must be enabled in the browser developer tools for that visualizer to be used.
+
+-   Using "delete" on tree fields now throws an error instead of not working correctly ([#21609](https://github.com/microsoft/FluidFramework/pull/21609)) [416849b1fd](https://github.com/microsoft/FluidFramework/commit/416849b1fda029870ee1c1742100de4f8dde45b7)
+
+    TypeScript allows `delete` on object node optional fields if the `exactOptionalPropertyTypes` tsconfig setting is not
+    enabled. This does not work correctly at runtime and now produces an informative error.
+
+-   Improved error reporting ([#21940](https://github.com/microsoft/FluidFramework/pull/21940)) [3b8a366dd1](https://github.com/microsoft/FluidFramework/commit/3b8a366dd15660f9c916832040faf772534c0755)
+
+    Several cases of invalid usage patterns for tree APIs have gained improved error reporting, as well as improved documentation on the APIs detailing what usage is supported.
+    These improvements include:
+
+    -   Unsupported usages of schema classes: using more than one schema class derived from a single SchemaFactory generated base class. This used to hit internal asserts, but now has a descriptive user-facing UsageError. Most of this work was done in [9fb3dcf](https://github.com/microsoft/FluidFramework/commit/9fb3dcf491a7f0d66f4abbdc64ab97ccabef4707).
+    -   Improved detection of when prior exception may have left SharedTree in an invalid state.
+        These cases now report a UsageError including a reference to the prior exception. This was mainly done in [9fb3dcf](https://github.com/microsoft/FluidFramework/commit/9fb3dcf491a7f0d66f4abbdc64ab97ccabef4707) and [b77d530](https://github.com/microsoft/FluidFramework/commit/b77d530b9252201c40a90d1a2a6315f76f1a4a4b).
+
 ## 2.0.0-rc.5.0.0
 
 ### Minor Changes

package/README.md

@@ -39,6 +39,10 @@ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `fluid-f
 
 To access the `legacy` APIs, import via `fluid-framework/legacy`.
 
+## API Documentation
+
+API documentation for **fluid-framework** is available at <https://fluidframework.com/docs/apis/fluid-framework>.
+
 <!-- prettier-ignore-end -->
 
 <!-- AUTO-GENERATED-CONTENT:END -->
@@ -70,10 +74,6 @@ Check out the [Hello World tutorial](https://fluidframework.com/docs/start/tutor
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
-## API Documentation
-
-API documentation for **fluid-framework** is available at <https://fluidframework.com/docs/apis/fluid-framework>.
-
 ## Minimum Client Requirements
 
 These are the platform requirements for the current version of Fluid Framework Client Packages.

package/api-report/fluid-framework.beta.api.md

@@ -796,7 +796,7 @@ export interface TreeNodeApi {
     parent(node: TreeNode): TreeNode | undefined;
     schema<T extends TreeNode | TreeLeafValue>(node: T): TreeNodeSchema<string, NodeKind, unknown, T>;
     shortId(node: TreeNode): number | string | undefined;
-    readonly status: (node: TreeNode) => TreeStatus;
+    status(node: TreeNode): TreeStatus;
 }
 
 // @public

package/api-report/fluid-framework.legacy.alpha.api.md

@@ -1206,7 +1206,7 @@ export interface TreeNodeApi {
     parent(node: TreeNode): TreeNode | undefined;
     schema<T extends TreeNode | TreeLeafValue>(node: T): TreeNodeSchema<string, NodeKind, unknown, T>;
     shortId(node: TreeNode): number | string | undefined;
-    readonly status: (node: TreeNode) => TreeStatus;
+    status(node: TreeNode): TreeStatus;
 }
 
 // @public

package/api-report/fluid-framework.legacy.public.api.md

@@ -830,7 +830,7 @@ export interface TreeNodeApi {
     parent(node: TreeNode): TreeNode | undefined;
     schema<T extends TreeNode | TreeLeafValue>(node: T): TreeNodeSchema<string, NodeKind, unknown, T>;
     shortId(node: TreeNode): number | string | undefined;
-    readonly status: (node: TreeNode) => TreeStatus;
+    status(node: TreeNode): TreeStatus;
 }
 
 // @public

package/api-report/fluid-framework.public.api.md

@@ -796,7 +796,7 @@ export interface TreeNodeApi {
     parent(node: TreeNode): TreeNode | undefined;
     schema<T extends TreeNode | TreeLeafValue>(node: T): TreeNodeSchema<string, NodeKind, unknown, T>;
     shortId(node: TreeNode): number | string | undefined;
-    readonly status: (node: TreeNode) => TreeStatus;
+    status(node: TreeNode): TreeStatus;
 }
 
 // @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.1.0-281041",
+  "version": "2.1.0",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,22 +37,22 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.1.0-281041",
-    "@fluidframework/container-loader": "2.1.0-281041",
-    "@fluidframework/core-interfaces": "2.1.0-281041",
-    "@fluidframework/driver-definitions": "2.1.0-281041",
-    "@fluidframework/fluid-static": "2.1.0-281041",
-    "@fluidframework/map": "2.1.0-281041",
-    "@fluidframework/sequence": "2.1.0-281041",
-    "@fluidframework/shared-object-base": "2.1.0-281041",
-    "@fluidframework/tree": "2.1.0-281041"
+    "@fluidframework/container-definitions": "~2.1.0",
+    "@fluidframework/container-loader": "~2.1.0",
+    "@fluidframework/core-interfaces": "~2.1.0",
+    "@fluidframework/driver-definitions": "~2.1.0",
+    "@fluidframework/fluid-static": "~2.1.0",
+    "@fluidframework/map": "~2.1.0",
+    "@fluidframework/sequence": "~2.1.0",
+    "@fluidframework/shared-object-base": "~2.1.0",
+    "@fluidframework/tree": "~2.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "~1.8.3",
-    "@fluid-tools/build-cli": "^0.40.0",
+    "@fluid-tools/build-cli": "^0.41.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.40.0",
+    "@fluidframework/build-tools": "^0.41.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/node": "^18.19.0",