microsoft/FluidFramework client_v2.72.0

Fluid Framework v2.72.0 (minor)

on GitHub

Contents

• ✨ New Features
  • Expose staged, types, stagedRecursive and typesRecursive on SchemaFactoryBeta (#25779)
• 🌳 SharedTree DDS Changes
  • formatVersion removed from the options passed to configuredSharedTree (#25752)
• Legacy API Changes
  • Added a new Fluid error type layerIncompatibilityError (#25784)

✨ New Features

Expose staged, types, stagedRecursive and typesRecursive on SchemaFactoryBeta (#25779)

These APIs were previously only available on SchemaFactoryAlpha, but are now available on SchemaFactoryBeta.

Change details

Commit: 75d7f11

Affected packages:

• @fluidframework/tree

⬆️ Table of contents

🌳 SharedTree DDS Changes

formatVersion removed from the options passed to configuredSharedTree (#25752)

Note: this change may break users of alpha APIs. See below for details.

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.

For migration purposes, the mapping from SharedTreeFormatVersion to minVersionForCollab is as follows:

• SharedTreeFormatVersion.v1: no supported equivalent
• SharedTreeFormatVersion.v2: no supported equivalent
• SharedTreeFormatVersion.v3: minVersionForCollab: FluidClientVersion.v2_0
• SharedTreeFormatVersion.v5: minVersionForCollab: FluidClientVersion.v2_43
• SharedTreeFormatVersion.vSharedBranches: minVersionForCollab: FluidClientVersion.v2_43 + SharedTreeOptions.enableSharedBranches

The values for which there is no supported equivalent minVersionForCollab were never given official support. Contact the Fluid Framework team if you need help migrating away from them.

Change details

Commit: df53390

Affected packages:

• @fluidframework/tree
• fluid-framework

⬆️ Table of contents

Legacy API Changes

Added a new Fluid error type layerIncompatibilityError (#25784)

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.

Change details

Commit: 01d568b

Affected packages:

• @fluidframework/core-interfaces
• @fluidframework/container-definitions

⬆️ Table of contents

🛠️ Start Building Today!

Please continue to engage with us on GitHub Discussion and Issue pages as you adopt Fluid Framework!