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,74 @@ 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;
+}
+
+/// An item in the realm-level field data for a "choice" custom profile field.
+///
+/// The value of [CustomProfileField.fieldData] decodes to a
+/// `List<CustomProfileFieldChoiceDataItem>` when
+/// the [CustomProfileField.type] is [CustomProfileFieldType.choice].
+///
+/// TODO(server): This isn't really documented.  But see chat thread:
+///   https://chat.zulip.org/#narrow/stream/378-api-design/topic/custom.20profile.20fields/near/1383005
+@JsonSerializable(fieldRename: FieldRename.snake)
+class CustomProfileFieldChoiceDataItem {
+  final String text;
+
+  const CustomProfileFieldChoiceDataItem({required this.text});
+
+  factory CustomProfileFieldChoiceDataItem.fromJson(Map<String, dynamic> json) =>
+    _$CustomProfileFieldChoiceDataItemFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CustomProfileFieldChoiceDataItemToJson(this);
+
+  static Map<String, CustomProfileFieldChoiceDataItem> parseFieldDataChoices(Map<String, dynamic> json) =>
+    json.map((k, v) => MapEntry(k, CustomProfileFieldChoiceDataItem.fromJson(v)));
+}
+
+/// The realm-level field data for an "external account" custom profile field.
+///
+/// This is the decoding of [CustomProfileField.fieldData] when
+/// the [CustomProfileField.type] is [CustomProfileFieldType.externalAccount].
+///
+/// TODO(server): This is undocumented.  See chat thread:
+///   https://chat.zulip.org/#narrow/stream/378-api-design/topic/external.20account.20custom.20profile.20fields/near/1387213
+@JsonSerializable(fieldRename: FieldRename.snake)
+class CustomProfileFieldExternalAccountData {
+  final String subtype;
+  final String? urlPattern;
+
+  const CustomProfileFieldExternalAccountData({
+    required this.subtype,
+    required this.urlPattern,
+  });
+
+  factory CustomProfileFieldExternalAccountData.fromJson(Map<String, dynamic> json) =>
+    _$CustomProfileFieldExternalAccountDataFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CustomProfileFieldExternalAccountDataToJson(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

@@ -152,6 +152,7 @@ class PerAccountStore extends ChangeNotifier {
   }) : zulipVersion = initialSnapshot.zulipVersion,
        maxFileUploadSizeMib = initialSnapshot.maxFileUploadSizeMib,
        realmDefaultExternalAccounts = initialSnapshot.realmDefaultExternalAccounts,
+       customProfileFields = _sortCustomProfileFields(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;
+  List<CustomProfileField> customProfileFields;
 
   // Data attached to the self-account on the realm.
   final UserSettings? userSettings; // TODO(server-5)
@@ -236,6 +238,10 @@ class PerAccountStore extends ChangeNotifier {
           userSettings?.emojiset                  = event.value as Emojiset;
       }
       notifyListeners();
+    } else if (event is CustomProfileFieldsEvent) {
+      assert(debugLog("server event: custom_profile_fields"));
+      customProfileFields = _sortCustomProfileFields(event.fields);
+      notifyListeners();
     } else if (event is RealmUserAddEvent) {
       assert(debugLog("server event: realm_user/add"));
       users[event.person.userId] = event.person;
@@ -321,6 +327,21 @@ class PerAccountStore extends ChangeNotifier {
     //   https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/.23M3881.20Sending.20outbox.20messages.20is.20fraught.20with.20issues/near/1405739
     return _apiSendMessage(connection, destination: destination, content: content);
   }
+
+  static List<CustomProfileField> _sortCustomProfileFields(List<CustomProfileField> initialCustomProfileFields) {
+    // TODO(server): The realm-wide field objects have an `order` property,
+    //   but the actual API appears to be that the fields should be shown in
+    //   the order they appear in the array (`custom_profile_fields` in the
+    //   API; our `realmFields` array here.)  See chat thread:
+    //     https://chat.zulip.org/#narrow/stream/378-api-design/topic/custom.20profile.20fields/near/1382982
+    //
+    // We go on to put at the start of the list any fields that are marked for
+    // displaying in the "profile summary".  (Possibly they should be at the
+    // start of the list in the first place, but make sure just in case.)
+    final displayFields = initialCustomProfileFields.where((e) => e.displayInProfileSummary == true);
+    final nonDisplayFields = initialCustomProfileFields.where((e) => e.displayInProfileSummary != true);
+    return displayFields.followedBy(nonDisplayFields).toList();
+  }
 }
 
 const _apiSendMessage = sendMessage; // Bit ugly; for alternatives, see: https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/flutter.3A.20PerAccountStore.20methods/near/1545809

lib/api/model/model.g.dart

@@ -1,3 +1,5 @@
+import 'dart:convert';
+
 import 'package:checks/checks.dart';
 import 'package:test/scaffolding.dart';
 import 'package:zulip/api/model/model.dart';
@@ -7,6 +9,20 @@ import '../../stdlib_checks.dart';
 import 'model_checks.dart';
 
 void main() {
+  test('CustomProfileFieldChoiceDataItem', () {
+    const input = '''{
+      "0": {"text": "Option 0", "order": 1},
+      "1": {"text": "Option 1", "order": 2},
+      "2": {"text": "Option 2", "order": 3}
+    }''';
+    final choices = CustomProfileFieldChoiceDataItem.parseFieldDataChoices(jsonDecode(input));
+    check(choices).jsonEquals({
+      '0': const CustomProfileFieldChoiceDataItem(text: 'Option 0'),
+      '1': const CustomProfileFieldChoiceDataItem(text: 'Option 1'),
+      '2': const CustomProfileFieldChoiceDataItem(text: 'Option 2'),
+    });
+  });
+
   group('User', () {
     final Map<String, dynamic> baseJson = Map.unmodifiable({
       'user_id': 123,