Update sorting

Author: renefloor

packages/stream_chat/lib/src/core/models/channel_state.dart

@@ -85,6 +85,7 @@ class ChannelState implements ComparableFieldProvider {
       ChannelSortKey.lastMessageAt => channel?.lastMessageAt,
       ChannelSortKey.memberCount => channel?.memberCount,
       ChannelSortKey.pinnedAt => membership?.pinnedAt,
+      ChannelSortKey.archivedAt => membership?.archivedAt,
       // TODO: Support providing default value for hasUnread, unreadCount
       ChannelSortKey.hasUnread => null,
       ChannelSortKey.unreadCount => null,
@@ -125,4 +126,7 @@ extension type const ChannelSortKey(String key) implements String {
 
   /// Sort channels by the date they were pinned.
   static const pinnedAt = ChannelSortKey('pinned_at');
+
+  /// Sort channels by the date they were archived.
+  static const archivedAt = ChannelSortKey('archived_at');
 }

packages/stream_chat_flutter_core/lib/src/stream_channel_list_controller.dart

@@ -196,12 +196,6 @@ class StreamChannelListController extends PagedValueNotifier<int, Channel> {
     }
   }
 
-  /// Sorts the channels based on [channelStateSort] and sets the [channels].
-  void setAndSortChannels(List<Channel> channels) {
-    _sortChannels(channels);
-    this.channels = channels;
-  }
-
   /// Returns/Creates a new Channel and starts watching it.
   Future<Channel> getChannel({
     required String id,
@@ -304,18 +298,6 @@ class StreamChannelListController extends PagedValueNotifier<int, Channel> {
     _channelEventSubscription?.resume();
   }
 
-  void _sortChannels(List<Channel> channels) {
-    if (channelStateSort case final sortOrder?) {
-      channels.sort((a, b) {
-        final stateA = a.state?.channelState;
-        final stateB = b.state?.channelState;
-        if (stateA == null || stateB == null) return 0;
-
-        return sortOrder.compare(stateA, stateB);
-      });
-    }
-  }
-
   @override
   void dispose() {
     _unsubscribeFromChannelListEvents();

packages/stream_chat_flutter_core/lib/src/stream_channel_list_event_handler.dart

@@ -20,7 +20,7 @@ mixin class StreamChannelListEventHandler {
         (it) => it.cid == (event.cid ?? event.channel?.cid),
       );
 
-    controller.setAndSortChannels(updatedChannels);
+    controller.channels = updatedChannels;
   }
 
   /// Function which gets called for the event
@@ -50,7 +50,7 @@ mixin class StreamChannelListEventHandler {
   ///
   /// By default, this updates the channel received in the event.
   void onChannelUpdated(Event event, StreamChannelListController controller) {
-    controller.setAndSortChannels([...controller.currentItems]);
+    controller.channels = [...controller.currentItems];
   }
 
   /// Function which gets called for the event
@@ -60,7 +60,7 @@ mixin class StreamChannelListEventHandler {
   ///
   /// By default, this sorts the channels.
   void onMemberUpdated(Event event, StreamChannelListController controller) {
-    controller.setAndSortChannels([...controller.currentItems]);
+    controller.channels = [...controller.currentItems];
   }
 
   /// Function which gets called for the event
@@ -90,7 +90,7 @@ mixin class StreamChannelListEventHandler {
       ...currentChannels..removeWhere((it) => it.cid == channel.cid),
     ];
 
-    controller.setAndSortChannels(updatedChannels);
+    controller.channels = updatedChannels;
   }
 
   /// Function which gets called for the event
@@ -129,7 +129,7 @@ mixin class StreamChannelListEventHandler {
     final channel = channels.removeAt(channelIndex);
     channels.insert(0, channel);
 
-    controller.setAndSortChannels(channels);
+    controller.channels = [...channels];
   }
 
   /// Function which gets called for the event
@@ -177,7 +177,7 @@ mixin class StreamChannelListEventHandler {
 
     if (!listChanged) return;
 
-    controller.setAndSortChannels([...updatedChannels]);
+    controller.channels = [...updatedChannels];
   }
 
   /// Function which gets called for the event
@@ -220,6 +220,6 @@ mixin class StreamChannelListEventHandler {
       return channel;
     });
 
-    controller.setAndSortChannels([...updatedChannels]);
+    controller.channels = [...updatedChannels];
   }
 }