@fluidframework/driver-definitions 2.43.0-343119 → 2.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,32 @@
1
1
  # @fluidframework/driver-definitions
2
2
 
3
+ ## 2.43.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 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)
8
+
9
+ 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.
10
+
11
+ In a future release, the `reason` parameter will become optional.
12
+
13
+ **Old signature:**
14
+
15
+ ```typescript
16
+ listener: (reason: IAnyDriverError) => void
17
+ ```
18
+
19
+ **New signature:**
20
+
21
+ ```typescript
22
+ listener: (reason?: IAnyDriverError) => void
23
+ ```
24
+
25
+ Developers with listeners for the `disconnect` event should update their implementations to handle cases where the `reason` parameter is `undefined`.
26
+ This indicates a clean disconnect, which should not be treated as an error.
27
+
28
+ The breaking change is scheduled to be released in version **2.60**.
29
+
3
30
  ## 2.42.0
4
31
 
5
32
  Dependency updates only.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/driver-definitions",
3
- "version": "2.43.0-343119",
3
+ "version": "2.43.0",
4
4
  "description": "Fluid driver definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,14 +47,14 @@
47
47
  "main": "lib/index.js",
48
48
  "types": "lib/public.d.ts",
49
49
  "dependencies": {
50
- "@fluidframework/core-interfaces": "2.43.0-343119"
50
+ "@fluidframework/core-interfaces": "~2.43.0"
51
51
  },
52
52
  "devDependencies": {
53
53
  "@arethetypeswrong/cli": "^0.17.1",
54
54
  "@biomejs/biome": "~1.9.3",
55
- "@fluid-tools/build-cli": "^0.55.0",
55
+ "@fluid-tools/build-cli": "^0.56.0",
56
56
  "@fluidframework/build-common": "^2.0.3",
57
- "@fluidframework/build-tools": "^0.55.0",
57
+ "@fluidframework/build-tools": "^0.56.0",
58
58
  "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.42.0",
59
59
  "@fluidframework/eslint-config-fluid": "^5.7.4",
60
60
  "@microsoft/api-extractor": "7.52.8",