OpenAPI: Migrate mute and unmute users to v2 endpoint and generate current user payload

CHANGELOG.md

@@ -10,6 +10,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Add `MemberSearch` for debounced channel member search [#4213](https://github.com/GetStream/stream-chat-swift/pull/4213)
 - Add `ChatChannel.truncatedBy`, `ChatChannel.isAutoTranslationEnabled` and `ChatChannel.autoTranslationLanguages` [#4197](https://github.com/GetStream/stream-chat-swift/pull/4197)
 - Add `ChatChannelMember.memberStatus` and `ChatChannelMember.memberDeletedAt` [#4197](https://github.com/GetStream/stream-chat-swift/pull/4197)
+- Add `CurrentChatUserController.muteUsers(_:expiration:completion:)` and `ConnectedUser.muteUsers(_:expiration:)` for muting multiple users at once with an optional expiration
+- Add `CurrentChatUserController.unmuteUsers(_:completion:)` and `ConnectedUser.unmuteUsers(_:)` for unmuting multiple users at once
+- Add `CurrentChatUser.totalUnreadCountByTeam` for accessing the unread message count per team
 ### 🐞 Fixed
 - Fix a rare crash caused by the main thread being blocked in `BackgroundDatabaseObserver.rawItems.getter` [#4218](https://github.com/GetStream/stream-chat-swift/pull/4218)
 - Fix unread count not clearing immediately when marking a channel as read [#4214](https://github.com/GetStream/stream-chat-swift/pull/4214)

DemoApp/StreamChat/Components/DemoChatChannelListRouter.swift

@@ -473,6 +473,50 @@ final class DemoChatChannelListRouter: ChatChannelListRouter {
                     }
                 }
             }),
+            .init(title: "Mute All Channel Members", handler: { [unowned self] _ in
+                let memberIds = Set(channelController.channel?.lastActiveMembers.map(\.id) ?? [])
+                    .subtracting([client.currentUserId ?? ""])
+                guard !memberIds.isEmpty else {
+                    self.rootViewController.presentAlert(title: "Channel \(cid) has no other members")
+                    return
+                }
+                client.currentUserController().muteUsers(memberIds) { [unowned self] result in
+                    switch result {
+                    case .success(let mutedUsers):
+                        self.rootViewController.presentAlert(
+                            title: "Muted \(mutedUsers.mutes?.count ?? 0) of \(memberIds.count) members",
+                            message: mutedUsers.nonExistingUsers.map { "Not found: \($0.joined(separator: ", "))" }
+                        )
+                    case .failure(let error):
+                        self.rootViewController.presentAlert(
+                            title: "Couldn't mute the members of channel \(cid)",
+                            message: "\(error)"
+                        )
+                    }
+                }
+            }),
+            .init(title: "Unmute All Channel Members", handler: { [unowned self] _ in
+                let memberIds = Set(channelController.channel?.lastActiveMembers.map(\.id) ?? [])
+                    .subtracting([client.currentUserId ?? ""])
+                guard !memberIds.isEmpty else {
+                    self.rootViewController.presentAlert(title: "Channel \(cid) has no other members")
+                    return
+                }
+                client.currentUserController().unmuteUsers(memberIds) { [unowned self] result in
+                    switch result {
+                    case .success(let response):
+                        self.rootViewController.presentAlert(
+                            title: "Unmuted \(memberIds.count) members",
+                            message: response.nonExistingUsers.map { "Not found: \($0.joined(separator: ", "))" }
+                        )
+                    case .failure(let error):
+                        self.rootViewController.presentAlert(
+                            title: "Couldn't unmute the members of channel \(cid)",
+                            message: "\(error)"
+                        )
+                    }
+                }
+            }),
             .init(title: "Mark channel unread with timestamp", isEnabled: true, handler: { [unowned self] _ in
                 self.rootViewController.presentAlert(title: "Mark messages as unread with timestamp", message: "Marks messages as unread from the last number of days", textFieldPlaceholder: "Days") { offsetInDaysString in
                     let calendar = Calendar.current

Scripts/openapi_generate.sh

@@ -37,6 +37,7 @@ allowed_endpoints=(
     listDevices
     listUserGroups
     markDelivered
+    mute
     muteChannel
     queryMembers
     queryPollVotes
@@ -47,6 +48,7 @@ allowed_endpoints=(
     showChannel
     stopWatchingChannel
     unblockUsers
+    unmute
     unmuteChannel
     unreadCounts
     updateLiveLocation
@@ -78,6 +80,7 @@ allowed_models=(
   CreateUserGroupRequest
   DeleteChannelResponse
   DeliveredMessagePayload
+  DeliveryReceiptsResponse
   DeviceResponse
   Field
   FileUploadConfig
@@ -98,6 +101,9 @@ allowed_models=(
   MembersResponse
   MuteChannelRequest
   MuteChannelResponse
+  MuteRequest
+  MuteResponse
+  OwnUserResponse
   PollOptionInput
   PollOptionResponse
   PollOptionResponseData
@@ -106,21 +112,26 @@ allowed_models=(
   PollVoteResponse
   PollVoteResponseData
   PollVotesResponse
+  PrivacySettingsResponse
   PushPreferenceInput
   PushPreferencesResponse
   QueryMembersPayload
   QueryPollVotesRequest
   QueryReactionsRequest
   ReactionResponse
+  ReadReceiptsResponse
   RemoveUserGroupMembersRequest
   Role
   SearchRolesResponse
   SharedLocationResponseData
   SharedLocationsResponse
   SortParamRequest
+  TypingIndicatorsResponse
   UnblockUsersRequest
   UnblockUsersResponse
   UnmuteChannelRequest
+  UnmuteRequest
+  UnmuteResponse
   UnreadCountsChannel
   UnreadCountsChannelType
   UnreadCountsThread
@@ -135,6 +146,7 @@ allowed_models=(
   UpsertPushPreferencesResponse
   UserGroupMember
   UserGroupResponse
+  UserMuteResponse
   UserResponse
   VoteData
   WrappedUnreadCountsResponse
@@ -400,12 +412,17 @@ rename_generated ChannelMemberResponse MemberPayload
 rename_generated ChannelMute MutedChannelPayload
 rename_generated ChannelResponse ChannelDetailPayload
 rename_generated MuteChannelResponse MutedChannelPayloadResponse
+rename_generated UnmuteResponse UnmuteUsersResponse
+rename_generated UserMuteResponse MutedUserPayload
+rename_generated DeliveryReceiptsResponse DeliveryReceiptsPrivacySettings
+rename_generated PrivacySettingsResponse UserPrivacySettings
+rename_generated ReadReceiptsResponse ReadReceiptsPrivacySettings
+rename_generated TypingIndicatorsResponse TypingIndicatorPrivacySettings
 
 rename_generated_type HideChannelResponse EmptyResponse
 rename_generated_type MarkDeliveredResponse EmptyResponse
 rename_generated_type Response EmptyResponse
 rename_generated_type ShowChannelResponse EmptyResponse
-rename_generated_type UnmuteResponse EmptyResponse
 
 # Remove a generated property (declaration, doc comment, init param, assignment,
 #     CodingKeys case). Runs before publicize, so there are no access modifiers to
@@ -439,6 +456,17 @@ optionalize_property MemberPayload channelRole
 optionalize_property MemberPayload notificationsMuted
 optionalize_property MemberPayload shadowBanned
 
+optionalize_property OwnUserResponse banned
+optionalize_property OwnUserResponse channelMutes
+optionalize_property OwnUserResponse devices
+optionalize_property OwnUserResponse invisible
+optionalize_property OwnUserResponse language
+optionalize_property OwnUserResponse mutes
+optionalize_property OwnUserResponse teams
+optionalize_property OwnUserResponse totalUnreadCount
+optionalize_property OwnUserResponse unreadChannels
+optionalize_property OwnUserResponse unreadThreads
+
 # Remove a generated property (declaration, doc comment, init param, assignment,
 #     CodingKeys case). Runs before publicize, so there are no access modifiers to
 #     handle. Assumes the single-line init the generator emits (step 7 re-wraps).
@@ -479,6 +507,8 @@ remove_property DeleteChannelResponse duration
 remove_property MutedChannelPayloadResponse channelMutes
 remove_property MutedChannelPayloadResponse duration
 remove_property MutedChannelPayloadResponse ownUser
+remove_property OwnUserResponse unreadCount
+remove_property UnmuteUsersResponse duration
 
 retype_property ChannelDetailPayload cid String ChannelId
 retype_property ChannelDetailPayload config ChannelConfigWithInfo ChannelConfig
@@ -497,40 +527,75 @@ remove_nested_enum() {
 remove_nested_enum PushPreferenceInput PushPreferenceInputCallLevel
 remove_nested_enum PushPreferenceInput PushPreferenceInputFeedsLevel
 
-# 4c. Expose selected generated models as public API. The class and its stored
+# Give a generated model mutable stored properties, so it can replace a hand-written
+#     public type whose properties were var. Mutable state rules out checked Sendable,
+#     hence the relaxed conformance. Runs before publicize_model, which anchors on the
+#     resulting var lines.
+make_model_mutable() {
+  local file="$OUTPUT_DIR_CHAT/models/$1.swift"
+  sed -i '' -E \
+    -e 's/^(final class [A-Za-z0-9_]+): Sendable,/\1: @unchecked Sendable,/' \
+    -e 's/^    let /    var /' \
+    "$file"
+}
+make_model_mutable DeliveryReceiptsPrivacySettings
+make_model_mutable ReadReceiptsPrivacySettings
+make_model_mutable TypingIndicatorPrivacySettings
+make_model_mutable UserPrivacySettings
+
+# 4c. Expose selected generated models as public API. The type and its stored
 #     properties become public, along with the generated Hashable conformance
 #     (== and hash(into:)); the memberwise init and CodingKeys stay internal.
 publicize_model() {
   local file="$OUTPUT_DIR_CHAT/models/$1.swift"
   sed -i '' -E \
     -e 's/^final class /public final class /' \
     -e 's/^    let /    public let /' \
+    -e 's/^    var /    public var /' \
     -e 's/^    static func == /    public static func == /' \
     -e 's/^    func hash\(into /    public func hash(into /' \
     "$file"
 }
 publicize_model AppSettings
 publicize_model CurrentUserUnreads
+publicize_model DeliveryReceiptsPrivacySettings
 publicize_model Device
 publicize_model PushPreference
+publicize_model ReadReceiptsPrivacySettings
 publicize_model Role
 publicize_model SharedLocation
+publicize_model TypingIndicatorPrivacySettings
+publicize_model UnmuteUsersResponse
 publicize_model UnreadChannel
 publicize_model UnreadChannelByType
 publicize_model UnreadThread
 publicize_model UploadConfig
 publicize_model UserGroup
 publicize_model UserGroupMember
+publicize_model UserPrivacySettings
 
-# Drop `final` from a generated model so hand-written payloads can subclass it.
-unfinalize_model() {
+# Expose a generated model's memberwise init, for models whose hand-written public
+#     counterpart had a public init.
+publicize_init() {
   local file="$OUTPUT_DIR_CHAT/models/$1.swift"
-  sed -i '' -E \
-    -e 's/^final class /class /' \
-    -e 's/^(class [A-Za-z0-9_]+): Sendable,/\1: @unchecked Sendable,/' \
-    "$file"
+  sed -i '' -E 's/^    init\(/    public init(/' "$file"
+}
+publicize_init DeliveryReceiptsPrivacySettings
+publicize_init ReadReceiptsPrivacySettings
+publicize_init TypingIndicatorPrivacySettings
+
+# Give a generated memberwise init parameter a default value, restoring one the
+#     hand-written public init had.
+default_init_parameter() {
+  local file="$OUTPUT_DIR_CHAT/models/$1.swift"
+  P="$2" D="$3" perl -0777 -pi -e '
+    my ($p, $d) = ($ENV{P}, $ENV{D});
+    s/([(,]\s*)\Q$p\E: ([^,)\n=]+)(?=[,)])/${1}$p: $2 = $d/;
+  ' "$file"
 }
-unfinalize_model UserPayload
+default_init_parameter DeliveryReceiptsPrivacySettings enabled true
+default_init_parameter ReadReceiptsPrivacySettings enabled true
+default_init_parameter TypingIndicatorPrivacySettings enabled true
 
 # 4d. Strip the generated Hashable conformance from every model not in
 #     allowed_hashable_models. The Hashable extension is always the last block in
@@ -613,7 +678,6 @@ inject_v1_endpoint_paths() {
     case banMember
     case flagUser
     case flagMessage
-    case muteUser(Bool)
 
 EOF
 
@@ -667,7 +731,6 @@ EOF
         case .banMember: return "moderation/ban"
         case .flagUser: return "moderation/flag"
         case .flagMessage: return "moderation/flag"
-        case let .muteUser(mute): return "moderation/\(mute ? "mute" : "unmute")"
 
 EOF
 

Sources/StreamChat/.openapi.sourcery.yml

@@ -1,5 +1,6 @@
 sources:
   - ./Generated/OpenAPI/models/ChannelDetailPayload.swift
+  - ./Generated/OpenAPI/models/OwnUserResponse.swift
   - ./Generated/OpenAPI/models/MemberPayload.swift
   - ./Generated/OpenAPI/models/MessageReactionPayload.swift
   - ./Generated/OpenAPI/models/UserPayload.swift
@@ -11,4 +12,5 @@ args:
   # v1 endpoints return the user's custom data flattened next to a wider set of keys than v2
   # declares, so those have to be excluded too when rebuilding the extra data.
   v1CodingKeys:
+    OwnUserResponse: UserPayloadsCodingKeys
     UserPayload: UserPayloadsCodingKeys

Sources/StreamChat/APIClient/Endpoints/EndpointPath+OfflineRequest.swift

@@ -61,8 +61,8 @@ extension EndpointPath {
              .markThreadUnread,
              .message,
              .messageAction,
+             .mute,
              .muteChannel,
-             .muteUser,
              .pinnedMessages,
              .queryMembers,
              .queryPollVotes,
@@ -82,6 +82,7 @@ extension EndpointPath {
              .translateMessage,
              .truncateChannel,
              .unblockUsers,
+             .unmute,
              .unmuteChannel,
              .unreadCounts,
              .updateChannel,

Sources/StreamChat/APIClient/Endpoints/ModerationEndpoints.swift

@@ -4,18 +4,6 @@
 
 import Foundation
 
-// MARK: - User muting
-
-extension Endpoint {
-    static func muteUser(_ userId: UserId) -> Endpoint<EmptyResponse> {
-        muteUser(true, with: userId)
-    }
-
-    static func unmuteUser(_ userId: UserId) -> Endpoint<EmptyResponse> {
-        muteUser(false, with: userId)
-    }
-}
-
 // MARK: - User banning
 
 extension Endpoint {
@@ -97,17 +85,3 @@ extension Endpoint {
         )
     }
 }
-
-// MARK: - Private
-
-private extension Endpoint {
-    static func muteUser(_ mute: Bool, with userId: UserId) -> Endpoint<EmptyResponse> {
-        .init(
-            path: .muteUser(mute),
-            method: .post,
-            queryItems: nil,
-            requiresConnectionId: false,
-            body: ["target_id": userId]
-        )
-    }
-}