Add channelRole filter key for ChannelListQuery (#3802)

Author: laevandus

CHANGELOG.md

@@ -3,7 +3,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 # Upcoming
 
-### 🔄 Changed
+## StreamChat
+### ✅ Added
+- Add `FilterKey.channelRole` for `ChannelListQuery` [3802](https://github.com/GetStream/stream-chat-swift/pull/3802)
 
 # [4.87.0](https://github.com/GetStream/stream-chat-swift/releases/tag/4.87.0)
 _August 29, 2025_

DemoApp/StreamChat/Components/DemoChatChannelListVC.swift

@@ -58,6 +58,13 @@ final class DemoChatChannelListVC: ChatChannelListVC {
             ])
         ])
     )
+    
+    lazy var channelModeratorChannelsQuery: ChannelListQuery = .init(
+        filter: .and([
+            .containMembers(userIds: [currentUserId]),
+            .equal(.channelRole, to: "channel_moderator")
+        ])
+    )
 
     lazy var unreadCountChannelsQuery: ChannelListQuery = .init(
         filter: .and([
@@ -180,6 +187,15 @@ final class DemoChatChannelListVC: ChatChannelListVC {
                 self?.setBlockedUnblockedWithHiddenChannelsQuery()
             }
         )
+        
+        let channelRoleChannelsAction = UIAlertAction(
+            title: "Moderator Channels",
+            style: .default,
+            handler: { [weak self] _ in
+                self?.title = "Moderator Channels"
+                self?.setChannelModeratorChannelsQuery()
+            }
+        )
 
         let unreadCountChannelsAction = UIAlertAction(
             title: "Unread Count Channels",
@@ -254,7 +270,8 @@ final class DemoChatChannelListVC: ChatChannelListVC {
                 coolChannelsAction,
                 pinnedChannelsAction,
                 archivedChannelsAction,
-                equalMembersAction
+                equalMembersAction,
+                channelRoleChannelsAction
             ].sorted(by: { $0.title ?? "" < $1.title ?? "" }),
             preferredStyle: .actionSheet,
             sourceView: filterChannelsButton
@@ -272,6 +289,10 @@ final class DemoChatChannelListVC: ChatChannelListVC {
     func setBlockedUnblockedWithHiddenChannelsQuery() {
         replaceQuery(blockedUnblockedWithHiddenChannelsQuery)
     }
+    
+    func setChannelModeratorChannelsQuery() {
+        replaceQuery(channelModeratorChannelsQuery)
+    }
 
     func setUnreadCountChannelsQuery() {
         replaceQuery(unreadCountChannelsQuery)

Sources/StreamChat/Database/DTOs/MemberModelDTO.swift

@@ -122,7 +122,7 @@ extension NSManagedObjectContext {
 
         // Save member specific data
         if let role = payload.role {
-            dto.channelRoleRaw = role.rawValue
+            dto.channelRoleRaw = role.rawChannelValue
         }
 
         dto.memberCreatedAt = payload.createdAt.bridgeDate
@@ -213,7 +213,7 @@ extension ChatChannelMember {
             memberExtraData = [:]
         }
 
-        let role = dto.channelRoleRaw.flatMap { MemberRole(rawValue: $0) } ?? .member
+        let role = dto.channelRoleRaw.flatMap { MemberRole(rawChannelValue: $0) } ?? .member
         let language: TranslationLanguage? = dto.user.language.map(TranslationLanguage.init)
 
         var member = ChatChannelMember(

Sources/StreamChat/Models/Member.swift

@@ -172,11 +172,26 @@ public struct MemberRole: RawRepresentable, Codable, Hashable, ExpressibleByStri
 
     public init(rawValue: String) {
         self.rawValue = rawValue
+        rawChannelValue = rawValue
     }
 
     public init(stringLiteral value: String) {
         self.init(rawValue: value)
     }
+    
+    init(rawChannelValue: String) {
+        // Historically these have been mapped when decoding JSON
+        switch rawChannelValue {
+        case "channel_member":
+            self.init(rawValue: Self.member.rawValue)
+        case "channel_moderator":
+            self.init(rawValue: Self.moderator.rawValue)
+        default:
+            self.init(rawValue: rawChannelValue)
+        }
+    }
+    
+    var rawChannelValue: String
 }
 
 public extension MemberRole {
@@ -207,6 +222,8 @@ public extension MemberRole {
         default:
             self = MemberRole(rawValue: value)
         }
+        // Store the original raw value from the backend for local filtering
+        rawChannelValue = value
     }
 
     func encode(to encoder: any Encoder) throws {

Sources/StreamChat/Query/ChannelListQuery.swift

@@ -287,6 +287,10 @@ public extension FilterKey where Scope == ChannelListFilterScope {
     /// Filter for the time of the last message in the channel. If the channel has no messages, then the time the channel was created.
     /// Supported operators: `equal`, `greaterThan`, `lessThan`, `greaterOrEqual`, `lessOrEqual`
     static var lastUpdatedAt: FilterKey<Scope, Date> { .init(rawValue: "last_updated", keyPathString: #keyPath(ChannelDTO.defaultSortingAt)) }
+    
+    /// Filter for checking if the current user has a specific channel role set.
+    /// Supported operatios: `equal`, `in`
+    static var channelRole: FilterKey<Scope, String> { .init(rawValue: "channel_role", keyPathString: #keyPath(ChannelDTO.membership.channelRoleRaw)) }
 }
 
 /// Internal filter queries for the channel list.