# @fluidframework/datastore-definitions > Fluid data store definitions Latest version **3.1.0** (published 2026-09-16) · MIT license · 0 weekly downloads ## Install ```sh npm install @fluidframework/datastore-definitions pnpm add @fluidframework/datastore-definitions yarn add @fluidframework/datastore-definitions bun add @fluidframework/datastore-definitions ``` ## Health **Score 60/100 (C)** — status: active. Positive: esm support; no vulnerabilities; recently updated; high maintenance score. Warnings: low downloads; no types. ## Facts | | | |---|---| | Version | 3.1.0 | | Published | 2026-09-16 | | First published | 2020-09-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM | | Dependencies | 5 | | Unpacked size | 162.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 4947 | | Author | Microsoft and contributors | | Maintainers | ms-fluid-bot, microsoft-oss-releases, microsoft1es | ## Links - npm: https://www.npmjs.com/package/@fluidframework/datastore-definitions - Repository: https://github.com/microsoft/FluidFramework - Homepage: https://fluidframework.com - Issues: https://github.com/microsoft/FluidFramework/issues - npm.io page: https://npm.io/package/@fluidframework/datastore-definitions ## Dependencies (5) - [@fluidframework/id-compressor](https://npm.io/package/@fluidframework/id-compressor.md) ~3.1.0 - [@fluidframework/core-interfaces](https://npm.io/package/@fluidframework/core-interfaces.md) ~3.1.0 - [@fluidframework/driver-definitions](https://npm.io/package/@fluidframework/driver-definitions.md) ~3.1.0 - [@fluidframework/runtime-definitions](https://npm.io/package/@fluidframework/runtime-definitions.md) ~3.1.0 - [@fluidframework/container-definitions](https://npm.io/package/@fluidframework/container-definitions.md) ~3.1.0 ## Recent versions - 3.1.0 (latest) — 2026-09-16 - 2.118.1 (rc) — 2026-09-08 - 2.116.0-416006 (dev) — 2026-08-11 - 2.0.0-internal.8.0.8 (canary) — 2024-03-20 - 2.0.0-dev-rc.1.0.0.225277 (next) — 2023-12-20 - 3.0.2 — 2026-09-11 - 3.0.1 — 2026-09-09 - 3.0.0 — 2026-09-04 - 2.118.0 — 2026-09-04 - 2.117.0 — 2026-08-28 - 2.116.1 — 2026-08-26 - 2.116.0 — 2026-08-18 - 2.115.0 — 2026-08-10 - 2.114.0 — 2026-08-03 - 2.113.1 — 2026-07-29 - … 672 more at https://npm.io/package/@fluidframework/datastore-definitions/versions ## README # @fluidframework/datastore-definitions Interface `IFluidDataStoreRuntime` specifies the data store developer API. ## 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: ```bash npm i @fluidframework/datastore-definitions ``` ## Importing from this package This package uses [package.json exports](https://nodejs.org/api/packages.html#exports) to separate APIs by support level. For information about the support guarantees, read [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels). Import the `public` APIs from `@fluidframework/datastore-definitions`. Import the `legacy` APIs from `@fluidframework/datastore-definitions/legacy`. ## API Documentation Read the **@fluidframework/datastore-definitions** API documentation at . ## Capabilities exposed on `IFluidDataStoreRuntime` _TODO: The full set of functionality is under review_ - DDS creation and management APIs - Container info and states (connection state, documentId, quorum, audience, etc.) - Loader - Op/Signal submission - Snapshotting - DeltaManager - Blob Management API. ### Signals Signals provide a transient data channel for data (any serializable payload) that doesn't need to be persisted in the op stream. Use signals where possible to avoid storing unnecessary ops, e.g. to transmit presence status during a collaborative session. Signals are not persisted, ordered, or guaranteed. If a client is behind, the op state can be behind the signal state. For this reason people usually stick the currentSeq on the signal, so other clients can wait to process if they are behind. You can send a signal via the container or data store runtime. The container will emit the signal event on all signals, but a data store will emit the signal event only on signals emitted on that data store runtime. ## 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](https://nodejs.org/en/about/previous-releases). - Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule). - 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](https://typescriptdocs.com/release-notes/TypeScript%206.0): - Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options. - Set the build targets (`lib`, `target`) to `ES2022` or later. - Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig). - Fluid Framework does not support [configuration options deprecated in TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0#breaking-changes-and-deprecations-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](https://webpack.js.org/) 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`](https://www.typescriptlang.org/tsconfig#moduleResolution) module resolution. These settings follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/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](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways: - Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions). - [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes. - Review [source code changes](https://github.com/microsoft/FluidFramework/pulls). - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md). For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md). This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/). For questions or comments, contact . 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](https://www.microsoft.com/trademarks). 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](https://fluidframework.com/docs/) for information about Fluid Framework concepts and APIs. To request information that the documentation does not contain, [create an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md). ## 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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. --- _Source: https://npm.io/package/@fluidframework/datastore-definitions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._