api: Add realmUserGroups to InitialSnapshot

Author: gnprice

lib/api/model/initial_snapshot.dart

@@ -56,6 +56,8 @@ class InitialSnapshot {
 
   final Map<String, RealmEmojiItem> realmEmoji;
 
+  final List<UserGroup> realmUserGroups;
+
   final List<RecentDmConversation> recentPrivateConversations;
 
   final List<SavedSnippet>? savedSnippets; // TODO(server-10)
@@ -149,6 +151,7 @@ class InitialSnapshot {
     required this.mutedUsers,
     required this.presences,
     required this.realmEmoji,
+    required this.realmUserGroups,
     required this.recentPrivateConversations,
     required this.savedSnippets,
     required this.subscriptions,

lib/api/model/initial_snapshot.g.dart

@@ -199,6 +199,41 @@ enum Emojiset {
     .map((key, value) => MapEntry(value, key));
 }
 
+/// As in [InitialSnapshot.realmUserGroups].
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserGroup {
+  final int id;
+
+  // List<int> members; // TODO(#1687) track group members
+  // List<int> directSubgroupIds; // TODO(#1687) track group members
+
+  String name;
+  String description;
+
+  // final int? dateCreated; // not using; ignore
+  // final int? creatorId; // not using; ignore
+
+  final bool isSystemGroup;
+
+  // TODO(server-10): [deactivated] new in FL 290; previously no groups were deactivated
+  @JsonKey(defaultValue: false)
+  bool deactivated;
+
+  // TODO(#814): GroupSettingValue canAddMembersGroup, etc.
+
+  UserGroup({
+    required this.id,
+    required this.name,
+    required this.description,
+    required this.isSystemGroup,
+    required this.deactivated,
+  });
+
+  factory UserGroup.fromJson(Map<String, dynamic> json) => _$UserGroupFromJson(json);
+
+  Map<String, dynamic> toJson() => _$UserGroupToJson(this);
+}
+
 /// As in [InitialSnapshot.realmUsers], [InitialSnapshot.realmNonActiveUsers], and [InitialSnapshot.crossRealmBots].
 ///
 /// In the Zulip API, the items in realm_users, realm_non_active_users, and

lib/api/model/model.dart

@@ -2,6 +2,14 @@ import 'package:checks/checks.dart';
 import 'package:zulip/api/model/model.dart';
 import 'package:zulip/api/model/submessage.dart';
 
+extension UserGroupChecks on Subject<UserGroup> {
+  Subject<int> get id => has((x) => x.id, 'id');
+  Subject<String> get name => has((x) => x.name, 'name');
+  Subject<String> get description => has((x) => x.description, 'description');
+  Subject<bool> get isSystemGroup => has((x) => x.isSystemGroup, 'isSystemGroup');
+  Subject<bool> get deactivated => has((x) => x.deactivated, 'deactivated');
+}
+
 extension UserChecks on Subject<User> {
   Subject<int> get userId => has((x) => x.userId, 'userId');
   Subject<String?> get deliveryEmail => has((x) => x.deliveryEmail, 'deliveryEmail');

lib/api/model/model.g.dart

@@ -166,6 +166,26 @@ ServerEmojiData serverEmojiDataPopularLegacy = ServerEmojiData(codeToNames: {
   '1f419': ['octopus'],
 });
 
+/// A fresh user-group ID, from a random but always strictly increasing sequence.
+int _nextUserGroupId() => (_lastUserGroupId += 1 + Random().nextInt(10));
+int _lastUserGroupId = 100;
+
+UserGroup userGroup({
+  int? id,
+  String? name,
+  String? description,
+  bool isSystemGroup = false,
+  bool deactivated = false,
+}) {
+  return UserGroup(
+    id: id ??= _nextUserGroupId(),
+    name: name ??= 'group-$id',
+    description: description ?? 'A group named $name',
+    isSystemGroup: isSystemGroup,
+    deactivated: deactivated,
+  );
+}
+
 RealmEmojiItem realmEmojiItem({
   required String emojiCode,
   required String emojiName,
@@ -1112,6 +1132,7 @@ InitialSnapshot initialSnapshot({
   List<MutedUserItem>? mutedUsers,
   Map<int, PerUserPresence>? presences,
   Map<String, RealmEmojiItem>? realmEmoji,
+  List<UserGroup>? realmUserGroups,
   List<RecentDmConversation>? recentPrivateConversations,
   List<SavedSnippet>? savedSnippets,
   List<Subscription>? subscriptions,
@@ -1153,6 +1174,7 @@ InitialSnapshot initialSnapshot({
     mutedUsers: mutedUsers ?? [],
     presences: presences ?? {},
     realmEmoji: realmEmoji ?? {},
+    realmUserGroups: realmUserGroups ?? [],
     recentPrivateConversations: recentPrivateConversations ?? [],
     savedSnippets: savedSnippets ?? [],
     subscriptions: subscriptions ?? [], // TODO add subscriptions to default