api: Handle muted_users event

Author: sm-sayedi

lib/api/model/events.dart

@@ -62,6 +62,7 @@ sealed class Event {
         }
       // case 'muted_topics': … // TODO(#422) we ignore this feature on older servers
       case 'user_topic': return UserTopicEvent.fromJson(json);
+      case 'muted_users': return MutedUsersEvent.fromJson(json);
       case 'message': return MessageEvent.fromJson(json);
       case 'update_message': return UpdateMessageEvent.fromJson(json);
       case 'delete_message': return DeleteMessageEvent.fromJson(json);
@@ -733,6 +734,24 @@ class UserTopicEvent extends Event {
   Map<String, dynamic> toJson() => _$UserTopicEventToJson(this);
 }
 
+/// A Zulip event of type `muted_users`: https://zulip.com/api/get-events#muted_users
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUsersEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'muted_users';
+
+  final List<MutedUserItem> mutedUsers;
+
+  MutedUsersEvent({required super.id, required this.mutedUsers});
+
+  factory MutedUsersEvent.fromJson(Map<String, dynamic> json) =>
+    _$MutedUsersEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$MutedUsersEventToJson(this);
+}
+
 /// A Zulip event of type `message`: https://zulip.com/api/get-events#message
 @JsonSerializable(fieldRename: FieldRename.snake)
 class MessageEvent extends Event {

lib/api/model/events.g.dart

@@ -111,7 +111,7 @@ class CustomProfileFieldExternalAccountData {
 }
 
 
-/// An item in the [InitialSnapshot.mutedUsers].
+/// An item in the [InitialSnapshot.mutedUsers] or [MutedUsersEvent].
 ///
 /// For docs, search for "muted_users:"
 /// in <https://zulip.com/api/register-queue>.

lib/api/model/model.dart

@@ -950,6 +950,11 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         assert(debugLog("server event: reaction/${event.op}"));
         _messages.handleReactionEvent(event);
 
+      case MutedUsersEvent():
+        assert(debugLog("server event: muted_users"));
+        _users.handleMutedUsersEvent(event);
+        notifyListeners();
+
       case UnexpectedEvent():
         assert(debugLog("server event: ${jsonEncode(event.toJson())}")); // TODO log better
     }

lib/model/store.dart

@@ -164,4 +164,9 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
         }
     }
   }
+
+  void handleMutedUsersEvent(MutedUsersEvent event) {
+    mutedUsers.clear();
+    mutedUsers.addAll(_sortMutedUsers(event.mutedUsers));
+  }
 }