Merge pull request #212 from InsanusMokrassar/0.30.5

0.30.5

CHANGELOG.md

@@ -1,5 +1,16 @@
 # TelegramBotAPI changelog
 
+## 0.30.5
+
+* `Common`:
+    * `Version`:
+        * `MicroUtils`: `0.3.3` -> `0.4.0`
+* `Core`:
+    * Mechanism of `ChatMember` serialization has been changed
+        * Since this version any `ChatMember` can be serialized (even outside in case it marked by `@Serializable`)
+        * Since this version any `ChatMember` (included in this project) can be deserialized in common way
+    * `User` property `id` has changed its type: now it is `UserId` (under the hood it is the same as `ChatId`)
+
 ## 0.30.4
 
 * `Common`:

gradle.properties

@@ -12,12 +12,12 @@ klock_version=1.12.1
 uuid_version=0.2.2
 ktor_version=1.4.2
 
-micro_utils_version=0.3.3
+micro_utils_version=0.4.0
 
 javax_activation_version=1.1.1
 
 library_group=dev.inmo
-library_version=0.30.4
+library_version=0.30.5
 
 gradle_bintray_plugin_version=1.8.5
 github_release_plugin_version=2.2.12

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/chat/get/GetChatAdministrators.kt

@@ -4,13 +4,13 @@ import dev.inmo.tgbotapi.CommonAbstracts.types.ChatRequest
 import dev.inmo.tgbotapi.requests.abstracts.SimpleRequest
 import dev.inmo.tgbotapi.types.ChatIdentifier
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.AdministratorChatMember
-import dev.inmo.tgbotapi.types.ChatMember.abstracts.AdministratorChatMemberSerializerWithoutDeserialization
+import dev.inmo.tgbotapi.types.ChatMember.abstracts.AdministratorChatMemberSerializer
 import dev.inmo.tgbotapi.types.chatIdField
 import kotlinx.serialization.*
 import kotlinx.serialization.builtins.ListSerializer
 
 private val chatMembersListSerializer = ListSerializer(
-    AdministratorChatMemberSerializerWithoutDeserialization
+    AdministratorChatMemberSerializer
 )
 
 @Serializable

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/chat/members/GetChatMember.kt

@@ -3,7 +3,7 @@ package dev.inmo.tgbotapi.requests.chat.members
 import dev.inmo.tgbotapi.requests.chat.abstracts.ChatMemberRequest
 import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.ChatMember
-import dev.inmo.tgbotapi.types.ChatMember.abstracts.ChatMemberDeserializationStrategy
+import dev.inmo.tgbotapi.types.ChatMember.abstracts.ChatMemberSerializer
 import kotlinx.serialization.*
 
 @Serializable
@@ -15,7 +15,7 @@ data class GetChatMember(
 ) : ChatMemberRequest<ChatMember> {
     override fun method(): String = "getChatMember"
     override val resultDeserializer: DeserializationStrategy<ChatMember>
-        get() = ChatMemberDeserializationStrategy
+        get() = ChatMemberSerializer
     override val requestSerializer: SerializationStrategy<*>
         get() = serializer()
 }

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/AdministratorChatMemberImpl.kt

@@ -1,19 +1,37 @@
 package dev.inmo.tgbotapi.types.ChatMember
 
+import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.AdministratorChatMember
-import dev.inmo.tgbotapi.types.User
+import kotlinx.serialization.*
 
