api: Convert User.role into enum

Author: sirpengi

lib/api/model/events.dart

@@ -211,7 +211,7 @@ class RealmUserUpdateEvent extends RealmUserEvent {
   @JsonKey(readValue: _readFromPerson) final int? avatarVersion;
   @JsonKey(readValue: _readFromPerson) final String? timezone;
   @JsonKey(readValue: _readFromPerson) final int? botOwnerId;
-  @JsonKey(readValue: _readFromPerson) final int? role; // TODO enum
+  @JsonKey(readValue: _readFromPerson, unknownEnumValue: UserRole.unknown) final UserRole? role;
   @JsonKey(readValue: _readFromPerson) final bool? isBillingAdmin;
   @JsonKey(readValue: _readFromPerson) final String? deliveryEmail; // TODO handle JSON `null`
   @JsonKey(readValue: _readFromPerson) final RealmUserUpdateCustomProfileField? customProfileField;

lib/api/model/events.g.dart

@@ -56,7 +56,8 @@ class User {
   bool isBot;
   int? botType; // TODO enum
   int? botOwnerId;
-  int role; // TODO enum
+  @JsonKey(unknownEnumValue: UserRole.unknown)
+  UserRole role;
   String timezone;
   String? avatarUrl; // TODO distinguish null from missing https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/flutter.3A.20omitted.20vs.2E.20null.20in.20JSON/near/1551759
   int avatarVersion;
@@ -121,6 +122,25 @@ class ProfileFieldUserData {
   Map<String, dynamic> toJson() => _$ProfileFieldUserDataToJson(this);
 }
 
+/// As in [User.role].
+@JsonEnum(valueField: "apiValue")
+enum UserRole{
+  owner(apiValue: 100),
+  administrator(apiValue: 200),
+  moderator(apiValue: 300),
+  member(apiValue: 400),
+  guest(apiValue: 600),
+  unknown(apiValue: null);
+
+  const UserRole({
+    required this.apiValue,
+  });
+
+  final int? apiValue;
+
+  int? toJson() => apiValue;
+}
+
 /// As in `streams` in the initial snapshot.
 ///
 /// Not called `Stream` because dart:async uses that name.

lib/api/model/model.dart

@@ -28,7 +28,7 @@ User user({
     isGuest: false,
     isBillingAdmin: false,
     isBot: false,
-    role: 400,
+    role: UserRole.member,
     timezone: 'UTC',
     avatarUrl: avatarUrl,
     avatarVersion: 0,