Implement stream and topic muting

assets/l10n/app_en.arb

@@ -342,12 +342,9 @@
   "@serverUrlValidationErrorUnsupportedScheme": {
     "description": "Error message when URL has an unsupported scheme."
   },
-  "markAsReadLabel": "Mark {num, plural, =1{1 message} other{{num} messages}} as read",
-  "@markAsReadLabel": {
-    "description": "Button text to mark messages as read.",
-    "placeholders": {
-      "num": {"type": "int", "example": "4"}
-    }
+  "markAllAsReadLabel": "Mark all messages as read",
+  "@markAllAsReadLabel": {
+    "description": "Button text to mark messages as read."
   },
   "markAsReadComplete": "Marked {num, plural, =1{1 message} other{{num} messages}} as read.",
   "@markAsReadComplete": {

lib/api/model/events.dart

@@ -1,6 +1,5 @@
 import 'package:json_annotation/json_annotation.dart';
 
-import 'initial_snapshot.dart';
 import 'model.dart';
 
 part 'events.g.dart';
@@ -35,6 +34,13 @@ sealed class Event {
           case 'update': return RealmUserUpdateEvent.fromJson(json);
           default: return UnexpectedEvent.fromJson(json);
         }
+      case 'stream':
+        switch (json['op'] as String) {
+          case 'create': return StreamCreateEvent.fromJson(json);
+          case 'delete': return StreamDeleteEvent.fromJson(json);
+          // TODO(#182): case 'update': …
+          default: return UnexpectedEvent.fromJson(json);
+        }
       case 'subscription':
         switch (json['op'] as String) {
           case 'add': return SubscriptionAddEvent.fromJson(json);
@@ -44,13 +50,8 @@ sealed class Event {
           case 'peer_remove': return SubscriptionPeerRemoveEvent.fromJson(json);
           default: return UnexpectedEvent.fromJson(json);
         }
-      case 'stream':
-        switch (json['op'] as String) {
-          case 'create': return StreamCreateEvent.fromJson(json);
-          case 'delete': return StreamDeleteEvent.fromJson(json);
-          // TODO(#182): case 'update': …
-          default: return UnexpectedEvent.fromJson(json);
-        }
+      // case 'muted_topics': … // TODO(#422) we ignore this feature on older servers
+      case 'user_topic': return UserTopicEvent.fromJson(json);
       case 'message': return MessageEvent.fromJson(json);
       case 'update_message': return UpdateMessageEvent.fromJson(json);
       case 'delete_message': return DeleteMessageEvent.fromJson(json);
@@ -195,7 +196,7 @@ class CustomProfileFieldsEvent extends Event {
 ///
 /// The corresponding API docs are in several places for
 /// different values of `op`; see subclasses.
-abstract class RealmUserEvent extends Event {
+sealed class RealmUserEvent extends Event {
   @override
   @JsonKey(includeToJson: true)
   String get type => 'realm_user';
@@ -308,6 +309,57 @@ class RealmUserUpdateEvent extends RealmUserEvent {
   Map<String, dynamic> toJson() => _$RealmUserUpdateEventToJson(this);
 }
 
+/// A Zulip event of type `stream`.
+///
+/// The corresponding API docs are in several places for
+/// different values of `op`; see subclasses.
+sealed class StreamEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'stream';
+
+  String get op;
+
+  StreamEvent({required super.id});
+}
+
+/// A [StreamEvent] with op `create`: https://zulip.com/api/get-events#stream-create
+@JsonSerializable(fieldRename: FieldRename.snake)
+class StreamCreateEvent extends StreamEvent {
+  @override
+  String get op => 'create';
+
+  final List<ZulipStream> streams;
+
+  StreamCreateEvent({required super.id, required this.streams});
+
+  factory StreamCreateEvent.fromJson(Map<String, dynamic> json) =>
+    _$StreamCreateEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$StreamCreateEventToJson(this);
+}
+
+/// A [StreamEvent] with op `delete`: https://zulip.com/api/get-events#stream-delete
+@JsonSerializable(fieldRename: FieldRename.snake)
+class StreamDeleteEvent extends StreamEvent {
+  @override
+  String get op => 'delete';
+
+  final List<ZulipStream> streams;
+
+  StreamDeleteEvent({required super.id, required this.streams});
+
+  factory StreamDeleteEvent.fromJson(Map<String, dynamic> json) =>
+    _$StreamDeleteEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$StreamDeleteEventToJson(this);
+}
+
+// TODO(#182) StreamUpdateEvent, for a [StreamEvent] with op `update`:
+//   https://zulip.com/api/get-events#stream-update
+
 /// A Zulip event of type `subscription`.
 ///
 /// The corresponding API docs are in several places for
@@ -492,57 +544,33 @@ class SubscriptionPeerRemoveEvent extends SubscriptionEvent {
   Map<String, dynamic> toJson() => _$SubscriptionPeerRemoveEventToJson(this);
 }
 
-/// A Zulip event of type `stream`.
-///
-/// The corresponding API docs are in several places for
-/// different values of `op`; see subclasses.
-abstract class StreamEvent extends Event {
-  @override
-  @JsonKey(includeToJson: true)
-  String get type => 'stream';
-
-  String get op;
-
-  StreamEvent({required super.id});
-}
-
-/// A [StreamEvent] with op `create`: https://zulip.com/api/get-events#stream-create
+/// A Zulip event of type `user_topic`: https://zulip.com/api/get-events#user_topic
 @JsonSerializable(fieldRename: FieldRename.snake)
-class StreamCreateEvent extends StreamEvent {
+class UserTopicEvent extends Event {
   @override
-  String get op => 'create';
-
-  final List<ZulipStream> streams;
-
-  StreamCreateEvent({required super.id, required this.streams});
-
-  factory StreamCreateEvent.fromJson(Map<String, dynamic> json) =>
-    _$StreamCreateEventFromJson(json);
-
-  @override
-  Map<String, dynamic> toJson() => _$StreamCreateEventToJson(this);
-}
-
-/// A [StreamEvent] with op `delete`: https://zulip.com/api/get-events#stream-delete
-@JsonSerializable(fieldRename: FieldRename.snake)
-class StreamDeleteEvent extends StreamEvent {
-  @override
-  String get op => 'delete';
+  @JsonKey(includeToJson: true)
+  String get type => 'user_topic';
 
-  final List<ZulipStream> streams;
+  final int streamId;
+  final String topicName;
+  final int lastUpdated;
+  final UserTopicVisibilityPolicy visibilityPolicy;
 
-  StreamDeleteEvent({required super.id, required this.streams});
+  UserTopicEvent({
+    required super.id,
+    required this.streamId,
+    required this.topicName,
+    required this.lastUpdated,
+    required this.visibilityPolicy,
+  });
 
-  factory StreamDeleteEvent.fromJson(Map<String, dynamic> json) =>
-    _$StreamDeleteEventFromJson(json);
+  factory UserTopicEvent.fromJson(Map<String, dynamic> json) =>
+    _$UserTopicEventFromJson(json);
 
   @override
-  Map<String, dynamic> toJson() => _$StreamDeleteEventToJson(this);
+  Map<String, dynamic> toJson() => _$UserTopicEventToJson(this);
 }
 
-// TODO(#182) StreamUpdateEvent, for a [StreamEvent] with op `update`:
-//   https://zulip.com/api/get-events#stream-update
-
 /// A Zulip event of type `message`: https://zulip.com/api/get-events#message
 // TODO use [JsonSerializable] here too, using its customization features,
 //   in order to skip the boilerplate in [fromJson] and [toJson].