api: Add channel_folder event

Author: chrisbobbe

lib/api/model/events.dart

@@ -71,6 +71,13 @@ sealed class Event {
           case 'peer_remove': return SubscriptionPeerRemoveEvent.fromJson(json);
           default: return UnexpectedEvent.fromJson(json);
         }
+      case 'channel_folder':
+        switch (json['op'] as String) {
+          case 'add': return ChannelFolderAddEvent.fromJson(json);
+          case 'reorder': return ChannelFolderReorderEvent.fromJson(json);
+          case 'update': return ChannelFolderUpdateEvent.fromJson(json);
+          default: return UnexpectedEvent.fromJson(json);
+        }
       case 'user_status': return UserStatusEvent.fromJson(json);
       case 'user_topic': return UserTopicEvent.fromJson(json);
       case 'muted_users': return MutedUsersEvent.fromJson(json);
@@ -887,6 +894,103 @@ class SubscriptionPeerRemoveEvent extends SubscriptionEvent {
   Map<String, dynamic> toJson() => _$SubscriptionPeerRemoveEventToJson(this);
 }
 
+/// A Zulip event of type `channel_folder`.
+///
+/// The corresponding API docs are in several places for
+/// different values of `op`; see subclasses.
+sealed class ChannelFolderEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'channel_folder';
+
+  String get op;
+
+  ChannelFolderEvent({required super.id});
+}
+
+/// A [ChannelFolderEvent] with op `add`:
+///   https://zulip.com/api/get-events#channel_folder-add
+@JsonSerializable(fieldRename: FieldRename.snake)
+class ChannelFolderAddEvent extends ChannelFolderEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'add';
+
+  final ChannelFolder channelFolder;
+
+  ChannelFolderAddEvent({required super.id, required this.channelFolder});
+
+  factory ChannelFolderAddEvent.fromJson(Map<String, dynamic> json) =>
+    _$ChannelFolderAddEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$ChannelFolderAddEventToJson(this);
+}
+
+/// A [ChannelFolderEvent] with op `update`:
+///   https://zulip.com/api/get-events#channel_folder-update
+@JsonSerializable(fieldRename: FieldRename.snake)
+class ChannelFolderUpdateEvent extends ChannelFolderEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'update';
+
+  final int channelFolderId;
+  final ChannelFolderChange data;
+
+  ChannelFolderUpdateEvent({
+    required super.id,
+    required this.channelFolderId,
+    required this.data,
+  });
+
+  factory ChannelFolderUpdateEvent.fromJson(Map<String, dynamic> json) =>
+    _$ChannelFolderUpdateEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$ChannelFolderUpdateEventToJson(this);
+}
+
+/// Details of a channel-folder change, as in [ChannelFolderUpdateEvent.data].
+@JsonSerializable(fieldRename: FieldRename.snake)
+class ChannelFolderChange {
+  final String? name;
+  final String? description;
+  final String? renderedDescription;
+  final bool? isArchived;
+
+  ChannelFolderChange({
+    required this.name,
+    required this.description,
+    required this.renderedDescription,
+    required this.isArchived,
+  });
+
+  factory ChannelFolderChange.fromJson(Map<String, dynamic> json) =>
+    _$ChannelFolderChangeFromJson(json);
+
+  Map<String, dynamic> toJson() => _$ChannelFolderChangeToJson(this);
+}
+
+/// A [ChannelFolderEvent] with op `update`:
+///   https://zulip.com/api/get-events#channel_folder-update
+@JsonSerializable(fieldRename: FieldRename.snake)
+class ChannelFolderReorderEvent extends ChannelFolderEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'reorder';
+
+  final List<int> order;
+
+  ChannelFolderReorderEvent({required super.id, required this.order});
+
+  factory ChannelFolderReorderEvent.fromJson(Map<String, dynamic> json) =>
+    _$ChannelFolderReorderEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$ChannelFolderReorderEventToJson(this);
+}
+
 /// A Zulip event of type `user_status`: https://zulip.com/api/get-events#user_status
 @JsonSerializable(fieldRename: FieldRename.snake, createToJson: false)
 class UserStatusEvent extends Event {

lib/api/model/events.g.dart

@@ -829,6 +829,11 @@ class PerAccountStore extends PerAccountStoreBase with
         _channels.handleSubscriptionEvent(event);
         notifyListeners();
 
+      case ChannelFolderEvent():
+        assert(debugLog("server event: channel_folder/${event.op}"));
+        // TODO handle
+        break;
+
       case UserStatusEvent():
         assert(debugLog("server event: user_status"));
         _users.handleUserStatusEvent(event);