api: Complete support for CustomProfileField

Change `CustomProfileField.type` into a proper enum,
add support for server event `custom_profile_fields`.

Author: sirpengi

lib/api/model/events.dart

@@ -22,6 +22,7 @@ sealed class Event {
           case 'update': return UserSettingsUpdateEvent.fromJson(json);
           default: return UnexpectedEvent.fromJson(json);
         }
+      case 'custom_profile_fields': return CustomProfileFieldsEvent.fromJson(json);
       case 'realm_user':
         switch (json['op'] as String) {
           case 'add': return RealmUserAddEvent.fromJson(json);
@@ -130,6 +131,24 @@ class UserSettingsUpdateEvent extends Event {
   Map<String, dynamic> toJson() => _$UserSettingsUpdateEventToJson(this);
 }
 
+/// A Zulip event of type `custom_profile_fields`: https://zulip.com/api/get-events#custom_profile_fields
+@JsonSerializable(fieldRename: FieldRename.snake)
+class CustomProfileFieldsEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'custom_profile_fields';
+
+  final List<CustomProfileField> fields;
+
+  CustomProfileFieldsEvent({required super.id, required this.fields});
+
+  factory CustomProfileFieldsEvent.fromJson(Map<String, dynamic> json) =>
+    _$CustomProfileFieldsEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$CustomProfileFieldsEventToJson(this);
+}
+
 /// A Zulip event of type `realm_user`.
 ///
 /// The corresponding API docs are in several places for

lib/api/model/events.g.dart

@@ -9,7 +9,8 @@ part 'model.g.dart';
 @JsonSerializable(fieldRename: FieldRename.snake)
 class CustomProfileField {
   final int id;
-  final int type; // TODO enum; also TODO(server-6) a value added
+  @JsonKey(unknownEnumValue: CustomProfileFieldType.unknown)
+  final CustomProfileFieldType type;
   final int order;
   final String name;
   final String hint;
@@ -32,6 +33,28 @@ class CustomProfileField {
   Map<String, dynamic> toJson() => _$CustomProfileFieldToJson(this);
 }
 
+/// As in [CustomProfileField.type].
+@JsonEnum(fieldRename: FieldRename.snake, valueField: "apiValue")
+enum CustomProfileFieldType {
+  shortText(apiValue: 1),
+  longText(apiValue: 2),
+  choice(apiValue: 3),
+  date(apiValue: 4),
+  link(apiValue: 5),
+  user(apiValue: 6),
+  externalAccount(apiValue: 7),
+  pronouns(apiValue: 8), // TODO(server-6) newly added
+  unknown(apiValue: null);
+
+  const CustomProfileFieldType({
+    required this.apiValue
+  });
+
+  final int? apiValue;
+
+  int? toJson() => apiValue;
+}
+
 /// 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

@@ -152,6 +152,7 @@ class PerAccountStore extends ChangeNotifier {
   }) : zulipVersion = initialSnapshot.zulipVersion,
        maxFileUploadSizeMib = initialSnapshot.maxFileUploadSizeMib,
        realmDefaultExternalAccounts = initialSnapshot.realmDefaultExternalAccounts,
+       customProfileFields = initialSnapshot.customProfileFields,
        userSettings = initialSnapshot.userSettings,
        users = Map.fromEntries(
          initialSnapshot.realmUsers
@@ -174,6 +175,7 @@ class PerAccountStore extends ChangeNotifier {
   final String zulipVersion; // TODO get from account; update there on initial snapshot
   final int maxFileUploadSizeMib; // No event for this.
   final Map<String, RealmDefaultExternalAccount> realmDefaultExternalAccounts;
+  final List<CustomProfileField> customProfileFields;
 
   // Data attached to the self-account on the realm.
   final UserSettings? userSettings; // TODO(server-5)
@@ -236,6 +238,11 @@ class PerAccountStore extends ChangeNotifier {
           userSettings?.emojiset                  = event.value as Emojiset;
       }
       notifyListeners();
+    } else if (event is CustomProfileFieldsEvent) {
+      assert(debugLog("server event: custom_profile_fields"));
+      customProfileFields.clear();
+      customProfileFields.addAll(event.fields);
+      notifyListeners();
     } else if (event is RealmUserAddEvent) {
       assert(debugLog("server event: realm_user/add"));
       users[event.person.userId] = event.person;