Skip to content

Comments

Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.10.0#318

Open
renovate[bot] wants to merge 1 commit intomodernfrom
renovate/serialization
Open

Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.10.0#318
renovate[bot] wants to merge 1 commit intomodernfrom
renovate/serialization

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Jun 6, 2024

This PR contains the following updates:

Package Change Age Confidence
org.jetbrains.kotlinx:kotlinx-serialization-json 1.6.31.10.0 age confidence

Release Notes

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

v1.10.0

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

This release is based on Kotlin 2.3.0 and contains all of the changes from 1.10.0-RC.
The only additional change is a fix for ProtoBuf packing of Kotlin unsigned types (#​3079).
Big thanks to KosmX for contributing the fix.

For your convenience, the changelog for 1.10.0-RC is duplicated below:

Stabilization of APIs

kotlinx-serialization 1.10 and subsequent releases will be focused on stabilization of existing APIs.
The following APIs and configuration options are no longer experimental because they're widely used without any known major issues:

  • Json configuration options: decodeEnumsCaseInsensitive, allowTrailingComma, allowComments, and prettyPrintIndent. (#​3100)
  • @EncodeDefault annotation and its modes. (#​3106)
  • JsonUnquotedLiteral constructor function (#​2900)
  • JsonPrimitive constructor function overloads that accept unsigned types. (#​3117)
  • JSON DSL functions on JsonElement with Nothing? overloads. (#​3117)

Readiness for return value checker

Kotlin 2.3.0 introduces a new feature aimed
at helping you to catch bugs related to the accidentally ignored return value of the function.
kotlinx-serialization 1.10.0-RC code is fully marked for this feature, meaning that you
can get warnings for unused function calls like Json.encodeToString(...).
To get the warnings, the feature has to be enabled in your project as described here.

Polymorphism improvements

Polymorphic serialization received a couple of improvements in this release:

New subclassesOfSealed utility to automatically register sealed subclasses serializers in polymorphic modules (#​2201).
Use it in your SerializersModule when configuring a polymorphic hierarchy which contains both abstract and sealed classes.
For example, when root of your hierarchy is an interface, but most of your inheritors are sealed classes.
The new function will register all known sealed subclasses for you, so you don’t need to list them one by one.
This makes writing your SerializerModules much faster and simpler.
Big thanks to Paul de Vrieze for contributing this feature.

Class discriminator conflict check rework (#​3105).
If a payload already contains a property with the same name as the configured discriminator (for example, type),
it is called a class discriminator conflict.
To produce a correct output and allow more inputs to be deserialized at the same time, the following changes were made:

  • Conflicts introduced by JsonNamingStrategy transformations are now detected during serialization as well and will cause SerializationException.
    It also affects non-polymorphic classes.
  • Conflicts from ClassDisciminatorMode.ALL_JSON_OBJECTS and SerializersModuleBuilder.polymorphicDefaultSerializer are also detected.
  • It is allowed to deserialize such a conflicting key for both sealed and open polymorphic hierarchies.
    Previously, it was possible in the sealed hierarchies alone due to missing assertion. See #​1664 for details.

General improvements

  • Add .serialName to MissingFieldException for clearer diagnostics. (#​3114)
  • Generate unique Automatic-Module-Name entries for metadata JARs. (#​3109)
  • Revised ProGuard rules and added R8 tests. (#​3041)
  • CBOR: Improved error message when a byte string/array type mismatch is encountered. (#​3052)

Bugfixes

  • Fix the type in the BIGNUM_NEGATIVE tag name. (#​3090)
  • CBOR: Fix various bugs in the decoder implementation to be more strict and consistent with the specification.

v1.9.0

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

This release updates Kotlin version to 2.2.0, includes several bugfixes and provides serializers for kotlin.time.Instant.

Add kotlin.time.Instant serializers

Instant class was moved from kotlinx-datetime library to Kotlin standard library.
As a result, kotlinx-datetime 0.7.0 no longer has serializers for the Instant class.
To use new kotlin.time.Instant class in your @​Serializable classes,
you can use this 1.9.0 kotlinx-serialization version (Kotlin 2.2 is required).
You can choose between default InstantSerializer which uses its string representation,
or specify InstantComponentSerializer that represents instant as its components.
See details in the PR.

Other bugfixes

  • Fix resize in JsonPath (#​2995)
  • Fixed proguard rules for obfuscation to work correctly (#​2983)

v1.8.1

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

This release updates Kotlin version to 2.1.20, while also providing several important improvements
and bugfixes.

Improvements

Bugfixes

  • Fix incorrect enum coercion during deserialization from JsonElement (#​2962)
  • Supply proper equals(), hashCode(), and toString() for SerialDescriptor() wrapper (#​2942)
  • Do not encode empty packed collections in protobuf (#​2907)

v1.8.0

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

This release contains all of the changes from 1.8.0-RC. Kotlin 2.1.0 is used as a default, while upcoming 2.1.10 is also supported.
Also added small bugfixes, including speedup of ProtoWireType.from (#​2879).

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).


Configuration

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

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, 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.

@renovate renovate bot requested a review from r0adkll as a code owner June 6, 2024 14:00
@renovate renovate bot added the renovate Automated PR from renovate bot label Jun 6, 2024
@renovate renovate bot enabled auto-merge (squash) June 6, 2024 14:00
@github-actions
Copy link

github-actions bot commented Jun 6, 2024

Messages
📖 This PR has been checked by Danger

Generated by 🚫 Danger Kotlin against e3de98c

@renovate renovate bot force-pushed the renovate/serialization branch 4 times, most recently from 6909045 to bc5b5b8 Compare June 13, 2024 22:02
@renovate renovate bot force-pushed the renovate/serialization branch 6 times, most recently from 7ad507e to aaab1d2 Compare June 25, 2024 16:21
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.0 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.1 Jun 25, 2024
@renovate renovate bot force-pushed the renovate/serialization branch from aaab1d2 to 8652f2f Compare June 27, 2024 04:47
@renovate renovate bot force-pushed the renovate/serialization branch 6 times, most recently from bfeb768 to a148ac8 Compare July 12, 2024 01:15
@renovate renovate bot force-pushed the renovate/serialization branch 3 times, most recently from 46863f9 to 063c44b Compare July 18, 2024 13:59
@renovate renovate bot force-pushed the renovate/serialization branch 2 times, most recently from 2b5e17c to 6d65cad Compare July 24, 2024 21:58
@renovate renovate bot force-pushed the renovate/serialization branch 2 times, most recently from d0dd653 to 4b92b40 Compare August 14, 2024 19:20
@renovate renovate bot force-pushed the renovate/serialization branch from 4b92b40 to 9d24156 Compare August 26, 2024 02:28
@renovate renovate bot force-pushed the renovate/serialization branch from 05f2d8a to 9e5f995 Compare August 28, 2024 16:10
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.1 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.2 Aug 28, 2024
@renovate renovate bot force-pushed the renovate/serialization branch 5 times, most recently from 29ed96e to c7c361d Compare September 4, 2024 14:56
@renovate renovate bot force-pushed the renovate/serialization branch 4 times, most recently from 9d555b4 to 5d55d9d Compare September 9, 2024 13:21
@renovate renovate bot force-pushed the renovate/serialization branch 2 times, most recently from 855a921 to 134f9b2 Compare September 13, 2024 19:53
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.2 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.3 Sep 19, 2024
@renovate renovate bot force-pushed the renovate/serialization branch from 134f9b2 to 2407296 Compare September 19, 2024 16:46
@renovate renovate bot force-pushed the renovate/serialization branch from 2407296 to 53d5545 Compare January 6, 2025 16:56
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.3 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.0 Jan 6, 2025
@renovate renovate bot force-pushed the renovate/serialization branch 6 times, most recently from f0aaddd to e465615 Compare February 10, 2025 14:11
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.0 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.1 Apr 1, 2025
@renovate renovate bot force-pushed the renovate/serialization branch from e465615 to 79c91e6 Compare April 1, 2025 16:32
@renovate renovate bot force-pushed the renovate/serialization branch from 79c91e6 to 45e800e Compare June 27, 2025 14:43
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.1 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.9.0 Jun 27, 2025
@renovate renovate bot force-pushed the renovate/serialization branch from 45e800e to e3de98c Compare January 21, 2026 16:58
@renovate renovate bot changed the title Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.9.0 Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.10.0 Jan 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

renovate Automated PR from renovate bot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants