api: Add streams list in initial snapshot

Author: gnprice

lib/api/model/initial_snapshot.dart

@@ -7,6 +7,11 @@ part 'initial_snapshot.g.dart';
 // https://zulip.com/api/register-queue#response
 @JsonSerializable(fieldRename: FieldRename.snake)
 class InitialSnapshot {
+  // Keep these fields in the order they appear in the API docs.
+  // (For many API types we choose a more logical order than the docs.
+  // But this one is so long that that'd make it become impossible to
+  // compare the lists by hand.)
+
   final String? queueId;
   final int lastEventId;
   final int zulipFeatureLevel;
@@ -21,6 +26,8 @@ class InitialSnapshot {
 
   final List<Subscription> subscriptions;
 
+  final List<ZulipStream> streams;
+
   final int maxFileUploadSizeMib;
 
   @JsonKey(readValue: _readUsersIsActiveFallbackTrue)
@@ -31,6 +38,7 @@ class InitialSnapshot {
   final List<User> crossRealmBots;
 
   // TODO etc., etc.
+  // If adding fields, keep them all in the order they appear in the API docs.
 
   // `is_active` is sometimes absent:
   //   https://chat.zulip.org/#narrow/stream/412-api-documentation/topic/.60is_active.60.20in.20.60.2Fregister.60.20response/near/1371603
@@ -59,6 +67,7 @@ class InitialSnapshot {
     required this.alertWords,
     required this.customProfileFields,
     required this.subscriptions,
+    required this.streams,
     required this.maxFileUploadSizeMib,
     required this.realmUsers,
     required this.realmNonActiveUsers,

lib/api/model/initial_snapshot.g.dart

@@ -118,6 +118,50 @@ class User {
   Map<String, dynamic> toJson() => _$UserToJson(this);
 }
 
+/// As in `streams` in the initial snapshot.
+///
+/// Not called `Stream` because dart:async uses that name.
+@JsonSerializable(fieldRename: FieldRename.snake)
+class ZulipStream {
+  final int streamId;
+  final String name;
+  final String description;
+  final String renderedDescription;
+
+  final int dateCreated;
+  final int? firstMessageId;
+
+  final bool inviteOnly;
+  final bool isWebPublic;
+  final bool historyPublicToSubscribers;
+  final int? messageRetentionDays;
+
+  final int streamPostPolicy; // TODO enum
+  // final bool isAnnouncementOnly; // deprecated; ignore
+
+  final int? canRemoveSubscribersGroupId; // TODO(server-6)
+
+  ZulipStream({
+    required this.streamId,
+    required this.name,
+    required this.description,
+    required this.renderedDescription,
+    required this.dateCreated,
+    required this.firstMessageId,
+    required this.inviteOnly,
+    required this.isWebPublic,
+    required this.historyPublicToSubscribers,
+    required this.messageRetentionDays,
+    required this.streamPostPolicy,
+    required this.canRemoveSubscribersGroupId,
+  });
+
+  factory ZulipStream.fromJson(Map<String, dynamic> json) =>
+    _$ZulipStreamFromJson(json);
+
+  Map<String, dynamic> toJson() => _$ZulipStreamToJson(this);
+}
+
 /// As in `subscriptions` in the initial snapshot.
 @JsonSerializable(fieldRename: FieldRename.snake)
 class Subscription {

lib/api/model/model.dart

@@ -109,6 +109,7 @@ final InitialSnapshot initialSnapshot = InitialSnapshot(
   alertWords: ['klaxon'],
   customProfileFields: [],
   subscriptions: [], // TODO add subscriptions to example initial snapshot
+  streams: [], // TODO add streams to example initial snapshot
   maxFileUploadSizeMib: 25,
   realmUsers: [],
   realmNonActiveUsers: [],