This repository has been archived by the owner on Sep 2, 2024. It is now read-only.
Update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.7.2 #27
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.3.3
->1.7.2
Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-json)
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:
@CborLabel
annotation andpreferCborLabelsOverNames
flag.encode*Tags
andverify*Tags
set of flagsuseDefiniteLengthEncoding
. This flag affects object encoding, since decoding of arrays with definite lenghts is automatically supported.alwaysUseByteString
flag.Since there are quite a lot of flags now, they were restructured to a separate
CborConfiguration
class, similarly toJsonConfiguration
.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.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
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
, anddecodeSourceToSequence
.Check out the PR for more details.
Other bugfixes
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 inJsonBuilder
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
v1.6.2
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
v1.6.0
==================
This release contains all features and bugfixes from 1.6.0-RC plus some bugfixes on its own (see below).
Kotlin 1.9.0 is used as a default, while 1.9.10 is also supported.
Bugfixes
v1.5.1
==================
This release contains an important Native targets overhaul, as well as numerous enhancements and bugfixes.
Kotlin 1.8.21 is used by default.
New set of Native targets
The official Kotlin target support policy has recently been published
describing new target policy: each target belongs to a certain tier, and different tiers have different stability guarantees.
The official recommendation for library authors is to support targets up to Tier 3,
and kotlinx.serialization now follows it.
It means that in this release, there are a lot of new targets added from this tier,
such as
androidNativeX86
orwatchosDeviceArm64
.Note that since they belong to Tier 3, they're not auto-tested on CI.
kotlinx.serialization also ships some deprecated Kotlin/Native targets that do not belong to any tier (e.g.
iosArm32
,mingwX86
).We'll continue to release them, but we do not provide support for them, nor do we plan to add new targets from the deprecated list.
Improvements in Json elements
There are two new function sets that should make creating raw Json elements easier.
First one contains overloads for
JsonPrimitive
constructor-like functionthat accept unsigned types:
JsonPrimitive(1u)
.Second one adds new
addAll
functions toJsonArrayBuilder
to be used with collectionsof numbers, booleans or strings:
buildJsonArray { addAll(listOf(1, 2, 3)) }
Both were contributed to us by aSemy.
Other enhancements
target
variables tosink
(#2226)Bugfixes
v1.5.0
==================
This release contains all features and bugfixes from 1.5.0-RC plus some experimental features and bugfixes on its own (see below).
Kotlin 1.8.10 is used as a default.
HoconEncoder and HoconDecoder interfaces and HOCON-specific serializers
These interfaces work in a way similar to
JsonEncoder
andJsonDecoder
: they allow intercepting (de)serialization process,making writing if custom HOCON-specific serializers easier. New
ConfigMemorySizeSerializer
andJavaDurationSerializer
already make use of them.See more details in the PR.
Big thanks to Alexander Mikhailov for contributing this!
Ability to read buffered huge strings in custom Json deserializers
New interface
ChunkedDecoder
allows you to read huge strings that may not fit in memory by chunks.Currently, this interface is only implemented by Json decoder that works with strings and streams,
but we may expand it later, if there's a demand for it.
See more details in the PR authored by Alexey Sviridov.
Bugfixes
v1.4.1
==================
This is patch release contains several bugfixes and improvements.
Kotlin 1.7.20 is used by default.
Improvements
Bugfixes
v1.4.0
==================
This release contains all features and bugfixes from 1.4.0-RC plus some bugfixes on its own (see below).
Kotlin 1.7.10 is used as a default.
Bugfixes
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.
This PR was generated by Mend Renovate. View the repository job log.