api: Add UserGroupEvent types

Author: gnprice

lib/api/model/events.dart

@@ -30,6 +30,14 @@ sealed class Event {
           default: return UnexpectedEvent.fromJson(json);
         }
       case 'custom_profile_fields': return CustomProfileFieldsEvent.fromJson(json);
+      case 'user_group':
+        switch (json['op'] as String) {
+          case 'add': return UserGroupAddEvent.fromJson(json);
+          case 'update': return UserGroupUpdateEvent.fromJson(json);
+          // TODO(#1687): add_members, remove_members, add_subgroups, remove_subgroups
+          case 'remove': return UserGroupRemoveEvent.fromJson(json);
+          default: return UnexpectedEvent.fromJson(json);
+        }
       case 'realm_user':
         switch (json['op'] as String) {
           case 'add': return RealmUserAddEvent.fromJson(json);
@@ -206,6 +214,85 @@ class CustomProfileFieldsEvent extends Event {
   Map<String, dynamic> toJson() => _$CustomProfileFieldsEventToJson(this);
 }
 
+/// A Zulip event of type `user_group`.
+///
+/// See API docs starting at:
+///   https://zulip.com/api/get-events#user_group-add
+sealed class UserGroupEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'user_group';
+
+  String get op;
+
+  UserGroupEvent({required super.id});
+}
+
+/// A [UserGroupEvent] with op `add`: https://zulip.com/api/get-events#user_group-add
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserGroupAddEvent extends UserGroupEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'add';
+
+  final UserGroup group;
+
+  UserGroupAddEvent({required super.id, required this.group});
+
+  factory UserGroupAddEvent.fromJson(Map<String, dynamic> json) => _$UserGroupAddEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$UserGroupAddEventToJson(this);
+}
+
+/// A [UserGroupEvent] with op `update`: https://zulip.com/api/get-events#user_group-update
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserGroupUpdateEvent extends UserGroupEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'update';
+
+  final int groupId;
+  final UserGroupUpdateData data;
+
+  UserGroupUpdateEvent({required super.id, required this.groupId, required this.data});
+
+  factory UserGroupUpdateEvent.fromJson(Map<String, dynamic> json) => _$UserGroupUpdateEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$UserGroupUpdateEventToJson(this);
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserGroupUpdateData {
+  final String? name;
+  final String? description;
+  final bool? deactivated;
+
+  UserGroupUpdateData({required this.name, required this.description, required this.deactivated});
+
+  factory UserGroupUpdateData.fromJson(Map<String, dynamic> json) => _$UserGroupUpdateDataFromJson(json);
+
+  Map<String, dynamic> toJson() => _$UserGroupUpdateDataToJson(this);
+}
+
+/// A [UserGroupEvent] with op `remove`: https://zulip.com/api/get-events#user_group-remove
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserGroupRemoveEvent extends UserGroupEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'remove';
+
+  final int groupId;
+
+  UserGroupRemoveEvent({required super.id, required this.groupId});
+
+  factory UserGroupRemoveEvent.fromJson(Map<String, dynamic> json) => _$UserGroupRemoveEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$UserGroupRemoveEventToJson(this);
+}
+
 /// A Zulip event of type `realm_user`.
 ///
 /// The corresponding API docs are in several places for

lib/api/model/events.g.dart

@@ -199,11 +199,12 @@ enum Emojiset {
     .map((key, value) => MapEntry(value, key));
 }
 
-/// As in [InitialSnapshot.realmUserGroups].
+/// As in [InitialSnapshot.realmUserGroups] or [UserGroupAddEvent].
 @JsonSerializable(fieldRename: FieldRename.snake)
 class UserGroup {
   final int id;
 
+  // TODO(#1687) to maintain members, also act on user deactivation: https://github.com/zulip/zulip-flutter/issues/662#issuecomment-2405845356
   // List<int> members; // TODO(#1687) track group members
   // List<int> directSubgroupIds; // TODO(#1687) track group members
 
@@ -219,7 +220,7 @@ class UserGroup {
   @JsonKey(defaultValue: false)
   bool deactivated;
 
-  // TODO(#814): GroupSettingValue canAddMembersGroup, etc.
+  // TODO(#814): GroupSettingValue canAddMembersGroup, etc.; add to update event too
 
   UserGroup({
     required this.id,

lib/api/model/model.dart

@@ -901,6 +901,10 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         customProfileFields = _sortCustomProfileFields(event.fields);
         notifyListeners();
 
+      case UserGroupEvent():
+        assert(debugLog("server event: user_group/${event.op}"));
+        // TODO(#662) handle
+
       case RealmUserAddEvent():
         assert(debugLog("server event: realm_user/add"));
         _users.handleRealmUserEvent(event);