feat: ✨ Add Pin/Mute Chat Support

Author: dhyash-simform

doc/documentation.md

@@ -172,6 +172,8 @@ Widget build(BuildContext context) {
 | createChat             | Creates a one-to-one chat room by specifying the other user's ID and it returns the `chatRoomID`.                                                                  | `Future<String?>`               |
 | createGroupChat        | Creates a group chat by providing a group name, an optional profile picture, and a list of participants with their assigned roles and it returns the `chatRoomID`. | `Future<String?>`               |
 | deleteChat             | Deletes a chat room by its ID, removing it from the database, all users' chat lists, and deleting associated media from storage.                                   | `Future<bool>`                  |
+| muteChat               | Mutes or unmutes a chat room by passing the desired state (e.g., muted for mute, unmuted for unmute).                                                              | `Future<void>`                  |
+| pinChat                | Pins or unpins a chat room by passing the desired state (e.g., pinned for pin, unpinned for unpin).                                                                | `Future<void>`                  |
 | updateUserActiveStatus | Updates a user’s activity status by passing the desired state (e.g., online or offline).                                                                           | `Future<bool>`                  |
 | resetCurrentUserId     | Resets the current user ID                                                                                                                                         | `void`                          |
 
@@ -309,6 +311,9 @@ The `chats` collection contains chat room details.
        ├── membership_status_timestamp: Timestamp (Timestamp of when the membership status changed)
        ├── role: string (Role of the user in the chat ie: admin/user)
        ├── typing_status: string (Indicates whether the user is typing ie: typed/typing)
+       ├── pin_status: string (Indicates whether the chat is pinned or not ie: pinned/unpinned)
+       ├── pin_status_timestamp: Timestamp (Timestamp of when the chat is pinned)
+       ├── mute_status: string (Indicates whether the chat is muted or not ie: muted/unmuted)
 ```
 
 #### User Chats Collection:

lib/src/database/database_service.dart

@@ -344,6 +344,8 @@ abstract interface class DatabaseService {
   /// (e.g., `typing`, `typed`).
   /// - (optional): [membershipStatus] The user's membership status in the
   /// chat room (e.g., `member`, `removed`, `left`).
+  /// - (optional): [pinStatus] The pin status of the user in the chat room.
+  /// - (optional): [muteStatus] The mute status of the user in the chat room.
   /// - (optional): [chatRoomUserData] A map containing user data updates.
   ///   If provided, this data is used to update the document instead of the
   ///   other individual parameters.
@@ -356,6 +358,8 @@ abstract interface class DatabaseService {
     required String userId,
     TypeWriterStatus? typingStatus,
     MembershipStatus? membershipStatus,
+    PinStatus? pinStatus,
+    MuteStatus? muteStatus,
     Map<String, dynamic>? chatRoomUserData,
     ValueGetter<ChatRoomParticipant>? ifDataNotFound,
   });

lib/src/database/firebase/chatview_firestore_database.dart

@@ -38,6 +38,9 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
   static const String _membershipStatus = 'membership_status';
   static const String _membershipStatusTimestamp =
       'membership_status_timestamp';
+  static const String _pinStatusTimestamp = 'pin_status_timestamp';
+  static const String _pinStatus = 'pin_status';
+  static const String _muteStatus = 'mute_status';
 
   FirestoreChatDatabasePathConfig? get _chatDatabasePathConfig =>
       ChatViewConnect.instance.getFirestoreChatDatabasePathConfig;
@@ -498,6 +501,8 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
     required String userId,
     TypeWriterStatus? typingStatus,
     MembershipStatus? membershipStatus,
+    PinStatus? pinStatus,
+    MuteStatus? muteStatus,
     Map<String, dynamic>? chatRoomUserData,
     ValueGetter<ChatRoomParticipant>? ifDataNotFound,
   }) async {
@@ -509,6 +514,12 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
               _membershipStatus: status.name,
               _membershipStatusTimestamp: FieldValue.serverTimestamp(),
             },
+            if (pinStatus case final status?) ...{
+              _pinStatus: status.name,
+              _pinStatusTimestamp:
+                  pinStatus.isPinned ? FieldValue.serverTimestamp() : null,
+            },
+            if (muteStatus case final status?) _muteStatus: status.name,
           };
 
       if (data.isEmpty) return;
@@ -1007,6 +1018,9 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
     return unreadMessagesCountStream.map(
       (unreadMessagesCount) => chatRoom.copyWith(
         forceNullValue: true,
+        pinnedAt: currentUser?.pinStatusTimestamp,
+        muteStatus: currentUser?.muteStatus,
+        pinStatus: currentUser?.pinStatus,
         users: otherUsers,
         chatId: chatRoom.chatId,
         groupName: chatRoom.groupName,
@@ -1210,6 +1224,7 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
         role: Role.admin,
         membershipStatusTimestamp: null,
         membershipStatus: membershipStatus,
+        pinStatusTimestamp: null,
       ),
     );
 
@@ -1235,6 +1250,7 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
                 membershipStatusTimestamp: null,
                 membershipStatus: membershipStatus,
                 role: participants[userId] ?? Role.admin,
+                pinStatusTimestamp: null,
               ),
             ),
       ],
@@ -1490,6 +1506,7 @@ final class ChatViewFireStoreDatabase implements DatabaseService {
           userId: userId,
           membershipStatus: MembershipStatus.member,
           membershipStatusTimestamp: membershipStatusTime,
+          pinStatusTimestamp: null,
         ),
       );
 

lib/src/manager/chat/chat_manager.dart

@@ -420,6 +420,40 @@ final class ChatManager extends ChatController {
     );
   }
 
+  /// Pins or unpins a chat in the user's chat list.
+  /// This method updates the pin status of a chat room
+  /// for the current user.
+  ///
+  /// **Parameters:**
+  /// - (required): [status] The pin status to set for the chat room.
+  /// - (required): [chatRoomId] The unique identifier of the chat room
+  /// to pin or unpin.
+  Future<void> pinChat(PinStatus status, String chatRoomId) {
+    return _database.updateChatRoomUserMetadata(
+      userId: _currentUserId,
+      chatId: chatRoomId,
+      pinStatus: status,
+      retry: ChatViewConnectConstants.defaultRetry,
+    );
+  }
+
+  /// Mutes or unmutes a chat room for the current user.
+  /// This method updates the mute status of a chat room
+  /// for the current user.
+  ///
+  /// **Parameters:**
+  /// - (required): [status] The mute status to set for the chat room.
+  /// - (required): [chatRoomId] The unique identifier of the chat room
+  /// to mute or unmute.
+  Future<void> muteChat(MuteStatus status, String chatRoomId) {
+    return _database.updateChatRoomUserMetadata(
+      userId: _currentUserId,
+      chatId: chatRoomId,
+      muteStatus: status,
+      retry: ChatViewConnectConstants.defaultRetry,
+    );
+  }
+
   /// Updates the status of a message to "read" or any other provided status.
   ///
   /// **Parameters:**

lib/src/models/chat_room.dart

@@ -43,11 +43,14 @@ class ChatRoom {
     required this.chatId,
     required this.chatRoomType,
     this.unreadMessagesCount = 0,
+    this.pinStatus = PinStatus.unpinned,
+    this.muteStatus = MuteStatus.unmuted,
     this.groupPhotoUrl,
     this.chatRoomCreateBy,
     this.lastMessage,
     this.groupName,
     this.users,
+    this.pinnedAt,
   });
 
   /// Converts a JSON object to a [ChatRoom] instance.
@@ -99,6 +102,15 @@ class ChatRoom {
   /// is unavailable.
   final String? chatRoomCreateBy;
 
+  /// The status of the pin in the chat room for the current user.
+  final PinStatus pinStatus;
+
+  /// The date and time when the chat room was pinned.
+  final DateTime? pinnedAt;
+
+  /// The mute status of the chat room for the current user.
+  final MuteStatus muteStatus;
+
   /// The number of unread messages in the chat room for the current user.
   ///
   /// **Note:** In the below example,
@@ -222,6 +234,9 @@ class ChatRoom {
     List<ChatRoomParticipant>? users,
     int? unreadMessagesCount,
     String? chatRoomCreateBy,
+    PinStatus? pinStatus,
+    DateTime? pinnedAt,
+    MuteStatus? muteStatus,
     bool forceNullValue = false,
   }) {
     return ChatRoom(
@@ -237,6 +252,9 @@ class ChatRoom {
       chatRoomCreateBy: forceNullValue
           ? chatRoomCreateBy
           : chatRoomCreateBy ?? this.chatRoomCreateBy,
+      pinStatus: pinStatus ?? this.pinStatus,
+      pinnedAt: forceNullValue ? pinnedAt : pinnedAt ?? this.pinnedAt,
+      muteStatus: muteStatus ?? this.muteStatus,
     );
   }
 
@@ -252,7 +270,10 @@ class ChatRoom {
             lastMessage == other.lastMessage &&
             users == other.users &&
             unreadMessagesCount == other.unreadMessagesCount &&
-            chatRoomCreateBy == other.chatRoomCreateBy;
+            chatRoomCreateBy == other.chatRoomCreateBy &&
+            pinStatus == other.pinStatus &&
+            pinnedAt == other.pinnedAt &&
+            muteStatus == other.muteStatus;
   }
 
   @override
@@ -266,6 +287,9 @@ class ChatRoom {
       users,
       unreadMessagesCount,
       chatRoomCreateBy,
+      pinStatus,
+      pinnedAt,
+      muteStatus,
     );
   }
 
@@ -280,6 +304,9 @@ class ChatRoom {
       lastMessage: $lastMessage,
       groupName: $groupName,
       users: ${users?.map((e) => e.toString()).toList()},
+      pinStatus: $pinStatus,
+      pinnedAt: $pinnedAt,
+      muteStatus: $muteStatus,
     )''';
   }
 }

lib/src/models/chat_room_participant.dart

@@ -28,8 +28,11 @@ class ChatRoomParticipant {
     required this.chatUser,
     required this.membershipStatus,
     required this.membershipStatusTimestamp,
+    required this.pinStatusTimestamp,
     this.userActiveStatus = UserActiveStatus.offline,
     this.typingStatus = TypeWriterStatus.typed,
+    this.pinStatus = PinStatus.unpinned,
+    this.muteStatus = MuteStatus.unmuted,
   });
 
   /// Creates a [ChatRoomParticipant] instance from a JSON map.
@@ -47,6 +50,13 @@ class ChatRoomParticipant {
         : createAtJson;
     json[_membershipStatusTimestamp] = createAt;
 
+    final pinStatusTimestampJson = json[_pinStatusTimestamp];
+    final pinStatusTimestamp = pinStatusTimestampJson is Timestamp
+        ? pinStatusTimestampJson.toDate().toLocal().toIso8601String()
+        : pinStatusTimestampJson;
+
+    json[_pinStatusTimestamp] = pinStatusTimestamp;
+
     return ChatRoomParticipant(
       chatUser: chatUserData is Map<String, dynamic>
           ? ChatUser.fromJson(
@@ -68,12 +78,23 @@ class ChatRoomParticipant {
       membershipStatusTimestamp: DateTime.tryParse(
         json[_membershipStatusTimestamp].toString(),
       ),
+      pinStatus: PinStatusExtension.parse(
+        json['pin_status'].toString(),
+      ),
+      pinStatusTimestamp: DateTime.tryParse(
+        json[_pinStatusTimestamp].toString(),
+      ),
+      muteStatus: MuteStatusExtension.parse(
+        json['mute_status'].toString(),
+      ),
     );
   }
 
   static const String _membershipStatusTimestamp =
       'membership_status_timestamp';
 
+  static const String _pinStatusTimestamp = 'pin_status_timestamp';
+
   /// Detailed information about the user in the chat room.
   ///
   /// This can be `null` if no data is available for the user.
@@ -108,6 +129,15 @@ class ChatRoomParticipant {
   /// If `null`, the exact time of the status change is unknown.
   final DateTime? membershipStatusTimestamp;
 
+  /// The status of the pin for the chat room participant.
+  final PinStatus pinStatus;
+
+  /// The timestamp of the last pin status change.
+  final DateTime? pinStatusTimestamp;
+
+  /// The mute status of the chat room participant.
+  final MuteStatus muteStatus;
+
   /// Converts the [ChatRoomParticipant] instance to a JSON map.
   ///
   /// **Note**: The [chatUser], [userActiveStatus] field is not included in
@@ -133,12 +163,20 @@ class ChatRoomParticipant {
       'typing_status': typingStatus.name,
       'membership_status': membershipStatus?.name,
       _membershipStatusTimestamp: membershipStatusTimestamp?.toIso8601String(),
+      'pin_status': pinStatus.name,
+      _pinStatusTimestamp: pinStatusTimestamp?.toIso8601String(),
+      'mute_status': muteStatus.name,
     };
     if (membershipStatusTimestamp case final membershipStatusTimestamp?) {
       data[_membershipStatusTimestamp] = membershipStatusTimestamp.isNow
           ? FieldValue.serverTimestamp()
           : Timestamp.fromDate(membershipStatusTimestamp);
     }
+    if (pinStatusTimestamp case final pinStatusTimestamp?) {
+      data[_pinStatusTimestamp] = pinStatusTimestamp.isNow
+          ? FieldValue.serverTimestamp()
+          : Timestamp.fromDate(pinStatusTimestamp);
+    }
     return data;
   }
 
@@ -153,7 +191,10 @@ class ChatRoomParticipant {
             typingStatus == other.typingStatus &&
             role == other.role &&
             membershipStatus == other.membershipStatus &&
-            membershipStatusTimestamp == other.membershipStatusTimestamp;
+            membershipStatusTimestamp == other.membershipStatusTimestamp &&
+            pinStatus == other.pinStatus &&
+            pinStatusTimestamp == other.pinStatusTimestamp &&
+            muteStatus == other.muteStatus;
   }
 
   @override
@@ -166,6 +207,9 @@ class ChatRoomParticipant {
       userActiveStatus,
       membershipStatus,
       membershipStatusTimestamp,
+      pinStatus,
+      pinStatusTimestamp,
+      muteStatus,
     );
   }
 
@@ -195,6 +239,9 @@ class ChatRoomParticipant {
     TypeWriterStatus? typingStatus,
     MembershipStatus? membershipStatus,
     DateTime? membershipStatusTimestamp,
+    PinStatus? pinStatus,
+    DateTime? pinStatusTimestamp,
+    MuteStatus? muteStatus,
     bool forceNullValue = false,
   }) {
     return ChatRoomParticipant(
@@ -209,6 +256,11 @@ class ChatRoomParticipant {
       membershipStatusTimestamp: forceNullValue
           ? membershipStatusTimestamp
           : membershipStatusTimestamp ?? this.membershipStatusTimestamp,
+      pinStatus: pinStatus ?? this.pinStatus,
+      pinStatusTimestamp: forceNullValue
+          ? pinStatusTimestamp
+          : pinStatusTimestamp ?? this.pinStatusTimestamp,
+      muteStatus: muteStatus ?? this.muteStatus,
     );
   }
 
@@ -220,6 +272,9 @@ class ChatRoomParticipant {
       'typingStatus: $typingStatus, '
       'role: $role, '
       'membershipStatus: $membershipStatus, '
-      'membershipStatusTimestamp: $membershipStatusTimestamp'
+      'membershipStatusTimestamp: $membershipStatusTimestamp, '
+      'pinStatus: $pinStatus, '
+      'pinStatusTimestamp: $pinStatusTimestamp, '
+      'muteStatus: $muteStatus'
       ')';
 }