@fluidframework/core-interfaces 2.30.0 → 2.31.1

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 CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/core-interfaces
2
2
 
3
+ ## 2.31.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.30.0
4
8
 
5
9
  Dependency updates only.
@@ -32,12 +36,12 @@ Dependency updates only.
32
36
 
33
37
  ### Minor Changes
34
38
 
35
- - The events library has been moved from the tree package ([#23141](https://github.com/microsoft/FluidFramework/pull/23141)) [cae07b5c8c](https://github.com/microsoft/FluidFramework/commit/cae07b5c8c7904184b5fbf8c677f302da19cc697)
39
+ - The events library has been moved from the tree package ([#23141](https://github.com/microsoft/FluidFramework/pull/23141)) [cae07b5c8c](https://github.com/microsoft/FluidFramework/commit/cae07b5c8c7904184b5fbf8c677f302da19cc697)
36
40
 
37
- In previous releases, the `@fluidframework/tree` package contained an internal events library. The events-related types and interfaces have been moved to
38
- `@fluidframework/core-interfaces`, while the implementation has been relocated to `@fluid-internal/client-utils`. There are
39
- no changes to how the events library is used; the relocation simply organizes the library into more appropriate
40
- packages. This change should have no impact on developers using the Fluid Framework.
41
+ In previous releases, the `@fluidframework/tree` package contained an internal events library. The events-related types and interfaces have been moved to
42
+ `@fluidframework/core-interfaces`, while the implementation has been relocated to `@fluid-internal/client-utils`. There are
43
+ no changes to how the events library is used; the relocation simply organizes the library into more appropriate
44
+ packages. This change should have no impact on developers using the Fluid Framework.
41
45
 
42
46
  ## 2.10.0
43
47
 
@@ -67,134 +71,134 @@ Dependency updates only.
67
71
 
68
72
  ### Minor Changes
69
73
 
70
- - fluid-framework: Type Erase ISharedObjectKind ([#21081](https://github.com/microsoft/FluidFramework/pull/21081)) [78f228e370](https://github.com/microsoft/FluidFramework/commit/78f228e37055bd4d9a8f02b3a1eefebf4da9c59c)
74
+ - fluid-framework: Type Erase ISharedObjectKind ([#21081](https://github.com/microsoft/FluidFramework/pull/21081)) [78f228e370](https://github.com/microsoft/FluidFramework/commit/78f228e37055bd4d9a8f02b3a1eefebf4da9c59c)
71
75
 
72
- A new type, `SharedObjectKind` is added as a type erased version of `ISharedObjectKind` and `DataObjectClass`.
76
+ A new type, `SharedObjectKind` is added as a type erased version of `ISharedObjectKind` and `DataObjectClass`.
73
77
 
74
- This type fills the role of both `ISharedObjectKind` and `DataObjectClass` in the `@public` "declarative API" exposed in the `fluid-framework` package.
78
+ This type fills the role of both `ISharedObjectKind` and `DataObjectClass` in the `@public` "declarative API" exposed in the `fluid-framework` package.
75
79
 
76
- This allows several types referenced by `ISharedObjectKind` to be made `@alpha` as they should only need to be used by legacy code and users of the unstable/alpha/legacy "encapsulated API".
80
+ This allows several types referenced by `ISharedObjectKind` to be made `@alpha` as they should only need to be used by legacy code and users of the unstable/alpha/legacy "encapsulated API".
77
81
 
78
- Access to these now less public types should not be required for users of the `@public` "declarative API" exposed in the `fluid-framework` package, but can still be accessed for those who need them under the `/legacy` import paths.
79
- The full list of such types is:
82
+ Access to these now less public types should not be required for users of the `@public` "declarative API" exposed in the `fluid-framework` package, but can still be accessed for those who need them under the `/legacy` import paths.
83
+ The full list of such types is:
80
84
 
81
- - `SharedTree` as exported from `@fluidframwork/tree`: It is still exported as `@public` from `fluid-framework` as `SharedObjectKind`.
82
- - `ISharedObjectKind`: See new `SharedObjectKind` type for use in `@public` APIs.
83
- `ISharedObject`
84
- - `IChannel`
85
- - `IChannelAttributes`
86
- - `IChannelFactory`
87
- - `IExperimentalIncrementalSummaryContext`
88
- - `IGarbageCollectionData`
89
- - `ISummaryStats`
90
- - `ISummaryTreeWithStats`
91
- - `ITelemetryContext`
92
- - `IDeltaManagerErased`
93
- - `IFluidDataStoreRuntimeEvents`
94
- - `IFluidHandleContext`
95
- - `IProvideFluidHandleContext`
85
+ - `SharedTree` as exported from `@fluidframwork/tree`: It is still exported as `@public` from `fluid-framework` as `SharedObjectKind`.
86
+ - `ISharedObjectKind`: See new `SharedObjectKind` type for use in `@public` APIs.
87
+ `ISharedObject`
88
+ - `IChannel`
89
+ - `IChannelAttributes`
90
+ - `IChannelFactory`
91
+ - `IExperimentalIncrementalSummaryContext`
92
+ - `IGarbageCollectionData`
93
+ - `ISummaryStats`
94
+ - `ISummaryTreeWithStats`
95
+ - `ITelemetryContext`
96
+ - `IDeltaManagerErased`
97
+ - `IFluidDataStoreRuntimeEvents`
98
+ - `IFluidHandleContext`
99
+ - `IProvideFluidHandleContext`
96
100
 
97
- Removed APIs:
101
+ Removed APIs:
98
102
 
99
- - `DataObjectClass`: Usages replaced with `SharedObjectKind`.
100
- - `LoadableObjectClass`: Replaced with `SharedObjectKind`.
101
- - `LoadableObjectClassRecord`: Replaced with `Record<string, SharedObjectKind>`.
102
- -
103
+ - `DataObjectClass`: Usages replaced with `SharedObjectKind`.
104
+ - `LoadableObjectClass`: Replaced with `SharedObjectKind`.
105
+ - `LoadableObjectClassRecord`: Replaced with `Record<string, SharedObjectKind>`.
106
+ -
103
107
 
104
- - Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
108
+ - Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
105
109
 
106
- Update package implementations to use TypeScript 5.4.5.
110
+ Update package implementations to use TypeScript 5.4.5.
107
111
 
108
- - core-interfaces, tree: Unify `IDisposable` interfaces ([#21184](https://github.com/microsoft/FluidFramework/pull/21184)) [cfcb827851](https://github.com/microsoft/FluidFramework/commit/cfcb827851ffc81486db6c718380150189fb95c5)
112
+ - core-interfaces, tree: Unify `IDisposable` interfaces ([#21184](https://github.com/microsoft/FluidFramework/pull/21184)) [cfcb827851](https://github.com/microsoft/FluidFramework/commit/cfcb827851ffc81486db6c718380150189fb95c5)
109
113
 
110
- Public APIs in `@fluidframework/tree` now use `IDisposable` from `@fluidframework/core-interfaces` replacing `disposeSymbol` with "dispose".
114
+ Public APIs in `@fluidframework/tree` now use `IDisposable` from `@fluidframework/core-interfaces` replacing `disposeSymbol` with "dispose".
111
115
 
112
- `IDisposable` in `@fluidframework/core-interfaces` is now `@sealed` indicating that third parties should not implement it to reserve the ability for Fluid Framework to extend it to include `Symbol.dispose` as a future non-breaking change.
116
+ `IDisposable` in `@fluidframework/core-interfaces` is now `@sealed` indicating that third parties should not implement it to reserve the ability for Fluid Framework to extend it to include `Symbol.dispose` as a future non-breaking change.
113
117
 
114
118
  ## 2.0.0-rc.4.0.0
115
119
 
116
120
  ### Minor Changes
117
121
 
118
- - Deprecated members of IFluidHandle are split off into new IFluidHandleInternal interface [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
122
+ - Deprecated members of IFluidHandle are split off into new IFluidHandleInternal interface [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
119
123
 
120
- Split IFluidHandle into two interfaces, `IFluidHandle` and `IFluidHandleInternal`.
121
- Code depending on the previously deprecated members of IFluidHandle can access them by using `toFluidHandleInternal` from `@fluidframework/runtime-utils/legacy`.
124
+ Split IFluidHandle into two interfaces, `IFluidHandle` and `IFluidHandleInternal`.
125
+ Code depending on the previously deprecated members of IFluidHandle can access them by using `toFluidHandleInternal` from `@fluidframework/runtime-utils/legacy`.
122
126
 
123
- External implementation of the `IFluidHandle` interface are not supported: this change makes the typing better convey this using the `ErasedType` pattern.
124
- Any existing and previously working, and now broken, external implementations of `IFluidHandle` should still work at runtime, but will need some unsafe type casts to compile.
125
- Such handle implementation may break in the future and thus should be replaced with use of handles produced by the Fluid Framework client packages.
127
+ External implementation of the `IFluidHandle` interface are not supported: this change makes the typing better convey this using the `ErasedType` pattern.
128
+ Any existing and previously working, and now broken, external implementations of `IFluidHandle` should still work at runtime, but will need some unsafe type casts to compile.
129
+ Such handle implementation may break in the future and thus should be replaced with use of handles produced by the Fluid Framework client packages.
126
130
 
127
131
  ## 2.0.0-rc.3.0.0
128
132
 
129
133
  ### Major Changes
130
134
 
131
- - core-interfaces: Code details and package API surface removed [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
135
+ - core-interfaces: Code details and package API surface removed [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
132
136
 
133
- The code details and package API surface was deprecated in @fluidframework/core-interfaces in 0.53 and has now been removed. Please import them from @fluidframework/container-definitions instead. These include:
137
+ The code details and package API surface was deprecated in @fluidframework/core-interfaces in 0.53 and has now been removed. Please import them from @fluidframework/container-definitions instead. These include:
134
138
 
135
- - IFluidCodeDetails
136
- - IFluidCodeDetailsComparer
137
- - IFluidCodeDetailsConfig
138
- - IFluidPackage
139
- - IFluidPackageEnvironment
140
- - IProvideFluidCodeDetailsComparer
141
- - isFluidCodeDetails
142
- - isFluidPackage
139
+ - IFluidCodeDetails
140
+ - IFluidCodeDetailsComparer
141
+ - IFluidCodeDetailsConfig
142
+ - IFluidPackage
143
+ - IFluidPackageEnvironment
144
+ - IProvideFluidCodeDetailsComparer
145
+ - isFluidCodeDetails
146
+ - isFluidPackage
143
147
 
144
- - Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
148
+ - Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
145
149
 
146
- Fluid Framework packages have been updated to use the [package.json "exports"
147
- field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
148
- TypeScript types and implementation code.
150
+ Fluid Framework packages have been updated to use the [package.json "exports"
151
+ field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
152
+ TypeScript types and implementation code.
149
153
 
150
- This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
154
+ This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
151
155
 
152
- - `"moduleResolution": "Node16"` with `"module": "Node16"`
153
- - `"moduleResolution": "Bundler"` with `"module": "ESNext"`
156
+ - `"moduleResolution": "Node16"` with `"module": "Node16"`
157
+ - `"moduleResolution": "Bundler"` with `"module": "ESNext"`
154
158
 
155
- We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
156
- for use with modern versions of Node.js _and_ Bundlers.
157
- [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
158
- regarding the module and moduleResolution options.
159
+ We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
160
+ for use with modern versions of Node.js _and_ Bundlers.
161
+ [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
162
+ regarding the module and moduleResolution options.
159
163
 
160
- **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
161
- to distinguish stable APIs from those that are in development.**
164
+ **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
165
+ to distinguish stable APIs from those that are in development.**
162
166
 
163
167
  ## 2.0.0-rc.2.0.0
164
168
 
165
169
  ### Minor Changes
166
170
 
167
- - core-interfaces: Removed ITelemetryProperties, TelemetryEventCategory, TelemetryEventPropertyType, and ITaggedTelemetryPropertyType ([#19752](https://github.com/microsoft/FluidFramework/issues/19752)) [615a7712e6](https://github.com/microsoft/FluidFramework/commits/615a7712e67885c6cda69ddd907cb5cc708eef18)
171
+ - core-interfaces: Removed ITelemetryProperties, TelemetryEventCategory, TelemetryEventPropertyType, and ITaggedTelemetryPropertyType ([#19752](https://github.com/microsoft/FluidFramework/issues/19752)) [615a7712e6](https://github.com/microsoft/FluidFramework/commits/615a7712e67885c6cda69ddd907cb5cc708eef18)
168
172
 
169
- The `ITelemetryProperties` interface was deprecated and has been removed.
170
- Use the identical `ITelemetryBaseProperties` instead.
173
+ The `ITelemetryProperties` interface was deprecated and has been removed.
174
+ Use the identical `ITelemetryBaseProperties` instead.
171
175
 
172
- The `TelemetryEventCategory` type was deprecated and has been removed from `@fluidframework/core-interfaces`, since
173
- it had moved to `@fluidframework/telemetry-utils` in the past.
176
+ The `TelemetryEventCategory` type was deprecated and has been removed from `@fluidframework/core-interfaces`, since
177
+ it had moved to `@fluidframework/telemetry-utils` in the past.
174
178
 
175
- The `TelemetryEventPropertyType` type alias was deprecated and has been removed.
176
- Use the identical `TelemetryBaseEventPropertyType` instead.
179
+ The `TelemetryEventPropertyType` type alias was deprecated and has been removed.
180
+ Use the identical `TelemetryBaseEventPropertyType` instead.
177
181
 
178
- The `ITaggedTelemetryPropertyType` interface was deprecated and has been removed.
179
- Use `Tagged<TelemetryBaseEventPropertyType>` instead.
182
+ The `ITaggedTelemetryPropertyType` interface was deprecated and has been removed.
183
+ Use `Tagged<TelemetryBaseEventPropertyType>` instead.
180
184
 
181
- - container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
185
+ - container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
182
186
 
183
- Added `containerMetadata` prop on IContainer interface.
187
+ Added `containerMetadata` prop on IContainer interface.
184
188
 
185
- - runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
189
+ - runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
186
190
 
187
- The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
191
+ The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
188
192
 
189
- - core-interfaces: Removed deprecated telemetry event types ([#19740](https://github.com/microsoft/FluidFramework/issues/19740)) [0ff130a50e](https://github.com/microsoft/FluidFramework/commits/0ff130a50e9bcccb119673ac985ea27fa38de463)
193
+ - core-interfaces: Removed deprecated telemetry event types ([#19740](https://github.com/microsoft/FluidFramework/issues/19740)) [0ff130a50e](https://github.com/microsoft/FluidFramework/commits/0ff130a50e9bcccb119673ac985ea27fa38de463)
190
194
 
191
- The deprecated `ITelemetryErrorEvent`, `ITelemetryGenericEvent`, and `ITelemetryPerformanceEvent` interfaces,
192
- which represented different kinds of telemetry events, were not intended for consumers of Fluid Framework and have thus
193
- been removed.
194
- `ITelemetryBaseEvent` is the only telemetry event interface that should be used in/by consuming code.
195
+ The deprecated `ITelemetryErrorEvent`, `ITelemetryGenericEvent`, and `ITelemetryPerformanceEvent` interfaces,
196
+ which represented different kinds of telemetry events, were not intended for consumers of Fluid Framework and have thus
197
+ been removed.
198
+ `ITelemetryBaseEvent` is the only telemetry event interface that should be used in/by consuming code.
195
199
 
196
- `ITelemetryLogger` was not intended for consumers of Fluid Framework and has been removed.
197
- Consumers should use the simpler `ITelemetryBaseLogger` instead.
200
+ `ITelemetryLogger` was not intended for consumers of Fluid Framework and has been removed.
201
+ Consumers should use the simpler `ITelemetryBaseLogger` instead.
198
202
 
199
203
  ## 2.0.0-rc.1.0.0
200
204
 
@@ -204,27 +208,27 @@ Dependency updates only.
204
208
 
205
209
  ### Major Changes
206
210
 
207
- - container-runtime-definitions: Removed getRootDataStore [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
211
+ - container-runtime-definitions: Removed getRootDataStore [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
208
212
 
209
- 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`.
213
+ 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`.
210
214
 
211
- See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
215
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
212
216
 
213
- - core-interfaces: Removed IFluidRouter and IProvideFluidRouter [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
217
+ - core-interfaces: Removed IFluidRouter and IProvideFluidRouter [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
214
218
 
215
- The `IFluidRouter` and `IProvideFluidRouter` interfaces have been removed. Please migrate all usage to the new `entryPoint` pattern.
219
+ The `IFluidRouter` and `IProvideFluidRouter` interfaces have been removed. Please migrate all usage to the new `entryPoint` pattern.
216
220
 
217
- See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
221
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
218
222
 
219
223
  ## 2.0.0-internal.7.4.0
220
224
 
221
225
  ### Minor Changes
222
226
 
223
- - telemetry-utils: Deprecate ConfigTypes and IConfigProviderBase ([#18597](https://github.com/microsoft/FluidFramework/issues/18597)) [39b9ff57c0](https://github.com/microsoft/FluidFramework/commits/39b9ff57c0184b72f0e3f9425922dda944995265)
227
+ - telemetry-utils: Deprecate ConfigTypes and IConfigProviderBase ([#18597](https://github.com/microsoft/FluidFramework/issues/18597)) [39b9ff57c0](https://github.com/microsoft/FluidFramework/commits/39b9ff57c0184b72f0e3f9425922dda944995265)
224
228
 
225
- The types `ConfigTypes` and `IConfigProviderBase` have been deprecated in the @fluidframework/telemetry-utils package.
226
- The types can now be found in the @fluidframework/core-interfaces package. Please replace any uses with the types from
227
- @fluidframework/core-interfaces.
229
+ The types `ConfigTypes` and `IConfigProviderBase` have been deprecated in the @fluidframework/telemetry-utils package.
230
+ The types can now be found in the @fluidframework/core-interfaces package. Please replace any uses with the types from
231
+ @fluidframework/core-interfaces.
228
232
 
229
233
  ## 2.0.0-internal.7.3.0
230
234
 
@@ -242,31 +246,31 @@ Dependency updates only.
242
246
 
243
247
  ### Major Changes
244
248
 
245
- - test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
249
+ - test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
246
250
 
247
- The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
251
+ The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
248
252
 
249
- - `BaseContainerRuntimeFactory`
250
- - `RuntimeFactory`
251
- - `ContainerRuntime` (constructor and `loadRuntime`)
252
- - `FluidDataStoreRuntime`
253
+ - `BaseContainerRuntimeFactory`
254
+ - `RuntimeFactory`
255
+ - `ContainerRuntime` (constructor and `loadRuntime`)
256
+ - `FluidDataStoreRuntime`
253
257
 
254
- See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
255
- See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
258
+ See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
259
+ See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
256
260
 
257
- Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
261
+ Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
258
262
 
259
- For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
263
+ For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
260
264
 
261
- - DEPRECATED: core-interfaces: IFluidRouter and IProvideFluidRouter deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
265
+ - DEPRECATED: core-interfaces: IFluidRouter and IProvideFluidRouter deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
262
266
 
263
- `IFluidRouter` and `IProvideFluidRouter` have been deprecated. Please remove all usages of these interfaces and migrate to the new `entryPoint` pattern.
267
+ `IFluidRouter` and `IProvideFluidRouter` have been deprecated. Please remove all usages of these interfaces and migrate to the new `entryPoint` pattern.
264
268
 
265
- See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
269
+ See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
266
270
 
267
- - Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
271
+ - Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
268
272
 
269
- The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
273
+ The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
270
274
 
271
275
  ## 2.0.0-internal.6.4.0
272
276
 
@@ -276,60 +280,60 @@ Dependency updates only.
276
280
 
277
281
  ### Minor Changes
278
282
 
279
- - Cleaning up duplicate or misnamed telemetry types ([#17149](https://github.com/microsoft/FluidFramework/issues/17149)) [f9236942fa](https://github.com/microsoft/FluidFramework/commits/f9236942faf03cde860bfcbc7c28f8fbd81d3868)
283
+ - Cleaning up duplicate or misnamed telemetry types ([#17149](https://github.com/microsoft/FluidFramework/issues/17149)) [f9236942fa](https://github.com/microsoft/FluidFramework/commits/f9236942faf03cde860bfcbc7c28f8fbd81d3868)
280
284
 
281
- We have two sets of telemetry-related interfaces:
285
+ We have two sets of telemetry-related interfaces:
282
286
 
283
- - The "Base" ones
284
- - These have a very bare API surface
285
- - They are used on public API surfaces to transmit logs across layers
286
- - The internal ones
287
- - These have a richer API surface (multiple log functions with different categories,
288
- support for logging flat arrays and objects)
289
- - They are used for instrumenting our code, and then normalize and pass off the logs via the Base interface
287
+ - The "Base" ones
288
+ - These have a very bare API surface
289
+ - They are used on public API surfaces to transmit logs across layers
290
+ - The internal ones
291
+ - These have a richer API surface (multiple log functions with different categories,
292
+ support for logging flat arrays and objects)
293
+ - They are used for instrumenting our code, and then normalize and pass off the logs via the Base interface
290
294
 
291
- There are two problems with the given state of the world:
295
+ There are two problems with the given state of the world:
292
296
 
293
- 1. The "Base" ones were not named consistently, so the distinction was not as apparent as it could be
294
- 2. The internal ones were copied to `@fluidframework/telemetry-utils` and futher extended, but the original duplicates remain.
297
+ 1. The "Base" ones were not named consistently, so the distinction was not as apparent as it could be
298
+ 2. The internal ones were copied to `@fluidframework/telemetry-utils` and futher extended, but the original duplicates remain.
295
299
 
296
- This change addresses these by adding "Base" to the name of each base type, and deprecating the old duplicate internal types.
300
+ This change addresses these by adding "Base" to the name of each base type, and deprecating the old duplicate internal types.
297
301
 
298
- Additionally, the following types were adjusted:
302
+ Additionally, the following types were adjusted:
299
303
 
300
- - `TelemetryEventCategory` is moving from `@fluidframework/core-interfaces` to `@fluidframework/telemetry-utils`
301
- - Several types modeling "tagged" telemetry properties are deprecated in favor of a generic type `Tagged<V>`
304
+ - `TelemetryEventCategory` is moving from `@fluidframework/core-interfaces` to `@fluidframework/telemetry-utils`
305
+ - Several types modeling "tagged" telemetry properties are deprecated in favor of a generic type `Tagged<V>`
302
306
 
303
307
  ## 2.0.0-internal.6.2.0
304
308
 
305
309
  ### Minor Changes
306
310
 
307
- - Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
308
-
309
- The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
310
- imported from the **@fluidframework/core-interfaces** package:
311
-
312
- - interface IDisposable
313
- - interface IErrorEvent
314
- - interface IErrorEvent
315
- - interface IEvent
316
- - interface IEventProvider
317
- - interface ILoggingError
318
- - interface ITaggedTelemetryPropertyType
319
- - interface ITelemetryBaseEvent
320
- - interface ITelemetryBaseLogger
321
- - interface ITelemetryErrorEvent
322
- - interface ITelemetryGenericEvent
323
- - interface ITelemetryLogger
324
- - interface ITelemetryPerformanceEvent
325
- - interface ITelemetryProperties
326
- - type ExtendEventProvider
327
- - type IEventThisPlaceHolder
328
- - type IEventTransformer
329
- - type ReplaceIEventThisPlaceHolder
330
- - type ReplaceIEventThisPlaceHolder
331
- - type TelemetryEventCategory
332
- - type TelemetryEventPropertyType
311
+ - Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
312
+
313
+ The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
314
+ imported from the **@fluidframework/core-interfaces** package:
315
+
316
+ - interface IDisposable
317
+ - interface IErrorEvent
318
+ - interface IErrorEvent
319
+ - interface IEvent
320
+ - interface IEventProvider
321
+ - interface ILoggingError
322
+ - interface ITaggedTelemetryPropertyType
323
+ - interface ITelemetryBaseEvent
324
+ - interface ITelemetryBaseLogger
325
+ - interface ITelemetryErrorEvent
326
+ - interface ITelemetryGenericEvent
327
+ - interface ITelemetryLogger
328
+ - interface ITelemetryPerformanceEvent
329
+ - interface ITelemetryProperties
330
+ - type ExtendEventProvider
331
+ - type IEventThisPlaceHolder
332
+ - type IEventTransformer
333
+ - type ReplaceIEventThisPlaceHolder
334
+ - type ReplaceIEventThisPlaceHolder
335
+ - type TelemetryEventCategory
336
+ - type TelemetryEventPropertyType
333
337
 
334
338
  ## 2.0.0-internal.6.1.0
335
339
 
@@ -339,9 +343,9 @@ Dependency updates only.
339
343
 
340
344
  ### Major Changes
341
345
 
342
- - Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
346
+ - Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
343
347
 
344
- 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.
348
+ 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.
345
349
 
346
350
  ## 2.0.0-internal.5.4.0
347
351
 
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.47.8"
8
+ "packageVersion": "7.50.1"
9
9
  }
10
10
  ]
11
11
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/core-interfaces",
3
- "version": "2.30.0",
3
+ "version": "2.31.1",
4
4
  "description": "Fluid object interfaces",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -76,9 +76,9 @@
76
76
  "@fluid-tools/build-cli": "^0.54.0",
77
77
  "@fluidframework/build-common": "^2.0.3",
78
78
  "@fluidframework/build-tools": "^0.54.0",
79
- "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.23.0",
79
+ "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.31.0",
80
80
  "@fluidframework/eslint-config-fluid": "^5.7.3",
81
- "@microsoft/api-extractor": "7.47.8",
81
+ "@microsoft/api-extractor": "7.50.1",
82
82
  "@types/mocha": "^10.0.10",
83
83
  "@types/node": "^18.19.0",
84
84
  "c8": "^8.0.1",
@@ -88,7 +88,6 @@
88
88
  "eslint": "~8.55.0",
89
89
  "mocha": "^10.8.2",
90
90
  "mocha-multi-reporters": "^1.5.1",
91
- "prettier": "~3.0.3",
92
91
  "rimraf": "^4.4.0",
93
92
  "typescript": "~5.4.5"
94
93
  },
@@ -128,26 +127,22 @@
128
127
  "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
129
128
  "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
130
129
  "check:format": "npm run check:biome",
131
- "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
132
130
  "ci:build": "npm run build:compile",
133
131
  "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
134
132
  "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
135
133
  "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
136
134
  "ci:build:docs": "api-extractor run",
137
- "ci:test": "echo No test for this package",
138
- "ci:test:coverage": "echo No test for this package",
139
135
  "clean": "rimraf --glob dist lib {alpha,beta,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
140
136
  "eslint": "eslint --format stylish src",
141
137
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
142
138
  "format": "npm run format:biome",
143
139
  "format:biome": "biome check . --write",
144
- "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
145
140
  "lint": "fluid-build . --task lint",
146
141
  "lint:fix": "fluid-build . --task eslint:fix --task format",
147
142
  "place:cjs:package-stub": "copyfiles -f ./src/cjs/package.json ./dist",
148
143
  "test": "npm run test:mocha",
149
144
  "test:coverage": "c8 npm test",
150
- "test:mocha": "npm run test:mocha:esm && echo npm run test:mocha:cjs",
145
+ "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
151
146
  "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\"",
152
147
  "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\"",
153
148
  "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
@@ -1,8 +0,0 @@
1
- /*!
2
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
- * Licensed under the MIT License.
4
- */
5
-
6
- module.exports = {
7
- ...require("@fluidframework/build-common/prettier.config.cjs"),
8
- };