feat(gateway): support guild members request and member update events

Author: cryptoAlgorithm

Sources/DiscordKitCore/Objects/Data/Member.swift

@@ -21,4 +21,20 @@ public struct Member: Codable, GatewayData {
     public let communication_disabled_until: Date? // When the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out
     public let guild_id: Snowflake?
     public let user_id: Snowflake? // Only present in merged_members in READY payload!
+
+    public init(from updateMember: GuildMemberUpdate, merging: Self? = nil) {
+        self.user = updateMember.user
+        self.nick = updateMember.nick
+        self.avatar = updateMember.avatar
+        self.roles = updateMember.roles
+        self.joined_at = merging?.joined_at ?? updateMember.joined_at ?? .distantPast
+        self.premium_since = updateMember.premium_since
+        self.deaf = merging?.deaf ?? updateMember.deaf ?? false
+        self.mute = merging?.mute ?? updateMember.mute ?? false
+        self.pending = updateMember.pending
+        self.permissions = merging?.permissions
+        self.communication_disabled_until = updateMember.communication_disabled_until
+        self.guild_id = updateMember.guild_id
+        self.user_id = merging?.user_id
+    }
 }

Sources/DiscordKitCore/Objects/Gateway/DataStructs.swift

@@ -65,10 +65,19 @@ public struct GatewayVoiceStateUpdate: OutgoingGatewayData, GatewayData {
 /// Guild Request Members
 ///
 /// > Outgoing Gateway data struct for opcode 8
-public struct GatewayGuildRequestMembers: GatewayData {
-    public let guild_id: Snowflake
+public struct GatewayGuildRequestMembers: OutgoingGatewayData, GatewayData {
+    public init(guild_id: [Snowflake], query: String? = nil, limit: Int? = nil, presences: Bool? = nil, user_ids: [Snowflake]? = nil, nonce: String? = nil) {
+        self.guild_id = guild_id
+        self.query = query
+        self.limit = limit
+        self.presences = presences
+        self.user_ids = user_ids
+        self.nonce = nonce
+    }
+
+    public let guild_id: [Snowflake]
     public let query: String?
-    public let limit: Int
+    public let limit: Int?
     public let presences: Bool? // Used to specify if we want the presences of the matched members
     public let user_ids: [Snowflake]? // Used to specify which users you wish to fetch
     public let nonce: String? // Nonce to identify the Guild Members Chunk response

Sources/DiscordKitCore/Objects/Gateway/Event/GuildMembersChunk.swift

@@ -0,0 +1,21 @@
+//
+//  GuildMembersChunk.swift
+//
+//
+//  Created by Vincent Kwok on 11/12/23.
+//
+
+import Foundation
+
+/// Guild Members Chunk
+/// 
+/// Sent in response to a
+public struct GuildMembersChunk: GatewayData {
+    public let guild_id: Snowflake
+    public let members: [Member]
+    public let chunk_index: Int
+    public let chunk_count: Int
+    public let not_found: [Snowflake]?
+    public let presences: [Presence]?
+    public let nonce: String?
+}

Sources/DiscordKitCore/Objects/Gateway/GatewayIO.swift

@@ -84,6 +84,9 @@ public struct GatewayIncoming: Decodable {
         /// > server outage.
         case guildDelete(GuildUnavailable)
 
+        /// Guild members chunk
+        case guildMembersChunk(GuildMembersChunk)
+
         // MARK: - Channels
 
         /// Channel create event
@@ -166,6 +169,19 @@ public struct GatewayIncoming: Decodable {
         /// > presence updates for users in a certain guild.
         case presenceUpdate(PresenceUpdate)
 
+        // MARK: - Guild Members
+
+        /// Guild member add
+        ///
+        /// Sent when a new user joins a guild
+        case guildMemberAdd(Member)
+
+        /// Guild member remove
+        case guildMemberRemove(GuildMemberRemove)
+
+        /// Guild member update
+        case guildMemberUpdate(GuildMemberUpdate)
+
         // MARK: - Interactions
 
         /// Interaction create event
@@ -238,6 +254,7 @@ public struct GatewayIncoming: Decodable {
             case .guildCreate: data = .guildCreate(try values.decode(Guild.self, forKey: .data))
             case .guildUpdate: data = .guildUpdate(try values.decode(Guild.self, forKey: .data))
             case .guildDelete: data = .guildDelete(try values.decode(GuildUnavailable.self, forKey: .data))
+            case .guildMembersChunk: data = .guildMembersChunk(try values.decode(GuildMembersChunk.self, forKey: .data))
 /*
             case .guildBanAdd, .guildBanRemove: data = try values.decode(GuildBan.self, forKey: .data)
             case .guildEmojisUpdate: data = try values.decode(GuildEmojisUpdate.self, forKey: .data)
@@ -264,6 +281,11 @@ public struct GatewayIncoming: Decodable {
             case .userUpdate: data = .userUpdate(try values.decode(CurrentUser.self, forKey: .data))
             case .presenceUpdate: data = .presenceUpdate(try values.decode(PresenceUpdate.self, forKey: .data))
 
+            // MARK: Members
+            case .guildMemberAdd: data = .guildMemberAdd(try values.decode(Member.self, forKey: .data))
+            case .guildMemberRemove: data = .guildMemberRemove(try values.decode(GuildMemberRemove.self, forKey: .data))
+            case .guildMemberUpdate: data = .guildMemberUpdate(try values.decode(GuildMemberUpdate.self, forKey: .data))
+
             // MARK: Interactions
             case .interactionCreate: data = .interaction(try values.decode(Interaction.self, forKey: .data))