feat(llc): add support for polls api

packages/stream_chat/lib/src/client/channel.dart

@@ -1,8 +1,7 @@
 import 'dart:async';
 import 'dart:math';
 
-import 'package:collection/collection.dart'
-    show IterableExtension, ListEquality;
+import 'package:collection/collection.dart';
 import 'package:rxdart/rxdart.dart';
 import 'package:stream_chat/src/client/retry_queue.dart';
 import 'package:stream_chat/src/core/util/utils.dart';
@@ -1790,6 +1789,24 @@
 
     _listenReactionDeleted();
 
+    /* Start of poll events */
+
+    _listenPollUpdated();
+
+    _listenPollClosed();
+
+    _listenPollAnswerCasted();
+
+    _listenPollVoteCasted();
+
+    _listenPollVoteChanged();
+
+    _listenPollAnswerRemoved();
+
+    _listenPollVoteRemoved();
+
+    /* End of poll events */
+
     _listenReadEvents();
 
     _listenUnreadEvents();
@@ -2042,6 +2059,198 @@
     _retryQueue.add(failedMessages);
   }
 
+  Message? _findPollMessage(String pollId) {
+    final message = messages.firstWhereOrNull((it) => it.pollId == pollId);
+    if (message != null) return message;
+
+    final threadMessage = threads.values.flattened.firstWhereOrNull((it) {
+      return it.pollId == pollId;
+    });
+
+    return threadMessage;
+  }
+
+  void _listenPollUpdated() {
+    _subscriptions.add(_channel.on(EventType.pollUpdated).listen((event) {
+      final eventPoll = event.poll;
+      if (eventPoll == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+
+      final answers = oldPoll?.answers ?? eventPoll.answers;
+      final ownVotesAndAnswers =
+          oldPoll?.ownVotesAndAnswers ?? eventPoll.ownVotesAndAnswers;
+
+      final poll = eventPoll.copyWith(
+        answers: answers,
+        ownVotesAndAnswers: ownVotesAndAnswers,
+      );
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
+  void _listenPollClosed() {
+    _subscriptions.add(_channel.on(EventType.pollClosed).listen((event) {
+      final eventPoll = event.poll;
+      if (eventPoll == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+      final poll = oldPoll?.copyWith(isClosed: true) ?? eventPoll;
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
+  void _listenPollAnswerCasted() {
+    _subscriptions.add(_channel.on(EventType.pollAnswerCasted).listen((event) {
+      final (eventPoll, eventPollVote) = (event.poll, event.pollVote);
+      if (eventPoll == null || eventPollVote == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+
+      final answers = <String, PollVote>{
+        for (final ans in oldPoll?.answers ?? []) ans.id: ans,
+        eventPollVote.id!: eventPollVote,
+      };
+
+      final currentUserId = _channel.client.state.currentUser?.id;
+      final ownVotesAndAnswers = <String, PollVote>{
+        for (final vote in oldPoll?.ownVotesAndAnswers ?? []) vote.id: vote,
+        if (eventPollVote.userId == currentUserId)
+          eventPollVote.id!: eventPollVote,
+      };
+
+      final poll = eventPoll.copyWith(
+        answers: [...answers.values],
+        ownVotesAndAnswers: [...ownVotesAndAnswers.values],
+      );
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
+  void _listenPollVoteCasted() {
+    _subscriptions.add(_channel.on(EventType.pollVoteCasted).listen((event) {
+      final (eventPoll, eventPollVote) = (event.poll, event.pollVote);
+      if (eventPoll == null || eventPollVote == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+
+      final answers = oldPoll?.answers ?? eventPoll.answers;
+      final currentUserId = _channel.client.state.currentUser?.id;
+      final ownVotesAndAnswers = <String, PollVote>{
+        for (final vote in oldPoll?.ownVotesAndAnswers ?? []) vote.id: vote,
+        if (eventPollVote.userId == currentUserId)
+          eventPollVote.id!: eventPollVote,
+      };
+
+      final poll = eventPoll.copyWith(
+        answers: answers,
+        ownVotesAndAnswers: [...ownVotesAndAnswers.values],
+      );
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
+  void _listenPollAnswerRemoved() {
+    _subscriptions.add(_channel.on(EventType.pollAnswerRemoved).listen((event) {
+      final (eventPoll, eventPollVote) = (event.poll, event.pollVote);
+      if (eventPoll == null || eventPollVote == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+
+      final answers = <String, PollVote>{
+        for (final ans in oldPoll?.answers ?? []) ans.id: ans,
+      }..remove(eventPollVote.id);
+
+      final ownVotesAndAnswers = <String, PollVote>{
+        for (final vote in oldPoll?.ownVotesAndAnswers ?? []) vote.id: vote,
+      }..remove(eventPollVote.id);
+
+      final poll = eventPoll.copyWith(
+        answers: [...answers.values],
+        ownVotesAndAnswers: [...ownVotesAndAnswers.values],
+      );
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
+  void _listenPollVoteRemoved() {
+    _subscriptions.add(_channel.on(EventType.pollVoteRemoved).listen((event) {
+      final (eventPoll, eventPollVote) = (event.poll, event.pollVote);
+      if (eventPoll == null || eventPollVote == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+
+      final answers = oldPoll?.answers ?? eventPoll.answers;
+      final ownVotesAndAnswers = <String, PollVote>{
+        for (final vote in oldPoll?.ownVotesAndAnswers ?? []) vote.id: vote,
+      }..remove(eventPollVote.id);
+
+      final poll = eventPoll.copyWith(
+        answers: answers,
+        ownVotesAndAnswers: [...ownVotesAndAnswers.values],
+      );
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
+  void _listenPollVoteChanged() {
+    _subscriptions.add(_channel.on(EventType.pollVoteChanged).listen((event) {
+      final (eventPoll, eventPollVote) = (event.poll, event.pollVote);
+      if (eventPoll == null || eventPollVote == null) return;
+
+      final pollMessage = _findPollMessage(eventPoll.id);
+      if (pollMessage == null) return;
+
+      final oldPoll = pollMessage.poll;
+
+      final answers = oldPoll?.answers ?? eventPoll.answers;
+      final currentUserId = _channel.client.state.currentUser?.id;
+      final ownVotesAndAnswers = <String, PollVote>{
+        for (final vote in oldPoll?.ownVotesAndAnswers ?? []) vote.id: vote,
+        if (eventPollVote.userId == currentUserId)
+          eventPollVote.id!: eventPollVote,
+      };
+
+      final poll = eventPoll.copyWith(
+        answers: answers,
+        ownVotesAndAnswers: [...ownVotesAndAnswers.values],
+      );
+
+      final message = pollMessage.copyWith(poll: poll);
+      updateMessage(message);
+    }));
+  }
+
   void _listenReactionDeleted() {
     _subscriptions.add(_channel.on(EventType.reactionDeleted).listen((event) {
       final oldMessage =

packages/stream_chat/lib/src/client/client.dart

@@ -23,6 +23,9 @@
 import 'package:stream_chat/src/core/models/member.dart';
 import 'package:stream_chat/src/core/models/message.dart';
 import 'package:stream_chat/src/core/models/own_user.dart';
+import 'package:stream_chat/src/core/models/poll.dart';
+import 'package:stream_chat/src/core/models/poll_option.dart';
+import 'package:stream_chat/src/core/models/poll_vote.dart';
 import 'package:stream_chat/src/core/models/user.dart';
 import 'package:stream_chat/src/core/platform_detector/platform_detector.dart';
 import 'package:stream_chat/src/core/util/utils.dart';
@@ -197,7 +200,17 @@
 
   /// Stream of [Event] coming from [_ws] connection
   /// Listen to this or use the [on] method to filter specific event types
-  Stream<Event> get eventStream => _eventController.stream;
+  Stream<Event> get eventStream => _eventController.stream.map(
+        // If the poll vote is an answer, we should emit a different event
+        // to make it easier to handle in the state.
+        (event) => switch ((event.type, event.pollVote?.isAnswer == true)) {
+          (EventType.pollVoteCasted || EventType.pollVoteChanged, true) =>
+            event.copyWith(type: EventType.pollAnswerCasted),
+          (EventType.pollVoteRemoved, true) =>
+            event.copyWith(type: EventType.pollAnswerRemoved),
+          _ => event,
+        },
+      );
 
   final _wsConnectionStatusController =
       BehaviorSubject.seeded(ConnectionStatus.disconnected);
@@ -1200,6 +1213,126 @@
         messageId,
       );
 
+  /// Creates a new Poll
+  Future<CreatePollResponse> createPoll(Poll poll) =>
+      _chatApi.polls.createPoll(poll);
+
+  /// Retrieves a Poll by [pollId]
+  Future<GetPollResponse> getPoll(String pollId) =>
+      _chatApi.polls.getPoll(pollId);
+
+  /// Updates a Poll
+  Future<UpdatePollResponse> updatePoll(Poll poll) =>
+      _chatApi.polls.updatePoll(poll);
+
+  /// Partially updates a Poll by [pollId].
+  ///
+  /// Use [set] to define values to be set.
+  /// Use [unset] to define values to be unset.
+  Future<UpdatePollResponse> partialUpdatePoll(
+    String pollId, {
+    Map<String, Object?>? set,
+    List<String>? unset,
+  }) =>
+      _chatApi.polls.partialUpdatePoll(
+        pollId,
+        set: set,
+        unset: unset,
+      );
+
+  /// Deletes the Poll by [pollId].
+  Future<EmptyResponse> deletePoll(String pollId) =>
+      _chatApi.polls.deletePoll(pollId);
+
+  /// Marks the Poll [pollId] as closed.
+  Future<UpdatePollResponse> closePoll(String pollId) =>
+      partialUpdatePoll(pollId, set: {
+        'is_closed': true,
+      });
+
+  /// Creates a new Poll Option for the Poll [pollId].
+  Future<CreatePollOptionResponse> createPollOption(
+    String pollId,
+    PollOption option,
+  ) =>
+      _chatApi.polls.createPollOption(pollId, option);
+
+  /// Retrieves a Poll Option by [optionId] for the Poll [pollId].
+  Future<GetPollOptionResponse> getPollOption(
+    String pollId,
+    String optionId,
+  ) =>
+      _chatApi.polls.getPollOption(pollId, optionId);
+
+  /// Updates a Poll Option for the Poll [pollId].
+  Future<UpdatePollOptionResponse> updatePollOption(
+    String pollId,
+    PollOption option,
+  ) =>
+      _chatApi.polls.updatePollOption(pollId, option);
+
+  /// Deletes a Poll Option by [optionId] for the Poll [pollId].
+  Future<EmptyResponse> deletePollOption(
+    String pollId,
+    String optionId,
+  ) =>
+      _chatApi.polls.deletePollOption(pollId, optionId);
+
+  /// Cast a [vote] for the Poll [pollId].
+  Future<CastPollVoteResponse> castPollVote(
+    String messageId,
+    String pollId, {
+    required String optionId,
+  }) {
+    final vote = PollVote(optionId: optionId);
+    return _chatApi.polls.castPollVote(messageId, pollId, vote);
+  }
+
+  /// Adds a answer with [answerText] for the Poll [pollId].
+  Future<CastPollVoteResponse> addPollAnswer(
+    String messageId,
+    String pollId, {
+    required String answerText,
+  }) {
+    final vote = PollVote(answerText: answerText);
+    return _chatApi.polls.castPollVote(messageId, pollId, vote);
+  }
+
+  /// Removes a vote by [voteId] for the Poll [pollId].
+  Future<RemovePollVoteResponse> removePollVote(
+    String messageId,
+    String pollId,
+    String voteId,
+  ) =>
+      _chatApi.polls.removePollVote(messageId, pollId, voteId);
+
+  /// Queries Polls with the given [filter] and [sort] options.
+  Future<QueryPollsResponse> queryPolls({
+    Filter? filter,
+    List<SortOption>? sort,
+    PaginationParams pagination = const PaginationParams(),
+  }) =>
+      _chatApi.polls.queryPolls(
+        filter: filter,
+        sort: sort,
+        pagination: pagination,
+      );
+
+  /// Queries Poll Votes for the Poll [pollId] with the given [filter]
+  /// and [sort] options.
+  Future<QueryPollVotesResponse> queryPollVotes(
+    String pollId, {
+    Filter? filter,
+    List<SortOption>? sort,
+    PaginationParams pagination = const PaginationParams(),
+  }) =>
+      _chatApi.polls.queryPollVotes(
+        pollId,
+        filter: filter,
+        sort: sort,
+        pagination: pagination,
+      );
+
   /// Update or Create the given user object.
   Future<UpdateUsersResponse> updateUser(User user) => updateUsers([user]);