[3/6] api: Audit enums to handle unknown values where appropriate

lib/api/model/events.dart

@@ -244,11 +244,11 @@ class UserSettingsUpdateEvent extends Event {
   @JsonKey(includeToJson: true)
   String get op => 'update';
 
-  /// The name of the setting, or null if we don't recognize it.
-  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
-  final UserSettingName? property;
+  /// The name of the setting, or [UserSettingName.unknown] if we don't recognize it.
+  @JsonKey(unknownEnumValue: UserSettingName.unknown)
+  final UserSettingName property;
 
-  /// The new value, or null if we don't recognize the setting.
+  /// The new value, or null if we don't recognize the setting ([UserSettingName.unknown]).
   ///
   /// This will have the type appropriate for [property]; for example,
   /// if the setting is boolean, then `value is bool` will always be true.
@@ -261,17 +261,17 @@ class UserSettingsUpdateEvent extends Event {
   static Object? _readValue(Map<dynamic, dynamic> json, String key) {
     final value = json['value'];
     switch (UserSettingName.fromRawString(json['property'] as String)) {
-      case UserSettingName.twentyFourHourTime:
+      case .twentyFourHourTime:
         return TwentyFourHourTimeMode.fromApiValue(value as bool?);
-      case UserSettingName.starredMessageCounts:
-      case UserSettingName.displayEmojiReactionUsers:
+      case .starredMessageCounts:
+      case .displayEmojiReactionUsers:
         return value as bool;
-      case UserSettingName.emojiset:
+      case .emojiset:
         return Emojiset.fromRawString(value as String);
-      case UserSettingName.webInboxShowChannelFolders:
-      case UserSettingName.presenceEnabled:
+      case .webInboxShowChannelFolders:
+      case .presenceEnabled:
         return value as bool;
-      case null:
+      case .unknown:
         return null;
     }
   }
@@ -818,11 +818,12 @@ class ChannelUpdateEvent extends ChannelEvent {
   final int streamId;
   final String name;
 
-  /// The name of the channel property, or null if we don't recognize it.
-  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
-  final ChannelPropertyName? property;
+  /// The name of the channel property,
+  /// or [ChannelProperty.unknown] if we don't recognize it.
+  @JsonKey(unknownEnumValue: ChannelProperty.unknown)
+  final ChannelProperty property;
 
-  /// The new value, or null if we don't recognize the property.
+  /// The new value, or null if we don't recognize the property ([ChannelProperty.unknown]).
   ///
   /// This will have the type appropriate for [property]; for example,
   /// if the property is boolean, then `value is bool` will always be true.
@@ -849,36 +850,36 @@ class ChannelUpdateEvent extends ChannelEvent {
   /// (e.g., `value as bool`).
   static Object? _readValue(Map<dynamic, dynamic> json, String key) {
     final value = json['value'];
-    switch (ChannelPropertyName.fromRawString(json['property'] as String)) {
-      case ChannelPropertyName.name:
+    switch (ChannelProperty.fromRawString(json['property'] as String)) {
+      case .name:
         return value as String;
-      case ChannelPropertyName.isArchived:
+      case .isArchived:
         return value as bool;
-      case ChannelPropertyName.description:
+      case .description:
         return value as String;
-      case ChannelPropertyName.firstMessageId:
+      case .firstMessageId:
         return value as int?;
-      case ChannelPropertyName.inviteOnly:
+      case .inviteOnly:
         return value as bool;
-      case ChannelPropertyName.messageRetentionDays:
+      case .messageRetentionDays:
         return value as int?;
-      case ChannelPropertyName.topicsPolicy:
+      case .topicsPolicy:
         return ChannelTopicsPolicy.fromApiValue(value as String);
-      case ChannelPropertyName.channelPostPolicy:
+      case .channelPostPolicy:
         return ChannelPostPolicy.fromApiValue(value as int);
-      case ChannelPropertyName.folderId:
+      case .folderId:
         return value as int?;
-      case ChannelPropertyName.canAddSubscribersGroup:
-      case ChannelPropertyName.canDeleteAnyMessageGroup:
-      case ChannelPropertyName.canDeleteOwnMessageGroup:
-      case ChannelPropertyName.canSendMessageGroup:
-      case ChannelPropertyName.canSubscribeGroup:
+      case .canAddSubscribersGroup:
+      case .canDeleteAnyMessageGroup:
+      case .canDeleteOwnMessageGroup:
+      case .canSendMessageGroup:
+      case .canSubscribeGroup:
         return GroupSettingValue.fromJson(value);
-      case ChannelPropertyName.isRecentlyActive:
+      case .isRecentlyActive:
         return value as bool;
-      case ChannelPropertyName.streamWeeklyTraffic:
+      case .streamWeeklyTraffic:
         return value as int?;
-      case null:
+      case .unknown:
         return null;
     }
   }
@@ -1405,8 +1406,9 @@ class DeleteMessageEvent extends Event {
 
   final List<int> messageIds;
   // final int messageId; // Not present; we support the bulk_message_deletion capability
-  // The server never actually sends "direct" here yet (it's "private" instead),
-  // but we accept both forms for forward-compatibility.
+  // The server never actually sends "channel" or "direct" here yet
+  // (it's "stream" or "private" instead), but we accept both the old
+  // and new forms for forward-compatibility.
   @MessageTypeConverter()
   final MessageType messageType;
   final int? streamId;
@@ -1423,7 +1425,7 @@ class DeleteMessageEvent extends Event {
   factory DeleteMessageEvent.fromJson(Map<String, dynamic> json) {
     final result = _$DeleteMessageEventFromJson(json);
     // Crunchy-shell validation
-    if (result.messageType == MessageType.stream) {
+    if (result.messageType == .channel) {
       result.streamId as int;
       result.topic as String;
     }
@@ -1434,30 +1436,6 @@ class DeleteMessageEvent extends Event {
   Map<String, dynamic> toJson() => _$DeleteMessageEventToJson(this);
 }
 
-/// As in [DeleteMessageEvent.messageType],
-/// [UpdateMessageFlagsMessageDetail.type],
-/// or [TypingEvent.messageType].
-@JsonEnum(alwaysCreate: true)
-enum MessageType {
-  stream,
-  direct;
-}
-
-class MessageTypeConverter extends JsonConverter<MessageType, String> {
-  const MessageTypeConverter();
-
-  @override
-  MessageType fromJson(String json) {
-    if (json == 'private') json = 'direct'; // TODO(server-future)
-    return $enumDecode(_$MessageTypeEnumMap, json);
-  }
-
-  @override
-  String toJson(MessageType object) {
-    return _$MessageTypeEnumMap[object]!;
-  }
-}
-
 /// A Zulip event of type `update_message_flags`.
 ///
 /// For the corresponding API docs, see subclasses.
@@ -1536,8 +1514,9 @@ class UpdateMessageFlagsRemoveEvent extends UpdateMessageFlagsEvent {
 /// As in [UpdateMessageFlagsRemoveEvent.messageDetails].
 @JsonSerializable(fieldRename: FieldRename.snake)
 class UpdateMessageFlagsMessageDetail {
-  // The server never actually sends "direct" here yet (it's "private" instead),
-  // but we accept both forms for forward-compatibility.
+  // The server never actually sends "channel" or "direct" here yet
+  // (it's "stream" or "private" instead), but we accept both the old
+  // and new forms for forward-compatibility.
   @MessageTypeConverter()
   final MessageType type;
   final bool? mentioned;
@@ -1557,10 +1536,10 @@ class UpdateMessageFlagsMessageDetail {
     final result = _$UpdateMessageFlagsMessageDetailFromJson(json);
     // Crunchy-shell validation
     switch (result.type) {
-      case MessageType.stream:
+      case .channel:
         result.streamId as int;
         result.topic as String;
-      case MessageType.direct:
+      case .direct:
         result.userIds as List<int>;
     }
     return result;
@@ -1613,7 +1592,10 @@ class TypingEvent extends Event {
   @JsonKey(includeToJson: true)
   String get type => 'typing';
 
+  @JsonKey(unknownEnumValue: TypingOp.unknown)
   final TypingOp op;
+  // The server never actually sends "channel" here yet (it's "stream" instead),
+  // but we accept both forms for forward-compatibility.
   @MessageTypeConverter()
   final MessageType messageType;
   @JsonKey(readValue: _readSenderId)
@@ -1647,10 +1629,10 @@ class TypingEvent extends Event {
     final result = _$TypingEventFromJson(json);
     // Crunchy-shell validation
     switch (result.messageType) {
-      case MessageType.stream:
+      case .channel:
         result.streamId as int;
         result.topic as String;
-      case MessageType.direct:
+      case .direct:
         result.recipientIds as List<int>;
     }
     return result;
@@ -1664,7 +1646,10 @@ class TypingEvent extends Event {
 @JsonEnum(fieldRename: FieldRename.snake)
 enum TypingOp {
   start,
-  stop;
+  stop,
+
+  /// A new, unrecognized operation.
+  unknown;
 
   String toJson() => _$TypingOpEnumMap[this]!;
 }
@@ -1743,6 +1728,7 @@ class ReactionEvent extends Event {
   @JsonKey(includeToJson: true)
   String get type => 'reaction';
 
+  @JsonKey(unknownEnumValue: ReactionOp.unknown)
   final ReactionOp op;
 
   final String emojiName;
@@ -1774,6 +1760,9 @@ class ReactionEvent extends Event {
 enum ReactionOp {
   add,
   remove,
+
+  /// A new, unrecognized operation.
+  unknown;
 }
 
 /// A Zulip event of type `heartbeat`: https://zulip.com/api/get-events#heartbeat