+@Serializable
 data class AdministratorChatMemberImpl(
+    @SerialName(userField)
     override val user: User,
-    override val canBeEdited: Boolean,
-    override val canChangeInfo: Boolean,
-    override val canPostMessages: Boolean,
-    override val canEditMessages: Boolean,
-    override val canRemoveMessages: Boolean,
-    override val canInviteUsers: Boolean,
-    override val canRestrictMembers: Boolean,
-    override val canPinMessages: Boolean,
-    override val canPromoteMembers: Boolean,
-    override val isAnonymous: Boolean,
-    override val customTitle: String?
-) : AdministratorChatMember
+    @SerialName(canBeEditedField)
+    override val canBeEdited: Boolean = false,
+    @SerialName(canChangeInfoField)
+    override val canChangeInfo: Boolean = false,
+    @SerialName(canPostMessagesField)
+    override val canPostMessages: Boolean = false,
+    @SerialName(canEditMessagesField)
+    override val canEditMessages: Boolean = false,
+    @SerialName(canDeleteMessagesField)
+    override val canRemoveMessages: Boolean = false,
+    @SerialName(canInviteUsersField)
+    override val canInviteUsers: Boolean = false,
+    @SerialName(canRestrictMembersField)
+    override val canRestrictMembers: Boolean = false,
+    @SerialName(canPinMessagesField)
+    override val canPinMessages: Boolean = false,
+    @SerialName(canPromoteMembersField)
+    override val canPromoteMembers: Boolean = false,
+    @SerialName(isAnonymousField)
+    override val isAnonymous: Boolean = false,
+    @SerialName(customTitleField)
+    override val customTitle: String? = null
+) : AdministratorChatMember {
+    @SerialName(statusField)
+    @Required
+    private val type: String = "administrator"
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/CreatorChatMember.kt

@@ -1,20 +1,36 @@
 package dev.inmo.tgbotapi.types.ChatMember
 
+import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.AdministratorChatMember
-import dev.inmo.tgbotapi.types.User
+import kotlinx.serialization.*
 
+@Serializable
 data class CreatorChatMember(
     override val user: User,
-    override val isAnonymous: Boolean,
-    override val customTitle: String?
+    @SerialName(isAnonymousField)
+    override val isAnonymous: Boolean = false,
+    @SerialName(customTitleField)
+    override val customTitle: String? = null
 ) : AdministratorChatMember {
+    @Transient
     override val canBeEdited: Boolean = true
+    @Transient
     override val canChangeInfo: Boolean = true
+    @Transient
     override val canPostMessages: Boolean = true
+    @Transient
     override val canEditMessages: Boolean = true
+    @Transient
     override val canRemoveMessages: Boolean = true
+    @Transient
     override val canInviteUsers: Boolean = true
+    @Transient
     override val canRestrictMembers: Boolean = true
+    @Transient
     override val canPinMessages: Boolean = true
+    @Transient
     override val canPromoteMembers: Boolean = true
+    @SerialName(statusField)
+    @Required
+    private val type: String = "creator"
 }

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/KickedChatMember.kt

@@ -1,10 +1,17 @@
 package dev.inmo.tgbotapi.types.ChatMember
 
+import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.BannedChatMember
-import dev.inmo.tgbotapi.types.TelegramDate
-import dev.inmo.tgbotapi.types.User
+import kotlinx.serialization.*
 
+@Serializable
 data class KickedChatMember(
+    @SerialName(userField)
     override val user: User,
-    override val untilDate: TelegramDate?
-) : BannedChatMember
+    @SerialName(untilDateField)
+    override val untilDate: TelegramDate? = null
+) : BannedChatMember {
+    @SerialName(statusField)
+    @Required
+    private val type: String = "kicked"
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/LeftChatMember.kt

@@ -1,7 +1,12 @@
 package dev.inmo.tgbotapi.types.ChatMember
 
+import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.ChatMember
-import dev.inmo.tgbotapi.types.User
+import kotlinx.serialization.*
 
-data class LeftChatMember(override val user: User) :
-    ChatMember
+@Serializable
+data class LeftChatMember(@SerialName(userField) override val user: User) : ChatMember {
+    @SerialName(statusField)
+    @Required
+    private val type: String = "left"
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/MemberChatMember.kt

@@ -1,7 +1,12 @@
 package dev.inmo.tgbotapi.types.ChatMember
 
+import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.ChatMember
-import dev.inmo.tgbotapi.types.User
+import kotlinx.serialization.*
 
-data class MemberChatMember(override val user: User) :
-    ChatMember
+@Serializable
+data class MemberChatMember(@SerialName(userField) override val user: User) : ChatMember {
+    @SerialName(statusField)
+    @Required
+    private val type: String = "member"
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/RawChatMember.kt

@@ -1,87 +0,0 @@
-package dev.inmo.tgbotapi.types.ChatMember
-
-import dev.inmo.tgbotapi.types.*
-import dev.inmo.tgbotapi.types.ChatMember.abstracts.ChatMember
-import kotlinx.serialization.SerialName
-import kotlinx.serialization.Serializable
-
-@Serializable
-internal data class RawChatMember(
-    val user: User,
-    private val status: String,
-    private val until_date: TelegramDate? = null,
-    @SerialName(canBeEditedField)
-    private val canBeEdited: Boolean = false,
-    @SerialName(canChangeInfoField)
-    private val canChangeInfo: Boolean = false,
-    @SerialName(canPostMessagesField)
-    private val canPostMessages: Boolean = false,
-    @SerialName(canEditMessagesField)
-    private val canEditMessages: Boolean = false,
-    @SerialName(canDeleteMessagesField)
-    private val canDeleteMessages: Boolean = false,
-    @SerialName(canInviteUsersField)
-    private val canInviteUsers: Boolean = false,
-    @SerialName(canRestrictMembersField)
-    private val canRestrictMembers: Boolean = false,
-    @SerialName(canPinMessagesField)
-    private val canPinMessages: Boolean = false,
-    @SerialName(canPromoteMembersField)
-    private val canPromoteMembers: Boolean = false,
-    @SerialName(isMemberField)
-    private val isMember: Boolean = false,
-    @SerialName(canSendMessagesField)
-    private val canSendMessages: Boolean = false,
-    @SerialName(canSendMediaMessagesField)
-    private val canSendMediaMessages: Boolean = false,
-    @SerialName(canSendPollsField)
-    private val canSendPolls: Boolean = false,
-    @SerialName(canSendOtherMessagesField)
-    private val canSendOtherMessages: Boolean = false,
-    @SerialName(canAddWebPagePreviewsField)
-    private val canAddWebPagePreviews: Boolean = false,
-    @SerialName(isAnonymousField)
-    private val isAnonymous: Boolean = false,
-    @SerialName(customTitleField)
-    private val customTitle: String? = null
-) {
-    val asChatMember: ChatMember by lazy {
-        when (status) {
-            "creator" -> CreatorChatMember(user, isAnonymous, customTitle)
-            "administrator" -> AdministratorChatMemberImpl(
-                user,
-                canBeEdited,
-                canChangeInfo,
-                canPostMessages,
-                canEditMessages,
-                canDeleteMessages,
-                canInviteUsers,
-                canRestrictMembers,
-                canPinMessages,
-                canPromoteMembers,
-                isAnonymous,
-                customTitle
-            )
-            "member" -> MemberChatMember(user)
-            "restricted" -> RestrictedChatMember(
-                user,
-                until_date,
-                isMember,
-                canSendMessages,
-                canSendMediaMessages,
-                canSendPolls,
-                canSendOtherMessages,
-                canAddWebPagePreviews,
-                canChangeInfo,
-                canInviteUsers,
-                canPinMessages
-            )
-            "left" -> LeftChatMember(user)
-            "kicked" -> KickedChatMember(
-                user,
-                until_date
-            )
-            else -> throw IllegalStateException("Can't understand type of user: $status")
-        }
-    }
-}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/RestrictedChatMember.kt

@@ -1,20 +1,36 @@
 package dev.inmo.tgbotapi.types.ChatMember
 
+import dev.inmo.tgbotapi.types.*
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.BannedChatMember
 import dev.inmo.tgbotapi.types.ChatMember.abstracts.SpecialRightsChatMember
-import dev.inmo.tgbotapi.types.TelegramDate
-import dev.inmo.tgbotapi.types.User
+import kotlinx.serialization.*
 
+@Serializable
 data class RestrictedChatMember(
+    @SerialName(userField)
     override val user: User,
-    override val untilDate: TelegramDate?,
-    val isMember: Boolean,
-    val canSendMessages: Boolean,
-    val canSendMediaMessages: Boolean,
-    val canSendPolls: Boolean,
-    val canSendOtherMessages: Boolean,
-    val canAddWebpagePreviews: Boolean,
-    override val canChangeInfo: Boolean,
-    override val canInviteUsers: Boolean,
-    override val canPinMessages: Boolean
-) : BannedChatMember, SpecialRightsChatMember
+    @SerialName(untilDateField)
+    override val untilDate: TelegramDate? = null,
+    @SerialName(isMemberField)
+    val isMember: Boolean = false,
+    @SerialName(canSendMessagesField)
+    val canSendMessages: Boolean = false,
+    @SerialName(canSendMediaMessagesField)
+    val canSendMediaMessages: Boolean = false,
+    @SerialName(canSendPollsField)
+    val canSendPolls: Boolean = false,
+    @SerialName(canSendOtherMessagesField)
+    val canSendOtherMessages: Boolean = false,
+    @SerialName(canAddWebPagePreviewsField)
+    val canAddWebpagePreviews: Boolean = false,
+    @SerialName(canChangeInfoField)
+    override val canChangeInfo: Boolean = false,
+    @SerialName(canInviteUsersField)
+    override val canInviteUsers: Boolean = false,
+    @SerialName(canPinMessagesField)
+    override val canPinMessages: Boolean = false
+) : BannedChatMember, SpecialRightsChatMember {
+    @SerialName(statusField)
+    @Required
+    private val type: String = "restricted"
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/abstracts/AdministratorChatMember.kt

@@ -1,5 +1,11 @@
 package dev.inmo.tgbotapi.types.ChatMember.abstracts
 
+import kotlinx.serialization.*
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+@Serializable(AdministratorChatMemberSerializer::class)
 interface AdministratorChatMember : SpecialRightsChatMember {
     val canBeEdited: Boolean
     val canPostMessages: Boolean
@@ -9,4 +15,12 @@ interface AdministratorChatMember : SpecialRightsChatMember {
     val canPromoteMembers: Boolean
     val isAnonymous: Boolean
     val customTitle: String?
-}
+}
+
+@Serializer(AdministratorChatMember::class)
+internal object AdministratorChatMemberSerializer : KSerializer<AdministratorChatMember> {
+    override val descriptor: SerialDescriptor = ChatMemberSerializer.descriptor
+
+    override fun deserialize(decoder: Decoder): AdministratorChatMember = ChatMemberSerializer.deserialize(decoder) as AdministratorChatMember
+    override fun serialize(encoder: Encoder, value: AdministratorChatMember) = ChatMemberSerializer.serialize(encoder, value)
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/abstracts/BannedChatMember.kt

@@ -1,5 +1,7 @@
 package dev.inmo.tgbotapi.types.ChatMember.abstracts
 
 import dev.inmo.tgbotapi.CommonAbstracts.types.UntilDate
+import kotlinx.serialization.Serializable
 
+@Serializable(ChatMemberSerializer::class)
 interface BannedChatMember : ChatMember, UntilDate

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/abstracts/ChatMember.kt

@@ -1,27 +1,46 @@
 package dev.inmo.tgbotapi.types.ChatMember.abstracts
 
-import dev.inmo.tgbotapi.types.ChatMember.RawChatMember
+import dev.inmo.tgbotapi.types.ChatMember.*
 import dev.inmo.tgbotapi.types.User
-import kotlinx.serialization.DeserializationStrategy
-import kotlinx.serialization.KSerializer
+import dev.inmo.tgbotapi.types.statusField
+import dev.inmo.tgbotapi.utils.nonstrictJsonFormat
+import kotlinx.serialization.*
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.jsonPrimitive
 
+@Serializable(ChatMemberSerializer::class)
 interface ChatMember {
     val user: User
 }
 
-internal object AdministratorChatMemberSerializerWithoutDeserialization : KSerializer<AdministratorChatMember> {
-    override val descriptor: SerialDescriptor = ChatMemberDeserializationStrategy.descriptor
+@Serializer(ChatMember::class)
+internal object ChatMemberSerializer : KSerializer<ChatMember> {
+    override val descriptor: SerialDescriptor = JsonObject.serializer().descriptor
 
-    override fun deserialize(decoder: Decoder): AdministratorChatMember
-        = ChatMemberDeserializationStrategy.deserialize(decoder) as AdministratorChatMember
-    override fun serialize(encoder: Encoder, value: AdministratorChatMember) = throw UnsupportedOperationException()
-}
-
-internal object ChatMemberDeserializationStrategy : DeserializationStrategy<ChatMember> {
-    override val descriptor: SerialDescriptor = RawChatMember.serializer().descriptor
-
-    override fun deserialize(decoder: Decoder): ChatMember = RawChatMember.serializer().deserialize(decoder).asChatMember
+    override fun deserialize(decoder: Decoder): ChatMember {
+        val json = JsonObject.serializer().deserialize(decoder)
+        return when (json[statusField] ?.jsonPrimitive ?.content ?: error("Status field of chat member must be specified, but incoming json contains next: $json")) {
+            "creator" -> nonstrictJsonFormat.decodeFromJsonElement(CreatorChatMember.serializer(), json)
+            "administrator" -> nonstrictJsonFormat.decodeFromJsonElement(AdministratorChatMemberImpl.serializer(), json)
+            "member" -> nonstrictJsonFormat.decodeFromJsonElement(MemberChatMember.serializer(), json)
+            "restricted" -> nonstrictJsonFormat.decodeFromJsonElement(RestrictedChatMember.serializer(), json)
+            "left" -> nonstrictJsonFormat.decodeFromJsonElement(LeftChatMember.serializer(), json)
+            "kicked" -> nonstrictJsonFormat.decodeFromJsonElement(KickedChatMember.serializer(), json)
+            else -> error("Unknown type of chat member in json: $json")
+        }
+    }
+
+    override fun serialize(encoder: Encoder, value: ChatMember) {
+        when (value) {
+            is CreatorChatMember -> CreatorChatMember.serializer()
+            is AdministratorChatMemberImpl -> AdministratorChatMemberImpl.serializer()
+            is MemberChatMember -> MemberChatMember.serializer()
+            is RestrictedChatMember -> RestrictedChatMember.serializer()
+            is LeftChatMember -> LeftChatMember.serializer()
+            is KickedChatMember -> KickedChatMember.serializer()
+        }
+    }
 }

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/ChatMember/abstracts/SpecialRightsChatMember.kt

@@ -1,5 +1,8 @@
 package dev.inmo.tgbotapi.types.ChatMember.abstracts
 
+import kotlinx.serialization.Serializable
+
+@Serializable(ChatMemberSerializer::class)
 interface SpecialRightsChatMember : ChatMember {
     val canChangeInfo: Boolean
     val canInviteUsers: Boolean

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/Common.kt

@@ -232,6 +232,7 @@ const val canSendPollsField = "can_send_polls"
 const val canAddWebPagePreviewsField = "can_add_web_page_previews"
 const val canSetStickerSetField = "can_set_sticker_set"
 
+const val statusField = "status"
 const val canBeEditedField = "can_be_edited"
 const val canChangeInfoField = "can_change_info"
 const val canPostMessagesField = "can_post_messages"

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/User.kt

@@ -10,11 +10,13 @@ import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.json.*
 
 @Serializable(UserSerializer::class)
-sealed class User : PrivateChat
+sealed class User : PrivateChat {
+    abstract override val id: UserId
+}
 
 @Serializable
 data class CommonUser(
-    override val id: ChatId,
+    override val id: UserId,
     @SerialName(firstNameField)
     override val firstName: String,
     @SerialName(lastNameField)
@@ -35,7 +37,7 @@ sealed class Bot : User() {
 
 @Serializable
 data class CommonBot(
-    override val id: ChatId,
+    override val id: UserId,
     @SerialName(usernameField)
     override val username: Username,
     @SerialName(firstNameField)
@@ -49,7 +51,7 @@ data class CommonBot(
 
 @Serializable
 data class ExtendedBot(
-    override val id: ChatId,
+    override val id: UserId,
     @SerialName(usernameField)
     override val username: Username,
     @SerialName(firstNameField)