model: Add poll and friends.

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

lib/api/model/polls.dart

@@ -0,0 +1,141 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'polls.g.dart';
+
+/// Data structure seen from [Submessage.content] to support Zulip's widget
+/// system.
+sealed class WidgetData {}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class WidgetStartData extends WidgetData {
+  WidgetStartData({required this.widgetType, required this.extraData});
+
+  final WidgetType widgetType;
+  final PollExtraData extraData;
+
+  factory WidgetStartData.fromJson(Map<String, dynamic> json) =>
+    _$WidgetStartDataFromJson(json);
+
+  Map<String, dynamic> toJson() => _$WidgetStartDataToJson(this);
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class PollExtraData {
+  const PollExtraData({required this.question, required this.options});
+
+  final String question;
+  final List<String> options;
+
+  factory PollExtraData.fromJson(Map<String, dynamic> json) =>
+    _$PollExtraDataFromJson(json);
+
+  Map<String, dynamic> toJson() => _$PollExtraDataToJson(this);
+}
+
+enum WidgetType {
+  poll,
+  todo,
+  unknown,
+}
+
+sealed class PollEvent extends WidgetData {
+  PollEventType get type;
+
+  PollEvent();
+
+  factory PollEvent.fromJson(Map<String, dynamic> json) {
+    switch (json['type']) {
+      case 'new_option': return PollOptionEvent.fromJson(json);
+      case 'question': return PollQuestionEvent.fromJson(json);
+      case 'vote': return PollVoteEvent.fromJson(json);
+      default: return UnknownPollEvent(json: json);
+    }
+  }
+
+  Map<String, dynamic> toJson();
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class PollOptionEvent extends PollEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  PollEventType get type => PollEventType.newOption;
+
+  final String option;
+  final int idx;
+
+  PollOptionEvent({
+    required this.option,
+    required this.idx,
+  });
+
+  @override
+  factory PollOptionEvent.fromJson(Map<String, dynamic> json) =>
+    _$PollOptionEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$PollOptionEventToJson(this);
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class PollQuestionEvent extends PollEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  PollEventType get type => PollEventType.question;
+
+  final String question;
+
+  PollQuestionEvent({
+    required this.question,
+  });
+
+  @override
+  factory PollQuestionEvent.fromJson(Map<String, dynamic> json) =>
+    _$PollQuestionEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$PollQuestionEventToJson(this);
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class PollVoteEvent extends PollEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  PollEventType get type => PollEventType.vote;
+
+  final String key;
+  final int vote;
+
+  PollVoteEvent({
+    required this.key,
+    required this.vote,
+  });
+
+  @override
+  factory PollVoteEvent.fromJson(Map<String, dynamic> json) =>
+    _$PollVoteEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$PollVoteEventToJson(this);
+}
+
+class UnknownPollEvent extends PollEvent {
+  @override
+  @JsonKey(includeToJson: true)
+  PollEventType get type => PollEventType.unknown;
+
+  final Map<String, dynamic> json;
+
+  UnknownPollEvent({required this.json});
+
+  @override
+  Map<String, dynamic> toJson() => json;
+}
+
+@JsonEnum(fieldRename: FieldRename.snake)
+enum PollEventType {
+  newOption,
+  question,
+  vote,
+  unknown,
+}

lib/api/model/polls.g.dart

@@ -328,6 +328,7 @@ StreamMessage streamMessage({
   List<Reaction>? reactions,
   int? timestamp,
   List<MessageFlag>? flags,
+  List<Submessage>? submessages,
 }) {
   final effectiveStream = stream ?? _stream(streamId: defaultStreamMessageStreamId);
   // The use of JSON here is convenient in order to delegate parts of the data
@@ -346,6 +347,7 @@ StreamMessage streamMessage({
     'id': id ?? _nextMessageId(),
     'last_edit_timestamp': lastEditTimestamp,
     'subject': topic ?? 'example topic',
+    'submessages': submessages ?? [],
     'timestamp': timestamp ?? 1678139636,
     'type': 'stream',
   }) as Map<String, dynamic>);
@@ -370,6 +372,7 @@ DmMessage dmMessage({
   int? lastEditTimestamp,
   int? timestamp,
   List<MessageFlag>? flags,
+  List<Submessage>? submessages,
 }) {
   assert(!to.any((user) => user.userId == from.userId));
   return DmMessage.fromJson(deepToJson({
@@ -384,6 +387,7 @@ DmMessage dmMessage({
     'id': id ?? _nextMessageId(),
     'last_edit_timestamp': lastEditTimestamp,
     'subject': '',
+    'submessages': submessages ?? [],
     'timestamp': timestamp ?? 1678139636,
     'type': 'private',
   }) as Map<String, dynamic>);