feat(llc, persistence): add channelRole to Message model (#2411)

Author: xsahil03x

packages/stream_chat/CHANGELOG.md

@@ -7,6 +7,7 @@
 
 ✅ Added
 
+- Added support for `Message.channelRole` field to provide access to the sender's channel role.
 - Added support for `Channel.messageCount` field.
 
 🐞 Fixed

packages/stream_chat/lib/src/core/models/message.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

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

@@ -14,6 +14,12 @@
     "image": "https://randomuser.me/api/portraits/women/2.jpg",
     "name": "Mia Denys"
   },
+  "member": {
+    "user_id": "c1c9b454-2bcc-402d-8bb0-2f3706ce1680",
+    "channel_role": "channel_member",
+    "created_at": "2020-01-28T22:17:30.83015Z",
+    "updated_at": "2020-01-28T22:17:31.19435Z"
+  },
   "attachments": [
     {
       "type": "video",

packages/stream_chat/test/fixtures/message.json

@@ -37,6 +37,7 @@ void main() {
       expect(message.pinnedBy, null);
       expect(message.i18n, null);
       expect(message.restrictedVisibility, isA<List<String>>());
+      expect(message.channelRole, 'channel_member');
     });
 
     test('should serialize to json correctly', () {

packages/stream_chat/test/src/core/models/message_test.dart

@@ -2,6 +2,7 @@
 
 ✅ Added
 
+- Added support for `Message.channelRole` field.
 - Added support for `client.flush()` method to clear database.
 - Added support for `Channel.messageCount` field.
 

packages/stream_chat_persistence/CHANGELOG.md

@@ -55,7 +55,7 @@ class DriftChatDatabase extends _$DriftChatDatabase {
 
   // you should bump this number whenever you change or add a table definition.
   @override
-  int get schemaVersion => 24;
+  int get schemaVersion => 25;
 
   @override
   MigrationStrategy get migration => MigrationStrategy(