|
| 1 | +1.10.0 / 2026-01-21 |
| 2 | +================== |
| 3 | + |
| 4 | +This release is based on Kotlin 2.3.0 and contains all of the changes from 1.10.0-RC. |
| 5 | +The only additional change is a fix for ProtoBuf packing of Kotlin unsigned types (#3079). |
| 6 | +Big thanks to [KosmX](https://github.com/KosmX) for contributing the fix. |
| 7 | + |
| 8 | +> For your convenience, the changelog for 1.10.0-RC is duplicated below: |
| 9 | +
|
| 10 | +## Stabilization of APIs |
| 11 | + |
| 12 | +kotlinx-serialization 1.10 and subsequent releases will be focused on stabilization of existing APIs. |
| 13 | +The following APIs and configuration options are no longer experimental because they're widely used without any known major issues: |
| 14 | + |
| 15 | +* `Json` configuration options: `decodeEnumsCaseInsensitive`, `allowTrailingComma`, `allowComments`, and `prettyPrintIndent`. (#3100) |
| 16 | +* `@EncodeDefault` annotation and its modes. (#3106) |
| 17 | +* `JsonUnquotedLiteral` constructor function (#2900) |
| 18 | +* `JsonPrimitive` constructor function overloads that accept unsigned types. (#3117) |
| 19 | +* JSON DSL functions on `JsonElement` with `Nothing?` overloads. (#3117) |
| 20 | + |
| 21 | +## Readiness for return value checker |
| 22 | + |
| 23 | +Kotlin 2.3.0 [introduces a new feature](https://kotlinlang.org/docs/whatsnew23.html#unused-return-value-checker) aimed |
| 24 | +at helping you to catch bugs related to the accidentally ignored return value of the function. |
| 25 | +kotlinx-serialization 1.10.0-RC code is fully marked for this feature, meaning that you |
| 26 | +can get warnings for unused function calls like `Json.encodeToString(...)`. |
| 27 | +To get the warnings, the feature has to be enabled in your project as [described here](https://kotlinlang.org/docs/unused-return-value-checker.html#configure-the-unused-return-value-checker). |
| 28 | + |
| 29 | +## Polymorphism improvements |
| 30 | + |
| 31 | +Polymorphic serialization received a couple of improvements in this release: |
| 32 | + |
| 33 | +New `subclassesOfSealed` utility to automatically register sealed subclasses serializers in polymorphic modules (#2201). |
| 34 | +Use it in your `SerializersModule` when configuring a polymorphic hierarchy which contains both abstract and sealed classes. |
| 35 | +[For example](https://github.com/Kotlin/kotlinx.serialization/issues/2199), when root of your hierarchy is an `interface`, but most of your inheritors are `sealed` classes. |
| 36 | +The new function will register all known sealed subclasses for you, so you don’t need to list them one by one. |
| 37 | +This makes writing your `SerializerModule`s much faster and simpler. |
| 38 | +Big thanks to [Paul de Vrieze](https://github.com/pdvrieze) for contributing this feature. |
| 39 | + |
| 40 | +Class discriminator conflict check rework (#3105). |
| 41 | +If a payload already contains a property with the same name as the configured discriminator (for example, `type`), |
| 42 | +it is called a class discriminator conflict. |
| 43 | +To produce a correct output and allow more inputs to be deserialized at the same time, the following changes were made: |
| 44 | +* Conflicts introduced by `JsonNamingStrategy` transformations are now detected during serialization as well and will cause `SerializationException`. |
| 45 | + It also affects non-polymorphic classes. |
| 46 | +* Conflicts from `ClassDisciminatorMode.ALL_JSON_OBJECTS` and `SerializersModuleBuilder.polymorphicDefaultSerializer` are also detected. |
| 47 | +* It is allowed to deserialize such a conflicting key for both sealed and open polymorphic hierarchies. |
| 48 | + Previously, it was possible in the sealed hierarchies alone due to missing assertion. See #1664 for details. |
| 49 | + |
| 50 | +## General improvements |
| 51 | + |
| 52 | +* Add `.serialName` to `MissingFieldException` for clearer diagnostics. (#3114) |
| 53 | +* Generate unique `Automatic-Module-Name` entries for metadata JARs. (#3109) |
| 54 | +* Revised ProGuard rules and added R8 tests. (#3041) |
| 55 | +* CBOR: Improved error message when a byte string/array type mismatch is encountered. (#3052) |
| 56 | + |
| 57 | +## Bugfixes |
| 58 | + |
| 59 | +* Fix the type in the `BIGNUM_NEGATIVE` tag name. (#3090) |
| 60 | +* CBOR: Fix various bugs in the decoder implementation to be more strict and consistent with the specification. |
| 61 | + |
1 | 62 | 1.10.0-RC / 2025-12-18 |
2 | 63 | ================== |
3 | 64 |
|
@@ -29,7 +90,7 @@ Polymorphic serialization received a couple of improvements in this release: |
29 | 90 |
|
30 | 91 | New `subclassesOfSealed` utility to automatically register sealed subclasses serializers in polymorphic modules (#2201). |
31 | 92 | Use it in your `SerializersModule` when configuring a polymorphic hierarchy which contains both abstract and sealed classes. |
32 | | -[For example](https://github.com/Kotlin/kotlinx.serialization/issues/2199), when root of your hierarchy is an `inteface`, but most of your inheritors are `sealed` classes. |
| 93 | +[For example](https://github.com/Kotlin/kotlinx.serialization/issues/2199), when root of your hierarchy is an `interface`, but most of your inheritors are `sealed` classes. |
33 | 94 | The new function will register all known sealed subclasses for you, so you don’t need to list them one by one. |
34 | 95 | This makes writing your `SerializerModule`s much faster and simpler. |
35 | 96 | Big thanks to [Paul de Vrieze](https://github.com/pdvrieze) for contributing this feature. |
|
0 commit comments