@fluidframework/driver-definitions - npm Package Compare versions

Comparing version 2.43.0-343119 to 2.43.0

CHANGELOG.md

 # @fluidframework/driver-definitions
 
+## 2.43.0
+
+### Minor Changes
+
+- The reason parameter on the disconnect event is now optional to allow for clean, non-error disconnections ([#24840](https://github.com/microsoft/FluidFramework/pull/24840)) [82a1c5a1362](https://github.com/microsoft/FluidFramework/commit/82a1c5a1362d3362886bdcc12859ce60a2744bdb)
+
+  To enable better handling of intentional disconnects (for example [`Container.dispose()`](https://fluidframework.com/docs/api/container-loader/container/dispose)), the `reason` parameter of the `disconnect` event on [`IDocumentDeltaConnectionEvents`](https://fluidframework.com/docs/api/driver-definitions/idocumentdeltaconnectionevents) is being deprecated as a required parameter.
+
+  In a future release, the `reason` parameter will become optional.
+
+  **Old signature:**
+
+  ```typescript
+  listener: (reason: IAnyDriverError) => void
+  ```
+
+  **New signature:**
+
+  ```typescript
+  listener: (reason?: IAnyDriverError) => void
+  ```
+
+  Developers with listeners for the `disconnect` event should update their implementations to handle cases where the `reason` parameter is `undefined`.
+  This indicates a clean disconnect, which should not be treated as an error.
+
+  The breaking change is scheduled to be released in version **2.60**.
+
 ## 2.42.0
@@ -4,0 +31,0 @@

package.json

 {
   "name": "@fluidframework/driver-definitions",
-  "version": "2.43.0-343119",
+  "version": "2.43.0",
   "description": "Fluid driver definitions",
@@ -50,3 +50,3 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/core-interfaces": "2.43.0-343119"
+    "@fluidframework/core-interfaces": "~2.43.0"
   },
@@ -56,5 +56,5 @@ "devDependencies": {
     "@biomejs/biome": "~1.9.3",
-    "@fluid-tools/build-cli": "^0.55.0",
+    "@fluid-tools/build-cli": "^0.56.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.55.0",
+    "@fluidframework/build-tools": "^0.56.0",
     "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.42.0",
@@ -61,0 +61,0 @@ "@fluidframework/eslint-config-fluid": "^5.7.4",

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

547429

0.23%

Number of low quality alerts

0

-100%

Worsened metrics

Published versions last year

58

-1.69%

Dependency changes

• + Added

  @fluidframework/core-interfaces@2.43.0
  (transitive)

• - Removed

  @fluidframework/core-interfaces@2.43.0-343119
  (transitive)

• Updated

  @fluidframework/core-interfaces@~2.43.0