Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.3 #47

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 16, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
org.jetbrains.kotlinx:kotlinx-serialization-json 1.6.2 -> 1.7.3 age adoption passing confidence

Release Notes

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

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

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 force-pushed the renovate/kotlinx.serialization branch from 15203c0 to cf62f09 Compare February 17, 2024 06:30
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 2 times, most recently from 90682e8 to a449c8f Compare March 13, 2024 07:14
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 4 times, most recently from c69aedb to f06dec2 Compare March 22, 2024 19:22
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from f06dec2 to ab17fbe Compare March 28, 2024 03:46
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from ab17fbe to a12128e Compare April 6, 2024 18:48
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from a12128e to d0a3cd4 Compare April 28, 2024 02:27
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from d0a3cd4 to c60926f Compare May 7, 2024 14:16
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from c60926f to cb9c375 Compare May 16, 2024 01:31
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 2 times, most recently from 79387d2 to ee8d42c Compare June 5, 2024 16:30
@renovate renovate bot changed the title fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.6.3 fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.0 Jun 6, 2024
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 2 times, most recently from 5919c8f to ac49024 Compare June 10, 2024 16:45
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from ac49024 to e77229e Compare June 25, 2024 18:07
@renovate renovate bot changed the title fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.0 fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.1 Jun 25, 2024
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 2 times, most recently from 72412c2 to 5a06f51 Compare July 1, 2024 14:06
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from 5a06f51 to 8615ef9 Compare July 11, 2024 19:13
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 2 times, most recently from bdaff3a to f8832db Compare July 19, 2024 20:05
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from f8832db to a35d95b Compare August 14, 2024 20:00
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from a35d95b to 45e678a Compare August 28, 2024 18:30
@renovate renovate bot changed the title fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.1 fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.2 Aug 28, 2024
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch 2 times, most recently from bb4ed24 to cc83e1e Compare September 12, 2024 21:33
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from cc83e1e to 4d109f1 Compare September 19, 2024 18:58
@renovate renovate bot changed the title fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.2 fix(deps): update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.3 Sep 19, 2024
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from 4d109f1 to c855d04 Compare September 24, 2024 01:52
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from c855d04 to 3f67dd4 Compare October 9, 2024 22:16
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from 3f67dd4 to 5d48316 Compare November 11, 2024 20:03
@renovate renovate bot force-pushed the renovate/kotlinx.serialization branch from 5d48316 to d93b1ce Compare November 20, 2024 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants