api: Add ZulipStream.topicsPolicy

Author: chungwwei

lib/api/model/events.dart

@@ -681,6 +681,8 @@ class ChannelUpdateEvent extends ChannelEvent {
         return value as bool;
       case ChannelPropertyName.messageRetentionDays:
         return value as int?;
+      case ChannelPropertyName.topicsPolicy:
+        return TopicsPolicy.fromApiValue(value as String);
       case ChannelPropertyName.channelPostPolicy:
         return ChannelPostPolicy.fromApiValue(value as int);
       case ChannelPropertyName.folderId:

lib/api/model/events.g.dart

@@ -659,6 +659,9 @@ class ZulipStream {
   bool isWebPublic; // present since 2.1, according to /api/changelog
   bool historyPublicToSubscribers;
   int? messageRetentionDays;
+  @JsonKey(defaultValue: TopicsPolicy.inherit, // TODO(server-11) remove default value
+    unknownEnumValue: TopicsPolicy.unknown)
+  TopicsPolicy topicsPolicy;
   @JsonKey(name: 'stream_post_policy')
   ChannelPostPolicy? channelPostPolicy; // TODO(server-10) remove
   // final bool isAnnouncementOnly; // deprecated for `channelPostPolicy`; ignore
@@ -684,6 +687,7 @@ class ZulipStream {
     required this.isWebPublic,
     required this.historyPublicToSubscribers,
     required this.messageRetentionDays,
+    required this.topicsPolicy,
     required this.channelPostPolicy,
     required this.folderId,
     required this.canAddSubscribersGroup,
@@ -708,6 +712,7 @@ class ZulipStream {
       isWebPublic: subscription.isWebPublic,
       historyPublicToSubscribers: subscription.historyPublicToSubscribers,
       messageRetentionDays: subscription.messageRetentionDays,
+      topicsPolicy: subscription.topicsPolicy,
       channelPostPolicy: subscription.channelPostPolicy,
       folderId: subscription.folderId,
       canAddSubscribersGroup: subscription.canAddSubscribersGroup,
@@ -744,6 +749,7 @@ enum ChannelPropertyName {
   // isWebPublic is updated via its own [ChannelUpdateEvent] field
   // historyPublicToSubscribers is updated via its own [ChannelUpdateEvent] field
   messageRetentionDays,
+  topicsPolicy,
   @JsonValue('stream_post_policy')
   channelPostPolicy,
   folderId,
@@ -765,6 +771,30 @@ enum ChannelPropertyName {
     .map((key, value) => MapEntry(value, key));
 }
 
+/// A value of [ZulipStream.topicsPolicy].
+///
+/// For docs, search for "topics_policy"
+/// in <https://zulip.com/api/get-stream-by-id>.
+@JsonEnum(valueField: 'apiValue')
+enum TopicsPolicy {
+  inherit(apiValue: 'inherit'),
+  allowEmptyTopic(apiValue: 'allow_empty_topic'),
+  disableEmptyTopic(apiValue: 'disable_empty_topic'),
+  emptyTopicOnly(apiValue: 'empty_topic_only'),
+  unknown(apiValue: null);
+
+  const TopicsPolicy({required this.apiValue});
+
+  final String? apiValue;
+
+  String? toJson() => apiValue;
+
+  static TopicsPolicy fromApiValue(String value) => _byApiValue[value] ?? unknown;
+
+  static final _byApiValue = _$TopicsPolicyEnumMap
+    .map((key, value) => MapEntry(value, key));
+}
+
 /// Policy for which users can post to the stream.
 ///
 /// For docs, search for "stream_post_policy"
@@ -830,6 +860,7 @@ class Subscription extends ZulipStream {
     required super.isWebPublic,
     required super.historyPublicToSubscribers,
     required super.messageRetentionDays,
+    required super.topicsPolicy,
     required super.channelPostPolicy,
     required super.folderId,
     required super.canAddSubscribersGroup,

lib/api/model/model.dart

@@ -444,6 +444,8 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
             stream.inviteOnly = event.value as bool;
           case ChannelPropertyName.messageRetentionDays:
             stream.messageRetentionDays = event.value as int?;
+          case ChannelPropertyName.topicsPolicy:
+            stream.topicsPolicy = event.value as TopicsPolicy;
           case ChannelPropertyName.channelPostPolicy:
             stream.channelPostPolicy = event.value as ChannelPostPolicy;
           case ChannelPropertyName.folderId:

lib/api/model/model.g.dart

@@ -464,6 +464,7 @@ ZulipStream stream({
   bool? isWebPublic,
   bool? historyPublicToSubscribers,
   int? messageRetentionDays,
+  TopicsPolicy? topicsPolicy,
   ChannelPostPolicy? channelPostPolicy,
   int? folderId,
   GroupSettingValue? canAddSubscribersGroup,
@@ -496,6 +497,7 @@ ZulipStream stream({
     isWebPublic: isWebPublic ?? false,
     historyPublicToSubscribers: historyPublicToSubscribers ?? true,
     messageRetentionDays: messageRetentionDays,
+    topicsPolicy: topicsPolicy ?? TopicsPolicy.inherit,
     channelPostPolicy: channelPostPolicy ?? ChannelPostPolicy.any,
     folderId: folderId,
     canAddSubscribersGroup: canAddSubscribersGroup ?? GroupSettingValueNamed(nobodyGroup.id),
@@ -541,6 +543,7 @@ Subscription subscription(
     isWebPublic: stream.isWebPublic,
     historyPublicToSubscribers: stream.historyPublicToSubscribers,
     messageRetentionDays: stream.messageRetentionDays,
+    topicsPolicy: stream.topicsPolicy,
     channelPostPolicy: stream.channelPostPolicy,
     folderId: stream.folderId,
     canAddSubscribersGroup: stream.canAddSubscribersGroup,
@@ -1261,6 +1264,8 @@ ChannelUpdateEvent channelUpdateEvent(
       assert(value is bool);
     case ChannelPropertyName.messageRetentionDays:
       assert(value is int?);
+    case ChannelPropertyName.topicsPolicy:
+      assert(value is TopicsPolicy);
     case ChannelPropertyName.channelPostPolicy:
       assert(value is ChannelPostPolicy);
     case ChannelPropertyName.folderId: