# Changelog

All notable changes to this project will be documented in this file.

## [Unreleased]


### New features

* New option `konvert.enforce-not-null-strategy` to define how Konvert handles mapping from nullable to non-nullable field [#199](https://github.com/mcarleio/konvert/pull/199) (thanks to [@Shanzeee](https://github.com/Shanzeee))
   * `ASSERTION_OPERATOR` (default, deprecated) - uses the `!!` operator to assert that the source value is not null. Will result in a simple `NullPointerException` if the source value is null.
   * `REQUIRE_NOT_NULL` - uses the `requireNotNull` function to check that the source value is not null. Will throw an `IllegalArgumentException` with a speaking message if the source value is null.

* Three new type converters, which handle `Array<*>` (including primitive arrays like e.g. `IntArray`) mappings:
   * `ArrayToArrayConverter` - maps between arrays, e.g. `Array<Int>` to `Array<String>`
   * `ArrayToIterablesXConverter` - maps from an array to an iterable, e.g. `Array<Int>` to `List<String>`
   * `IterableToArrayConverter` - maps from an iterable to an array, e.g. `List<Int>` to `Array<String>`

  The following example now works out-of-the-box and generates the appropriate mappings:
  ```kotlin
  @KonvertTo(UserIdsDto::class)
  class UserIds(val ids: Array<Int>)

  @KonvertTo(UserIds::class)
  class UserIdsDto(val ids: List<Int>)
  ```


### Improvements

* Updates:
  * Kotlin → 2.3.10
  * KSP → 2.3.5
  * Injectors (Anvil, Dagger, Koin, Spring)

* Build updates:
  * Gradle → 9.4.1
  * Kotlin Compile Testing → 0.12.1
  * jUnit → 6.0.2

## [4.4.0]

### Improvements
* Update to Kotlin 2.2.0 and KSP 2.0.2
* Switch how `konvert` is being used in a maven project with KSP2 by using the new [ksp-maven-plugin](https://github.com/mcarleio/ksp-maven-plugin).

## [4.3.2]

### Bug fixes
* do not require `konvert.enforce-not-null` for mapping to value class when source and target are nullable [#189](https://github.com/mcarleio/konvert/issues/189)

## [4.3.1]

### Bug fixes
* respect source and target class visibilities for extension function generation [#180](https://github.com/mcarleio/konvert/issues/180)

## [4.3.0]

### New features

* Two new type converters, which handle `value class` mappings, i.e., to map from/to e.g. String to/from value class with a String inside: [#178](https://github.com/mcarleio/konvert/issues/178)
   * `ValueClassToXConverter`
   * `XToValueClassConverter`

  The following example now works out-of-the-box and generates the appropriate mappings:
  ```kotlin
  @JvmInline value class DataId(val id: String)

  @KonvertTo(AdapterClass::class)
  class DomainClass(id: DataId)

  @KonvertTo(DomainClass::class)
  class AdapterClass(id: String)
  ```

## [4.2.0]

## Breaking Changes

* The behavior when mapping non-constructor target properties has changed.
  Previously, it was a bit ambiguous how non-constructor target properties were handled.
  For example, it was enough to define a single mapping definition to generate mapping for all other non-constructor target properties.
  This behavior is now controlled by the new option `konvert.non-constructor-properties-mapping` (see below).

### New features

* New option `konvert.non-constructor-properties-mapping` to define how non-constructor target properties should be mapped: [#124](https://github.com/mcarleio/konvert/issues/124) (thanks to [@kosoj](https://github.com/kosoj) for idea and initial work [#138](https://github.com/mcarleio/konvert/pull/138))
   * `auto` (default): Behaves like `implicit` if no explicit mappings are present, otherwise behaves like `explicit`.
   * `explicit`: Only non-constructor target properties explicitly declared in mappings are mapped.
   * `implicit`: Maps all non-constructor target properties with a matching source property or explicit mapping.
   * `all`: All non-constructor target properties must be mapped, otherwise an exception is thrown.

* New option `konvert.invalid-mapping-strategy` to define how invalid mappings should be handled:
   * `warn` (default): Logs a warning and ignores invalid mappings.
   * `fail`: Throws an exception when an invalid mapping is encountered.

## [4.1.2]

### Bug fixes
* fix target constructor determination to allow use of a constructor with an ignored target property if the parameter has a default value [#160](https://github.com/mcarleio/konvert/issues/160)

## [4.1.1]

### Bug fixes
* fix iterable mapping generating illegal code in specific cases [#161](https://github.com/mcarleio/konvert/issues/161) (thanks to [@felhag](https://github.com/felhag)) [#162](https://github.com/mcarleio/konvert/pull/162)

## [4.1.0]

### Bug fixes
* fix property mappings (e.g. when using empty constructor or having additional variables) to use correct import statement [#139](https://github.com/mcarleio/konvert/issues/139)

### Improvements
* Improve Java support and compatibility [#125](https://github.com/mcarleio/konvert/issues/125)
   * values in records are now identified as sources
   * getter functions are now identified as sources
   * setter functions are now identified as targets

## [4.0.1]

### Bug fixes
* fix `expression` in `@KonvertFrom` generating non-compilable code due to duplicate nested `let` blocks [#99](https://github.com/mcarleio/konvert/issues/99)

## [4.0.0]

Update to Kotlin 2.0.21 and KSP 1.0.27

### Breaking Change
* META-INF files for `@Konvert`/`@KonverTo`/`@KonvertFrom` annotated functions are no longer generated.
  This is due to the fact that the generated META-INF files are not (directly) accessible for Konvert during following KSP runs.

  To be backwards compatible, the new option `konvert.parseDeprecatedMetaInfFiles`
  can be set to `true` to nevertheless parse the deprecated META-INF files as before.
  This option is set to `false` by default and will be removed in a future release.

  From now on, Konvert will generate a new code file which contains all the generated functions
  in the new `@GeneratedKonvertModule` annotation. This information can be accessed more easily during KSP runs.

## [3.2.3]

### Bug fixes
* improve compatibility with KSP2 which may include generics in the `KSTypeReference` [#93](https://github.com/mcarleio/konvert/issues/93)

## [3.2.2]

### Improvements
* keep `suspend` and `internal` modifiers in generated code (thanks to [@unshare](https://github.com/unshare)) [#88](https://github.com/mcarleio/konvert/pull/88)
* exceptions thrown during code generation are wrapped with a `KonvertException` to provide more (basic) information (related to [#27](https://github.com/mcarleio/konvert/issues/27), [#83](https://github.com/mcarleio/konvert/issues/83))

## [3.2.1]

### Bug fixes
* use kotlinpoet's `%L` placeholder instead of (implicit) using `CodeBlock.toString()` in [MapToXConverter](converter/src/main/kotlin/io/mcarle/konvert/converter/MapToXConverter.kt)  [#75](https://github.com/mcarleio/konvert/issues/75)

## [3.2.0]

### Bug fixes
* remove wrongly introduced invisible dependency on `kotlinx.collections.immutable` [#63](https://github.com/mcarleio/konvert/issues/63)

### Improvements
* better compatibility with Java classes by determining property names using getter functions [#54](https://github.com/mcarleio/konvert/issues/54)

## [3.1.0]

### New features
* Introduced support for `kotlinx.collections.immutable` [#51](https://github.com/mcarleio/konvert/discussions/51), [#58](https://github.com/mcarleio/konvert/pull/58)
* reusable TypeConverters `IterableToXConverter` and `MapToXConverter` (instead of hard coded, non-reusable `IterableToIterableConverter` and `MapToMapConverter`) [#57](https://github.com/mcarleio/konvert/pull/57)

## [3.0.1]

### Bug fixes
* Correctly resolve nested classes in generated code [#49](https://github.com/mcarleio/konvert/issues/49)

## [3.0.0]

Update to Kotlin 1.9.22 and KSP 1.0.16

### Breaking Changes
* rename annotation parameter `constructor` to `constructorArgs` (in `@KonvertTo`, `@KonvertFrom` and `@Konvert`)
  due to future plans to support KMP [[#12](https://github.com/mcarleio/konvert/discussions/12), [#24](https://github.com/mcarleio/konvert/issues/24)], which lists `constructor` as a reserved word

### Bug fixes
* Replace function call in `Konverter` during runtime, as it is not implemented for Android (thanks to [@mkowol-n](https://github.com/mkowol-n) [#32](https://github.com/mcarleio/konvert/pull/32))
* Handle additional parameters (introduced with [2.4.0](#2.4.0)) when implementation is given and the super call is generated
* Use same aliases as the `@Konverter` annotated interface when implementation is given (function with super call)

### New features
* Remove necessity for reflection at runtime by directly using the generated `@Konverter` annotated interface implementation [#33](https://github.com/mcarleio/konvert/pull/33)

  This also increases the performance and enables future support for KMP (see above), as reflection is not available on all platforms.

  Old functionality is still available by defining the new option `konvert.konverter.use-reflection` to `true` (default is `false`)

## [2.4.0]<a id='2.4.0'></a>

### New features
* allow functions with multiple parameters in `@Konverter` annotated interfaces if one is defined as source with `@Konverter.Source` [#28](https://github.com/mcarleio/konvert/issues/28)
   ```kotlin
   @Konverter
   interface Mapper {
    fun toDto(@Konverter.Source source: Source, otherProperty: Int): Target
   }
   data class Source(val property: String)
   data class Target(val property: String, val otherProperty: Int)
   ```

### Bug fixes:
* ignore private and extension functions in `@Konverter` annotated interfaces [#30](https://github.com/mcarleio/konvert/issues/30)

## [2.3.1]

### Publication fix
* Fix published maven `pom.xml` for `konvert-processor` to not include dependency to itself and testFixtures dependencies [#22](https://github.com/mcarleio/konvert/issues/22) (thanks to [@iDevSK](https://github.com/iDevSK) [#23](https://github.com/mcarleio/konvert/pull/23))

## [2.3.0]

Update to Kotlin 1.9.10 and KSP 1.0.13

### Improvements
* Generate mapping code with help of existing `TypeConverter`, e.g. between iterables [#20](https://github.com/mcarleio/konvert/issues/20)
  ```kotlin
  @Konverter
  interface Mapper {
    fun toDto(source: Source): Target
    fun toDto(sources: List<Source>): List<Target> // <- will use the IterableToIterable TypeConverter
  }
  data class Source(val property: String)
  data class Target(val property: String)
  ```
* New option (`konvert.enable-converters`) to enable TypeConverters via configuration (related to [#19](https://github.com/mcarleio/konvert/issues/19))
* Started throwing better understandable exceptions (related to [#18](https://github.com/mcarleio/konvert/issues/18))

### Bug fixes:
* replace implicit CodeBlock.toString() calls
* ignore generics when looking for aliases

## [2.2.0]

Update to Kotlin 1.9.0 and KSP 1.0.12

### Bug fixes
* ignore missing source property for a target constructor parameter with a default value [#16](https://github.com/mcarleio/konvert/issues/16)
  ```kotlin
  @KonvertTo(Target::class)
  data class Source(val property: String)
  data class Target(val property: String, val withDefaultVal: Int = 42)
  ```

## [2.1.0]

### New features
* override implemented interface functions (simply calling `super`) to add the `@GeneratedKonverter` annotation
   * this enables to load them on startup when processing entries in `META-INF/io.mcarle.konvert.api.Konvert`

### Bug fixes
* add `Impl` suffix to classes in `META-INF/io.mcarle.konvert.api.Konvert` (i.e. do not reference the interface, but the implementing class/object)

## [2.0.0]

### New features
* call own functions of a `@Konverter` annotated interface directly instead of calling `Konverter.get` [[c828f05](https://github.com/mcarleio/konvert/commit/c828f0594c8d660726fc1eb9fa083459fc94e3af)]
* functions in `@Konverter` are now allowed to have a nullable source parameter [[4bf1c97](https://github.com/mcarleio/konvert/commit/4bf1c974fd51bdd341a5f17078cfd45b982c83ef)]
* use more imports instead of fully qualified names [[1a40238](https://github.com/mcarleio/konvert/commit/1a40238138728fd390e6a60c670bbd5579e9156e)]
* enable (re-) usage of generated konverter from other modules or libraries [[5d358ea](https://github.com/mcarleio/konvert/commit/5d358ea1f986b3fa78e72a4bcf1a1536471c5d24)]
   * therefore, generate META-INF files containing all generated functions
   * add `@GeneratedKonverter` annotation to all generated functions
   * and add a new option `konvert.add-generated-konverter-annotation` to disable this feature

### Breaking Changes for custom `TypeConverter`
* changed return type of the function `convert` from `String` to `CodeBlock` [[cc3cadd](https://github.com/mcarleio/konvert/commit/cc3caddca7323e1ff8fad0df4e5944e75b86ad2c)]
   * The simplest migration is to wrap your result `String` in a `CodeBlock` like this:
     ```kotlin
     fun convert(fieldName: String, source: KSType, target: KSType): CodeBlock {
         // ... do your stuff ...
         return CodeBlock.of("your conversion code")
     }
     ```

## [1.5.1]

### Bug fixes
* actually use the collected classloaders from 1.5.0... [#13](https://github.com/mcarleio/konvert/issues/13)

## [1.5.0]

### New features
* add new type converters for `BigInteger` and `BigDecimal`
* add options for `koin-injector`: `konvert.koin.default-injection-method` and `konvert.koin.default-scope` (thanks to [@jakoss](https://github.com/jakoss) [#6](https://github.com/mcarleio/konvert/pull/6))
* add new injector for `anvil` (thanks to [@jakoss](https://github.com/jakoss) [#8](https://github.com/mcarleio/konvert/pull/8))

### Bug fixes
* fixed class loading issues of generated interface implementations during runtime [#13](https://github.com/mcarleio/konvert/issues/13)

## [1.4.0]

### New features
* add new modules:
   * The module `plugin-api` can be used to extend the `processor` at certain points
   * The modules `injectors/spring-injector` and `injectors/cdi-injector` which use the `plugin-api` to
     add annotations like `@Component` or `@RequestScoped` to the generated types from `@Konverter`
      * The modules `injectors/spring-annotations` and `injectors/cdi-annotations` so that the user can define the exact annotations
   * The modules `injectors/koin-injector` and `injectors/koin-annotations` (thanks to [@jakoss](https://github.com/jakoss) [#4](https://github.com/mcarleio/konvert/pull/4))
* add new option `konvert.generated-filename-suffix` to define the trailing part of the generated filename

### Bug fixes
* defined `options` in `@KonvertTo` and `@KonvertFrom` are now used

## [1.3.0]

### New features
* reimplemented configuration handling
   * new annotation `@Konfig` to define configurations
   * isolated configurations per converter
* new option `konvert.konverter.generate-class` to generate a `class` instead of an `object` on `@Konverter` (can be set globally or
  per `@Konverter` via `@Konfig`)
   * the `Konverter.get<YOUR_INTERFACE>()` implementation is extended to instantiate an instance of a class

### Breaking Changes for custom `TypeConverter`
* changed signature of `TypeConverter.init` to only pass the resolver
   * removed `options` field from `AbstractTypeConverter`
* changed option key `enforce-not-null` to `konvert.enforce-not-null`

### Bug fixes
* handle nullable parameter in mapping functions of a `@Konverter`

## [1.2.1]

### Bug fixes
* use FQN when converting between enums in different packages
* only create an import alias if not nullable type is not equal to the type reference

## [1.2.0]

### New features
* If an import alias was used for `@Konvert`, the generated object will also use that alias

### Bug fixes
* fix the special case when source and target class both have the same class name
* use non-breaking space to prevent rare cases where a line break could break code

## [1.1.1]

### Bug fixes

* the nullability checks for `KonvertTypeConverter` now consider both, declared and current type for source and target

## [1.1.0]

### Breaking Changes

* enabled by default following converters:
   * `ULongToNumberConverter`
   * `ULongToDoubleConverter`
   * `UShortToNumberConverter`
   * `UByteToNumberConverter`
* changed outcome of following converters: `ULongToNumberConverter`
* renamed the following converters:
   * `LongToDateConverter` -> `LongEpochMillisToDateConverter`
   * `DateToLongConverter` -> `DateToLongEpochMillisConverter`
   * `InstantToLongConverter` -> `InstantToLongEpochMillisConverter`
   * `ZonedDateTimeToLongConverter` -> `ZonedDateTimeToLongEpochMillisConverter`
   * `OffsetDateTimeToLongConverter` -> `OffsetDateTimeToLongEpochMillisConverter`
   * `LongToInstantConverter` -> `LongEpochMillisToInstantConverter`
* moved from `converter` to `converter-api` module:
   * `AbstractTypeConverter`
   * `ConverterOptions`

### New features

* implemented new converters:
   * `LongEpochSecondsToDateConverter`
   * `DateToLongEpochSecondsConverter`
   * `InstantToLongEpochSecondsConverter`
   * `ZonedDateTimeToLongEpochSecondsConverter`
   * `OffsetDateTimeToLongEpochSecondsConverter`
   * `OffsetTimeToStringConverter`
   * `LocalTimeToStringConverter`
   * `StringToOffsetTimeConverter`
   * `StringToLocalTimeConverter`
   * `LongEpochSecondsToInstantConverter`
   * `OffsetDateTimeToInstantConverter`
   * `OffsetDateTimeToZonedDateTimeConverter`
   * `OffsetDateTimeToLocalDateTimeConverter`
   * `OffsetDateTimeToLocalDateConverter`
   * `OffsetDateTimeToLocalTimeConverter`
   * `OffsetDateTimeToOffsetTimeConverter`
   * `ZonedDateTimeToInstantConverter`
   * `ZonedDateTimeToOffsetDateTimeConverter`
   * `ZonedDateTimeToLocalDateTimeConverter`
   * `ZonedDateTimeToLocalDateConverter`
   * `ZonedDateTimeToLocalTimeConverter`
   * `ZonedDateTimeToOffsetTimeConverter`
   * `LocalDateTimeToLocalDateConverter`
   * `LocalDateTimeToLocalTimeConverter`
   * `OffsetTimeToLocalTimeConverter`

### Bug fixes

* Types with generics on a function in interfaces annotated with `Konverter` work
* The generated `TypeConverter` for `KonvertTo`, `KonvertFrom` and `Konvert` can handle nullable source with not nullable target

## [1.0.0] - 2023-03-27

[unreleased]: https://github.com/mcarleio/konvert/compare/v4.4.0...HEAD

[4.4.0]: https://github.com/mcarleio/konvert/compare/v4.3.2...v4.4.0

[4.3.2]: https://github.com/mcarleio/konvert/compare/v4.3.1...v4.3.2

[4.3.1]: https://github.com/mcarleio/konvert/compare/v4.3.0...v4.3.1

[4.3.0]: https://github.com/mcarleio/konvert/compare/v4.2.0...v4.3.0

[4.2.0]: https://github.com/mcarleio/konvert/compare/v4.1.2...v4.2.0

[4.1.2]: https://github.com/mcarleio/konvert/compare/v4.1.1...v4.1.2

[4.1.1]: https://github.com/mcarleio/konvert/compare/v4.1.0...v4.1.1

[4.1.0]: https://github.com/mcarleio/konvert/compare/v4.0.1...v4.1.0

[4.0.1]: https://github.com/mcarleio/konvert/compare/v4.0.0...v4.0.1

[4.0.0]: https://github.com/mcarleio/konvert/compare/v3.2.3...v4.0.0

[3.2.3]: https://github.com/mcarleio/konvert/compare/v3.2.2...v3.2.3

[3.2.2]: https://github.com/mcarleio/konvert/compare/v3.2.1...v3.2.2

[3.2.1]: https://github.com/mcarleio/konvert/compare/v3.2.0...v3.2.1

[3.2.0]: https://github.com/mcarleio/konvert/compare/v3.1.0...v3.2.0

[3.1.0]: https://github.com/mcarleio/konvert/compare/v3.0.1...v3.1.0

[3.0.1]: https://github.com/mcarleio/konvert/compare/v3.0.0...v3.0.1

[3.0.0]: https://github.com/mcarleio/konvert/compare/v2.4.0...v3.0.0

[2.4.0]: https://github.com/mcarleio/konvert/compare/v2.3.1...v2.4.0

[2.3.1]: https://github.com/mcarleio/konvert/compare/v2.3.0...v2.3.1

[2.3.0]: https://github.com/mcarleio/konvert/compare/v2.2.0...v2.3.0

[2.2.0]: https://github.com/mcarleio/konvert/compare/v2.1.0...v2.2.0

[2.1.0]: https://github.com/mcarleio/konvert/compare/v2.0.0...v2.1.0

[2.0.0]: https://github.com/mcarleio/konvert/compare/v1.5.1...v2.0.0

[1.5.1]: https://github.com/mcarleio/konvert/compare/v1.5.0...v1.5.1

[1.5.0]: https://github.com/mcarleio/konvert/compare/v1.4.0...v1.5.0

[1.4.0]: https://github.com/mcarleio/konvert/compare/v1.3.0...v1.4.0

[1.3.0]: https://github.com/mcarleio/konvert/compare/v1.2.1...v1.3.0

[1.2.1]: https://github.com/mcarleio/konvert/compare/v1.2.0...v1.2.1

[1.2.0]: https://github.com/mcarleio/konvert/compare/v1.1.1...v1.2.0

[1.1.1]: https://github.com/mcarleio/konvert/compare/v1.1.0...v1.1.1

[1.1.0]: https://github.com/mcarleio/konvert/compare/v1.0.0...v1.1.0

[1.0.0]: https://github.com/mcarleio/konvert/releases/tag/v1.0.0