improvements and breaking changes in ChatMember hierarchy

2025-09-05 08:09:21 +00:00 · 2024-08-29 17:54:00 +06:00
parent 2d40af21fe
commit 10d92c2fdb
15 changed files with 266 additions and 131 deletions
--- a/tgbotapi.core/api/tgbotapi.core.api
+++ b/tgbotapi.core/api/tgbotapi.core.api
@@ -15681,14 +15681,6 @@ public final class dev/inmo/tgbotapi/types/chat/member/AdministratorChatMemberSe
 	public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
 }

-public abstract interface class dev/inmo/tgbotapi/types/chat/member/BannedChatMember : dev/inmo/tgbotapi/abstracts/types/UntilDate, dev/inmo/tgbotapi/types/chat/member/ChatMember {
-	public static final field Companion Ldev/inmo/tgbotapi/types/chat/member/BannedChatMember$Companion;
-}
-
-public final class dev/inmo/tgbotapi/types/chat/member/BannedChatMember$Companion {
-	public final fun serializer ()Lkotlinx/serialization/KSerializer;
-}
-
 public abstract interface class dev/inmo/tgbotapi/types/chat/member/ChatAdministratorRights : dev/inmo/tgbotapi/types/chat/member/SpecialChatAdministratorRights {
 	public static final field Companion Ldev/inmo/tgbotapi/types/chat/member/ChatAdministratorRights$Companion;
 	public abstract fun getCanDeleteStories ()Z
@@ -15856,7 +15848,7 @@ public final class dev/inmo/tgbotapi/types/chat/member/ChatMemberUpdated$Compani
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }

