5.1.1

♻️ Changed

• Improve dependency compatibility documentation (8a6f2fc).

🔥 Removed

• Version 5.0.0 from API reference (62652e1).

🐛 Fixed

• Incompatibility with different dependency versions (#907, originally reported by @MichaelStH).

---

Thanks to @MichaelStH for contributing to this new release. 🙏

5.1.0

✨ Added

• Support iOS arm64 Kotlin/Native target (#843).
• Support browser target for Kotlin/JS (#874).
• Integer experimental type for preventing overflow when performing arithmetic operations with integers, and for consistent behavior across all platforms when dividing an integer by zero (#880).
• Serializer for Integer type, in KotoolsTypesSerializersModule() experimental function (#898).
• of(String) and of(String, EmailAddressRegex) experimental functions in EmailAddress.Companion type, for creating an instance of EmailAddress (#865).
• EmailAddressRegex.Companion.of(String) experimental function for creating an instance of EmailAddressRegex (#868).
• Java compatibility in dependency compatibility (1dacbda).

♻️ Changed

• Improve declarations lifecycle documentation (1f9e815, 7a8e483, fd2f9b2 and 7a1942a).
• Update dependency compatibility documentation (c60c84d).
• Hide KotoolsTypesSerializersModule() experimental function from Java code (#897).

🗑️ Deprecated

• orNull and orThrow experimental functions from EmailAddress.Companion with an error level, for using its of functions instead (#865).
• orNull(String) and orThrow(String) experimental functions from EmailAddressRegex.Companion with an error level,
  for using its of function instead (#868).

🔥 Removed

• Following deprecated declarations from EmailAddress.Companion experimental type: PATTERN constant, orNull(String, String) and orThrow(String, String) functions (#838).
• Zero experimental type and its serializers (#844). Use Integer.from(0) instead.
• stringSerializer() experimental functions (#897). Use KotoolsTypesSerializersModule() instead.

🐛 Fixed

• Run configurations in contributing guidelines (#854).
• Kotlin/Native typos in README of root project (e4df56b).

5.0.1

✨ Added

• The EmailAddressRegex experimental type representing a regular expression for validating email addresses, in the types Gradle subproject (#809).
• The EmailAddress.Companion.orNull(String, EmailAddressRegex) and the EmailAddress.Companion.orThrow(String, EmailAddressRegex) experimental functions, in the types Gradle subproject, for creating an email address matching the specified regular expression (#809).
• The EmailAddressRegex.Companion.stringSerializer() experimental function, in the types-kotlinx-serialization Gradle subproject, for serializing the EmailAddressRegex type as String (#809).
• The KotoolsTypesSerializersModule() experimental function, in the types-kotlinx-serialization Gradle subproject, for providing a collection of default serializers for serializing types provided by Kotools Types (#790).
• The following extension functions on the Zero.Companion experimental type, in the types-kotlinx-serialization Gradle subproject (#793):
  • byteSerializer() for serializing the Zero type as Byte.
  • shortSerializer() for serializing the Zero type as Short.
  • intSerializer() for serializing the Zero type as Int.
  • longSerializer() for serializing the Zero type as Long.
  • floatSerializer() for serializing the Zero type as Float.
  • doubleSerializer() for serializing the Zero type as Double.
  • stringSerializer() for serializing the Zero type as String.
• The EmailAddress.Companion.stringSerializer() experimental function, in the types-kotlinx-serialization Gradle subproject, for serializing the EmailAddress type as String (#794).
• Explanations associated to each symbol used in patterns present in the API reference (fba9c4e).

♻️ Changed

• The README documentation of the types-kotlinx-serialization Gradle subproject, for using the new KotoolsTypesSerializersModule() function (#790).

🗑️ Deprecated

• The EmailAddress.Companion.PATTERN experimental property with an error level for using the EmailAddressRegex.Companion.default() function instead (#809).
• The EmailAddress.Companion.orNull(String, String) experimental function with an error level for using the orNull(String, EmailAddressRegex) overload instead (#809).
• The EmailAddress.Companion.orThrow(String, String) experimental function with an error level for using the orThrow(String, EmailAddressRegex) overload instead (#809).

🔥 Removed

• Versions 4.5.0, 4.5.1 and 4.5.2 from the API reference (#771).
• Experimental declarations from the kotools.types.* packages in the types Gradle subproject (#802). Better alternatives for these declarations will be introduced in the org.kotools.types package.
• The KotoolsTypesSerializers experimental type from the types-kotlinx-serialization Gradle subproject, for using the KotoolsTypesSerializersModule() function instead (#790).
• The ZeroAsByteSerializer experimental type, from the types-kotlinx-serialization Gradle subproject, for using the Zero.Companion.byteSerializer() function instead (#795).
• The EmailAddressAsStringSerializer experimental type, from the types-kotlinx-serialization Gradle subproject, for using the EmailAddress.Companion.stringSerializer() function instead (#796).

5.0.0

✨ Added

• Support iOS Simulator arm64 and iOS x64 Kotlin Native targets (#415 and #416).
• Dependency upgrades strategy in the dependency compatibility documentation (#289).
• Overloads for the orNull and the orThrow functions in the Zero.Companion experimental type, for creating an instance of Zero from a number of type Short (#716), Int (#717), Long (#718), Float (#719) and Double (#720), or from a text of type String (#761).

♻️ Changed

• Bump embedded Kotlin from 1.8.22 to 1.9.25, Kotlin language version from 1.5 to 1.9, and kotlinx.serialization from 1.5.1 to 1.6.3 (#407 and #740).
• Use default package names for Linux x64, macOS x64 and MinGW x64 Kotlin Native targets (#405).
• Move ExperimentalKotoolsTypesApi from the kotools.types.experimental package to the org.kotools.types one (#636).
• Documentation of EmailAddress.Companion.PATTERN that now refers to RegExr (#762).

🔥 Removed

• KotoolsTypesSerializers.zero deprecated property from the experimental API (#723).
• KotoolsTypesSerializers.emailAddress deprecated property, from the experimental API (#727).
• Hidden annotations from the kotools.types.experimental package (#318).
• Zero.Companion.fromByte and Zero.Companion.fromByteOrNull deprecated functions from the experimental API (#715).
• EmailAddress.Companion.fromString and EmailAddress.Companion.fromStringOrNull deprecated functions from the experimental API (#721).

🐛 Fixed

• Links to the API reference from the README documentation (#742).

---

Thanks to @bodiam for contributing to this new release. 🙏

4.5.3

✨ Added

• The Zero.Companion.orThrow(Byte) experimental method for Kotlin and Java platforms, and the Zero.Companion.orNull(Byte) experimental method only for Kotlin platforms (#688).
• In the EmailAddress.Companion experimental type, the orThrow(String) and the orThrow(String, String) methods for Kotlin and Java platforms, the orNull(String) and the orNull(String, String) methods only for Kotlin platforms (#692).
• The ZeroAsByteSerializer experimental type, in the types-kotlinx-serialization subproject, for serializing the Zero type as Byte (#690).
• The EmailAddressAsStringSerializer experimental type, in the types-kotlinx-serialization subproject, for serializing the EmailAddress type as String (#691).

🗑️ Deprecated

• In the Zero.Companion experimental type, the fromByte and the fromByteOrNull methods with an error level for using the orThrow and the orNull ones instead (#688).
• In the EmailAddress.Companion experimental type, the fromString and the fromStringOrNull methods with an error level for using the orThrow and the orNull ones instead (#692).
• The KotoolsTypesSerializers.zero experimental property, from the types-kotlinx-serialization subproject, with an error level for using the ZeroAsByteSerializer type instead (#690).
• The KotoolsTypesSerializers.emailAddress experimental property, from the types-kotlinx-serialization subproject, with an error level for using the EmailAddressAsStringSerializer type instead (#691).

🔥 Removed

• Versions 4.0.0 and 4.3.0 from the API reference (#704).
• JUnit 5 and System Lambda unused dependencies (#703).

🐛 Fixed

• Inappropriate usages of the function word instead of the method one in the API reference (#706).

🔒 Security

Bumped the following NPM packages for fixing DOM Clobbering Gadget leading to XSS:

• rollup from version 2.68.0 to 2.79.2 (#730).
• webpack from version 5.76.3 to 5.94.0 (#728).

---

Thanks to @LVMVRQUXL for contributing to this new release. 🙏

4.5.2

✨ Added

• The following declarations to the Zero experimental type:
  • compareTo(Byte), compareTo(Short), compareTo(Int), compareTo(Long), compareTo(Float) and compareTo(Double) functions (#650)
  • toByte(), toShort(), toInt(), toLong(), toFloat(), toDouble() and toChar() functions (#646).
• Samples to the Zero() constructor (7c8172d).

♻️ Changed

• The value parameter of the fromString and the fromStringOrNull functions from the EmailAddress.Companion experimental type, that is now named text (#682).
• Documentation of the EmailAddress type, the EmailAddress.Companion.PATTERN property, and the EmailAddress.Companion.fromString functions (f1ac24c, 1a0ea52, fd003c4 and 4c188db).
• Documentation of the Zero type, the Zero.Companion.fromByte(Byte) and the Zero.Companion.fromByteOrNull(Byte) functions (#681 and ccaaa3a).
• Samples for using assertions instead of printing values and collapsing them by default (#641 and #678).
• Kotlin and Java samples of the StrictlyNegativeDouble.Companion.create(Number) function (0a4258f).

🐛 Fixed

• API dependencies of the types-kotlinx-serialization subproject by exporting the kotlinx.serialization library (#700).
• Kotlin samples of the create and the createOrNull experimental functions from the NotEmptyMap.Companion type (1fa89b0 and 35d599b).
• Java sample of the StrictlyNegativeDouble.equals(Any?) experimental function (c862e0c).

🔥 Removed

• The kotools.types.web.EmailAddress deprecated type from the experimental API (#663).
• Availability of the Zero.Companion.fromByteOrNull(Byte) experimental function from Java code (#683).
• Availability of the EmailAddress.Companion.fromStringOrNull experimental functions from Java code (#684).

---

Thanks to @LVMVRQUXL and @MartiPresa for contributing to this new release. 🙏

4.5.1

✨ Added

• Introduced the Zero experimental type representing the zero number in the new org.kotools.types package (#644). This package will contain reimplemented types and those from the kotools.types.* packages will be deprecated incrementally.
• Introduced the EmailAddress experimental type representing email addresses in the org.kotools.types package (#635). This new implementation provides new fromString and fromStringOrNull factory functions accepting a value argument of type Any. For simplicity purpose, the default pattern used for validating email addresses is ^\S+@\S+\.\S+$, which allows a wider range of values. But it is also possible to provide a pattern argument to these new factory functions for customizing the validation.

val value: Any = "contact@kotools.org"
val pattern: Any = "^[a-z]+@[a-z]+\\.[a-z]+\$"
val emailAddress: EmailAddress = EmailAddress.fromString(value, pattern)
println(emailAddress) // "contact@kotools.org"

• New types-kotlinx-serialization module for supporting serialization of types from the org.kotools.types package using the Kotlin Serialization library (#602). See its README documentation for more details on how to use it.

♻️ Changed

• Our versioning strategy is now based on backward compatibility, focusing on behavioral, source and binary compatibilities.
• The create and the createOrNull experimental functions of the NotBlankString.Companion type now accept a value of type Any instead of Any? (#626).

// Before
NotBlankString.create(null) // pass
NotBlankString.createOrNull(null) // pass

// Now
NotBlankString.create(null) // compilation error
NotBlankString.createOrNull(null) // compilation error

• The documentation of the AnyInt(Int) experimental constructor-like function now uses collapsing sections for splitting Kotlin and Java samples (8eb8044).

🗑️ Deprecated

• The following annotations are now hidden from sources (#334): ExperimentalCollectionApi, ExperimentalNumberApi, ExperimentalRangeApi, ExperimentalResultApi and ExperimentalTextApi.
• The EmailAddress experimental type from the kotools.types.web package is now deprecated with a warning level for using the corresponding type from the org.kotools.types package (#635). Its create and createOrNull factory functions are also deprecated with an error level for this reason.

🔥 Removed

Due to an internal compilation error of Kotlin when comparing generics, the following types have been removed from the experimental API: NotEmptyRange, Bound, InclusiveBound and ExclusiveBound (#627). Experimental properties using these types were also removed.

---

Thanks to @augustomtt and @LVMVRQUXL for contributing to this new release. 🙏

4.5.0

✨ Added

• Support macOS arm64 systems with Kotlin Native (#414).
• The StrictlyNegativeDouble experimental type for representing a floating-point number of type Double that is less than zero (#555).
• The create(Any?) and the createOrNull(Any?) experimental factory functions in NotBlankString.Companion (#341).
• The create(Number) and createOrNull(Number) experimental factory functions in the following types:
  • StrictlyPositiveInt.Companion (#342)
  • StrictlyNegativeInt.Companion (#347)
  • PositiveInt.Companion (#349)
  • NegativeInt.Companion (#350)
  • NonZeroInt.Companion (#351).
• The create(Collection<E>), the createOrNull(Collection<E>) and the of(E, vararg E) experimental factory functions in NotEmptyList.Companion (#352) and in NotEmptySet.Companion (#353).
• The create(Map<K, V>), the createOrNull(Map<K, V>) and the of(Pair<K, V>, vararg Pair<K, V>) experimental factory functions in NotEmptyMap.Companion (#354).
• The NotBlankString.plus(Any) experimental operation (#543).
• Documentation of dependency compatibility (#288).
• The documentation of the serialization and the deserialization processes in the API reference for the following types: AnyInt, NonZeroInt, PositiveInt, NegativeInt, StrictlyPositiveInt, StrictlyNegativeInt, ZeroInt, NotBlankString, NotEmptyList, NotEmptySet and NotEmptyMap (#256).
• References to the corresponding factory functions for eligible types in the API reference (cfc99b2).
• Tagline suggested by @jmfayard in the README documentation (#338).

♻️ Changed

• Bump embedded Kotlin from 1.7.21 to 1.8.22 (#172 and #196).
• Bump kotlinx.serialization from 1.4.0 to 1.5.1 (#378 and #381).
• Move the EmailAddress experimental type from the kotools.types.experimental package to the new kotools.types.web one (#377).
• Make the regex property of the EmailAddress experimental type inaccessible for Java sources, due to the unavailability of the kotlin.text.Regex type for this language (8d0d098).
• Update the regular expression of the EmailAddress experimental type for following the RFC-5322 (#394).
• Update our Git commit messages convention using Gitmoji in our Contribution Guidelines (#490).

🗑️ Deprecated

Deprecation promotion of the following annotations to error (#333):

• ExperimentalCollectionApi
• ExperimentalNumberApi
• ExperimentalRangeApi
• ExperimentalResultApi
• ExperimentalTextApi

🔥 Removed

The plus experimental operations using the NotBlankString type (#542).

---

Thanks to @jmfayard and @LVMVRQUXL for contributing to this new release. 🙏

4.4.2

🐛 Fixed

Serialization problems using the Kotlin/JS IR compiler for all serializable types (#431).

---

Thanks to @robertfmurdock and @LVMVRQUXL for contributing to this new release. 🙏

4.4.1

🐛 Fixed

The types-internal subproject was missing in the Gradle dependency tree of Kotools Types 4.4.0 (#406).

---

Thanks to @robertfmurdock and @LVMVRQUXL for contributing to this new release. 🙏