Track user status

lib/api/model/events.dart

@@ -61,6 +61,7 @@ sealed class Event {
           default: return UnexpectedEvent.fromJson(json);
         }
       // case 'muted_topics': … // TODO(#422) we ignore this feature on older servers
+      case 'user_status': return UserStatusEvent.fromJson(json);
       case 'user_topic': return UserTopicEvent.fromJson(json);
       case 'muted_users': return MutedUsersEvent.fromJson(json);
       case 'message': return MessageEvent.fromJson(json);
@@ -708,6 +709,57 @@ class SubscriptionPeerRemoveEvent extends SubscriptionEvent {
   Map<String, dynamic> toJson() => _$SubscriptionPeerRemoveEventToJson(this);
 }
 
+/// A Zulip event of type `user_status`: https://zulip.com/api/get-events#user_status
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserStatusEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'user_status';
+
+  final int userId;
+  // final bool away; // deprecated in server-6 (FL-148); ignore
+  final String? statusText;
+  final String? emojiName;
+  final String? emojiCode;
+  final UserStatusEventReactionType? reactionType;
+
+  UserStatusEvent({
+    required super.id,
+    required this.userId,
+    required this.statusText,
+    required this.emojiName,
+    required this.emojiCode,
+    required this.reactionType,
+  });
+
+  factory UserStatusEvent.fromJson(Map<String, dynamic> json) =>
+    _$UserStatusEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$UserStatusEventToJson(this);
+}
+
+/// As in [UserStatusEvent.reactionType].
+///
+/// This is the same as [ReactionType], but with an additional value "empty"
+/// representing an empty string value in [UserStatusEvent] where no status
+/// emoji is selected.
+@JsonEnum(fieldRename: FieldRename.snake)
+enum UserStatusEventReactionType {
+  unicodeEmoji,
+  realmEmoji,
+  zulipExtraEmoji,
+  @JsonValue('')
+  empty;
+
+  String toJson() => _$UserStatusEventReactionTypeEnumMap[this]!;
+
+  static UserStatusEventReactionType fromApiValue(String value) => _byApiValue[value]!;
+
+  static final _byApiValue = _$UserStatusEventReactionTypeEnumMap
+    .map((key, value) => MapEntry(value, key));
+}
+
 /// A Zulip event of type `user_topic`: https://zulip.com/api/get-events#user_topic
 @JsonSerializable(fieldRename: FieldRename.snake)
 class UserTopicEvent extends Event {

lib/api/model/initial_snapshot.dart

@@ -66,6 +66,12 @@ class InitialSnapshot {
 
   final List<ZulipStream> streams;
 
+  @JsonKey(name: 'user_status')
+  // In register-queue, the name of this field is the singular "user_status",
+  // even though it actually contains user status information for all the users
+  // that the self-user has access to. Therefore, we prefer to use the plural form.
+  final Map<int, UserStatus> userStatuses;
+
   // Servers pre-5.0 don't have `user_settings`, and instead provide whatever
   // user settings they support at toplevel in the initial snapshot. Since we're
   // likely to desupport pre-5.0 servers before wide release, we prefer to
@@ -154,6 +160,7 @@ class InitialSnapshot {
     required this.subscriptions,
     required this.unreadMsgs,
     required this.streams,
+    required this.userStatuses,
     required this.userSettings,
     required this.userTopics,
     required this.realmWildcardMentionPolicy,

lib/api/model/model.dart

@@ -158,6 +158,31 @@ class RealmEmojiItem {
   Map<String, dynamic> toJson() => _$RealmEmojiItemToJson(this);
 }
 
+/// A value in [InitialSnapshot.userStatuses].
+///
+/// For docs, search for "user_status:"
+/// in <https://zulip.com/api/register-queue>.
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UserStatus {
+  // final bool? away; // deprecated in server-6 (FL-148); ignore
+  final String? statusText;
+  final String? emojiName;
+  final String? emojiCode;
+  final ReactionType? reactionType;
+
+  UserStatus({
+    required this.statusText,
+    required this.emojiName,
+    required this.emojiCode,
+    required this.reactionType,
+  });
+
+  factory UserStatus.fromJson(Map<String, dynamic> json) =>
+    _$UserStatusFromJson(json);
+
+  Map<String, dynamic> toJson() => _$UserStatusToJson(this);
+}
+
 /// The name of a user setting that has a property in [UserSettings].
 ///
 /// In Zulip event-handling code (for [UserSettingsUpdateEvent]),

lib/api/model/reaction.dart

@@ -175,4 +175,9 @@ enum ReactionType {
   zulipExtraEmoji;
 
   String toJson() => _$ReactionTypeEnumMap[this]!;
+
+  static ReactionType fromApiValue(String value) => _byApiValue[value]!;
+
+  static final _byApiValue = _$ReactionTypeEnumMap
+    .map((key, value) => MapEntry(value, key));
 }

lib/model/store.dart

@@ -665,6 +665,9 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   bool isUserMuted(int userId, {MutedUsersEvent? event}) =>
     _users.isUserMuted(userId, event: event);
 
+  @override
+  UserStatus? getUserStatus(int userId) => _users.getUserStatus(userId);
+
   final UserStoreImpl _users;
 
   final TypingStatus typingStatus;
@@ -926,6 +929,11 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         _channels.handleSubscriptionEvent(event);
         notifyListeners();
 
+      case UserStatusEvent():
+        assert(debugLog("server event: user_status"));
+        _users.handleUserStatusEvent(event);
+        notifyListeners();
+
       case UserTopicEvent():
         assert(debugLog("server event: user_topic"));
         _messages.handleUserTopicEvent(event);