-public final class dev/inmo/tgbotapi/types/chat/member/KickedChatMember : dev/inmo/tgbotapi/types/chat/member/BannedChatMember {
+public final class dev/inmo/tgbotapi/types/chat/member/KickedChatMember : dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember {
 	public static final field Companion Ldev/inmo/tgbotapi/types/chat/member/KickedChatMember$Companion;
 	public fun <init> (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;)V
 	public synthetic fun <init> (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
@@ -16008,8 +16000,18 @@ public final class dev/inmo/tgbotapi/types/chat/member/OwnerChatMember$Companion
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }

-public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember : dev/inmo/tgbotapi/types/chat/ChatPermissions, dev/inmo/tgbotapi/types/chat/member/BannedChatMember, dev/inmo/tgbotapi/types/chat/member/SpecialRightsChatMember {
+public abstract interface class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember : dev/inmo/tgbotapi/abstracts/types/UntilDate, dev/inmo/tgbotapi/types/chat/member/ChatMember {
 	public static final field Companion Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember$Companion;
+}
+
+public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember$Companion {
+	public final fun invoke (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZ)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;
+	public static synthetic fun invoke$default (Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember$Companion;Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZILjava/lang/Object;)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;
+	public final fun serializer ()Lkotlinx/serialization/KSerializer;
+}
+
+public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl : dev/inmo/tgbotapi/types/chat/ChatPermissions, dev/inmo/tgbotapi/types/chat/member/MemberChatMember, dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember, dev/inmo/tgbotapi/types/chat/member/SpecialRightsChatMember {
+	public static final field Companion Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl$Companion;
 	public fun <init> (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZ)V
 	public synthetic fun <init> (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Ldev/inmo/tgbotapi/types/chat/User;
@@ -16029,8 +16031,8 @@ public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember : de
 	public final fun component7 ()Z
 	public final fun component8 ()Z
 	public final fun component9 ()Z
-	public final fun copy (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZ)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember;
-	public static synthetic fun copy$default (Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember;Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZILjava/lang/Object;)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember;
+	public final fun copy (Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZ)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;
+	public static synthetic fun copy$default (Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;Ldev/inmo/tgbotapi/types/chat/User;Ldev/inmo/tgbotapi/types/TelegramDate;ZZZZZZZZZZZZZZZILjava/lang/Object;)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;
 	public fun copyCommon (Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;)Ldev/inmo/tgbotapi/types/chat/ChatPermissions;
 	public fun copyGranular (Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;)Ldev/inmo/tgbotapi/types/chat/ChatPermissions;
 	public fun equals (Ljava/lang/Object;)Z
@@ -16062,18 +16064,18 @@ public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember : de
 	public fun toString ()Ljava/lang/String;
 }

-public synthetic class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
-	public static final field INSTANCE Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember$$serializer;
+public synthetic class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
+	public static final field INSTANCE Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl$$serializer;
 	public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
-	public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember;
+	public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;
 	public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
 	public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
-	public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMember;)V
+	public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Ldev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl;)V
 	public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
 	public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
 }

-public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember$Companion {
+public final class dev/inmo/tgbotapi/types/chat/member/RestrictedChatMemberImpl$Companion {
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }

--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/BannedChatMember.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/BannedChatMember.kt
@@ -1,7 +0,0 @@
-package dev.inmo.tgbotapi.types.chat.member
-
-import dev.inmo.tgbotapi.abstracts.types.UntilDate
-import kotlinx.serialization.Serializable
-
-@Serializable(ChatMemberSerializer::class)
-sealed interface BannedChatMember : ChatMember, UntilDate
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/ChatMember.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/ChatMember.kt
@@ -12,7 +12,6 @@ import kotlinx.serialization.builtins.serializer
 import kotlinx.serialization.descriptors.SerialDescriptor
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
-import kotlinx.serialization.json.JsonElement
 import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.json.jsonPrimitive

@@ -28,7 +27,7 @@ sealed interface ChatMember : WithUser {
        Administrator("administrator", AdministratorChatMemberImpl.serializer()),
        Member("member", MemberChatMemberImpl.serializer(), { status, json -> status == "member" && json[untilDateField] ?.jsonPrimitive == null }),
        SubscriptionMember("member", SubscriptionMemberChatMemberImpl.serializer(), { status, json -> status == "member" && json[untilDateField] ?.jsonPrimitive != null }),
-        Restricted("restricted", RestrictedChatMember.serializer()),
+        Restricted("restricted", RestrictedMemberChatMember.serializer()),
        Left("left", LeftChatMemberImpl.serializer()),
        Kicked("kicked", KickedChatMember.serializer())
    }
@@ -74,7 +73,7 @@ object ChatMemberSerializer : KSerializer<ChatMember> {
            is AdministratorChatMemberImpl -> AdministratorChatMemberImpl.serializer().serialize(encoder, value)
            is SubscriptionMemberChatMemberImpl -> SubscriptionMemberChatMemberImpl.serializer().serialize(encoder, value)
            is MemberChatMemberImpl -> MemberChatMemberImpl.serializer().serialize(encoder, value)
-            is RestrictedChatMember -> RestrictedChatMember.serializer().serialize(encoder, value)
+            is RestrictedMemberChatMember -> RestrictedMemberChatMember.serializer().serialize(encoder, value)
            is LeftChatMemberImpl -> LeftChatMemberImpl.serializer().serialize(encoder, value)
            is KickedChatMember -> KickedChatMember.serializer().serialize(encoder, value)
        }
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/KickedChatMember.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/KickedChatMember.kt
@@ -10,7 +10,7 @@ data class KickedChatMember(
    override val user: User,
    @SerialName(untilDateField)
    override val untilDate: TelegramDate? = null
-) : BannedChatMember {
+) : RestrictedChatMember {
    @SerialName(statusField)
    @Required
    @EncodeDefault
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/RestrictedChatMember.kt
@@ -1,49 +1,60 @@
 package dev.inmo.tgbotapi.types.chat.member

+import dev.inmo.tgbotapi.abstracts.types.UntilDate
 import dev.inmo.tgbotapi.types.*
-import dev.inmo.tgbotapi.types.chat.ChatPermissions
 import dev.inmo.tgbotapi.types.chat.User
-import kotlinx.serialization.*
+import kotlinx.serialization.Serializable

-@Serializable
-data class RestrictedChatMember(
-    @SerialName(userField)
-    override val user: User,
-    @SerialName(untilDateField)
-    override val untilDate: TelegramDate? = null,
-    @SerialName(isMemberField)
-    val isMember: Boolean = false,
-    @SerialName(canSendMessagesField)
-    override val canSendMessages: Boolean = false,
-    @SerialName(canSendAudiosField)
-    override val canSendAudios: Boolean = false,
-    @SerialName(canSendDocumentsField)
-    override val canSendDocuments: Boolean = false,
-    @SerialName(canSendPhotosField)
-    override val canSendPhotos: Boolean = false,
-    @SerialName(canSendVideosField)
-    override val canSendVideos: Boolean = false,
-    @SerialName(canSendVideoNotesField)
-    override val canSendVideoNotes: Boolean = false,
-    @SerialName(canSendVoiceNotesField)
-    override val canSendVoiceNotes: Boolean = false,
-    @SerialName(canSendPollsField)
-    override val canSendPolls: Boolean = false,
-    @SerialName(canSendOtherMessagesField)
-    override val canSendOtherMessages: Boolean = false,
-    @SerialName(canAddWebPagePreviewsField)
-    override 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,
-    @SerialName(canManageTopicsField)
-    override val canManageTopics: Boolean = false
-) : BannedChatMember, SpecialRightsChatMember, ChatPermissions {
-    @SerialName(statusField)
-    @Required
-    @EncodeDefault
-    override val status: ChatMember.Status = ChatMember.Status.Restricted
+@Serializable(ChatMemberSerializer::class)
+sealed interface RestrictedChatMember : ChatMember, UntilDate {
+    companion object {
+        // backward compatibility fun
+        @Deprecated(
+            "Renamed",
+            ReplaceWith(
+                "RestrictedChatMemberImpl(user, untilDate, isMember, canSendMessages, canSendAudios, canSendDocuments, canSendPhotos, canSendVideos, canSendVideoNotes, canSendVoiceNotes, canSendPolls, canSendOtherMessages, canAddWebPagePreviews, canChangeInfo, canInviteUsers, canPinMessages, canManageTopics)",
+                "dev.inmo.tgbotapi.types.chat.members.RestrictedChatMemberImpl",
+            )
+        )
+        operator fun invoke(
+            user: User,
+            untilDate: TelegramDate? = null,
+            isMember: Boolean = false,
+            canSendMessages: Boolean = false,
+            canSendAudios: Boolean = false,
+            canSendDocuments: Boolean = false,
+            canSendPhotos: Boolean = false,
+            canSendVideos: Boolean = false,
+            canSendVideoNotes: Boolean = false,
+            canSendVoiceNotes: Boolean = false,
+            canSendPolls: Boolean = false,
+            canSendOtherMessages: Boolean = false,
+            canAddWebPagePreviews: Boolean = false,
+            canChangeInfo: Boolean = false,
+            canInviteUsers: Boolean = false,
+            canPinMessages: Boolean = false,
+            canManageTopics: Boolean = false
+        ) = RestrictedMemberChatMember(
+            user = user,
+            untilDate = untilDate,
+            isMember = isMember,
+            canSendMessages = canSendMessages,
+            canSendAudios = canSendAudios,
+            canSendDocuments = canSendDocuments,
+            canSendPhotos = canSendPhotos,
+            canSendVideos = canSendVideos,
+            canSendVideoNotes = canSendVideoNotes,
+            canSendVoiceNotes = canSendVoiceNotes,
+            canSendPolls = canSendPolls,
+            canSendOtherMessages = canSendOtherMessages,
+            canAddWebPagePreviews = canAddWebPagePreviews,
+            canChangeInfo = canChangeInfo,
+            canInviteUsers = canInviteUsers,
+            canPinMessages = canPinMessages,
+            canManageTopics = canManageTopics
+        )
+    }
 }
+
+@Deprecated("Renamed", ReplaceWith("RestrictedChatMember", "dev.inmo.tgbotapi.types.chat.member.RestrictedChatMember"))
+typealias BannedChatMember = RestrictedChatMember
--- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/RestrictedMemberChatMember.kt
+++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/chat/member/RestrictedMemberChatMember.kt
@@ -0,0 +1,53 @@
+package dev.inmo.tgbotapi.types.chat.member
+
+import dev.inmo.tgbotapi.types.*
+import dev.inmo.tgbotapi.types.chat.ChatPermissions
+import dev.inmo.tgbotapi.types.chat.User
+import kotlinx.serialization.*
+
+/**
+ * Represents `ChatMemberRestricted` from telegram bots api and means that member is still member of chat but has been
+ * restricted in his rights
+ */
+@Serializable
+data class RestrictedMemberChatMember(
+    @SerialName(userField)
+    override val user: User,
+    @SerialName(untilDateField)
+    override val untilDate: TelegramDate? = null,
+    @SerialName(isMemberField)
+    val isMember: Boolean = false,
+    @SerialName(canSendMessagesField)
+    override val canSendMessages: Boolean = false,
+    @SerialName(canSendAudiosField)
+    override val canSendAudios: Boolean = false,
+    @SerialName(canSendDocumentsField)
+    override val canSendDocuments: Boolean = false,
+    @SerialName(canSendPhotosField)
+    override val canSendPhotos: Boolean = false,
+    @SerialName(canSendVideosField)
+    override val canSendVideos: Boolean = false,
+    @SerialName(canSendVideoNotesField)
+    override val canSendVideoNotes: Boolean = false,
+    @SerialName(canSendVoiceNotesField)
+    override val canSendVoiceNotes: Boolean = false,
+    @SerialName(canSendPollsField)
+    override val canSendPolls: Boolean = false,
+    @SerialName(canSendOtherMessagesField)
+    override val canSendOtherMessages: Boolean = false,
+    @SerialName(canAddWebPagePreviewsField)
+    override 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,
+    @SerialName(canManageTopicsField)
+    override val canManageTopics: Boolean = false
+) : RestrictedChatMember, SpecialRightsChatMember, MemberChatMember, ChatPermissions {
+    @SerialName(statusField)
+    @Required
+    @EncodeDefault
+    override val status: ChatMember.Status = ChatMember.Status.Restricted
+}