channel: Add isArchived field

Author: chrisbobbe

lib/api/model/events.dart

@@ -664,6 +664,9 @@ class ChannelUpdateEvent extends ChannelEvent {
     final value = json['value'];
     switch (ChannelPropertyName.fromRawString(json['property'] as String)) {
       case ChannelPropertyName.name:
+        return value as String;
+      case ChannelPropertyName.isArchived:
+        return value as bool;
       case ChannelPropertyName.description:
         return value as String;
       case ChannelPropertyName.firstMessageId:

lib/api/model/events.g.dart

@@ -627,6 +627,12 @@ class ZulipStream {
 
   final int streamId;
   String name;
+
+  // Servers that don't send this property will only send non-archived channels;
+  // default to false for those servers.
+  @JsonKey(defaultValue: false)
+  bool isArchived; // TODO(server-10) remove default and its comment
+
   String description;
   String renderedDescription;
 
@@ -652,6 +658,7 @@ class ZulipStream {
   ZulipStream({
     required this.streamId,
     required this.name,
+    required this.isArchived,
     required this.description,
     required this.renderedDescription,
     required this.dateCreated,
@@ -674,6 +681,7 @@ class ZulipStream {
       streamId: subscription.streamId,
       name: subscription.name,
       description: subscription.description,
+      isArchived: subscription.isArchived,
       renderedDescription: subscription.renderedDescription,
       dateCreated: subscription.dateCreated,
       firstMessageId: subscription.firstMessageId,
@@ -706,6 +714,7 @@ class ZulipStream {
 enum ChannelPropertyName {
   // streamId is immutable
   name,
+  isArchived,
   description,
   // renderedDescription is updated via its own [ChannelUpdateEvent] field
   // dateCreated is immutable
@@ -791,6 +800,7 @@ class Subscription extends ZulipStream {
     required super.streamId,
     required super.name,
     required super.description,
+    required super.isArchived,
     required super.renderedDescription,
     required super.dateCreated,
     required super.firstMessageId,

lib/api/model/model.dart

@@ -366,6 +366,8 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
             stream.name = event.value as String;
             streamsByName.remove(streamName);
             streamsByName[stream.name] = stream;
+          case ChannelPropertyName.isArchived:
+            stream.isArchived = event.value as bool;
           case ChannelPropertyName.description:
             stream.description = event.value as String;
           case ChannelPropertyName.firstMessageId:

lib/api/model/model.g.dart

@@ -440,6 +440,7 @@ ZulipStream stream({
   int? streamId,
   String? name,
   String? description,
+  bool? isArchived,
   String? renderedDescription,
   int? dateCreated,
   int? firstMessageId,
@@ -462,6 +463,7 @@ ZulipStream stream({
   return ZulipStream(
     streamId: effectiveStreamId,
     name: effectiveName,
+    isArchived: isArchived ?? false,
     description: effectiveDescription,
     renderedDescription: renderedDescription ?? '<p>$effectiveDescription</p>',
     dateCreated: dateCreated ?? 1686774898,
@@ -504,6 +506,7 @@ Subscription subscription(
   return Subscription(
     streamId: stream.streamId,
     name: stream.name,
+    isArchived: stream.isArchived,
     description: stream.description,
     renderedDescription: stream.renderedDescription,
     dateCreated: stream.dateCreated,
@@ -1178,6 +1181,9 @@ ChannelUpdateEvent channelUpdateEvent(
 }) {
   switch (property) {
     case ChannelPropertyName.name:
+      assert(value is String);
+    case ChannelPropertyName.isArchived:
+      assert(value is bool);
     case ChannelPropertyName.description:
       assert(value is String);
     case ChannelPropertyName.firstMessageId: