Merge branch 'master' into feat/floating_date_divider_builder

Author: AleksandrLarin-Ardas

.github/workflows/update_goldens.yml

@@ -30,7 +30,7 @@ jobs:
         run: melos run update:goldens
 
       - name: 📤 Commit Changes
-        uses: stefanzweifel/git-auto-commit-action@v6
+        uses: stefanzweifel/git-auto-commit-action@v7
         with:
           commit_message: "chore: Update Goldens"
           file_pattern: "**/test/**/goldens/*.png"

melos.yaml

@@ -79,11 +79,11 @@ command:
       share_plus: ">=11.0.0 <13.0.0"
       shimmer: ^3.0.0
       sqlite3_flutter_libs: ^0.5.26
-      stream_chat: ^9.17.0
-      stream_chat_flutter: ^9.17.0
-      stream_chat_flutter_core: ^9.17.0
-      stream_chat_localizations: ^9.17.0
-      stream_chat_persistence: ^9.17.0
+      stream_chat: ^9.18.0
+      stream_chat_flutter: ^9.18.0
+      stream_chat_flutter_core: ^9.18.0
+      stream_chat_localizations: ^9.18.0
+      stream_chat_persistence: ^9.18.0
       streaming_shared_preferences: ^2.0.0
       svg_icon_widget: ^0.0.1
       synchronized: ^3.1.0+1

packages/stream_chat/CHANGELOG.md

@@ -1,4 +1,4 @@
-## Upcoming
+## 9.18.0
 
 🐞 Fixed
 
@@ -7,7 +7,10 @@
 
 ✅ Added
 
+- Added support for `Message.channelRole` field to provide access to the sender's channel role.
 - Added support for `Channel.messageCount` field.
+- Added support for Pending Messages. Pending messages can be accessed via
+  `ChannelState.pendingMessages` or `ChannelState.pendingMessagesStream`.
 
 🐞 Fixed
 

packages/stream_chat/example/pubspec.yaml

@@ -24,7 +24,7 @@ dependencies:
   cupertino_icons: ^1.0.3
   flutter:
     sdk: flutter
-  stream_chat: ^9.17.0
+  stream_chat: ^9.18.0
 
 flutter:
   uses-material-design: true

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

@@ -3152,6 +3152,15 @@ class ChannelClientState {
       .map((cs) => cs.pinnedMessages ?? <Message>[])
       .distinct(const ListEquality().equals);
 
+  /// Channel pending message list.
+  List<Message> get pendingMessages =>
+      _channelState.pendingMessages ?? <Message>[];
+
+  /// Channel pending message list as a stream.
+  Stream<List<Message>> get pendingMessagesStream => channelStateStream
+      .map((cs) => cs.pendingMessages ?? <Message>[])
+      .distinct(const ListEquality().equals);
+
   /// Get channel last message.
   Message? get lastMessage =>
       _channelState.messages != null && _channelState.messages!.isNotEmpty
@@ -3376,6 +3385,7 @@ class ChannelClientState {
       read: newReads,
       draft: updatedState.draft,
       pinnedMessages: updatedState.pinnedMessages,
+      pendingMessages: updatedState.pendingMessages,
       pushPreferences: updatedState.pushPreferences,
     );
   }

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

@@ -26,6 +26,7 @@ class ChannelConfig {
     this.urlEnrichment = false,
     this.skipLastMsgUpdateForSystemMsgs = false,
     this.userMessageReminders = false,
+    this.markMessagesPending = false,
   })  : createdAt = createdAt ?? DateTime.now(),
         updatedAt = updatedAt ?? DateTime.now();
 
@@ -91,6 +92,9 @@ class ChannelConfig {
   /// True if the user can set reminders for messages in this channel.
   final bool userMessageReminders;
 
+  /// Whether pending messages are enabled for this channel.
+  final bool markMessagesPending;
+
   /// Serialize to json
   Map<String, dynamic> toJson() => _$ChannelConfigToJson(this);
 }

packages/stream_chat/lib/src/core/models/channel_config.g.dart

@@ -30,6 +30,7 @@ class ChannelState implements ComparableFieldProvider {
     this.read,
     this.membership,
     this.draft,
+    this.pendingMessages,
     this.pushPreferences,
   });
 
