Restricted access to creating an EncodedObject

Author: Daeda88

firebase-common/src/androidMain/kotlin/dev/gitlive/firebase/_encoders.kt

@@ -10,11 +10,7 @@ import kotlinx.serialization.descriptors.StructureKind
 import java.lang.IllegalArgumentException
 import kotlin.collections.set
 
-actual data class EncodedObject(actual val raw: Map<String, Any?>) : Map<String, Any?> by raw {
-    actual companion object {
-        actual val emptyEncodedObject: EncodedObject = EncodedObject(emptyMap())
-    }
-}
+actual data class EncodedObject internal constructor(actual val raw: Map<String, Any?>) : Map<String, Any?> by raw
 
 @PublishedApi
 internal actual fun List<Pair<String, Any?>>.asEncodedObject() = EncodedObject(toMap())

firebase-common/src/commonMain/kotlin/dev/gitlive/firebase/encoders.kt

@@ -15,13 +15,9 @@ import kotlinx.serialization.modules.SerializersModule
  * Platform specific object for storing encoded data that can be used for methods that explicitly require an object.
  * This is essentially a [Map] of [String] and [Any]? (as represented by [raw]) but since [encode] gives a platform specific value, this method wraps that.
  *
- * Created using [encodeAsObject]
+ * Created using [encodeAsObject]. It is not recommended to encode to this manually.
  */
 expect class EncodedObject {
-    companion object {
-        val emptyEncodedObject: EncodedObject
-    }
-
     val raw: Map<String, Any?>
 }
 
@@ -45,13 +41,24 @@ inline fun <reified T> encode(value: T, shouldEncodeElementDefault: Boolean): An
 inline fun <reified T> encode(value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}) =
     encode(value, EncodeSettings.BuilderImpl().apply(buildSettings).buildEncodeSettings())
 
+/**
+ * Encodes data as an [EncodedObject].
+ * This is not recommended for manual use, but may be done by the library internally.
+ * @throws IllegalArgumentException if [value] is not valid as an [EncodedObject] (e.g. not encodable in the form Map<String:Any?>
+ */
 inline fun <T : Any> encodeAsObject(strategy: SerializationStrategy<T>, value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): EncodedObject {
     if (value is Map<*, *> && value.keys.any { it !is String }) {
         throw IllegalArgumentException("$value is a Map containing non-String keys. Must be of the form Map<String, Any?>")
     }
     val encoded = encode(strategy, value, buildSettings) ?: throw IllegalArgumentException("$value was encoded as null. Must be of the form Map<String, Any?>")
     return encoded.asNativeMap()?.asEncodedObject() ?: throw IllegalArgumentException("$value was encoded as ${encoded::class}. Must be of the form Map<String, Any?>")
 }
+
+/**
+ * Encodes data as an [EncodedObject].
+ * This is not recommended for manual use, but may be done by the library internally.
+ * @throws IllegalArgumentException if [value] is not valid as an [EncodedObject] (e.g. not encodable in the form Map<String:Any?>
+ */
 inline fun <reified T : Any> encodeAsObject(value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): EncodedObject {
     if (value is Map<*, *> && value.keys.any { it !is String }) {
         throw IllegalArgumentException("$value is a Map containing non-String keys. Must be of the form Map<String, Any?>")

firebase-common/src/iosMain/kotlin/dev/gitlive/firebase/_encoders.kt

@@ -9,11 +9,7 @@ import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.descriptors.StructureKind
 import kotlin.collections.set
 
-actual data class EncodedObject(actual val raw: Map<String, Any?>) : Map<Any?, Any?> by raw.mapKeys({ (key, _) -> key as? Any })  {
-    actual companion object {
-        actual val emptyEncodedObject: EncodedObject = EncodedObject(emptyMap())
-    }
-}
+actual data class EncodedObject internal constructor(actual val raw: Map<String, Any?>) : Map<Any?, Any?> by raw.mapKeys({ (key, _) -> key as? Any })
 
 @PublishedApi
 internal actual fun List<Pair<String, Any?>>.asEncodedObject() = EncodedObject(toMap())

firebase-common/src/jsMain/kotlin/dev/gitlive/firebase/_encoders.kt

@@ -10,11 +10,7 @@ import kotlinx.serialization.descriptors.StructureKind
 import kotlin.js.Json
 import kotlin.js.json
 
-actual data class EncodedObject(private val keyValues: List<Pair<String, Any?>>) {
-    actual companion object {
-        actual val emptyEncodedObject: EncodedObject = EncodedObject(emptyList())
-    }
-
+actual class EncodedObject internal constructor(private val keyValues: List<Pair<String, Any?>>) {
     actual val raw get() = keyValues.toMap()
     val json get() = json(*keyValues.toTypedArray())
 }