chore: add explicitApi mode in the core internal library

Author: osugikoji

ychat-core/build.gradle.kts

@@ -18,6 +18,7 @@ kover {
 }
 
 kotlin {
+    explicitApi()
     android()
     jvm()
     listOf(

ychat-core/src/androidMain/kotlin/co/yml/ychat/core/model/FileBytes.kt

@@ -1,7 +1,7 @@
 package co.yml.ychat.core.model
 
-actual typealias FileBytes = ByteArray
+public actual typealias FileBytes = ByteArray
 
-actual fun FileBytes.toByteArray(): ByteArray {
+public actual fun FileBytes.toByteArray(): ByteArray {
     return this
 }

ychat-core/src/androidMain/kotlin/co/yml/ychat/core/network/factories/HttpEngineFactory.kt

@@ -3,8 +3,8 @@ package co.yml.ychat.core.network.factories
 import io.ktor.client.engine.HttpClientEngine
 import io.ktor.client.engine.okhttp.OkHttp
 
-actual object HttpEngineFactory {
-    actual fun getEngine(): HttpClientEngine {
+public actual object HttpEngineFactory {
+    public actual fun getEngine(): HttpClientEngine {
         return OkHttp.create()
     }
 }

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/exceptions/YChatException.kt

@@ -1,12 +1,12 @@
 package co.yml.ychat.core.exceptions
 
-class YChatException(
+public class YChatException(
     message: String? = null,
     cause: Throwable? = null,
-    var statusCode: Int? = null,
+    public var statusCode: Int? = null,
 ) : Exception(message, cause) {
 
-    constructor(
+    public constructor(
         cause: Throwable?,
         statusCode: Int? = null
     ) : this(message = null, cause = cause, statusCode = statusCode)

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/model/FileBytes.kt

@@ -1,5 +1,5 @@
 package co.yml.ychat.core.model
 
-expect class FileBytes
+public expect class FileBytes
 
-expect fun FileBytes.toByteArray(): ByteArray
+public expect fun FileBytes.toByteArray(): ByteArray

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/network/extensions/ApiResultExtensions.kt

@@ -9,7 +9,7 @@ import io.ktor.client.statement.bodyAsText
 import io.ktor.http.isSuccess
 import io.ktor.util.toMap
 
-suspend inline fun <reified T> HttpResponse.toApiResult(): ApiResult<T> {
+public suspend inline fun <reified T> HttpResponse.toApiResult(): ApiResult<T> {
     val headers = this.headers.toMap()
     val statusCode = this.status.value
     return if (!this.status.isSuccess()) {
@@ -21,14 +21,14 @@ suspend inline fun <reified T> HttpResponse.toApiResult(): ApiResult<T> {
     }
 }
 
-fun <T> ResponseException.toApiResult(): ApiResult<T> {
+public fun <T> ResponseException.toApiResult(): ApiResult<T> {
     return ApiResult(
         statusCode = this.response.status.value,
         exception = YChatException(this.cause, this.response.status.value)
     )
 }
 
-fun <T> Throwable.toApiResult(): ApiResult<T> {
+public fun <T> Throwable.toApiResult(): ApiResult<T> {
     return ApiResult(
         statusCode = null,
         exception = YChatException(this.cause)

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/network/factories/HttpClientFactory.kt

@@ -2,6 +2,6 @@ package co.yml.ychat.core.network.factories
 
 import io.ktor.client.HttpClient
 
-interface HttpClientFactory {
-    fun getHttpClient(): HttpClient
+public interface HttpClientFactory {
+    public fun getHttpClient(): HttpClient
 }

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/network/factories/HttpEngineFactory.kt

@@ -2,6 +2,6 @@ package co.yml.ychat.core.network.factories
 
 import io.ktor.client.engine.HttpClientEngine
 
-expect object HttpEngineFactory {
-    actual fun getEngine(): HttpClientEngine
+public expect object HttpEngineFactory {
+    public actual fun getEngine(): HttpClientEngine
 }

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/network/infrastructure/ApiExecutor.kt

@@ -17,7 +17,7 @@ import io.ktor.http.HttpMethod
 import io.ktor.utils.io.errors.IOException
 import kotlin.collections.set
 
-class ApiExecutor(private val httpClientFactory: HttpClientFactory) {
+public class ApiExecutor(private val httpClientFactory: HttpClientFactory) {
 
     private val httpClient by lazy { httpClientFactory.getHttpClient() }
 
@@ -29,39 +29,39 @@ class ApiExecutor(private val httpClientFactory: HttpClientFactory) {
 
     private var query: HashMap<String, String> = HashMap()
 
-    val formParts = mutableListOf<FormPart<*>>()
+    public val formParts: MutableList<FormPart<*>> = mutableListOf()
 
-    fun setEndpoint(endpoint: String): ApiExecutor {
+    public fun setEndpoint(endpoint: String): ApiExecutor {
         this.endpoint = endpoint
         return this
     }
 
-    fun setHttpMethod(httpMethod: HttpMethod): ApiExecutor {
+    public fun setHttpMethod(httpMethod: HttpMethod): ApiExecutor {
         this.httpMethod = httpMethod
         return this
     }
 
-    fun setBody(body: Any): ApiExecutor {
+    public fun setBody(body: Any): ApiExecutor {
         this.body = body
         return this
     }
 
-    fun addQuery(key: String, value: String): ApiExecutor {
+    public fun addQuery(key: String, value: String): ApiExecutor {
         this.query[key] = value
         return this
     }
 
-    fun addQuery(key: String, value: List<String>): ApiExecutor {
+    public fun addQuery(key: String, value: List<String>): ApiExecutor {
         this.query[key] = value.joinToString(",")
         return this
     }
 
-    fun <T : Any> addFormPart(key: String, value: T): ApiExecutor {
+    public fun <T : Any> addFormPart(key: String, value: T): ApiExecutor {
         formParts += FormPart(key, value)
         return this
     }
 
-    fun addFormPart(key: String, fileName: String, value: ByteArray): ApiExecutor {
+    public fun addFormPart(key: String, fileName: String, value: ByteArray): ApiExecutor {
         val headers = Headers.build {
             append(HttpHeaders.ContentType, ContentType.Application.OctetStream.contentType)
             append(HttpHeaders.ContentDisposition, "filename=$fileName")
@@ -70,7 +70,7 @@ class ApiExecutor(private val httpClientFactory: HttpClientFactory) {
         return this
     }
 
-    suspend inline fun <reified T> execute(): ApiResult<T> {
+    public suspend inline fun <reified T> execute(): ApiResult<T> {
         return try {
             val response = if (formParts.isEmpty()) executeRequest() else executeRequestAsForm()
             return response.toApiResult()
@@ -81,15 +81,15 @@ class ApiExecutor(private val httpClientFactory: HttpClientFactory) {
         }
     }
 
-    suspend fun executeRequest(): HttpResponse {
+    public suspend fun executeRequest(): HttpResponse {
         return httpClient.request(endpoint) {
             url { query.forEach { parameters.append(it.key, it.value) } }
             method = httpMethod
             this.setBody(this@ApiExecutor.body)
         }
     }
 
-    suspend fun executeRequestAsForm(): HttpResponse {
+    public suspend fun executeRequestAsForm(): HttpResponse {
         return httpClient.submitFormWithBinaryData(
             url = endpoint,
             formData = formData { formParts.forEach { append(it) } }

ychat-core/src/commonMain/kotlin/co/yml/ychat/core/network/infrastructure/ApiResult.kt

@@ -3,7 +3,7 @@ package co.yml.ychat.core.network.infrastructure
 import co.yml.ychat.core.exceptions.YChatException
 
 /** Encapsulates an outcome from source api. */
-data class ApiResult<T>(
+public data class ApiResult<T>(
     val body: T? = null,
     val headers: Map<String, List<String>> = mapOf(),
     val statusCode: Int? = null,
@@ -14,14 +14,14 @@ data class ApiResult<T>(
     val isSuccessful: Boolean = exception == null
 
     /** Try to get [body], if it is null an [YChatException] will be thrown. */
-    fun getBodyOrThrow(): T {
+    public fun getBodyOrThrow(): T {
         val exception = exception
             ?: YChatException("Could not retrieve body from ApiResult.")
         return body ?: throw exception
     }
 
     /** Throw an [exception] when [isSuccessful] is false. */
-    fun ensureSuccess() {
+    public fun ensureSuccess() {
         if (!isSuccessful)
             throw exception ?: YChatException("Api request was not successful.")
     }