fluid-framework

The fluid-framework package bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client package (e.g. @fluidframework/azure-client, @fluidframework/tinylicious-client, or @fluidframework/odsp-client (BETA)).

This package reexports these APIs from other Fluid client packages reducing the number of direct package dependencies needed. There are some packages there are not included as part of this fluid-framework package which users may want to use with this package:

• A service client (e.g. @fluidframework/azure-client, @fluidframework/odsp-client (BETA), or @fluidframework/tinylicious-client for local development) to allow connecting to a Fluid service.
• Fluid Framework developer tools.
• @fluidframework/app-insights-logger: to route Fluid telemetry to Azure App Insights.
• @fluidframework/react (ALPHA): to help integrate Fluid content (mainly SharedTree) into React applications.

Using Fluid Framework libraries

For a dependency on a Fluid Framework library's public APIs, we recommend a ^ (caret) version range. For example, use ^1.3.4.

For a dependency on an unstable API, such as a beta API, we recommend a more restrictive version range. For example, use a ~ version range.

Installation

Run this command to install the package:

npm i fluid-framework

Importing from this package

This package uses package.json exports to separate APIs by support level. For information about the support guarantees, read API Support Levels.

Import the public APIs from fluid-framework.

Import the beta APIs from fluid-framework/beta.

Import the alpha APIs from fluid-framework/alpha.

Import the legacy APIs from fluid-framework/legacy.

API Documentation

Read the fluid-framework API documentation at https://fluidframework.com/docs/apis/fluid-framework.

Contents

The fluid-framework package consists primarily of two portions: the IFluidContainer and a selection of distributed data structures (DDSes).

IFluidContainer

The IFluidContainer interface is one of the types returned by calls to createContainer() and getContainer() on the service clients such as AzureClient. It includes functionality to retrieve the Fluid data contained within, as well as to inspect the state of the collaboration session connection.

DDS packages

You'll use one or more DDS data structures in your container to model your collaborative data. The fluid-framework package offers the following data structures:

1. SharedTree
2. SharedMap, a map-like data structure for storing key/value pair data
   • Note: as of version 2.0, SharedMap is now marked legacy. Please use SharedTree for any new development.

Tutorial

Check out the Hello World tutorial using fluid-framework.

Minimum Client Requirements

Fluid Framework client libraries support the platforms in this document. These requirements are intentionally restrictive. Within a major version series, we can relax these requirements, but we cannot make them stricter. For a Long Term Support (LTS) version, we might need to support these platforms for several years.

Other configurations can work, but Fluid Framework does not support them. If an unsupported configuration stops working, we do not classify this as a bug. To request support for a configuration that is not listed, file an issue. The product team will evaluate your request. In the issue, specify the current status of the configuration:

• The configuration works but needs official support.
• The configuration does not work and requires changes.

Supported Runtimes

• Fluid Framework supports Node.js versions 22 and 24 while they receive upstream support.
  • Fluid Framework will stop support for version 22 when upstream support ends on 2027-04-30.
  • Fluid Framework does not support Node.js with the --no-experimental-fetch flag.
• Fluid Framework supports modern browsers that support the ES2022 standard library.

Supported Tools

• TypeScript 6.0:
  • Fluid Framework supports all strict options.
  • Set the build targets (lib, target) to ES2022 or later.
  • Enable strictNullChecks.
  • Fluid Framework does not support configuration options deprecated in TypeScript 6.0.
  • Fluid Framework does not fully support exactOptionalPropertyTypes. If you enable this option, do not use in, Reflect.has, Object.hasOwn, or Object.prototype.hasOwnProperty to narrow members of Fluid Framework types. These methods can incorrectly exclude undefined from the possible values.
• webpack 5
  • We do not require a specific bundler. Other bundlers that handle ES Modules can work, but we actively test only webpack.

Module Resolution

In TypeScript compilerOptions, use Node16, Node20, NodeNext, or Bundler module resolution. These settings follow the Node.js v12+ ESM Resolution and Loading algorithm.

Do not use Node10 module resolution.

Module Formats

• ES Modules: Use ES Modules to consume Fluid Framework client packages, including in Node.js.
• CommonJS: Fluid Framework does not officially support CommonJS in version 3.0 or later.

Contribution Guidelines

You can contribute to Fluid Framework in these ways:

• Answer questions in GitHub Discussions.
• Submit bug reports and help verify fixes.
• Review source code changes.
• Contribute bug fixes.

For detailed instructions, read the repo documentation.

This project follows the Microsoft Open Source Code of Conduct. For more information, read the Code of Conduct frequently asked questions. For questions or comments, contact [email protected].

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Help

Read the Fluid Framework documentation for information about Fluid Framework concepts and APIs.

To request information that the documentation does not contain, create an issue.

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.