feat(crypto): orNull variants

Author: lsafer-meemer

module-extkt-crypto/src/commonMain/kotlin/compression/deflate.kt

@@ -12,6 +12,10 @@ expect fun String.deflate(level: Int /* 0-9 */): ByteArray
 
 expect fun ByteArray.inflate(): ByteArray
 
+expect fun ByteArray.inflateOrNull(): ByteArray?
+
 // deflate => string
 
 expect fun ByteArray.inflateToString(): String
+
+expect fun ByteArray.inflateToStringOrNull(): String?

module-extkt-crypto/src/commonMain/kotlin/compression/gzip.kt

@@ -12,6 +12,10 @@ expect fun String.gzip(): ByteArray
 
 expect fun ByteArray.gunzip(): ByteArray
 
+expect fun ByteArray.gunzipOrNull(): ByteArray?
+
 // gzip => string
 
 expect fun ByteArray.gunzipToString(): String
+
+expect fun ByteArray.gunzipToStringOrNull(): String?

module-extkt-crypto/src/commonMain/kotlin/text/base64.kt

@@ -28,14 +28,22 @@ expect fun String.encodeBase64UrlSafe(offset: Int, length: Int = this.length): S
 
 expect fun String.decodeBase64(): ByteArray
 
+expect fun String.decodeBase64OrNull(): ByteArray?
+
 // base64url => byte[]
 
 expect fun String.decodeBase64UrlSafe(): ByteArray
 
+expect fun String.decodeBase64UrlSafeOrNull(): ByteArray?
+
 // base64 => string
 
 expect fun String.decodeBase64ToString(): String
 
+expect fun String.decodeBase64ToStringOrNull(): String?
+
 // base64url => string
 
 expect fun String.decodeBase64UrlSafeToString(): String
+
+expect fun String.decodeBase64UrlSafeToStringOrNull(): String?

module-extkt-crypto/src/commonMain/kotlin/text/hex.kt

@@ -12,6 +12,10 @@ expect fun String.encodeHex(): String
 
 expect fun String.decodeHex(): ByteArray
 
+expect fun String.decodeHexOrNull(): ByteArray?
+
 // hex => string
 
 expect fun String.decodeHexToString(): String
+
+expect fun String.decodeHexToStringOrNull(): String?

module-extkt-crypto/src/jsMain/kotlin/compression/deflate.js.kt

@@ -12,6 +12,14 @@ actual fun ByteArray.inflate(): ByteArray {
     TODO("Not yet implemented")
 }
 
+actual fun ByteArray.inflateOrNull(): ByteArray? {
+    TODO("Not yet implemented")
+}
+
 actual fun ByteArray.inflateToString(): String {
     TODO("Not yet implemented")
 }
+
+actual fun ByteArray.inflateToStringOrNull(): String? {
+    TODO("Not yet implemented")
+}

module-extkt-crypto/src/jsMain/kotlin/compression/gzip.js.kt

@@ -12,6 +12,14 @@ actual fun ByteArray.gunzip(): ByteArray {
     TODO("Not yet implemented")
 }
 
+actual fun ByteArray.gunzipOrNull(): ByteArray? {
+    TODO("Not yet implemented")
+}
+
 actual fun ByteArray.gunzipToString(): String {
     TODO("Not yet implemented")
 }
+
+actual fun ByteArray.gunzipToStringOrNull(): String? {
+    TODO("Not yet implemented")
+}

module-extkt-crypto/src/jsMain/kotlin/text/base64.js.kt

@@ -1,5 +1,6 @@
 package org.cufy.text
 
+import kotlin.coroutines.cancellation.CancellationException
 import kotlin.io.encoding.Base64
 import kotlin.io.encoding.ExperimentalEncodingApi
 
@@ -65,16 +66,55 @@ actual fun String.decodeBase64(): ByteArray {
     return Base64.decode(this)
 }
 
+@OptIn(ExperimentalEncodingApi::class)
+actual fun String.decodeBase64OrNull(): ByteArray? {
+    return try {
+        Base64.decode(this)
+    } catch (_: IllegalArgumentException) {
+        null
+    }
+}
+
 @OptIn(ExperimentalEncodingApi::class)
 actual fun String.decodeBase64UrlSafe(): ByteArray {
     val base64 = base64UrlSafeToBase64(this)
     return Base64.decode(base64)
 }
 
