|
| 1 | +<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. --> |
| 2 | + |
| 3 | +# Fluid Framework v2.72.0 |
| 4 | + |
| 5 | +## Contents |
| 6 | + |
| 7 | +- [✨ New Features](#-new-features) |
| 8 | + - [Expose staged, types, stagedRecursive and typesRecursive on SchemaFactoryBeta (#25779)](#expose-staged-types-stagedrecursive-and-typesrecursive-on-schemafactorybeta-25779) |
| 9 | +- [🌳 SharedTree DDS Changes](#-sharedtree-dds-changes) |
| 10 | + - [`formatVersion` removed from the options passed to `configuredSharedTree` (#25752)](#formatversion-removed-from-the-options-passed-to-configuredsharedtree-25752) |
| 11 | +- [Legacy API Changes](#legacy-api-changes) |
| 12 | + - [Added a new Fluid error type layerIncompatibilityError (#25784)](#added-a-new-fluid-error-type-layerincompatibilityerror-25784) |
| 13 | + |
| 14 | +## ✨ New Features |
| 15 | + |
| 16 | +### Expose staged, types, stagedRecursive and typesRecursive on SchemaFactoryBeta ([#25779](https://github.com/microsoft/FluidFramework/issues/25779)) |
| 17 | + |
| 18 | +These APIs were previously only available on `SchemaFactoryAlpha`, but are now available on `SchemaFactoryBeta`. |
| 19 | + |
| 20 | +#### Change details |
| 21 | + |
| 22 | +Commit: [`75d7f11`](https://github.com/microsoft/FluidFramework/commit/75d7f113e4a5492221201f7ee3585a16e5d1790f) |
| 23 | + |
| 24 | +Affected packages: |
| 25 | + |
| 26 | +- @fluidframework/tree |
| 27 | + |
| 28 | +[⬆️ Table of contents](#contents) |
| 29 | + |
| 30 | +## 🌳 SharedTree DDS Changes |
| 31 | + |
| 32 | +### `formatVersion` removed from the options passed to `configuredSharedTree` ([#25752](https://github.com/microsoft/FluidFramework/issues/25752)) |
| 33 | + |
| 34 | +Note: this change may break users of alpha APIs. See below for details. |
| 35 | + |
| 36 | +`SharedTreeOptions` (which is passed to `configuredSharedTree`) no longer includes a `formatVersion: SharedTreeFormatVersion[keyof SharedTreeFormatVersion]` field. The concept of `SharedTreeFormatVersion` has been removed altogether. Instead, users are expected to leverage the already existing `minVersionForCollab` field. |
| 37 | + |
| 38 | +For migration purposes, the mapping from `SharedTreeFormatVersion` to `minVersionForCollab` is as follows: |
| 39 | + |
| 40 | +- `SharedTreeFormatVersion.v1`: no supported equivalent |
| 41 | +- `SharedTreeFormatVersion.v2`: no supported equivalent |
| 42 | +- `SharedTreeFormatVersion.v3`: `minVersionForCollab: FluidClientVersion.v2_0` |
| 43 | +- `SharedTreeFormatVersion.v5`: `minVersionForCollab: FluidClientVersion.v2_43` |
| 44 | +- `SharedTreeFormatVersion.vSharedBranches`: `minVersionForCollab: FluidClientVersion.v2_43` + `SharedTreeOptions.enableSharedBranches` |
| 45 | + |
| 46 | +The values for which there is no supported equivalent `minVersionForCollab` were never given official support. [Contact](https://github.com/microsoft/FluidFramework/issues) the Fluid Framework team if you need help migrating away from them. |
| 47 | + |
| 48 | +#### Change details |
| 49 | + |
| 50 | +Commit: [`df53390`](https://github.com/microsoft/FluidFramework/commit/df533906e3a8e5d54024009704ca0c0eedb95e95) |
| 51 | + |
| 52 | +Affected packages: |
| 53 | + |
| 54 | +- @fluidframework/tree |
| 55 | +- fluid-framework |
| 56 | + |
| 57 | +[⬆️ Table of contents](#contents) |
| 58 | + |
| 59 | +## Legacy API Changes |
| 60 | + |
| 61 | +### Added a new Fluid error type layerIncompatibilityError ([#25784](https://github.com/microsoft/FluidFramework/issues/25784)) |
| 62 | + |
| 63 | +A new Fluid error type `layerIncompatibilityError` is added to `FluidErrorTypesAlpha` as @legacy @alpha. This will be moved to `FluidErrorTypes` as @legacy @beta in a future legacy breaking release. It will also be added to `ContainerErrorTypes` since it extends `FluidErrorTypes`. |
| 64 | + |
| 65 | +#### Change details |
| 66 | + |
| 67 | +Commit: [`01d568b`](https://github.com/microsoft/FluidFramework/commit/01d568b4bcbff38a0ee4b614bad1dfb0c400a360) |
| 68 | + |
| 69 | +Affected packages: |
| 70 | + |
| 71 | +- @fluidframework/core-interfaces |
| 72 | +- @fluidframework/container-definitions |
| 73 | + |
| 74 | +[⬆️ Table of contents](#contents) |
| 75 | + |
| 76 | +### 🛠️ Start Building Today! |
| 77 | + |
| 78 | +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