# Fluid Framework v2.30.0 ## Contents - [🌳 SharedTree DDS Changes](#-sharedtree-dds-changes) - [TreeBranchEvents now exposes the rootChanged event (#24014)](#treebranchevents-now-exposes-the-rootchanged-event-24014) - [New SchemaFactoryAlpha.scopedFactory method (#23987)](#new-schemafactoryalphascopedfactory-method-23987) - [Rules regarding how and when lazy schema references are resolved have been clarified (#24030)](#rules-regarding-how-and-when-lazy-schema-references-are-resolved-have-been-clarified-24030) - [Alpha APIs for replacing handles in export formats have been redesigned (#24061)](#alpha-apis-for-replacing-handles-in-export-formats-have-been-redesigned-24061) - [⚠️ Deprecations](#️-deprecations) - [IContainer.getContainerPackageInfo() is now deprecated (#23840)](#icontainergetcontainerpackageinfo-is-now-deprecated-23840) - [Legacy API Changes](#legacy-api-changes) - [Unnecessary exports are now removed from container-runtime (#23981)](#unnecessary-exports-are-now-removed-from-container-runtime-23981) - [The process and processDocumentSchemaOp functions have been removed (#24018)](#the-process-and-processdocumentschemaop-functions-have-been-removed-24018) - [Deprecated ILoaderOptions have been removed (#24046)](#deprecated-iloaderoptions-have-been-removed-24046) - [Other Changes](#other-changes) - [The OrderedEditSet interface now has a getLocalEdits method (#23244)](#the-orderededitset-interface-now-has-a-getlocaledits-method-23244) ## 🌳 SharedTree DDS Changes ### TreeBranchEvents now exposes the rootChanged event ([#24014](https://github.com/microsoft/FluidFramework/issues/24014)) `TreeBranchEvents` now includes the `rootChanged` event from `TreeViewEvents`. #### Change details Commit: [`702a08a`](https://github.com/microsoft/FluidFramework/commit/702a08af83206c21e1016ca47051052fa8554aa5) Affected packages: - fluid-framework - @fluidframework/tree [⬆️ Table of contents](#contents) ### New SchemaFactoryAlpha.scopedFactory method ([#23987](https://github.com/microsoft/FluidFramework/issues/23987)) The [`SchemaFactoryAlpha.scopedFactory`](https://fluidframework.com/docs/api/fluid-framework/schemafactoryalpha-class) method has been added, providing an easy way to create a new `SchemaFactory` with a nested scope string. #### Change details Commit: [`cddd513`](https://github.com/microsoft/FluidFramework/commit/cddd5139c3e070ef26db55331528435a99c0a1b1) Affected packages: - fluid-framework - @fluidframework/tree [⬆️ Table of contents](#contents) ### Rules regarding how and when lazy schema references are resolved have been clarified ([#24030](https://github.com/microsoft/FluidFramework/issues/24030)) A lazy schema reference is a [LazyItem](https://fluidframework.com/docs/api/fluid-framework/lazyitem-typealias) referencing a [TreeNodeSchema](https://fluidframework.com/docs/api/fluid-framework/treenodeschema-typealias). They typically look like `() => MySchema` and are used when a [forward reference](https://en.wikipedia.org/wiki/Forward_declaration#Forward_reference) from one schema to another is required (including but not limited to recursive and co-recursive schema). [TreeViewConfiguration](https://fluidframework.com/docs/api/fluid-framework/treeviewconfiguration-class#_constructor_-constructor) now documents its significance with respect to lazy schema references. Additionally some implicit assumptions like no modifications of [AllowedTypes](https://fluidframework.com/docs/api/fluid-framework/allowedtypes-typealias) after resolving of lazy schema references have been enforced (such modifications would previously cause undefined behavior in the future, and now an error is thrown when trying to modify them). `evaluateLazySchema` has been added as an `@alpha` API that is now consistently used by all internal code when evaluating lazy schema references. This ensures consistent behavior and error reporting, but also adds caching. Therefore it is now supported for applications to have lazy schema references which compute the schema when invoked, without having to implement their own caching as long as those applications use `evaluateLazySchema` anytime they need to evaluate a lazy schema reference. #### Change details Commit: [`23f3279`](https://github.com/microsoft/FluidFramework/commit/23f32794dbd3672dcc18e2a9ba2f16f4bf1241f0) Affected packages: - fluid-framework - @fluidframework/tree [⬆️ Table of contents](#contents) ### Alpha APIs for replacing handles in export formats have been redesigned ([#24061](https://github.com/microsoft/FluidFramework/issues/24061)) The various import and export [`VerboseTree`](https://fluidframework.com/docs/api/fluid-framework/verbosetree-typealias) and [`ConciseTree`](https://fluidframework.com/docs/api/fluid-framework/concisetree-typealias) APIs no longer include `valueConverter` options. Instead the resulting tree can be further processed to do any desired replacements. The following `@alpha` APIs have been added to assist with this: 1. `cloneWithReplacements` 2. `replaceHandles` 3. `replaceConciseTreeHandles` 4. `replaceVerboseTreeHandles` #### Change details Commit: [`34b319c`](https://github.com/microsoft/FluidFramework/commit/34b319cae7a78db5530dc898689e2eb846f1419f) Affected packages: - @fluidframework/tree - fluid-framework [⬆️ Table of contents](#contents) ## ⚠️ Deprecations ### IContainer.getContainerPackageInfo() is now deprecated ([#23840](https://github.com/microsoft/FluidFramework/issues/23840)) The `IContainer.getContainerPackageInfo()` function is now deprecated. This API will be removed in version 2.40.0. Use `IFluidCodeDetails.package` returned by `IContainer.getLoadedCodeDetails()` instead. See [issue #23898](https://github.com/microsoft/FluidFramework/issues/23898) for details. #### Change details Commit: [`521be72`](https://github.com/microsoft/FluidFramework/commit/521be726198a1f88f4f8f06c0f273528a49d2957) Affected packages: - @fluidframework/container-definitions - @fluidframework/container-loader [⬆️ Table of contents](#contents) ## Legacy API Changes ### Unnecessary exports are now removed from container-runtime ([#23981](https://github.com/microsoft/FluidFramework/issues/23981)) The following types in the @fluidframework/container-runtime are now removed. These types are unnecessary for external users of this package. - currentDocumentVersionSchema - DeletedResponseHeaderKey - DocumentSchemaValueType - DocumentsSchemaController - GCFeatureMatrix - GCNodeType - GCVersion - IBlobManagerLoadInfo - ICancellableSummarizerController - ICancellationToken - IConnectableRuntime - IContainerRuntimeMetadata - ICreateContainerMetadata - IDocumentSchema - IDocumentSchemaChangeMessage - IDocumentSchemaCurrent - IDocumentSchemaFeatures - IGCMetadata - IGCStats - IMarkPhaseStats - IRefreshSummaryAckOptions - ISerializedElection - ISubmitSummaryOptions - ISummarizerInternalsProvider - ISummarizerRuntime - ISummaryCancellationToken - ISummaryMetadataMessage - ISweepPhaseStats - Summarizer #### Change details Commit: [`74896b9`](https://github.com/microsoft/FluidFramework/commit/74896b92e8878911e9e4874a8ac45e659a293110) Affected packages: - @fluidframework/container-runtime [⬆️ Table of contents](#contents) ### The process and processDocumentSchemaOp functions have been removed ([#24018](https://github.com/microsoft/FluidFramework/issues/24018)) `process` has been replaced by `processMessages` from the following: - `FluidDataStoreRuntime` - `IDeltaHandler` - `IFluidDataStoreChannel` - `MockFluidDataStoreRuntime` - `MockDeltaConnection` `processDocumentSchemaOp` has been replaced by `processDocumentSchemaMessages` from `DocumentsSchemaController`. See the [deprecation release note](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.5.0#user-content-the-process-function-on-ifluiddatastorechannel-ideltahandler-mockfluiddatastoreruntime-and-mockdeltaconnection-is-now-deprecated-22840) for more details. #### Change details Commit: [`bc35d54`](https://github.com/microsoft/FluidFramework/commit/bc35d543d58c7e4bf28944b09d645cc26bf28a29) Affected packages: - @fluidframework/container-runtime - @fluidframework/datastore - @fluidframework/datastore-definitions - @fluidframework/runtime-definitions - @fluidframework/test-runtime-utils [⬆️ Table of contents](#contents) ### Deprecated ILoaderOptions have been removed ([#24046](https://github.com/microsoft/FluidFramework/issues/24046)) Previously `ILoaderOptions` exported from `container-loader` was extending the base `ILoaderOptions` defined in `container-definitions` to add an experimental `summarizeProtocolTree` property which was used to test single-commit summaries. The option is no longer required or in use, so the extended version of `ILoaderOptions` is not needed anymore. Use `@fluidframework/container-definitions#ILoaderOptions` instead. #### Change details Commit: [`24b4c8c`](https://github.com/microsoft/FluidFramework/commit/24b4c8cf098b499b9b7cd1ea94c2bf627e259956) Affected packages: - @fluidframework/container-loader [⬆️ Table of contents](#contents) ## Other Changes ### The OrderedEditSet interface now has a getLocalEdits method ([#23244](https://github.com/microsoft/FluidFramework/issues/23244)) Previously, `EditLog` was imported to cast to this type for access to the `getLocalEdits` method. In addition, the `./test/EditLog` export has been removed. #### Change details Commit: [`429c0b7`](https://github.com/microsoft/FluidFramework/commit/429c0b717f37d18da0311dd69fcfc3bd10fea13c) Affected packages: - @fluid-experimental/tree [⬆️ Table of contents](#contents) ### 🛠️ Start Building Today! Please continue to engage with us on GitHub [Discussion](https://github.com/microsoft/FluidFramework/discussions) and [Issue](https://github.com/microsoft/FluidFramework/issues) pages as you adopt Fluid Framework!