# @fluidframework/driver-definitions ## 2.110.0 Dependency updates only. ## 2.103.0 Dependency updates only. ## 2.102.0 Dependency updates only. ## 2.101.0 Dependency updates only. ## 2.100.0 ### Minor Changes - Node 22 is now the minimum supported Node.js version ([#27116](https://github.com/microsoft/FluidFramework/pull/27116)) [e8214d29663](https://github.com/microsoft/FluidFramework/commit/e8214d29663f5ee98d737daed82506a25d8de8d0) All Fluid Framework client packages now require Node.js 22 or later. This aligns with the standing Node upgrade policy as Node 20 reaches end-of-life on April 30, 2026. ## 2.93.0 Dependency updates only. ## 2.92.0 Dependency updates only. ## 2.91.0 Dependency updates only. ## 2.90.0 Dependency updates only. ## 2.83.0 Dependency updates only. ## 2.82.0 Dependency updates only. ## 2.81.0 Dependency updates only. ## 2.80.0 ### Minor Changes - Added layerIncompatibilityError to FluidErrorTypes, ContainerErrorTypes, DriverErrorTypes and OdspErrorTypes ([#26068](https://github.com/microsoft/FluidFramework/pull/26068)) [a8532bdd903](https://github.com/microsoft/FluidFramework/commit/a8532bdd903626524f17d2ec650d8904046e5308) The Fluid error type `layerIncompatibilityError` is added to `FluidErrorTypes` and is now @legacy @beta. It is also added to `ContainerErrorTypes`, `DriverErrorTypes` and `OdspErrorTypes` which extend `FluidErrorTypes`. `layerIncompatibilityError` was added as @legacy @alpha in version 2.72.0. The corresponding interface `ILayerIncompatibilityError` for errors of type `layerIncompatibilityError` is now also @legacy @beta. See [this issue](https://github.com/microsoft/FluidFramework/issues/25813) for more details. ## 2.74.0 Dependency updates only. ## 2.73.0 Dependency updates only. ## 2.72.0 Dependency updates only. ## 2.71.0 Dependency updates only. ## 2.70.0 Dependency updates only. ## 2.63.0 Dependency updates only. ## 2.62.0 ### Minor Changes - Move IPersistedCache types to driver-definitions ([#25518](https://github.com/microsoft/FluidFramework/pull/25518)) [54fca68d91](https://github.com/microsoft/FluidFramework/commit/54fca68d91aeb40bdef14b1fe8b8f3c28168b6de) In an effort to decouple the driver web cache from the odsp driver a number of types have been moved from `@fluidframework/odsp-driver-definitions` to `@fluidframework/driver-definitions`. The moved types have been deprecated in `@fluidframework/odsp-driver-definitions`, and any usages should be moved to `@fluidframework/driver-definitions`. The moved types are: - `IEntry` - `IFileEntry` - `ICacheEntry` - `IPersistedCache` ## 2.61.0 Dependency updates only. ## 2.60.0 Dependency updates only. ## 2.53.0 Dependency updates only. ## 2.52.0 Dependency updates only. ## 2.51.0 Dependency updates only. ## 2.50.0 Dependency updates only. ## 2.43.0 ### Minor Changes - The reason parameter on the disconnect event is now optional to allow for clean, non-error disconnections ([#24840](https://github.com/microsoft/FluidFramework/pull/24840)) [82a1c5a1362](https://github.com/microsoft/FluidFramework/commit/82a1c5a1362d3362886bdcc12859ce60a2744bdb) To enable better handling of intentional disconnects (for example [`Container.dispose()`](https://fluidframework.com/docs/api/container-loader/container/dispose)), the `reason` parameter of the `disconnect` event on [`IDocumentDeltaConnectionEvents`](https://fluidframework.com/docs/api/driver-definitions/idocumentdeltaconnectionevents) is being deprecated as a required parameter. In a future release, the `reason` parameter will become optional. **Old signature:** ```typescript listener: (reason: IAnyDriverError) => void ``` **New signature:** ```typescript listener: (reason?: IAnyDriverError) => void ``` Developers with listeners for the `disconnect` event should update their implementations to handle cases where the `reason` parameter is `undefined`. This indicates a clean disconnect, which should not be treated as an error. The breaking change is scheduled to be released in version **2.60**. ## 2.42.0 Dependency updates only. ## 2.41.0 Dependency updates only. ## 2.40.0 Dependency updates only. ## 2.33.0 Dependency updates only. ## 2.32.0 Dependency updates only. ## 2.31.0 Dependency updates only. ## 2.30.0 Dependency updates only. ## 2.23.0 Dependency updates only. ## 2.22.0 Dependency updates only. ## 2.21.0 Dependency updates only. ## 2.20.0 Dependency updates only. ## 2.13.0 Dependency updates only. ## 2.12.0 Dependency updates only. ## 2.11.0 Dependency updates only. ## 2.10.0 Dependency updates only. ## 2.5.0 Dependency updates only. ## 2.4.0 Dependency updates only. ## 2.3.0 Dependency updates only. ## 2.2.0 Dependency updates only. ## 2.1.0 Dependency updates only. ## 2.0.0-rc.5.0.0 ### Minor Changes - Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6) Update package implementations to use TypeScript 5.4.5. - fluid-framework: Remove some types from `@public` that are not needed ([#21326](https://github.com/microsoft/FluidFramework/pull/21326)) [b629cb80b0](https://github.com/microsoft/FluidFramework/commit/b629cb80b0e5ecdc750270807f77a0e30fab4559) Mark the following APIs `@alpha` instead of `@public`: - IBranchOrigin - ISequencedDocumentMessage - ISignalMessage - ISignalMessageBase - ITrace - Update to ES 2022 ([#21292](https://github.com/microsoft/FluidFramework/pull/21292)) [68921502f7](https://github.com/microsoft/FluidFramework/commit/68921502f79b1833c4cd6d0fe339bfb126a712c7) Update tsconfig to target ES 2022. ## 2.0.0-rc.4.0.0 ### Minor Changes - Make several driver types no longer public [b7ad7d0b55](https://github.com/microsoft/FluidFramework/commit/b7ad7d0b55884dd8954abf7c398e518838b9bda0) Move the following types from `@public` to `@alpha`: - ITokenClaims - IDocumentMessage - IClientConfiguration - IAnyDriverError - IDriverErrorBase - DriverErrorTypes `DriverErrorTypes` is no longer exported from the `fluid-framework` package. ## 2.0.0-rc.3.0.0 ### Major Changes - Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae) Fluid Framework packages have been updated to use the [package.json "exports" field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both TypeScript types and implementation code. This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json: - `"moduleResolution": "Node16"` with `"module": "Node16"` - `"moduleResolution": "Bundler"` with `"module": "ESNext"` We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable for use with modern versions of Node.js _and_ Bundlers. [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information regarding the module and moduleResolution options. **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.** ### Minor Changes - driver-definitions: update submitSignal content type to string [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae) Change IDocumentDeltaConnection.submitSignal's content argument type to string which represents actual/known use. ## 2.0.0-rc.2.0.0 ### Minor Changes - driver-definitions: Deprecate `ISnapshotContents` ([#19314](https://github.com/microsoft/FluidFramework/issues/19314)) [fc731b69de](https://github.com/microsoft/FluidFramework/commits/fc731b69deed4a2987e9b97d8918492d689bafbc) `ISnapshotContents` is deprecated. It has been replaced with `ISnapshot`. - driver-definitions: repositoryUrl removed from IDocumentStorageService ([#19522](https://github.com/microsoft/FluidFramework/issues/19522)) [90eb3c9d33](https://github.com/microsoft/FluidFramework/commits/90eb3c9d33d80e24caa1393a50f414c5602f6aa3) The `repositoryUrl` member of `IDocumentStorageService` was unused and always equal to the empty string. It has been removed. - Deprecated error-related enums have been removed ([#19067](https://github.com/microsoft/FluidFramework/issues/19067)) [59793302e5](https://github.com/microsoft/FluidFramework/commits/59793302e56784cfb6ace0e6469345f3565b3312) Error-related enums `ContainerErrorType`, `DriverErrorType`, `OdspErrorType` and `RouterliciousErrorType` were previously deprecated and are now removed. There are replacement object-based enumerations of `ContainerErrorTypes`, `DriverErrorTypes`, `OdspErrorTypes` and `RouterliciousErrorTypes`. Refer to the release notes of [Fluid Framework version 2.0.0-internal.7.0.0](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.7.0.0) for details on the replacements. - container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2) Added `containerMetadata` prop on IContainer interface. - runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2) The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package. ## 2.0.0-rc.1.0.0 ### Minor Changes - Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902) The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0) - @fluidframework/gitresources - @fluidframework/server-kafka-orderer - @fluidframework/server-lambdas - @fluidframework/server-lambdas-driver - @fluidframework/server-local-server - @fluidframework/server-memory-orderer - @fluidframework/protocol-base - @fluidframework/server-routerlicious - @fluidframework/server-routerlicious-base - @fluidframework/server-services - @fluidframework/server-services-client - @fluidframework/server-services-core - @fluidframework/server-services-ordering-kafkanode - @fluidframework/server-services-ordering-rdkafka - @fluidframework/server-services-ordering-zookeeper - @fluidframework/server-services-shared - @fluidframework/server-services-telemetry - @fluidframework/server-services-utils - @fluidframework/server-test-utils - tinylicious - Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902) The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310) ## 2.0.0-internal.8.0.0 Dependency updates only. ## 2.0.0-internal.7.4.0 Dependency updates only. ## 2.0.0-internal.7.3.0 Dependency updates only. ## 2.0.0-internal.7.2.0 Dependency updates only. ## 2.0.0-internal.7.1.0 Dependency updates only. ## 2.0.0-internal.7.0.0 ### Major Changes - odsp-driver: Load container in readonly mode when driver throws DriverErrorType.outOfStorage [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e) Handle DriverErrorType.outOfStorage error from driver and load the container in readonly mode. Currently there is no handling and when the join session throws this error, the container will get closed. With this we use NoDeltaStream object as connection and load the container in read mode, so that it loads properly. We also notify the that the container is "readonly" through the event on delta manager so that apps can listen to this and show any UX etc. The app can listen to the event like this: ```ts container.deltaManager.on( "readonly", ( readonly?: boolean, readonlyConnectionReason?: { text: string; error?: IErrorBase }, ) => { // error?.errorType will be equal to DriverErrorType.outOfStorage in this case // App logic }, ); ``` - Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e) This included the following changes from the protocol-definitions release: - Updating signal interfaces for some planned improvements. The intention is split the interface between signals submitted by clients to the server and the resulting signals sent from the server to clients. - A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has been added, which will be the typing for signals sent from the client to the server. Both extend a new ISignalMessageBase interface that contains common members. - The @fluidframework/common-definitions package dependency has been updated to version 1.0.0. - routerlicious-driver: remove dead blob aggregation concepts and code [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e) Dead concepts blob aggregation like `aggregateBlobsSmallerThanBytes` and `minBlobSize` have been removed. - Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e) Dependencies on the following Fluid server package have been updated to version 2.0.1: - @fluidframework/gitresources: 2.0.1 - @fluidframework/server-kafka-orderer: 2.0.1 - @fluidframework/server-lambdas: 2.0.1 - @fluidframework/server-lambdas-driver: 2.0.1 - @fluidframework/server-local-server: 2.0.1 - @fluidframework/server-memory-orderer: 2.0.1 - @fluidframework/protocol-base: 2.0.1 - @fluidframework/server-routerlicious: 2.0.1 - @fluidframework/server-routerlicious-base: 2.0.1 - @fluidframework/server-services: 2.0.1 - @fluidframework/server-services-client: 2.0.1 - @fluidframework/server-services-core: 2.0.1 - @fluidframework/server-services-ordering-kafkanode: 2.0.1 - @fluidframework/server-services-ordering-rdkafka: 2.0.1 - @fluidframework/server-services-ordering-zookeeper: 2.0.1 - @fluidframework/server-services-shared: 2.0.1 - @fluidframework/server-services-telemetry: 2.0.1 - @fluidframework/server-services-utils: 2.0.1 - @fluidframework/server-test-utils: 2.0.1 - tinylicious: 2.0.1 - Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e) The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6. ## 2.0.0-internal.6.4.0 Dependency updates only. ## 2.0.0-internal.6.3.0 ### Minor Changes - Add new error type enumeration that extends common errors from core-interfaces ([#17078](https://github.com/microsoft/FluidFramework/issues/17078)) [5c4bf0d9c2](https://github.com/microsoft/FluidFramework/commits/5c4bf0d9c224af86d0c2205c67c6e64405fee51c) Deprecates existing `DriverErrorType` enum in favor of the new `DriverErrorTypes` type. ## 2.0.0-internal.6.2.0 ### Minor Changes - Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf) The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now imported from the **@fluidframework/core-interfaces** package: - interface IDisposable - interface IErrorEvent - interface IErrorEvent - interface IEvent - interface IEventProvider - interface ILoggingError - interface ITaggedTelemetryPropertyType - interface ITelemetryBaseEvent - interface ITelemetryBaseLogger - interface ITelemetryErrorEvent - interface ITelemetryGenericEvent - interface ITelemetryLogger - interface ITelemetryPerformanceEvent - interface ITelemetryProperties - type ExtendEventProvider - type IEventThisPlaceHolder - type IEventTransformer - type ReplaceIEventThisPlaceHolder - type ReplaceIEventThisPlaceHolder - type TelemetryEventCategory - type TelemetryEventPropertyType ## 2.0.0-internal.6.1.0 Dependency updates only. ## 2.0.0-internal.6.0.0 ### Major Changes - Remove Interface IFluidResolvedUrl [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a) IFluidResolvedUrl was deprecated and is now removed. All usages should use IResolvedUrl instead - Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a) Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target. ## 2.0.0-internal.5.4.0 Dependency updates only. ## 2.0.0-internal.5.3.0 Dependency updates only. ## 2.0.0-internal.5.2.0 Dependency updates only. ## 2.0.0-internal.5.1.0 Dependency updates only. ## 2.0.0-internal.5.0.0 ### Major Changes - IResolvedUrl equivalent to IFluidResolvedUrl [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2) In @fluidframework/driver-definitions, IResolvedUrlBase and IWebResolvedUrl have now been removed. This makes IResolvedUrl and IFluidResolvedUrl equivalent. Since all ResolvedUrls are now FluidResolvedUrls we no longer need to differentiate them. In @fluidframework/driver-utils isFluidResolvedUrl and ensureFluidResolvedUrl have been removed due to this. ## 2.0.0-internal.4.4.0 Dependency updates only. ## 2.0.0-internal.4.1.0 Dependency updates only.