|
| 1 | +<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. --> |
| 2 | + |
| 3 | +# Fluid Framework v2.61.0 |
| 4 | + |
| 5 | +## Contents |
| 6 | + |
| 7 | +- [✨ New Features](#-new-features) |
| 8 | + - [`minVersionForCollab` is now available on `IFluidDataStoreContext` (#25130)](#minversionforcollab-is-now-available-on-ifluiddatastorecontext-25130) |
| 9 | +- [⚠️ Deprecations](#️-deprecations) |
| 10 | + - [Deprecate submitMessage on FluidDataStoreRuntime and MockFluidDataStoreRuntime (#25332)](#deprecate-submitmessage-on-fluiddatastoreruntime-and-mockfluiddatastoreruntime-25332) |
| 11 | +- [Legacy API Changes](#legacy-api-changes) |
| 12 | + - [Wrapped errors preserved as `cause` property (#25485)](#wrapped-errors-preserved-as-cause-property-25485) |
| 13 | + |
| 14 | +## ✨ New Features |
| 15 | + |
| 16 | +### `minVersionForCollab` is now available on `IFluidDataStoreContext` ([#25130](https://github.com/microsoft/FluidFramework/issues/25130)) |
| 17 | + |
| 18 | +`minVersionForCollab` is now passed down from the `ContainerRuntime` to the Datastore layer where it is made available for `SharedObject` construction. DDSes may optionally consume this value and use it to determine which sets of feature flags should be enabled. |
| 19 | + |
| 20 | +#### Public type changes |
| 21 | + |
| 22 | +- **@fluidframework/datastore: `FluidDataStoreRuntime`** - Exposes `minVersionForCollab`. |
| 23 | +- **@fluidframework/runtime-definitions: `IFluidDataStoreContext`** - Exposes optional member `minVersionForCollab`. See `FluidDataStoreContext` for an example implementation. |
| 24 | +- **@fluidframework/test-runtime-utils: `MockFluidDataStoreContext`, `MockFluidDataStoreRuntime`** - Exposes `minVersionForCollab` either via a getter or as a readonly field. |
| 25 | + |
| 26 | +Note that the new implementations are optional fields and in some cases accept `undefined`. This is needed for layer compatibility, and in a future release these members will no longer be optional. |
| 27 | + |
| 28 | +#### Change details |
| 29 | + |
| 30 | +Commit: [`2566772`](https://github.com/microsoft/FluidFramework/commit/2566772d24a9bcffbb613c6b88517145c2d0ea32) |
| 31 | + |
| 32 | +Affected packages: |
| 33 | + |
| 34 | +- @fluidframework/datastore |
| 35 | +- @fluidframework/runtime-definitions |
| 36 | +- @fluidframework/test-runtime-utils |
| 37 | + |
| 38 | +[⬆️ Table of contents](#contents) |
| 39 | + |
| 40 | +## ⚠️ Deprecations |
| 41 | + |
| 42 | +### Deprecate submitMessage on FluidDataStoreRuntime and MockFluidDataStoreRuntime ([#25332](https://github.com/microsoft/FluidFramework/issues/25332)) |
| 43 | + |
| 44 | +As needed, access `submitMessage` via `IFluidDataStoreContext`/`IFluidParentContext`. See [#24406](https://github.com/microsoft/FluidFramework/issues/24406) for details. |
| 45 | + |
| 46 | +#### Change details |
| 47 | + |
| 48 | +Commit: [`687378a`](https://github.com/microsoft/FluidFramework/commit/687378ab1c02fe8798a5c01153da5aa35ccdc5ae) |
| 49 | + |
| 50 | +Affected packages: |
| 51 | + |
| 52 | +- @fluidframework/datastore |
| 53 | +- @fluidframework/test-runtime-utils |
| 54 | + |
| 55 | +[⬆️ Table of contents](#contents) |
| 56 | + |
| 57 | +## Legacy API Changes |
| 58 | + |
| 59 | +### Wrapped errors preserved as `cause` property ([#25485](https://github.com/microsoft/FluidFramework/issues/25485)) |
| 60 | + |
| 61 | +`IFluidErrorBase` (internal basis for FluidFramework client errors) declares `cause` property matching ES2022 lib (whether targeted or not). When an error is wrapped, `cause` will be set to the originating error (which may or may not itself be an `Error`). |
| 62 | + |
| 63 | +#### Change details |
| 64 | + |
| 65 | +Commit: [`c69d56d`](https://github.com/microsoft/FluidFramework/commit/c69d56d2b210e82cb42cb4ec8f8b6d3f8ce6c9db) |
| 66 | + |
| 67 | +Affected packages: |
| 68 | + |
| 69 | +- @fluidframework/telemetry-utils |
| 70 | + |
| 71 | +[⬆️ Table of contents](#contents) |
| 72 | + |
| 73 | +### 🛠️ Start Building Today! |
| 74 | + |
| 75 | +Please continue to engage with us on GitHub [Discussion](https://github.com/microsoft/FluidFramework/discussions) and [Issue](https://github.com/microsoft/FluidFramework/issues) pages as you adopt Fluid Framework! |
0 commit comments