Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.0

[renovate[bot]]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
org.jetbrains.kotlinx:kotlinx-serialization-json	1.6.0 -> 1.8.0

---

Release Notes

Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-json)

v1.8.0

==================

This is a release candidate for the next version. It is based on Kotlin 2.1.0 and includes a few new features, as well as bugfixes and improvements:

@JsonIgnoreUnknownKeys annotation

Previously, only global setting JsonBuilder.ignoreUnknownKeys controlled whether Json parser would throw exception if input contained a property that was not declared in a @Serializable class. There were a lot of complaints that this setting is not flexible enough. To address them, we added new @JsonIgnoreUnknownKeys annotation that can be applied on a per-class basis. With this annotation, it is possible to allow unknown properties for annotated classes, while general decoding methods (such as Json.decodeFromString and others) would still reject them for everything else. See details in the corresponding PR.

Stabilization of SerialDescriptor API and @SealedSerializationApi annotation

SerialDescriptor, SerialKind, and related API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. Fortunately, Kotlin 2.1 provides a special mechanism for such a case — SubclassOptInRequired. New kotlinx.serialization.SealedSerializationApi annotation designates APIs as public for use, but closed for implementation — the case for SerialDescriptor, which is a non-sealed interface for technical reasons. Now you can use most of SerialDescriptor and its builders API without the need to opt-in into experimental serialization API. See the PR for more details.

Note: All SerialKinds are stable API now, except PolymorphicKind — we may want to expand it in the future.

Generate Java 8's default method implementations in interfaces

TL;DR This change ensures better binary compatibility in the future for library. You should not experience any difference from it.

kotlinx.serialization library contains a lot of interfaces with default method implementations. Historically, Kotlin compiled a synthetic DefaultImpls class for them. Starting from Kotlin 1.4, it was possible to compile them using as Java 8's default methods to ensure that new methods can still be added to interfaces without the need for implementors to recompile. To preserve binary compatibility with existing clients, a special all-compatbility mode is supported in compiler to generate both default methods and synthetic DefaultImpls class.

Now, kotlinx.serialization finally makes use of this all-compatibility mode, which potentially allows us to add new methods to interfaces such as SerialDescriptor, Encoder, Decoder, etc., without breaking existing clients. This change is expected to have no effect on existing clients, and no action from your side is required. Note that Kotlin 2.2 plans to enable all-compatibility mode by default.

Other bugfixes and improvements

