fix detekt

Author: jan-tennert

Realtime/src/commonMain/kotlin/io/github/jan/supabase/realtime/Realtime.kt

@@ -60,6 +60,7 @@ interface Realtime : MainPlugin<Realtime.Config>, CustomSerializationPlugin {
      */
     val subscriptions: Map<String, RealtimeChannel>
 
+    @SupabaseInternal
     val websocket: RealtimeWebsocket
 
     /**
@@ -101,6 +102,11 @@ interface Realtime : MainPlugin<Realtime.Config>, CustomSerializationPlugin {
     @SupabaseInternal
     suspend fun send(message: RealtimeMessage)
 
+    /**
+     * Sends a binary payload to the realtime websocket
+     * @param data The data to send
+     */
+    @SupabaseInternal
     suspend fun send(data: ByteArray)
 
     /**
@@ -136,6 +142,7 @@ interface Realtime : MainPlugin<Realtime.Config>, CustomSerializationPlugin {
      * @property rejoinDelay The interval between channel rejoin attempts
      * @property maxAttempts The maximum number of times a channel will try to rejoin after an error before giving up. Defaults to 5
      * @property disconnectOnEmptyChannelsAfter Delay before disconnecting from the realtime socket after the last channel was removed. If null, it defaults to `2*heartbeatInterval`
+     * @property vsn The realtime protocol version. [RealtimeProtocolVersion.V2] supports binary payloads and is more efficient.
      */
     @Suppress("MagicNumber")
     class Config: MainConfig(), CustomSerializationConfig, AuthDependentPluginConfig {

Realtime/src/commonMain/kotlin/io/github/jan/supabase/realtime/RealtimeProtocolVersion.kt

@@ -2,6 +2,7 @@ package io.github.jan.supabase.realtime
 
 /**
  * Phoenix protocol version used for WebSocket communication.
+ * @param value The raw value
  */
 enum class RealtimeProtocolVersion(val value: String) {
     /**

Realtime/src/commonMain/kotlin/io/github/jan/supabase/realtime/broadcast/RealtimeSerializer.kt

@@ -1,3 +1,4 @@
+@file:Suppress("MagicNumber")
 package io.github.jan.supabase.realtime.broadcast
 
 import io.github.jan.supabase.realtime.RealtimeMessage
@@ -12,12 +13,12 @@ import kotlinx.serialization.json.contentOrNull
 import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.json.jsonPrimitive
 
-enum class BinaryKind(val value: Byte) {
+internal enum class BinaryKind(val value: Byte) {
     USER_BROADCAST_PUSH(3),
     USER_BROADCAST(4)
 }
 
-enum class PayloadEncoding(val value: Byte) {
+internal enum class PayloadEncoding(val value: Byte) {
     BINARY(0),
     JSON(1);
 
@@ -50,6 +51,7 @@ internal fun ByteArray.decodeBinaryPayload(): RealtimeBroadcast {
     }
 }
 
+@Suppress("ComplexCondition")
 internal fun RealtimeBroadcast.encodeBroadcast(
     joinRef: String?,
     ref: String?,
@@ -61,13 +63,9 @@ internal fun RealtimeBroadcast.encodeBroadcast(
     val topicBytes = topic.encodeToByteArray()
     val eventBytes = event.encodeToByteArray()
     val metaBytes = ByteArray(0)
-    val encoding = when(payload) {
-        is BroadcastPayload.Binary -> PayloadEncoding.BINARY
-        is BroadcastPayload.Json -> PayloadEncoding.JSON
-    }
-    val payload = when(payload) {
-        is BroadcastPayload.Binary -> payload.data
-        is BroadcastPayload.Json -> payload.value.toString().encodeToByteArray()
+    val (encoding, payload) = when(payload) {
+        is BroadcastPayload.Binary -> PayloadEncoding.BINARY to payload.data
+        is BroadcastPayload.Json -> PayloadEncoding.JSON to payload.value.toString().encodeToByteArray()
     }
 
     if(joinRefBytes.size > 255 || refBytes.size > 255 || topicBytes.size > 255 || eventBytes.size > 255 || metaBytes.size > 255)

Realtime/src/commonMain/kotlin/io/github/jan/supabase/realtime/websocket/RealtimeWebsocket.kt

@@ -17,6 +17,9 @@ interface RealtimeWebsocket {
      */
     val hasIncomingMessages: Boolean
 
+    /**
+     * Generates a new ref for a realtime message
+     */
     fun makeRef(): String
 
     /**