|
| 1 | +<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. --> |
| 2 | + |
| 3 | +# Fluid Framework v2.21.0 |
| 4 | + |
| 5 | +## Contents |
| 6 | + |
| 7 | +- [🐛 Bug Fixes](#-bug-fixes) |
| 8 | + - [SharedMap, SharedIntervalCollection and AttributableMap now throw an error when they encounter unrecognized Ops (#23659)](#sharedmap-sharedintervalcollection-and-attributablemap-now-throw-an-error-when-they-encounter-unrecognized-ops-23659) |
| 9 | +- [⚠️ Deprecations](#️-deprecations) |
| 10 | + - [Many unnecessary exports have been deprecated in the container-runtime package (#23607)](#many-unnecessary-exports-have-been-deprecated-in-the-container-runtime-package-23607) |
| 11 | + - [The IContainerContext.supportedFeatures property is now deprecated (#22877)](#the-icontainercontextsupportedfeatures-property-is-now-deprecated-22877) |
| 12 | + - [ITokenClaims and ScopeType types are now deprecated (#23703)](#itokenclaims-and-scopetype-types-are-now-deprecated-23703) |
| 13 | + |
| 14 | +## 🐛 Bug Fixes |
| 15 | + |
| 16 | +### SharedMap, SharedIntervalCollection and AttributableMap now throw an error when they encounter unrecognized Ops ([#23659](https://github.com/microsoft/FluidFramework/issues/23659)) |
| 17 | + |
| 18 | +To avoid future versions of DDSes with new Op types causing silent data corruption and de-sync between clients, DDSes should error when unable to apply an Op. This prevents data loss and corruption scenarios like a summary client using old code discarding all Ops from newer clients. |
| 19 | + |
| 20 | +If updating applications using SharedMap, SharedIntervalCollection and AttributableMap use a newer version which adds Ops types in the future, old clients which are old enough to be from before this fix will ignore the new ops instead of erroring. Therefore it may be useful to ensure this update is deployed as widely as possible before migrating any to newer versions which add new op formats to these DDSes. |
| 21 | + |
| 22 | +#### Change details |
| 23 | + |
| 24 | +Commit: [`3dd4208`](https://github.com/microsoft/FluidFramework/commit/3dd4208dd329a9200c4405f07e302b0ab1ff6159) |
| 25 | + |
| 26 | +Affected packages: |
| 27 | + |
| 28 | +- @fluid-experimental/attributable-map |
| 29 | +- @fluidframework/map |
| 30 | +- @fluidframework/sequence |
| 31 | + |
| 32 | +[⬆️ Table of contents](#contents) |
| 33 | + |
| 34 | +## ⚠️ Deprecations |
| 35 | + |
| 36 | +### Many unnecessary exports have been deprecated in the container-runtime package ([#23607](https://github.com/microsoft/FluidFramework/issues/23607)) |
| 37 | + |
| 38 | +The following types in the `@fluidframework/container-runtime` package are now deprecated. These types are unnecessary for external users of this package. |
| 39 | + |
| 40 | +- currentDocumentVersionSchema |
| 41 | +- DeletedResponseHeaderKey |
| 42 | +- DocumentSchemaValueType |
| 43 | +- DocumentsSchemaController |
| 44 | +- GCFeatureMatrix |
| 45 | +- GCNodeType |
| 46 | +- GCVersion |
| 47 | +- IBlobManagerLoadInfo |
| 48 | +- ICancellableSummarizerController |
| 49 | +- ICancellationToken |
| 50 | +- IConnectableRuntime |
| 51 | +- IContainerRuntimeMetadata |
| 52 | +- ICreateContainerMetadata |
| 53 | +- IDocumentSchema |
| 54 | +- IDocumentSchemaChangeMessage |
| 55 | +- IDocumentSchemaCurrent |
| 56 | +- IDocumentSchemaFeatures |
| 57 | +- IGCMetadata |
| 58 | +- IGCStats |
| 59 | +- IMarkPhaseStats |
| 60 | +- IRefreshSummaryAckOptions |
| 61 | +- ISerializedElection |
| 62 | +- ISubmitSummaryOptions |
| 63 | +- ISummarizerInternalsProvider |
| 64 | +- ISummarizerRuntime |
| 65 | +- ISummaryCancellationToken |
| 66 | +- ISummaryMetadataMessage |
| 67 | +- ISweepPhaseStats |
| 68 | +- Summarizer |
| 69 | + |
| 70 | +#### Change details |
| 71 | + |
| 72 | +Commit: [`3da5b42`](https://github.com/microsoft/FluidFramework/commit/3da5b427ef406799abade04196e43bb6d66d898d) |
| 73 | + |
| 74 | +Affected packages: |
| 75 | + |
| 76 | +- @fluidframework/container-runtime |
| 77 | + |
| 78 | +[⬆️ Table of contents](#contents) |
| 79 | + |
| 80 | +### The IContainerContext.supportedFeatures property is now deprecated ([#22877](https://github.com/microsoft/FluidFramework/issues/22877)) |
| 81 | + |
| 82 | +The `IContainerContext.supportedFeatures` optional property was used internally to communicate features supported by the Loader layer to the Runtime layer. This has since been replaced with functionality that is not exposed externally. |
| 83 | + |
| 84 | +#### Change details |
| 85 | + |
| 86 | +Commit: [`4c06412`](https://github.com/microsoft/FluidFramework/commit/4c06412bb365d680430f83b87c456d132d9da1be) |
| 87 | + |
| 88 | +Affected packages: |
| 89 | + |
| 90 | +- @fluidframework/container-definitions |
| 91 | + |
| 92 | +[⬆️ Table of contents](#contents) |
| 93 | + |
| 94 | +### ITokenClaims and ScopeType types are now deprecated ([#23703](https://github.com/microsoft/FluidFramework/issues/23703)) |
| 95 | + |
| 96 | +The `ITokenClaims` and `ScopeType` types in `@fluidframework/azure-client` are now deprecated. These were isolated types re-exported for convenience but they do not directly interact with typical azure-client APIs. |
| 97 | + |
| 98 | +See [issue #23702](https://github.com/microsoft/FluidFramework/issues/23702) for details and alternatives. |
| 99 | + |
| 100 | +#### Change details |
| 101 | + |
| 102 | +Commit: [`f679945`](https://github.com/microsoft/FluidFramework/commit/f67994577597aae6dc8b42f3c6557c744adc0964) |
| 103 | + |
| 104 | +Affected packages: |
| 105 | + |
| 106 | +- @fluidframework/azure-client |
| 107 | + |
| 108 | +[⬆️ Table of contents](#contents) |
| 109 | + |
| 110 | +### 🛠️ Start Building Today! |
| 111 | + |
| 112 | +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! |
0 commit comments