• Correctly skip structures with Cbor.ignoreUnknownKeys setting (#​2873)
• Handle missing system property without NPE (#​2867)
• Fixed keeping INSTANCE field and serializer function for serializable objects in R8 full mode (#​2865)
• Correctly parse invalid numbers in JsonLiteral.long and other extensions (#​2852)
• Correctly handle serial name conflict for different classes in SerializersModule.overwriteWith (#​2856)
• Add inline reified version of encodeToString as a Json member to streamline the experience for newcomers. (#​2853)
• Do not check kind or discriminator collisions for subclasses' polymorphic serializers if Json.classDiscriminatorMode is set to NONE (#​2833)

v1.7.3

==================

This release aims to fix important issues that were discovered in the 1.7.2 release, including the inability to sync certain projects into Android Studio/IntelliJ IDEA and exceptions from custom Uuid serializers.

It uses Kotlin 2.0.20 by default.

• Use explicit kotlin-stdlib and kotlin-test versions from version catalog (#​2818)
• Drop usage of deprecated Any?.freeze() in K/N target (#​2819)
• Check against serialName instead of simpleClassName (#​2802)
• Ignore NoClassDefFoundError when initializing builtins map for serializer() function (#​2803)
• Clarify example for SerializationException (#​2806)

v1.7.2

==================

This release provides several new features, including a major Cbor configuration rework. It uses Kotlin 2.0.20 by default.

Cbor feature set for COSE compliance

This change brings a lot of features to the CBOR format, namely:

• Serial Labels — see @CborLabel annotation and preferCborLabelsOverNames flag.
• Tagging of keys and values — see encode*Tags and verify*Tags set of flags
• Definite length encoding — see useDefiniteLengthEncoding. This flag affects object encoding, since decoding of arrays with definite lenghts is automatically supported.
• Option to globally prefer major type 2 for byte array encoding — see alwaysUseByteString flag.

Since there are quite a lot of flags now, they were restructured to a separate CborConfiguration class, similarly to JsonConfiguration. It is possible to retrieve this configuration from CborEncoder/CborDecoder interfaces in your custom serializers (see their documentation for details).

All of these features make it possible to serialize and parse COSE-compliant CBOR, for example, ISO/IEC 18013-5:2021-compliant mobile driving license data. In case you want to make use of them, there is a predefined Cbor.CoseCompliant instance. However, some canonicalization steps (such as sorting keys) still need to be performed manually.

This functionality was contributed to us by Bernd Prünster.

Keeping generated serializers

One of the most requested features for serialization plugin was to continue to generate a serializer even if a custom one is specified for the class. It allows using a plugin-generated serializer in a fallback or delegate strategy, accessing type structure via descriptor, using default serialization behavior in inheritors that do not use custom serializers.

Starting with this release, you can specify the @KeepGeneratedSerializer annotation on the class declaration to instruct the plugin to continue generating the serializer. In this case, the serializer will be accessible using the .generatedSerializer() function on the class's companion object.

This annotation is currently experimental. Kotlin 2.0.20 or higher is required for this feature to work.

You can check out the examples in the documentation and in the PRs: #​2758, #​2669.

Serializer for kotlin.uuid.Uuid

Kotlin 2.0.20 added a common class to represent UUIDs in a multiplatform code. kotlinx.serialization 1.7.2 provides a corresponding Uuid.serializer() for it, making it possible to use it in @Serializable classes. Note that for now, serializer should be provided manually with @Contextual annotation. Plugin will be able to automatically insert Uuid serializer in Kotlin 2.1.0.

See more details in the corresponding PR.

Other bugfixes and improvements

• Prohibited using of zero and negative field numbers in ProtoNumber (#​2766)
• Improve readability of protobuf decoding exception messages (#​2768) (thanks to xiaozhikang0916)
• docs(serializers): Fix grammatical errors (#​2779) (thanks to jamhour1g)
• Fixed VerifyError after ProGuard optimization (#​2728)
• Add wasm-wasi target to Okio integration (#​2727)

v1.7.1

==================

This is a bugfix release that aims to fix missing kotlinx-serialization-hocon artifact. It also contains experimental integration with kotlinx-io library. Kotlin 2.0.0 is used by default.

Fixed HOCON publication

Sadly, 1.7.0 release was published incomplete: kotlinx-serialization-hocon artifact is missing from 1.7.0 and 1.7.0-RC releases. This release fixes this problem and now kotlinx-serialization-hocon is available again with 1.7.1 version. No other changes were made to this artifact. Related ticket: #​2717.

Add integration with a kotlinx-io library

kotlinx-io is an official multiplatform library that provides basic IO primitives, similar to Okio. kotlinx.serialization integration is now available in a separate artifact, located at the kotlinx-serialization-json-io coordinates. Integration artifact provides functions similar to existing Okio integration: encodeToSink, decodeFromSource, and decodeSourceToSequence. Check out the PR for more details.

Other bugfixes

• Prohibited use of elements other than JsonObject in JsonTransformingSerializer with polymorphic serialization (#​2715)

v1.7.0

==================

This release contains all of the changes from 1.7.0-RC and is compatible with Kotlin 2.0. Please note that for reasons explained in the 1.7.0-RC changelog, it may not be possible to use it with the Kotlin 1.9.x compiler plugin. Yet, it is still fully backwards compatible with previous versions.

The only difference with 1.7.0-RC is that classDiscriminatorMode property in JsonBuilder is marked as experimental, as it should have been when it was introduced (#​2680).

v1.6.3

==================

This release provides a couple of new features and uses Kotlin 1.9.22 as default.

Class discriminator output mode

Class discriminator provides information for serializing and deserializing polymorphic class hierarchies. In case you want to encode more or less information for various third party APIs about types in the output, it is possible to control addition of the class discriminator with the JsonBuilder.classDiscriminatorMode property. For example, ClassDiscriminatorMode.NONE does not add class discriminator at all, in case the receiving party is not interested in Kotlin types. You can learn more about this feature in the documentation and corresponding PR.

Other features

• Add kebab-case naming strategy (#​2531) (thanks to Emil Kantis)
• Add value class support to the ProtoBufSchemaGenerator (#​2542) (thanks to Felipe Rotilho)

Bugfixes and improvements

• Fix: Hocon polymorphic serialization in containers (#​2151) (thanks to LichtHund)
• Actualize lenient mode documentation (#​2568)
• Slightly improve error messages thrown from serializer<T>() function (#​2533)
• Do not try to coerce input values for properties (#​2530)
• Make empty objects and arrays collapsed in pretty print mode (#​2506)
• Update Gradle dokka configuration to make sure "source" button is visible in all API docs (#​2518, #​2524)

v1.6.2

==================

This is a patch release accompanying Kotlin 1.9.21. It also provides additional targets that were not available in 1.6.1: wasm-wasi and (deprecated) linuxArm32Hfp.

• Add Wasm WASI target (#​2510)
• Bring back linuxArm32Hfp target because it is deprecated, but not removed yet. (#​2505)

v1.6.1

==================

This release uses Kotlin 1.9.20 by default, while upcoming 1.9.21 is also supported.

Trailing commas in Json

Trailing commas are one of the most popular non-spec Json variations. A new configuration flag, allowTrailingComma, makes Json parser accept them instead of throwing an exception. Note that it does not affect encoding, so kotlinx.serialization always produces Json without trailing commas. See details in the corresponding PR

Support of WasmJs target

Kotlin/Wasm has been experimental for some time and gained enough maturity to be added to the kotlinx libraries. Starting with 1.6.1, kotlinx.serialization provides a wasm-js flavor, so your projects with Kotlin/Wasm can have even more functionality. As usual, just add serialization dependencies to your build and declare wasmJs target. Please remember that Kotlin/Wasm is still experimental, so changes are expected.

Bugfixes and improvements

• Fix TaggedDecoder nullable decoding (#​2456) (thanks to Phillip Schichtel)
• Fix IllegalAccessException for some JPMS boundaries (#​2469)
• Cbor: check if inline value classes are marked as @​ByteString (#​2466) (thanks to eater)
• Improve polymorphic deserialization optimization (#​2481)
• Update Okio dependency to 3.6.0 (#​2473)
• Add protobuf conformance tests (#​2404) (thanks to Doğaç Eldenk)
• Support decoding maps with boolean keys (#​2440)

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• [ ] If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.