@fluidframework/odsp-driver-definitions 2.23.0 → 2.31.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.
- package/CHANGELOG.md +130 -119
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +4 -7
- package/prettier.config.cjs +0 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @fluidframework/odsp-driver-definitions
|
|
2
2
|
|
|
3
|
+
## 2.31.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
7
|
+
## 2.30.0
|
|
8
|
+
|
|
9
|
+
Dependency updates only.
|
|
10
|
+
|
|
3
11
|
## 2.23.0
|
|
4
12
|
|
|
5
13
|
Dependency updates only.
|
|
@@ -56,9 +64,9 @@ Dependency updates only.
|
|
|
56
64
|
|
|
57
65
|
### Minor Changes
|
|
58
66
|
|
|
59
|
-
-
|
|
67
|
+
- Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
|
|
60
68
|
|
|
61
|
-
|
|
69
|
+
Update package implementations to use TypeScript 5.4.5.
|
|
62
70
|
|
|
63
71
|
## 2.0.0-rc.4.0.0
|
|
64
72
|
|
|
@@ -68,82 +76,82 @@ Dependency updates only.
|
|
|
68
76
|
|
|
69
77
|
### Major Changes
|
|
70
78
|
|
|
71
|
-
-
|
|
79
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
72
80
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
81
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
82
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
83
|
+
TypeScript types and implementation code.
|
|
76
84
|
|
|
77
|
-
|
|
85
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
78
86
|
|
|
79
|
-
|
|
80
|
-
|
|
87
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
88
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
81
89
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
90
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
91
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
92
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
93
|
+
regarding the module and moduleResolution options.
|
|
86
94
|
|
|
87
|
-
|
|
88
|
-
|
|
95
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
96
|
+
to distinguish stable APIs from those that are in development.**
|
|
89
97
|
|
|
90
98
|
## 2.0.0-rc.2.0.0
|
|
91
99
|
|
|
92
100
|
### Minor Changes
|
|
93
101
|
|
|
94
|
-
-
|
|
102
|
+
- Deprecated error-related enums have been removed ([#19067](https://github.com/microsoft/FluidFramework/issues/19067)) [59793302e5](https://github.com/microsoft/FluidFramework/commits/59793302e56784cfb6ace0e6469345f3565b3312)
|
|
95
103
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
104
|
+
Error-related enums `ContainerErrorType`, `DriverErrorType`, `OdspErrorType` and `RouterliciousErrorType` were previously
|
|
105
|
+
deprecated and are now removed. There are replacement object-based enumerations of `ContainerErrorTypes`,
|
|
106
|
+
`DriverErrorTypes`, `OdspErrorTypes` and `RouterliciousErrorTypes`. Refer to the release notes of [Fluid Framework version
|
|
107
|
+
2.0.0-internal.7.0.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.7.0.0) for details
|
|
108
|
+
on the replacements.
|
|
101
109
|
|
|
102
|
-
-
|
|
110
|
+
- odsp-driver: Removed deprecated implementation of SingleRT feature ([#18690](https://github.com/microsoft/FluidFramework/issues/18690)) [430205cff1](https://github.com/microsoft/FluidFramework/commits/430205cff1ba8a1a7b13b4d42d12babaae596708)
|
|
103
111
|
|
|
104
|
-
|
|
112
|
+
Removed the deprecated logic of creating sharing-links with container attach (called SingleRT) which was enabled via enableShareLinkWithCreate flag in HostStoragePolicy. This change removes SharingLinkTypes interface definition, removes other deprecated properties from the odsp-driver's resolvedUrl object and also removes the enableShareLinkWithCreate flag. The newer version of SingleRT feature continues to exist, which can be enabled via enableSingleRequestForShareLinkWithCreate feature flag in HostStoragePolicy.
|
|
105
113
|
|
|
106
|
-
-
|
|
114
|
+
- container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
|
|
107
115
|
|
|
108
|
-
|
|
116
|
+
Added `containerMetadata` prop on IContainer interface.
|
|
109
117
|
|
|
110
|
-
-
|
|
118
|
+
- runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
|
|
111
119
|
|
|
112
|
-
|
|
120
|
+
The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
|
|
113
121
|
|
|
114
122
|
## 2.0.0-rc.1.0.0
|
|
115
123
|
|
|
116
124
|
### Minor Changes
|
|
117
125
|
|
|
118
|
-
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
126
|
+
- Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
127
|
+
|
|
128
|
+
The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
|
|
129
|
+
|
|
130
|
+
- @fluidframework/gitresources
|
|
131
|
+
- @fluidframework/server-kafka-orderer
|
|
132
|
+
- @fluidframework/server-lambdas
|
|
133
|
+
- @fluidframework/server-lambdas-driver
|
|
134
|
+
- @fluidframework/server-local-server
|
|
135
|
+
- @fluidframework/server-memory-orderer
|
|
136
|
+
- @fluidframework/protocol-base
|
|
137
|
+
- @fluidframework/server-routerlicious
|
|
138
|
+
- @fluidframework/server-routerlicious-base
|
|
139
|
+
- @fluidframework/server-services
|
|
140
|
+
- @fluidframework/server-services-client
|
|
141
|
+
- @fluidframework/server-services-core
|
|
142
|
+
- @fluidframework/server-services-ordering-kafkanode
|
|
143
|
+
- @fluidframework/server-services-ordering-rdkafka
|
|
144
|
+
- @fluidframework/server-services-ordering-zookeeper
|
|
145
|
+
- @fluidframework/server-services-shared
|
|
146
|
+
- @fluidframework/server-services-telemetry
|
|
147
|
+
- @fluidframework/server-services-utils
|
|
148
|
+
- @fluidframework/server-test-utils
|
|
149
|
+
- tinylicious
|
|
150
|
+
|
|
151
|
+
- Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
152
|
+
|
|
153
|
+
The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
|
|
154
|
+
changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
|
|
147
155
|
|
|
148
156
|
## 2.0.0-internal.8.0.0
|
|
149
157
|
|
|
@@ -169,63 +177,66 @@ Dependency updates only.
|
|
|
169
177
|
|
|
170
178
|
### Major Changes
|
|
171
179
|
|
|
172
|
-
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
-
|
|
227
|
-
|
|
228
|
-
|
|
180
|
+
- odsp-driver: Load container in readonly mode when driver throws DriverErrorType.outOfStorage [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
181
|
+
|
|
182
|
+
Handle DriverErrorType.outOfStorage error from driver and load the container in readonly mode. Currently there is no
|
|
183
|
+
handling and when the join session throws this error, the container will get closed. With this we use NoDeltaStream
|
|
184
|
+
object as connection and load the container in read mode, so that it loads properly. We also notify the that the
|
|
185
|
+
container is "readonly" through the event on delta manager so that apps can listen to this and show any UX etc. The app
|
|
186
|
+
can listen to the event like this:
|
|
187
|
+
|
|
188
|
+
```ts
|
|
189
|
+
container.deltaManager.on(
|
|
190
|
+
"readonly",
|
|
191
|
+
(
|
|
192
|
+
readonly?: boolean,
|
|
193
|
+
readonlyConnectionReason?: { text: string; error?: IErrorBase },
|
|
194
|
+
) => {
|
|
195
|
+
// error?.errorType will be equal to DriverErrorType.outOfStorage in this case
|
|
196
|
+
// App logic
|
|
197
|
+
},
|
|
198
|
+
);
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
202
|
+
|
|
203
|
+
This included the following changes from the protocol-definitions release:
|
|
204
|
+
|
|
205
|
+
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
206
|
+
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
207
|
+
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
208
|
+
been added, which will be the typing for signals sent from the client to the server. Both extend a new
|
|
209
|
+
ISignalMessageBase interface that contains common members.
|
|
210
|
+
- The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
|
|
211
|
+
|
|
212
|
+
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
213
|
+
|
|
214
|
+
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
215
|
+
|
|
216
|
+
- @fluidframework/gitresources: 2.0.1
|
|
217
|
+
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
218
|
+
- @fluidframework/server-lambdas: 2.0.1
|
|
219
|
+
- @fluidframework/server-lambdas-driver: 2.0.1
|
|
220
|
+
- @fluidframework/server-local-server: 2.0.1
|
|
221
|
+
- @fluidframework/server-memory-orderer: 2.0.1
|
|
222
|
+
- @fluidframework/protocol-base: 2.0.1
|
|
223
|
+
- @fluidframework/server-routerlicious: 2.0.1
|
|
224
|
+
- @fluidframework/server-routerlicious-base: 2.0.1
|
|
225
|
+
- @fluidframework/server-services: 2.0.1
|
|
226
|
+
- @fluidframework/server-services-client: 2.0.1
|
|
227
|
+
- @fluidframework/server-services-core: 2.0.1
|
|
228
|
+
- @fluidframework/server-services-ordering-kafkanode: 2.0.1
|
|
229
|
+
- @fluidframework/server-services-ordering-rdkafka: 2.0.1
|
|
230
|
+
- @fluidframework/server-services-ordering-zookeeper: 2.0.1
|
|
231
|
+
- @fluidframework/server-services-shared: 2.0.1
|
|
232
|
+
- @fluidframework/server-services-telemetry: 2.0.1
|
|
233
|
+
- @fluidframework/server-services-utils: 2.0.1
|
|
234
|
+
- @fluidframework/server-test-utils: 2.0.1
|
|
235
|
+
- tinylicious: 2.0.1
|
|
236
|
+
|
|
237
|
+
- Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
238
|
+
|
|
239
|
+
The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
|
|
229
240
|
|
|
230
241
|
## 2.0.0-internal.6.4.0
|
|
231
242
|
|
|
@@ -247,9 +258,9 @@ Dependency updates only.
|
|
|
247
258
|
|
|
248
259
|
### Major Changes
|
|
249
260
|
|
|
250
|
-
-
|
|
261
|
+
- Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
251
262
|
|
|
252
|
-
|
|
263
|
+
Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
|
|
253
264
|
|
|
254
265
|
## 2.0.0-internal.5.4.0
|
|
255
266
|
|
|
@@ -259,11 +270,11 @@ Dependency updates only.
|
|
|
259
270
|
|
|
260
271
|
### Minor Changes
|
|
261
272
|
|
|
262
|
-
-
|
|
273
|
+
- New interfaces to discover getRelaySessionInfo API ([#16300](https://github.com/microsoft/FluidFramework/issues/16300)) [a25789cd37](https://github.com/microsoft/FluidFramework/commits/a25789cd37bf60ebc4a08e1a9f7eaa8c65f4eae2)
|
|
263
274
|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
275
|
+
There are new interfaces `IRelaySessionAwareDriverFactory` and `IProvideSessionAwareDriverFactory` in
|
|
276
|
+
odsp-driver-definitions that enable using the provider pattern to discover the new API `getRelaySessionInfo` in
|
|
277
|
+
odsp-driver.
|
|
267
278
|
|
|
268
279
|
## 2.0.0-internal.5.2.0
|
|
269
280
|
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/odsp-driver-definitions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.31.0",
|
|
4
4
|
"description": "Socket storage implementation for SPO and ODC",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"main": "lib/index.js",
|
|
48
48
|
"types": "lib/public.d.ts",
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@fluidframework/driver-definitions": "~2.
|
|
50
|
+
"@fluidframework/driver-definitions": "~2.31.0"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
53
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
@@ -56,13 +56,12 @@
|
|
|
56
56
|
"@fluidframework/build-common": "^2.0.3",
|
|
57
57
|
"@fluidframework/build-tools": "^0.54.0",
|
|
58
58
|
"@fluidframework/eslint-config-fluid": "^5.7.3",
|
|
59
|
-
"@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.
|
|
60
|
-
"@microsoft/api-extractor": "7.
|
|
59
|
+
"@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.30.0",
|
|
60
|
+
"@microsoft/api-extractor": "7.50.1",
|
|
61
61
|
"concurrently": "^8.2.1",
|
|
62
62
|
"copyfiles": "^2.4.1",
|
|
63
63
|
"cross-env": "^7.0.3",
|
|
64
64
|
"eslint": "~8.55.0",
|
|
65
|
-
"prettier": "~3.0.3",
|
|
66
65
|
"rimraf": "^4.4.0",
|
|
67
66
|
"typescript": "~5.4.5"
|
|
68
67
|
},
|
|
@@ -94,7 +93,6 @@
|
|
|
94
93
|
"check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
|
|
95
94
|
"check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
|
|
96
95
|
"check:format": "npm run check:biome",
|
|
97
|
-
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
98
96
|
"ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
|
|
99
97
|
"ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
|
|
100
98
|
"ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
|
|
@@ -104,7 +102,6 @@
|
|
|
104
102
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
105
103
|
"format": "npm run format:biome",
|
|
106
104
|
"format:biome": "biome check . --write",
|
|
107
|
-
"format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
108
105
|
"lint": "fluid-build . --task lint",
|
|
109
106
|
"lint:fix": "fluid-build . --task eslint:fix --task format",
|
|
110
107
|
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
|