@fluidframework/container-runtime-definitions 2.30.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 +183 -179
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +7 -10
- package/prettier.config.cjs +0 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# @fluidframework/container-runtime-definitions
|
|
2
2
|
|
|
3
|
+
## 2.31.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
3
7
|
## 2.30.0
|
|
4
8
|
|
|
5
9
|
Dependency updates only.
|
|
@@ -20,18 +24,18 @@ Dependency updates only.
|
|
|
20
24
|
|
|
21
25
|
### Minor Changes
|
|
22
26
|
|
|
23
|
-
-
|
|
27
|
+
- The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed ([#22996](https://github.com/microsoft/FluidFramework/pull/22996)) [bd243fb292](https://github.com/microsoft/FluidFramework/commit/bd243fb2927915d87c42486e21ee0c990962a9a7)
|
|
24
28
|
|
|
25
|
-
|
|
26
|
-
|
|
29
|
+
`ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps`
|
|
30
|
+
were [deprecated in version 0.25.0](https://github.com/microsoft/FluidFramework/blob/main/BREAKING.md#icontainerruntimebase_createdatastorewithprops-is-removed) and have been removed.
|
|
27
31
|
|
|
28
|
-
|
|
29
|
-
|
|
32
|
+
Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState`
|
|
33
|
+
parameter.
|
|
30
34
|
|
|
31
|
-
|
|
35
|
+
These changes were originally announced in version 0.25.0. See the following issues for more details:
|
|
32
36
|
|
|
33
|
-
|
|
34
|
-
|
|
37
|
+
- [#1537](https://github.com/microsoft/FluidFramework/issues/1537)
|
|
38
|
+
- [#2931](https://github.com/microsoft/FluidFramework/pull/2931)
|
|
35
39
|
|
|
36
40
|
## 2.13.0
|
|
37
41
|
|
|
@@ -49,19 +53,19 @@ Dependency updates only.
|
|
|
49
53
|
|
|
50
54
|
### Minor Changes
|
|
51
55
|
|
|
52
|
-
-
|
|
56
|
+
- The inbound and outbound properties have been removed from IDeltaManager ([#22282](https://github.com/microsoft/FluidFramework/pull/22282)) [45a57693f2](https://github.com/microsoft/FluidFramework/commit/45a57693f291e0dc5e91af7f29a9b9c8f82dfad5)
|
|
53
57
|
|
|
54
|
-
|
|
58
|
+
The inbound and outbound properties were [deprecated in version 2.0.0-rc.2.0.0](https://github.com/microsoft/FluidFramework/blob/main/RELEASE_NOTES/2.0.0-rc.2.0.0.md#container-definitions-deprecate-ideltamanagerinbound-and-ideltamanageroutbound) and have been removed from `IDeltaManager`.
|
|
55
59
|
|
|
56
|
-
|
|
60
|
+
`IDeltaManager.inbound` contained functionality that could break core runtime features such as summarization and processing batches if used improperly. Data loss or corruption could occur when `IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` were called.
|
|
57
61
|
|
|
58
|
-
|
|
62
|
+
Similarly, `IDeltaManager.outbound` contained functionality that could break core runtime features such as generation of batches and chunking. Data loss or corruption could occur when `IDeltaManger.inbound.pause()` or `IDeltaManager.inbound.resume()` were called.
|
|
59
63
|
|
|
60
|
-
|
|
64
|
+
#### Alternatives
|
|
61
65
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
66
|
+
- Alternatives to `IDeltaManager.inbound.on("op", ...)` are `IDeltaManager.on("op", ...)`
|
|
67
|
+
- Alternatives to calling `IDeltaManager.inbound.pause`, `IDeltaManager.outbound.pause` for `IContainer` disconnect use `IContainer.disconnect`.
|
|
68
|
+
- Alternatives to calling `IDeltaManager.inbound.resume`, `IDeltaManager.outbound.resume` for `IContainer` reconnect use `IContainer.connect`.
|
|
65
69
|
|
|
66
70
|
## 2.5.0
|
|
67
71
|
|
|
@@ -87,144 +91,144 @@ Dependency updates only.
|
|
|
87
91
|
|
|
88
92
|
### Minor Changes
|
|
89
93
|
|
|
90
|
-
-
|
|
94
|
+
- Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
|
|
91
95
|
|
|
92
|
-
|
|
96
|
+
Update package implementations to use TypeScript 5.4.5.
|
|
93
97
|
|
|
94
98
|
## 2.0.0-rc.4.0.0
|
|
95
99
|
|
|
96
100
|
### Minor Changes
|
|
97
101
|
|
|
98
|
-
-
|
|
102
|
+
- Type Erase IFluidDataStoreRuntime.deltaManager [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
|
|
99
103
|
|
|
100
|
-
|
|
101
|
-
|
|
104
|
+
Make IFluidDataStoreRuntime.deltaManager have an opaque type.
|
|
105
|
+
Marks the following types which were reachable from it as alpha:
|
|
102
106
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
107
|
+
- IConnectionDetails
|
|
108
|
+
- IDeltaSender
|
|
109
|
+
- IDeltaManagerEvents
|
|
110
|
+
- IDeltaManager
|
|
111
|
+
- IDeltaQueueEvents
|
|
112
|
+
- IDeltaQueue
|
|
113
|
+
- ReadOnlyInfo
|
|
110
114
|
|
|
111
|
-
|
|
115
|
+
As a temporary workaround, users needing access to the full delta manager API can use the `@alpha` `toDeltaManagerInternal` API to retrieve its members, but should migrate away from requiring access to those APIs.
|
|
112
116
|
|
|
113
|
-
|
|
117
|
+
Implementing a custom `IFluidDataStoreRuntime` is not supported: this is now indicated by it being marked with `@sealed`.
|
|
114
118
|
|
|
115
119
|
## 2.0.0-rc.3.0.0
|
|
116
120
|
|
|
117
121
|
### Major Changes
|
|
118
122
|
|
|
119
|
-
-
|
|
123
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
120
124
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
125
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
126
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
127
|
+
TypeScript types and implementation code.
|
|
124
128
|
|
|
125
|
-
|
|
129
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
126
130
|
|
|
127
|
-
|
|
128
|
-
|
|
131
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
132
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
129
133
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
135
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
136
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
137
|
+
regarding the module and moduleResolution options.
|
|
134
138
|
|
|
135
|
-
|
|
136
|
-
|
|
139
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
140
|
+
to distinguish stable APIs from those that are in development.**
|
|
137
141
|
|
|
138
142
|
## 2.0.0-rc.2.0.0
|
|
139
143
|
|
|
140
144
|
### Minor Changes
|
|
141
145
|
|
|
142
|
-
-
|
|
146
|
+
- container-runtime: New feature: ID compression for DataStores & DDSs ([#19859](https://github.com/microsoft/FluidFramework/issues/19859)) [51f0d3db73](https://github.com/microsoft/FluidFramework/commits/51f0d3db737800e1c30ea5e3952d38ff30ffc7da)
|
|
143
147
|
|
|
144
|
-
|
|
148
|
+
### Key changes
|
|
145
149
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
150
|
+
1. A new API IContainerRuntimeBase.generateDocumentUniqueId() is exposed. This API will opportunistically generate IDs in short format (non-negative numbers). If it can't achieve that, it will return UUID strings. UUIDs generated will have low entropy in groups and will compress well. It can be leveraged anywhere in container where container unique IDs are required. I.e. any place that uses uuid() and stores data in container is likely candidate to start leveraging this API.
|
|
151
|
+
2. Data store internal IDs (IDs that are auto generated by FF system) will opportunistically be generated in shorter form. Data stores created in detached container will always have short IDs, data stores created in attached container will opportunistically be short (by using newly added IContainerRuntimeBase.generateDocumentUniqueId() capability)
|
|
152
|
+
3. Similar DDS names will be opportunistically short (same considerations for detached DDS vs. attached DDS)
|
|
149
153
|
|
|
150
|
-
|
|
154
|
+
### Implementation details
|
|
151
155
|
|
|
152
|
-
|
|
156
|
+
1. Container level ID Compressor can now be enabled with delay. With such setting, only new IContainerRuntimeBase.generateDocumentUniqueId() is exposed (ID Compressor is not exposed in such case, as leveraging any of its other capabilities requires future container sessions to load ID Compressor on container load, for correctness reasons). Once Container establishes connection and any changes are made in container, newly added API will start generating more compact IDs (in most cases).
|
|
153
157
|
|
|
154
|
-
|
|
158
|
+
### Breaking changes
|
|
155
159
|
|
|
156
|
-
|
|
160
|
+
1. DDS names can no longer start with "\_" symbol - this is reserved for FF needs. I've validated that's not an issue for AzureClient (it only creates root object by name, everything else is referred by handle). Our main internal partners almost never use named DDSs (I can find only 4 instances in Loop).
|
|
157
161
|
|
|
158
|
-
|
|
162
|
+
### Backward compatibility considerations
|
|
159
163
|
|
|
160
|
-
|
|
161
|
-
|
|
164
|
+
1. Data store internal IDs could collide with earlier used names data stores. Earlier versions of FF framework (before DataStore aliasing feature was added) allowed customers to supply IDs for data stores. And thus, files created with earlier versions of framework could have data store IDs that will be similar to names FF will use for newly created data stores ("A", ... "Z", "a"..."z", "AA", etc.). While such collision is possible, it's very unlikely (almost impossible) if user-provided names were at least 4-5 characters long.
|
|
165
|
+
2. If application runs to these problems, or wants to reduce risks, consider disabling ID compressor via IContainerRuntimeOptions.enableRuntimeIdCompressor = "off".
|
|
162
166
|
|
|
163
|
-
|
|
167
|
+
### Minor changes
|
|
164
168
|
|
|
165
|
-
|
|
166
|
-
|
|
169
|
+
1. IContainerRuntime.createDetachedRootDataStore() is removed. Please use IContainerRuntime.createDetachedDataStore and IDataStore.trySetAlias() instead
|
|
170
|
+
2. IContainerRuntimeOptions.enableRuntimeIdCompressor has been changes from boolean to tri-state.
|
|
167
171
|
|
|
168
|
-
-
|
|
172
|
+
- driver-definitions: repositoryUrl removed from IDocumentStorageService ([#19522](https://github.com/microsoft/FluidFramework/issues/19522)) [90eb3c9d33](https://github.com/microsoft/FluidFramework/commits/90eb3c9d33d80e24caa1393a50f414c5602f6aa3)
|
|
169
173
|
|
|
170
|
-
|
|
174
|
+
The `repositoryUrl` member of `IDocumentStorageService` was unused and always equal to the empty string. It has been removed.
|
|
171
175
|
|
|
172
|
-
-
|
|
176
|
+
- container-definitions: ILoaderOptions no longer accepts arbitrary key/value pairs ([#19306](https://github.com/microsoft/FluidFramework/issues/19306)) [741926e225](https://github.com/microsoft/FluidFramework/commits/741926e2253a161504ecc6a6451d8f15d7ac4ed6)
|
|
173
177
|
|
|
174
|
-
|
|
178
|
+
ILoaderOptions has been narrowed to the specific set of supported loader options, and may no longer be used to pass arbitrary key/value pairs through to the runtime.
|
|
175
179
|
|
|
176
180
|
## 2.0.0-rc.1.0.0
|
|
177
181
|
|
|
178
182
|
### Minor Changes
|
|
179
183
|
|
|
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
|
-
|
|
184
|
+
- Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
185
|
+
|
|
186
|
+
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)
|
|
187
|
+
|
|
188
|
+
- @fluidframework/gitresources
|
|
189
|
+
- @fluidframework/server-kafka-orderer
|
|
190
|
+
- @fluidframework/server-lambdas
|
|
191
|
+
- @fluidframework/server-lambdas-driver
|
|
192
|
+
- @fluidframework/server-local-server
|
|
193
|
+
- @fluidframework/server-memory-orderer
|
|
194
|
+
- @fluidframework/protocol-base
|
|
195
|
+
- @fluidframework/server-routerlicious
|
|
196
|
+
- @fluidframework/server-routerlicious-base
|
|
197
|
+
- @fluidframework/server-services
|
|
198
|
+
- @fluidframework/server-services-client
|
|
199
|
+
- @fluidframework/server-services-core
|
|
200
|
+
- @fluidframework/server-services-ordering-kafkanode
|
|
201
|
+
- @fluidframework/server-services-ordering-rdkafka
|
|
202
|
+
- @fluidframework/server-services-ordering-zookeeper
|
|
203
|
+
- @fluidframework/server-services-shared
|
|
204
|
+
- @fluidframework/server-services-telemetry
|
|
205
|
+
- @fluidframework/server-services-utils
|
|
206
|
+
- @fluidframework/server-test-utils
|
|
207
|
+
- tinylicious
|
|
208
|
+
|
|
209
|
+
- Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
210
|
+
|
|
211
|
+
The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
|
|
212
|
+
changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
|
|
209
213
|
|
|
210
214
|
## 2.0.0-internal.8.0.0
|
|
211
215
|
|
|
212
216
|
### Major Changes
|
|
213
217
|
|
|
214
|
-
-
|
|
218
|
+
- container-runtime-definitions: Removed resolveHandle and IFluidHandleContext from ContainerRuntime interfaces [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
215
219
|
|
|
216
|
-
|
|
217
|
-
|
|
220
|
+
The `IContainerRuntime.resolveHandle(...)` method and the `IContainerRuntimeBase.IFluidHandleContext` property have been
|
|
221
|
+
removed. Please remove all usage of these APIs.
|
|
218
222
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
223
|
+
See
|
|
224
|
+
[Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
225
|
+
for more details.
|
|
222
226
|
|
|
223
|
-
-
|
|
227
|
+
- container-runtime-definitions: Removed getRootDataStore [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
224
228
|
|
|
225
|
-
|
|
229
|
+
The `getRootDataStore` method has been removed from `IContainerRuntime` and `ContainerRuntime`. Please migrate all usage to the new `getAliasedDataStoreEntryPoint` method. This method returns the data store's entry point which is its `IFluidHandle`.
|
|
226
230
|
|
|
227
|
-
|
|
231
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
228
232
|
|
|
229
233
|
## 2.0.0-internal.7.4.0
|
|
230
234
|
|
|
@@ -246,64 +250,64 @@ Dependency updates only.
|
|
|
246
250
|
|
|
247
251
|
### Major Changes
|
|
248
252
|
|
|
249
|
-
-
|
|
253
|
+
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
250
254
|
|
|
251
|
-
|
|
255
|
+
This included the following changes from the protocol-definitions release:
|
|
252
256
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
257
|
+
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
258
|
+
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
259
|
+
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
260
|
+
been added, which will be the typing for signals sent from the client to the server. Both extend a new
|
|
261
|
+
ISignalMessageBase interface that contains common members.
|
|
262
|
+
- The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
|
|
259
263
|
|
|
260
|
-
-
|
|
264
|
+
- container-runtime-definitions: `IDataStoreWithBindToContext_Deprecated` interface removed [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
261
265
|
|
|
262
|
-
|
|
266
|
+
`IDataStoreWithBindToContext_Deprecated` has been removed. It has been deprecated for a while and cannot be used anymore.
|
|
263
267
|
|
|
264
|
-
-
|
|
268
|
+
- DEPRECATED: resolveHandle and IFluidHandleContext deprecated on IContainerRuntime [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
265
269
|
|
|
266
|
-
|
|
270
|
+
The `resolveHandle(...)` and `get IFluidHandleContext()` methods have been deprecated on the following interfaces:
|
|
267
271
|
|
|
268
|
-
|
|
269
|
-
|
|
272
|
+
- `IContainerRuntime`
|
|
273
|
+
- `IContainerRuntimeBase`
|
|
270
274
|
|
|
271
|
-
|
|
275
|
+
Requesting arbitrary URLs has been deprecated on `IContainerRuntime`. Please migrate all usage to the `IContainerRuntime.getEntryPoint()` method if trying to obtain the application-specified root object.
|
|
272
276
|
|
|
273
|
-
|
|
277
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
274
278
|
|
|
275
|
-
-
|
|
279
|
+
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
276
280
|
|
|
277
|
-
|
|
281
|
+
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
278
282
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
283
|
+
- @fluidframework/gitresources: 2.0.1
|
|
284
|
+
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
285
|
+
- @fluidframework/server-lambdas: 2.0.1
|
|
286
|
+
- @fluidframework/server-lambdas-driver: 2.0.1
|
|
287
|
+
- @fluidframework/server-local-server: 2.0.1
|
|
288
|
+
- @fluidframework/server-memory-orderer: 2.0.1
|
|
289
|
+
- @fluidframework/protocol-base: 2.0.1
|
|
290
|
+
- @fluidframework/server-routerlicious: 2.0.1
|
|
291
|
+
- @fluidframework/server-routerlicious-base: 2.0.1
|
|
292
|
+
- @fluidframework/server-services: 2.0.1
|
|
293
|
+
- @fluidframework/server-services-client: 2.0.1
|
|
294
|
+
- @fluidframework/server-services-core: 2.0.1
|
|
295
|
+
- @fluidframework/server-services-ordering-kafkanode: 2.0.1
|
|
296
|
+
- @fluidframework/server-services-ordering-rdkafka: 2.0.1
|
|
297
|
+
- @fluidframework/server-services-ordering-zookeeper: 2.0.1
|
|
298
|
+
- @fluidframework/server-services-shared: 2.0.1
|
|
299
|
+
- @fluidframework/server-services-telemetry: 2.0.1
|
|
300
|
+
- @fluidframework/server-services-utils: 2.0.1
|
|
301
|
+
- @fluidframework/server-test-utils: 2.0.1
|
|
302
|
+
- tinylicious: 2.0.1
|
|
299
303
|
|
|
300
|
-
-
|
|
304
|
+
- Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
301
305
|
|
|
302
|
-
|
|
306
|
+
The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
|
|
303
307
|
|
|
304
|
-
-
|
|
308
|
+
- container-runtime-definitions: `getAliasedDataStoreEntryPoint` in `IContainerRuntime` is now required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
305
309
|
|
|
306
|
-
|
|
310
|
+
`getAliasedDataStoreEntryPoint` was added to `IContainerRuntime` in 2.0.0-internal.6.0 and is now required.
|
|
307
311
|
|
|
308
312
|
## 2.0.0-internal.6.4.0
|
|
309
313
|
|
|
@@ -317,32 +321,32 @@ Dependency updates only.
|
|
|
317
321
|
|
|
318
322
|
### Minor Changes
|
|
319
323
|
|
|
320
|
-
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
324
|
+
- Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
|
|
325
|
+
|
|
326
|
+
The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
|
|
327
|
+
imported from the **@fluidframework/core-interfaces** package:
|
|
328
|
+
|
|
329
|
+
- interface IDisposable
|
|
330
|
+
- interface IErrorEvent
|
|
331
|
+
- interface IErrorEvent
|
|
332
|
+
- interface IEvent
|
|
333
|
+
- interface IEventProvider
|
|
334
|
+
- interface ILoggingError
|
|
335
|
+
- interface ITaggedTelemetryPropertyType
|
|
336
|
+
- interface ITelemetryBaseEvent
|
|
337
|
+
- interface ITelemetryBaseLogger
|
|
338
|
+
- interface ITelemetryErrorEvent
|
|
339
|
+
- interface ITelemetryGenericEvent
|
|
340
|
+
- interface ITelemetryLogger
|
|
341
|
+
- interface ITelemetryPerformanceEvent
|
|
342
|
+
- interface ITelemetryProperties
|
|
343
|
+
- type ExtendEventProvider
|
|
344
|
+
- type IEventThisPlaceHolder
|
|
345
|
+
- type IEventTransformer
|
|
346
|
+
- type ReplaceIEventThisPlaceHolder
|
|
347
|
+
- type ReplaceIEventThisPlaceHolder
|
|
348
|
+
- type TelemetryEventCategory
|
|
349
|
+
- type TelemetryEventPropertyType
|
|
346
350
|
|
|
347
351
|
## 2.0.0-internal.6.1.0
|
|
348
352
|
|
|
@@ -352,18 +356,18 @@ Dependency updates only.
|
|
|
352
356
|
|
|
353
357
|
### Major Changes
|
|
354
358
|
|
|
355
|
-
-
|
|
359
|
+
- `getRootDataStore` API is deprecated [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
356
360
|
|
|
357
|
-
|
|
358
|
-
|
|
361
|
+
The `getRootDataStore` API that is used to get aliased data store has been deprecated. It will be removed in a future release.
|
|
362
|
+
Use `getAliasedDataStoreEntryPoint` API to get aliased data stores instead. It returns the data store's entry point which is its `IFluidHandle`. To use this API `initializeEntryPoint` must be provided when creating `FluidDataStoreRuntime` [here](https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/datastore/src/dataStoreRuntime.ts#L243). `getAliasedDataStoreEntryPoint` and `initializeEntryPoint` will become required in a future release.
|
|
359
363
|
|
|
360
|
-
-
|
|
364
|
+
- Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
361
365
|
|
|
362
|
-
|
|
366
|
+
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.
|
|
363
367
|
|
|
364
|
-
-
|
|
368
|
+
- IDeltaManager members disposed and dispose() removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
365
369
|
|
|
366
|
-
|
|
370
|
+
IDeltaManager members disposed and dispose() were deprecated in 2.0.0-internal.5.3.0 and have now been removed.
|
|
367
371
|
|
|
368
372
|
## 2.0.0-internal.5.4.0
|
|
369
373
|
|
|
@@ -385,11 +389,11 @@ Dependency updates only.
|
|
|
385
389
|
|
|
386
390
|
### Major Changes
|
|
387
391
|
|
|
388
|
-
-
|
|
392
|
+
- The following functions and classes were deprecated in previous releases and have been removed: [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2)
|
|
389
393
|
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
394
|
+
- `PureDataObject.getFluidObjectFromDirectory`
|
|
395
|
+
- `IProvideContainerRuntime` and its `IContainerRuntime` member.
|
|
396
|
+
- `ContainerRuntime`'s `IProvideContainerRuntime` has also been removed.
|
|
393
397
|
|
|
394
398
|
## 2.0.0-internal.4.4.0
|
|
395
399
|
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-runtime-definitions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.31.0",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -41,10 +41,10 @@
|
|
|
41
41
|
"main": "",
|
|
42
42
|
"types": "lib/public.d.ts",
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@fluidframework/container-definitions": "~2.
|
|
45
|
-
"@fluidframework/core-interfaces": "~2.
|
|
46
|
-
"@fluidframework/driver-definitions": "~2.
|
|
47
|
-
"@fluidframework/runtime-definitions": "~2.
|
|
44
|
+
"@fluidframework/container-definitions": "~2.31.0",
|
|
45
|
+
"@fluidframework/core-interfaces": "~2.31.0",
|
|
46
|
+
"@fluidframework/driver-definitions": "~2.31.0",
|
|
47
|
+
"@fluidframework/runtime-definitions": "~2.31.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
@@ -52,13 +52,12 @@
|
|
|
52
52
|
"@fluid-tools/build-cli": "^0.54.0",
|
|
53
53
|
"@fluidframework/build-common": "^2.0.3",
|
|
54
54
|
"@fluidframework/build-tools": "^0.54.0",
|
|
55
|
-
"@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.
|
|
55
|
+
"@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.30.0",
|
|
56
56
|
"@fluidframework/eslint-config-fluid": "^5.7.3",
|
|
57
|
-
"@microsoft/api-extractor": "7.
|
|
57
|
+
"@microsoft/api-extractor": "7.50.1",
|
|
58
58
|
"concurrently": "^8.2.1",
|
|
59
59
|
"copyfiles": "^2.4.1",
|
|
60
60
|
"eslint": "~8.55.0",
|
|
61
|
-
"prettier": "~3.0.3",
|
|
62
61
|
"rimraf": "^4.4.0",
|
|
63
62
|
"typescript": "~5.4.5"
|
|
64
63
|
},
|
|
@@ -89,7 +88,6 @@
|
|
|
89
88
|
"check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
|
|
90
89
|
"check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
|
|
91
90
|
"check:format": "npm run check:biome",
|
|
92
|
-
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
93
91
|
"ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
|
|
94
92
|
"ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
|
|
95
93
|
"ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
|
|
@@ -99,7 +97,6 @@
|
|
|
99
97
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
100
98
|
"format": "npm run format:biome",
|
|
101
99
|
"format:biome": "biome check . --write",
|
|
102
|
-
"format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
103
100
|
"lint": "fluid-build . --task lint",
|
|
104
101
|
"lint:fix": "fluid-build . --task eslint:fix --task format",
|
|
105
102
|
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
|