Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-json)
### [`v1.7.2`](https://togithub.com/Kotlin/kotlinx.serialization/blob/HEAD/CHANGELOG.md#172--2024-08-28)
\==================
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](https://datatracker.ietf.org/doc/html/rfc8152), 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](https://togithub.com/Kotlin/kotlinx.serialization/pull/2412) to us by [Bernd Prünster](https://togithub.com/JesusMcCloud).
#### 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](docs/serializers.md#simultaneous-use-of-plugin-generated-and-custom-serializers) and in the PRs: [#2758](https://togithub.com/Kotlin/kotlinx.serialization/pull/2758), [#2669](https://togithub.com/Kotlin/kotlinx.serialization/pull/2669).
#### Serializer for kotlin.uuid.Uuid
Kotlin 2.0.20 [added](https://kotlinlang.org/docs/whatsnew2020.html#support-for-uuids-in-the-common-kotlin-standard-library) 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](https://togithub.com/Kotlin/kotlinx.serialization/blob/master/docs/serializers.md#contextual-serialization).
Plugin will be able to automatically insert `Uuid` serializer in Kotlin 2.1.0.
See more details in the [corresponding PR](https://togithub.com/Kotlin/kotlinx.serialization/pull/2744).
#### Other bugfixes and improvements
- Prohibited using of zero and negative field numbers in ProtoNumber ([#2766](https://togithub.com/Kotlin/kotlinx.serialization/issues/2766))
- Improve readability of protobuf decoding exception messages ([#2768](https://togithub.com/Kotlin/kotlinx.serialization/issues/2768)) (thanks to [xiaozhikang0916](https://togithub.com/xiaozhikang0916))
- docs(serializers): Fix grammatical errors ([#2779](https://togithub.com/Kotlin/kotlinx.serialization/issues/2779)) (thanks to [jamhour1g](https://togithub.com/jamhour1g))
- Fixed VerifyError after ProGuard optimization ([#2728](https://togithub.com/Kotlin/kotlinx.serialization/issues/2728))
- Add wasm-wasi target to Okio integration ([#2727](https://togithub.com/Kotlin/kotlinx.serialization/issues/2727))
### [`v1.7.1`](https://togithub.com/Kotlin/kotlinx.serialization/blob/HEAD/CHANGELOG.md#171--2024-06-25)
\==================
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](https://togithub.com/Kotlin/kotlinx.serialization/issues/2717).
#### Add integration with a kotlinx-io library
[`kotlinx-io`](https://togithub.com/Kotlin/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](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json-okio/kotlinx.serialization.json.okio/): `encodeToSink`, `decodeFromSource`, and `decodeSourceToSequence`.
Check out the [PR](https://togithub.com/Kotlin/kotlinx.serialization/pull/2707) for more details.
#### Other bugfixes
- Prohibited use of elements other than JsonObject in JsonTransformingSerializer with polymorphic serialization ([#2715](https://togithub.com/Kotlin/kotlinx.serialization/issues/2715))
### [`v1.7.0`](https://togithub.com/Kotlin/kotlinx.serialization/blob/HEAD/CHANGELOG.md#170--2024-06-05)
\==================
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](https://togithub.com/Kotlin/kotlinx.serialization/releases/tag/v1.7.0-RC), 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](https://togithub.com/Kotlin/kotlinx.serialization/issues/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 contains the following updates:
1.6.3->1.7.2Release Notes
Kotlin/kotlinx.serialization (org.jetbrains.kotlinx:kotlinx-serialization-json)
### [`v1.7.2`](https://togithub.com/Kotlin/kotlinx.serialization/blob/HEAD/CHANGELOG.md#172--2024-08-28) \================== 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](https://datatracker.ietf.org/doc/html/rfc8152), 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](https://togithub.com/Kotlin/kotlinx.serialization/pull/2412) to us by [Bernd Prünster](https://togithub.com/JesusMcCloud). #### 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](docs/serializers.md#simultaneous-use-of-plugin-generated-and-custom-serializers) and in the PRs: [#2758](https://togithub.com/Kotlin/kotlinx.serialization/pull/2758), [#2669](https://togithub.com/Kotlin/kotlinx.serialization/pull/2669). #### Serializer for kotlin.uuid.Uuid Kotlin 2.0.20 [added](https://kotlinlang.org/docs/whatsnew2020.html#support-for-uuids-in-the-common-kotlin-standard-library) 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](https://togithub.com/Kotlin/kotlinx.serialization/blob/master/docs/serializers.md#contextual-serialization). Plugin will be able to automatically insert `Uuid` serializer in Kotlin 2.1.0. See more details in the [corresponding PR](https://togithub.com/Kotlin/kotlinx.serialization/pull/2744). #### Other bugfixes and improvements - Prohibited using of zero and negative field numbers in ProtoNumber ([#2766](https://togithub.com/Kotlin/kotlinx.serialization/issues/2766)) - Improve readability of protobuf decoding exception messages ([#2768](https://togithub.com/Kotlin/kotlinx.serialization/issues/2768)) (thanks to [xiaozhikang0916](https://togithub.com/xiaozhikang0916)) - docs(serializers): Fix grammatical errors ([#2779](https://togithub.com/Kotlin/kotlinx.serialization/issues/2779)) (thanks to [jamhour1g](https://togithub.com/jamhour1g)) - Fixed VerifyError after ProGuard optimization ([#2728](https://togithub.com/Kotlin/kotlinx.serialization/issues/2728)) - Add wasm-wasi target to Okio integration ([#2727](https://togithub.com/Kotlin/kotlinx.serialization/issues/2727)) ### [`v1.7.1`](https://togithub.com/Kotlin/kotlinx.serialization/blob/HEAD/CHANGELOG.md#171--2024-06-25) \================== 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](https://togithub.com/Kotlin/kotlinx.serialization/issues/2717). #### Add integration with a kotlinx-io library [`kotlinx-io`](https://togithub.com/Kotlin/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](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json-okio/kotlinx.serialization.json.okio/): `encodeToSink`, `decodeFromSource`, and `decodeSourceToSequence`. Check out the [PR](https://togithub.com/Kotlin/kotlinx.serialization/pull/2707) for more details. #### Other bugfixes - Prohibited use of elements other than JsonObject in JsonTransformingSerializer with polymorphic serialization ([#2715](https://togithub.com/Kotlin/kotlinx.serialization/issues/2715)) ### [`v1.7.0`](https://togithub.com/Kotlin/kotlinx.serialization/blob/HEAD/CHANGELOG.md#170--2024-06-05) \================== 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](https://togithub.com/Kotlin/kotlinx.serialization/releases/tag/v1.7.0-RC), 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](https://togithub.com/Kotlin/kotlinx.serialization/issues/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.
This PR was generated by Mend Renovate. View the repository job log.