# @fluidframework/aqueduct > A set of implementations for Fluid Framework interfaces. Latest version **3.1.0** (published 2026-09-16) · MIT license · 0 weekly downloads ## Install ```sh npm install @fluidframework/aqueduct pnpm add @fluidframework/aqueduct yarn add @fluidframework/aqueduct bun add @fluidframework/aqueduct ``` ## 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 | 16 | | Unpacked size | 447.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 4946 | | Author | Microsoft and contributors | | Maintainers | ms-fluid-bot, microsoft-oss-releases, microsoft1es | ## Links - npm: https://www.npmjs.com/package/@fluidframework/aqueduct - 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/aqueduct ## Dependencies (16) - [@fluidframework/map](https://npm.io/package/@fluidframework/map.md) ~3.1.0 - [@fluidframework/tree](https://npm.io/package/@fluidframework/tree.md) ~3.1.0 - [@fluidframework/datastore](https://npm.io/package/@fluidframework/datastore.md) ~3.1.0 - [@fluidframework/core-utils](https://npm.io/package/@fluidframework/core-utils.md) ~3.1.0 - [@fluidframework/synthesize](https://npm.io/package/@fluidframework/synthesize.md) ~3.1.0 - [@fluid-internal/client-utils](https://npm.io/package/@fluid-internal/client-utils.md) ~3.1.0 - [@fluidframework/runtime-utils](https://npm.io/package/@fluidframework/runtime-utils.md) ~3.1.0 - [@fluidframework/core-interfaces](https://npm.io/package/@fluidframework/core-interfaces.md) ~3.1.0 - [@fluidframework/request-handler](https://npm.io/package/@fluidframework/request-handler.md) ~3.1.0 - [@fluidframework/telemetry-utils](https://npm.io/package/@fluidframework/telemetry-utils.md) ~3.1.0 - [@fluidframework/container-runtime](https://npm.io/package/@fluidframework/container-runtime.md) ~3.1.0 - [@fluidframework/shared-object-base](https://npm.io/package/@fluidframework/shared-object-base.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 - [@fluidframework/datastore-definitions](https://npm.io/package/@fluidframework/datastore-definitions.md) ~3.1.0 - [@fluidframework/container-runtime-definitions](https://npm.io/package/@fluidframework/container-runtime-definitions.md) ~3.1.0 ## Recent versions - 3.1.0 (latest) — 2026-09-16 - 2.118.1 (rc) — 2026-09-09 - 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 - … 671 more at https://npm.io/package/@fluidframework/aqueduct/versions ## README # @fluidframework/aqueduct ## 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/aqueduct ``` ## 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/aqueduct`. Import the `legacy` APIs from `@fluidframework/aqueduct/legacy`. ## API Documentation Read the **@fluidframework/aqueduct** API documentation at . ![Aqueduct](https://publicdomainvectors.org/photos/johnny-automatic-Roman-aqueducts.png) The Aqueduct is a library for building Fluid objects and Fluid containers within the Fluid Framework. Its goal is to provide a thin base layer over the existing Fluid Framework interfaces that allows developers to get started quickly. ## Fluid object development Fluid object development consists of developing the data object and the corresponding data object factory. The data object defines the logic of your Fluid object, whereas the data object factory defines how to initialize your object. ## Data object development `DataObject` and `PureDataObject` are the two base classes provided by the library. ### DataObject The [DataObject][] class extends [PureDataObject](#puredataobject) and provides the following additional functionality: - A `root` SharedDirectory that makes creating and storing distributed data structures and objects easy. - Blob storage implementation that makes it easier to store and retrieve blobs. **Note:** Most developers will want to use the `DataObject` as their base class to extend. ### PureDataObject [PureDataObject][] provides the following functionality: - Basic set of interface implementations to be loadable in a Fluid container. - Functions for managing the Fluid object lifecycle. - `initializingFirstTime(props: S)` - called only the first time a Fluid object is initialized and only on the first client on which it loads. - `initializingFromExisting()` - called every time except the first time a Fluid object is initialized; that is, every time an instance is loaded from a previously created instance. - `hasInitialized()` - called every time after `initializingFirstTime` or `initializingFromExisting` executes - Helper functions for creating and getting other data objects in the same container. **Note:** You probably don't want to inherit from this data object directly unless you are creating another base data object class. If you have a data object that doesn't use distributed data structures you should use Container Services to manage your object. ### DataObject example In the below example we have a simple data object, _Clicker_, that will render a value alongside a button the the page. Every time the button is pressed the value will increment. Because this data object renders to the DOM it also extends `IFluidHTMLView`. ```jsx export class Clicker extends DataObject implements IFluidHTMLView { public static get Name() { return "clicker"; } public get IFluidHTMLView() { return this; } private _counter: SharedCounter | undefined; protected async initializingFirstTime() { const counter = SharedCounter.create(this.runtime); this.root.set("clicks", counter.handle); } protected async hasInitialized() { const counterHandle = this.root.get>("clicks"); this._counter = await counterHandle.get(); } public render(div: HTMLElement) { ReactDOM.render( , div, ); return div; } private get counter() { if (this._counter === undefined) { throw new Error("SharedCounter not initialized"); } return this._counter; } } ``` ## DataObjectFactory development The `DataObjectFactory` is used to create a Fluid object and to initialize a data object within the context of a Container. The factory can live alongside a data object or within a different package. The `DataObjectFactory` defines the distributed data structures used within the data object as well as any Fluid objects it depends on. The Aqueduct offers a factory for each of the data objects provided. ### More details - [DataObjectFactory][] - [PureDataObjectFactory][] ### DataObjectFactory example In the below example we build a `DataObjectFactory` for the [Clicker](#dataobject-example) example above. To build a `DataObjectFactory`, we need to provide factories for the distributed data structures we are using inside of our `DataObject`. In the above example we store a handle to a `SharedCounter` in `this.root` to track our `"clicks"`. The `DataObject` comes with the `SharedDirectory` (`this.root`) already initialized, so we just need to add the factory for `SharedCounter`. ```typescript export const ClickerInstantiationFactory = new DataObjectFactory({ type: Clicker.Name, ctor: Clicker, sharedObjects: [SharedCounter.getFactory()], }); ``` This factory can then create Clickers when provided a creating instance context. ```typescript const myClicker = ClickerInstantiationFactory.createInstance(this.context) as Clicker; ``` ### Providers in data objects The `this.providers` object on `PureDataObject` is initialized in the constructor and is generated based on Providers provided by the Container. To access a specific provider you need to: 1. Define the type in the generic on `PureDataObject`/`DataObject` 2. Add the symbol to your factory (see [DataObjectFactory Example](#dataobjectfactory-example) below) In the below example we have an `IFluidUserInfo` interface that looks like this: ```typescript interface IFluidUserInfo { readonly userCount: number; } ``` On our example we want to declare that we want the `IFluidUserInfo` Provider and get the `userCount` if the Container provides the `IFluidUserInfo` provider. ```typescript export class MyExample extends DataObject { protected async initializingFirstTime() { const userInfo = await this.providers.IFluidUserInfo; if(userInfo) { console.log(userInfo.userCount); } } } // Note: we have to define the symbol to the IFluidUserInfo that we declared above. This is compile time checked. export const ClickerInstantiationFactory = new DataObjectFactory({ type: Clicker.Name ctor: Clicker, optionalProviders: { IFluidUserInfo }, // Provider Symbols see below }); ``` ## Container development A Container is a collection of data objects and functionality that produce an experience. Containers hold the instances of data objects as well as defining the data objects that can be created within the Container. Because of this data objects cannot be consumed except for when they are within a Container. The Aqueduct library provides the [ContainerRuntimeFactoryWithDefaultDataStore][] that enables you as a container developer to: - Define the registry of data objects that can be created - Declare the default data object - Use provider entries - Declare Container level [Request Handlers](#container-level-request-handlers) ## Container object example In the below example we will write a Container that exposes the above [Clicker](#dataobject-example) using the [Clicker Factory](#dataobjectfactory-example). You will notice below that the Container developer defines the registry name (data object type) of the Fluid object. We also pass in the type of data object we want to be the default. The default data object is created the first time the Container is created. ```typescript export fluidExport = new ContainerRuntimeFactoryWithDefaultDataStore( ClickerInstantiationFactory.type, // Default data object type ClickerInstantiationFactory.registryEntry, // Fluid object registry [], // Provider Entries [], // Request Handler Routes ); ``` ## Container-level request handlers You can provide custom request handlers to the container. These request handlers are injected after system handlers but before the `DataObject` get function. Request handlers allow you to intercept requests made to the container and return custom responses. Consider a scenario where you want to create a random color generator. I could create a RequestHandler that when someone makes a request to the Container for `{url:"color"}` will intercept and return a custom `IResponse` of `{ status:200, type:"text/plain", value:"blue"}`. We use custom handlers to build the Container Services pattern. ## 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. [containerruntimefactorywithdefaultdatastore]: https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/containerRuntimeFactories/containerRuntimeFactoryWithDefaultDataStore.ts [dataobject]: https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/data-objects/dataObject.ts [dataobjectfactory]: https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/data-object-factories/dataObjectFactory.ts [puredataobject]: https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/data-object-factories/pureDataObject.ts [puredataobjectfactory]: https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts --- _Source: https://npm.io/package/@fluidframework/aqueduct · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._