@@ -60,6 +61,28 @@ class ChannelState implements ComparableFieldProvider {
   /// The draft message for this channel if it exists.
   final Draft? draft;
 
+  static Object? _pendingMessagesReadValue(
+    Map<Object?, Object?> json,
+    String key,
+  ) {
+    final pendingMessageResponse = json[key];
+    if (pendingMessageResponse is! List<Object?>) return null;
+
+    final value = pendingMessageResponse.map((it) {
+      if (it is! Map<String, Object?>) return null;
+      return it['message'];
+    }).nonNulls;
+
+    if (value.isEmpty) return null;
+    return value.toList(growable: false);
+  }
+
+  /// List of messages pending for moderation on this channel.
+  ///
+  /// These messages are only visible to the author until they are approved.
+  @JsonKey(readValue: _pendingMessagesReadValue)
+  final List<Message>? pendingMessages;
+
   /// The push preferences for this channel if it exists.
   final ChannelPushPreference? pushPreferences;
 
@@ -81,6 +104,7 @@ class ChannelState implements ComparableFieldProvider {
     List<Read>? read,
     Member? membership,
     Object? draft = _nullConst,
+    List<Message>? pendingMessages,
     ChannelPushPreference? pushPreferences,
   }) =>
       ChannelState(
@@ -93,6 +117,7 @@ class ChannelState implements ComparableFieldProvider {
         read: read ?? this.read,
         membership: membership ?? this.membership,
         draft: draft == _nullConst ? this.draft : draft as Draft?,
+        pendingMessages: pendingMessages ?? this.pendingMessages,
         pushPreferences: pushPreferences ?? this.pushPreferences,
       );
 

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

@@ -11,6 +11,7 @@ import 'package:stream_chat/src/core/models/poll.dart';
 import 'package:stream_chat/src/core/models/reaction.dart';
 import 'package:stream_chat/src/core/models/reaction_group.dart';
 import 'package:stream_chat/src/core/models/user.dart';
+import 'package:stream_chat/src/core/util/extension.dart';
 import 'package:stream_chat/src/core/util/serializer.dart';
 import 'package:uuid/uuid.dart';
 
@@ -69,6 +70,7 @@ class Message extends Equatable implements ComparableFieldProvider {
     this.moderation,
     this.draft,
     this.reminder,
+    this.channelRole,
   })  : id = id ?? const Uuid().v4(),
         type = MessageType(type),
         pinExpires = pinExpires?.toUtc(),
@@ -314,6 +316,19 @@ class Message extends Equatable implements ComparableFieldProvider {
   /// This is present when a user has set a reminder for this message.
   final MessageReminder? reminder;
 
+  static Object? _channelRoleReadValue(Map<Object?, Object?> json, String key) {
+    // Extract the channel role from the member object if present.
+    final member = json['member'];
+    if (member is! Map<String, Object?>) return null;
+
+    final channelRole = member[key].safeCast<String>();
+    return channelRole;
+  }
+
+  /// The role of the user in the channel the message belongs to.
+  @JsonKey(includeToJson: false, readValue: _channelRoleReadValue)
+  final String? channelRole;
+
   /// Message custom extraData.
   final Map<String, Object?> extraData;
 
@@ -362,6 +377,7 @@ class Message extends Equatable implements ComparableFieldProvider {
     'moderation_details',
     'draft',
     'reminder',
+    'member',
   ];
 
   /// Serialize to json.
@@ -424,6 +440,7 @@ class Message extends Equatable implements ComparableFieldProvider {
     Moderation? moderation,
     Object? draft = _nullConst,
     Object? reminder = _nullConst,
+    String? channelRole,
   }) {
     assert(() {
       if (pinExpires is! DateTime &&
@@ -506,6 +523,7 @@ class Message extends Equatable implements ComparableFieldProvider {
       draft: draft == _nullConst ? this.draft : draft as Draft?,
       reminder:
           reminder == _nullConst ? this.reminder : reminder as MessageReminder?,
+      channelRole: channelRole ?? this.channelRole,
     );
   }
 
@@ -551,6 +569,7 @@ class Message extends Equatable implements ComparableFieldProvider {
       moderation: other.moderation,
       draft: other.draft,
       reminder: other.reminder,
+      channelRole: other.channelRole,
     );
   }
 
@@ -616,6 +635,7 @@ class Message extends Equatable implements ComparableFieldProvider {
         moderation,
         draft,
         reminder,
+        channelRole,
       ];
 
   @override