+@OptIn(ExperimentalEncodingApi::class)
+actual fun String.decodeBase64UrlSafeOrNull(): ByteArray? {
+    return try {
+        val base64 = base64UrlSafeToBase64(this)
+        Base64.decode(base64)
+    } catch (_: IllegalArgumentException) {
+        null
+    }
+}
+
 actual fun String.decodeBase64ToString(): String {
     return atob(this)
 }
 
+actual fun String.decodeBase64ToStringOrNull(): String? {
+    return try {
+        atob(this)
+    } catch (e: CancellationException) {
+        throw e
+    } catch (_: Throwable) {
+        null
+    }
+}
+
 actual fun String.decodeBase64UrlSafeToString(): String {
     return atobUrlSafe(this)
 }
+
+actual fun String.decodeBase64UrlSafeToStringOrNull(): String? {
+    return try {
+        atobUrlSafe(this)
+    } catch (e: CancellationException) {
+        throw e
+    } catch (_: Throwable) {
+        null
+    }
+}

module-extkt-crypto/src/jsMain/kotlin/text/hex.js.kt

@@ -12,6 +12,14 @@ actual fun String.decodeHex(): ByteArray {
     TODO("Not yet implemented")
 }
 
+actual fun String.decodeHexOrNull(): ByteArray? {
+    TODO("Not yet implemented")
+}
+
 actual fun String.decodeHexToString(): String {
     TODO("Not yet implemented")
 }
+
+actual fun String.decodeHexToStringOrNull(): String? {
+    TODO("Not yet implemented")
+}

module-extkt-crypto/src/jvmMain/kotlin/compression/deflate.jvm.kt

@@ -8,6 +8,7 @@ import java.util.zip.Deflater
 import java.util.zip.DeflaterOutputStream
 import java.util.zip.Inflater
 import java.util.zip.InflaterInputStream
+import kotlin.coroutines.cancellation.CancellationException
 
 actual fun ByteArray.deflate(level: Int): ByteArray {
     val baos = ByteArrayOutputStream()
@@ -33,10 +34,30 @@ actual fun ByteArray.inflate(): ByteArray {
     return inflate.use { it.readBytes() }
 }
 
+actual fun ByteArray.inflateOrNull(): ByteArray? {
+    return try {
+        inflate()
+    } catch (e: CancellationException) {
+        throw e
+    } catch (_: RuntimeException) {
+        null
+    }
+}
+
 actual fun ByteArray.inflateToString(): String {
     val bais = ByteArrayInputStream(this)
     val inflater = Inflater()
     val inflate = InflaterInputStream(bais, inflater)
     val isr = InputStreamReader(inflate)
     return isr.use { it.readText() }
 }
+
+actual fun ByteArray.inflateToStringOrNull(): String? {
+    return try {
+        inflateToString()
+    } catch (e: CancellationException) {
+        throw e
+    } catch (_: RuntimeException) {
+        null
+    }
+}

module-extkt-crypto/src/jvmMain/kotlin/compression/gzip.jvm.kt

@@ -6,6 +6,7 @@ import java.io.InputStreamReader
 import java.io.OutputStreamWriter
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
+import kotlin.coroutines.cancellation.CancellationException
 
 actual fun ByteArray.gzip(): ByteArray {
     val baos = ByteArrayOutputStream()
@@ -28,9 +29,29 @@ actual fun ByteArray.gunzip(): ByteArray {
     return gzip.use { it.readBytes() }
 }
 
+actual fun ByteArray.gunzipOrNull(): ByteArray? {
+    return try {
+        gunzip()
+    } catch (e: CancellationException) {
+        throw e
+    } catch (_: RuntimeException) {
+        null
+    }
+}
+
 actual fun ByteArray.gunzipToString(): String {
     val bais = ByteArrayInputStream(this)
     val gzip = GZIPInputStream(bais)
     val isr = InputStreamReader(gzip)
     return isr.use { it.readText() }
 }
+
+actual fun ByteArray.gunzipToStringOrNull(): String? {
+    return try {
+        gunzipToString()
+    } catch (e: CancellationException) {
+        throw e
+    } catch (_: RuntimeException) {
+        null
+    }
+}