Ref: use explicit api & consistency (#63)

* refactor to use explicit api

* update visibility modifiers and naming

* update changelog

Author: buenaflor

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Improve Objc/Swift experience with @HiddenFromObjc ([#62](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/62))
 
+### Fixes
+
+- ref: use explicit api & add code consistency ([#63](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/63))
+
 ## 0.0.3
 
 ### Fixes

sentry-kotlin-multiplatform/build.gradle.kts

@@ -23,6 +23,8 @@ android {
 }
 
 kotlin {
+    explicitApi()
+
     android {
         publishLibraryVariants("release")
     }

sentry-kotlin-multiplatform/src/androidMain/kotlin/io/sentry/kotlin/multiplatform/SentryInit.kt

@@ -12,4 +12,4 @@ internal actual fun initSentry(context: Context?, configuration: OptionsConfigur
     }
 }
 
-actual typealias Context = Context
+public actual typealias Context = Context

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/Attachment.kt

@@ -3,48 +3,47 @@ package io.sentry.kotlin.multiplatform
 import io.sentry.kotlin.multiplatform.extensions.toByteArray
 import io.sentry.kotlin.multiplatform.extensions.toNSData
 
-actual class Attachment : IAttachment {
+public actual class Attachment {
 
-    lateinit var cocoaAttachment: CocoaAttachment
+    internal lateinit var cocoaAttachment: CocoaAttachment
 
-    actual override val filename: String
+    public actual val filename: String
         get() = cocoaAttachment.filename
 
-    actual override val pathname: String?
+    public actual val pathname: String?
         get() = cocoaAttachment.path
 
-    actual override val bytes: ByteArray?
+    public actual val bytes: ByteArray?
         get() = cocoaAttachment.data?.toByteArray()
 
-    actual override val contentType: String?
+    public actual val contentType: String?
         get() = cocoaAttachment.contentType
 
-    actual companion object {
-        actual fun fromScreenshot(screenshotBytes: ByteArray): Attachment {
-            val data = screenshotBytes.toNSData()
+    public actual companion object {
+        public actual fun fromScreenshot(screenshotBytes: ByteArray): Attachment {
             return Attachment(screenshotBytes, "screenshot.png", "image/png")
         }
     }
 
-    actual constructor(pathname: String) {
+    public actual constructor(pathname: String) {
         cocoaAttachment = CocoaAttachment(pathname)
     }
 
-    actual constructor(pathname: String, filename: String) {
+    public actual constructor(pathname: String, filename: String) {
         cocoaAttachment = CocoaAttachment(pathname, filename)
     }
 
-    actual constructor(pathname: String, filename: String, contentType: String?) {
+    public actual constructor(pathname: String, filename: String, contentType: String?) {
         contentType?.let { cocoaAttachment = CocoaAttachment(pathname, filename, it) } ?: run {
             cocoaAttachment = CocoaAttachment(pathname, filename)
         }
     }
 
-    actual constructor(bytes: ByteArray, filename: String) {
+    public actual constructor(bytes: ByteArray, filename: String) {
         cocoaAttachment = CocoaAttachment(bytes.toNSData(), filename)
     }
 
-    actual constructor(bytes: ByteArray, filename: String, contentType: String?) {
+    public actual constructor(bytes: ByteArray, filename: String, contentType: String?) {
         contentType?.let { cocoaAttachment = CocoaAttachment(bytes.toNSData(), filename, it) } ?: run {
             cocoaAttachment = CocoaAttachment(bytes.toNSData(), filename)
         }

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/ScopeCocoaImpl.kt renamed to sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/CocoaScopeProvider.kt

@@ -10,7 +10,7 @@ import io.sentry.kotlin.multiplatform.protocol.Breadcrumb
 import io.sentry.kotlin.multiplatform.protocol.User
 import Scope.Sentry.SentryScope as PrivateCocoaScope
 
-internal class ScopeCocoaImpl(private val scope: CocoaScope) : ISentryScope {
+internal class CocoaScopeProvider(private val scope: CocoaScope) : ScopeProvider {
 
     /*
      This bridge exposes private Cocoa SDK API to fetch internal properties such as user, level, etc.

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.kt

@@ -12,7 +12,7 @@ import io.sentry.kotlin.multiplatform.protocol.UserFeedback
 import platform.Foundation.NSError
 import platform.Foundation.NSException
 
-actual abstract class Context
+public actual abstract class Context
 
 internal expect fun initSentry(configuration: OptionsConfiguration)
 
@@ -68,21 +68,21 @@ internal actual object SentryBridge {
 
     private fun configureScopeCallback(scopeCallback: ScopeCallback): (CocoaScope?) -> Unit {
         return { cocoaScope ->
-            val cocoaScopeImpl = cocoaScope?.let {
-                ScopeCocoaImpl(it)
+            val cocoaScopeProvider = cocoaScope?.let {
+                CocoaScopeProvider(it)
             }
-            cocoaScopeImpl?.let {
+            cocoaScopeProvider?.let {
                 val scope = Scope(it)
                 scopeCallback.invoke(scope)
             }
         }
     }
 }
 
-fun Sentry.captureError(error: NSError) {
+public fun captureError(error: NSError) {
     SentrySDK.captureError(error)
 }
 
-fun Sentry.captureException(exception: NSException) {
+public fun captureException(exception: NSException) {
     SentrySDK.captureException(exception)
 }

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/BreadcrumbExtensions.kt

@@ -2,29 +2,24 @@ package io.sentry.kotlin.multiplatform.extensions
 
 import io.sentry.kotlin.multiplatform.CocoaBreadcrumb
 import io.sentry.kotlin.multiplatform.protocol.Breadcrumb
-import io.sentry.kotlin.multiplatform.protocol.ISentryBreadcrumb
 
-internal fun ISentryBreadcrumb.toCocoaBreadcrumb(): CocoaBreadcrumb {
-    val outerScope = this
-    return CocoaBreadcrumb().apply {
-        setMessage(outerScope.message)
-        setType(outerScope.type)
-        outerScope.category?.let { setCategory(it) }
-        outerScope.level?.let { setLevel(it.toCocoaSentryLevel()) }
-        setData(outerScope.getData()?.toMap())
-    }
+internal fun Breadcrumb.toCocoaBreadcrumb() = CocoaBreadcrumb().apply {
+    val scope = this@toCocoaBreadcrumb
+    setMessage(scope.message)
+    setType(scope.type)
+    scope.category?.let { setCategory(it) }
+    scope.level?.let { setLevel(it.toCocoaSentryLevel()) }
+    setData(scope.getData()?.toMap())
 }
 
-internal fun CocoaBreadcrumb.toKmpBreadcrumb(): Breadcrumb {
-    return Breadcrumb().apply {
-        val funScope = this@toKmpBreadcrumb
-        message = funScope.message
-        type = funScope.type
-        category = funScope.category
-        val map = funScope.data as? Map<String, Any>
-        map?.let {
-            this.setData(it.toMutableMap())
-        }
-        level = funScope.level?.toKmpSentryLevel()
+internal fun CocoaBreadcrumb.toKmpBreadcrumb() = Breadcrumb().apply {
+    val scope = this@toKmpBreadcrumb
+    message = scope.message
+    type = scope.type
+    category = scope.category
+    val map = scope.data as? Map<String, Any>
+    map?.let {
+        this.setData(it.toMutableMap())
     }
+    level = scope.level?.toKmpSentryLevel()
 }

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/FoundationExtensions.kt

@@ -11,7 +11,7 @@ import platform.Foundation.allKeys
 import platform.Foundation.create
 import platform.posix.memcpy
 
-fun <K, V> NSMutableDictionary.toMutableMap(): MutableMap<K, V> {
+internal fun <K, V> NSMutableDictionary.toMutableMap(): MutableMap<K, V> {
     val keys = this.allKeys
     val map = mutableMapOf<K, V>()
     for (key in keys) {
@@ -20,13 +20,13 @@ fun <K, V> NSMutableDictionary.toMutableMap(): MutableMap<K, V> {
     return map
 }
 
-fun NSData.toByteArray(): ByteArray = ByteArray(this@toByteArray.length.toInt()).apply {
+internal fun NSData.toByteArray(): ByteArray = ByteArray(this@toByteArray.length.toInt()).apply {
     usePinned {
         memcpy(it.addressOf(0), this@toByteArray.bytes, this@toByteArray.length)
     }
 }
 
-fun ByteArray.toNSData(): NSData = memScoped {
+internal fun ByteArray.toNSData(): NSData = memScoped {
     NSData.create(
         bytes = allocArrayOf(this@toNSData),
         length = this@toNSData.size.toULong().convert()

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/UserExtensions.kt

@@ -3,23 +3,19 @@ package io.sentry.kotlin.multiplatform.extensions
 import io.sentry.kotlin.multiplatform.CocoaUser
 import io.sentry.kotlin.multiplatform.protocol.User
 
-internal fun User.toCocoaUser(): CocoaUser {
-    val outerScope = this
-    return CocoaUser().apply {
-        userId = outerScope.id
-        username = outerScope.username
-        email = outerScope.email
-        ipAddress = outerScope.ipAddress
-    }
+internal fun User.toCocoaUser() = CocoaUser().apply {
+    val scope = this@toCocoaUser
+    userId = scope.id
+    username = scope.username
+    email = scope.email
+    ipAddress = scope.ipAddress
 }
 
-internal fun CocoaUser.toKmpUser(): User {
-    val outerScope = this
-    return User().apply {
-        id = outerScope.userId.toString()
-        username = outerScope.username.toString()
-        email = outerScope.email.toString()
-        ipAddress = outerScope.ipAddress.toString()
-        setData(outerScope.data)
-    }
+internal fun CocoaUser.toKmpUser() = User().apply {
+    val scope = this@toKmpUser
+    id = scope.userId.toString()
+    username = scope.username.toString()
+    email = scope.email.toString()
+    ipAddress = scope.ipAddress.toString()
+    setData(scope.data)
 }

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/UserFeedbackExtensions.kt

@@ -4,7 +4,7 @@ import io.sentry.kotlin.multiplatform.CocoaSentryId
 import io.sentry.kotlin.multiplatform.CocoaUserFeedback
 import io.sentry.kotlin.multiplatform.protocol.UserFeedback
 
-fun UserFeedback.toCocoaUserFeedback(): CocoaUserFeedback {
+internal fun UserFeedback.toCocoaUserFeedback(): CocoaUserFeedback {
     val sentryId = CocoaSentryId(sentryId.toString())
     return CocoaUserFeedback(sentryId).apply {
         comments = this@toCocoaUserFeedback.comments.toString()